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