remote: separate the concept of push and fetch mirrors
[git/git.git] / Documentation / git-remote.txt
CommitLineData
041e69c9
BF
1git-remote(1)
2============
3
4NAME
5----
6git-remote - manage set of tracked repositories
7
8
9SYNOPSIS
10--------
11[verse]
b1889c36 12'git remote' [-v | --verbose]
a9f5a355 13'git remote add' [-t <branch>] [-m <master>] [-f] [--tags|--no-tags] [--mirror=<fetch|push>] <name> <url>
bf98421a 14'git remote rename' <old> <new>
04c2407e 15'git remote rm' <name>
4504107d 16'git remote set-head' <name> (-a | -d | <branch>)
3d8b6949 17'git remote set-branches' <name> [--add] <branch>...
433f2be1
IL
18'git remote set-url' [--push] <name> <newurl> [<oldurl>]
19'git remote set-url --add' [--push] <name> <newurl>
20'git remote set-url --delete' [--push] <name> <url>
4504107d 21'git remote' [-v | --verbose] 'show' [-n] <name>
04c2407e 22'git remote prune' [-n | --dry-run] <name>
0adda936 23'git remote' [-v | --verbose] 'update' [-p | --prune] [(<group> | <remote>)...]
041e69c9
BF
24
25DESCRIPTION
26-----------
27
28Manage the set of repositories ("remotes") whose branches you track.
29
041e69c9 30
459cf2e9
SB
31OPTIONS
32-------
33
34-v::
35--verbose::
36 Be a little more verbose and show remote url after name.
4504107d 37 NOTE: This must be placed between `remote` and `subcommand`.
459cf2e9
SB
38
39
0f390875
SP
40COMMANDS
41--------
42
43With no arguments, shows a list of existing remotes. Several
44subcommands are available to perform operations on the remotes.
45
46'add'::
47
48Adds a remote named <name> for the repository at
041e69c9
BF
49<url>. The command `git fetch <name>` can then be used to create and
50update remote-tracking branches <name>/<branch>.
c5ddca1f
JH
51+
52With `-f` option, `git fetch <name>` is run immediately after
53the remote information is set up.
54+
111fb858
ST
55With `--tags` option, `git fetch <name>` imports every tag from the
56remote repository.
57+
58With `--no-tags` option, `git fetch <name>` does not import tags from
59the remote repository.
60+
c5ddca1f
JH
61With `-t <branch>` option, instead of the default glob
62refspec for the remote to track all branches under
63`$GIT_DIR/remotes/<name>/`, a refspec to track only `<branch>`
64is created. You can give more than one `-t <branch>` to track
cf593cc4 65multiple branches without grabbing all branches.
c5ddca1f
JH
66+
67With `-m <master>` option, `$GIT_DIR/remotes/<name>/HEAD` is set
bc14fac8 68up to point at remote's `<master>` branch. See also the set-head command.
38944390 69+
a9f5a355
JK
70When a fetch mirror is created with `\--mirror=fetch`, the refs will not
71be stored in the 'refs/remotes/' namespace, but rather everything in
72'refs/' on the remote will be directly mirrored into 'refs/' in the
73local repository. This option only makes sense in bare repositories,
74because a fetch would overwrite any local commits.
75+
76When a push mirror is created with `\--mirror=push`, then `git push`
77will always behave as if `\--mirror` was passed.
78+
79The option `\--mirror` (with no type) sets up both push and fetch
80mirror configuration. It is kept for historical purposes, and is
81probably not what you want.
041e69c9 82
bf98421a
MV
83'rename'::
84
0e615b25 85Rename the remote named <old> to <new>. All remote-tracking branches and
bf98421a 86configuration settings for the remote are updated.
74443f18
MV
87+
88In case <old> and <new> are the same, and <old> is a file under
89`$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to
90the configuration file format.
bf98421a 91
1b4cbb5d
JB
92'rm'::
93
0e615b25 94Remove the remote named <name>. All remote-tracking branches and
1b4cbb5d
JB
95configuration settings for the remote are removed.
96
bc14fac8
JS
97'set-head'::
98
99Sets or deletes the default branch (`$GIT_DIR/remotes/<name>/HEAD`) for
100the named remote. Having a default branch for a remote is not required,
101but allows the name of the remote to be specified in lieu of a specific
102branch. For example, if the default branch for `origin` is set to
103`master`, then `origin` may be specified wherever you would normally
104specify `origin/master`.
105+
106With `-d`, `$GIT_DIR/remotes/<name>/HEAD` is deleted.
107+
108With `-a`, the remote is queried to determine its `HEAD`, then
109`$GIT_DIR/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote
110`HEAD` is pointed at `next`, "`git remote set-head origin -a`" will set
111`$GIT_DIR/refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will
112only work if `refs/remotes/origin/next` already exists; if not it must be
113fetched first.
114+
115Use `<branch>` to set `$GIT_DIR/remotes/<name>/HEAD` explicitly. e.g., "git
116remote set-head origin master" will set `$GIT_DIR/refs/remotes/origin/HEAD` to
117`refs/remotes/origin/master`. This will only work if
118`refs/remotes/origin/master` already exists; if not it must be fetched first.
119+
120
3d8b6949
JN
121'set-branches'::
122
123Changes the list of branches tracked by the named remote.
124This can be used to track a subset of the available remote branches
125after the initial setup for a remote.
126+
127The named branches will be interpreted as if specified with the
128`-t` option on the 'git remote add' command line.
129+
130With `--add`, instead of replacing the list of currently tracked
131branches, adds to that list.
132
433f2be1
IL
133'set-url'::
134
135Changes URL remote points to. Sets first URL remote points to matching
136regex <oldurl> (first URL if no <oldurl> is given) to <newurl>. If
137<oldurl> doesn't match any URL, error occurs and nothing is changed.
138+
139With '--push', push URLs are manipulated instead of fetch URLs.
140+
141With '--add', instead of changing some URL, new URL is added.
142+
143With '--delete', instead of changing some URL, all URLs matching
144regex <url> are deleted. Trying to delete all non-push URLs is an
145error.
146
0f390875 147'show'::
041e69c9 148
0f390875 149Gives some information about the remote <name>.
181ea688
SV
150+
151With `-n` option, the remote heads are not queried first with
152`git ls-remote <name>`; cached information is used instead.
0f390875
SP
153
154'prune'::
155
8b3f3f84 156Deletes all stale remote-tracking branches under <name>.
859607df 157These stale branches have already been removed from the remote repository
1e592d65
TT
158referenced by <name>, but are still locally available in
159"remotes/<name>".
181ea688 160+
75f492ac 161With `--dry-run` option, report what branches will be pruned, but do not
8d767927 162actually prune them.
1e592d65
TT
163
164'update'::
165
1918278e
TT
166Fetch updates for a named set of remotes in the repository as defined by
167remotes.<group>. If a named group is not specified on the command line,
75f492ac 168the configuration parameter remotes.default will be used; if
cb5c49b9 169remotes.default is not defined, all remotes which do not have the
1918278e 170configuration parameter remote.<name>.skipDefaultUpdate set to true will
5162e697 171be updated. (See linkgit:git-config[1]).
efa54803
FAG
172+
173With `--prune` option, prune all the remotes that are updated.
859607df 174
0f390875
SP
175
176DISCUSSION
177----------
178
041e69c9
BF
179The remote configuration is achieved using the `remote.origin.url` and
180`remote.origin.fetch` configuration variables. (See
5162e697 181linkgit:git-config[1]).
041e69c9
BF
182
183Examples
184--------
185
db554bf0
JH
186* Add a new remote, fetch, and check out a branch from it
187+
041e69c9
BF
188------------
189$ git remote
190origin
191$ git branch -r
192origin/master
8391c60b 193$ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git
041e69c9
BF
194$ git remote
195linux-nfs
196origin
197$ git fetch
198* refs/remotes/linux-nfs/master: storing branch 'master' ...
199 commit: bf81b46
200$ git branch -r
201origin/master
202linux-nfs/master
203$ git checkout -b nfs linux-nfs/master
204...
205------------
206
0b444cdb 207* Imitate 'git clone' but track only selected branches
db554bf0
JH
208+
209------------
210$ mkdir project.git
211$ cd project.git
212$ git init
213$ git remote add -f -t master -m master origin git://example.com/git.git/
214$ git merge origin
215------------
216
217
56ae8df5 218SEE ALSO
041e69c9 219--------
5162e697
DM
220linkgit:git-fetch[1]
221linkgit:git-branch[1]
222linkgit:git-config[1]
041e69c9
BF
223
224Author
225------
226Written by Junio Hamano
227
228
229Documentation
230--------------
231Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>.
232
233
234GIT
235---
9e1f0a85 236Part of the linkgit:git[1] suite