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