HG(1)

hg

<mpm@selenic.com>
The files will be added to the repository at the next commit.
If no names are given, add all files in the current directory and
its subdirectories.
New files are ignored if they match any of the patterns in .hgignore. As
with add, these changes take effect at the next commit.
This command is useful to discover who did a change or when a change took
place.
Without the -a option, annotate will avoid processing files it
detects as binary. With -a, annotate will generate an annotation
anyway, probably with undesirable results.
options:
-a, --text            treat all files as text
-I, --include <pat>   include names matching the given patterns
-X, --exclude <pat>   exclude names matching the given patterns
-r, --revision <rev>  annotate the specified revision
-u, --user            list the author
-c, --changeset       list the changeset
-n, --number          list the revision number (default)
Generate a compressed changegroup file collecting all changesets
not found in the other repository.
This file can then be transferred using conventional means and
applied to another repository with the unbundle command. This is
useful when native push and pull are not available or when
exporting an entire repository is undesirable. The standard file
extension is ".hg".
Unlike import/export, this exactly preserves all changeset
contents including permissions, rename data, and revision history.
Output may be to a file, in which case the name of the file is
given using a format string.  The formatting rules are the same as
for the export command, with the following additions:
%s   basename of file being printed
%d   dirname of file being printed, or '.' if in repo root
%p   root-relative path name of file being printed
options:
-I, --include <pat>       include names matching the given patterns
-X, --exclude <pat>       exclude names matching the given patterns
-o, --output <filespec>   print output to file with formatted name
-r, --rev <rev>           print the given revision
If no destination directory name is specified, it defaults to the
basename of the source.
The source is added to the new repository's .hg/hgrc file to be used in
future pulls.
For efficiency, hardlinks are used for cloning whenever the
source and destination are on the same filesystem.
options:
-U, --noupdate   do not update the new working directory
-e, --ssh        specify ssh command to use
--remotecmd      specify hg command to run on the remote side
If a list of files is omitted, all changes reported by "hg status"
from the root of the repository will be commited.
The HGEDITOR or EDITOR environment variables are used to start an
editor to add a commit comment.
Options:
-A, --addremove       run addremove during commit
-I, --include <pat>   include names matching the given patterns
-X, --exclude <pat>   exclude names matching the given patterns
-m, --message <text>  use <text> as commit message
-l, --logfile <file>  read the commit message from <file>
-d, --date <datecode> record datecode as commit date
-u, --user <user>     record user as commiter
aliases: ci
By default, this command copies the contents of files as they
stand in the working directory.  If invoked with --after, the
operation is recorded, but no copying is performed.
This command takes effect in the next commit.
NOTE: This command should be treated as experimental. While it
should properly record copied files, this information is not yet
fully used by merge, nor fully reported by log.
Options:
-A, --after           record a copy that has already occurred
-I, --include <pat>   include names matching the given patterns
-X, --exclude <pat>   exclude names matching the given patterns
-f, --force           forcibly copy over an existing managed file
-p, --parents         append source path to dest
aliases: cp
Differences between files are shown using the unified diff format.
When two revision arguments are given, then changes are shown
between those revisions. If only one revision is specified then
that revision is compared to the working directory, and, when no
revisions are specified, the working directory files are compared
to its parent.
Without the -a option, diff will avoid generating diffs of files
it detects as binary. With -a, diff will generate a diff anyway,
probably with undesirable results.
options:
-a, --text           treat all files as text
-I, --include <pat>  include names matching the given patterns
-X, --exclude <pat>  exclude names matching the given patterns
The information shown in the changeset header is: author,
changeset hash, parent and commit comment.
Output may be to a file, in which case the name of the file is
given using a format string.  The formatting rules are as follows:
%%   literal "%" character
%H   changeset hash (40 bytes of hexadecimal)
%N   number of patches being generated
%R   changeset revision number
%b   basename of the exporting repository
%h   short-form changeset hash (12 bytes of hexadecimal)
%n   zero-padded sequence number, starting at 1
%r   zero-padded changeset revision number
Without the -a option, export will avoid generating diffs of files
it detects as binary. With -a, export will generate a diff anyway,
probably with undesirable results.
options:
-a, --text                treat all files as text
-o, --output <filespec>   print output to file with formatted name
options:
-I, --include <pat>  include names matching the given patterns
-X, --exclude <pat>  exclude names matching the given patterns
This command behaves differently than Unix grep.  It only accepts
Python/Perl regexps.  It searches repository history, not the
working directory.  It always prints the revision number in which
a match appears.
By default, grep only prints output for the first revision of a
file in which it finds a match.  To get it to print every revision
that contains a change in match status ("-" for a match that
becomes a non-match, or "+" for a non-match that becomes a match),
use the --all flag.
options:
-0, --print0              end fields with NUL
-I, --include <pat>       include names matching the given patterns
-X, --exclude <pat>       exclude names matching the given patterns
    --all                 print all revisions that match
