]>
Commit | Line | Data |
---|---|---|
041e69c9 BF |
1 | git-remote(1) |
2 | ============ | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-remote - manage set of tracked repositories | |
7 | ||
8 | ||
9 | SYNOPSIS | |
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> | |
19 | 'git remote update' [group] | |
041e69c9 BF |
20 | |
21 | DESCRIPTION | |
22 | ----------- | |
23 | ||
24 | Manage the set of repositories ("remotes") whose branches you track. | |
25 | ||
041e69c9 | 26 | |
459cf2e9 SB |
27 | OPTIONS |
28 | ------- | |
29 | ||
30 | -v:: | |
31 | --verbose:: | |
32 | Be a little more verbose and show remote url after name. | |
33 | ||
34 | ||
0f390875 SP |
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 | |
041e69c9 BF |
44 | <url>. The command `git fetch <name>` can then be used to create and |
45 | update remote-tracking branches <name>/<branch>. | |
c5ddca1f JH |
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 | |
cf593cc4 | 54 | multiple branches without grabbing all branches. |
c5ddca1f JH |
55 | + |
56 | With `-m <master>` option, `$GIT_DIR/remotes/<name>/HEAD` is set | |
bc14fac8 | 57 | up to point at remote's `<master>` branch. See also the set-head command. |
38944390 | 58 | + |
84bb2dfd | 59 | In mirror mode, enabled with `\--mirror`, the refs will not be stored |
38944390 | 60 | in the 'refs/remotes/' namespace, but in 'refs/heads/'. This option |
84bb2dfd PB |
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. | |
041e69c9 | 64 | |
bf98421a MV |
65 | 'rename':: |
66 | ||
67 | Rename the remote named <old> to <new>. All remote tracking branches and | |
68 | configuration settings for the remote are updated. | |
74443f18 MV |
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. | |
bf98421a | 73 | |
1b4cbb5d JB |
74 | 'rm':: |
75 | ||
76 | Remove the remote named <name>. All remote tracking branches and | |
77 | configuration settings for the remote are removed. | |
78 | ||
bc14fac8 JS |
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 | ||
0f390875 | 103 | 'show':: |
041e69c9 | 104 | |
0f390875 | 105 | Gives some information about the remote <name>. |
181ea688 SV |
106 | + |
107 | With `-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 | ||
112 | Deletes all stale tracking branches under <name>. | |
859607df | 113 | These stale branches have already been removed from the remote repository |
1e592d65 TT |
114 | referenced by <name>, but are still locally available in |
115 | "remotes/<name>". | |
181ea688 | 116 | + |
8d767927 OM |
117 | With `--dry-run` option, report what branches will be pruned, but do no |
118 | actually prune them. | |
1e592d65 TT |
119 | |
120 | 'update':: | |
121 | ||
1918278e TT |
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 | |
cb5c49b9 | 125 | remotes.default is not defined, all remotes which do not have the |
1918278e | 126 | configuration parameter remote.<name>.skipDefaultUpdate set to true will |
5162e697 | 127 | be updated. (See linkgit:git-config[1]). |
859607df | 128 | |
0f390875 SP |
129 | |
130 | DISCUSSION | |
131 | ---------- | |
132 | ||
041e69c9 BF |
133 | The remote configuration is achieved using the `remote.origin.url` and |
134 | `remote.origin.fetch` configuration variables. (See | |
5162e697 | 135 | linkgit:git-config[1]). |
041e69c9 BF |
136 | |
137 | Examples | |
138 | -------- | |
139 | ||
db554bf0 JH |
140 | * Add a new remote, fetch, and check out a branch from it |
141 | + | |
041e69c9 BF |
142 | ------------ |
143 | $ git remote | |
144 | origin | |
145 | $ git branch -r | |
146 | origin/master | |
8391c60b | 147 | $ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git |
041e69c9 BF |
148 | $ git remote |
149 | linux-nfs | |
150 | origin | |
151 | $ git fetch | |
152 | * refs/remotes/linux-nfs/master: storing branch 'master' ... | |
153 | commit: bf81b46 | |
154 | $ git branch -r | |
155 | origin/master | |
156 | linux-nfs/master | |
157 | $ git checkout -b nfs linux-nfs/master | |
158 | ... | |
159 | ------------ | |
160 | ||
467c0197 | 161 | * Imitate 'git-clone' but track only selected branches |
db554bf0 JH |
162 | + |
163 | ------------ | |
164 | $ mkdir project.git | |
165 | $ cd project.git | |
166 | $ git init | |
167 | $ git remote add -f -t master -m master origin git://example.com/git.git/ | |
168 | $ git merge origin | |
169 | ------------ | |
170 | ||
171 | ||
56ae8df5 | 172 | SEE ALSO |
041e69c9 | 173 | -------- |
5162e697 DM |
174 | linkgit:git-fetch[1] |
175 | linkgit:git-branch[1] | |
176 | linkgit:git-config[1] | |
041e69c9 BF |
177 | |
178 | Author | |
179 | ------ | |
180 | Written by Junio Hamano | |
181 | ||
182 | ||
183 | Documentation | |
184 | -------------- | |
185 | Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>. | |
186 | ||
187 | ||
188 | GIT | |
189 | --- | |
9e1f0a85 | 190 | Part of the linkgit:git[1] suite |