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