started on --list-params-for

Command/InitRemote.hs

@@ -1,6 +1,6 @@
 {- git-annex command
  -
- - Copyright 2011-2019 Joey Hess <id@joeyh.name>
+ - Copyright 2011-2020 Joey Hess <id@joeyh.name>
  -
  - Licensed under the GNU AGPL version 3 or higher.
  -}

doc/git-annex-enableremote.mdwn

@@ -27,7 +27,8 @@ special remote.
   
 Some special remotes may need parameters to be specified every time they are
 enabled. For example, the directory special remote requires a directory=
-parameter every time.
+parameter every time. The command will prompt for any required parameters
+you leave out.
 
 This command can also be used to modify the configuration of an existing
 special remote, by specifying new values for parameters that are

doc/git-annex-initremote.mdwn

@@ -19,10 +19,16 @@ For a list and details, see <https://git-annex.branchable.com/special_remotes/>
  
 The remote's configuration is specified by the parameters passed
 to this command. Different types of special remotes need different
-configuration values. The command will prompt for parameters as needed. A
-few parameters that are supported by all special remotes are documented in
+configuration values, so consult the documentation of a special remote for
+details. The command will prompt for any required parameters you leave out.
+A few parameters that are supported by all special remotes are documented in
 the next section below.
 
+To list all the configuration parameters that are accepted by a particular
+type of special remote, along with short descriptions, run eg:
+
+	git annex initremote --list-params-for=S3
+
 Once a special remote has been initialized once with this command,
 other clones of the repository can also be set up to access it using
 `git annex enableremote`.
@@ -35,6 +41,11 @@ want to use `git annex renameremote`.
 
 # OPTIONS
 
+* `--list-params-for=type`
+
+  Lists all configuration parameters that are accepted for a given
+  type of special remote.
+
 * `--fast`
 
   When initializing a remote that uses encryption, a cryptographic key is
@@ -66,7 +77,7 @@ want to use `git annex renameremote`.
 
 * `encryption`
 
-  All special remotes support encryption. You will need to specify
+  Almost all special remotes support encryption. You will need to specify
   what encryption, if any, to use. 
 
   If you do not want any encryption, use `encryption=none`