-i, --ignore-case         ignore case when matching
-l, --files-with-matches  print only file names and revs that match
-n, --line-number         print matching line numbers
-r <rev>, --rev <rev>     search in given revision range
-u, --user                print user who committed change
Repository "heads" are changesets that don't have children
changesets. They are where development generally takes place and
are the usual targets for update and merge operations.
This summary identifies the repository state using one or two parent
hash identifiers, followed by a "+" if there are uncommitted changes
in the working directory, followed by a list of tags for this revision.
aliases: id
If there are outstanding changes in the working directory, import
will abort unless given the -f flag.
If a patch looks like a mail message (its first line starts with
"From " or looks like an RFC822 header), it will not be applied
unless the -f option is used.  The importer neither parses nor
discards mail headers, so use -f only to override the "mailness"
safety check, not to import a real mail message.
options:
-p, --strip <n>   directory strip option for patch. This has the same
                  meaning as the corresponding patch option
-b <path>         base directory to read patches from
-f, --force       skip check for outstanding uncommitted changes
aliases: patch
Currently only local repositories are supported.
options:
-p, --patch           show patch
aliases: in
If no directory is given, the current directory is used.
This command searches the current directory and its
subdirectories.  To search an entire repository, move to the root
of the repository.
If no patterns are given to match, this command prints all file
names.
If you want to feed the output of this command into the "xargs"
command, use the "-0" option to both this command and "xargs".
This will avoid the problem of "xargs" treating single filenames
that contain white space as multiple file names.
options:
-0, --print0         end filenames with NUL, for use with xargs
-f, --fullpath       print complete paths from the filesystem root
-I, --include <pat>  include names matching the given patterns
-r, --rev <rev>      search the repository as it stood at rev
-X, --exclude <pat>  exclude names matching the given patterns
By default this command outputs: changeset id and hash, tags,
parents, user, date and time, and a summary for each commit. The
-v switch adds some more detail, such as changed files, manifest
hashes or message signatures.
options:
-I, --include <pat>   include names matching the given patterns
-X, --exclude <pat>   exclude names matching the given patterns
-r, --rev <A>         show the specified revision or range
-p, --patch           show patch
aliases: history
The manifest is the list of files being version controlled. If no revision
is given then the tip is used.
options:
-p, --patch           show patch
aliases: out
Path names are defined in the [paths] section of /etc/mercurial/hgrc
and $HOME/.hgrc.  If run inside a repository, .hg/hgrc is used, too.
This finds all changes from the repository at the specified path
or URL and adds them to the local repository. By default, this
does not update the copy of the project in the working directory.
Valid URLs are of the form:
local/filesystem/path
http://[user@]host[:port][/path]
https://[user@]host[:port][/path]
ssh://[user@]host[:port][/path]
SSH requires an accessible shell account on the destination machine
and a copy of hg in the remote path.  With SSH, paths are relative
to the remote user's home directory by default; use two slashes at
the start of a path to specify it as relative to the filesystem root.
options:
-u, --update   update the working directory to tip after pull
-e, --ssh    specify ssh command to use
--remotecmd  specify hg command to run on the remote side
This is the symmetrical operation for pull. It helps to move
changes from the current repository to a different one. If the
destination is local this is identical to a pull in that directory
from the current one.
By default, push will refuse to run if it detects the result would
increase the number of remote heads. This generally indicates the
the client has forgotten to sync and merge before pushing.
Valid URLs are of the form:
local/filesystem/path
ssh://[user@]host[:port][/path]
SSH requires an accessible shell account on the destination
machine and a copy of hg in the remote path.
options:
-f, --force  force update
-e, --ssh    specify ssh command to use
--remotecmd  specify hg command to run on the remote side
This command is not intended to be used by normal users, as it is
primarily useful for importing from other SCMs.
This command tries to fix the repository status after an interrupted
operation. It should only be necessary when Mercurial suggests it.
This command schedules the files to be removed at the next commit.
This only removes files from the current branch, not from the
entire project history.  If the files still exist in the working
directory, they will be deleted from it.
aliases: rm
By default, this command copies the contents of files as they
stand in the working directory.  If invoked with --after, the
operation is recorded, but no copying is performed.
This command takes effect in the next commit.
NOTE: This command should be treated as experimental. While it
should properly record rename files, this information is not yet
fully used by merge, nor fully reported by log.
Options:
-A, --after        record a rename that has already occurred
-f, --force        forcibly copy over an existing managed file
-p, --parents      append source path to dest
aliases: mv
If a file has been deleted, it is recreated.  If the executable
mode of a file was changed, it is reset.
If a directory is given, all files in that directory and its
subdirectories are reverted.
If no arguments are given, all files in the current directory and
its subdirectories are reverted.
options:
-r, --rev <rev>       revision to revert to
-n, --nonrecursive    do not recurse into subdirectories
By default, the server logs accesses to stdout and errors to
stderr.  Use the "-A" and "-E" options to log to files.
options:
-A, --accesslog <file>   name of access log file to write to
-E, --errorlog <file>    name of error log file to write to
-a, --address <addr>     address to use
-p, --port <n>           port to use (default: 8000)
-n, --name <name>        name to show in web pages (default: working dir)
-t, --templatedir <path> web templates to use
-6, --ipv6               use IPv6 in addition to IPv4
The codes used to show the status of files are:
M = changed
A = added
R = removed
? = not tracked
options:
-m, --modified       show only modified files
-a, --added          show only added files
-r, --removed        show only removed files
-u, --unknown        show only unknown (not tracked) files
-n, --no-status      hide status prefix
-0, --print0         end filenames with NUL, for use with xargs
-I, --include <pat>  include names matching the given patterns
-X, --exclude <pat>  exclude names matching the given patterns
Tags are used to name particular revisions of the repository and are
very useful to compare different revision, to go back to significant
earlier versions or to mark branch points as releases, etc.
If no revision is given, the tip is used.
To facilitate version control, distribution, and merging of tags,
they are stored as a file named ".hgtags" which is managed
similarly to other project files and can be hand-edited if
necessary.
options:
-l, --local           make the tag local
-m, --message <text>  message for tag commit log entry
-d, --date <datecode> datecode for commit
-u, --user <user>     user for commit
Note: Local tags are not version-controlled or distributed and are
stored in the .hg/localtags file. If there exists a local tag and
a public tag with the same name, local tag is used.
This lists both regular and local tags.
Apply a compressed changegroup file generated by the bundle
command.
Roll back the last pull or commit transaction on the
repository, restoring the project to its earlier state.
This command should be used with care. There is only one level of
undo and there is no redo.
This command is not intended for use on public repositories. Once
a change is visible for pull by other users, undoing it locally is
ineffective.
By default, update will refuse to run if doing so would require
merging or discarding local changes.
With the -m option, a merge will be performed.
With the -C option, local changes will be lost.
options:
-m, --merge       allow merging of branches
-C, --clean       overwrite locally modified files
aliases: up checkout co
This will perform an extensive check of the repository's
integrity, validating the hashes and checksums of each entry in
the changelog, manifest, and tracked files, as well as the
integrity of their crosslinks and indices.
Mercurial accepts several notations for identifying one or more
file at a time.
By default, Mercurial treats file names as shell-style extended
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:
re:.*\.c$      any name ending in ".c", anywhere in the repository
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.
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.
A range acts as a closed interval.  This means that a range of 3:5
gives 3, 4 and 5.  Similarly, a range of 4:2 gives 4, 3, and 2.
(deprecated, use .hgrc)
The default program is "hgmerge", which is a shell script provided
by Mercurial with some sensible defaults.
(deprecated, use .hgrc)
(deprecated, use .hgrc)

HG(1)

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

COMMAND ELEMENTS

COMMANDS

FILE NAME PATTERNS

SPECIFYING SINGLE REVISIONS

SPECIFYING MULTIPLE REVISIONS

ENVIRONMENT VARIABLES

FILES

BUGS

SEE ALSO

AUTHOR

RESOURCES

COPYING