Merge branch 'qq/maint' into maint
[gitweb.git] / Documentation / git-remote.txt
index 886bc03c4af0c1a9ab8232fc305c68a6a5e10d2a..345943a26466dab73034b41698c54ca317cc4d75 100644 (file)
@@ -9,10 +9,11 @@ git-remote - manage set of tracked repositories
 SYNOPSIS
 --------
 [verse]
-'git-remote'
-'git-remote' add [-t <branch>] [-m <branch>] [-f] <name> <url>
-'git-remote' show <name>
-'git-remote' prune <name>
+'git-remote' [-v | --verbose]
+'git-remote' add [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url>
+'git-remote' rm <name>
+'git-remote' show [-n] <name>
+'git-remote' prune [-n | --dry-run] <name>
 'git-remote' update [group]
 
 DESCRIPTION
@@ -21,6 +22,14 @@ DESCRIPTION
 Manage the set of repositories ("remotes") whose branches you track.
 
 
+OPTIONS
+-------
+
+-v::
+--verbose::
+       Be a little more verbose and show remote url after name.
+
+
 COMMANDS
 --------
 
@@ -45,6 +54,17 @@ multiple branches without grabbing all branches.
 With `-m <master>` option, `$GIT_DIR/remotes/<name>/HEAD` is set
 up to point at remote's `<master>` branch instead of whatever
 branch the `HEAD` at the remote repository actually points at.
++
+In mirror mode, enabled with `\--mirror`, the refs will not be stored
+in the 'refs/remotes/' namespace, but in 'refs/heads/'.  This option
+only makes sense in bare repositories.  If a remote uses mirror
+mode, furthermore, `git push` will always behave as if `\--mirror`
+was passed.
+
+'rm'::
+
+Remove the remote named <name>. All remote tracking branches and
+configuration settings for the remote are removed.
 
 'show'::
 
@@ -60,9 +80,8 @@ These stale branches have already been removed from the remote repository
 referenced by <name>, but are still locally available in
 "remotes/<name>".
 +
-With `-n` option, the remote heads are not confirmed first with `git
-ls-remote <name>`; cached information is used instead.  Use with
-caution.
+With `--dry-run` option, report what branches will be pruned, but do no
+actually prune them.
 
 'update'::
 
@@ -71,7 +90,7 @@ remotes.<group>.  If a named group is not specified on the command line,
 the configuration parameter remotes.default will get used; if
 remotes.default is not defined, all remotes which do not have the
 configuration parameter remote.<name>.skipDefaultUpdate set to true will
-be updated.  (See gitlink:git-config[1]).
+be updated.  (See linkgit:git-config[1]).
 
 
 DISCUSSION
@@ -79,7 +98,7 @@ DISCUSSION
 
 The remote configuration is achieved using the `remote.origin.url` and
 `remote.origin.fetch` configuration variables.  (See
-gitlink:git-config[1]).
+linkgit:git-config[1]).
 
 Examples
 --------
@@ -116,11 +135,11 @@ $ git merge origin
 ------------
 
 
-See Also
+SEE ALSO
 --------
-gitlink:git-fetch[1]
-gitlink:git-branch[1]
-gitlink:git-config[1]
+linkgit:git-fetch[1]
+linkgit:git-branch[1]
+linkgit:git-config[1]
 
 Author
 ------
@@ -134,4 +153,4 @@ Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[1] suite