imap-send: support subjectAltName as well
[git/jnareb-git.git] / Documentation / git-remote.txt
blob5a8c5061f3701c57bab75b2b4c70ad620f7e536f
1 git-remote(1)
2 ============
4 NAME
5 ----
6 git-remote - manage set of tracked repositories
9 SYNOPSIS
10 --------
11 [verse]
12 'git remote' [-v | --verbose]
13 'git remote add' [-t <branch>] [-m <master>] [-f] [--tags|--no-tags] [--mirror=<fetch|push>] <name> <url>
14 'git remote rename' <old> <new>
15 'git remote rm' <name>
16 'git remote set-head' <name> (-a | -d | <branch>)
17 'git remote set-branches' <name> [--add] <branch>...
18 'git remote set-url' [--push] <name> <newurl> [<oldurl>]
19 'git remote set-url --add' [--push] <name> <newurl>
20 'git remote set-url --delete' [--push] <name> <url>
21 'git remote' [-v | --verbose] 'show' [-n] <name>
22 'git remote prune' [-n | --dry-run] <name>
23 'git remote' [-v | --verbose] 'update' [-p | --prune] [(<group> | <remote>)...]
25 DESCRIPTION
26 -----------
28 Manage the set of repositories ("remotes") whose branches you track.
31 OPTIONS
32 -------
34 -v::
35 --verbose::
36         Be a little more verbose and show remote url after name.
37         NOTE: This must be placed between `remote` and `subcommand`.
40 COMMANDS
41 --------
43 With no arguments, shows a list of existing remotes.  Several
44 subcommands are available to perform operations on the remotes.
46 'add'::
48 Adds a remote named <name> for the repository at
49 <url>.  The command `git fetch <name>` can then be used to create and
50 update remote-tracking branches <name>/<branch>.
52 With `-f` option, `git fetch <name>` is run immediately after
53 the remote information is set up.
55 With `--tags` option, `git fetch <name>` imports every tag from the
56 remote repository.
58 With `--no-tags` option, `git fetch <name>` does not import tags from
59 the remote repository.
61 With `-t <branch>` option, instead of the default glob
62 refspec for the remote to track all branches under
63 the `refs/remotes/<name>/` namespace, a refspec to track only `<branch>`
64 is created.  You can give more than one `-t <branch>` to track
65 multiple branches without grabbing all branches.
67 With `-m <master>` option, a symbolic-ref `refs/remotes/<name>/HEAD` is set
68 up to point at remote's `<master>` branch. See also the set-head command.
70 When a fetch mirror is created with `\--mirror=fetch`, the refs will not
71 be stored in the 'refs/remotes/' namespace, but rather everything in
72 'refs/' on the remote will be directly mirrored into 'refs/' in the
73 local repository. This option only makes sense in bare repositories,
74 because a fetch would overwrite any local commits.
76 When a push mirror is created with `\--mirror=push`, then `git push`
77 will always behave as if `\--mirror` was passed.
79 'rename'::
81 Rename the remote named <old> to <new>. All remote-tracking branches and
82 configuration settings for the remote are updated.
84 In case <old> and <new> are the same, and <old> is a file under
85 `$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to
86 the configuration file format.
88 'rm'::
90 Remove the remote named <name>. All remote-tracking branches and
91 configuration settings for the remote are removed.
93 'set-head'::
95 Sets or deletes the default branch (i.e. the target of the
96 symbolic-ref `refs/remotes/<name>/HEAD`) for
97 the named remote. Having a default branch for a remote is not required,
98 but allows the name of the remote to be specified in lieu of a specific
99 branch. For example, if the default branch for `origin` is set to
100 `master`, then `origin` may be specified wherever you would normally
101 specify `origin/master`.
103 With `-d`, the symbolic ref `refs/remotes/<name>/HEAD` is deleted.
105 With `-a`, the remote is queried to determine its `HEAD`, then the
106 symbolic-ref `refs/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote
107 `HEAD` is pointed at `next`, "`git remote set-head origin -a`" will set
108 the symbolic-ref `refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will
109 only work if `refs/remotes/origin/next` already exists; if not it must be
110 fetched first.
112 Use `<branch>` to set the symbolic-ref `refs/remotes/<name>/HEAD` explicitly. e.g., "git
113 remote set-head origin master" will set the symbolic-ref `refs/remotes/origin/HEAD` to
114 `refs/remotes/origin/master`. This will only work if
115 `refs/remotes/origin/master` already exists; if not it must be fetched first.
118 'set-branches'::
120 Changes the list of branches tracked by the named remote.
121 This can be used to track a subset of the available remote branches
122 after the initial setup for a remote.
124 The named branches will be interpreted as if specified with the
125 `-t` option on the 'git remote add' command line.
127 With `--add`, instead of replacing the list of currently tracked
128 branches, adds to that list.
130 'set-url'::
132 Changes URL remote points to. Sets first URL remote points to matching
133 regex <oldurl> (first URL if no <oldurl> is given) to <newurl>. If
134 <oldurl> doesn't match any URL, error occurs and nothing is changed.
136 With '--push', push URLs are manipulated instead of fetch URLs.
138 With '--add', instead of changing some URL, new URL is added.
140 With '--delete', instead of changing some URL, all URLs matching
141 regex <url> are deleted. Trying to delete all non-push URLs is an
142 error.
144 'show'::
146 Gives some information about the remote <name>.
148 With `-n` option, the remote heads are not queried first with
149 `git ls-remote <name>`; cached information is used instead.
151 'prune'::
153 Deletes all stale remote-tracking branches under <name>.
154 These stale branches have already been removed from the remote repository
155 referenced by <name>, but are still locally available in
156 "remotes/<name>".
158 With `--dry-run` option, report what branches will be pruned, but do not
159 actually prune them.
161 'update'::
163 Fetch updates for a named set of remotes in the repository as defined by
164 remotes.<group>.  If a named group is not specified on the command line,
165 the configuration parameter remotes.default will be used; if
166 remotes.default is not defined, all remotes which do not have the
167 configuration parameter remote.<name>.skipDefaultUpdate set to true will
168 be updated.  (See linkgit:git-config[1]).
170 With `--prune` option, prune all the remotes that are updated.
173 DISCUSSION
174 ----------
176 The remote configuration is achieved using the `remote.origin.url` and
177 `remote.origin.fetch` configuration variables.  (See
178 linkgit:git-config[1]).
180 Examples
181 --------
183 * Add a new remote, fetch, and check out a branch from it
185 ------------
186 $ git remote
187 origin
188 $ git branch -r
189 origin/master
190 $ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git
191 $ git remote
192 linux-nfs
193 origin
194 $ git fetch
195 * refs/remotes/linux-nfs/master: storing branch 'master' ...
196   commit: bf81b46
197 $ git branch -r
198 origin/master
199 linux-nfs/master
200 $ git checkout -b nfs linux-nfs/master
202 ------------
204 * Imitate 'git clone' but track only selected branches
206 ------------
207 $ mkdir project.git
208 $ cd project.git
209 $ git init
210 $ git remote add -f -t master -m master origin git://example.com/git.git/
211 $ git merge origin
212 ------------
215 SEE ALSO
216 --------
217 linkgit:git-fetch[1]
218 linkgit:git-branch[1]
219 linkgit:git-config[1]
223 Part of the linkgit:git[1] suite