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