Mercurial > hg

annotate doc/hg.1.txt @ 7376:fc06bd17c985

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: handle shortened command synopses
author Matt Mackall <mpm@selenic.com>
date Fri, 14 Nov 2008 14:12:16 -0600
parents 25c0dee16ee0
children 9d67706ee8d5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
1 HG(1)
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
2 =====
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
3 Matt Mackall <mpm@selenic.com>
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
4
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
5 NAME
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
6 ----
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
7 hg - Mercurial source code management system
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
8
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
9 SYNOPSIS
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
10 --------
3544
4745cf66f77d Corrected hg synopsis.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 3287
diff changeset
11 'hg' [global option]... <command> [command/global option]... [argument]...
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
12
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
13 DESCRIPTION
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
14 -----------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
15 The hg(1) command provides a command line interface to the Mercurial system.
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
16
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
17 COMMAND ELEMENTS
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
18 ----------------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
19
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
20 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
21 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
22 "FILE NAME PATTERNS" for information on pattern matching
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
23
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
24 path::
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
25 indicates a path on the local machine
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
26
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
27 revision::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
28 indicates a changeset which can be specified as a changeset revision
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
29 number, a tag, or a unique substring of the changeset hash value
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
30
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
31 repository path::
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
32 either the pathname of a local repository or the URI of a remote
7211
25c0dee16ee0 Autodetect static-http
Matt Mackall <mpm@selenic.com>
parents: 6655
diff changeset
33 repository.
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
34
1814
7956893e8458 generate hg manpage from commands.py docstring
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 1758
diff changeset
35 include::hg.1.gendoc.txt[]
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
36
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
37 FILES
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
38 -----
6487
9e3bddb5fae2 hg.1: bogus escaping of .hg* not needed anymore
Christian Ebert <blacktrash@gmx.net>
parents: 5661
diff changeset
39 .hgignore::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
40 This file contains regular expressions (one per line) that describe file
2209
956e329f9e13 document hgignore syntax in new file doc/hgignore.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents: 2031
diff changeset
41 names that should be ignored by hg. For details, see hgignore(5).
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
42
6487
9e3bddb5fae2 hg.1: bogus escaping of .hg* not needed anymore
Christian Ebert <blacktrash@gmx.net>
parents: 5661
diff changeset
43 .hgtags::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
44 This file contains changeset hash values and text tag names (one of each
1045
b35d5b86e240 run the doc/* through aspell.
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 1036
diff changeset
45 separated by spaces) that correspond to tagged versions of the repository
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
46 contents.
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
47
951
859de3ebc041 Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 940
diff changeset
48 /etc/mercurial/hgrc, $HOME/.hgrc, .hg/hgrc::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
49 This file contains defaults and configuration. Values in .hg/hgrc
951
859de3ebc041 Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 940
diff changeset
50 override those in $HOME/.hgrc, and these override settings made in the
6446
ee5313bc3c0c asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents: 5661
diff changeset
51 global /etc/mercurial/hgrc configuration. See hgrc(5) for details of
951
859de3ebc041 Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 940
diff changeset
52 the contents and format of these files.
321
73b8a8a059ec Transparent proxy support
mpm@selenic.com
parents: 196
diff changeset
53
3021
b9dbbcf8a488 Document the fact that revert might overwrite .orig files
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 2859
diff changeset
54 Some commands (e.g. revert) produce backup files ending in .orig, if
b9dbbcf8a488 Document the fact that revert might overwrite .orig files
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 2859
diff changeset
55 the .orig file already exists and is not tracked by Mercurial, it
b9dbbcf8a488 Document the fact that revert might overwrite .orig files
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 2859
diff changeset
56 will be overwritten.
b9dbbcf8a488 Document the fact that revert might overwrite .orig files
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 2859
diff changeset
57
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
58 BUGS
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
59 ----
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
60 Probably lots, please post them to the mailing list (See Resources below)
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
61 when you find them.
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
62
671
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
63 SEE ALSO
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
64 --------
2209
956e329f9e13 document hgignore syntax in new file doc/hgignore.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents: 2031
diff changeset
65 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
66
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
67 AUTHOR
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
68 ------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
69 Written by Matt Mackall <mpm@selenic.com>
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
70
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
71 RESOURCES
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
72 ---------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
73 http://selenic.com/mercurial[Main Web Site]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
74
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
75 http://selenic.com/hg[Source code repository]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
76
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
77 http://selenic.com/mailman/listinfo/mercurial[Mailing list]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
78
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
79 COPYING
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
80 -------
4635
63b9d2deed48 Updated copyright notices and add "and others" to "hg version"
Thomas Arendsen Hein <thomas@intevation.de>
parents: 3799
diff changeset
81 Copyright \(C) 2005-2007 Matt Mackall.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
82 Free use of this software is granted under the terms of the GNU General
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
83 Public License (GPL).