Allow git-remote to update named groups of remotes
[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'
13 'git-remote' add <name> <url>
14 'git-remote' show <name>
15 'git-remote' prune <name>
16 'git-remote' update [group]
17
18 DESCRIPTION
19 -----------
20
21 Manage the set of repositories ("remotes") whose branches you track.
22
23
24 COMMANDS
25 --------
26
27 With no arguments, shows a list of existing remotes. Several
28 subcommands are available to perform operations on the remotes.
29
30 'add'::
31
32 Adds a remote named <name> for the repository at
33 <url>. The command `git fetch <name>` can then be used to create and
34 update remote-tracking branches <name>/<branch>.
35
36 'show'::
37
38 Gives some information about the remote <name>.
39
40 'prune'::
41
42 Deletes all stale tracking branches under <name>.
43 These stale branches have already been removed from the remote repository
44 referenced by <name>, but are still locally available in
45 "remotes/<name>".
46
47 'update'::
48
49 Fetch updates for a named set of remotes in the repository as defined by
50 remotes.<group>. If a named group is not specified on the command line,
51 the configuration parameter remotes.default will get used; if
52 remotes.default is not defined, all remotes which do not the
53 configuration parameter remote.<name>.skipDefaultUpdate set to true will
54 be updated. (See gitlink:git-config[1]).
55
56
57 DISCUSSION
58 ----------
59
60 The remote configuration is achieved using the `remote.origin.url` and
61 `remote.origin.fetch` configuration variables. (See
62 gitlink:git-config[1]).
63
64 Examples
65 --------
66
67 Add a new remote, fetch, and check out a branch from it:
68
69 ------------
70 $ git remote
71 origin
72 $ git branch -r
73 origin/master
74 $ git remote add linux-nfs git://linux-nfs.org/pub/nfs-2.6.git
75 $ git remote
76 linux-nfs
77 origin
78 $ git fetch
79 * refs/remotes/linux-nfs/master: storing branch 'master' ...
80 commit: bf81b46
81 $ git branch -r
82 origin/master
83 linux-nfs/master
84 $ git checkout -b nfs linux-nfs/master
85 ...
86 ------------
87
88 See Also
89 --------
90 gitlink:git-fetch[1]
91 gitlink:git-branch[1]
92 gitlink:git-config[1]
93
94 Author
95 ------
96 Written by Junio Hamano
97
98
99 Documentation
100 --------------
101 Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>.
102
103
104 GIT
105 ---
106 Part of the gitlink:git[7] suite
107