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