doc/hg.1.txt
author Johannes Stezenbach <js@sig21.net>
Tue, 03 Jun 2008 21:20:52 +0200
changeset 6655 ab798a37b846
parent 6490 b13dae8ed779
child 7211 25c0dee16ee0
permissions -rw-r--r--
help: move "revision syntax" help topics into online help Move the "Specifying Single Revisions" and "Specifying Multiple Revisions" help topics from the manual page into the helptable so they are available both online and in the manual page.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
6446
ee5313bc3c0c asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents: 5661
diff changeset
    33
    repository. There are two available URI protocols, http:// which is
2431
d90a9d7c7d4d replace old-http:// syntax by static-http:// and deprecate the redundant hg://
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 2209
diff changeset
    34
    fast and the static-http:// protocol which is much slower but does not
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    35
    require a special server on the web host.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    36
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    37
1814
7956893e8458 generate hg manpage from commands.py docstring
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 1758
diff changeset
    38
include::hg.1.gendoc.txt[]
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    39
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    40
FILES
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    41
-----
6487
9e3bddb5fae2 hg.1: bogus escaping of .hg* not needed anymore
Christian Ebert <blacktrash@gmx.net>
parents: 5661
diff changeset
    42
 .hgignore::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    43
    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
    44
    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
    45
6487
9e3bddb5fae2 hg.1: bogus escaping of .hg* not needed anymore
Christian Ebert <blacktrash@gmx.net>
parents: 5661
diff changeset
    46
 .hgtags::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    47
    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
    48
    separated by spaces) that correspond to tagged versions of the repository
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    49
    contents.
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    50
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
    51
 /etc/mercurial/hgrc, $HOME/.hgrc, .hg/hgrc::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    52
    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
    53
    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
    54
    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
    55
    the contents and format of these files.
321
73b8a8a059ec Transparent proxy support
mpm@selenic.com
parents: 196
diff changeset
    56
3021
b9dbbcf8a488 Document the fact that revert might overwrite .orig files
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 2859
diff changeset
    57
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
    58
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
    59
will be overwritten.
b9dbbcf8a488 Document the fact that revert might overwrite .orig files
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 2859
diff changeset
    60
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    61
BUGS
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    62
----
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    63
Probably lots, please post them to the mailing list (See Resources below)
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    64
when you find them.
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    65
671
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
    66
SEE ALSO
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
    67
--------
2209
956e329f9e13 document hgignore syntax in new file doc/hgignore.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents: 2031
diff changeset
    68
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
    69
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    70
AUTHOR
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    71
------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    72
Written by Matt Mackall <mpm@selenic.com>
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    73
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    74
RESOURCES
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    75
---------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    76
http://selenic.com/mercurial[Main Web Site]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    77
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    78
http://selenic.com/hg[Source code repository]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    79
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    80
http://selenic.com/mailman/listinfo/mercurial[Mailing list]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    81
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    82
COPYING
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    83
-------
4635
63b9d2deed48 Updated copyright notices and add "and others" to "hg version"
Thomas Arendsen Hein <thomas@intevation.de>
parents: 3799
diff changeset
    84
Copyright \(C) 2005-2007 Matt Mackall.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    85
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
    86
Public License (GPL).