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