git-annex/doc/git-annex-renameremote.mdwn
Joey Hess b184fc490a
split out common options to its own page and mention it on each subcommand page
Sometimes users would get confused because an option they were looking
for was not mentioned on a subcommand's man page, and they had not
noticed that the main git-annex man page had a list of common options.
This change lets each subcommand mention the common options, similarly
to how the matching options are handled.

This commit was sponsored by Svenne Krap on Patreon.
2021-05-10 15:00:13 -04:00

45 lines
1.1 KiB
Markdown

# NAME
git-annex renameremote - changes name of a special remote
# SYNOPSIS
git annex renameremote `name|uuid|desc newname`
# DESCRIPTION
Changes the name that is used to enable a special remote.
Normally the current name is used to identify the special remote to rename,
but its uuid or description can also be used.
This is especially useful when an old special remote used a name, and now you
want to use that name for a new special remote. `git annex initremote`
won't let you create a remote with a conflicting name, so rename the old
remote first.
git annex renameremote phone lost-phone
git annex initremote phone ...
This only updates the name that git-annex has stored for use
by `git annex enableremote`. It does not update the git config stanza
for the special remote to use the new name, but of course you can edit
the git config if you want to rename it there.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)
[[git-annex-initremote]](1)
[[git-annex-enableremote]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.