Documentation: add git-remote man page
Add a preliminary man page for git-remote. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
J. Bruce Fields committed
Jan 8, 2007 at 23:28 UTC
041e69c9984972c51cbf21a70b0327d83dee41db
1 file changed
+76
Documentation/git-remote.txt
new
+76
@@ -0,0 +1,76 @@
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'
13
+'git-remote' add <name> <url>
14
+'git-remote' show <name>
15
+
16
+DESCRIPTION
17
+-----------
18
+
19
+Manage the set of repositories ("remotes") whose branches you track.
20
+
21
+With no arguments, shows a list of existing remotes.
22
+
23
+In the second form, adds a remote named <name> for the repository at
24
+<url>. The command `git fetch <name>` can then be used to create and
25
+update remote-tracking branches <name>/<branch>.
26
+
27
+In the third form, gives some information about the remote <name>.
28
+
29
+The remote configuration is achieved using the `remote.origin.url` and
30
+`remote.origin.fetch` configuration variables. (See
31
+gitlink:git-repo-config[1]).
32
+
33
+Examples
34
+--------
35
+
36
+Add a new remote, fetch, and check out a branch from it:
37
+
38
+------------
39
+$ git remote
40
+origin
41
+$ git branch -r
42
+origin/master
43
+$ git remote add linux-nfs git://linux-nfs.org/pub/nfs-2.6.git
44
+$ git remote
45
+linux-nfs
46
+origin
47
+$ git fetch
48
+* refs/remotes/linux-nfs/master: storing branch 'master' ...
49
+ commit: bf81b46
50
+$ git branch -r
51
+origin/master
52
+linux-nfs/master
53
+$ git checkout -b nfs linux-nfs/master
54
+...
55
+------------
56
+
57
+See Also
58
+--------
59
+gitlink:git-fetch[1]
60
+gitlink:git-branch[1]
61
+gitlink:git-repo-config[1]
62
+
63
+Author
64
+------
65
+Written by Junio Hamano
66
+
67
+
68
+Documentation
69
+--------------
70
+Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>.
71
+
72
+
73
+GIT
74
+---
75
+Part of the gitlink:git[7] suite
76
+