hg(1) — the Plan 9 manual

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 Mercurial system.

unhandled troff command .sp

COMMAND ELEMENTS

files ...

indicates one or more filename or relative path filenames; 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 protocols, http:// which is fast and the static–http:// protocol which is much slower but does not require a special 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

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.

unhandled troff command .sp

The files will be added to the repository at the next commit. To undo an add before that, see hg revert.

unhandled troff command .sp

If no names are given, add all files in the repository.

unhandled troff command .sp

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.

unhandled troff command .sp

New files are ignored if they match any of the patterns in .hgignore. As with add, these changes take effect at the next commit.

unhandled troff command .sp

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.

unhandled troff command .sp

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 responsible for each line

unhandled troff command .sp

This command is useful to discover who did a change or when a change took place.

unhandled troff command .sp

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.

unhandled troff command .sp

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

unhandled troff command .sp

aliases: blame

archive [OPTION]... DEST

By default, the revision used is the parent of the working directory; use "–r" to specify a different revision.

unhandled troff command .sp

To specify the type of archive to create, use "–t". Valid types are:

unhandled troff command .sp

"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

unhandled troff command .sp

The exact name of the destination archive or directory is given using a format string; see "hg help export" for details.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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).

unhandled troff command .sp

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.

unhandled troff command .sp

See \’hg help dates\’ for a list of formats valid for –d/––date.

unhandled troff command .sp

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.

unhandled troff command .sp

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).

unhandled troff command .sp

Unless ––force is specified, branch will not let you set a branch name that shadows an existing branch.

unhandled troff command .sp

Use the command \’hg update\’ to switch to an existing branch.

unhandled troff command .sp

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.

unhandled troff command .sp

A branch is considered active if it contains repository heads.

unhandled troff command .sp

Use the command \’hg update\’ to switch to an existing branch.

unhandled troff command .sp

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.

unhandled troff command .sp

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).

unhandled troff command .sp

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.

unhandled troff command .sp

Applying bundles preserves all changeset contents including permissions, copy/rename information, and revision history.

unhandled troff command .sp

options: –f, ––force run even when remote repository is unrelated –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.

unhandled troff command .sp

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:

unhandled troff command .sp

%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

unhandled troff command .sp

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 directory.

unhandled troff command .sp

If no destination directory name is specified, it defaults to the basename of the source.

unhandled troff command .sp

The location of the source is added to the new repository\’s

unhandled troff command .hg/hgrc

unhandled troff command .sp

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.

unhandled troff command .sp

You can safely clone repositories and checked out files using full hardlinks with

unhandled troff command .sp

$ cp –al REPO REPOCLONE

unhandled troff command .sp

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).

unhandled troff command .sp

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.

unhandled troff command .sp

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).

unhandled troff command .sp

See pull for valid source format details.

unhandled troff command .sp

It is possible to specify an ssh:// URL as the destination, but no

unhandled troff command .hg/hgrc

Look at the help text for the pull command for important details about ssh:// URLs.

unhandled troff command .sp

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.

unhandled troff command .sp

If a list of files is omitted, all changes reported by "hg status" will be committed.

unhandled troff command .sp

If you are committing the result of a merge, do not provide any file names or –I/–X filters.

unhandled troff command .sp

If no commit message is specified, the configured editor is started to enter a message.

unhandled troff command .sp

See \’hg help dates\’ for a list of formats valid for –d/––date.

unhandled troff command .sp

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

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

This command takes effect in the next commit. To undo a copy before that, see hg revert.

unhandled troff command .sp

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

unhandled troff command .sp

aliases: cp

diff [OPTION]... [–r REV1 [–r REV2]] [FILE]...

Show differences between revisions for the specified files.

unhandled troff command .sp

Differences between files are shown using the unified diff format.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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

export [OPTION]... [–o OUTFILESPEC] REV...

Print the changeset header and diffs for one or more revisions.

unhandled troff command .sp

The information shown in the changeset header is: author, changeset hash, parent(s) and commit comment.

unhandled troff command .sp

NOTE: export may generate unexpected diff output for merge changesets, as it will compare the merge changeset against its first parent only.

unhandled troff command .sp

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:

unhandled troff command .sp

%% 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

unhandled troff command .sp

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.

unhandled troff command .sp

With the ––switch–parent option, the diff will be against the second parent. It can be useful to review a merge.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

options: –0, ––print0 end fields with NUL ––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.

unhandled troff command .sp

If branch or revisions names are given this will show the heads of the specified branches or the branches those revisions are tagged with.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

Given a command name, print help for that command.

unhandled troff command .sp

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.

