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