2007-01-09 04:28:51 +00:00
|
|
|
git-remote(1)
|
|
|
|
============
|
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
|
|
|
git-remote - manage set of tracked repositories
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
|
|
|
[verse]
|
2008-06-30 06:09:04 +00:00
|
|
|
'git remote' [-v | --verbose]
|
2008-07-03 05:36:04 +00:00
|
|
|
'git remote add' [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url>
|
2008-11-03 18:26:18 +00:00
|
|
|
'git remote rename' <old> <new>
|
2008-07-03 05:36:04 +00:00
|
|
|
'git remote rm' <name>
|
|
|
|
'git remote show' [-n] <name>
|
|
|
|
'git remote prune' [-n | --dry-run] <name>
|
|
|
|
'git remote update' [group]
|
2007-01-09 04:28:51 +00:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
|
|
|
|
|
|
|
Manage the set of repositories ("remotes") whose branches you track.
|
|
|
|
|
|
|
|
|
2008-06-08 01:36:10 +00:00
|
|
|
OPTIONS
|
|
|
|
-------
|
|
|
|
|
|
|
|
-v::
|
|
|
|
--verbose::
|
|
|
|
Be a little more verbose and show remote url after name.
|
|
|
|
|
|
|
|
|
2007-02-04 04:02:59 +00:00
|
|
|
COMMANDS
|
|
|
|
--------
|
|
|
|
|
|
|
|
With no arguments, shows a list of existing remotes. Several
|
|
|
|
subcommands are available to perform operations on the remotes.
|
|
|
|
|
|
|
|
'add'::
|
|
|
|
|
|
|
|
Adds a remote named <name> for the repository at
|
2007-01-09 04:28:51 +00:00
|
|
|
<url>. The command `git fetch <name>` can then be used to create and
|
|
|
|
update remote-tracking branches <name>/<branch>.
|
2007-02-26 07:26:11 +00:00
|
|
|
+
|
|
|
|
With `-f` option, `git fetch <name>` is run immediately after
|
|
|
|
the remote information is set up.
|
|
|
|
+
|
|
|
|
With `-t <branch>` option, instead of the default glob
|
|
|
|
refspec for the remote to track all branches under
|
|
|
|
`$GIT_DIR/remotes/<name>/`, a refspec to track only `<branch>`
|
|
|
|
is created. You can give more than one `-t <branch>` to track
|
2007-05-05 18:23:12 +00:00
|
|
|
multiple branches without grabbing all branches.
|
2007-02-26 07:26:11 +00:00
|
|
|
+
|
|
|
|
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.
|
2007-09-02 20:10:14 +00:00
|
|
|
+
|
2008-04-17 11:17:20 +00:00
|
|
|
In mirror mode, enabled with `\--mirror`, the refs will not be stored
|
2007-09-02 20:10:14 +00:00
|
|
|
in the 'refs/remotes/' namespace, but in 'refs/heads/'. This option
|
2008-04-17 11:17:20 +00:00
|
|
|
only makes sense in bare repositories. If a remote uses mirror
|
|
|
|
mode, furthermore, `git push` will always behave as if `\--mirror`
|
|
|
|
was passed.
|
2007-01-09 04:28:51 +00:00
|
|
|
|
2008-11-03 18:26:18 +00:00
|
|
|
'rename'::
|
|
|
|
|
|
|
|
Rename the remote named <old> to <new>. All remote tracking branches and
|
|
|
|
configuration settings for the remote are updated.
|
2008-11-10 20:43:03 +00:00
|
|
|
+
|
|
|
|
In case <old> and <new> are the same, and <old> is a file under
|
|
|
|
`$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to
|
|
|
|
the configuration file format.
|
2008-11-03 18:26:18 +00:00
|
|
|
|
2007-07-07 15:22:43 +00:00
|
|
|
'rm'::
|
|
|
|
|
|
|
|
Remove the remote named <name>. All remote tracking branches and
|
|
|
|
configuration settings for the remote are removed.
|
|
|
|
|
2007-02-04 04:02:59 +00:00
|
|
|
'show'::
|
2007-01-09 04:28:51 +00:00
|
|
|
|
2007-02-04 04:02:59 +00:00
|
|
|
Gives some information about the remote <name>.
|
2007-06-30 08:56:16 +00:00
|
|
|
+
|
|
|
|
With `-n` option, the remote heads are not queried first with
|
|
|
|
`git ls-remote <name>`; cached information is used instead.
|
2007-02-04 04:02:59 +00:00
|
|
|
|
|
|
|
'prune'::
|
|
|
|
|
|
|
|
Deletes all stale tracking branches under <name>.
|
2007-02-02 05:06:08 +00:00
|
|
|
These stale branches have already been removed from the remote repository
|
2007-02-19 04:00:00 +00:00
|
|
|
referenced by <name>, but are still locally available in
|
|
|
|
"remotes/<name>".
|
2007-06-30 08:56:16 +00:00
|
|
|
+
|
2008-06-10 14:51:35 +00:00
|
|
|
With `--dry-run` option, report what branches will be pruned, but do no
|
|
|
|
actually prune them.
|
2007-02-19 04:00:00 +00:00
|
|
|
|
|
|
|
'update'::
|
|
|
|
|
2007-02-20 20:13:43 +00:00
|
|
|
Fetch updates for a named set of remotes in the repository as defined by
|
|
|
|
remotes.<group>. If a named group is not specified on the command line,
|
|
|
|
the configuration parameter remotes.default will get used; if
|
2007-11-13 18:17:47 +00:00
|
|
|
remotes.default is not defined, all remotes which do not have the
|
2007-02-20 20:13:43 +00:00
|
|
|
configuration parameter remote.<name>.skipDefaultUpdate set to true will
|
2007-12-29 06:20:38 +00:00
|
|
|
be updated. (See linkgit:git-config[1]).
|
2007-02-02 05:06:08 +00:00
|
|
|
|
2007-02-04 04:02:59 +00:00
|
|
|
|
|
|
|
DISCUSSION
|
|
|
|
----------
|
|
|
|
|
2007-01-09 04:28:51 +00:00
|
|
|
The remote configuration is achieved using the `remote.origin.url` and
|
|
|
|
`remote.origin.fetch` configuration variables. (See
|
2007-12-29 06:20:38 +00:00
|
|
|
linkgit:git-config[1]).
|
2007-01-09 04:28:51 +00:00
|
|
|
|
|
|
|
Examples
|
|
|
|
--------
|
|
|
|
|
2007-02-28 22:05:42 +00:00
|
|
|
* Add a new remote, fetch, and check out a branch from it
|
|
|
|
+
|
2007-01-09 04:28:51 +00:00
|
|
|
------------
|
|
|
|
$ git remote
|
|
|
|
origin
|
|
|
|
$ git branch -r
|
|
|
|
origin/master
|
2007-11-03 02:54:31 +00:00
|
|
|
$ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git
|
2007-01-09 04:28:51 +00:00
|
|
|
$ git remote
|
|
|
|
linux-nfs
|
|
|
|
origin
|
|
|
|
$ git fetch
|
|
|
|
* refs/remotes/linux-nfs/master: storing branch 'master' ...
|
|
|
|
commit: bf81b46
|
|
|
|
$ git branch -r
|
|
|
|
origin/master
|
|
|
|
linux-nfs/master
|
|
|
|
$ git checkout -b nfs linux-nfs/master
|
|
|
|
...
|
|
|
|
------------
|
|
|
|
|
2008-07-03 05:28:15 +00:00
|
|
|
* Imitate 'git-clone' but track only selected branches
|
2007-02-28 22:05:42 +00:00
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ mkdir project.git
|
|
|
|
$ cd project.git
|
|
|
|
$ git init
|
|
|
|
$ git remote add -f -t master -m master origin git://example.com/git.git/
|
|
|
|
$ git merge origin
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
2008-05-28 23:55:27 +00:00
|
|
|
SEE ALSO
|
2007-01-09 04:28:51 +00:00
|
|
|
--------
|
2007-12-29 06:20:38 +00:00
|
|
|
linkgit:git-fetch[1]
|
|
|
|
linkgit:git-branch[1]
|
|
|
|
linkgit:git-config[1]
|
2007-01-09 04:28:51 +00:00
|
|
|
|
|
|
|
Author
|
|
|
|
------
|
|
|
|
Written by Junio Hamano
|
|
|
|
|
|
|
|
|
|
|
|
Documentation
|
|
|
|
--------------
|
|
|
|
Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>.
|
|
|
|
|
|
|
|
|
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|