diff --git a/doc/git-annex-enableremote.mdwn b/doc/git-annex-enableremote.mdwn index ec5cefbbd6..6620829854 100644 --- a/doc/git-annex-enableremote.mdwn +++ b/doc/git-annex-enableremote.mdwn @@ -8,27 +8,20 @@ git annex enableremote `name|uuid|desc [param=value ...]` # DESCRIPTION -Enables use of an existing remote in the current repository. +Enables use of an existing remote in the current repository, +that was set up earlier by `git annex initremote` run in +another clone of the repository. -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 +When enabling a remote, specify the same name used when originally +setting up 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 -special remote. +remote names. Or you can specify the uuid or description of the +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. The command will prompt for any required parameters -you leave out. +Some types of special remotes need parameters to be specified every time +they are enabled. For example, the directory special remote requires a +directory= 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 @@ -60,8 +53,9 @@ a new clone, it will will attempt to enable the special remote. Of course, this works best when the special remote does not need anything special to be done to get it enabled. -(This command also can be used to enable a remote that git-annex has been -prevented from using by the `remote..annex-ignore` setting.) +(This command also can be used to enable a git remote that git-annex +has found didn't work before and gave up on using, setting +`remote..annex-ignore`.) # SEE ALSO