Mercurial > hg
annotate doc/hg.1.txt @ 13503:5007ff32f356 stable
eol: test win32text compatible encode/decode filters
author | Martin Geisler <mg@aragost.com> |
---|---|
date | Mon, 28 Feb 2011 11:31:36 +0100 |
parents | 4f4eddee254d |
children | 05e522d3f186 |
rev | line source |
---|---|
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 |
9422
ec26d6986d85
doc: add TOC to hg.1.html and hgrc.5.html
Martin Geisler <mg@lazybytes.net>
parents:
9162
diff
changeset
|
14 .. contents:: |
ec26d6986d85
doc: add TOC to hg.1.html and hgrc.5.html
Martin Geisler <mg@lazybytes.net>
parents:
9162
diff
changeset
|
15 :backlinks: top |
ec26d6986d85
doc: add TOC to hg.1.html and hgrc.5.html
Martin Geisler <mg@lazybytes.net>
parents:
9162
diff
changeset
|
16 :class: htmlonly |
12776
4f4eddee254d
gendoc: move section commands to module scope
Martin Geisler <mg@lazybytes.net>
parents:
10263
diff
changeset
|
17 :depth: 1 |
9422
ec26d6986d85
doc: add TOC to hg.1.html and hgrc.5.html
Martin Geisler <mg@lazybytes.net>
parents:
9162
diff
changeset
|
18 |
177 | 19 |
9792
dd1a95ccbe07
doc: use titlecase in man page section titles
Martin Geisler <mg@lazybytes.net>
parents:
9705
diff
changeset
|
20 Synopsis |
177 | 21 -------- |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
22 **hg** *command* [*option*]... [*argument*]... |
177 | 23 |
9792
dd1a95ccbe07
doc: use titlecase in man page section titles
Martin Geisler <mg@lazybytes.net>
parents:
9705
diff
changeset
|
24 Description |
177 | 25 ----------- |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
26 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
|
27 system. |
177 | 28 |
9792
dd1a95ccbe07
doc: use titlecase in man page section titles
Martin Geisler <mg@lazybytes.net>
parents:
9705
diff
changeset
|
29 Command Elements |
177 | 30 ---------------- |
31 | |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
32 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
|
33 indicates one or more filename or relative path filenames; see |
9702
a9d15bf7efe2
doc: add some internal links to man pages
Martin Geisler <mg@lazybytes.net>
parents:
9510
diff
changeset
|
34 `File Name Patterns`_ for information on pattern matching |
177 | 35 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
36 path |
177 | 37 indicates a path on the local machine |
38 | |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
39 revision |
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
40 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
|
41 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
|
42 hash value |
177 | 43 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
44 repository path |
498 | 45 either the pathname of a local repository or the URI of a remote |
7211 | 46 repository. |
438 | 47 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
48 .. include:: hg.1.gendoc.txt |
438 | 49 |
9792
dd1a95ccbe07
doc: use titlecase in man page section titles
Martin Geisler <mg@lazybytes.net>
parents:
9705
diff
changeset
|
50 Files |
177 | 51 ----- |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
52 |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
53 ``.hgignore`` |
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
54 This file contains regular expressions (one per line) that |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
55 describe file names that should be ignored by **hg**. For details, |
9162
2399362b3bb0
doc: link man pages to one another
Martin Geisler <mg@lazybytes.net>
parents:
9161
diff
changeset
|
56 see |hgignore(5)|_. |
177 | 57 |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
58 ``.hgtags`` |
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
59 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
|
60 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
|
61 the repository contents. |
177 | 62 |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
63 ``/etc/mercurial/hgrc``, ``$HOME/.hgrc``, ``.hg/hgrc`` |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
64 This file contains defaults and configuration. Values in |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
65 ``.hg/hgrc`` override those in ``$HOME/.hgrc``, and these override |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
66 settings made in the global ``/etc/mercurial/hgrc`` configuration. |
9162
2399362b3bb0
doc: link man pages to one another
Martin Geisler <mg@lazybytes.net>
parents:
9161
diff
changeset
|
67 See |hgrc(5)|_ for details of the contents and format of these |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
68 files. |
321 | 69 |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
70 Some commands (e.g. revert) produce backup files ending in ``.orig``, |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
71 if the ``.orig`` file already exists and is not tracked by Mercurial, |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
72 it will be overwritten. |
3021
b9dbbcf8a488
Document the fact that revert might overwrite .orig files
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
2859
diff
changeset
|
73 |
9792
dd1a95ccbe07
doc: use titlecase in man page section titles
Martin Geisler <mg@lazybytes.net>
parents:
9705
diff
changeset
|
74 Bugs |
177 | 75 ---- |
9702
a9d15bf7efe2
doc: add some internal links to man pages
Martin Geisler <mg@lazybytes.net>
parents:
9510
diff
changeset
|
76 Probably lots, please post them to the mailing list (see Resources_ |
8728
9d67706ee8d5
hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
7211
diff
changeset
|
77 below) when you find them. |
177 | 78 |
9792
dd1a95ccbe07
doc: use titlecase in man page section titles
Martin Geisler <mg@lazybytes.net>
parents:
9705
diff
changeset
|
79 See Also |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
80 -------- |
9162
2399362b3bb0
doc: link man pages to one another
Martin Geisler <mg@lazybytes.net>
parents:
9161
diff
changeset
|
81 |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
|
82 |
9792
dd1a95ccbe07
doc: use titlecase in man page section titles
Martin Geisler <mg@lazybytes.net>
parents:
9705
diff
changeset
|
83 Author |
177 | 84 ------ |
85 Written by Matt Mackall <mpm@selenic.com> | |
86 | |
9792
dd1a95ccbe07
doc: use titlecase in man page section titles
Martin Geisler <mg@lazybytes.net>
parents:
9705
diff
changeset
|
87 Resources |
177 | 88 --------- |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
89 Main Web Site: http://mercurial.selenic.com/ |
177 | 90 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
91 Source code repository: http://selenic.com/hg |
177 | 92 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8936
diff
changeset
|
93 Mailing list: http://selenic.com/mailman/listinfo/mercurial |
177 | 94 |
9792
dd1a95ccbe07
doc: use titlecase in man page section titles
Martin Geisler <mg@lazybytes.net>
parents:
9705
diff
changeset
|
95 Copying |
177 | 96 ------- |
10209
c9194a7d7d3e
Update copyright year to 2010
Pascal Quantin <pascal.quantin@gmail.com>
parents:
9792
diff
changeset
|
97 Copyright (C) 2005-2010 Matt Mackall. |
177 | 98 Free use of this software is granted under the terms of the GNU General |
10263 | 99 Public License version 2 or any later version. |
9162
2399362b3bb0
doc: link man pages to one another
Martin Geisler <mg@lazybytes.net>
parents:
9161
diff
changeset
|
100 |
2399362b3bb0
doc: link man pages to one another
Martin Geisler <mg@lazybytes.net>
parents:
9161
diff
changeset
|
101 .. include:: common.txt |