unhandled troff command .sp

With a path, do a lookup in another repository.

unhandled troff command .sp

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 name for non–default branches.

unhandled troff command .sp

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

unhandled troff command .sp

aliases: id

import [OPTION]... PATCH...

Import a list of patches and commit them individually.

unhandled troff command .sp

If there are outstanding changes in the working directory, import will abort unless given the –f flag.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

To read a patch from standard input, use patch name "–". See \’hg help dates\’ for a list of formats valid for –d/––date.

unhandled troff command .sp

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

unhandled troff command .sp

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.

unhandled troff command .sp

For remote repository, using ––bundle avoids downloading the changesets twice if the incoming is followed by a pull.

unhandled troff command .sp

See pull for valid source format details.

unhandled troff command .sp

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

unhandled troff command .sp

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.

unhandled troff command .sp

If no directory is given, the current directory is used.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

This command searches the entire repository by default. To search just the current directory and its subdirectories, use "––include .".

unhandled troff command .sp

If no patterns are given to match, this command prints all file names.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

See \’hg help dates\’ for a list of formats valid for –d/––date.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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 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

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

With –v flag, print file permissions, symlink and executable bits. With ––debug flag, print file revision hashes.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

See pull for valid destination format details.

unhandled troff command .sp

options: –f, ––force run even when remote repository is unrelated –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

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

Valid URLs are of the form:

unhandled troff command .sp

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]

unhandled troff command .sp

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, allows access to a Mercurial repository where you simply use a web server to publish the .hg directory as static content.

unhandled troff command .sp

An optional identifier after # indicates a particular branch, tag, or changeset to pull.

unhandled troff command .sp

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.

unhandled troff command .sp

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 destination.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

Valid URLs are of the form:

unhandled troff command .sp

local/filesystem/path (or file://local/filesystem/path) ssh://[user@]host[:port]/[path] http://[user@]host[:port]/[path] https://[user@]host[:port]/[path]

unhandled troff command .sp

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.

unhandled troff command .sp

Look at the help text for the pull command for important details about ssh:// URLs.

unhandled troff command .sp

Pushing to http:// and https:// URLs is only possible, if this feature is explicitly enabled on the remote Mercurial server.

unhandled troff command .sp

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.

unhandled troff command .sp

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 repository.

unhandled troff command .sp

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.

unhandled troff command .sp

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).

unhandled troff command .sp

A C M ! none W RD W R –f R RD RD R –A W W W R –Af R R R R

unhandled troff command .sp

This command schedules the files to be removed at the next commit. To undo a remove before that, see hg revert.

unhandled troff command .sp

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

unhandled troff command .sp

aliases: rm

rename [OPTION]... SOURCE... DEST

Mark dest as copies of sources; mark sources for deletion. If dest is a directory, copies are put in that directory. If dest is a file, there can only be one source.

unhandled troff command .sp

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.

unhandled troff command .sp

This command takes effect in the next commit. To undo a rename before that, see hg revert.

unhandled troff command .sp

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

unhandled troff command .sp

aliases: mv

revert [OPTION]... [–r REV] [NAME]...

(use update –r to check out earlier revisions, revert does not change the working dir parents)

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

If a file has been deleted, it is restored. If the executable mode of a file was changed, it is reset.

unhandled troff command .sp

If names are given, all files matching the names are reverted. If no arguments are given, no files are reverted.

unhandled troff command .sp

Modified files are saved with a .orig suffix before reverting. To disable these backups, use ––no–backup.

unhandled troff command .sp

options: –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 rollback. It will also restore the dirstate at the time of the last transaction, losing any dirstate changes since that time.

unhandled troff command .sp

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:

unhandled troff command .sp

commit import pull push (with this repository as destination) unbundle

unhandled troff command .sp

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.

unhandled troff command .sp

By default, the server logs accesses to stdout and errors to stderr. Use the "–A" and "–E" options to log to files.

unhandled troff command .sp

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 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.

unhandled troff command .sp

With one arg of the form section.name, print just the value of that config item.

unhandled troff command .sp

With multiple args, print names and values of all config items with matching section names.

unhandled troff command .sp

options: –u, ––untrusted show untrusted configuration options

unhandled troff command .sp

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.

unhandled troff command .sp

Option –q/––quiet hides untracked (unknown and ignored) files unless explicitly requested with –u/––unknown or –i/–ignored.

unhandled troff command .sp

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.

unhandled troff command .sp

If one revision is given, it is used as the base revision. If two revisions are given, the difference between them is shown.

unhandled troff command .sp

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

unhandled troff command .sp

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

unhandled troff command .sp

aliases: st

