.\" Man page generated from reStructeredText. . .TH HG 1 "" "" "Mercurial Manual" .SH NAME hg \- Mercurial source code management system . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SYNOPSIS .sp \fBhg\fP \fIcommand\fP [\fIoption\fP]... [\fIargument\fP]... .SH DESCRIPTION .sp The \fBhg\fP command provides a command line interface to the Mercurial system. .SH COMMAND ELEMENTS .INDENT 0.0 .TP .B files... . indicates one or more filename or relative path filenames; see \%File Name Patterns\: for information on pattern matching .TP .B path . indicates a path on the local machine .TP .B revision . indicates a changeset which can be specified as a changeset revision number, a tag, or a unique substring of the changeset hash value .TP .B repository path . either the pathname of a local repository or the URI of a remote repository. .UNINDENT .SH OPTIONS .INDENT 0.0 .TP .B \-R, \-\-repository . repository root directory or name of overlay bundle file .TP .B \-\-cwd . change working directory .TP .B \-y, \-\-noninteractive . do not prompt, automatically pick the first choice for all prompts .TP .B \-q, \-\-quiet . suppress output .TP .B \-v, \-\-verbose . enable additional output .TP .B \-\-config . set/override config option (use \(aqsection.name=value\(aq) .TP .B \-\-debug . enable debugging output .TP .B \-\-debugger . start debugger .TP .B \-\-encoding . set the charset encoding (default: ascii) .TP .B \-\-encodingmode . set the charset encoding mode (default: strict) .TP .B \-\-traceback . always print a traceback on exception .TP .B \-\-time . time how long the command takes .TP .B \-\-profile . print command execution profile .TP .B \-\-version . output version information and exit .TP .B \-h, \-\-help . display help and exit .UNINDENT .SH COMMANDS .SS add .sp .nf .ft C hg add [OPTION]... [FILE]... .ft P .fi .sp Schedule files to be version controlled and added to the repository. .sp The files will be added to the repository at the next commit. To undo an add before that, see \%\fBhg forget\fP\:. .sp If no names are given, add all files to the repository. .sp An example showing how new (unknown) files are added automatically by \%\fBhg add\fP\:: .sp .nf .ft C $ ls foo.c $ hg status ? foo.c $ hg add adding foo.c $ hg status A foo.c .ft P .fi .sp Returns 0 if all files are successfully added. .sp Options: .INDENT 0.0 .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .TP .B \-S, \-\-subrepos . recurse into subrepositories .TP .B \-n, \-\-dry\-run . do not perform actions, just print output .UNINDENT .SS addremove .sp .nf .ft C hg addremove [OPTION]... [FILE]... .ft P .fi .sp Add all new files and remove all missing files from the repository. .sp New files are ignored if they match any of the patterns in \fB.hgignore\fP. As with add, these changes take effect at the next commit. .sp Use the \-s/\-\-similarity option to detect renamed files. With a parameter greater than 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. After using this option, \%\fBhg status \-C\fP\: can be used to check which files were identified as moved or renamed. .sp Returns 0 if all files are successfully added. .sp Options: .INDENT 0.0 .TP .B \-s, \-\-similarity . guess renamed files by similarity (0<=s<=100) .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .TP .B \-n, \-\-dry\-run . do not perform actions, just print output .UNINDENT .SS annotate .sp .nf .ft C hg annotate [\-r REV] [\-f] [\-a] [\-u] [\-d] [\-n] [\-c] [\-l] FILE... .ft P .fi .sp List changes in files, showing the revision id responsible for each line .sp This command is useful for discovering when a change was made and by whom. .sp Without the \-a/\-\-text option, annotate will avoid processing files it detects as binary. With \-a, annotate will annotate the file anyway, although the results will probably be neither useful nor desirable. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-rev . annotate the specified revision .TP .B \-\-follow . follow copies/renames and list the filename (DEPRECATED) .TP .B \-\-no\-follow . don\(aqt follow copies and renames .TP .B \-a, \-\-text . treat all files as text .TP .B \-u, \-\-user . list the author (long with \-v) .TP .B \-f, \-\-file . list the filename .TP .B \-d, \-\-date . list the date (short with \-q) .TP .B \-n, \-\-number . list the revision number (default) .TP .B \-c, \-\-changeset . list the changeset .TP .B \-l, \-\-line\-number . show line number at the first appearance .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .sp aliases: blame .UNINDENT .SS archive .sp .nf .ft C hg archive [OPTION]... DEST .ft P .fi .sp By default, the revision used is the parent of the working directory; use \-r/\-\-rev to specify a different revision. .sp The archive type is automatically detected based on file extension (or override using \-t/\-\-type). .sp Valid types are: .INDENT 0.0 .TP .B \fBfiles\fP .sp a directory full of files (default) .TP .B \fBtar\fP .sp tar archive, uncompressed .TP .B \fBtbz2\fP .sp tar archive, compressed using bzip2 .TP .B \fBtgz\fP .sp tar archive, compressed using gzip .TP .B \fBuzip\fP .sp zip archive, uncompressed .TP .B \fBzip\fP .sp zip archive, compressed using deflate .UNINDENT .sp The exact name of the destination archive or directory is given using a format string; see \%\fBhg help export\fP\: for details. .sp Each member added to an archive file has a directory prefix prepended. Use \-p/\-\-prefix to specify a format string for the prefix. The default is the basename of the archive, with suffixes removed. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-\-no\-decode . do not pass files through decoders .TP .B \-p, \-\-prefix . directory prefix for files in archive .TP .B \-r, \-\-rev . revision to distribute .TP .B \-t, \-\-type . type of distribution to create .TP .B \-S, \-\-subrepos . recurse into subrepositories .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .UNINDENT .SS backout .sp .nf .ft C hg backout [OPTION]... [\-r] REV .ft P .fi .sp Prepare a new changeset with the effect of REV undone in the current working directory. .sp If REV is the parent of the working directory, then this new changeset is committed automatically. Otherwise, hg needs to merge the changes and the merged result is left uncommitted. .sp By default, the pending changeset will have one parent, maintaining a linear history. With \-\-merge, the pending changeset will instead have two parents: the old parent of the working directory and a new child of REV that simply undoes REV. .sp Before version 1.7, the behavior without \-\-merge was equivalent to specifying \-\-merge followed by \%\fBhg update \-\-clean .\fP\: to cancel the merge and leave the child of REV as a head to be merged separately. .sp See \%\fBhg help dates\fP\: for a list of formats valid for \-d/\-\-date. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-\-merge . merge with old dirstate parent after backout .TP .B \-\-parent . parent to choose when backing out merge .TP .B \-t, \-\-tool . specify merge tool .TP .B \-r, \-\-rev . revision to backout .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .TP .B \-m, \-\-message . use text as commit message .TP .B \-l, \-\-logfile . read commit message from file .TP .B \-d, \-\-date . record the specified date as commit date .TP .B \-u, \-\-user . record the specified user as committer .UNINDENT .SS bisect .sp .nf .ft C hg bisect [\-gbsr] [\-U] [\-c CMD] [REV] .ft P .fi .sp 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 (unless the \-U/\-\-noupdate option is specified). Once you have performed tests, mark the working directory as good or bad, and bisect will either update to another candidate changeset or announce that it has found the bad revision. .sp As a shortcut, you can also use the revision argument to mark a revision as good or bad without checking it out first. .sp If you supply a command, it will be used for automatic bisection. Its exit status will be used to mark revisions as good or bad: status 0 means good, 125 means to skip the revision, 127 (command not found) will abort the bisection, and any other non\-zero exit status means the revision is bad. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-reset . reset bisect state .TP .B \-g, \-\-good . mark changeset good .TP .B \-b, \-\-bad . mark changeset bad .TP .B \-s, \-\-skip . skip testing changeset .TP .B \-e, \-\-extend . extend the bisect range .TP .B \-c, \-\-command . use command to check changeset state .TP .B \-U, \-\-noupdate . do not update to target .UNINDENT .SS bookmarks .sp .nf .ft C hg bookmarks [\-f] [\-d] [\-i] [\-m NAME] [\-r REV] [NAME] .ft P .fi .sp Bookmarks are pointers to certain commits that move when committing. Bookmarks are local. They can be renamed, copied and deleted. It is possible to use bookmark names in \%\fBhg merge\fP\: and \%\fBhg update\fP\: to merge and update respectively to a given bookmark. .sp You can use \%\fBhg bookmark NAME\fP\: to set a bookmark on the working directory\(aqs parent revision with the given name. If you specify a revision using \-r REV (where REV may be an existing bookmark), the bookmark is assigned to that revision. .sp Bookmarks can be pushed and pulled between repositories (see \%\fBhg help push\fP\: and \%\fBhg help pull\fP\:). This requires both the local and remote repositories to support bookmarks. For versions prior to 1.8, this means the bookmarks extension must be enabled. .sp Options: .INDENT 0.0 .TP .B \-f, \-\-force . force .TP .B \-r, \-\-rev . revision .TP .B \-d, \-\-delete . delete a given bookmark .TP .B \-m, \-\-rename . rename a given bookmark .TP .B \-i, \-\-inactive . do not mark a new bookmark active .UNINDENT .SS branch .sp .nf .ft C hg branch [\-fC] [NAME] .ft P .fi .sp With no argument, show the current branch name. With one argument, set the working directory branch name (the branch will not exist in the repository until the next commit). Standard practice recommends that primary development take place on the \(aqdefault\(aq branch. .sp Unless \-f/\-\-force is specified, branch will not let you set a branch name that already exists, even if it\(aqs inactive. .sp Use \-C/\-\-clean to reset the working directory branch to that of the parent of the working directory, negating a previous branch change. .sp Use the command \%\fBhg update\fP\: to switch to an existing branch. Use \%\fBhg commit \-\-close\-branch\fP\: to mark this branch as closed. .IP Note . Branch names are permanent. Use \%\fBhg bookmark\fP\: to create a light\-weight bookmark instead. See \%\fBhg help glossary\fP\: for more information about named branches and bookmarks. .RE .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-f, \-\-force . set branch name even if it shadows an existing branch .TP .B \-C, \-\-clean . reset branch name to parent branch name .UNINDENT .SS branches .sp .nf .ft C hg branches [\-ac] .ft P .fi .sp List the repository\(aqs named branches, indicating which ones are inactive. If \-c/\-\-closed is specified, also list branches which have been marked closed (see \%\fBhg commit \-\-close\-branch\fP\:). .sp If \-a/\-\-active is specified, only show active branches. A branch is considered active if it contains repository heads. .sp Use the command \%\fBhg update\fP\: to switch to an existing branch. .sp Returns 0. .sp Options: .INDENT 0.0 .TP .B \-a, \-\-active . show only branches that have unmerged heads .TP .B \-c, \-\-closed . show normal and closed branches .UNINDENT .SS bundle .sp .nf .ft C hg bundle [\-f] [\-t TYPE] [\-a] [\-r REV]... [\-\-base REV]... FILE [DEST] .ft P .fi .sp Generate a compressed changegroup file collecting changesets not known to be in another repository. .sp If you omit the destination repository, then hg assumes the destination will have all the nodes you specify with \-\-base parameters. To create a bundle containing all changesets, use \-a/\-\-all (or \-\-base null). .sp You can change compression method with the \-t/\-\-type option. The available compression methods are: none, bzip2, and gzip (by default, bundles are compressed using bzip2). .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. .sp Applying bundles preserves all changeset contents including permissions, copy/rename information, and revision history. .sp Returns 0 on success, 1 if no changes found. .sp Options: .INDENT 0.0 .TP .B \-f, \-\-force . run even when the destination is unrelated .TP .B \-r, \-\-rev . a changeset intended to be added to the destination .TP .B \-b, \-\-branch . a specific branch you would like to bundle .TP .B \-\-base . a base changeset assumed to be available at the destination .TP .B \-a, \-\-all . bundle all changesets in the repository .TP .B \-t, \-\-type . bundle compression type to use (default: bzip2) .TP .B \-e, \-\-ssh . specify ssh command to use .TP .B \-\-remotecmd . specify hg command to run on the remote side .TP .B \-\-insecure . do not verify server certificate (ignoring web.cacerts config) .UNINDENT .SS cat .sp .nf .ft C hg cat [OPTION]... FILE... .ft P .fi .sp 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. .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: .INDENT 0.0 .TP .B \fB%s\fP .sp basename of file being printed .TP .B \fB%d\fP .sp dirname of file being printed, or \(aq.\(aq if in repository root .TP .B \fB%p\fP .sp root\-relative path name of file being printed .UNINDENT .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-o, \-\-output . print output to file with formatted name .TP .B \-r, \-\-rev . print the given revision .TP .B \-\-decode . apply any matching decode filter .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .UNINDENT .SS clone .sp .nf .ft C hg clone [OPTION]... SOURCE [DEST] .ft P .fi .sp Create a copy of an existing repository in a new directory. .sp If no destination directory name is specified, it defaults to the basename of the source. .sp The location of the source is added to the new repository\(aqs \fB.hg/hgrc\fP file, as the default to be used for future pulls. .sp See \%\fBhg help urls\fP\: for valid source format details. .sp It is possible to specify an \fBssh://\fP URL as the destination, but no \fB.hg/hgrc\fP and working directory will be created on the remote side. Please see \%\fBhg help urls\fP\: for important details about \fBssh://\fP URLs. .sp A set of changesets (tags, or branch names) to pull may be specified by listing each changeset (tag, or branch name) with \-r/\-\-rev. If \-r/\-\-rev is used, the cloned repository will contain only a subset of the changesets of the source repository. Only the set of changesets defined by all \-r/\-\-rev options (including all their ancestors) will be pulled into the destination repository. No subsequent changesets (including subsequent tags) will be present in the destination. .sp Using \-r/\-\-rev (or \(aqclone src#rev dest\(aq) implies \-\-pull, even for local source repositories. .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 working directory). Some filesystems, such as AFS, implement hardlinking incorrectly, but do not report errors. In these cases, use the \-\-pull option to avoid hardlinking. .sp In some cases, you can clone repositories and the working directory using full hardlinks with .sp .nf .ft C $ cp \-al REPO REPOCLONE .ft P .fi .sp This is the fastest way to clone, but it is not always safe. 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). Also, this is not compatible with certain extensions that place their metadata under the .hg directory, such as mq. .sp Mercurial will update the working directory to the first applicable revision from this list: .INDENT 0.0 .IP a. 3 . null if \-U or the source repository has no changesets .IP b. 3 . if \-u . and the source repository is local, the first parent of the source repository\(aqs working directory .IP c. 3 . the changeset specified with \-u (if a branch name, this means the latest head of that branch) .IP d. 3 . the changeset specified with \-r .IP e. 3 . the tipmost head specified with \-b .IP f. 3 . the tipmost head specified with the url#branch source syntax .IP g. 3 . the tipmost head of the default branch .IP h. 3 . tip .UNINDENT .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-U, \-\-noupdate . the clone will include an empty working copy (only a repository) .TP .B \-u, \-\-updaterev . revision, tag or branch to check out .TP .B \-r, \-\-rev . include the specified changeset .TP .B \-b, \-\-branch . clone only the specified branch .TP .B \-\-pull . use pull protocol to copy metadata .TP .B \-\-uncompressed . use uncompressed transfer (fast over LAN) .TP .B \-e, \-\-ssh . specify ssh command to use .TP .B \-\-remotecmd . specify hg command to run on the remote side .TP .B \-\-insecure . do not verify server certificate (ignoring web.cacerts config) .UNINDENT .SS commit .sp .nf .ft C hg commit [OPTION]... [FILE]... .ft P .fi .sp Commit changes to the given files into the repository. Unlike a centralized SCM, this operation is a local operation. See \%\fBhg push\fP\: for a way to actively distribute your changes. .sp If a list of files is omitted, all changes reported by \%\fBhg status\fP\: will be committed. .sp If you are committing the result of a merge, do not provide any filenames or \-I/\-X filters. .sp If no commit message is specified, Mercurial starts your configured editor where you can enter a message. In case your commit fails, you will find a backup of your message in \fB.hg/last\-message.txt\fP. .sp See \%\fBhg help dates\fP\: for a list of formats valid for \-d/\-\-date. .sp Returns 0 on success, 1 if nothing changed. .sp Options: .INDENT 0.0 .TP .B \-A, \-\-addremove . mark new/missing files as added/removed before committing .TP .B \-\-close\-branch . mark a branch as closed, hiding it from the branch list .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .TP .B \-m, \-\-message . use text as commit message .TP .B \-l, \-\-logfile . read commit message from file .TP .B \-d, \-\-date . record the specified date as commit date .TP .B \-u, \-\-user . record the specified user as committer .sp aliases: ci .UNINDENT .SS copy .sp .nf .ft C hg copy [OPTION]... [SOURCE]... DEST .ft P .fi .sp Mark dest as having copies of source files. If dest is a directory, copies are put in that directory. If dest is a file, the source must be a single file. .sp By default, this command copies the contents of files as they exist in the working directory. If invoked with \-A/\-\-after, the operation is recorded, but no copying is performed. .sp This command takes effect with the next commit. To undo a copy before that, see \%\fBhg revert\fP\:. .sp Returns 0 on success, 1 if errors are encountered. .sp Options: .INDENT 0.0 .TP .B \-A, \-\-after . record a copy that has already occurred .TP .B \-f, \-\-force . forcibly copy over an existing managed file .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .TP .B \-n, \-\-dry\-run . do not perform actions, just print output .sp aliases: cp .UNINDENT .SS diff .sp .nf .ft C hg diff [OPTION]... ([\-c REV] | [\-r REV1 [\-r REV2]]) [FILE]... .ft P .fi .sp Show differences between revisions for the specified files. .sp Differences between files are shown using the unified diff format. .IP Note . diff may generate unexpected results for merges, as it will default to comparing against the working directory\(aqs first parent changeset if no revisions are specified. .RE .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. .sp Alternatively you can specify \-c/\-\-change with a revision to see the changes in that changeset relative to its first parent. .sp Without the \-a/\-\-text option, diff will avoid generating diffs of files it detects as binary. With \-a, diff will generate a diff anyway, probably with undesirable results. .sp Use the \-g/\-\-git option to generate diffs in the git extended diff format. For more information, read \%\fBhg help diffs\fP\:. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-rev . revision .TP .B \-c, \-\-change . change made by revision .TP .B \-a, \-\-text . treat all files as text .TP .B \-g, \-\-git . use git extended diff format .TP .B \-\-nodates . omit dates from diff headers .TP .B \-p, \-\-show\-function . show which function each change is in .TP .B \-\-reverse . produce a diff that undoes the changes .TP .B \-w, \-\-ignore\-all\-space . ignore white space when comparing lines .TP .B \-b, \-\-ignore\-space\-change . ignore changes in the amount of white space .TP .B \-B, \-\-ignore\-blank\-lines . ignore changes whose lines are all blank .TP .B \-U, \-\-unified . number of lines of context to show .TP .B \-\-stat . output diffstat\-style summary of changes .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .TP .B \-S, \-\-subrepos . recurse into subrepositories .UNINDENT .SS export .sp .nf .ft C hg export [OPTION]... [\-o OUTFILESPEC] REV... .ft P .fi .sp Print the changeset header and diffs for one or more revisions. .sp The information shown in the changeset header is: author, date, branch name (if non\-default), changeset hash, parent(s) and commit comment. .IP Note . export may generate unexpected diff output for merge changesets, as it will compare the merge changeset against its first parent only. .RE .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: .INDENT 0.0 .TP .B \fB%%\fP .sp literal "%" character .TP .B \fB%H\fP .sp changeset hash (40 hexadecimal digits) .TP .B \fB%N\fP .sp number of patches being generated .TP .B \fB%R\fP .sp changeset revision number .TP .B \fB%b\fP .sp basename of the exporting repository .TP .B \fB%h\fP .sp short\-form changeset hash (12 hexadecimal digits) .TP .B \fB%n\fP .sp zero\-padded sequence number, starting at 1 .TP .B \fB%r\fP .sp zero\-padded changeset revision number .UNINDENT .sp Without the \-a/\-\-text option, export will avoid generating diffs of files it detects as binary. With \-a, export will generate a diff anyway, probably with undesirable results. .sp Use the \-g/\-\-git option to generate diffs in the git extended diff format. See \%\fBhg help diffs\fP\: for more information. .sp With the \-\-switch\-parent option, the diff will be against the second parent. It can be useful to review a merge. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-o, \-\-output . print output to file with formatted name .TP .B \-\-switch\-parent . diff against the second parent .TP .B \-r, \-\-rev . revisions to export .TP .B \-a, \-\-text . treat all files as text .TP .B \-g, \-\-git . use git extended diff format .TP .B \-\-nodates . omit dates from diff headers .UNINDENT .SS forget .sp .nf .ft C hg forget [OPTION]... FILE... .ft P .fi .sp Mark the specified files so they will no longer be tracked after the next commit. .sp This only removes files from the current branch, not from the entire project history, and it does not delete them from the working directory. .sp To undo a forget before the next commit, see \%\fBhg add\fP\:. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .UNINDENT .SS grep .sp .nf .ft C hg grep [OPTION]... PATTERN [FILE]... .ft P .fi .sp Search revisions of files for a regular expression. .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. .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. .sp Returns 0 if a match is found, 1 otherwise. .sp Options: .INDENT 0.0 .TP .B \-0, \-\-print0 . end fields with NUL .TP .B \-\-all . print all revisions that match .TP .B \-a, \-\-text . treat all files as text .TP .B \-f, \-\-follow . follow changeset history, or file history across copies and renames .TP .B \-i, \-\-ignore\-case . ignore case when matching .TP .B \-l, \-\-files\-with\-matches . print only filenames and revisions that match .TP .B \-n, \-\-line\-number . print matching line numbers .TP .B \-r, \-\-rev . only search files changed within revision range .TP .B \-u, \-\-user . list the author (long with \-v) .TP .B \-d, \-\-date . list the date (short with \-q) .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .UNINDENT .SS heads .sp .nf .ft C hg heads [\-ac] [\-r STARTREV] [REV]... .ft P .fi .sp With no arguments, show all repository branch heads. .sp Repository "heads" are changesets with no 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 no child changeset on the same branch. .sp If one or more REVs are given, only branch heads on the branches associated with the specified changesets are shown. This means that you can use \%\fBhg heads foo\fP\: to see the heads on a branch named \fBfoo\fP. .sp If \-c/\-\-closed is specified, also show branch heads marked closed (see \%\fBhg commit \-\-close\-branch\fP\:). .sp If STARTREV is specified, only those heads that are descendants of STARTREV will be displayed. .sp If \-t/\-\-topo is specified, named branch mechanics will be ignored and only changesets without children will be shown. .sp Returns 0 if matching heads are found, 1 if not. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-rev . show only heads which are descendants of STARTREV .TP .B \-t, \-\-topo . show topological heads only .TP .B \-a, \-\-active . show active branchheads only (DEPRECATED) .TP .B \-c, \-\-closed . show normal and closed branch heads .TP .B \-\-style . display using template map file .TP .B \-\-template . display with template .UNINDENT .SS help .sp .nf .ft C hg help [\-ec] [TOPIC] .ft P .fi .sp With no arguments, print a list of commands with short help messages. .sp Given a topic, extension, or command name, print help for that topic. .sp Returns 0 if successful. .sp Options: .INDENT 0.0 .TP .B \-e, \-\-extension . show only help for extensions .TP .B \-c, \-\-command . show only help for commands .UNINDENT .SS identify .sp .nf .ft C hg identify [\-nibtB] [\-r REV] [SOURCE] .ft P .fi .sp Print a summary identifying the repository state at REV using one or two parent hash identifiers, followed by a "+" if the working directory has uncommitted changes, the branch name (if not default), a list of tags, and a list of bookmarks. .sp When REV is not given, print a summary of the current state of the repository. .sp Specifying a path to a repository root or Mercurial bundle will cause lookup to operate on that repository/bundle. .sp Returns 0 if successful. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-rev . identify the specified revision .TP .B \-n, \-\-num . show local revision number .TP .B \-i, \-\-id . show global revision id .TP .B \-b, \-\-branch . show branch .TP .B \-t, \-\-tags . show tags .TP .B \-B, \-\-bookmarks . show bookmarks .sp aliases: id .UNINDENT .SS import .sp .nf .ft C hg import [OPTION]... PATCH... .ft P .fi .sp Import a list of patches and commit them individually (unless \-\-no\-commit is specified). .sp If there are outstanding changes in the working directory, import will abort unless given the \-f/\-\-force flag. .sp You can import a patch straight from a mail message. Even patches as attachments work (to use the body part, it must have type text/plain or text/x\-patch). 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. .sp If the imported patch was generated by \%\fBhg export\fP\:, user and description from patch override values from message headers and body. Values given on command line with \-m/\-\-message and \-u/\-\-user override these. .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. .sp Use \-\-bypass to apply and commit patches directly to the repository, not touching the working directory. Without \-\-exact, patches will be applied on top of the working directory parent revision. .sp With \-s/\-\-similarity, hg will attempt to discover renames and copies in the patch in the same way as \(aqaddremove\(aq. .sp To read a patch from standard input, use "\-" as the patch name. If a URL is specified, the patch will be downloaded from it. See \%\fBhg help dates\fP\: for a list of formats valid for \-d/\-\-date. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-p, \-\-strip . directory strip option for patch. This has the same meaning as the corresponding patch option (default: 1) .TP .B \-b, \-\-base . base path (DEPRECATED) .TP .B \-f, \-\-force . skip check for outstanding uncommitted changes .TP .B \-\-no\-commit . don\(aqt commit, just update the working directory .TP .B \-\-bypass . apply patch without touching the working directory .TP .B \-\-exact . apply patch to the nodes from which it was generated .TP .B \-\-import\-branch . use any branch information in patch (implied by \-\-exact) .TP .B \-m, \-\-message . use text as commit message .TP .B \-l, \-\-logfile . read commit message from file .TP .B \-d, \-\-date . record the specified date as commit date .TP .B \-u, \-\-user . record the specified user as committer .TP .B \-s, \-\-similarity . guess renamed files by similarity (0<=s<=100) .sp aliases: patch .UNINDENT .SS incoming .sp .nf .ft C hg incoming [\-p] [\-n] [\-M] [\-f] [\-r REV]... [\-\-bundle FILENAME] [SOURCE] .ft P .fi .sp Show new changesets found in the specified path/URL or the default pull location. These are the changesets that would have been pulled if a pull at the time you issued this command. .sp For remote repository, using \-\-bundle avoids downloading the changesets twice if the incoming is followed by a pull. .sp See pull for valid source format details. .sp Returns 0 if there are incoming changes, 1 otherwise. .sp Options: .INDENT 0.0 .TP .B \-f, \-\-force . run even if remote repository is unrelated .TP .B \-n, \-\-newest\-first . show newest record first .TP .B \-\-bundle . file to store the bundles into .TP .B \-r, \-\-rev . a remote changeset intended to be added .TP .B \-B, \-\-bookmarks . compare bookmarks .TP .B \-b, \-\-branch . a specific branch you would like to pull .TP .B \-p, \-\-patch . show patch .TP .B \-g, \-\-git . use git extended diff format .TP .B \-l, \-\-limit . limit number of changes displayed .TP .B \-M, \-\-no\-merges . do not show merges .TP .B \-\-stat . output diffstat\-style summary of changes .TP .B \-\-style . display using template map file .TP .B \-\-template . display with template .TP .B \-e, \-\-ssh . specify ssh command to use .TP .B \-\-remotecmd . specify hg command to run on the remote side .TP .B \-\-insecure . do not verify server certificate (ignoring web.cacerts config) .TP .B \-S, \-\-subrepos . recurse into subrepositories .sp aliases: in .UNINDENT .SS init .sp .nf .ft C hg init [\-e CMD] [\-\-remotecmd CMD] [DEST] .ft P .fi .sp Initialize a new repository in the given directory. If the given directory does not exist, it will be created. .sp If no directory is given, the current directory is used. .sp It is possible to specify an \fBssh://\fP URL as the destination. See \%\fBhg help urls\fP\: for more information. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-e, \-\-ssh . specify ssh command to use .TP .B \-\-remotecmd . specify hg command to run on the remote side .TP .B \-\-insecure . do not verify server certificate (ignoring web.cacerts config) .UNINDENT .SS locate .sp .nf .ft C hg locate [OPTION]... [PATTERN]... .ft P .fi .sp Print files under Mercurial control in the working directory whose names match the given patterns. .sp By default, this command searches all directories in the working directory. To search just the current directory and its subdirectories, use "\-\-include .". .sp If no patterns are given to match, this command prints the names of all files under Mercurial control in the working directory. .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 whitespace as multiple filenames. .sp Returns 0 if a match is found, 1 otherwise. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-rev . search the repository as it is in REV .TP .B \-0, \-\-print0 . end filenames with NUL, for use with xargs .TP .B \-f, \-\-fullpath . print complete paths from the filesystem root .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .UNINDENT .SS log .sp .nf .ft C hg log [OPTION]... [FILE] .ft P .fi .sp Print the revision history of the specified files or the entire project. .sp File history is shown without following rename or copy history of files. Use \-f/\-\-follow with a filename to follow history across renames and copies. \-\-follow without a filename will only show ancestors or descendants of the starting revision. \-\-follow\-first only follows the first parent of merge revisions. .sp If no revision range is specified, the default is \fBtip:0\fP unless \-\-follow is set, in which case the working directory parent is used as the starting revision. You can specify a revision set for log, see \%\fBhg help revsets\fP\: for more information. .sp See \%\fBhg help dates\fP\: for a list of formats valid for \-d/\-\-date. .sp By default this command prints revision number and changeset id, 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 are shown. .IP Note . log \-p/\-\-patch may generate unexpected diff output for merge changesets, as it will only compare the merge changeset against its first parent. Also, only files different from BOTH parents will appear in files:. .RE .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-f, \-\-follow . follow changeset history, or file history across copies and renames .TP .B \-\-follow\-first . only follow the first parent of merge changesets .TP .B \-d, \-\-date . show revisions matching date spec .TP .B \-C, \-\-copies . show copied files .TP .B \-k, \-\-keyword . do case\-insensitive search for a given text .TP .B \-r, \-\-rev . show the specified revision or range .TP .B \-\-removed . include revisions where files were removed .TP .B \-m, \-\-only\-merges . show only merges .TP .B \-u, \-\-user . revisions committed by user .TP .B \-\-only\-branch . show only changesets within the given named branch (DEPRECATED) .TP .B \-b, \-\-branch . show changesets within the given named branch .TP .B \-P, \-\-prune . do not display revision or any of its ancestors .TP .B \-\-hidden . show hidden changesets .TP .B \-p, \-\-patch . show patch .TP .B \-g, \-\-git . use git extended diff format .TP .B \-l, \-\-limit . limit number of changes displayed .TP .B \-M, \-\-no\-merges . do not show merges .TP .B \-\-stat . output diffstat\-style summary of changes .TP .B \-\-style . display using template map file .TP .B \-\-template . display with template .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .sp aliases: history .UNINDENT .SS manifest .sp .nf .ft C hg manifest [\-r REV] .ft P .fi .sp Print a list of version controlled files for the given revision. If no revision is given, the first parent of the working directory is used, or the null revision if no revision is checked out. .sp With \-v, print file permissions, symlink and executable bits. With \-\-debug, print file revision hashes. .sp If option \-\-all is specified, the list of all files from all revisions is printed. This includes deleted and renamed files. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-rev . revision to display .TP .B \-\-all . list files from all revisions .UNINDENT .SS merge .sp .nf .ft C hg merge [\-P] [\-f] [[\-r] REV] .ft P .fi .sp The current working directory is updated with all changes made in the requested revision since the last common predecessor revision. .sp Files that changed between either parent are marked as changed for the next commit and a commit must be performed before any further updates to the repository are allowed. The next commit will have two parents. .sp \fB\-\-tool\fP can be used to specify the merge tool used for file merges. It overrides the HGMERGE environment variable and your configuration files. See \%\fBhg help merge\-tools\fP\: for options. .sp If no revision is specified, the working directory\(aqs parent is a head revision, and the current branch contains exactly one other head, the other head is merged with by default. Otherwise, an explicit revision with which to merge with must be provided. .sp \%\fBhg resolve\fP\: must be used to resolve unresolved files. .sp To undo an uncommitted merge, use \%\fBhg update \-\-clean .\fP\: which will check out a clean copy of the original merge parent, losing all changes. .sp Returns 0 on success, 1 if there are unresolved files. .sp Options: .INDENT 0.0 .TP .B \-f, \-\-force . force a merge with outstanding changes .TP .B \-t, \-\-tool . specify merge tool .TP .B \-r, \-\-rev . revision to merge .TP .B \-P, \-\-preview . review revisions to merge (no merge is performed) .UNINDENT .SS outgoing .sp .nf .ft C hg outgoing [\-M] [\-p] [\-n] [\-f] [\-r REV]... [DEST] .ft P .fi .sp 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. .sp See pull for details of valid destination formats. .sp Returns 0 if there are outgoing changes, 1 otherwise. .sp Options: .INDENT 0.0 .TP .B \-f, \-\-force . run even when the destination is unrelated .TP .B \-r, \-\-rev . a changeset intended to be included in the destination .TP .B \-n, \-\-newest\-first . show newest record first .TP .B \-B, \-\-bookmarks . compare bookmarks .TP .B \-b, \-\-branch . a specific branch you would like to push .TP .B \-p, \-\-patch . show patch .TP .B \-g, \-\-git . use git extended diff format .TP .B \-l, \-\-limit . limit number of changes displayed .TP .B \-M, \-\-no\-merges . do not show merges .TP .B \-\-stat . output diffstat\-style summary of changes .TP .B \-\-style . display using template map file .TP .B \-\-template . display with template .TP .B \-e, \-\-ssh . specify ssh command to use .TP .B \-\-remotecmd . specify hg command to run on the remote side .TP .B \-\-insecure . do not verify server certificate (ignoring web.cacerts config) .TP .B \-S, \-\-subrepos . recurse into subrepositories .sp aliases: out .UNINDENT .SS parents .sp .nf .ft C hg parents [\-r REV] [FILE] .ft P .fi .sp Print the working directory\(aqs parent revisions. If a revision is given via \-r/\-\-rev, the parent of that revision will be printed. If a file argument is given, the revision in which the file was last changed (before the working directory revision or the argument to \-\-rev if given) is printed. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-rev . show parents of the specified revision .TP .B \-\-style . display using template map file .TP .B \-\-template . display with template .UNINDENT .SS paths .sp .nf .ft C hg paths [NAME] .ft P .fi .sp Show definition of symbolic path name NAME. If no name is given, show definition of all available names. .sp Option \-q/\-\-quiet suppresses all output when searching for NAME and shows only the path names when listing all definitions. .sp Path names are defined in the [paths] section of your configuration file and in \fB/etc/mercurial/hgrc\fP. If run inside a repository, \fB.hg/hgrc\fP is used, too. .sp The path names \fBdefault\fP and \fBdefault\-push\fP have a special meaning. When performing a push or pull operation, they are used as fallbacks if no location is specified on the command\-line. When \fBdefault\-push\fP is set, it will be used for push and \fBdefault\fP will be used for pull; otherwise \fBdefault\fP is used as the fallback for both. When cloning a repository, the clone source is written as \fBdefault\fP in \fB.hg/hgrc\fP. Note that \fBdefault\fP and \fBdefault\-push\fP apply to all inbound (e.g. \%\fBhg incoming\fP\:) and outbound (e.g. \%\fBhg outgoing\fP\:, \%\fBhg email\fP\: and \%\fBhg bundle\fP\:) operations. .sp See \%\fBhg help urls\fP\: for more information. .sp Returns 0 on success. .SS pull .sp .nf .ft C hg pull [\-u] [\-f] [\-r REV]... [\-e CMD] [\-\-remotecmd CMD] [SOURCE] .ft P .fi .sp Pull changes from a remote repository to a local one. .sp This finds all changes from the repository at the specified path or URL and adds them to a local repository (the current one unless \-R is specified). By default, this does not update the copy of the project in the working directory. .sp Use \%\fBhg incoming\fP\: if you want to see what would have been added by a pull at the time you issued this command. If you then decide to add those changes to the repository, you should use \%\fBhg pull \-r X\fP\: where \fBX\fP is the last changeset listed by \%\fBhg incoming\fP\:. .sp If SOURCE is omitted, the \(aqdefault\(aq path will be used. See \%\fBhg help urls\fP\: for more information. .sp Returns 0 on success, 1 if an update had unresolved files. .sp Options: .INDENT 0.0 .TP .B \-u, \-\-update . update to new branch head if changesets were pulled .TP .B \-f, \-\-force . run even when remote repository is unrelated .TP .B \-r, \-\-rev . a remote changeset intended to be added .TP .B \-B, \-\-bookmark . bookmark to pull .TP .B \-b, \-\-branch . a specific branch you would like to pull .TP .B \-e, \-\-ssh . specify ssh command to use .TP .B \-\-remotecmd . specify hg command to run on the remote side .TP .B \-\-insecure . do not verify server certificate (ignoring web.cacerts config) .UNINDENT .SS push .sp .nf .ft C hg push [\-f] [\-r REV]... [\-e CMD] [\-\-remotecmd CMD] [DEST] .ft P .fi .sp Push changesets from the local repository to the specified destination. .sp This operation is symmetrical to pull: it is identical to a pull in the destination repository from the current one. .sp By default, push will not allow creation of new heads at the destination, since multiple heads would make it unclear which head to use. In this situation, it is recommended to pull and merge before pushing. .sp Use \-\-new\-branch if you want to allow push to create a new named branch that is not present at the destination. This allows you to only create a new branch without forcing other changes. .sp Use \-f/\-\-force to override the default behavior and push all changesets on all branches. .sp If \-r/\-\-rev is used, the specified revision and all its ancestors will be pushed to the remote repository. .sp Please see \%\fBhg help urls\fP\: for important details about \fBssh://\fP URLs. If DESTINATION is omitted, a default path will be used. .sp Returns 0 if push was successful, 1 if nothing to push. .sp Options: .INDENT 0.0 .TP .B \-f, \-\-force . force push .TP .B \-r, \-\-rev . a changeset intended to be included in the destination .TP .B \-B, \-\-bookmark . bookmark to push .TP .B \-b, \-\-branch . a specific branch you would like to push .TP .B \-\-new\-branch . allow pushing a new branch .TP .B \-e, \-\-ssh . specify ssh command to use .TP .B \-\-remotecmd . specify hg command to run on the remote side .TP .B \-\-insecure . do not verify server certificate (ignoring web.cacerts config) .UNINDENT .SS recover .sp .nf .ft C hg recover .ft P .fi .sp Recover from an interrupted commit or pull. .sp This command tries to fix the repository status after an interrupted operation. It should only be necessary when Mercurial suggests it. .sp Returns 0 if successful, 1 if nothing to recover or verify fails. .SS remove .sp .nf .ft C hg remove [OPTION]... FILE... .ft P .fi .sp Schedule the indicated files for removal from the repository. .sp This only removes files from the current branch, not from the entire project history. \-A/\-\-after can be used to remove only files that have already been deleted, \-f/\-\-force can be used to force deletion, and \-Af can be used to remove files from the next revision without deleting them from the working directory. .sp The following table details the behavior of remove for different file states (columns) and option combinations (rows). The file states are Added [A], Clean [C], Modified [M] and Missing [!] (as reported by \%\fBhg status\fP\:). The actions are Warn, Remove (from branch) and Delete (from disk): .sp .nf .ft C A C M ! none W RD W R \-f R RD RD R \-A W W W R \-Af R R R R .ft P .fi .sp Note that remove never deletes files in Added [A] state from the working directory, not even if option \-\-force is specified. .sp This command schedules the files to be removed at the next commit. To undo a remove before that, see \%\fBhg revert\fP\:. .sp Returns 0 on success, 1 if any warnings encountered. .sp Options: .INDENT 0.0 .TP .B \-A, \-\-after . record delete for missing files .TP .B \-f, \-\-force . remove (and delete) file even if added or modified .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .sp aliases: rm .UNINDENT .SS rename .sp .nf .ft C hg rename [OPTION]... SOURCE... DEST .ft P .fi .sp 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. .sp By default, this command copies the contents of files as they exist in the working directory. If invoked with \-A/\-\-after, the operation is recorded, but no copying is performed. .sp This command takes effect at the next commit. To undo a rename before that, see \%\fBhg revert\fP\:. .sp Returns 0 on success, 1 if errors are encountered. .sp Options: .INDENT 0.0 .TP .B \-A, \-\-after . record a rename that has already occurred .TP .B \-f, \-\-force . forcibly copy over an existing managed file .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .TP .B \-n, \-\-dry\-run . do not perform actions, just print output .sp aliases: move mv .UNINDENT .SS resolve .sp .nf .ft C hg resolve [OPTION]... [FILE]... .ft P .fi .sp Merges with unresolved conflicts are often the result of non\-interactive merging using the \fBinternal:merge\fP configuration setting, or a command\-line merge tool like \fBdiff3\fP. The resolve command is used to manage the files involved in a merge, after \%\fBhg merge\fP\: has been run, and before \%\fBhg commit\fP\: is run (i.e. the working directory must have two parents). .sp The resolve command can be used in the following ways: .INDENT 0.0 .IP \(bu 2 . \%\fBhg resolve [\-\-tool TOOL] FILE...\fP\:: attempt to re\-merge the specified files, discarding any previous merge attempts. Re\-merging is not performed for files already marked as resolved. Use \fB\-\-all/\-a\fP to select all unresolved files. \fB\-\-tool\fP can be used to specify the merge tool used for the given files. It overrides the HGMERGE environment variable and your configuration files. .IP \(bu 2 . \%\fBhg resolve \-m [FILE]\fP\:: mark a file as having been resolved (e.g. after having manually fixed\-up the files). The default is to mark all unresolved files. .IP \(bu 2 . \%\fBhg resolve \-u [FILE]...\fP\:: mark a file as unresolved. The default is to mark all resolved files. .IP \(bu 2 . \%\fBhg resolve \-l\fP\:: list files which had or still have conflicts. In the printed list, \fBU\fP = unresolved and \fBR\fP = resolved. .UNINDENT .sp Note that Mercurial will not let you commit files with unresolved merge conflicts. You must use \%\fBhg resolve \-m ...\fP\: before you can commit after a conflicting merge. .sp Returns 0 on success, 1 if any files fail a resolve attempt. .sp Options: .INDENT 0.0 .TP .B \-a, \-\-all . select all unresolved files .TP .B \-l, \-\-list . list state of files needing merge .TP .B \-m, \-\-mark . mark files as resolved .TP .B \-u, \-\-unmark . mark files as unresolved .TP .B \-t, \-\-tool . specify merge tool .TP .B \-n, \-\-no\-status . hide status prefix .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .UNINDENT .SS revert .sp .nf .ft C hg revert [OPTION]... [\-r REV] [NAME]... .ft P .fi .IP Note . To check out earlier revisions, you should use \%\fBhg update REV\fP\:. To cancel a merge (and lose your changes), use \%\fBhg update \-\-clean .\fP\:. .RE .sp With no revision specified, revert the specified files or directories to the contents they had in the parent of the working directory. This restores the contents of files to an unmodified state and unschedules adds, removes, copies, and renames. If the working directory has two parents, you must explicitly specify a revision. .sp Using the \-r/\-\-rev or \-d/\-\-date options, revert the given files or directories to their states as of a specific revision. Because revert does not change the working directory parents, this will cause these files to appear modified. This can be helpful to "back out" some or all of an earlier change. See \%\fBhg backout\fP\: for a related method. .sp Modified files are saved with a .orig suffix before reverting. To disable these backups, use \-\-no\-backup. .sp See \%\fBhg help dates\fP\: for a list of formats valid for \-d/\-\-date. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-a, \-\-all . revert all changes when no arguments given .TP .B \-d, \-\-date . tipmost revision matching date .TP .B \-r, \-\-rev . revert to the specified revision .TP .B \-\-no\-backup . do not save backup copies of files .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .TP .B \-n, \-\-dry\-run . do not perform actions, just print output .UNINDENT .SS rollback .sp .nf .ft C hg rollback .ft P .fi .sp 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. This command does not alter the working directory. .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: .INDENT 0.0 .IP \(bu 2 . commit .IP \(bu 2 . import .IP \(bu 2 . pull .IP \(bu 2 . push (with this repository as the destination) .IP \(bu 2 . unbundle .UNINDENT .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. .sp Returns 0 on success, 1 if no rollback data is available. .sp Options: .INDENT 0.0 .TP .B \-n, \-\-dry\-run . do not perform actions, just print output .UNINDENT .SS root .sp .nf .ft C hg root .ft P .fi .sp Print the root directory of the current repository. .sp Returns 0 on success. .SS serve .sp .nf .ft C hg serve [OPTION]... .ft P .fi .sp Start a local HTTP repository browser and pull server. You can use this for ad\-hoc sharing and browsing of repositories. It is recommended to use a real web server to serve a repository for longer periods of time. .sp Please note that the server does not implement access control. This means that, by default, anybody can read from the server and nobody can write to it by default. Set the \fBweb.allow_push\fP option to \fB*\fP to allow everybody to push to the server. You should use a real web server if you need to authenticate users. .sp By default, the server logs accesses to stdout and errors to stderr. Use the \-A/\-\-accesslog and \-E/\-\-errorlog options to log to files. .sp To have the server choose a free port number to listen on, specify a port number of 0; in this case, the server will print the port number it uses. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-A, \-\-accesslog . name of access log file to write to .TP .B \-d, \-\-daemon . run server in background .TP .B \-\-daemon\-pipefds . used internally by daemon mode .TP .B \-E, \-\-errorlog . name of error log file to write to .TP .B \-p, \-\-port . port to listen on (default: 8000) .TP .B \-a, \-\-address . address to listen on (default: all interfaces) .TP .B \-\-prefix . prefix path to serve from (default: server root) .TP .B \-n, \-\-name . name to show in web pages (default: working directory) .TP .B \-\-web\-conf . name of the hgweb config file (see "hg help hgweb") .TP .B \-\-webdir\-conf . name of the hgweb config file (DEPRECATED) .TP .B \-\-pid\-file . name of file to write process ID to .TP .B \-\-stdio . for remote clients .TP .B \-\-cmdserver . for remote clients .TP .B \-t, \-\-templates . web templates to use .TP .B \-\-style . template style to use .TP .B \-6, \-\-ipv6 . use IPv6 in addition to IPv4 .TP .B \-\-certificate . SSL certificate file .UNINDENT .SS showconfig .sp .nf .ft C hg showconfig [\-u] [NAME]... .ft P .fi .sp With no arguments, print names and values of all config items. .sp With one argument of the form section.name, print just the value of that config item. .sp With multiple arguments, print names and values of all config items with matching section names. .sp With \-\-debug, the source (filename and line number) is printed for each config item. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-u, \-\-untrusted . show untrusted configuration options .sp aliases: debugconfig .UNINDENT .SS status .sp .nf .ft C hg status [OPTION]... [FILE]... .ft P .fi .sp Show status of files in the repository. If names are given, only files that match are shown. Files that are clean or ignored or the source of a copy/move operation, are not listed unless \-c/\-\-clean, \-i/\-\-ignored, \-C/\-\-copies or \-A/\-\-all are given. Unless options described with "show only ..." are given, the options \-mardu are used. .sp Option \-q/\-\-quiet hides untracked (unknown and ignored) files unless explicitly requested with \-u/\-\-unknown or \-i/\-\-ignored. .IP 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. .RE .sp If one revision is given, it is used as the base revision. If two revisions are given, the differences between them are shown. The \-\-change option can also be used as a shortcut to list the changed files of a revision from its first parent. .sp The codes used to show the status of files are: .sp .nf .ft C M = modified A = added R = removed C = clean ! = missing (deleted by non\-hg command, but still tracked) ? = not tracked I = ignored = origin of the previous file listed as A (added) .ft P .fi .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-A, \-\-all . show status of all files .TP .B \-m, \-\-modified . show only modified files .TP .B \-a, \-\-added . show only added files .TP .B \-r, \-\-removed . show only removed files .TP .B \-d, \-\-deleted . show only deleted (but tracked) files .TP .B \-c, \-\-clean . show only files without changes .TP .B \-u, \-\-unknown . show only unknown (not tracked) files .TP .B \-i, \-\-ignored . show only ignored files .TP .B \-n, \-\-no\-status . hide status prefix .TP .B \-C, \-\-copies . show source of copied files .TP .B \-0, \-\-print0 . end filenames with NUL, for use with xargs .TP .B \-\-rev . show difference from revision .TP .B \-\-change . list the changed files of a revision .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .TP .B \-S, \-\-subrepos . recurse into subrepositories .sp aliases: st .UNINDENT .SS summary .sp .nf .ft C hg summary [\-\-remote] .ft P .fi .sp This generates a brief summary of the working directory state, including parents, branch, commit status, and available updates. .sp With the \-\-remote option, this will check the default paths for incoming and outgoing changes. This can be time\-consuming. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-\-remote . check for push and pull .sp aliases: sum .UNINDENT .SS tag .sp .nf .ft C hg tag [\-f] [\-l] [\-m TEXT] [\-d DATE] [\-u USER] [\-r REV] NAME... .ft P .fi .sp Name a particular revision using . .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. Changing an existing tag is normally disallowed; use \-f/\-\-force to override. .sp If no revision is given, the parent of the working directory is used, or tip if no revision is checked out. .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. This also means that tagging creates a new commit. The file ".hg/localtags" is used for local tags (not shared among repositories). .sp Tag commits are usually made at the head of a branch. If the parent of the working directory is not a branch head, \%\fBhg tag\fP\: aborts; use \-f/\-\-force to force the tag commit to be based on a non\-head changeset. .sp See \%\fBhg help dates\fP\: for a list of formats valid for \-d/\-\-date. .sp Since tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-f, \-\-force . force tag .TP .B \-l, \-\-local . make the tag local .TP .B \-r, \-\-rev . revision to tag .TP .B \-\-remove . remove a tag .TP .B \-e, \-\-edit . edit commit message .TP .B \-m, \-\-message . use as commit message .TP .B \-d, \-\-date . record the specified date as commit date .TP .B \-u, \-\-user . record the specified user as committer .UNINDENT .SS tags .sp .nf .ft C hg tags .ft P .fi .sp This lists both regular and local tags. When the \-v/\-\-verbose switch is used, a third column "local" is printed for local tags. .sp Returns 0 on success. .SS tip .sp .nf .ft C hg tip [\-p] [\-g] .ft P .fi .sp The tip revision (usually just called the tip) is the changeset most recently added to the repository (and therefore the most recently changed head). .sp 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. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-p, \-\-patch . show patch .TP .B \-g, \-\-git . use git extended diff format .TP .B \-\-style . display using template map file .TP .B \-\-template . display with template .UNINDENT .SS unbundle .sp .nf .ft C hg unbundle [\-u] FILE... .ft P .fi .sp Apply one or more compressed changegroup files generated by the bundle command. .sp Returns 0 on success, 1 if an update has unresolved files. .sp Options: .INDENT 0.0 .TP .B \-u, \-\-update . update to new branch head if changesets were unbundled .UNINDENT .SS update .sp .nf .ft C hg update [\-c] [\-C] [\-d DATE] [[\-r] REV] .ft P .fi .sp Update the repository\(aqs working directory to the specified changeset. If no changeset is specified, update to the tip of the current named branch. .sp If the changeset is not a descendant of the working directory\(aqs parent, the update is aborted. With the \-c/\-\-check option, the working directory is checked for uncommitted changes; if none are found, the working directory is updated to the specified changeset. .sp Update sets the working directory\(aqs parent revison to the specified changeset (see \%\fBhg help parents\fP\:). .sp The following rules apply when the working directory contains uncommitted changes: .INDENT 0.0 .IP 1. 3 . If neither \-c/\-\-check nor \-C/\-\-clean is specified, and if the requested changeset is an ancestor or descendant of the working directory\(aqs parent, the uncommitted changes are merged into the requested changeset and the merged result is left uncommitted. If the requested changeset is not an ancestor or descendant (that is, it is on another branch), the update is aborted and the uncommitted changes are preserved. .IP 2. 3 . With the \-c/\-\-check option, the update is aborted and the uncommitted changes are preserved. .IP 3. 3 . With the \-C/\-\-clean option, uncommitted changes are discarded and the working directory is updated to the requested changeset. .UNINDENT .sp Use null as the changeset to remove the working directory (like \%\fBhg clone \-U\fP\:). .sp If you want to revert just one file to an older revision, use \%\fBhg revert [\-r REV] NAME\fP\:. .sp See \%\fBhg help dates\fP\: for a list of formats valid for \-d/\-\-date. .sp Returns 0 on success, 1 if there are unresolved files. .sp Options: .INDENT 0.0 .TP .B \-C, \-\-clean . discard uncommitted changes (no backup) .TP .B \-c, \-\-check . update across branches if no uncommitted changes .TP .B \-d, \-\-date . tipmost revision matching date .TP .B \-r, \-\-rev . revision .sp aliases: up checkout co .UNINDENT .SS verify .sp .nf .ft C hg verify .ft P .fi .sp Verify the integrity of the current repository. .sp This will perform an extensive check of the repository\(aqs 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. .sp Returns 0 on success, 1 if errors are encountered. .SS version .sp .nf .ft C hg version .ft P .fi .sp output version and copyright information .SH DATE FORMATS .sp Some commands allow the user to specify a date, e.g.: .INDENT 0.0 .IP \(bu 2 . backout, commit, import, tag: Specify the commit date. .IP \(bu 2 . log, revert, update: Select revision(s) by date. .UNINDENT .sp Many date formats are valid. Here are some examples: .INDENT 0.0 .IP \(bu 2 . \fBWed Dec 6 13:18:29 2006\fP (local timezone assumed) .IP \(bu 2 . \fBDec 6 13:18 \-0600\fP (year assumed, time offset provided) .IP \(bu 2 . \fBDec 6 13:18 UTC\fP (UTC and GMT are aliases for +0000) .IP \(bu 2 . \fBDec 6\fP (midnight) .IP \(bu 2 . \fB13:18\fP (today assumed) .IP \(bu 2 . \fB3:39\fP (3:39AM assumed) .IP \(bu 2 . \fB3:39pm\fP (15:39) .IP \(bu 2 . \fB2006\-12\-06 13:18:29\fP (ISO 8601 format) .IP \(bu 2 . \fB2006\-12\-6 13:18\fP .IP \(bu 2 . \fB2006\-12\-6\fP .IP \(bu 2 . \fB12\-6\fP .IP \(bu 2 . \fB12/6\fP .IP \(bu 2 . \fB12/6/6\fP (Dec 6 2006) .UNINDENT .sp Lastly, there is Mercurial\(aqs internal format: .INDENT 0.0 .IP \(bu 2 . \fB1165432709 0\fP (Wed Dec 6 13:18:29 2006 UTC) .UNINDENT .sp This is the internal representation format for dates. The first number is the number of seconds since the epoch (1970\-01\-01 00:00 UTC). The second is the offset of the local timezone, in seconds west of UTC (negative if the timezone is east of UTC). .sp The log command also accepts date ranges: .INDENT 0.0 .IP \(bu 2 . \fBDATE\fP \- on or after a given date/time .IP \(bu 2 . \fBDATE to DATE\fP \- a date range, inclusive .IP \(bu 2 . \fB\-DAYS\fP \- within a given number of days of today .UNINDENT .SH DIFF FORMATS .sp Mercurial\(aqs default format for showing changes between two versions of a file is compatible with the unified format of GNU diff, which can be used by GNU patch and many other standard tools. .sp While this standard format is often enough, it does not encode the following information: .INDENT 0.0 .IP \(bu 2 . executable status and other permission bits .IP \(bu 2 . copy or rename information .IP \(bu 2 . changes in binary files .IP \(bu 2 . creation or deletion of empty files .UNINDENT .sp Mercurial also supports the extended diff format from the git VCS which addresses these limitations. The git diff format is not produced by default because a few widespread tools still do not understand this format. .sp This means that when generating diffs from a Mercurial repository (e.g. with \%\fBhg export\fP\:), you should be careful about things like file copies and renames or other things mentioned above, because when applying a standard diff to a different repository, this extra information is lost. Mercurial\(aqs internal operations (like push and pull) are not affected by this, because they use an internal binary format for communicating changes. .sp To make Mercurial produce the git extended diff format, use the \-\-git option available for many commands, or set \(aqgit = True\(aq in the [diff] section of your configuration file. You do not need to set this option when importing diffs in this format or using them in the mq extension. .SH ENVIRONMENT VARIABLES .INDENT 0.0 .TP .B HG . Path to the \(aqhg\(aq executable, automatically passed when running hooks, extensions or external tools. If unset or empty, this is the hg executable\(aqs name if it\(aqs frozen, or an executable named \(aqhg\(aq (with %PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on Windows) is searched. .TP .B HGEDITOR . This is the name of the editor to run when committing. See EDITOR. .sp (deprecated, use configuration file) .TP .B 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. .TP .B HGENCODINGMODE . This sets Mercurial\(aqs behavior for handling unknown characters while transcoding user input. The default is "strict", which causes Mercurial to abort if it can\(aqt map 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. .TP .B HGENCODINGAMBIGUOUS . This sets Mercurial\(aqs behavior for handling characters with "ambiguous" widths like accented Latin characters with East Asian fonts. By default, Mercurial assumes ambiguous characters are narrow, set this variable to "wide" if such characters cause formatting problems. .TP .B HGMERGE . An executable to use for resolving merge conflicts. The program will be executed with three arguments: local file, remote file, ancestor file. .sp (deprecated, use configuration file) .TP .B HGRCPATH . A list of files or directories to search for configuration files. Item separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set, platform default search path is used. If empty, only the .hg/hgrc from the current repository is read. .sp For each element in HGRCPATH: .INDENT 7.0 .IP \(bu 2 . if it\(aqs a directory, all files ending with .rc are added .IP \(bu 2 . otherwise, the file itself will be added .UNINDENT .TP .B HGPLAIN . When set, this disables any configuration settings that might change Mercurial\(aqs default output. This includes encoding, defaults, verbose mode, debug mode, quiet mode, tracebacks, and localization. This can be useful when scripting against Mercurial in the face of existing user configuration. .sp Equivalent options set via command line flags or environment variables are not overridden. .TP .B HGPLAINEXCEPT . This is a comma\-separated list of features to preserve when HGPLAIN is enabled. Currently the only value supported is "i18n", which preserves internationalization in plain mode. .sp Setting HGPLAINEXCEPT to anything (even an empty string) will enable plain mode. .TP .B HGUSER . This is the string used as the author of a commit. If not set, available values will be considered in this order: .INDENT 7.0 .IP \(bu 2 . HGUSER (deprecated) .IP \(bu 2 . configuration files from the HGRCPATH .IP \(bu 2 . EMAIL .IP \(bu 2 . interactive prompt .IP \(bu 2 . LOGNAME (with \fB@hostname\fP appended) .UNINDENT .sp (deprecated, use configuration file) .TP .B EMAIL . May be used as the author of a commit; see HGUSER. .TP .B LOGNAME . May be used as the author of a commit; see HGUSER. .TP .B VISUAL . This is the name of the editor to use when committing. See EDITOR. .TP .B 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 \(aqvi\(aq. .TP .B PYTHONPATH . This is used by Python to find imported modules and may need to be set appropriately if this Mercurial is not installed system\-wide. .UNINDENT .SH USING ADDITIONAL FEATURES .sp Mercurial has the ability to add new features through the use of extensions. Extensions may add new commands, add options to existing commands, change the default behavior of commands, or implement hooks. .sp Extensions are not loaded by default for a variety of reasons: they can increase startup overhead; they may be meant for advanced usage only; they may provide potentially dangerous abilities (such as letting you destroy or modify history); they might not be ready for prime time; or they may alter some usual behaviors of stock Mercurial. It is thus up to the user to activate extensions as needed. .sp To enable the "foo" extension, either shipped with Mercurial or in the Python search path, create an entry for it in your configuration file, like this: .sp .nf .ft C [extensions] foo = .ft P .fi .sp You may also specify the full path to an extension: .sp .nf .ft C [extensions] myfeature = ~/.hgext/myfeature.py .ft P .fi .sp To explicitly disable an extension enabled in a configuration file of broader scope, prepend its path with !: .sp .nf .ft C [extensions] # disabling extension bar residing in /path/to/extension/bar.py bar = !/path/to/extension/bar.py # ditto, but no path was supplied for extension baz baz = ! .ft P .fi .sp disabled extensions: .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .TP .B acl . hooks for controlling repository access .TP .B bugzilla . hooks for integrating with the Bugzilla bug tracker .TP .B children . command to display child changesets .TP .B churn . command to display statistics about repository history .TP .B color . colorize output from some commands .TP .B convert . import revisions from foreign VCS repositories into Mercurial .TP .B eol . automatically manage newlines in repository files .TP .B extdiff . command to allow external programs to compare revisions .TP .B fetch . pull, update and merge in one command .TP .B gpg . commands to sign and verify changesets .TP .B graphlog . command to view revision graphs from a shell .TP .B hgcia . hooks for integrating with the CIA.vc notification service .TP .B hgk . browse the repository in a graphical way .TP .B highlight . syntax highlighting for hgweb (requires Pygments) .TP .B inotify . accelerate status report using Linux\(aqs inotify service .TP .B interhg . expand expressions into changelog and summaries .TP .B keyword . expand keywords in tracked files .TP .B mq . manage a stack of patches .TP .B notify . hooks for sending email notifications at commit/push time .TP .B pager . browse command output with an external pager .TP .B patchbomb . command to send changesets as (a series of) patch emails .TP .B progress . show progress bars for some actions .TP .B purge . command to delete untracked files from the working directory .TP .B rebase . command to move sets of revisions to a different ancestor .TP .B record . commands to interactively select changes for commit/qrefresh .TP .B relink . recreates hardlinks between repository clones .TP .B schemes . extend schemes with shortcuts to repository swarms .TP .B share . share a common history between several working directories .TP .B transplant . command to transplant changesets from another branch .TP .B win32mbcs . allow the use of MBCS paths with problematic encodings .TP .B win32text . perform automatic newline conversion .TP .B zeroconf . discover and advertise repositories on the local network .UNINDENT .UNINDENT .UNINDENT .SH SPECIFYING FILE SETS .sp Mercurial supports a functional language for selecting a set of files. .sp Like other file patterns, this pattern type is indicated by a prefix, \(aqset:\(aq. The language supports a number of predicates which are joined by infix operators. Parenthesis can be used for grouping. .sp Identifiers such as filenames or patterns must be quoted with single or double quotes if they contain characters outside of \fB[.*{}[]?/\e_a\-zA\-Z0\-9\ex80\-\exff]\fP or if they match one of the predefined predicates. This generally applies to file patterns other than globs and arguments for predicates. .sp Special characters can be used in quoted identifiers by escaping them, e.g., \fB\en\fP is interpreted as a newline. To prevent them from being interpreted, strings can be prefixed with \fBr\fP, e.g. \fBr\(aq...\(aq\fP. .sp There is a single prefix operator: .INDENT 0.0 .TP .B \fBnot x\fP .sp Files not in x. Short form is \fB! x\fP. .UNINDENT .sp These are the supported infix operators: .INDENT 0.0 .TP .B \fBx and y\fP .sp The intersection of files in x and y. Short form is \fBx & y\fP. .TP .B \fBx or y\fP .sp The union of files in x and y. There are two alternative short forms: \fBx | y\fP and \fBx + y\fP. .TP .B \fBx \- y\fP .sp Files in x but not in y. .UNINDENT .sp The following predicates are supported: .INDENT 0.0 .TP .B \fBadded()\fP .sp File that is added according to status. .TP .B \fBbinary()\fP .sp File that appears to be binary (contains NUL bytes). .TP .B \fBclean()\fP .sp File that is clean according to status. .TP .B \fBcopied()\fP .sp File that is recorded as being copied. .TP .B \fBdeleted()\fP .sp File that is deleted according to status. .TP .B \fBencoding(name)\fP .sp File can be successfully decoded with the given character encoding. May not be useful for encodings other than ASCII and UTF\-8. .TP .B \fBexec()\fP .sp File that is marked as executable. .TP .B \fBgrep(regex)\fP .sp File contains the given regular expression. .TP .B \fBhgignore()\fP .sp File that matches the active .hgignore pattern. .TP .B \fBignored()\fP .sp File that is ignored according to status. These files will only be considered if this predicate is used. .TP .B \fBmodified()\fP .sp File that is modified according to status. .TP .B \fBremoved()\fP .sp File that is removed according to status. .TP .B \fBresolved()\fP .sp File that is marked resolved according to the resolve state. .TP .B \fBsize(expression)\fP .sp File size matches the given expression. Examples: .INDENT 7.0 .IP \(bu 2 . 1k (files from 1024 to 2047 bytes) .IP \(bu 2 . < 20k (files less than 20480 bytes) .IP \(bu 2 . >= .5MB (files at least 524288 bytes) .IP \(bu 2 . 4k \- 1MB (files from 4096 bytes to 1048576 bytes) .UNINDENT .TP .B \fBsymlink()\fP .sp File that is marked as a symlink. .TP .B \fBunknown()\fP .sp File that is unknown according to status. These files will only be considered if this predicate is used. .TP .B \fBunresolved()\fP .sp File that is marked unresolved according to the resolve state. .UNINDENT .sp Some sample queries: .INDENT 0.0 .IP \(bu 2 . Show status of files that appear to be binary in the working directory: .sp .nf .ft C hg status \-A "set:binary()" .ft P .fi .IP \(bu 2 . Forget files that are in .hgignore but are already tracked: .sp .nf .ft C hg forget "set:hgignore() and not ignored()" .ft P .fi .IP \(bu 2 . Find text files that contain a string: .sp .nf .ft C hg locate "set:grep(magic) and not binary()" .ft P .fi .IP \(bu 2 . Find C files in a non\-standard encoding: .sp .nf .ft C hg locate "set:**.c and not encoding(ascii)" .ft P .fi .IP \(bu 2 . Revert copies of large binary files: .sp .nf .ft C hg revert "set:copied() and binary() and size(\(aq>1M\(aq)" .ft P .fi .IP \(bu 2 . Remove files listed in foo.lst that contain the letter a or b: .sp .nf .ft C hg remove "set: \(aqlistfile:foo.lst\(aq and (**a* or **b*)" .ft P .fi .UNINDENT .sp See also \%\fBhg help patterns\fP\:. .SH GLOSSARY .INDENT 0.0 .TP .B Ancestor . Any changeset that can be reached by an unbroken chain of parent changesets from a given changeset. More precisely, the ancestors of a changeset can be defined by two properties: a parent of a changeset is an ancestor, and a parent of an ancestor is an ancestor. See also: \(aqDescendant\(aq. .TP .B Bookmark . Bookmarks are pointers to certain commits that move when committing. They are similar to tags in that it is possible to use bookmark names in all places where Mercurial expects a changeset ID, e.g., with \%\fBhg update\fP\:. Unlike tags, bookmarks move along when you make a commit. .sp Bookmarks can be renamed, copied and deleted. Bookmarks are local, unless they are explicitly pushed or pulled between repositories. Pushing and pulling bookmarks allow you to collaborate with others on a branch without creating a named branch. .TP .B Branch . (Noun) A child changeset that has been created from a parent that is not a head. These are known as topological branches, see \(aqBranch, topological\(aq. If a topological branch is named, it becomes a named branch. If a topological branch is not named, it becomes an anonymous branch. See \(aqBranch, anonymous\(aq and \(aqBranch, named\(aq. .sp Branches may be created when changes are pulled from or pushed to a remote repository, since new heads may be created by these operations. Note that the term branch can also be used informally to describe a development process in which certain development is done independently of other development. This is sometimes done explicitly with a named branch, but it can also be done locally, using bookmarks or clones and anonymous branches. .sp Example: "The experimental branch". .sp (Verb) The action of creating a child changeset which results in its parent having more than one child. .sp Example: "I\(aqm going to branch at X". .TP .B Branch, anonymous . Every time a new child changeset is created from a parent that is not a head and the name of the branch is not changed, a new anonymous branch is created. .TP .B Branch, closed . A named branch whose branch heads have all been closed. .TP .B Branch, default . The branch assigned to a changeset when no name has previously been assigned. .TP .B Branch head . See \(aqHead, branch\(aq. .TP .B Branch, inactive . If a named branch has no topological heads, it is considered to be inactive. As an example, a feature branch becomes inactive when it is merged into the default branch. The \%\fBhg branches\fP\: command shows inactive branches by default, though they can be hidden with \%\fBhg branches \-\-active\fP\:. .sp NOTE: this concept is deprecated because it is too implicit. Branches should now be explicitly closed using \%\fBhg commit \-\-close\-branch\fP\: when they are no longer needed. .TP .B Branch, named . A collection of changesets which have the same branch name. By default, children of a changeset in a named branch belong to the same named branch. A child can be explicitly assigned to a different branch. See \%\fBhg help branch\fP\:, \%\fBhg help branches\fP\: and \%\fBhg commit \-\-close\-branch\fP\: for more information on managing branches. .sp Named branches can be thought of as a kind of namespace, dividing the collection of changesets that comprise the repository into a collection of disjoint subsets. A named branch is not necessarily a topological branch. If a new named branch is created from the head of another named branch, or the default branch, but no further changesets are added to that previous branch, then that previous branch will be a branch in name only. .TP .B Branch tip . See \(aqTip, branch\(aq. .TP .B Branch, topological . Every time a new child changeset is created from a parent that is not a head, a new topological branch is created. If a topological branch is named, it becomes a named branch. If a topological branch is not named, it becomes an anonymous branch of the current, possibly default, branch. .TP .B Changelog . A record of the changesets in the order in which they were added to the repository. This includes details such as changeset id, author, commit message, date, and list of changed files. .TP .B Changeset . A snapshot of the state of the repository used to record a change. .TP .B Changeset, child . The converse of parent changeset: if P is a parent of C, then C is a child of P. There is no limit to the number of children that a changeset may have. .TP .B Changeset id . A SHA\-1 hash that uniquely identifies a changeset. It may be represented as either a "long" 40 hexadecimal digit string, or a "short" 12 hexadecimal digit string. .TP .B Changeset, merge . A changeset with two parents. This occurs when a merge is committed. .TP .B Changeset, parent . A revision upon which a child changeset is based. Specifically, a parent changeset of a changeset C is a changeset whose node immediately precedes C in the DAG. Changesets have at most two parents. .TP .B Checkout . (Noun) The working directory being updated to a specific revision. This use should probably be avoided where possible, as changeset is much more appropriate than checkout in this context. .sp Example: "I\(aqm using checkout X." .sp (Verb) Updating the working directory to a specific changeset. See \%\fBhg help update\fP\:. .sp Example: "I\(aqm going to check out changeset X." .TP .B Child changeset . See \(aqChangeset, child\(aq. .TP .B Close changeset . See \(aqChangeset, close\(aq. .TP .B Closed branch . See \(aqBranch, closed\(aq. .TP .B Clone . (Noun) An entire or partial copy of a repository. The partial clone must be in the form of a revision and its ancestors. .sp Example: "Is your clone up to date?". .sp (Verb) The process of creating a clone, using \%\fBhg clone\fP\:. .sp Example: "I\(aqm going to clone the repository". .TP .B Closed branch head . See \(aqHead, closed branch\(aq. .TP .B Commit . (Noun) A synonym for changeset. .sp Example: "Is the bug fixed in your recent commit?" .sp (Verb) The act of recording changes to a repository. When files are committed in a working directory, Mercurial finds the differences between the committed files and their parent changeset, creating a new changeset in the repository. .sp Example: "You should commit those changes now." .TP .B Cset . A common abbreviation of the term changeset. .TP .B DAG . The repository of changesets of a distributed version control system (DVCS) can be described as a directed acyclic graph (DAG), consisting of nodes and edges, where nodes correspond to changesets and edges imply a parent \-> child relation. This graph can be visualized by graphical tools such as \%\fBhg glog\fP\: (graphlog). In Mercurial, the DAG is limited by the requirement for children to have at most two parents. .TP .B Default branch . See \(aqBranch, default\(aq. .TP .B Descendant . Any changeset that can be reached by a chain of child changesets from a given changeset. More precisely, the descendants of a changeset can be defined by two properties: the child of a changeset is a descendant, and the child of a descendant is a descendant. See also: \(aqAncestor\(aq. .TP .B Diff . (Noun) The difference between the contents and attributes of files in two changesets or a changeset and the current working directory. The difference is usually represented in a standard form called a "diff" or "patch". The "git diff" format is used when the changes include copies, renames, or changes to file attributes, none of which can be represented/handled by classic "diff" and "patch". .sp Example: "Did you see my correction in the diff?" .sp (Verb) Diffing two changesets is the action of creating a diff or patch. .sp Example: "If you diff with changeset X, you will see what I mean." .TP .B Directory, working . The working directory represents the state of the files tracked by Mercurial, that will be recorded in the next commit. The working directory initially corresponds to the snapshot at an existing changeset, known as the parent of the working directory. See \(aqParent, working directory\(aq. The state may be modified by changes to the files introduced manually or by a merge. The repository metadata exists in the .hg directory inside the working directory. .TP .B Graph . See DAG and \%\fBhg help graphlog\fP\:. .TP .B Head . The term \(aqhead\(aq may be used to refer to both a branch head or a repository head, depending on the context. See \(aqHead, branch\(aq and \(aqHead, repository\(aq for specific definitions. .sp Heads are where development generally takes place and are the usual targets for update and merge operations. .TP .B Head, branch . A changeset with no descendants on the same named branch. .TP .B Head, closed branch . A changeset that marks a head as no longer interesting. The closed head is no longer listed by \%\fBhg heads\fP\:. A branch is considered closed when all its heads are closed and consequently is not listed by \%\fBhg branches\fP\:. .TP .B Head, repository . A topological head which has not been closed. .TP .B Head, topological . A changeset with no children in the repository. .TP .B History, immutable . Once committed, changesets cannot be altered. Extensions which appear to change history actually create new changesets that replace existing ones, and then destroy the old changesets. Doing so in public repositories can result in old changesets being reintroduced to the repository. .TP .B History, rewriting . The changesets in a repository are immutable. However, extensions to Mercurial can be used to alter the repository, usually in such a way as to preserve changeset contents. .TP .B Immutable history . See \(aqHistory, immutable\(aq. .TP .B Merge changeset . See \(aqChangeset, merge\(aq. .TP .B Manifest . Each changeset has a manifest, which is the list of files that are tracked by the changeset. .TP .B Merge . Used to bring together divergent branches of work. When you update to a changeset and then merge another changeset, you bring the history of the latter changeset into your working directory. Once conflicts are resolved (and marked), this merge may be committed as a merge changeset, bringing two branches together in the DAG. .TP .B Named branch . See \(aqBranch, named\(aq. .TP .B Null changeset . The empty changeset. It is the parent state of newly\-initialized repositories and repositories with no checked out revision. It is thus the parent of root changesets and the effective ancestor when merging unrelated changesets. Can be specified by the alias \(aqnull\(aq or by the changeset ID \(aq000000000000\(aq. .TP .B Parent . See \(aqChangeset, parent\(aq. .TP .B Parent changeset . See \(aqChangeset, parent\(aq. .TP .B Parent, working directory . The working directory parent reflects a virtual revision which is the child of the changeset (or two changesets with an uncommitted merge) shown by \%\fBhg parents\fP\:. This is changed with \%\fBhg update\fP\:. Other commands to see the working directory parent are \%\fBhg summary\fP\: and \%\fBhg id\fP\:. Can be specified by the alias ".". .TP .B Patch . (Noun) The product of a diff operation. .sp Example: "I\(aqve sent you my patch." .sp (Verb) The process of using a patch file to transform one changeset into another. .sp Example: "You will need to patch that revision." .TP .B Pull . An operation in which changesets in a remote repository which are not in the local repository are brought into the local repository. Note that this operation without special arguments only updates the repository, it does not update the files in the working directory. See \%\fBhg help pull\fP\:. .TP .B Push . An operation in which changesets in a local repository which are not in a remote repository are sent to the remote repository. Note that this operation only adds changesets which have been committed locally to the remote repository. Uncommitted changes are not sent. See \%\fBhg help push\fP\:. .TP .B Repository . The metadata describing all recorded states of a collection of files. Each recorded state is represented by a changeset. A repository is usually (but not always) found in the \fB.hg\fP subdirectory of a working directory. Any recorded state can be recreated by "updating" a working directory to a specific changeset. .TP .B Repository head . See \(aqHead, repository\(aq. .TP .B Revision . A state of the repository at some point in time. Earlier revisions can be updated to by using \%\fBhg update\fP\:. See also \(aqRevision number\(aq; See also \(aqChangeset\(aq. .TP .B Revision number . This integer uniquely identifies a changeset in a specific repository. It represents the order in which changesets were added to a repository, starting with revision number 0. Note that the revision number may be different in each clone of a repository. To identify changesets uniquely between different clones, see \(aqChangeset id\(aq. .TP .B Revlog . History storage mechanism used by Mercurial. It is a form of delta encoding, with occasional full revision of data followed by delta of each successive revision. It includes data and an index pointing to the data. .TP .B Rewriting history . See \(aqHistory, rewriting\(aq. .TP .B Root . A changeset that has only the null changeset as its parent. Most repositories have only a single root changeset. .TP .B Tag . An alternative name given to a changeset. Tags can be used in all places where Mercurial expects a changeset ID, e.g., with \%\fBhg update\fP\:. The creation of a tag is stored in the history and will thus automatically be shared with other using push and pull. .TP .B Tip . The changeset with the highest revision number. It is the changeset most recently added in a repository. .TP .B Tip, branch . The head of a given branch with the highest revision number. When a branch name is used as a revision identifier, it refers to the branch tip. See also \(aqBranch, head\(aq. Note that because revision numbers may be different in different repository clones, the branch tip may be different in different cloned repositories. .TP .B Update . (Noun) Another synonym of changeset. .sp Example: "I\(aqve pushed an update". .sp (Verb) This term is usually used to describe updating the state of the working directory to that of a specific changeset. See \%\fBhg help update\fP\:. .sp Example: "You should update". .TP .B Working directory . See \(aqDirectory, working\(aq. .TP .B Working directory parent . See \(aqParent, working directory\(aq. .UNINDENT .SH SYNTAX FOR MERCURIAL IGNORE FILES .SH SYNOPSIS .sp The Mercurial system uses a file called \fB.hgignore\fP in the root directory of a repository to control its behavior when it searches for files that it is not currently tracking. .SH DESCRIPTION .sp The working directory of a Mercurial repository will often contain files that should not be tracked by Mercurial. These include backup files created by editors and build products created by compilers. These files can be ignored by listing them in a \fB.hgignore\fP file in the root of the working directory. The \fB.hgignore\fP file must be created manually. It is typically put under version control, so that the settings will propagate to other repositories with push and pull. .sp An untracked file is ignored if its path relative to the repository root directory, or any prefix path of that path, is matched against any pattern in \fB.hgignore\fP. .sp For example, say we have an untracked file, \fBfile.c\fP, at \fBa/b/file.c\fP inside our repository. Mercurial will ignore \fBfile.c\fP if any pattern in \fB.hgignore\fP matches \fBa/b/file.c\fP, \fBa/b\fP or \fBa\fP. .sp In addition, a Mercurial configuration file can reference a set of per\-user or global ignore files. See the \fBignore\fP configuration key on the \fB[ui]\fP section of \%\fBhg help config\fP\: for details of how to configure these files. .sp To control Mercurial\(aqs handling of files that it manages, many commands support the \fB\-I\fP and \fB\-X\fP options; see \%\fBhg help \fP\: and \%\fBhg help patterns\fP\: for details. .SH SYNTAX .sp An ignore file is a plain text file consisting of a list of patterns, with one pattern per line. Empty lines are skipped. The \fB#\fP character is treated as a comment character, and the \fB\e\fP character is treated as an escape character. .sp Mercurial supports several pattern syntaxes. The default syntax used is Python/Perl\-style regular expressions. .sp To change the syntax used, use a line of the following form: .sp .nf .ft C syntax: NAME .ft P .fi .sp where \fBNAME\fP is one of the following: .INDENT 0.0 .TP .B \fBregexp\fP .sp Regular expression, Python/Perl syntax. .TP .B \fBglob\fP .sp Shell\-style glob. .UNINDENT .sp The chosen syntax stays in effect when parsing all patterns that follow, until another syntax is selected. .sp Neither glob nor regexp patterns are rooted. A glob\-syntax pattern of the form \fB*.c\fP will match a file ending in \fB.c\fP in any directory, and a regexp pattern of the form \fB\e.c$\fP will do the same. To root a regexp pattern, start it with \fB^\fP. .SH EXAMPLE .sp Here is an example ignore file. .sp .nf .ft C # use glob syntax. syntax: glob *.elc *.pyc *~ # switch to regexp syntax. syntax: regexp ^\e.pc/ .ft P .fi .SH CONFIGURING HGWEB .sp Mercurial\(aqs internal web server, hgweb, can serve either a single repository, or a collection of them. In the latter case, a special configuration file can be used to specify the repository paths to use and global web configuration options. .sp This file uses the same syntax as other Mercurial configuration files, but only the following sections are recognized: .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .IP \(bu 2 . web .IP \(bu 2 . paths .IP \(bu 2 . collections .UNINDENT .UNINDENT .UNINDENT .sp The \fBweb\fP section can specify all the settings described in the web section of the hgrc(5) documentation. See \%\fBhg help config\fP\: for information on where to find the manual page. .sp The \fBpaths\fP section provides mappings of physical repository paths to virtual ones. For instance: .sp .nf .ft C [paths] projects/a = /foo/bar projects/b = /baz/quux web/root = /real/root/* / = /real/root2/* virtual/root2 = /real/root2/** .ft P .fi .INDENT 0.0 .IP \(bu 2 . The first two entries make two repositories in different directories appear under the same directory in the web interface .IP \(bu 2 . The third entry maps every Mercurial repository found in \(aq/real/root\(aq into \(aqweb/root\(aq. This format is preferred over the [collections] one, since using absolute paths as configuration keys is not supported on every platform (especially on Windows). .IP \(bu 2 . The fourth entry is a special case mapping all repositories in \(aq/real/root2\(aq in the root of the virtual directory. .IP \(bu 2 . The fifth entry recursively finds all repositories under the real root, and maps their relative paths under the virtual root. .UNINDENT .sp The \fBcollections\fP section provides mappings of trees of physical repositories paths to virtual ones, though the paths syntax is generally preferred. For instance: .sp .nf .ft C [collections] /foo = /foo .ft P .fi .sp Here, the left side will be stripped off all repositories found in the right side. Thus \fB/foo/bar\fP and \fBfoo/quux/baz\fP will be listed as \fBbar\fP and \fBquux/baz\fP respectively. .SH MERGE TOOLS .sp To merge files Mercurial uses merge tools. .sp A merge tool combines two different versions of a file into a merged file. Merge tools are given the two files and the greatest common ancestor of the two file versions, so they can determine the changes made on both branches. .sp Merge tools are used both for \%\fBhg resolve\fP\:, \%\fBhg merge\fP\:, \%\fBhg update\fP\:, \%\fBhg backout\fP\: and in several extensions. .sp Usually, the merge tool tries to automatically reconcile the files by combining all non\-overlapping changes that occurred separately in the two different evolutions of the same initial base file. Furthermore, some interactive merge programs make it easier to manually resolve conflicting merges, either in a graphical way, or by inserting some conflict markers. Mercurial does not include any interactive merge programs but relies on external tools for that. .SS Available merge tools .sp External merge tools and their properties are configured in the merge\-tools configuration section \- see hgrc(5) \- but they can often just be named by their executable. .sp A merge tool is generally usable if its executable can be found on the system and if it can handle the merge. The executable is found if it is an absolute or relative executable path or the name of an application in the executable search path. The tool is assumed to be able to handle the merge if it can handle symlinks if the file is a symlink, if it can handle binary files if the file is binary, and if a GUI is available if the tool requires a GUI. .sp There are some internal merge tools which can be used. The internal merge tools are: .INDENT 0.0 .TP .B \fBinternal:merge\fP .sp Uses the internal non\-interactive simple merge algorithm for merging files. It will fail if there are any conflicts and leave markers in the partially merged file. .TP .B \fBinternal:fail\fP .sp Rather than attempting to merge files that were modified on both branches, it marks them as unresolved. The resolve command must be used to resolve these conflicts. .TP .B \fBinternal:local\fP .sp Uses the local version of files as the merged version. .TP .B \fBinternal:other\fP .sp Uses the other version of files as the merged version. .TP .B \fBinternal:prompt\fP .sp Asks the user which of the local or the other version to keep as the merged version. .TP .B \fBinternal:dump\fP .sp Creates three versions of the files to merge, containing the contents of local, other and base. These files can then be used to perform a merge manually. If the file to be merged is named \fBa.txt\fP, these files will accordingly be named \fBa.txt.local\fP, \fBa.txt.other\fP and \fBa.txt.base\fP and they will be placed in the same directory as \fBa.txt\fP. .UNINDENT .sp Internal tools are always available and do not require a GUI but will by default not handle symlinks or binary files. .SS Choosing a merge tool .sp Mercurial uses these rules when deciding which merge tool to use: .INDENT 0.0 .IP 1. 3 . If a tool has been specified with the \-\-tool option to merge or resolve, it is used. If it is the name of a tool in the merge\-tools configuration, its configuration is used. Otherwise the specified tool must be executable by the shell. .IP 2. 3 . If the \fBHGMERGE\fP environment variable is present, its value is used and must be executable by the shell. .IP 3. 3 . If the filename of the file to be merged matches any of the patterns in the merge\-patterns configuration section, the first usable merge tool corresponding to a matching pattern is used. Here, binary capabilities of the merge tool are not considered. .IP 4. 3 . If ui.merge is set it will be considered next. If the value is not the name of a configured tool, the specified value is used and must be executable by the shell. Otherwise the named tool is used if it is usable. .IP 5. 3 . If any usable merge tools are present in the merge\-tools configuration section, the one with the highest priority is used. .IP 6. 3 . If a program named \fBhgmerge\fP can be found on the system, it is used \- but it will by default not be used for symlinks and binary files. .IP 7. 3 . If the file to be merged is not binary and is not a symlink, then \fBinternal:merge\fP is used. .IP 8. 3 . The merge of the file fails and must be resolved before commit. .UNINDENT .IP Note . After selecting a merge program, Mercurial will by default attempt to merge the files using a simple merge algorithm first. Only if it doesn\(aqt succeed because of conflicting changes Mercurial will actually execute the merge program. Whether to use the simple merge algorithm first can be controlled by the premerge setting of the merge tool. Premerge is enabled by default unless the file is binary or a symlink. .RE .sp See the merge\-tools and ui sections of hgrc(5) for details on the configuration of merge tools. .SH SPECIFYING MULTIPLE REVISIONS .sp When Mercurial accepts more than one revision, they may be specified individually, or provided as a topologically continuous range, separated by the ":" character. .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". .sp If BEGIN is greater than END, revisions are treated in reverse order. .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 9:6 gives 9, 8, 7, and 6. .SH FILE NAME PATTERNS .sp Mercurial accepts several notations for identifying one or more files at a time. .sp By default, Mercurial treats filenames as shell\-style extended glob patterns. .sp Alternate pattern notations must be specified explicitly. .sp To use a plain path name without any pattern matching, start it with \fBpath:\fP. These path names must completely match starting at the current repository root. .sp To use an extended glob, start a name with \fBglob:\fP. Globs are rooted at the current directory; a glob such as \fB*.c\fP will only match files in the current directory ending with \fB.c\fP. .sp The supported glob syntax extensions are \fB**\fP to match any string across path separators and \fB{a,b}\fP to mean "a or b". .sp To use a Perl/Python regular expression, start a name with \fBre:\fP. Regexp pattern matching is anchored at the root of the repository. .sp To read name patterns from a file, use \fBlistfile:\fP or \fBlistfile0:\fP. The latter expects null delimited patterns while the former expects line feeds. Each string read from the file is itself treated as a file pattern. .sp Plain examples: .sp .nf .ft C 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" .ft P .fi .sp Glob examples: .sp .nf .ft C 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 any subdirectory of the current directory including itself. foo/*.c any name ending in ".c" in the directory foo foo/**.c any name ending in ".c" in any subdirectory of foo including itself. .ft P .fi .sp Regexp examples: .sp .nf .ft C re:.*\e.c$ any name ending in ".c", anywhere in the repository .ft P .fi .sp File examples: .sp .nf .ft C listfile:list.txt read list from list.txt with one file pattern per line listfile0:list.txt read list from list.txt with null byte delimiters .ft P .fi .sp See also \%\fBhg help filesets\fP\:. .SH SPECIFYING SINGLE REVISIONS .sp Mercurial supports several ways to specify individual revisions. .sp A plain integer is treated as a revision number. Negative integers are treated as sequential offsets from the tip, with \-1 denoting the tip, \-2 denoting the revision prior to the tip, and so forth. .sp A 40\-digit hexadecimal string is treated as a unique revision identifier. .sp A hexadecimal string less than 40 characters long is treated as a unique revision identifier and is referred to as a short\-form identifier. A short\-form identifier is only valid if it is the prefix of exactly one full\-length identifier. .sp Any other string is treated as a tag or branch name. A tag name is a symbolic name associated with a revision identifier. A branch name denotes the tipmost revision of that branch. Tag and branch names must not contain the ":" character. .sp The reserved name "tip" is a special tag that always identifies the most recent revision. .sp The reserved name "null" indicates the null revision. This is the revision of an empty repository, and the parent of revision 0. .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. .SH SPECIFYING REVISION SETS .sp Mercurial supports a functional language for selecting a set of revisions. .sp The language supports a number of predicates which are joined by infix operators. Parenthesis can be used for grouping. .sp Identifiers such as branch names must be quoted with single or double quotes if they contain characters outside of \fB[._a\-zA\-Z0\-9\ex80\-\exff]\fP or if they match one of the predefined predicates. .sp Special characters can be used in quoted identifiers by escaping them, e.g., \fB\en\fP is interpreted as a newline. To prevent them from being interpreted, strings can be prefixed with \fBr\fP, e.g. \fBr\(aq...\(aq\fP. .sp There is a single prefix operator: .INDENT 0.0 .TP .B \fBnot x\fP .sp Changesets not in x. Short form is \fB! x\fP. .UNINDENT .sp These are the supported infix operators: .INDENT 0.0 .TP .B \fBx::y\fP .sp A DAG range, meaning all changesets that are descendants of x and ancestors of y, including x and y themselves. If the first endpoint is left out, this is equivalent to \fBancestors(y)\fP, if the second is left out it is equivalent to \fBdescendants(x)\fP. .sp An alternative syntax is \fBx..y\fP. .TP .B \fBx:y\fP .sp All changesets with revision numbers between x and y, both inclusive. Either endpoint can be left out, they default to 0 and tip. .TP .B \fBx and y\fP .sp The intersection of changesets in x and y. Short form is \fBx & y\fP. .TP .B \fBx or y\fP .sp The union of changesets in x and y. There are two alternative short forms: \fBx | y\fP and \fBx + y\fP. .TP .B \fBx \- y\fP .sp Changesets in x but not in y. .TP .B \fBx^n\fP .sp The nth parent of x, n == 0, 1, or 2. For n == 0, x; for n == 1, the first parent of each changeset in x; for n == 2, the second parent of changeset in x. .TP .B \fBx~n\fP .sp The nth first ancestor of x; \fBx~0\fP is x; \fBx~3\fP is \fBx^^^\fP. .UNINDENT .sp There is a single postfix operator: .INDENT 0.0 .TP .B \fBx^\fP .sp Equivalent to \fBx^1\fP, the first parent of each changeset in x. .UNINDENT .sp The following predicates are supported: .INDENT 0.0 .TP .B \fBadds(pattern)\fP .sp Changesets that add a file matching pattern. .TP .B \fBall()\fP .sp All changesets, the same as \fB0:tip\fP. .TP .B \fBancestor(single, single)\fP .sp Greatest common ancestor of the two changesets. .TP .B \fBancestors(set)\fP .sp Changesets that are ancestors of a changeset in set. .TP .B \fBauthor(string)\fP .sp Alias for \fBuser(string)\fP. .TP .B \fBbisected(string)\fP .sp Changesets marked in the specified bisect state (good, bad, skip). .TP .B \fBbookmark([name])\fP .sp The named bookmark or all bookmarks. .TP .B \fBbranch(string or set)\fP .sp All changesets belonging to the given branch or the branches of the given changesets. .TP .B \fBchildren(set)\fP .sp Child changesets of changesets in set. .TP .B \fBclosed()\fP .sp Changeset is closed. .TP .B \fBcontains(pattern)\fP .sp Revision contains a file matching pattern. See \%\fBhg help patterns\fP\: for information about file patterns. .TP .B \fBdate(interval)\fP .sp Changesets within the interval, see \%\fBhg help dates\fP\:. .TP .B \fBdesc(string)\fP .sp Search commit message for string. The match is case\-insensitive. .TP .B \fBdescendants(set)\fP .sp Changesets which are descendants of changesets in set. .TP .B \fBfile(pattern)\fP .sp Changesets affecting files matched by pattern. .TP .B \fBfilelog(pattern)\fP .sp Changesets connected to the specified filelog. .TP .B \fBfollow([file])\fP .sp An alias for \fB::.\fP (ancestors of the working copy\(aqs first parent). If a filename is specified, the history of the given file is followed, including copies. .TP .B \fBgrep(regex)\fP .sp Like \fBkeyword(string)\fP but accepts a regex. Use \fBgrep(r\(aq...\(aq)\fP to ensure special escape characters are handled correctly. Unlike \fBkeyword(string)\fP, the match is case\-sensitive. .TP .B \fBhead()\fP .sp Changeset is a named branch head. .TP .B \fBheads(set)\fP .sp Members of set with no children in set. .TP .B \fBid(string)\fP .sp Revision non\-ambiguously specified by the given hex string prefix. .TP .B \fBkeyword(string)\fP .sp Search commit message, user name, and names of changed files for string. The match is case\-insensitive. .TP .B \fBlast(set, n)\fP .sp Last n members of set. .TP .B \fBlimit(set, n)\fP .sp First n members of set. .TP .B \fBmax(set)\fP .sp Changeset with highest revision number in set. .TP .B \fBmerge()\fP .sp Changeset is a merge changeset. .TP .B \fBmin(set)\fP .sp Changeset with lowest revision number in set. .TP .B \fBmodifies(pattern)\fP .sp Changesets modifying files matched by pattern. .TP .B \fBoutgoing([path])\fP .sp Changesets not found in the specified destination repository, or the default push location. .TP .B \fBp1([set])\fP .sp First parent of changesets in set, or the working directory. .TP .B \fBp2([set])\fP .sp Second parent of changesets in set, or the working directory. .TP .B \fBparents([set])\fP .sp The set of all parents for all changesets in set, or the working directory. .TP .B \fBpresent(set)\fP .sp An empty set, if any revision in set isn\(aqt found; otherwise, all revisions in set. .TP .B \fBremoves(pattern)\fP .sp Changesets which remove files matching pattern. .TP .B \fBrev(number)\fP .sp Revision with the given numeric identifier. .TP .B \fBreverse(set)\fP .sp Reverse order of set. .TP .B \fBroots(set)\fP .sp Changesets with no parent changeset in set. .TP .B \fBsort(set[, [\-]key...])\fP .sp Sort set by keys. The default sort order is ascending, specify a key as \fB\-key\fP to sort in descending order. .sp The keys can be: .INDENT 7.0 .IP \(bu 2 . \fBrev\fP for the revision number, .IP \(bu 2 . \fBbranch\fP for the branch name, .IP \(bu 2 . \fBdesc\fP for the commit message (description), .IP \(bu 2 . \fBuser\fP for user name (\fBauthor\fP can be used as an alias), .IP \(bu 2 . \fBdate\fP for the commit date .UNINDENT .TP .B \fBtag([name])\fP .sp The specified tag by name, or all tagged revisions if no name is given. .TP .B \fBuser(string)\fP .sp User name contains string. The match is case\-insensitive. .UNINDENT .sp New predicates (known as "aliases") can be defined, using any combination of existing predicates or other aliases. An alias definition looks like: .sp .nf .ft C = .ft P .fi .sp in the \fBrevsetalias\fP section of a Mercurial configuration file. Arguments of the form \fI$1\fP, \fI$2\fP, etc. are substituted from the alias into the definition. .sp For example, .sp .nf .ft C [revsetalias] h = heads() d($1) = sort($1, date) rs($1, $2) = reverse(sort($1, $2)) .ft P .fi .sp defines three aliases, \fBh\fP, \fBd\fP, and \fBrs\fP. \fBrs(0:tip, author)\fP is exactly equivalent to \fBreverse(sort(0:tip, author))\fP. .sp Command line equivalents for \%\fBhg log\fP\:: .sp .nf .ft C \-f \-> ::. \-d x \-> date(x) \-k x \-> keyword(x) \-m \-> merge() \-u x \-> user(x) \-b x \-> branch(x) \-P x \-> !::x \-l x \-> limit(expr, x) .ft P .fi .sp Some sample queries: .INDENT 0.0 .IP \(bu 2 . Changesets on the default branch: .sp .nf .ft C hg log \-r "branch(default)" .ft P .fi .IP \(bu 2 . Changesets on the default branch since tag 1.5 (excluding merges): .sp .nf .ft C hg log \-r "branch(default) and 1.5:: and not merge()" .ft P .fi .IP \(bu 2 . Open branch heads: .sp .nf .ft C hg log \-r "head() and not closed()" .ft P .fi .IP \(bu 2 . Changesets between tags 1.3 and 1.5 mentioning "bug" that affect \fBhgext/*\fP: .sp .nf .ft C hg log \-r "1.3::1.5 and keyword(bug) and file(\(aqhgext/*\(aq)" .ft P .fi .IP \(bu 2 . Changesets committed in May 2008, sorted by user: .sp .nf .ft C hg log \-r "sort(date(\(aqMay 2008\(aq), user)" .ft P .fi .IP \(bu 2 . Changesets mentioning "bug" or "issue" that are not in a tagged release: .sp .nf .ft C hg log \-r "(keyword(bug) or keyword(issue)) and not ancestors(tagged())" .ft P .fi .UNINDENT .SH SUBREPOSITORIES .sp Subrepositories let you nest external repositories or projects into a parent Mercurial repository, and make commands operate on them as a group. External Mercurial and Subversion projects are currently supported. .sp Subrepositories are made of three components: .INDENT 0.0 .IP 1. 3 . Nested repository checkouts. They can appear anywhere in the parent working directory, and are Mercurial clones or Subversion checkouts. .IP 2. 3 . Nested repository references. They are defined in \fB.hgsub\fP and tell where the subrepository checkouts come from. Mercurial subrepositories are referenced like: .INDENT 3.0 .INDENT 3.5 .sp path/to/nested = \%https://example.com/nested/repo/path\: .UNINDENT .UNINDENT .sp where \fBpath/to/nested\fP is the checkout location relatively to the parent Mercurial root, and \fBhttps://example.com/nested/repo/path\fP is the source repository path. The source can also reference a filesystem path. Subversion repositories are defined with: .INDENT 3.0 .INDENT 3.5 .sp path/to/nested = [svn]https://example.com/nested/trunk/path .UNINDENT .UNINDENT .sp Note that \fB.hgsub\fP does not exist by default in Mercurial repositories, you have to create and add it to the parent repository before using subrepositories. .IP 3. 3 . Nested repository states. They are defined in \fB.hgsubstate\fP and capture whatever information is required to restore the subrepositories to the state they were committed in a parent repository changeset. Mercurial automatically record the nested repositories states when committing in the parent repository. .IP Note . The \fB.hgsubstate\fP file should not be edited manually. .RE .UNINDENT .SH ADDING A SUBREPOSITORY .sp If \fB.hgsub\fP does not exist, create it and add it to the parent repository. Clone or checkout the external projects where you want it to live in the parent repository. Edit \fB.hgsub\fP and add the subrepository entry as described above. At this point, the subrepository is tracked and the next commit will record its state in \fB.hgsubstate\fP and bind it to the committed changeset. .SH SYNCHRONIZING A SUBREPOSITORY .sp Subrepos do not automatically track the latest changeset of their sources. Instead, they are updated to the changeset that corresponds with the changeset checked out in the top\-level changeset. This is so developers always get a consistent set of compatible code and libraries when they update. .sp Thus, updating subrepos is a manual process. Simply check out target subrepo at the desired revision, test in the top\-level repo, then commit in the parent repository to record the new combination. .SH DELETING A SUBREPOSITORY .sp To remove a subrepository from the parent repository, delete its reference from \fB.hgsub\fP, then remove its files. .SH INTERACTION WITH MERCURIAL COMMANDS .INDENT 0.0 .TP .B add . add does not recurse in subrepos unless \-S/\-\-subrepos is specified. Subversion subrepositories are currently silently ignored. .TP .B archive . archive does not recurse in subrepositories unless \-S/\-\-subrepos is specified. .TP .B commit . commit creates a consistent snapshot of the state of the entire project and its subrepositories. It does this by first attempting to commit all modified subrepositories, then recording their state and finally committing it in the parent repository. Mercurial can be made to abort if any subrepository content is modified by setting "ui.commitsubrepos=no" in a configuration file (see \%\fBhg help config\fP\:). .TP .B diff . diff does not recurse in subrepos unless \-S/\-\-subrepos is specified. Changes are displayed as usual, on the subrepositories elements. Subversion subrepositories are currently silently ignored. .TP .B incoming . incoming does not recurse in subrepos unless \-S/\-\-subrepos is specified. Subversion subrepositories are currently silently ignored. .TP .B outgoing . outgoing does not recurse in subrepos unless \-S/\-\-subrepos is specified. Subversion subrepositories are currently silently ignored. .TP .B pull . pull is not recursive since it is not clear what to pull prior to running \%\fBhg update\fP\:. Listing and retrieving all subrepositories changes referenced by the parent repository pulled changesets is expensive at best, impossible in the Subversion case. .TP .B push . Mercurial will automatically push all subrepositories first when the parent repository is being pushed. This ensures new subrepository changes are available when referenced by top\-level repositories. .TP .B status . status does not recurse into subrepositories unless \-S/\-\-subrepos is specified. Subrepository changes are displayed as regular Mercurial changes on the subrepository elements. Subversion subrepositories are currently silently ignored. .TP .B update . update restores the subrepos in the state they were originally committed in target changeset. If the recorded changeset is not available in the current subrepository, Mercurial will pull it in first before updating. This means that updating can require network access when using subrepositories. .UNINDENT .SH REMAPPING SUBREPOSITORIES SOURCES .sp A subrepository source location may change during a project life, invalidating references stored in the parent repository history. To fix this, rewriting rules can be defined in parent repository \fBhgrc\fP file or in Mercurial configuration. See the \fB[subpaths]\fP section in hgrc(5) for more details. .SH TEMPLATE USAGE .sp Mercurial allows you to customize output of commands through templates. You can either pass in a template from the command line, via the \-\-template option, or select an existing template\-style (\-\-style). .sp You can customize output for any "log\-like" command: log, outgoing, incoming, tip, parents, heads and glog. .sp Four styles are packaged with Mercurial: default (the style used when no explicit preference is passed), compact, changelog, and xml. Usage: .sp .nf .ft C $ hg log \-r1 \-\-style changelog .ft P .fi .sp A template is a piece of text, with markup to invoke variable expansion: .sp .nf .ft C $ hg log \-r1 \-\-template "{node}\en" b56ce7b07c52de7d5fd79fb89701ea538af65746 .ft P .fi .sp Strings in curly braces are called keywords. The availability of keywords depends on the exact context of the templater. These keywords are usually available for templating a log\-like command: .INDENT 0.0 .TP .B author . String. The unmodified author of the changeset. .TP .B bookmarks . List of strings. Any bookmarks associated with the changeset. .TP .B branch . String. The name of the branch on which the changeset was committed. .TP .B branches . List of strings. The name of the branch on which the changeset was committed. Will be empty if the branch name was default. .TP .B children . List of strings. The children of the changeset. .TP .B date . Date information. The date when the changeset was committed. .TP .B desc . String. The text of the changeset description. .TP .B diffstat . String. Statistics of changes with the following format: "modified files: +added/\-removed lines" .TP .B file_adds . List of strings. Files added by this changeset. .TP .B file_copies . List of strings. Files copied in this changeset with their sources. .TP .B file_copies_switch . List of strings. Like "file_copies" but displayed only if the \-\-copied switch is set. .TP .B file_dels . List of strings. Files removed by this changeset. .TP .B file_mods . List of strings. Files modified by this changeset. .TP .B files . List of strings. All files modified, added, or removed by this changeset. .TP .B latesttag . String. Most recent global tag in the ancestors of this changeset. .TP .B latesttagdistance . Integer. Longest path to the latest tag. .TP .B node . String. The changeset identification hash, as a 40 hexadecimal digit string. .TP .B rev . Integer. The repository\-local changeset revision number. .TP .B tags . List of strings. Any tags associated with the changeset. .UNINDENT .sp The "date" keyword does not produce human\-readable output. If you want to use a date in your output, you can use a filter to process it. Filters are functions which return a string based on the input variable. Be sure to use the stringify filter first when you\(aqre applying a string\-input filter to a list\-like input variable. You can also use a chain of filters to get the desired output: .sp .nf .ft C $ hg tip \-\-template "{date|isodate}\en" 2008\-08\-21 18:22 +0000 .ft P .fi .sp List of filters: .INDENT 0.0 .TP .B addbreaks . Any text. Add an XHTML "
" tag before the end of every line except the last. .TP .B age . Date. Returns a human\-readable date/time difference between the given date/time and the current date/time. .TP .B basename . Any text. Treats the text as a path, and returns the last component of the path after splitting by the path separator (ignoring trailing separators). For example, "foo/bar/baz" becomes "baz" and "foo/bar//" becomes "bar". .TP .B date . Date. Returns a date in a Unix date format, including the timezone: "Mon Sep 04 15:13:13 2006 0700". .TP .B domain . Any text. Finds the first string that looks like an email address, and extracts just the domain component. Example: \fBUser \fP becomes \fBexample.com\fP. .TP .B email . Any text. Extracts the first string that looks like an email address. Example: \fBUser \fP becomes \fBuser@example.com\fP. .TP .B escape . Any text. Replaces the special XML/XHTML characters "&", "<" and ">" with XML entities. .TP .B fill68 . Any text. Wraps the text to fit in 68 columns. .TP .B fill76 . Any text. Wraps the text to fit in 76 columns. .TP .B firstline . Any text. Returns the first line of text. .TP .B hex . Any text. Convert a binary Mercurial node identifier into its long hexadecimal representation. .TP .B hgdate . Date. Returns the date as a pair of numbers: "1157407993 25200" (Unix timestamp, timezone offset). .TP .B isodate . Date. Returns the date in ISO 8601 format: "2009\-08\-18 13:00 +0200". .TP .B isodatesec . Date. Returns the date in ISO 8601 format, including seconds: "2009\-08\-18 13:00:13 +0200". See also the rfc3339date filter. .TP .B localdate . Date. Converts a date to local date. .TP .B nonempty . Any text. Returns \(aq(none)\(aq if the string is empty. .TP .B obfuscate . Any text. Returns the input text rendered as a sequence of XML entities. .TP .B person . Any text. Returns the text before an email address. .TP .B rfc3339date . Date. Returns a date using the Internet date format specified in RFC 3339: "2009\-08\-18T13:00:13+02:00". .TP .B rfc822date . Date. Returns a date using the same format used in email headers: "Tue, 18 Aug 2009 13:00:13 +0200". .TP .B short . Changeset hash. Returns the short form of a changeset hash, i.e. a 12 hexadecimal digit string. .TP .B shortdate . Date. Returns a date like "2006\-09\-18". .TP .B stringify . Any type. Turns the value into text by converting values into text and concatenating them. .TP .B strip . Any text. Strips all leading and trailing whitespace. .TP .B stripdir . Treat the text as path and strip a directory level, if possible. For example, "foo" and "foo/bar" becomes "foo". .TP .B tabindent . Any text. Returns the text, with every line except the first starting with a tab character. .TP .B urlescape . Any text. Escapes all "special" characters. For example, "foo bar" becomes "foo%20bar". .TP .B user . Any text. Returns the user portion of an email address. .UNINDENT .SH URL PATHS .sp Valid URLs are of the form: .sp .nf .ft C local/filesystem/path[#revision] file://local/filesystem/path[#revision] http://[user[:pass]@]host[:port]/[path][#revision] https://[user[:pass]@]host[:port]/[path][#revision] ssh://[user@]host[:port]/[path][#revision] .ft P .fi .sp Paths in the local filesystem can either point to Mercurial repositories or to bundle files (as created by \%\fBhg bundle\fP\: or :hg:\(ga incoming \-\-bundle\(ga). See also \%\fBhg help paths\fP\:. .sp An optional identifier after # indicates a particular branch, tag, or changeset to use from the remote repository. See also \%\fBhg help revisions\fP\:. .sp Some features, such as pushing to \%http://\: and \%https://\: URLs are only possible if the feature is explicitly enabled on the remote Mercurial server. .sp Note that the security of HTTPS URLs depends on proper configuration of web.cacerts. .sp Some notes about using SSH with Mercurial: .INDENT 0.0 .IP \(bu 2 . SSH requires an accessible shell account on the destination machine and a copy of hg in the remote path or specified with as remotecmd. .IP \(bu 2 . path is relative to the remote user\(aqs home directory by default. Use an extra slash at the start of a path to specify an absolute path: .sp .nf .ft C ssh://example.com//tmp/repository .ft P .fi .IP \(bu 2 . Mercurial doesn\(aqt use its own compression via SSH; the right thing to do is to configure it in your ~/.ssh/config, e.g.: .sp .nf .ft C Host *.mylocalnetwork.example.com Compression no Host * Compression yes .ft P .fi .sp Alternatively specify "ssh \-C" as your ssh command in your configuration file or with the \-\-ssh command line option. .UNINDENT .sp These URLs can all be stored in your configuration file with path aliases under the [paths] section like so: .sp .nf .ft C [paths] alias1 = URL1 alias2 = URL2 \&... .ft P .fi .sp You can then use the alias for any command that uses a URL (for example \%\fBhg pull alias1\fP\: will be treated as \%\fBhg pull URL1\fP\:). .sp Two path aliases are special because they are used as defaults when you do not provide the URL to a command: .INDENT 0.0 .TP .B default: . When you create a repository with hg clone, the clone command saves the location of the source repository as the new repository\(aqs \(aqdefault\(aq path. This is then used when you omit path from push\- and pull\-like commands (including incoming and outgoing). .TP .B default\-push: . The push command will look for a path named \(aqdefault\-push\(aq, and prefer it over \(aqdefault\(aq if both are defined. .UNINDENT .SH EXTENSIONS .sp This section contains help for extensions that are distributed together with Mercurial. Help for other extensions is available in the help system. .SS acl .sp hooks for controlling repository access .sp This hook makes it possible to allow or deny write access to given branches and paths of a repository when receiving incoming changesets via pretxnchangegroup and pretxncommit. .sp The authorization is matched based on the local user name on the system where the hook runs, and not the committer of the original changeset (since the latter is merely informative). .sp The acl hook is best used along with a restricted shell like hgsh, preventing authenticating users from doing anything other than pushing or pulling. The hook is not safe to use if users have interactive shell access, as they can then disable the hook. Nor is it safe if remote users share an account, because then there is no way to distinguish them. .sp The order in which access checks are performed is: .INDENT 0.0 .IP 1. 3 . Deny list for branches (section \fBacl.deny.branches\fP) .IP 2. 3 . Allow list for branches (section \fBacl.allow.branches\fP) .IP 3. 3 . Deny list for paths (section \fBacl.deny\fP) .IP 4. 3 . Allow list for paths (section \fBacl.allow\fP) .UNINDENT .sp The allow and deny sections take key\-value pairs. .SS Branch\-based Access Control .sp Use the \fBacl.deny.branches\fP and \fBacl.allow.branches\fP sections to have branch\-based access control. Keys in these sections can be either: .INDENT 0.0 .IP \(bu 2 . a branch name, or .IP \(bu 2 . an asterisk, to match any branch; .UNINDENT .sp The corresponding values can be either: .INDENT 0.0 .IP \(bu 2 . a comma\-separated list containing users and groups, or .IP \(bu 2 . an asterisk, to match anyone; .UNINDENT .SS Path\-based Access Control .sp Use the \fBacl.deny\fP and \fBacl.allow\fP sections to have path\-based access control. Keys in these sections accept a subtree pattern (with a glob syntax by default). The corresponding values follow the same syntax as the other sections above. .SS Groups .sp Group names must be prefixed with an \fB@\fP symbol. Specifying a group name has the same effect as specifying all the users in that group. .sp You can define group members in the \fBacl.groups\fP section. If a group name is not defined there, and Mercurial is running under a Unix\-like system, the list of users will be taken from the OS. Otherwise, an exception will be raised. .SS Example Configuration .sp .nf .ft C [hooks] # Use this if you want to check access restrictions at commit time pretxncommit.acl = python:hgext.acl.hook # Use this if you want to check access restrictions for pull, push, # bundle and serve. pretxnchangegroup.acl = python:hgext.acl.hook [acl] # Allow or deny access for incoming changes only if their source is # listed here, let them pass otherwise. Source is "serve" for all # remote access (http or ssh), "push", "pull" or "bundle" when the # related commands are run locally. # Default: serve sources = serve [acl.deny.branches] # Everyone is denied to the frozen branch: frozen\-branch = * # A bad user is denied on all branches: * = bad\-user [acl.allow.branches] # A few users are allowed on branch\-a: branch\-a = user\-1, user\-2, user\-3 # Only one user is allowed on branch\-b: branch\-b = user\-1 # The super user is allowed on any branch: * = super\-user # Everyone is allowed on branch\-for\-tests: branch\-for\-tests = * [acl.deny] # This list is checked first. If a match is found, acl.allow is not # checked. All users are granted access if acl.deny is not present. # Format for both lists: glob pattern = user, ..., @group, ... # To match everyone, use an asterisk for the user: # my/glob/pattern = * # user6 will not have write access to any file: ** = user6 # Group "hg\-denied" will not have write access to any file: ** = @hg\-denied # Nobody will be able to change "DONT\-TOUCH\-THIS.txt", despite # everyone being able to change all other files. See below. src/main/resources/DONT\-TOUCH\-THIS.txt = * [acl.allow] # if acl.allow is not present, all users are allowed by default # empty acl.allow = no users allowed # User "doc_writer" has write access to any file under the "docs" # folder: docs/** = doc_writer # User "jack" and group "designers" have write access to any file # under the "images" folder: images/** = jack, @designers # Everyone (except for "user6" \- see acl.deny above) will have write # access to any file under the "resources" folder (except for 1 # file. See acl.deny): src/main/resources/** = * \&.hgtags = release_engineer .ft P .fi .SS bugzilla .sp hooks for integrating with the Bugzilla bug tracker .sp This hook extension adds comments on bugs in Bugzilla when changesets that refer to bugs by Bugzilla ID are seen. The comment is formatted using the Mercurial template mechanism. .sp The hook does not change bug status. .sp Three basic modes of access to Bugzilla are provided: .INDENT 0.0 .IP 1. 3 . Access via the Bugzilla XMLRPC interface. Requires Bugzilla 3.4 or later. .IP 2. 3 . Check data via the Bugzilla XMLRPC interface and submit bug change via email to Bugzilla email interface. Requires Bugzilla 3.4 or later. .IP 3. 3 . Writing directly to the Bugzilla database. Only Bugzilla installations using MySQL are supported. Requires Python MySQLdb. .UNINDENT .sp Writing directly to the database is susceptible to schema changes, and relies on a Bugzilla contrib script to send out bug change notification emails. This script runs as the user running Mercurial, must be run on the host with the Bugzilla install, and requires permission to read Bugzilla configuration details and the necessary MySQL user and password to have full access rights to the Bugzilla database. For these reasons this access mode is now considered deprecated, and will not be updated for new Bugzilla versions going forward. .sp Access via XMLRPC needs a Bugzilla username and password to be specified in the configuration. Comments are added under that username. Since the configuration must be readable by all Mercurial users, it is recommended that the rights of that user are restricted in Bugzilla to the minimum necessary to add comments. .sp Access via XMLRPC/email uses XMLRPC to query Bugzilla, but sends email to the Bugzilla email interface to submit comments to bugs. The From: address in the email is set to the email address of the Mercurial user, so the comment appears to come from the Mercurial user. In the event that the Mercurial user email is not recognised by Bugzilla as a Bugzilla user, the email associated with the Bugzilla username used to log into Bugzilla is used instead as the source of the comment. .sp Configuration items common to all access modes: .INDENT 0.0 .TP .B bugzilla.version . This access type to use. Values recognised are: .INDENT 7.0 .TP .B \fBxmlrpc\fP .sp Bugzilla XMLRPC interface. .TP .B \fBxmlrpc+email\fP .sp Bugzilla XMLRPC and email interfaces. .TP .B \fB3.0\fP .sp MySQL access, Bugzilla 3.0 and later. .TP .B \fB2.18\fP .sp MySQL access, Bugzilla 2.18 and up to but not including 3.0. .TP .B \fB2.16\fP .sp MySQL access, Bugzilla 2.16 and up to but not including 2.18. .UNINDENT .TP .B bugzilla.regexp . Regular expression to match bug IDs in changeset commit message. Must contain one "()" group. The default expression matches \fBBug 1234\fP, \fBBug no. 1234\fP, \fBBug number 1234\fP, \fBBugs 1234,5678\fP, \fBBug 1234 and 5678\fP and variations thereof. Matching is case insensitive. .TP .B bugzilla.style . The style file to use when formatting comments. .TP .B bugzilla.template . Template to use when formatting comments. Overrides style if specified. In addition to the usual Mercurial keywords, the extension specifies: .INDENT 7.0 .TP .B \fB{bug}\fP .sp The Bugzilla bug ID. .TP .B \fB{root}\fP .sp The full pathname of the Mercurial repository. .TP .B \fB{webroot}\fP .sp Stripped pathname of the Mercurial repository. .TP .B \fB{hgweb}\fP .sp Base URL for browsing Mercurial repositories. .UNINDENT .sp Default \fBchangeset {node|short} in repo {root} refers to bug {bug}.\endetails:\en\et{desc|tabindent}\fP .TP .B bugzilla.strip . The number of path separator characters to strip from the front of the Mercurial repository path (\fB{root}\fP in templates) to produce \fB{webroot}\fP. For example, a repository with \fB{root}\fP \fB/var/local/my\-project\fP with a strip of 2 gives a value for \fB{webroot}\fP of \fBmy\-project\fP. Default 0. .TP .B web.baseurl . Base URL for browsing Mercurial repositories. Referenced from templates as \fB{hgweb}\fP. .UNINDENT .sp Configuration items common to XMLRPC+email and MySQL access modes: .INDENT 0.0 .TP .B bugzilla.usermap . Path of file containing Mercurial committer email to Bugzilla user email mappings. If specified, the file should contain one mapping per line: .sp .nf .ft C committer = Bugzilla user .ft P .fi .sp See also the \fB[usermap]\fP section. .UNINDENT .sp The \fB[usermap]\fP section is used to specify mappings of Mercurial committer email to Bugzilla user email. See also \fBbugzilla.usermap\fP. Contains entries of the form \fBcommitter = Bugzilla user\fP. .sp XMLRPC access mode configuration: .INDENT 0.0 .TP .B bugzilla.bzurl . The base URL for the Bugzilla installation. Default \fBhttp://localhost/bugzilla\fP. .TP .B bugzilla.user . The username to use to log into Bugzilla via XMLRPC. Default \fBbugs\fP. .TP .B bugzilla.password . The password for Bugzilla login. .UNINDENT .sp XMLRPC+email access mode uses the XMLRPC access mode configuration items, and also: .INDENT 0.0 .TP .B bugzilla.bzemail . The Bugzilla email address. .UNINDENT .sp In addition, the Mercurial email settings must be configured. See the documentation in hgrc(5), sections \fB[email]\fP and \fB[smtp]\fP. .sp MySQL access mode configuration: .INDENT 0.0 .TP .B bugzilla.host . Hostname of the MySQL server holding the Bugzilla database. Default \fBlocalhost\fP. .TP .B bugzilla.db . Name of the Bugzilla database in MySQL. Default \fBbugs\fP. .TP .B bugzilla.user . Username to use to access MySQL server. Default \fBbugs\fP. .TP .B bugzilla.password . Password to use to access MySQL server. .TP .B bugzilla.timeout . Database connection timeout (seconds). Default 5. .TP .B bugzilla.bzuser . Fallback Bugzilla user name to record comments with, if changeset committer cannot be found as a Bugzilla user. .TP .B bugzilla.bzdir . Bugzilla install directory. Used by default notify. Default \fB/var/www/html/bugzilla\fP. .TP .B bugzilla.notify . The command to run to get Bugzilla to send bug change notification emails. Substitutes from a map with 3 keys, \fBbzdir\fP, \fBid\fP (bug id) and \fBuser\fP (committer bugzilla email). Default depends on version; from 2.18 it is "cd %(bzdir)s && perl \-T contrib/sendbugmail.pl %(id)s %(user)s". .UNINDENT .sp Activating the extension: .sp .nf .ft C [extensions] bugzilla = [hooks] # run bugzilla hook on every change pulled or pushed in here incoming.bugzilla = python:hgext.bugzilla.hook .ft P .fi .sp Example configurations: .sp XMLRPC example configuration. This uses the Bugzilla at \fBhttp://my\-project.org/bugzilla\fP, logging in as user \fBbugmail@my\-project.org\fP with password \fBplugh\fP. It is used with a collection of Mercurial repositories in \fB/var/local/hg/repos/\fP, with a web interface at \fBhttp://my\-project.org/hg\fP. .sp .nf .ft C [bugzilla] bzurl=http://my\-project.org/bugzilla user=bugmail@my\-project.org password=plugh version=xmlrpc template=Changeset {node|short} in {root|basename}. {hgweb}/{webroot}/rev/{node|short}\en {desc}\en strip=5 [web] baseurl=http://my\-project.org/hg .ft P .fi .sp XMLRPC+email example configuration. This uses the Bugzilla at \fBhttp://my\-project.org/bugzilla\fP, logging in as user \fBbugmail@my\-project.org\fP with password \fBplugh\fP. It is used with a collection of Mercurial repositories in \fB/var/local/hg/repos/\fP, with a web interface at \fBhttp://my\-project.org/hg\fP. Bug comments are sent to the Bugzilla email address \fBbugzilla@my\-project.org\fP. .sp .nf .ft C [bugzilla] bzurl=http://my\-project.org/bugzilla user=bugmail@my\-project.org password=plugh version=xmlrpc bzemail=bugzilla@my\-project.org template=Changeset {node|short} in {root|basename}. {hgweb}/{webroot}/rev/{node|short}\en {desc}\en strip=5 [web] baseurl=http://my\-project.org/hg [usermap] user@emaildomain.com=user.name@bugzilladomain.com .ft P .fi .sp MySQL example configuration. This has a local Bugzilla 3.2 installation in \fB/opt/bugzilla\-3.2\fP. The MySQL database is on \fBlocalhost\fP, the Bugzilla database name is \fBbugs\fP and MySQL is accessed with MySQL username \fBbugs\fP password \fBXYZZY\fP. It is used with a collection of Mercurial repositories in \fB/var/local/hg/repos/\fP, with a web interface at \fBhttp://my\-project.org/hg\fP. .sp .nf .ft C [bugzilla] host=localhost password=XYZZY version=3.0 bzuser=unknown@domain.com bzdir=/opt/bugzilla\-3.2 template=Changeset {node|short} in {root|basename}. {hgweb}/{webroot}/rev/{node|short}\en {desc}\en strip=5 [web] baseurl=http://my\-project.org/hg [usermap] user@emaildomain.com=user.name@bugzilladomain.com .ft P .fi .sp All the above add a comment to the Bugzilla bug record of the form: .sp .nf .ft C Changeset 3b16791d6642 in repository\-name. http://my\-project.org/hg/repository\-name/rev/3b16791d6642 Changeset commit comment. Bug 1234. .ft P .fi .SS children .sp command to display child changesets .SS Commands .SS children .sp .nf .ft C hg children [\-r REV] [FILE] .ft P .fi .sp Print the children of the working directory\(aqs revisions. If a revision is given via \-r/\-\-rev, the children of that revision will be printed. If a file argument is given, revision in which the file was last changed (after the working directory revision or the argument to \-\-rev if given) is printed. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-rev . show children of the specified revision .TP .B \-\-style . display using template map file .TP .B \-\-template . display with template .UNINDENT .SS churn .sp command to display statistics about repository history .SS Commands .SS churn .sp .nf .ft C hg churn [\-d DATE] [\-r REV] [\-\-aliases FILE] [FILE] .ft P .fi .sp This command will display a histogram representing the number of changed lines or revisions, grouped according to the given template. The default template will group changes by author. The \-\-dateformat option may be used to group the results by date instead. .sp Statistics are based on the number of changed lines, or alternatively the number of matching revisions if the \-\-changesets option is specified. .sp Examples: .sp .nf .ft C # display count of changed lines for every committer hg churn \-t \(aq{author|email}\(aq # display daily activity graph hg churn \-f \(aq%H\(aq \-s \-c # display activity of developers by month hg churn \-f \(aq%Y\-%m\(aq \-s \-c # display count of lines changed in every year hg churn \-f \(aq%Y\(aq \-s .ft P .fi .sp It is possible to map alternate email addresses to a main address by providing a file using the following format: .sp .nf .ft C = .ft P .fi .sp Such a file may be specified with the \-\-aliases option, otherwise a .hgchurn file will be looked for in the working directory root. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-rev . count rate for the specified revision or range .TP .B \-d, \-\-date . count rate for revisions matching date spec .TP .B \-t, \-\-template . template to group changesets (default: {author|email}) .TP .B \-f, \-\-dateformat . strftime\-compatible format for grouping by date .TP .B \-c, \-\-changesets . count rate by number of changesets .TP .B \-s, \-\-sort . sort by key (default: sort by count) .TP .B \-\-diffstat . display added/removed lines separately .TP .B \-\-aliases . file with email aliases .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .UNINDENT .SS color .sp colorize output from some commands .sp This extension modifies the status and resolve commands to add color to their output to reflect file status, the qseries command to add color to reflect patch status (applied, unapplied, missing), and to diff\-related commands to highlight additions, removals, diff headers, and trailing whitespace. .sp Other effects in addition to color, like bold and underlined text, are also available. By default, the terminfo database is used to find the terminal codes used to change color and effect. If terminfo is not available, then effects are rendered with the ECMA\-48 SGR control function (aka ANSI escape codes). .sp Default effects may be overridden from your configuration file: .sp .nf .ft C [color] status.modified = blue bold underline red_background status.added = green bold status.removed = red bold blue_background status.deleted = cyan bold underline status.unknown = magenta bold underline status.ignored = black bold # \(aqnone\(aq turns off all effects status.clean = none status.copied = none qseries.applied = blue bold underline qseries.unapplied = black bold qseries.missing = red bold diff.diffline = bold diff.extended = cyan bold diff.file_a = red bold diff.file_b = green bold diff.hunk = magenta diff.deleted = red diff.inserted = green diff.changed = white diff.trailingwhitespace = bold red_background resolve.unresolved = red bold resolve.resolved = green bold bookmarks.current = green branches.active = none branches.closed = black bold branches.current = green branches.inactive = none .ft P .fi .sp The available effects in terminfo mode are \(aqblink\(aq, \(aqbold\(aq, \(aqdim\(aq, \(aqinverse\(aq, \(aqinvisible\(aq, \(aqitalic\(aq, \(aqstandout\(aq, and \(aqunderline\(aq; in ECMA\-48 mode, the options are \(aqbold\(aq, \(aqinverse\(aq, \(aqitalic\(aq, and \(aqunderline\(aq. How each is rendered depends on the terminal emulator. Some may not be available for a given terminal type, and will be silently ignored. .sp Note that on some systems, terminfo mode may cause problems when using color with the pager extension and less \-R. less with the \-R option will only display ECMA\-48 color codes, and terminfo mode may sometimes emit codes that less doesn\(aqt understand. You can work around this by either using ansi mode (or auto mode), or by using less \-r (which will pass through all terminal control codes, not just color control codes). .sp Because there are only eight standard colors, this module allows you to define color names for other color slots which might be available for your terminal type, assuming terminfo mode. For instance: .sp .nf .ft C color.brightblue = 12 color.pink = 207 color.orange = 202 .ft P .fi .sp to set \(aqbrightblue\(aq to color slot 12 (useful for 16 color terminals that have brighter colors defined in the upper eight) and, \(aqpink\(aq and \(aqorange\(aq to colors in 256\-color xterm\(aqs default color cube. These defined colors may then be used as any of the pre\-defined eight, including appending \(aq_background\(aq to set the background to that color. .sp By default, the color extension will use ANSI mode (or win32 mode on Windows) if it detects a terminal. To override auto mode (to enable terminfo mode, for example), set the following configuration option: .sp .nf .ft C [color] mode = terminfo .ft P .fi .sp Any value other than \(aqansi\(aq, \(aqwin32\(aq, \(aqterminfo\(aq, or \(aqauto\(aq will disable color. .SS convert .sp import revisions from foreign VCS repositories into Mercurial .SS Commands .SS convert .sp .nf .ft C hg convert [OPTION]... SOURCE [DEST [REVMAP]] .ft P .fi .sp Accepted source formats [identifiers]: .INDENT 0.0 .IP \(bu 2 . Mercurial [hg] .IP \(bu 2 . CVS [cvs] .IP \(bu 2 . Darcs [darcs] .IP \(bu 2 . git [git] .IP \(bu 2 . Subversion [svn] .IP \(bu 2 . Monotone [mtn] .IP \(bu 2 . GNU Arch [gnuarch] .IP \(bu 2 . Bazaar [bzr] .IP \(bu 2 . Perforce [p4] .UNINDENT .sp Accepted destination formats [identifiers]: .INDENT 0.0 .IP \(bu 2 . Mercurial [hg] .IP \(bu 2 . Subversion [svn] (history on branches is not preserved) .UNINDENT .sp If no revision is given, all revisions will be converted. Otherwise, convert will only import up to the named revision (given in a format understood by the source). .sp If no destination directory name is specified, it defaults to the basename of the source with \fB\-hg\fP appended. If the destination repository doesn\(aqt exist, it will be created. .sp By default, all sources except Mercurial will use \-\-branchsort. Mercurial uses \-\-sourcesort to preserve original revision numbers order. Sort modes have the following effects: .INDENT 0.0 .TP .B \-\-branchsort . convert from parent to child revision when possible, which means branches are usually converted one after the other. It generates more compact repositories. .TP .B \-\-datesort . sort revisions by date. Converted repositories have good\-looking changelogs but are often an order of magnitude larger than the same ones generated by \-\-branchsort. .TP .B \-\-sourcesort . try to preserve source revisions order, only supported by Mercurial sources. .UNINDENT .sp If \fBREVMAP\fP isn\(aqt given, it will be put in a default location (\fB/.hg/shamap\fP by default). The \fBREVMAP\fP is a simple text file that maps each source commit ID to the destination ID for that revision, like so: .sp .nf .ft C .ft P .fi .sp If the file doesn\(aqt exist, it\(aqs automatically created. It\(aqs updated on each commit copied, so \%\fBhg convert\fP\: can be interrupted and can be run repeatedly to copy new commits. .sp The authormap is a simple text file that maps each source commit author to a destination commit author. It is handy for source SCMs that use unix logins to identify authors (eg: CVS). One line per author mapping and the line format is: .sp .nf .ft C source author = destination author .ft P .fi .sp Empty lines and lines starting with a \fB#\fP are ignored. .sp The filemap is a file that allows filtering and remapping of files and directories. Each line can contain one of the following directives: .sp .nf .ft C include path/to/file\-or\-dir exclude path/to/file\-or\-dir rename path/to/source path/to/destination .ft P .fi .sp Comment lines start with \fB#\fP. A specified path matches if it equals the full relative name of a file or one of its parent directories. The \fBinclude\fP or \fBexclude\fP directive with the longest matching path applies, so line order does not matter. .sp The \fBinclude\fP directive causes a file, or all files under a directory, to be included in the destination repository, and the exclusion of all other files and directories not explicitly included. The \fBexclude\fP directive causes files or directories to be omitted. The \fBrename\fP directive renames a file or directory if it is converted. To rename from a subdirectory into the root of the repository, use \fB.\fP as the path to rename to. .sp The splicemap is a file that allows insertion of synthetic history, letting you specify the parents of a revision. This is useful if you want to e.g. give a Subversion merge two parents, or graft two disconnected series of history together. Each entry contains a key, followed by a space, followed by one or two comma\-separated values: .sp .nf .ft C key parent1, parent2 .ft P .fi .sp The key is the revision ID in the source revision control system whose parents should be modified (same format as a key in .hg/shamap). The values are the revision IDs (in either the source or destination revision control system) that should be used as the new parents for that node. For example, if you have merged "release\-1.0" into "trunk", then you should specify the revision on "trunk" as the first parent and the one on the "release\-1.0" branch as the second. .sp The branchmap is a file that allows you to rename a branch when it is being brought in from whatever external repository. When used in conjunction with a splicemap, it allows for a powerful combination to help fix even the most badly mismanaged repositories and turn them into nicely structured Mercurial repositories. The branchmap contains lines of the form: .sp .nf .ft C original_branch_name new_branch_name .ft P .fi .sp where "original_branch_name" is the name of the branch in the source repository, and "new_branch_name" is the name of the branch is the destination repository. No whitespace is allowed in the branch names. This can be used to (for instance) move code in one repository from "default" to a named branch. .SS Mercurial Source .sp The Mercurial source recognizes the following configuration options, which you can set on the command line with \fB\-\-config\fP: .INDENT 0.0 .TP .B convert.hg.ignoreerrors . ignore integrity errors when reading. Use it to fix Mercurial repositories with missing revlogs, by converting from and to Mercurial. Default is False. .TP .B convert.hg.saverev . store original revision ID in changeset (forces target IDs to change). It takes and boolean argument and defaults to False. .TP .B convert.hg.startrev . convert start revision and its descendants. It takes a hg revision identifier and defaults to 0. .UNINDENT .SS CVS Source .sp CVS source will use a sandbox (i.e. a checked\-out copy) from CVS to indicate the starting point of what will be converted. Direct access to the repository files is not needed, unless of course the repository is \fB:local:\fP. The conversion uses the top level directory in the sandbox to find the CVS repository, and then uses CVS rlog commands to find files to convert. This means that unless a filemap is given, all files under the starting directory will be converted, and that any directory reorganization in the CVS sandbox is ignored. .sp The following options can be used with \fB\-\-config\fP: .INDENT 0.0 .TP .B convert.cvsps.cache . Set to False to disable remote log caching, for testing and debugging purposes. Default is True. .TP .B convert.cvsps.fuzz . Specify the maximum time (in seconds) that is allowed between commits with identical user and log message in a single changeset. When very large files were checked in as part of a changeset then the default may not be long enough. The default is 60. .TP .B convert.cvsps.mergeto . Specify a regular expression to which commit log messages are matched. If a match occurs, then the conversion process will insert a dummy revision merging the branch on which this log message occurs to the branch indicated in the regex. Default is \fB{{mergetobranch ([\-\ew]+)}}\fP .TP .B convert.cvsps.mergefrom . Specify a regular expression to which commit log messages are matched. If a match occurs, then the conversion process will add the most recent revision on the branch indicated in the regex as the second parent of the changeset. Default is \fB{{mergefrombranch ([\-\ew]+)}}\fP .TP .B hook.cvslog . Specify a Python function to be called at the end of gathering the CVS log. The function is passed a list with the log entries, and can modify the entries in\-place, or add or delete them. .TP .B hook.cvschangesets . Specify a Python function to be called after the changesets are calculated from the the CVS log. The function is passed a list with the changeset entries, and can modify the changesets in\-place, or add or delete them. .UNINDENT .sp An additional "debugcvsps" Mercurial command allows the builtin changeset merging code to be run without doing a conversion. Its parameters and output are similar to that of cvsps 2.1. Please see the command help for more details. .SS Subversion Source .sp Subversion source detects classical trunk/branches/tags layouts. By default, the supplied \fBsvn://repo/path/\fP source URL is converted as a single branch. If \fBsvn://repo/path/trunk\fP exists it replaces the default branch. If \fBsvn://repo/path/branches\fP exists, its subdirectories are listed as possible branches. If \fBsvn://repo/path/tags\fP exists, it is looked for tags referencing converted branches. Default \fBtrunk\fP, \fBbranches\fP and \fBtags\fP values can be overridden with following options. Set them to paths relative to the source URL, or leave them blank to disable auto detection. .sp The following options can be set with \fB\-\-config\fP: .INDENT 0.0 .TP .B convert.svn.branches . specify the directory containing branches. The default is \fBbranches\fP. .TP .B convert.svn.tags . specify the directory containing tags. The default is \fBtags\fP. .TP .B convert.svn.trunk . specify the name of the trunk branch. The default is \fBtrunk\fP. .UNINDENT .sp Source history can be retrieved starting at a specific revision, instead of being integrally converted. Only single branch conversions are supported. .INDENT 0.0 .TP .B convert.svn.startrev . specify start Subversion revision number. The default is 0. .UNINDENT .SS Perforce Source .sp The Perforce (P4) importer can be given a p4 depot path or a client specification as source. It will convert all files in the source to a flat Mercurial repository, ignoring labels, branches and integrations. Note that when a depot path is given you then usually should specify a target directory, because otherwise the target may be named \fB...\-hg\fP. .sp It is possible to limit the amount of source history to be converted by specifying an initial Perforce revision: .INDENT 0.0 .TP .B convert.p4.startrev . specify initial Perforce revision (a Perforce changelist number). .UNINDENT .SS Mercurial Destination .sp The following options are supported: .INDENT 0.0 .TP .B convert.hg.clonebranches . dispatch source branches in separate clones. The default is False. .TP .B convert.hg.tagsbranch . branch name for tag revisions, defaults to \fBdefault\fP. .TP .B convert.hg.usebranchnames . preserve branch names. The default is True. .UNINDENT .sp Options: .INDENT 0.0 .TP .B \-\-authors . username mapping filename (DEPRECATED, use \-\-authormap instead) .TP .B \-s, \-\-source\-type . source repository type .TP .B \-d, \-\-dest\-type . destination repository type .TP .B \-r, \-\-rev . import up to target revision REV .TP .B \-A, \-\-authormap . remap usernames using this file .TP .B \-\-filemap . remap file names using contents of file .TP .B \-\-splicemap . splice synthesized history into place .TP .B \-\-branchmap . change branch names while converting .TP .B \-\-branchsort . try to sort changesets by branches .TP .B \-\-datesort . try to sort changesets by date .TP .B \-\-sourcesort . preserve source changesets order .UNINDENT .SS eol .sp automatically manage newlines in repository files .sp This extension allows you to manage the type of line endings (CRLF or LF) that are used in the repository and in the local working directory. That way you can get CRLF line endings on Windows and LF on Unix/Mac, thereby letting everybody use their OS native line endings. .sp The extension reads its configuration from a versioned \fB.hgeol\fP configuration file found in the root of the working copy. The \fB.hgeol\fP file use the same syntax as all other Mercurial configuration files. It uses two sections, \fB[patterns]\fP and \fB[repository]\fP. .sp The \fB[patterns]\fP section specifies how line endings should be converted between the working copy and the repository. The format is specified by a file pattern. The first match is used, so put more specific patterns first. The available line endings are \fBLF\fP, \fBCRLF\fP, and \fBBIN\fP. .sp Files with the declared format of \fBCRLF\fP or \fBLF\fP are always checked out and stored in the repository in that format and files declared to be binary (\fBBIN\fP) are left unchanged. Additionally, \fBnative\fP is an alias for checking out in the platform\(aqs default line ending: \fBLF\fP on Unix (including Mac OS X) and \fBCRLF\fP on Windows. Note that \fBBIN\fP (do nothing to line endings) is Mercurial\(aqs default behaviour; it is only needed if you need to override a later, more general pattern. .sp The optional \fB[repository]\fP section specifies the line endings to use for files stored in the repository. It has a single setting, \fBnative\fP, which determines the storage line endings for files declared as \fBnative\fP in the \fB[patterns]\fP section. It can be set to \fBLF\fP or \fBCRLF\fP. The default is \fBLF\fP. For example, this means that on Windows, files configured as \fBnative\fP (\fBCRLF\fP by default) will be converted to \fBLF\fP when stored in the repository. Files declared as \fBLF\fP, \fBCRLF\fP, or \fBBIN\fP in the \fB[patterns]\fP section are always stored as\-is in the repository. .sp Example versioned \fB.hgeol\fP file: .sp .nf .ft C [patterns] **.py = native **.vcproj = CRLF **.txt = native Makefile = LF **.jpg = BIN [repository] native = LF .ft P .fi .IP Note . The rules will first apply when files are touched in the working copy, e.g. by updating to null and back to tip to touch all files. .RE .sp The extension uses an optional \fB[eol]\fP section in your hgrc file (not the \fB.hgeol\fP file) for settings that control the overall behavior. There are two settings: .INDENT 0.0 .IP \(bu 2 . \fBeol.native\fP (default \fBos.linesep\fP) can be set to \fBLF\fP or \fBCRLF\fP to override the default interpretation of \fBnative\fP for checkout. This can be used with \%\fBhg archive\fP\: on Unix, say, to generate an archive where files have line endings for Windows. .IP \(bu 2 . \fBeol.only\-consistent\fP (default True) can be set to False to make the extension convert files with inconsistent EOLs. Inconsistent means that there is both \fBCRLF\fP and \fBLF\fP present in the file. Such files are normally not touched under the assumption that they have mixed EOLs on purpose. .UNINDENT .sp The extension provides \fBcleverencode:\fP and \fBcleverdecode:\fP filters like the deprecated win32text extension does. This means that you can disable win32text and enable eol and your filters will still work. You only need to these filters until you have prepared a \fB.hgeol\fP file. .sp The \fBwin32text.forbid*\fP hooks provided by the win32text extension have been unified into a single hook named \fBeol.checkheadshook\fP. The hook will lookup the expected line endings from the \fB.hgeol\fP file, which means you must migrate to a \fB.hgeol\fP file first before using the hook. \fBeol.checkheadshook\fP only checks heads, intermediate invalid revisions will be pushed. To forbid them completely, use the \fBeol.checkallhook\fP hook. These hooks are best used as \fBpretxnchangegroup\fP hooks. .sp See \%\fBhg help patterns\fP\: for more information about the glob patterns used. .SS extdiff .sp command to allow external programs to compare revisions .sp The extdiff Mercurial extension allows you to use external programs to compare revisions, or revision with working directory. The external diff programs are called with a configurable set of options and two non\-option arguments: paths to directories containing snapshots of files to compare. .sp The extdiff extension also allows you to configure new diff commands, so you do not need to type \%\fBhg extdiff \-p kdiff3\fP\: always. .sp .nf .ft C [extdiff] # add new command that runs GNU diff(1) in \(aqcontext diff\(aq mode cdiff = gdiff \-Nprc5 ## or the old way: #cmd.cdiff = gdiff #opts.cdiff = \-Nprc5 # add new command called vdiff, runs kdiff3 vdiff = kdiff3 # add new command called meld, runs meld (no need to name twice) meld = # add new command called vimdiff, runs gvimdiff with DirDiff plugin # (see http://www.vim.org/scripts/script.php?script_id=102) Non # English user, be sure to put "let g:DirDiffDynamicDiffText = 1" in # your .vimrc vimdiff = gvim \-f \(aq+next\(aq \(aq+execute "DirDiff" argv(0) argv(1)\(aq .ft P .fi .sp Tool arguments can include variables that are expanded at runtime: .sp .nf .ft C $parent1, $plabel1 \- filename, descriptive label of first parent $child, $clabel \- filename, descriptive label of child revision $parent2, $plabel2 \- filename, descriptive label of second parent $root \- repository root $parent is an alias for $parent1. .ft P .fi .sp The extdiff extension will look in your [diff\-tools] and [merge\-tools] sections for diff tool arguments, when none are specified in [extdiff]. .sp .nf .ft C [extdiff] kdiff3 = [diff\-tools] kdiff3.diffargs=\-\-L1 \(aq$plabel1\(aq \-\-L2 \(aq$clabel\(aq $parent $child .ft P .fi .sp You can use \-I/\-X and list of file or directory names like normal \%\fBhg diff\fP\: command. The extdiff extension makes snapshots of only needed files, so running the external diff program will actually be pretty fast (at least faster than having to compare the entire tree). .SS Commands .SS extdiff .sp .nf .ft C hg extdiff [OPT]... [FILE]... .ft P .fi .sp Show differences between revisions for the specified files, using an external program. The default program used is diff, with default options "\-Npru". .sp To select a different program, use the \-p/\-\-program option. The program will be passed the names of two directories to compare. To pass additional options to the program, use \-o/\-\-option. These will be passed before the names of the directories to compare. .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. .sp Options: .INDENT 0.0 .TP .B \-p, \-\-program . comparison program to run .TP .B \-o, \-\-option . pass option to comparison program .TP .B \-r, \-\-rev . revision .TP .B \-c, \-\-change . change made by revision .TP .B \-I, \-\-include . include names matching the given patterns .TP .B \-X, \-\-exclude . exclude names matching the given patterns .UNINDENT .SS fetch .sp pull, update and merge in one command .SS Commands .SS fetch .sp .nf .ft C hg fetch [SOURCE] .ft P .fi .sp This finds all changes from the repository at the specified path or URL and adds them to the local repository. .sp If the pulled changes add a new branch head, the head is automatically merged, and the result of the merge is committed. Otherwise, the working directory is updated to include the new changes. .sp When a merge occurs, the newly pulled changes are assumed to be "authoritative". The head of the new changes is used as the first parent, with local changes as the second. To switch the merge order, use \-\-switch\-parent. .sp See \%\fBhg help dates\fP\: for a list of formats valid for \-d/\-\-date. .sp Returns 0 on success. .sp Options: .INDENT 0.0 .TP .B \-r, \-\-rev . a specific revision you would like to pull .TP .B \-e, \-\-edit . edit commit message .TP .B \-\-force\-editor . edit commit message (DEPRECATED) .TP .B \-\-switch\-parent . switch parents when merging .TP .B \-m, \-\-message . use text as commit message .TP .B \-l, \-\-logfile . read commit message from file .TP .B \-d, \-\-date . record the specified date as commit date .TP .B \-u, \-\-user . record the specified user as committer .TP .B \-e, \-\-ssh . specify ssh command to use .TP .B \-\-remotecmd . specify hg command to run on the remote side .TP .B \-\-insecure . do not verify server certificate (ignoring web.cacerts config) .UNINDENT .SS gpg .sp commands to sign and verify changesets .SS Commands .SS sigcheck .sp .nf .ft C hg sigcheck REVISION .ft P .fi .sp verify all the signatures there may be for a particular revision .SS sign .sp .nf .ft C hg sign [OPTION]... [REVISION]... .ft P .fi .sp If no revision is given, the parent of the working directory is used, or tip if no revision is checked out. .sp See \%\fBhg help dates\fP\: for a list of formats valid for \-d/\-\-date. .sp Options: .INDENT 0.0 .TP .B \-l, \-\-local . make the signature local .TP .B \-f, \-\-force . sign even if the sigfile is modified .TP .B \-\-no\-commit . do not commit the sigfile after signing .TP .B \-k, \-\-key . the key id to sign with .TP .B \-m, \-\-message . commit message .TP .B \-d, \-\-date . record the specified date as commit date .TP .B \-u, \-\-user . record the specified user as committer .UNINDENT .SS sigs .sp .nf .ft C hg sigs .ft P .fi .sp list signed changesets .SS graphlog .sp command to view revision graphs from a shell .sp This extension adds a \-\-graph option to the incoming, outgoing and log commands. When this options is given, an ASCII representation of the revision graph is also shown. .SS Commands .SS glog .sp .nf .ft C hg glog [OPTION]... [FILE] .ft P .fi .sp Print a revision history alongside a revision graph drawn with ASCII characters. .sp Nodes printed as an @ character are parents of the working directory. .sp Options: .INDENT 0.0 .TP .B \-l, \-\-limit . limit number of changes displayed .TP .B \-p, \-\-patch . show patch .TP .B \-r, \-\-rev . show the specified revision or range .TP .B \-\-style . display using template map file .TP .B \-\-template . display with template .UNINDENT .SS hgcia .sp hooks for integrating with the CIA.vc notification service .sp This is meant to be run as a changegroup or incoming hook. To configure it, set the following options in your hgrc: .sp .nf .ft C [cia] # your registered CIA user name user = foo # the name of the project in CIA project = foo # the module (subproject) (optional) #module = foo # Append a diffstat to the log message (optional) #diffstat = False # Template to use for log messages (optional) #template = {desc}\en{baseurl}{webroot}/rev/{node}\-\- {diffstat} # Style to use (optional) #style = foo # The URL of the CIA notification service (optional) # You can use mailto: URLs to send by email, eg # mailto:cia@cia.vc # Make sure to set email.from if you do this. #url = http://cia.vc/ # print message instead of sending it (optional) #test = False # number of slashes to strip for url paths #strip = 0 [hooks] # one of these: changegroup.cia = python:hgcia.hook #incoming.cia = python:hgcia.hook [web] # If you want hyperlinks (optional) baseurl = http://server/path/to/repo .ft P .fi .SS hgk .sp browse the repository in a graphical way .sp The hgk extension allows browsing the history of a repository in a graphical way. It requires Tcl/Tk version 8.4 or later. (Tcl/Tk is not distributed with Mercurial.) .sp hgk consists of two parts: a Tcl script that does the displaying and querying of information, and an extension to Mercurial named hgk.py, which provides hooks for hgk to get information. hgk can be found in the contrib directory, and the extension is shipped in the hgext repository, and needs to be enabled. .sp The \%\fBhg view\fP\: command will launch the hgk Tcl script. For this command to work, hgk must be in your search path. Alternately, you can specify the path to hgk in your configuration file: .sp .nf .ft C [hgk] path=/location/of/hgk .ft P .fi .sp hgk can make use of the extdiff extension to visualize revisions. Assuming you had already configured extdiff vdiff command, just add: .sp .nf .ft C [hgk] vdiff=vdiff .ft P .fi .sp Revisions context menu will now display additional entries to fire vdiff on hovered and selected revisions. .SS Commands .SS view .sp .nf .ft C hg view [\-l LIMIT] [REVRANGE] .ft P .fi .sp start interactive history viewer .sp Options: .INDENT 0.0 .TP .B \-l, \-\-limit . limit number of changes displayed .UNINDENT .SS highlight .sp syntax highlighting for hgweb (requires Pygments) .sp It depends on the Pygments syntax highlighting library: \%http://pygments.org/\: .sp There is a single configuration option: .sp .nf .ft C [web] pygments_style =