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