hg.1.txt
221 lines
| 6.8 KiB
| text/plain
|
TextLexer
/ doc / hg.1.txt
jake@edge2.net
|
r177 | HG(1) | ||
===== | ||||
Matt Mackall <mpm@selenic.com> | ||||
NAME | ||||
---- | ||||
mpm@selenic.com
|
r438 | hg - Mercurial source code management system | ||
jake@edge2.net
|
r177 | |||
SYNOPSIS | ||||
-------- | ||||
'hg' [-v -d -q -y] <command> [command options] [files] | ||||
DESCRIPTION | ||||
----------- | ||||
The hg(1) command provides a command line interface to the Mercurial system. | ||||
COMMAND ELEMENTS | ||||
---------------- | ||||
files ...:: | ||||
Bryan O'Sullivan
|
r724 | indicates one or more filename or relative path filenames; see | ||
"FILE NAME PATTERNS" for information on pattern matching | ||||
jake@edge2.net
|
r177 | |||
path:: | ||||
indicates a path on the local machine | ||||
Thomas Arendsen Hein
|
r478 | revision:: | ||
mpm@selenic.com
|
r438 | indicates a changeset which can be specified as a changeset revision | ||
number, a tag, or a unique substring of the changeset hash value | ||||
jake@edge2.net
|
r177 | |||
repository path:: | ||||
mpm@selenic.com
|
r498 | either the pathname of a local repository or the URI of a remote | ||
jake@edge2.net
|
r181 | repository. There are two available URI protocols, http:// which is | ||
Thomas Arendsen Hein
|
r478 | fast and the old-http:// protocol which is much slower but does not | ||
mpm@selenic.com
|
r438 | require a special server on the web host. | ||
jake@edge2.net
|
r177 | |||
mpm@selenic.com
|
r438 | |||
Benoit Boissinot
|
r1814 | include::hg.1.gendoc.txt[] | ||
mpm@selenic.com
|
r438 | |||
Bryan O'Sullivan
|
r724 | FILE NAME PATTERNS | ||
------------------ | ||||
Mercurial accepts several notations for identifying one or more | ||||
Florian La Roche
|
r1274 | files at a time. | ||
Bryan O'Sullivan
|
r724 | |||
Florian La Roche
|
r1274 | By default, Mercurial treats filenames as shell-style extended | ||
Bryan O'Sullivan
|
r724 | glob patterns. | ||
Alternate pattern notations must be specified explicitly. | ||||
To use a plain path name without any pattern matching, start a | ||||
name with "path:". These path names must match completely, from | ||||
the root of the current repository. | ||||
To use an extended glob, start a name with "glob:". Globs are | ||||
rooted at the current directory; a glob such as "*.c" will match | ||||
files ending in ".c" in the current directory only. | ||||
The supported glob syntax extensions are "**" to match any string | ||||
across path separators, and "{a,b}" to mean "a or b". | ||||
To use a Perl/Python regular expression, start a name with "re:". | ||||
Regexp pattern matching is anchored at the root of the repository. | ||||
Plain examples: | ||||
path:foo/bar a name bar in a directory named foo in the root of | ||||
the repository | ||||
path:path:name a file or directory named "path:name" | ||||
Glob examples: | ||||
glob:*.c any name ending in ".c" in the current directory | ||||
*.c any name ending in ".c" in the current directory | ||||
**.c any name ending in ".c" in the current directory, or | ||||
any subdirectory | ||||
foo/*.c any name ending in ".c" in the directory foo | ||||
foo/**.c any name ending in ".c" in the directory foo, or any | ||||
subdirectory | ||||
Regexp examples: | ||||
Benoit Boissinot
|
r1045 | re:.*\.c$ any name ending in ".c", anywhere in the repository | ||
Bryan O'Sullivan
|
r724 | |||
mpm@selenic.com
|
r580 | SPECIFYING SINGLE REVISIONS | ||
--------------------------- | ||||
Mercurial accepts several notations for identifying individual | ||||
revisions. | ||||
A plain integer is treated as a revision number. Negative | ||||
integers are treated as offsets from the tip, with -1 denoting the | ||||
tip. | ||||
A 40-digit hexadecimal string is treated as a unique revision | ||||
identifier. | ||||
A hexadecimal string less than 40 characters long is treated as a | ||||
unique revision identifier, and referred to as a short-form | ||||
identifier. A short-form identifier is only valid if it is the | ||||
prefix of one full-length identifier. | ||||
Any other string is treated as a tag name, which is a symbolic | ||||
name associated with a revision identifier. Tag names may not | ||||
contain the ":" character. | ||||
The reserved name "tip" is a special tag that always identifies | ||||
the most recent revision. | ||||
SPECIFYING MULTIPLE REVISIONS | ||||
----------------------------- | ||||
When Mercurial accepts more than one revision, they may be | ||||
specified individually, or provided as a continuous range, | ||||
separated by the ":" character. | ||||
The syntax of range notation is [BEGIN]:[END], where BEGIN and END | ||||
are revision identifiers. Both BEGIN and END are optional. If | ||||
BEGIN is not specified, it defaults to revision number 0. If END | ||||
is not specified, it defaults to the tip. The range ":" thus | ||||
means "all revisions". | ||||
If BEGIN is greater than END, revisions are treated in reverse | ||||
order. | ||||
Thomas Arendsen Hein
|
r860 | A range acts as a closed interval. This means that a range of 3:5 | ||
mpm@selenic.com
|
r580 | gives 3, 4 and 5. Similarly, a range of 4:2 gives 4, 3, and 2. | ||
jake@edge2.net
|
r196 | |||
jake@edge2.net
|
r177 | ENVIRONMENT VARIABLES | ||
--------------------- | ||||
mpm@selenic.com
|
r438 | |||
Thomas Arendsen Hein
|
r478 | HGEDITOR:: | ||
This is the name of the editor to use when committing. Defaults to the | ||||
Thomas Arendsen Hein
|
r1216 | value of EDITOR. | ||
Matt Mackall
|
r608 | |||
(deprecated, use .hgrc) | ||||
Thomas Arendsen Hein
|
r478 | |||
jake@edge2.net
|
r177 | HGMERGE:: | ||
mpm@selenic.com
|
r498 | An executable to use for resolving merge conflicts. The program | ||
mpm@selenic.com
|
r438 | will be executed with three arguments: local file, remote file, | ||
ancestor file. | ||||
The default program is "hgmerge", which is a shell script provided | ||||
by Mercurial with some sensible defaults. | ||||
jake@edge2.net
|
r177 | |||
Matt Mackall
|
r608 | (deprecated, use .hgrc) | ||
Vadim Gelfer
|
r1951 | HGRCPATH:: | ||
A list of files or directories to search for hgrc files. Item | ||||
separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set, | ||||
platform default search path is used. If empty, only .hg/hgrc of | ||||
current repository is read. | ||||
For each element in path, if a directory, all entries in directory | ||||
ending with ".rc" are added to path. Else, element itself is | ||||
added to path. | ||||
jake@edge2.net
|
r177 | HGUSER:: | ||
mpm@selenic.com
|
r438 | This is the string used for the author of a commit. | ||
jake@edge2.net
|
r177 | |||
Matt Mackall
|
r608 | (deprecated, use .hgrc) | ||
jake@edge2.net
|
r177 | EMAIL:: | ||
mpm@selenic.com
|
r438 | If HGUSER is not set, this will be used as the author for a commit. | ||
jake@edge2.net
|
r177 | |||
LOGNAME:: | ||||
Thomas Arendsen Hein
|
r478 | If neither HGUSER nor EMAIL is set, LOGNAME will be used (with | ||
mpm@selenic.com
|
r438 | '@hostname' appended) as the author value for a commit. | ||
jake@edge2.net
|
r177 | |||
EDITOR:: | ||||
Thomas Arendsen Hein
|
r478 | This is the name of the editor used in the hgmerge script. It will be | ||
mpm@selenic.com
|
r498 | used for commit messages if HGEDITOR isn't set. Defaults to 'vi'. | ||
mpm@selenic.com
|
r438 | |||
PYTHONPATH:: | ||||
This is used by Python to find imported modules and may need to be set | ||||
appropriately if Mercurial is not installed system-wide. | ||||
jake@edge2.net
|
r177 | |||
FILES | ||||
----- | ||||
.hgignore:: | ||||
mpm@selenic.com
|
r438 | This file contains regular expressions (one per line) that describe file | ||
Vadim Gelfer
|
r2209 | names that should be ignored by hg. For details, see hgignore(5). | ||
jake@edge2.net
|
r177 | |||
.hgtags:: | ||||
mpm@selenic.com
|
r438 | This file contains changeset hash values and text tag names (one of each | ||
Benoit Boissinot
|
r1045 | separated by spaces) that correspond to tagged versions of the repository | ||
jake@edge2.net
|
r177 | contents. | ||
Thomas Arendsen Hein
|
r951 | /etc/mercurial/hgrc, $HOME/.hgrc, .hg/hgrc:: | ||
mpm@selenic.com
|
r438 | This file contains defaults and configuration. Values in .hg/hgrc | ||
Thomas Arendsen Hein
|
r951 | override those in $HOME/.hgrc, and these override settings made in the | ||
global /etc/mercurial/hgrc configuration. See hgrc(5) for details of | ||||
the contents and format of these files. | ||||
mpm@selenic.com
|
r321 | |||
jake@edge2.net
|
r177 | BUGS | ||
---- | ||||
Probably lots, please post them to the mailing list (See Resources below) | ||||
when you find them. | ||||
Bryan O'Sullivan
|
r671 | SEE ALSO | ||
-------- | ||||
Vadim Gelfer
|
r2209 | hgignore(5), hgrc(5) | ||
Bryan O'Sullivan
|
r671 | |||
jake@edge2.net
|
r177 | AUTHOR | ||
------ | ||||
Written by Matt Mackall <mpm@selenic.com> | ||||
RESOURCES | ||||
--------- | ||||
http://selenic.com/mercurial[Main Web Site] | ||||
http://selenic.com/hg[Source code repository] | ||||
http://selenic.com/mailman/listinfo/mercurial[Mailing list] | ||||
COPYING | ||||
------- | ||||
Vincent Danjean
|
r1341 | Copyright \(C) 2005 Matt Mackall. | ||
jake@edge2.net
|
r177 | Free use of this software is granted under the terms of the GNU General | ||
Public License (GPL). | ||||