diff options
author | Joey Hess <joeyh@joeyh.name> | 2016-05-24 15:24:38 -0400 |
---|---|---|
committer | Joey Hess <joeyh@joeyh.name> | 2016-05-24 15:24:38 -0400 |
commit | ba3bc0d631702ce91f1044985f2c3f533fb4f95d (patch) | |
tree | 351de6c3a09a5113805b9fe8931898a69cee8f3f /doc/git-annex-enableremote.mdwn | |
parent | c9d99bfb55f7e0748b85fba0a9d11ffb57b693a6 (diff) |
enableremote: Can now be used to explicitly enable git-annex to use git remotes. Using the command this way prevents other git-annex commands from probing new git remotes to auto-enable them.
Diffstat (limited to 'doc/git-annex-enableremote.mdwn')
-rw-r--r-- | doc/git-annex-enableremote.mdwn | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/doc/git-annex-enableremote.mdwn b/doc/git-annex-enableremote.mdwn index 846724715..d63dfaf62 100644 --- a/doc/git-annex-enableremote.mdwn +++ b/doc/git-annex-enableremote.mdwn @@ -1,6 +1,6 @@ # NAME -git-annex enableremote - enables use of an existing special remote +git-annex enableremote - enables git-annex to use a remote # SYNOPSIS @@ -8,15 +8,22 @@ git annex enableremote `name|uuid|desc [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. +Enables use of an existing remote in the current repository. -The name of the remote is the same name used when originally +This is often used to enable use of a special (non-git) remote, by +a different repository than the one in which it was +originally created with the initremote command. + +It can also be used to explicitly enable a git remote, +so that git-annex can store the contents of files there. First +run `git remote add`, and then `git annex enableremote` with the name of +the remote. + +When enabling a special remote, specify 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. Or you can specify the uuid or description of the -remote. +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= |