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' [-v | --verbose]
  13 'git remote add' [-t <branch>] [-m <master>] [-f] [--mirror] <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' [--add] <name> <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]...
  24
  25 DESCRIPTION
  26 -----------
  27
  28 Manage the set of repositories ("remotes") whose branches you track.
  29
  30
  31 OPTIONS
  32 -------
  33
  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`.
  38
  39
  40 COMMANDS
  41 --------
  42
  43 With no arguments, shows a list of existing remotes.  Several
  44 subcommands are available to perform operations on the remotes.
  45
  46 'add'::
  47
  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>.
  51 +
  52 With `-f` option, `git fetch <name>` is run immediately after
  53 the remote information is set up.
  54 +
  55 With `-t <branch>` option, instead of the default glob
  56 refspec for the remote to track all branches under
  57 `$GIT_DIR/remotes/<name>/`, a refspec to track only `<branch>`
  58 is created.  You can give more than one `-t <branch>` to track
  59 multiple branches without grabbing all branches.
  60 +
  61 With `-m <master>` option, `$GIT_DIR/remotes/<name>/HEAD` is set
  62 up to point at remote's `<master>` branch. See also the set-head command.
  63 +
  64 In mirror mode, enabled with `\--mirror`, the refs will not be stored
  65 in the 'refs/remotes/' namespace, but in 'refs/heads/'.  This option
  66 only makes sense in bare repositories.  If a remote uses mirror
  67 mode, furthermore, `git push` will always behave as if `\--mirror`
  68 was passed.
  69
  70 'rename'::
  71
  72 Rename the remote named <old> to <new>. All remote tracking branches and
  73 configuration settings for the remote are updated.
  74 +
  75 In case <old> and <new> are the same, and <old> is a file under
  76 `$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to
  77 the configuration file format.
  78
  79 'rm'::
  80
  81 Remove the remote named <name>. All remote tracking branches and
  82 configuration settings for the remote are removed.
  83
  84 'set-head'::
  85
  86 Sets or deletes the default branch (`$GIT_DIR/remotes/<name>/HEAD`) for
  87 the named remote. Having a default branch for a remote is not required,
  88 but allows the name of the remote to be specified in lieu of a specific
  89 branch. For example, if the default branch for `origin` is set to
  90 `master`, then `origin` may be specified wherever you would normally
  91 specify `origin/master`.
  92 +
  93 With `-d`, `$GIT_DIR/remotes/<name>/HEAD` is deleted.
  94 +
  95 With `-a`, the remote is queried to determine its `HEAD`, then
  96 `$GIT_DIR/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote
  97 `HEAD` is pointed at `next`, "`git remote set-head origin -a`" will set
  98 `$GIT_DIR/refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will
  99 only work if `refs/remotes/origin/next` already exists; if not it must be
 100 fetched first.
 101 +
 102 Use `<branch>` to set `$GIT_DIR/remotes/<name>/HEAD` explicitly. e.g., "git
 103 remote set-head origin master" will set `$GIT_DIR/refs/remotes/origin/HEAD` to
 104 `refs/remotes/origin/master`. This will only work if
 105 `refs/remotes/origin/master` already exists; if not it must be fetched first.
 106 +
 107
 108 'set-branches'::
 109
 110 Changes the list of branches tracked by the named remote.
 111 This can be used to track a subset of the available remote branches
 112 after the initial setup for a remote.
 113 +
 114 The named branches will be interpreted as if specified with the
 115 `-t` option on the 'git remote add' command line.
 116 +
 117 With `--add`, instead of replacing the list of currently tracked
 118 branches, adds to that list.
 119
 120 'set-url'::
 121
 122 Changes URL remote points to. Sets first URL remote points to matching
 123 regex <oldurl> (first URL if no <oldurl> is given) to <newurl>. If
 124 <oldurl> doesn't match any URL, error occurs and nothing is changed.
 125 +
 126 With '--push', push URLs are manipulated instead of fetch URLs.
 127 +
 128 With '--add', instead of changing some URL, new URL is added.
 129 +
 130 With '--delete', instead of changing some URL, all URLs matching
 131 regex <url> are deleted. Trying to delete all non-push URLs is an
 132 error.
 133
 134 'show'::
 135
 136 Gives some information about the remote <name>.
 137 +
 138 With `-n` option, the remote heads are not queried first with
 139 `git ls-remote <name>`; cached information is used instead.
 140
 141 'prune'::
 142
 143 Deletes all stale tracking branches under <name>.
 144 These stale branches have already been removed from the remote repository
 145 referenced by <name>, but are still locally available in
 146 "remotes/<name>".
 147 +
 148 With `--dry-run` option, report what branches will be pruned, but do not
 149 actually prune them.
 150
 151 'update'::
 152
 153 Fetch updates for a named set of remotes in the repository as defined by
 154 remotes.<group>.  If a named group is not specified on the command line,
 155 the configuration parameter remotes.default will be used; if
 156 remotes.default is not defined, all remotes which do not have the
 157 configuration parameter remote.<name>.skipDefaultUpdate set to true will
 158 be updated.  (See linkgit:git-config[1]).
 159 +
 160 With `--prune` option, prune all the remotes that are updated.
 161
 162
 163 DISCUSSION
 164 ----------
 165
 166 The remote configuration is achieved using the `remote.origin.url` and
 167 `remote.origin.fetch` configuration variables.  (See
 168 linkgit:git-config[1]).
 169
 170 Examples
 171 --------
 172
 173 * Add a new remote, fetch, and check out a branch from it
 174 +
 175 ------------
 176 $ git remote
 177 origin
 178 $ git branch -r
 179 origin/master
 180 $ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git
 181 $ git remote
 182 linux-nfs
 183 origin
 184 $ git fetch
 185 * refs/remotes/linux-nfs/master: storing branch 'master' ...
 186   commit: bf81b46
 187 $ git branch -r
 188 origin/master
 189 linux-nfs/master
 190 $ git checkout -b nfs linux-nfs/master
 191 ...
 192 ------------
 193
 194 * Imitate 'git clone' but track only selected branches
 195 +
 196 ------------
 197 $ mkdir project.git
 198 $ cd project.git
 199 $ git init
 200 $ git remote add -f -t master -m master origin git://example.com/git.git/
 201 $ git merge origin
 202 ------------
 203
 204
 205 SEE ALSO
 206 --------
 207 linkgit:git-fetch[1]
 208 linkgit:git-branch[1]
 209 linkgit:git-config[1]
 210
 211 Author
 212 ------
 213 Written by Junio Hamano
 214
 215
 216 Documentation
 217 --------------
 218 Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>.
 219
 220
 221 GIT
 222 ---
 223 Part of the linkgit:git[1] suite