mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

initremote --describe-other-params

Browse source 
Does not yet include descriptions from external special remote programs.
This commit is contained in:
Joey Hess 2020-01-20 16:05:51 -04:00
parent 2f8822307f
commit aa949bbb7d
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
6 changed files with 60 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/git-annex-initremote.mdwn
View file

@ -20,15 +20,12 @@ 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, so consult the documentation of a special remote for
details. The command will prompt for any required parameters you leave out.
details. The command will prompt for any required parameters you leave out;
you can also pass --describe-other-params to see additional parameters.
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`.
@ -41,10 +38,14 @@ want to use `git annex renameremote`.
# OPTIONS
* `--list-params-for=type`
* `--describe-other-params` / `-p`
Lists all configuration parameters that are accepted for a given
type of special remote.
Describe additional configuration parameters that you could specify.
For example, if you know you want a S3 remote, but forget how to
configure it:
git annex initremote mys3 type=S3 --describe-other-params
* `--fast`
@ -87,6 +88,7 @@ want to use `git annex renameremote`.
For details about this and other encrpytion settings, see
<https://git-annex.branchable.com/encryption/>
or --describe-other-params
* `autoenable`