blob: 7b59d9230a4d9caf112da4780ddb3ab61c340897 [file] [log] [blame]
Russ Coxd944f762007-11-04 20:30:18 -05001.TH HG 1
2.SH NAME
3hg \- introduction to using plan9port Mercurial repository
4.SH SYNOPSIS
5.B hg
6.B clone
7.B http://hg.pdos.csail.mit.edu/hg/plan9
8.B plan9
9.PP
10.B hg
11.B pull
12.B -u
13.PP
14.B hg
15.B diff
16[
17.B -r
18.I revision
19]
20[
21.I path ...
22]
23.PP
24.B hg
25.B serve
26.PP
27.B hg
28.B view
29.PP
30.B web
31.B http://hg.pdos.csail.mit.edu/hg/plan9/
32.SH DESCRIPTION
33The master source tree for Plan 9 from User Space is maintained
34using the source control system Mercurial
35as a substitute for Plan 9's
36\fIreplica\fR(8) and dump file system.
37(It is maintained simultaneously using CVS; see
38.IR cvs (1).)
39.PP
40The first argument to
41.I hg
42is a command, which determines the form of the rest of the command line.
43.PP
44The
45.B clone
46command downloads a copy of the tree into the directory
47.BR plan9 ,
48which it will create.
49After
50.B hg
51.BR clone ,
52the other commands listed
53should be run within the
54.B plan9
55directory tree.
56.PP
57Unlike CVS, Mercurial downloads the entire revision history
58of Plan 9 from User Space
59in addition to the current tree.
60.PP
61.I Hg
62.I pull
63incorporates changes from the master repository
64into the local revision history.
65The
66.B -u
67flag applies these changes to the current file tree.
68.PP
69.I Hg
70.I diff
71runs Unix's
72.IR diff (1)
73to compare the files in the local tree with the corresponding
74files in the revision history.
75By default it compares against the version that was most recently
76incorporated into the local tree.
77The
78.B -r
79flag specifies an alternate version to compare against.
80The special revision
81.B tip
82refers to the most recent version on the server.
83.PP
84.I Hg
85.I serve
86starts an HTTP server serving information about
87the local repository at the address
88.BR http://localhost:8000/ .
89.PP
90.I Hg
91.I view
92starts an interactive history viewer.
93.PP
94The Mercurial tree can be inspected on the web at
95.HR http://hg.pdos.csail.mit.edu/hg/plan9/ "" .
96.SH FILES
97.TP
98.B \*9/.hg
99directory containing Mercurial local repository
100.TP
101.B .hgignore
102list of files and wildcards to exclude from Mercurial operations
103.SH SEE ALSO
104.IR cvs (1)
105.PP
106Unix's
107\fIhg\fR(1),
108.HR http://www.selenic.com/mercurial/wiki/
109.PP
110.HR http://hg.pdos.csail.mit.edu/hg/plan9/
111.SH BUGS
112The use of Mercurial for accessing Plan 9 from User Space
113should be considered experimental.
114People uncomfortable with Mercurial should continue to use
115.IR cvs (1).