]>
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 JN |
15 | 'git remote rm' <name> |
16 | 'git remote show' [-n] <name> | |
17 | 'git remote prune' [-n | --dry-run] <name> | |
18 | 'git remote update' [group] | |
041e69c9 BF |
19 | |
20 | DESCRIPTION | |
21 | ----------- | |
22 | ||
23 | Manage the set of repositories ("remotes") whose branches you track. | |
24 | ||
041e69c9 | 25 | |
459cf2e9 SB |
26 | OPTIONS |
27 | ------- | |
28 | ||
29 | -v:: | |
30 | --verbose:: | |
31 | Be a little more verbose and show remote url after name. | |
32 | ||
33 | ||
0f390875 SP |
34 | COMMANDS |
35 | -------- | |
36 | ||
37 | With no arguments, shows a list of existing remotes. Several | |
38 | subcommands are available to perform operations on the remotes. | |
39 | ||
40 | 'add':: | |
41 | ||
42 | Adds a remote named <name> for the repository at | |
041e69c9 BF |
43 | <url>. The command `git fetch <name>` can then be used to create and |
44 | update remote-tracking branches <name>/<branch>. | |
c5ddca1f JH |
45 | + |
46 | With `-f` option, `git fetch <name>` is run immediately after | |
47 | the remote information is set up. | |
48 | + | |
49 | With `-t <branch>` option, instead of the default glob | |
50 | refspec for the remote to track all branches under | |
51 | `$GIT_DIR/remotes/<name>/`, a refspec to track only `<branch>` | |
52 | is created. You can give more than one `-t <branch>` to track | |
cf593cc4 | 53 | multiple branches without grabbing all branches. |
c5ddca1f JH |
54 | + |
55 | With `-m <master>` option, `$GIT_DIR/remotes/<name>/HEAD` is set | |
56 | up to point at remote's `<master>` branch instead of whatever | |
57 | branch the `HEAD` at the remote repository actually points at. | |
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. | |
69 | ||
1b4cbb5d JB |
70 | 'rm':: |
71 | ||
72 | Remove the remote named <name>. All remote tracking branches and | |
73 | configuration settings for the remote are removed. | |
74 | ||
0f390875 | 75 | 'show':: |
041e69c9 | 76 | |
0f390875 | 77 | Gives some information about the remote <name>. |
181ea688 SV |
78 | + |
79 | With `-n` option, the remote heads are not queried first with | |
80 | `git ls-remote <name>`; cached information is used instead. | |
0f390875 SP |
81 | |
82 | 'prune':: | |
83 | ||
84 | Deletes all stale tracking branches under <name>. | |
859607df | 85 | These stale branches have already been removed from the remote repository |
1e592d65 TT |
86 | referenced by <name>, but are still locally available in |
87 | "remotes/<name>". | |
181ea688 | 88 | + |
8d767927 OM |
89 | With `--dry-run` option, report what branches will be pruned, but do no |
90 | actually prune them. | |
1e592d65 TT |
91 | |
92 | 'update':: | |
93 | ||
1918278e TT |
94 | Fetch updates for a named set of remotes in the repository as defined by |
95 | remotes.<group>. If a named group is not specified on the command line, | |
96 | the configuration parameter remotes.default will get used; if | |
cb5c49b9 | 97 | remotes.default is not defined, all remotes which do not have the |
1918278e | 98 | configuration parameter remote.<name>.skipDefaultUpdate set to true will |
5162e697 | 99 | be updated. (See linkgit:git-config[1]). |
859607df | 100 | |
0f390875 SP |
101 | |
102 | DISCUSSION | |
103 | ---------- | |
104 | ||
041e69c9 BF |
105 | The remote configuration is achieved using the `remote.origin.url` and |
106 | `remote.origin.fetch` configuration variables. (See | |
5162e697 | 107 | linkgit:git-config[1]). |
041e69c9 BF |
108 | |
109 | Examples | |
110 | -------- | |
111 | ||
db554bf0 JH |
112 | * Add a new remote, fetch, and check out a branch from it |
113 | + | |
041e69c9 BF |
114 | ------------ |
115 | $ git remote | |
116 | origin | |
117 | $ git branch -r | |
118 | origin/master | |
8391c60b | 119 | $ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git |
041e69c9 BF |
120 | $ git remote |
121 | linux-nfs | |
122 | origin | |
123 | $ git fetch | |
124 | * refs/remotes/linux-nfs/master: storing branch 'master' ... | |
125 | commit: bf81b46 | |
126 | $ git branch -r | |
127 | origin/master | |
128 | linux-nfs/master | |
129 | $ git checkout -b nfs linux-nfs/master | |
130 | ... | |
131 | ------------ | |
132 | ||
467c0197 | 133 | * Imitate 'git-clone' but track only selected branches |
db554bf0 JH |
134 | + |
135 | ------------ | |
136 | $ mkdir project.git | |
137 | $ cd project.git | |
138 | $ git init | |
139 | $ git remote add -f -t master -m master origin git://example.com/git.git/ | |
140 | $ git merge origin | |
141 | ------------ | |
142 | ||
143 | ||
56ae8df5 | 144 | SEE ALSO |
041e69c9 | 145 | -------- |
5162e697 DM |
146 | linkgit:git-fetch[1] |
147 | linkgit:git-branch[1] | |
148 | linkgit:git-config[1] | |
041e69c9 BF |
149 | |
150 | Author | |
151 | ------ | |
152 | Written by Junio Hamano | |
153 | ||
154 | ||
155 | Documentation | |
156 | -------------- | |
157 | Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>. | |
158 | ||
159 | ||
160 | GIT | |
161 | --- | |
9e1f0a85 | 162 | Part of the linkgit:git[1] suite |