diff options
author | Joey Hess <joeyh@joeyh.name> | 2015-03-23 18:20:42 -0400 |
---|---|---|
committer | Joey Hess <joeyh@joeyh.name> | 2015-03-23 18:20:42 -0400 |
commit | d17d5a77893ac01fc7c29f92447a3e85e3501d9f (patch) | |
tree | 5be49dd57a28ee56001023893f806b15dcd4c008 /doc/git-annex-enableremote.mdwn | |
parent | 277b7335378e41d1a0ecb5fdc93760435b05fc5d (diff) |
separated man pages for all the setup commands while at the gate in ATL
Diffstat (limited to 'doc/git-annex-enableremote.mdwn')
-rw-r--r-- | doc/git-annex-enableremote.mdwn | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/git-annex-enableremote.mdwn b/doc/git-annex-enableremote.mdwn new file mode 100644 index 000000000..cb4002a08 --- /dev/null +++ b/doc/git-annex-enableremote.mdwn @@ -0,0 +1,56 @@ +# NAME + +git-annex enableremote - enables use of an existing special remote + +# SYNOPSIS + +git annex enableremote `name [param=value ...]` + +# DESCRIPTION + +Enables use of an existing special remote in the current repository, +which may be a different repository than the one in which it was +originally created with the initremote command. + +The name of the remote is the same name used when originally +creating that remote with `git annex initremote`. Run +`git annex enableremote` without any name to get a list of +special remote names. + +Some special remotes may need parameters to be specified every time they are +enabled. For example, the directory special remote requires a directory= +parameter. + +This command can also be used to modify the configuration of an existing +special remote, by specifying new values for parameters that were +originally set when using initremote. (However, some settings such as +the as the encryption scheme cannot be changed once a special remote +has been created.) + +The GPG keys that an encrypted special remote is encrypted with can be +changed using the keyid+= and keyid-= parameters. These respectively +add and remove keys from the list. However, note that removing a key +does NOT necessarily prevent the key's owner from accessing data +in the encrypted special remote +(which is by design impossible, short of deleting the remote). + +One use-case of keyid-= is to replace a revoked key with +a new key: + + git annex enableremote mys3 keyid-=revokedkey keyid+=newkey + +Also, note that for encrypted special remotes using plain public-key +encryption (encryption=pubkey), adding or removing a key has NO effect +on files that have already been copied to the remote. Hence using +keyid+= and keyid-= with such remotes should be used with care, and +make little sense except in cases like the revoked key example above. + +# SEE ALSO + +[[git-annex]](1) + +# AUTHOR + +Joey Hess <id@joeyh.name> + +Warning: Automatically converted into a man page by mdwn2man. Edit with care. |