tag [–l] [–m TEXT] [–d DATE] [–u USER] [–r REV] NAME...

Name a particular revision using <name>.

unhandled troff command .sp

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.

unhandled troff command .sp

If no revision is given, the parent of the working directory is used, or tip if no revision is checked out.

unhandled troff command .sp

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).

unhandled troff command .sp

See \’hg help dates\’ for a list of formats valid for –d/––date.

unhandled troff command .sp

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

DATE FORMATS

unhandled troff command .sp

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.

unhandled troff command .sp

Many date formats are valid. Here are some examples:

unhandled troff command .sp

"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)

unhandled troff command .sp

Lastly, there is Mercurial\’s internal format:

unhandled troff command .sp

"1165432709 0" (Wed Dec 6 13:18:29 2006 UTC)

unhandled troff command .sp

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).

unhandled troff command .sp

The log command also accepts date ranges:

unhandled troff command .sp

"<{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

unhandled troff command .sp

Mercurial accepts several notations for identifying one or more files at a time.

unhandled troff command .sp

By default, Mercurial treats filenames as shell–style extended glob patterns.

unhandled troff command .sp

Alternate pattern notations must be specified explicitly.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

The supported glob syntax extensions are "**" to match any string across path separators, and "{a,b}" to mean "a or b".

unhandled troff command .sp

To use a Perl/Python regular expression, start a name with "re:". Regexp pattern matching is anchored at the root of the repository.

unhandled troff command .sp

Plain examples:

unhandled troff command .sp

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"

unhandled troff command .sp

Glob examples:

unhandled troff command .sp

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

unhandled troff command .sp

Regexp examples:

unhandled troff command .sp

re:.*\.c$ any name ending in ".c", anywhere in the repository

ENVIRONMENT VARIABLES

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.

unhandled troff command .sp

(deprecated, use .hgrc)

HGENCODING

This overrides the default locale setting detected by Mercurial. This setting is used to convert data including 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 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.

unhandled troff command .sp

(deprecated, use .hgrc)

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.

unhandled troff command .sp

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.

unhandled troff command .sp

(deprecated, use .hgrc)

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 commit.

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 editor for a user to modify, for example when writing commit messages. The editor it uses is determined by looking at the environment variables HGEDITOR, VISUAL and EDITOR, in that order. The first non–empty one is chosen. If all of them are empty, the editor defaults to vi.

PYTHONPATH

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

unhandled troff command .sp

Mercurial accepts several notations for identifying individual revisions.

unhandled troff command .sp

A plain integer is treated as a revision number. Negative integers are treated as offsets from the tip, with –1 denoting the tip.

unhandled troff command .sp

A 40–digit hexadecimal string is treated as a unique revision identifier.

unhandled troff command .sp

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.

unhandled troff command .sp

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.

unhandled troff command .sp

The reserved name "tip" is a special tag that always identifies the most recent revision.

unhandled troff command .sp

The reserved name "null" indicates the null revision. This is the revision of an empty repository, and the parent of revision 0.

unhandled troff command .sp

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

unhandled troff command .sp

When Mercurial accepts more than one revision, they may be specified individually, or provided as a continuous range, separated by the ":" character.

unhandled troff command .sp

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".

unhandled troff command .sp

If BEGIN is greater than END, revisions are treated in reverse order.

unhandled troff command .sp

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.

FILES

unhandled troff command .hgignore

This file contains regular expressions (one per line) that describe file names that should be ignored by hg. For details, see hgignore(5).

unhandled troff command .hgtags

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 override 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.

unhandled troff command .sp

BUGS

Probably lots, please post them to the mailing list (See Resources below) when you find them.

unhandled troff command .sp

AUTHOR

Written by Matt Mackall <mpm@selenic.com>

unhandled troff command .sp

RESOURCES

Main Web Site[1]

unhandled troff command .sp

Source code repository[2]

unhandled troff command .sp

Mailing list[3]

unhandled troff command .sp

COPYING

unhandled troff command .sp

NOTES

Main Web Site

http://selenic.com/mercurial

Source code repository

http://selenic.com/hg

Mailing list

http://selenic.com/mailman/listinfo/mercurial

man.aiju.de 9front man pages

NAME

SYNOPSIS

DESCRIPTION

COMMAND ELEMENTS

OPTIONS

COMMANDS

DATE FORMATS

FILE PATTERNS

ENVIRONMENT VARIABLES

SPECIFYING SINGLE REVISIONS

SPECIFYING MULTIPLE REVISIONS

FILES

BUGS

SEE ALSO

AUTHOR

RESOURCES

COPYING

NOTES