]> git.ipfire.org Git - thirdparty/git.git/blob - Documentation/git-remote.txt
Manual subsection to refer to other pages is SEE ALSO
[thirdparty/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 [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url>
14 'git-remote' rm <name>
15 'git-remote' show <name>
16 'git-remote' prune <name>
17 'git-remote' update [group]
18
19 DESCRIPTION
20 -----------
21
22 Manage the set of repositories ("remotes") whose branches you track.
23
24
25 COMMANDS
26 --------
27
28 With no arguments, shows a list of existing remotes. Several
29 subcommands are available to perform operations on the remotes.
30
31 'add'::
32
33 Adds a remote named <name> for the repository at
34 <url>. The command `git fetch <name>` can then be used to create and
35 update remote-tracking branches <name>/<branch>.
36 +
37 With `-f` option, `git fetch <name>` is run immediately after
38 the remote information is set up.
39 +
40 With `-t <branch>` option, instead of the default glob
41 refspec for the remote to track all branches under
42 `$GIT_DIR/remotes/<name>/`, a refspec to track only `<branch>`
43 is created. You can give more than one `-t <branch>` to track
44 multiple branches without grabbing all branches.
45 +
46 With `-m <master>` option, `$GIT_DIR/remotes/<name>/HEAD` is set
47 up to point at remote's `<master>` branch instead of whatever
48 branch the `HEAD` at the remote repository actually points at.
49 +
50 In mirror mode, enabled with `\--mirror`, the refs will not be stored
51 in the 'refs/remotes/' namespace, but in 'refs/heads/'. This option
52 only makes sense in bare repositories. If a remote uses mirror
53 mode, furthermore, `git push` will always behave as if `\--mirror`
54 was passed.
55
56 'rm'::
57
58 Remove the remote named <name>. All remote tracking branches and
59 configuration settings for the remote are removed.
60
61 'show'::
62
63 Gives some information about the remote <name>.
64 +
65 With `-n` option, the remote heads are not queried first with
66 `git ls-remote <name>`; cached information is used instead.
67
68 'prune'::
69
70 Deletes all stale tracking branches under <name>.
71 These stale branches have already been removed from the remote repository
72 referenced by <name>, but are still locally available in
73 "remotes/<name>".
74 +
75 With `-n` option, the remote heads are not confirmed first with `git
76 ls-remote <name>`; cached information is used instead. Use with
77 caution.
78
79 'update'::
80
81 Fetch updates for a named set of remotes in the repository as defined by
82 remotes.<group>. If a named group is not specified on the command line,
83 the configuration parameter remotes.default will get used; if
84 remotes.default is not defined, all remotes which do not have the
85 configuration parameter remote.<name>.skipDefaultUpdate set to true will
86 be updated. (See linkgit:git-config[1]).
87
88
89 DISCUSSION
90 ----------
91
92 The remote configuration is achieved using the `remote.origin.url` and
93 `remote.origin.fetch` configuration variables. (See
94 linkgit:git-config[1]).
95
96 Examples
97 --------
98
99 * Add a new remote, fetch, and check out a branch from it
100 +
101 ------------
102 $ git remote
103 origin
104 $ git branch -r
105 origin/master
106 $ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git
107 $ git remote
108 linux-nfs
109 origin
110 $ git fetch
111 * refs/remotes/linux-nfs/master: storing branch 'master' ...
112 commit: bf81b46
113 $ git branch -r
114 origin/master
115 linux-nfs/master
116 $ git checkout -b nfs linux-nfs/master
117 ...
118 ------------
119
120 * Imitate 'git clone' but track only selected branches
121 +
122 ------------
123 $ mkdir project.git
124 $ cd project.git
125 $ git init
126 $ git remote add -f -t master -m master origin git://example.com/git.git/
127 $ git merge origin
128 ------------
129
130
131 SEE ALSO
132 --------
133 linkgit:git-fetch[1]
134 linkgit:git-branch[1]
135 linkgit:git-config[1]
136
137 Author
138 ------
139 Written by Junio Hamano
140
141
142 Documentation
143 --------------
144 Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>.
145
146
147 GIT
148 ---
149 Part of the linkgit:git[7] suite