HG(1) HG(1)
NAME
hg - Mercurial source code management system
SYNOPSIS
hg [ globaloptions ] command [ commandoptions ] [ arguments
]
DESCRIPTION
The hg command provides a command line interface to the Mer-
curial system.
COMMAND ELEMENTS
files ...
indicates one or more filename or relative path file-
names; see FILE PATTERNS for information on pattern
matching
path
indicates a path on the local machine
revision
indicates a changeset which can be specified as a
changeset revision number, a tag, or a unique substring
of the changeset hash value
repository path
either the pathname of a local repository or the URI of
a remote repository. There are two available URI proto-
cols, http:// which is fast and the static-http:// pro-
tocol which is much slower but does not require a spe-
cial server on the web host.
OPTIONS
-R, --repository
repository root directory or symbolic path name
--cwd
change working directory
-y, --noninteractive
do not prompt, assume yes for any required answers
-q, --quiet
suppress output
-v, --verbose
enable additional output
--config
Page 1 Plan 9 (printed 4/20/24)
HG(1) HG(1)
set/override config option
--debug
enable debugging output
--debugger
start debugger
--encoding
set the charset encoding (default: UTF-8)
--encodingmode
set the charset encoding mode (default: strict)
--lsprof
print improved command execution profile
--traceback
print traceback on exception
--time
time how long the command takes
--profile
print command execution profile
--version
output version information and exit
-h, --help
display help and exit
COMMANDS
add [OPTION]... [FILE]...
Schedule files to be version controlled and added to the
repository.
The files will be added to the repository at the next commit. To
undo an add before that, see hg revert.
If no names are given, add all files in the repository.
options:
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
-n, --dry-run do not perform actions, just print output
addremove [OPTION]... [FILE]...
Add all new files and remove all missing files from the
repository.
New files are ignored if they match any of the patterns in .hgignore. As
Page 2 Plan 9 (printed 4/20/24)
HG(1) HG(1)
with add, these changes take effect at the next commit.
Use the -s option to detect renamed files. With a parameter > 0,
this compares every removed file with every added file and records
those similar enough as renames. This option takes a percentage
between 0 (disabled) and 100 (files must be identical) as its
parameter. Detecting renamed files this way can be expensive.
options:
-s, --similarity guess renamed files by similarity (0<=s<=100)
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
-n, --dry-run do not perform actions, just print output
annotate [-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...
List changes in files, showing the revision id responsi-
ble for each line
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:
-r, --rev annotate the specified revision
-f, --follow follow file copies and renames
-a, --text treat all files as text
-u, --user list the author (long with -v)
-d, --date list the date (short with -q)
-n, --number list the revision number (default)
-c, --changeset list the changeset
-l, --line-number show line number at the first appearance
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
aliases: blame
archive [OPTION]... DEST
By default, the revision used is the parent of the work-
ing directory; use "-r" to specify a different revision.
To specify the type of archive to create, use "-t". Valid
types are:
"files" (default): a directory full of files
"tar": tar archive, uncompressed
"tbz2": tar archive, compressed using bzip2
"tgz": tar archive, compressed using gzip
"uzip": zip archive, uncompressed
"zip": zip archive, compressed using deflate
Page 3 Plan 9 (printed 4/20/24)
HG(1) HG(1)
The exact name of the destination archive or directory is given
using a format string; see "hg help export" for details.
Each member added to an archive file has a directory prefix
prepended. Use "-p" to specify a format string for the prefix.
The default is the basename of the archive, with suffixes removed.
options:
--no-decode do not pass files through decoders
-p, --prefix directory prefix for files in archive
-r, --rev revision to distribute
-t, --type type of distribution to create
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
backout [OPTION]... [-r] REV
Commit the backed out changes as a new changeset. The
new changeset is a child of the backed out changeset.
If you back out a changeset other than the tip, a new head is
created. This head will be the new tip and you should merge this
backout changeset with another head (current one by default).
The --merge option remembers the parent of the working directory
before starting the backout, then merges the new head with that
changeset afterwards. This saves you from doing the merge by
hand. The result of this merge is not committed, as for a normal
merge.
See 'hg help dates' for a list of formats valid for -d/--date.
options:
--merge merge with old dirstate parent after backout
--parent parent to choose when backing out merge
-r, --rev revision to backout
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
-m, --message use <text> as commit message
-l, --logfile read commit message from <file>
-d, --date record datecode as commit date
-u, --user record user as committer
bisect [-gbsr] [REV]
This command helps to find changesets which introduce
problems. To use, mark the earliest changeset you know
exhibits the problem as bad, then mark the latest
changeset which is free from the problem as good. Bisect
will update your working directory to a revision for
testing. Once you have performed tests, mark the working
directory as bad or good and bisect will either update
to another candidate changeset or announce that it has
found the bad revision.
Page 4 Plan 9 (printed 4/20/24)
HG(1) HG(1)
options:
-r, --reset reset bisect state
-g, --good mark changeset good
-b, --bad mark changeset bad
-s, --skip skip testing changeset
-U, --noupdate do not update to target
branch [-f] [NAME]
With no argument, show the current branch name. With one
argument, set the working directory branch name (the
branch does not exist in the repository until the next
commit).
Unless --force is specified, branch will not let you set a
branch name that shadows an existing branch.
Use the command 'hg update' to switch to an existing branch.
options:
-f, --force set branch name even if it shadows an existing branch
branches [-a]
List the repository's named branches, indicating which
ones are inactive. If active is specified, only show
active branches.
A branch is considered active if it contains repository heads.
Use the command 'hg update' to switch to an existing branch.
options:
-a, --active show only branches that have unmerged heads
bundle [-f] [-a] [-r REV]... [--base REV]... FILE [DEST]
Generate a compressed changegroup file collecting
changesets not found in the other repository.
If no destination repository is specified the destination is
assumed to have all the nodes specified by one or more --base
parameters. To create a bundle containing all changesets, use
--all (or --base null).
The bundle file can then be transferred using conventional means and
applied to another repository with the unbundle or pull command.
This is useful when direct push and pull are not available or when
exporting an entire repository is undesirable.
Applying bundles preserves all changeset contents including
permissions, copy/rename information, and revision history.
options:
-f, --force run even when remote repository is unrelated
Page 5 Plan 9 (printed 4/20/24)
HG(1) HG(1)
-r, --rev a changeset up to which you would like to bundle
--base a base changeset to specify instead of a destination
-a, --all bundle all changesets in the repository
-e, --ssh specify ssh command to use
--remotecmd specify hg command to run on the remote side
cat [OPTION]... FILE...
Print the specified files as they were at the given
revision. If no revision is given, the parent of the
working directory is used, or tip if no revision is
checked out.
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:
-o, --output print output to file with formatted name
-r, --rev print the given revision
--decode apply any matching decode filter
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
clone [OPTION]... SOURCE [DEST]
Create a copy of an existing repository in a new direc-
tory.
If no destination directory name is specified, it defaults to the
basename of the source.
The location of the source is added to the new repository's
For efficiency, hardlinks are used for cloning whenever the source
and destination are on the same filesystem (note this applies only
to the repository data, not to the checked out files). Some
filesystems, such as AFS, implement hardlinking incorrectly, but
do not report errors. In these cases, use the --pull option to
avoid hardlinking.
You can safely clone repositories and checked out files using full
hardlinks with
$ cp -al REPO REPOCLONE
which is the fastest way to clone. However, the operation is not
atomic (making sure REPO is not modified during the operation is
up to you) and you have to make sure your editor breaks hardlinks
(Emacs and most Linux Kernel tools do so).
Page 6 Plan 9 (printed 4/20/24)
HG(1) HG(1)
If you use the -r option to clone up to a specific revision, no
subsequent revisions will be present in the cloned repository.
This option implies --pull, even on local repositories.
If the -U option is used, the new clone will contain only a repository
(.hg) and no working copy (the working copy parent is the null revision).
See pull for valid source format details.
It is possible to specify an ssh:// URL as the destination, but no
Look at the help text for the pull command for important details
about ssh:// URLs.
options:
-U, --noupdate the clone will only contain a repository (no
working copy)
-r, --rev a changeset you would like to have after cloning
--pull use pull protocol to copy metadata
--uncompressed use uncompressed transfer (fast over LAN)
-e, --ssh specify ssh command to use
--remotecmd specify hg command to run on the remote side
commit [OPTION]... [FILE]...
Commit changes to the given files into the repository.
If a list of files is omitted, all changes reported by "hg status"
will be committed.
If you are committing the result of a merge, do not provide any
file names or -I/-X filters.
If no commit message is specified, the configured editor is started to
enter a message.
See 'hg help dates' for a list of formats valid for -d/--date.
options:
-A, --addremove mark new/missing files as added/removed before
committing
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
-m, --message use <text> as commit message
-l, --logfile read commit message from <file>
-d, --date record datecode as commit date
-u, --user record user as committer
aliases: ci
copy [OPTION]... [SOURCE]... DEST
Mark dest as having copies of source files. If dest is a
directory, copies are put in that directory. If dest is
a file, there can only be one source.
Page 7 Plan 9 (printed 4/20/24)
HG(1) HG(1)
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. To undo a copy
before that, see hg revert.
options:
-A, --after record a copy that has already occurred
-f, --force forcibly copy over an existing managed file
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
-n, --dry-run do not perform actions, just print output
aliases: cp
diff [OPTION]... [-r REV1 [-r REV2]] [FILE]...
Show differences between revisions for the specified
files.
Differences between files are shown using the unified diff format.
NOTE: diff may generate unexpected results for merges, as it will
default to comparing against the working directory's first parent
changeset if no revisions are specified.
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:
-r, --rev revision
-a, --text treat all files as text
-p, --show-function show which function each change is in
-g, --git use git extended diff format
--nodates don't include dates in diff headers
-w, --ignore-all-space ignore white space when comparing lines
-b, --ignore-space-change ignore changes in the amount of white
space
-B, --ignore-blank-lines ignore changes whose lines are all
blank
-U, --unified number of lines of context to show
-I, --include include names matching the given
patterns
-X, --exclude exclude names matching the given
patterns
Page 8 Plan 9 (printed 4/20/24)
HG(1) HG(1)
export [OPTION]... [-o OUTFILESPEC] REV...
Print the changeset header and diffs for one or more
revisions.
The information shown in the changeset header is: author,
changeset hash, parent(s) and commit comment.
NOTE: export may generate unexpected diff output for merge changesets,
as it will compare the merge changeset against its first parent only.
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.
With the --switch-parent option, the diff will be against the second
parent. It can be useful to review a merge.
options:
-o, --output print output to file with formatted name
-a, --text treat all files as text
-g, --git use git extended diff format
--nodates don't include dates in diff headers
--switch-parent diff against the second parent
grep [OPTION]... PATTERN [FILE]...
Search revisions of files for a regular expression.
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
Page 9 Plan 9 (printed 4/20/24)
HG(1) HG(1)
--all print all revisions that match
-f, --follow follow changeset history, or file
history across copies and renames
-i, --ignore-case ignore case when matching
-l, --files-with-matches print only filenames and revs that match
-n, --line-number print matching line numbers
-r, --rev search in given revision range
-u, --user list the author (long with -v)
-d, --date list the date (short with -q)
-I, --include include names matching the given
patterns
-X, --exclude exclude names matching the given
patterns
heads [-r REV] [REV]...
With no arguments, show all repository head changesets.
If branch or revisions names are given this will show the heads of
the specified branches or the branches those revisions are tagged
with.
Repository "heads" are changesets that don't have child
changesets. They are where development generally takes place and
are the usual targets for update and merge operations.
Branch heads are changesets that have a given branch tag, but have
no child changesets with that tag. They are usually where
development on the given branch takes place.
options:
-r, --rev show only heads which are descendants of rev
--style display using template map file
--template display with template
help [COMMAND]
With no arguments, print a list of commands and short
help.
Given a command name, print help for that command.
Given an extension name, print help for that extension, and the
commands it provides.
identify [-nibt] [-r REV] [SOURCE]
With no revision, print a summary of the current state
of the repo.
With a path, do a lookup in another repository.
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, a list of tags for this revision and a branch
Page 10 Plan 9 (printed 4/20/24)
HG(1) HG(1)
name for non-default branches.
options:
-r, --rev identify the specified rev
-n, --num show local revision number
-i, --id show global revision id
-b, --branch show branch
-t, --tags show tags
aliases: id
import [OPTION]... PATCH...
Import a list of patches and commit them individually.
If there are outstanding changes in the working directory, import
will abort unless given the -f flag.
You can import a patch straight from a mail message. Even patches
as attachments work (body part must be type text/plain or
text/x-patch to be used). From and Subject headers of email
message are used as default committer and commit message. All
text/plain body parts before first diff are added to commit
message.
If the imported patch was generated by hg export, user and description
from patch override values from message headers and body. Values
given on command line with -m and -u override these.
If --exact is specified, import will set the working directory
to the parent of each patch before applying it, and will abort
if the resulting changeset has a different ID than the one
recorded in the patch. This may happen due to character set
problems or other deficiencies in the text patch format.
To read a patch from standard input, use patch name "-".
See 'hg help dates' for a list of formats valid for -d/--date.
options:
-p, --strip directory strip option for patch. This has the
same meaning as the corresponding patch option
(default: 1)
-b, --base base path
-f, --force skip check for outstanding uncommitted changes
--no-commit don't commit, just update the working directory
--exact apply patch to the nodes from which it was
generated
--import-branch Use any branch information in patch (implied by
--exact)
-m, --message use <text> as commit message
-l, --logfile read commit message from <file>
-d, --date record datecode as commit date
-u, --user record user as committer
Page 11 Plan 9 (printed 4/20/24)
HG(1) HG(1)
aliases: patch
incoming [-p] [-n] [-M] [-f] [-r REV]... [--bundle FILENAME]
[SOURCE]
Show new changesets found in the specified path/URL or
the default pull location. These are the changesets that
would be pulled if a pull was requested.
For remote repository, using --bundle avoids downloading the changesets
twice if the incoming is followed by a pull.
See pull for valid source format details.
options:
-f, --force run even when remote repository is unrelated
-n, --newest-first show newest record first
--bundle file to store the bundles into
-r, --rev a specific revision up to which you would like
to pull
-p, --patch show patch
-l, --limit limit number of changes displayed
-M, --no-merges do not show merges
--style display using template map file
--template display with template
-e, --ssh specify ssh command to use
--remotecmd specify hg command to run on the remote side
aliases: in
init [-e CMD] [--remotecmd CMD] [DEST]
Initialize a new repository in the given directory. If
the given directory does not exist, it is created.
If no directory is given, the current directory is used.
It is possible to specify an ssh:// URL as the destination.
Look at the help text for the pull command for important details
about ssh:// URLs.
options:
-e, --ssh specify ssh command to use
--remotecmd specify hg command to run on the remote side
locate [OPTION]... [PATTERN]...
Print all files under Mercurial control whose names
match the given patterns.
This command searches the entire repository by default. To search
just the current directory and its subdirectories, use
"--include .".
If no patterns are given to match, this command prints all file
Page 12 Plan 9 (printed 4/20/24)
HG(1) HG(1)
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 filenames.
options:
-r, --rev search the repository as it stood at rev
-0, --print0 end filenames with NUL, for use with xargs
-f, --fullpath print complete paths from the filesystem root
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
log [OPTION]... [FILE]
Print the revision history of the specified files or the
entire project.
File history is shown without following rename or copy history of
files. Use -f/--follow with a file name to follow history across
renames and copies. --follow without a file name will only show
ancestors or descendants of the starting revision. --follow-first
only follows the first parent of merge revisions.
If no revision range is specified, the default is tip:0 unless
--follow is set, in which case the working directory parent is
used as the starting revision.
See 'hg help dates' for a list of formats valid for -d/--date.
By default this command outputs: changeset id and hash, tags,
non-trivial parents, user, date and time, and a summary for each
commit. When the -v/--verbose switch is used, the list of changed
files and full commit message is shown.
NOTE: log -p may generate unexpected diff output for merge
changesets, as it will compare the merge changeset against its
first parent only. Also, the files: list will only reflect files
that are different from BOTH parents.
options:
-f, --follow follow changeset history, or file history
across copies and renames
--follow-first only follow the first parent of merge
changesets
-d, --date show revs matching date spec
-C, --copies show copied files
-k, --keyword do case-insensitive search for a keyword
-r, --rev show the specified revision or range
--removed include revs where files were removed
-m, --only-merges show only merges
-b, --only-branch show only changesets within the given named
Page 13 Plan 9 (printed 4/20/24)
HG(1) HG(1)
branch
-P, --prune do not display revision or any of its ancestors
-p, --patch show patch
-l, --limit limit number of changes displayed
-M, --no-merges do not show merges
--style display using template map file
--template display with template
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
aliases: history
manifest [-r REV]
Print a list of version controlled files for the given
revision. If no revision is given, the parent of the
working directory is used, or tip if no revision is
checked out.
The manifest is the list of files being version controlled. If no revision
is given then the first parent of the working directory is used.
With -v flag, print file permissions, symlink and executable bits. With
--debug flag, print file revision hashes.
options:
-r, --rev revision to display
merge [-f] [[-r] REV]
Merge the contents of the current working directory and
the requested revision. Files that changed between
either parent are marked as changed for the next commit
and a commit must be performed before any further
updates are allowed.
If no revision is specified, the working directory's parent is a
head revision, and the repository contains exactly one other head,
the other head is merged with by default. Otherwise, an explicit
revision to merge with must be provided.
options:
-f, --force force a merge with outstanding changes
-r, --rev revision to merge
outgoing [-M] [-p] [-n] [-f] [-r REV]... [DEST]
Show changesets not found in the specified destination
repository or the default push location. These are the
changesets that would be pushed if a push was requested.
See pull for valid destination format details.
options:
-f, --force run even when remote repository is unrelated
Page 14 Plan 9 (printed 4/20/24)
HG(1) HG(1)
-r, --rev a specific revision up to which you would like
to push
-n, --newest-first show newest record first
-p, --patch show patch
-l, --limit limit number of changes displayed
-M, --no-merges do not show merges
--style display using template map file
--template display with template
-e, --ssh specify ssh command to use
--remotecmd specify hg command to run on the remote side
aliases: out
parents [-r REV] [FILE]
Print the working directory's parent revisions. If a
revision is given via --rev, the parent of that revision
will be printed. If a file argument is given, revision
in which the file was last changed (before the working
directory revision or the argument to --rev if given) is
printed.
options:
-r, --rev show parents from the specified rev
--style display using template map file
--template display with template
paths [NAME]
Show definition of symbolic path name NAME. If no name
is given, show definition of available names.
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.
pull [-u] [-f] [-r REV]... [-e CMD] [--remotecmd CMD]
[SOURCE]
Pull changes from a remote repository to a local one.
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 (or file://local/filesystem/path)
http://[user@]host[:port]/[path]
https://[user@]host[:port]/[path]
ssh://[user@]host[:port]/[path]
static-http://host[:port]/[path]
Paths in the local filesystem can either point to Mercurial
repositories or to bundle files (as created by 'hg bundle' or
'hg incoming --bundle'). The static-http:// protocol, albeit slow,
Page 15 Plan 9 (printed 4/20/24)
HG(1) HG(1)
allows access to a Mercurial repository where you simply use a web
server to publish the .hg directory as static content.
An optional identifier after # indicates a particular branch, tag,
or changeset to pull.
Some notes about using SSH with Mercurial:
- SSH requires an accessible shell account on the destination machine
and a copy of hg in the remote path or specified with as remotecmd.
- path is relative to the remote user's home directory by default.
Use an extra slash at the start of a path to specify an absolute path:
ssh://example.com//tmp/repository
- Mercurial doesn't use its own compression via SSH; the right thing
to do is to configure it in your ~/.ssh/config, e.g.:
Host *.mylocalnetwork.example.com
Compression no
Host *
Compression yes
Alternatively specify "ssh -C" as your ssh command in your hgrc or
with the --ssh command line option.
options:
-u, --update update to new tip if changesets were pulled
-f, --force run even when remote repository is unrelated
-r, --rev a specific revision up to which you would like to
pull
-e, --ssh specify ssh command to use
--remotecmd specify hg command to run on the remote side
push [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [DEST]
Push changes from the local repository to the given des-
tination.
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 client has forgotten to pull and merge before pushing.
Valid URLs are of the form:
local/filesystem/path (or file://local/filesystem/path)
ssh://[user@]host[:port]/[path]
http://[user@]host[:port]/[path]
https://[user@]host[:port]/[path]
An optional identifier after # indicates a particular branch, tag,
or changeset to push. If -r is used, the named changeset and all its
ancestors will be pushed to the remote repository.
Page 16 Plan 9 (printed 4/20/24)
HG(1) HG(1)
Look at the help text for the pull command for important details
about ssh:// URLs.
Pushing to http:// and https:// URLs is only possible, if this
feature is explicitly enabled on the remote Mercurial server.
options:
-f, --force force push
-r, --rev a specific revision up to which you would like to
push
-e, --ssh specify ssh command to use
--remotecmd specify hg command to run on the remote side
recover
Recover from an interrupted commit or pull.
This command tries to fix the repository status after an interrupted
operation. It should only be necessary when Mercurial suggests it.
remove [OPTION]... FILE...
Schedule the indicated files for removal from the repos-
itory.
This only removes files from the current branch, not from the entire
project history. -A can be used to remove only files that have already
been deleted, -f can be used to force deletion, and -Af can be used
to remove files from the next revision without deleting them.
The following table details the behavior of remove for different file
states (columns) and option combinations (rows). The file states are
Added, Clean, Modified and Missing (as reported by hg status). The
actions are Warn, Remove (from branch) and Delete (from disk).
A C M !
none W RD W R
-f R RD RD R
-A W W W R
-Af R R R R
This command schedules the files to be removed at the next commit.
To undo a remove before that, see hg revert.
options:
-A, --after record delete for missing files
-f, --force remove (and delete) file even if added or modified
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
aliases: rm
rename [OPTION]... SOURCE... DEST
Mark dest as copies of sources; mark sources for
Page 17 Plan 9 (printed 4/20/24)
HG(1) HG(1)
deletion. If dest is a directory, copies are put in that
directory. If dest is a file, there can only be one
source.
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. To undo a rename
before that, see hg revert.
options:
-A, --after record a rename that has already occurred
-f, --force forcibly copy over an existing managed file
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
-n, --dry-run do not perform actions, just print output
aliases: mv
revert [OPTION]... [-r REV] [NAME]...
(use update -r to check out earlier revisions, revert
does not change the working dir parents)
With no revision specified, revert the named files or directories
to the contents they had in the parent of the working directory.
This restores the contents of the affected files to an unmodified
state and unschedules adds, removes, copies, and renames. If the
working directory has two parents, you must explicitly specify the
revision to revert to.
Using the -r option, revert the given files or directories to their
contents as of a specific revision. This can be helpful to "roll
back" some or all of an earlier change.
See 'hg help dates' for a list of formats valid for -d/--date.
Revert modifies the working directory. It does not commit any
changes, or change the parent of the working directory. If you
revert to a revision other than the parent of the working
directory, the reverted files will thus appear modified
afterwards.
If a file has been deleted, it is restored. If the executable
mode of a file was changed, it is reset.
If names are given, all files matching the names are reverted.
If no arguments are given, no files are reverted.
Modified files are saved with a .orig suffix before reverting.
To disable these backups, use --no-backup.
options:
Page 18 Plan 9 (printed 4/20/24)
HG(1) HG(1)
-a, --all revert all changes when no arguments given
-d, --date tipmost revision matching date
-r, --rev revision to revert to
--no-backup do not save backup copies of files
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
-n, --dry-run do not perform actions, just print output
rollback
This command should be used with care. There is only one
level of rollback, and there is no way to undo a roll-
back. It will also restore the dirstate at the time of
the last transaction, losing any dirstate changes since
that time.
Transactions are used to encapsulate the effects of all commands
that create new changesets or propagate existing changesets into a
repository. For example, the following commands are transactional,
and their effects can be rolled back:
commit
import
pull
push (with this repository as destination)
unbundle
This command is not intended for use on public repositories. Once
changes are visible for pull by other users, rolling a transaction
back locally is ineffective (someone else may already have pulled
the changes). Furthermore, a race is possible with readers of the
repository; for example an in-progress pull from the repository
may fail if a rollback is performed.
root
Print the root directory of the current repository.
serve [OPTION]...
Start a local HTTP repository browser and pull server.
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 name of access log file to write to
-d, --daemon run server in background
--daemon-pipefds used internally by daemon mode
-E, --errorlog name of error log file to write to
-p, --port port to listen on (default: 8000)
-a, --address address to listen on (default: all interfaces)
--prefix prefix path to serve from (default: server root)
-n, --name name to show in web pages (default: working dir)
--webdir-conf name of the webdir config file (serve more than
Page 19 Plan 9 (printed 4/20/24)
HG(1) HG(1)
one repo)
--pid-file name of file to write process ID to
--stdio for remote clients
-t, --templates web templates to use
--style template style to use
-6, --ipv6 use IPv6 in addition to IPv4
--certificate SSL certificate file
showconfig [-u] [NAME]...
With no args, print names and values of all config
items.
With one arg of the form section.name, print just the value of
that config item.
With multiple args, print names and values of all config items
with matching section names.
options:
-u, --untrusted show untrusted configuration options
aliases: debugconfig
status [OPTION]... [FILE]...
Show status of files in the repository. If names are
given, only files that match are shown. Files that are
clean or ignored or source of a copy/move operation, are
not listed unless -c (clean), -i (ignored), -C (copies)
or -A is given. Unless options described with "show only
..." are given, the options -mardu are used.
Option -q/--quiet hides untracked (unknown and ignored) files
unless explicitly requested with -u/--unknown or -i/-ignored.
NOTE: status may appear to disagree with diff if permissions have
changed or a merge has occurred. The standard diff format does not
report permission changes and diff only reports changes relative
to one merge parent.
If one revision is given, it is used as the base revision.
If two revisions are given, the difference between them is shown.
The codes used to show the status of files are:
M = modified
A = added
R = removed
C = clean
! = deleted, but still tracked
? = not tracked
I = ignored
= the previous added file was copied from here
Page 20 Plan 9 (printed 4/20/24)
HG(1) HG(1)
options:
-A, --all show status of all files
-m, --modified show only modified files
-a, --added show only added files
-r, --removed show only removed files
-d, --deleted show only deleted (but tracked) files
-c, --clean show only files without changes
-u, --unknown show only unknown (not tracked) files
-i, --ignored show only ignored files
-n, --no-status hide status prefix
-C, --copies show source of copied files
-0, --print0 end filenames with NUL, for use with xargs
--rev show difference from revision
-I, --include include names matching the given patterns
-X, --exclude exclude names matching the given patterns
aliases: st
tag [-l] [-m TEXT] [-d DATE] [-u USER] [-r REV] NAME...
Name a particular revision using <name>.
Tags are used to name particular revisions of the repository and are
very useful to compare different revisions, to go back to significant
earlier versions or to mark branch points as releases, etc.
If no revision is given, the parent of the working directory is used,
or tip if no revision is checked out.
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. The file '.hg/localtags' is used for local tags (not
shared among repositories).
See 'hg help dates' for a list of formats valid for -d/--date.
options:
-f, --force replace existing tag
-l, --local make the tag local
-r, --rev revision to tag
--remove remove a tag
-m, --message use <text> as commit message
-d, --date record datecode as commit date
-u, --user record user as committer
tags
List the repository tags.
This lists both regular and local tags. When the -v/--verbose switch
is used, a third column "local" is printed for local tags.
tip [-p]
Page 21 Plan 9 (printed 4/20/24)
HG(1) HG(1)
The tip revision (usually just called the tip) is the
most recently added changeset in the repository, the
most recently changed head.
If you have just made a commit, that commit will be the tip. If
you have just pulled changes from another repository, the tip of
that repository becomes the current tip. The "tip" tag is special
and cannot be renamed or assigned to a different changeset.
options:
-p, --patch show patch
--style display using template map file
--template display with template
unbundle [-u] FILE...
Apply one or more compressed changegroup files generated
by the bundle command.
options:
-u, --update update to new tip if changesets were unbundled
update [-C] [-d DATE] [[-r] REV]
Update the working directory to the specified revision,
or the tip of the current branch if none is specified.
If the requested revision is a descendant of the working
directory, any outstanding changes in the working directory will
be merged into the result. If it is not directly descended but is
on the same named branch, update aborts with a suggestion to use
merge or update -C instead.
If the requested revision is on a different named branch and the
working directory is clean, update quietly switches branches.
If you want to update just one file to an older revision, use revert.
See 'hg help dates' for a list of formats valid for --date.
options:
-C, --clean overwrite locally modified files
-d, --date tipmost revision matching date
-r, --rev revision
aliases: up checkout co
verify
Verify the integrity of the current repository.
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.
Page 22 Plan 9 (printed 4/20/24)
HG(1) HG(1)
version
output version and copyright information
DATE FORMATS
Some commands allow the user to specify a date:
backout, commit, import, tag: Specify the commit date.
log, revert, update: Select revision(s) by date.
Many date formats are valid. Here are some examples:
"Wed Dec 6 13:18:29 2006" (local timezone assumed)
"Dec 6 13:18 -0600" (year assumed, time offset provided)
"Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
"Dec 6" (midnight)
"13:18" (today assumed)
"3:39" (3:39AM assumed)
"3:39pm" (15:39)
"2006-12-6 13:18:29" (ISO 8601 format)
"2006-12-6 13:18"
"2006-12-6"
"12-6"
"12/6"
"12/6/6" (Dec 6 2006)
Lastly, there is Mercurial's internal format:
"1165432709 0" (Wed Dec 6 13:18:29 2006 UTC)
This is the internal representation format for dates. unixtime is
the number of seconds since the epoch (1970-01-01 00:00 UTC). offset
is the offset of the local timezone, in seconds west of UTC (negative
if the timezone is east of UTC).
The log command also accepts date ranges:
"<{date}" - on or before a given date
">{date}" - on or after a given date
"{date} to {date}" - a date range, inclusive
"-{days}" - within a given number of days of today
FILE PATTERNS
Mercurial accepts several notations for identifying one or more
files at a time.
By default, Mercurial treats filenames 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.
Page 23 Plan 9 (printed 4/20/24)
HG(1) HG(1)
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
ENVIRONMENT VARIABLES
HG
Path to the hg executable, automatically passed when
running hooks, extensions or external tools. If unset or
empty, an executable named hg (with com/exe/bat/cmd
extension on Windows) is searched.
HGEDITOR
This is the name of the editor to use when committing.
See EDITOR.
(deprecated, use .hgrc)
HGENCODING
This overrides the default locale setting detected by
Mercurial. This setting is used to convert data includ-
ing usernames, changeset descriptions, tag names, and
branches. This setting can be overridden with the
--encoding command-line option.
HGENCODINGMODE
This sets Mercurial's behavior for handling unknown
Page 24 Plan 9 (printed 4/20/24)
HG(1) HG(1)
characters while transcoding user inputs. The default is
"strict", which causes Mercurial to abort if it can't
translate a character. Other settings include "replace",
which replaces unknown characters, and "ignore", which
drops them. This setting can be overridden with the
--encodingmode command-line option.
HGMERGE
An executable to use for resolving merge conflicts. The
program will be executed with three arguments: local
file, remote file, ancestor file.
(deprecated, use .hgrc)
HGRCPATH
A list of files or directories to search for hgrc files.
Item separator is ":" on Unix, ";" on Windows. If HGRC-
PATH 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.
HGUSER
This is the string used for the author of a commit.
(deprecated, use .hgrc)
EMAIL
If HGUSER is not set, this will be used as the author
for a commit.
LOGNAME
If neither HGUSER nor EMAIL is set, LOGNAME will be used
(with @hostname appended) as the author value for a com-
mit.
VISUAL
This is the name of the editor to use when committing.
See EDITOR.
EDITOR
Sometimes Mercurial needs to open a text file in an edi-
tor for a user to modify, for example when writing com-
mit messages. The editor it uses is determined by look-
ing at the environment variables HGEDITOR, VISUAL and
EDITOR, in that order. The first non-empty one is cho-
sen. If all of them are empty, the editor defaults to
vi.
PYTHONPATH
Page 25 Plan 9 (printed 4/20/24)
HG(1) HG(1)
This is used by Python to find imported modules and may
need to be set appropriately if Mercurial is not
installed system-wide.
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.
The reserved name "null" indicates the null revision. This is the
revision of an empty repository, and the parent of revision 0.
The reserved name "." indicates the working directory parent. If
no working directory is checked out, it is equivalent to null.
If an uncommitted merge is in progress, "." is the revision of
the first parent.
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.
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.
Page 26 Plan 9 (printed 4/20/24)
HG(1) HG(1)
FILES
This file contains regular expressions (one per line)
that describe file names that should be ignored by hg.
For details, see hgignore(5).
This file contains changeset hash values and text tag
names (one of each separated by spaces) that correspond
to tagged versions of the repository contents.
/etc/mercurial/hgrc, $HOME/.hgrc, .hg/hgrc
This file contains defaults and configuration. Values in
.hg/hgrc override those in $HOME/.hgrc, and these over-
ride settings made in the global /etc/mercurial/hgrc
configuration. See hgrc(5) for details of the contents
and format of these files.
Some commands (e.g. revert) produce backup files ending in
.orig, if the .orig file already exists and is not tracked
by Mercurial, it will be overwritten.
BUGS
Probably lots, please post them to the mailing list (See
Resources below) when you find them.
SEE ALSO
hgignore(8), hgrc(8).
AUTHOR
Written by Matt Mackall <mpm@selenic.com>
RESOURCES
Main Web Site[1]
Source code repository[2]
Mailing list[3]
COPYING
Copyright (C) 2005-2007 Matt Mackall. Free use of this soft-
ware is granted under the terms of the GNU General Public
License (GPL).
NOTES
1. Main Web Site
http://selenic.com/mercurial
2. Source code repository
Page 27 Plan 9 (printed 4/20/24)
HG(1) HG(1)
http://selenic.com/hg
3. Mailing list
http://selenic.com/mailman/listinfo/mercurial
Page 28 Plan 9 (printed 4/20/24)