author | Martin Geisler <mg@lazybytes.net> |
Thu, 16 Jul 2009 23:25:26 +0200 | |
changeset 9158 | d6eecafaf12f |
parent 8936 | 1de6e7e1bb9f |
child 9161 | e8b653a4b8da |
permissions | -rw-r--r-- |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
1 |
==== |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
2 |
hg |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
3 |
==== |
177 | 4 |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
5 |
--------------------------------------- |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
6 |
Mercurial source code management system |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
7 |
--------------------------------------- |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
8 |
|
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
9 |
:Author: Matt Mackall <mpm@selenic.com> |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
10 |
:Organization: Mercurial |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
11 |
:Manual section: 1 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
12 |
:Manual group: Mercurial Manual |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
13 |
|
177 | 14 |
|
15 |
SYNOPSIS |
|
16 |
-------- |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
17 |
**hg** *command* [*option*]... [*argument*]... |
177 | 18 |
|
19 |
DESCRIPTION |
|
20 |
----------- |
|
8775
8e15f4afdf06
hg.1: highlight references to commands and man pages
Martin Geisler <mg@lazybytes.net>
parents:
8774
diff
changeset
|
21 |
The *hg* command provides a command line interface to the Mercurial |
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
22 |
system. |
177 | 23 |
|
24 |
COMMAND ELEMENTS |
|
25 |
---------------- |
|
26 |
||
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
27 |
files... |
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
28 |
indicates one or more filename or relative path filenames; see |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
29 |
"FILE NAME PATTERNS" for information on pattern matching |
177 | 30 |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
31 |
path |
177 | 32 |
indicates a path on the local machine |
33 |
||
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
34 |
revision |
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
35 |
indicates a changeset which can be specified as a changeset |
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
36 |
revision number, a tag, or a unique substring of the changeset |
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
37 |
hash value |
177 | 38 |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
39 |
repository path |
498 | 40 |
either the pathname of a local repository or the URI of a remote |
7211 | 41 |
repository. |
438 | 42 |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
43 |
.. include:: hg.1.gendoc.txt |
438 | 44 |
|
177 | 45 |
FILES |
46 |
----- |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
47 |
|
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
48 |
`.hgignore` |
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
49 |
This file contains regular expressions (one per line) that |
8775
8e15f4afdf06
hg.1: highlight references to commands and man pages
Martin Geisler <mg@lazybytes.net>
parents:
8774
diff
changeset
|
50 |
describe file names that should be ignored by *hg*. For details, |
8e15f4afdf06
hg.1: highlight references to commands and man pages
Martin Geisler <mg@lazybytes.net>
parents:
8774
diff
changeset
|
51 |
see *hgignore(5)*. |
177 | 52 |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
53 |
`.hgtags` |
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
54 |
This file contains changeset hash values and text tag names (one |
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
55 |
of each separated by spaces) that correspond to tagged versions of |
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
56 |
the repository contents. |
177 | 57 |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
58 |
`/etc/mercurial/hgrc`, `$HOME/.hgrc`, `.hg/hgrc` |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8728
diff
changeset
|
59 |
This file contains defaults and configuration. Values in `.hg/hgrc` |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8728
diff
changeset
|
60 |
override those in `$HOME/.hgrc`, and these override settings made in |
8775
8e15f4afdf06
hg.1: highlight references to commands and man pages
Martin Geisler <mg@lazybytes.net>
parents:
8774
diff
changeset
|
61 |
the global `/etc/mercurial/hgrc` configuration. See *hgrc(5)* for |
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
62 |
details of the contents and format of these files. |
321 | 63 |
|
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8728
diff
changeset
|
64 |
Some commands (e.g. revert) produce backup files ending in `.orig`, if |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8728
diff
changeset
|
65 |
the `.orig` file already exists and is not tracked by Mercurial, it will |
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
66 |
be overwritten. |
3021
b9dbbcf8a488
Document the fact that revert might overwrite .orig files
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
2859
diff
changeset
|
67 |
|
177 | 68 |
BUGS |
69 |
---- |
|
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
70 |
Probably lots, please post them to the mailing list (See Resources |
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
71 |
below) when you find them. |
177 | 72 |
|
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
73 |
SEE ALSO |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
74 |
-------- |
8775
8e15f4afdf06
hg.1: highlight references to commands and man pages
Martin Geisler <mg@lazybytes.net>
parents:
8774
diff
changeset
|
75 |
*hgignore(5)*, *hgrc(5)* |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
76 |
|
177 | 77 |
AUTHOR |
78 |
------ |
|
79 |
Written by Matt Mackall <mpm@selenic.com> |
|
80 |
||
81 |
RESOURCES |
|
82 |
--------- |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
83 |
Main Web Site: http://mercurial.selenic.com/ |
177 | 84 |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
85 |
Source code repository: http://selenic.com/hg |
177 | 86 |
|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
87 |
Mailing list: http://selenic.com/mailman/listinfo/mercurial |
177 | 88 |
|
89 |
COPYING |
|
90 |
------- |
|
8771
a2871de50f50
man pages: updated copyright years
Martin Geisler <mg@lazybytes.net>
parents:
8766
diff
changeset
|
91 |
Copyright \(C) 2005-2009 Matt Mackall. |
177 | 92 |
Free use of this software is granted under the terms of the GNU General |
93 |
Public License (GPL). |