git remote update: Fallback to remote if group does not exist
[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] [--mirror] <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 show' [-n] <name>
18 'git remote prune' [-n | --dry-run] <name>
19 'git remote update' [-p | --prune] [group | remote]...
20
21 DESCRIPTION
22 -----------
23
24 Manage the set of repositories ("remotes") whose branches you track.
25
26
27 OPTIONS
28 -------
29
30 -v::
31 --verbose::
32 Be a little more verbose and show remote url after name.
33
34
35 COMMANDS
36 --------
37
38 With no arguments, shows a list of existing remotes. Several
39 subcommands are available to perform operations on the remotes.
40
41 'add'::
42
43 Adds a remote named <name> for the repository at
44 <url>. The command `git fetch <name>` can then be used to create and
45 update remote-tracking branches <name>/<branch>.
46 +
47 With `-f` option, `git fetch <name>` is run immediately after
48 the remote information is set up.
49 +
50 With `-t <branch>` option, instead of the default glob
51 refspec for the remote to track all branches under
52 `$GIT_DIR/remotes/<name>/`, a refspec to track only `<branch>`
53 is created. You can give more than one `-t <branch>` to track
54 multiple branches without grabbing all branches.
55 +
56 With `-m <master>` option, `$GIT_DIR/remotes/<name>/HEAD` is set
57 up to point at remote's `<master>` branch. See also the set-head command.
58 +
59 In mirror mode, enabled with `\--mirror`, the refs will not be stored
60 in the 'refs/remotes/' namespace, but in 'refs/heads/'. This option
61 only makes sense in bare repositories. If a remote uses mirror
62 mode, furthermore, `git push` will always behave as if `\--mirror`
63 was passed.
64
65 'rename'::
66
67 Rename the remote named <old> to <new>. All remote tracking branches and
68 configuration settings for the remote are updated.
69 +
70 In case <old> and <new> are the same, and <old> is a file under
71 `$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to
72 the configuration file format.
73
74 'rm'::
75
76 Remove the remote named <name>. All remote tracking branches and
77 configuration settings for the remote are removed.
78
79 'set-head'::
80
81 Sets or deletes the default branch (`$GIT_DIR/remotes/<name>/HEAD`) for
82 the named remote. Having a default branch for a remote is not required,
83 but allows the name of the remote to be specified in lieu of a specific
84 branch. For example, if the default branch for `origin` is set to
85 `master`, then `origin` may be specified wherever you would normally
86 specify `origin/master`.
87 +
88 With `-d`, `$GIT_DIR/remotes/<name>/HEAD` is deleted.
89 +
90 With `-a`, the remote is queried to determine its `HEAD`, then
91 `$GIT_DIR/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote
92 `HEAD` is pointed at `next`, "`git remote set-head origin -a`" will set
93 `$GIT_DIR/refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will
94 only work if `refs/remotes/origin/next` already exists; if not it must be
95 fetched first.
96 +
97 Use `<branch>` to set `$GIT_DIR/remotes/<name>/HEAD` explicitly. e.g., "git
98 remote set-head origin master" will set `$GIT_DIR/refs/remotes/origin/HEAD` to
99 `refs/remotes/origin/master`. This will only work if
100 `refs/remotes/origin/master` already exists; if not it must be fetched first.
101 +
102
103 'show'::
104
105 Gives some information about the remote <name>.
106 +
107 With `-n` option, the remote heads are not queried first with
108 `git ls-remote <name>`; cached information is used instead.
109
110 'prune'::
111
112 Deletes all stale tracking branches under <name>.
113 These stale branches have already been removed from the remote repository
114 referenced by <name>, but are still locally available in
115 "remotes/<name>".
116 +
117 With `--dry-run` option, report what branches will be pruned, but do no
118 actually prune them.
119
120 'update'::
121
122 Fetch updates for a named set of remotes in the repository as defined by
123 remotes.<group>. If a named group is not specified on the command line,
124 the configuration parameter remotes.default will get used; if
125 remotes.default is not defined, all remotes which do not have the
126 configuration parameter remote.<name>.skipDefaultUpdate set to true will
127 be updated. (See linkgit:git-config[1]).
128 +
129 With `--prune` option, prune all the remotes that are updated.
130
131
132 DISCUSSION
133 ----------
134
135 The remote configuration is achieved using the `remote.origin.url` and
136 `remote.origin.fetch` configuration variables. (See
137 linkgit:git-config[1]).
138
139 Examples
140 --------
141
142 * Add a new remote, fetch, and check out a branch from it
143 +
144 ------------
145 $ git remote
146 origin
147 $ git branch -r
148 origin/master
149 $ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git
150 $ git remote
151 linux-nfs
152 origin
153 $ git fetch
154 * refs/remotes/linux-nfs/master: storing branch 'master' ...
155 commit: bf81b46
156 $ git branch -r
157 origin/master
158 linux-nfs/master
159 $ git checkout -b nfs linux-nfs/master
160 ...
161 ------------
162
163 * Imitate 'git-clone' but track only selected branches
164 +
165 ------------
166 $ mkdir project.git
167 $ cd project.git
168 $ git init
169 $ git remote add -f -t master -m master origin git://example.com/git.git/
170 $ git merge origin
171 ------------
172
173
174 SEE ALSO
175 --------
176 linkgit:git-fetch[1]
177 linkgit:git-branch[1]
178 linkgit:git-config[1]
179
180 Author
181 ------
182 Written by Junio Hamano
183
184
185 Documentation
186 --------------
187 Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>.
188
189
190 GIT
191 ---
192 Part of the linkgit:git[1] suite