5 hgrc \- configuration files for Mercurial
7 The Mercurial system uses a set of configuration files to control aspects of its behaviour.
10 Mercurial reads configuration data from several files, if they exist. The names of these files depend on the system on which Mercurial is installed. *.rc files from a single directory are read in alphabetical order, later ones overriding earlier ones. Where multiple paths are given below, settings from later paths override earlier ones.
12 (Unix) <install\-root>/etc/mercurial/hgrc.d/*.rc, (Unix) <install\-root>/etc/mercurial/hgrc
14 Per\-installation configuration files, searched for in the directory where Mercurial is installed. <install\-root> is the parent directory of the hg executable (or symlink) being run. For example, if installed in /shared/tools/bin/hg, Mercurial will look in /shared/tools/etc/mercurial/hgrc. Options in these files apply to all Mercurial commands executed by any user in any directory.
17 (Unix) /etc/mercurial/hgrc.d/*.rc, (Unix) /etc/mercurial/hgrc
19 Per\-system configuration files, for the system on which Mercurial is running. Options in these files apply to all Mercurial commands executed by any user in any directory. Options in these files override per\-installation options.
22 (Windows) <install\-dir>\eMercurial.ini, or else, (Windows) HKEY_LOCAL_MACHINE\eSOFTWARE\eMercurial, or else, (Windows) C:\eMercurial\eMercurial.ini
24 Per\-installation/system configuration files, for the system on which Mercurial is running. Options in these files apply to all Mercurial commands executed by any user in any directory. Registry keys contain PATH\-like strings, every part of which must reference a Mercurial.ini file or be a directory where *.rc files will be read.
27 (Unix) $HOME/.hgrc, (Windows) %HOME%\eMercurial.ini, (Windows) %HOME%\e.hgrc, (Windows) %USERPROFILE%\eMercurial.ini, (Windows) %USERPROFILE%\e.hgrc
29 Per\-user configuration file(s), for the user running Mercurial. On Windows 9x, %HOME% is replaced by %APPDATA%. Options in these files apply to all Mercurial commands executed by this user in any directory. Options in thes files override per\-installation and per\-system options.
32 (Unix, Windows) <repo>/.hg/hgrc
34 Per\-repository configuration options that only apply in a particular repository. This file is not version\-controlled, and will not get transferred during a "clone" operation. Options in this file override options in all other configuration files. On Unix, most of this file will be ignored if it doesn\'t belong to a trusted user or to a trusted group. See the documentation for the trusted section below for more details.
37 A configuration file consists of sections, led by a "[section]" header and followed by "name: value" entries; "name=value" is also accepted.
48 Each line contains one entry. If the lines that follow are indented, they are treated as continuations of that entry.
50 Leading whitespace is removed from values. Empty lines are skipped.
52 The optional values can contain format strings which refer to other values in the same section, or values in a special DEFAULT section.
54 Lines beginning with "#" or ";" are ignored and may be used to provide comments.
57 This section describes the different sections that may appear in a Mercurial "hgrc" file, the purpose of each section, its possible keys, and their possible values.
61 Filters for transforming files on checkout/checkin. This would typically be used for newline processing or other localization/canonicalization of files.
65 Filters consist of a filter pattern followed by a filter command.
66 Filter patterns are globs by default, rooted at the repository
67 root. For example, to match any file ending in ".txt" in the root
68 directory only, use the pattern "*.txt". To match any file ending
69 in ".c" anywhere in the repository, use the pattern "**.c".
75 The filter command can start with a specifier, either "pipe:" or
76 "tempfile:". If no specifier is given, "pipe:" is used by default.
82 A "pipe:" command must accept data on stdin and return the
83 transformed data on stdout.
96 # uncompress gzip files on checkin to improve delta compression
97 # note: not necessarily a good idea, just an example
105 # recompress gzip files when writing them to the working dir (we
106 # can safely omit "pipe:", because it\'s the default)
113 A "tempfile:" command is a template. The string INFILE is replaced
114 with the name of a temporary file that contains the data to be
115 filtered by the command. The string OUTFILE is replaced with the
116 name of an empty temporary file, where the filtered data must be
117 written by the command.
123 NOTE: the tempfile mechanism is recommended for Windows systems,
124 where the standard shell I/O redirection operators often have
125 strange effects and may corrupt the contents of your files.
131 The most common usage is for LF <\-> CRLF translation on Windows.
132 For this, use the "smart" convertors which check for binary files:
149 or if you only want to translate certain files:
167 Use the [defaults] section to define command defaults, i.e. the default options/arguments to pass to the specified commands.
171 The following example makes \'hg log\' run in verbose mode, and
172 \'hg status\' show only the modified files, by default.
186 The actual commands, instead of their aliases, must be used when
187 defining command defaults. The command defaults will also be
188 applied to the aliases of the commands defined.
195 Settings used when displaying diffs. They are all boolean and defaults to False.
199 Use git extended diff format.
204 Don\'t include dates in diff headers.
209 Show which function each change is in.
214 Ignore white space when comparing lines.
219 Ignore changes in the amount of white space.
224 Ignore changes whose lines are all blank.
230 Settings for extensions that send email messages.
234 Optional. Email address to use in "From" header and SMTP envelope of outgoing messages.
239 Optional. Comma\-separated list of recipients\' email addresses.
244 Optional. Comma\-separated list of carbon copy recipients\' email addresses.
249 Optional. Comma\-separated list of blind carbon copy recipients\' email addresses. Cannot be set interactively.
254 Optional. Method to use to send email messages. If value is "smtp" (default), use SMTP (see section "[smtp]" for configuration). Otherwise, use as name of program to run that acts like sendmail (takes "\-f" option for sender, list of recipients on command line, message on stdin). Normally, setting this to "sendmail" or "/usr/sbin/sendmail" is enough to use sendmail to send messages.
265 from = Joseph User <joe.user@example.com>
266 method = /usr/sbin/sendmail
274 Mercurial has an extension mechanism for adding new features. To enable an extension, create an entry for it in this section.
278 If you know that the extension is already in Python\'s search path,
279 you can give the name of the module, followed by "=", with nothing
286 Otherwise, give a name that you choose, followed by "=", followed by
287 the path to the ".py" file (including the file name extension) that
288 defines the extension.
294 To explicitly disable an extension that is enabled in an hgrc of
295 broader scope, prepend its path with \'!\', as in
296 \'hgext.foo = !/ext/path\' or \'hgext.foo = !\' when no path is supplied.
309 # (the mq extension will get loaded from mercurial\'s path)
311 # (this extension will get loaded from the file specified)
312 myfeature = ~/.hgext/myfeature.py
322 Enable or disable the "store" repository format which improves compatibility with systems that fold case or otherwise mangle filenames. Enabled by default. Disabling this option will allow you to store longer filenames in some situations at the expense of compatibility.
328 This section specifies merge tools to associate with particular file patterns. Tools matched here will take precedence over the default merge tool. Patterns are globs by default, rooted at the repository root.
347 This section configures external merge tools to use for file\-level merges.
358 # Override stock tool location
359 kdiff3.executable = ~/bin/kdiff3
360 # Specify command line
361 kdiff3.args = $base $local $other \-o $output
362 # Give higher priority
370 myHtmlTool.args = \-m $local $other $base $output
371 myHtmlTool.regkey = Software\eFooSoftware\eHtmlMerge
372 myHtmlTool.priority = 1
380 The priority in which to evaluate this tool.
383 Either just the name of the executable or its pathname.
384 Default: the tool name.
386 The arguments to pass to the tool executable. You can refer to the files
387 being merged as well as the output file through these variables: $base,
388 $local, $other, $output.
389 Default: $local $base $other
391 Attempt to run internal non\-interactive 3\-way merge tool before
392 launching external tool.
395 This tool can merge binary files. Defaults to False, unless tool
396 was selected by file pattern match.
398 This tool can merge symlinks. Defaults to False, even if tool was
399 selected by file pattern match.
401 Check whether there are conflicts even though the tool reported
405 Check whether outputs were written even though the tool reported
409 Attempt to fix up EOL changes caused by the merge tool.
412 This tool requires a graphical interface to run. Default: False
414 Windows registry key which describes install location of this tool.
415 Mercurial will search for this key first under HKEY_CURRENT_USER and
416 then under HKEY_LOCAL_MACHINE. Default: None
418 Name of value to read from specified registry key. Defaults to the
419 unnamed (default) value.
421 String to append to the value read from the registry, typically the
422 executable name of the tool. Default: None
429 Commands or Python functions that get automatically executed by various actions such as starting or finishing a commit. Multiple hooks can be run for the same action by appending a suffix to the action. Overriding a site\-wide hook can be done by changing its value or setting it to an empty string.
440 # do not use the site\-wide hook
442 incoming.email = /my/email/hook
443 incoming.autobuild = /my/build/hook
449 Most hooks are run with environment variables set that give added
450 useful information. For each hook below, the environment variables
451 it is passed are listed with names of the form "$HG_foo".
457 Run after a changegroup has been added via push, pull or unbundle. ID of the first new changeset is in $HG_NODE. URL from which changes came is in $HG_URL.
462 Run after a changeset has been created in the local repository. ID of the newly created changeset is in $HG_NODE. Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
467 Run after a changeset has been pulled, pushed, or unbundled into the local repository. The ID of the newly arrived changeset is in $HG_NODE. URL that was source of changes came is in $HG_URL.
472 Run after sending changes from local repository to another. ID of first changeset sent is in $HG_NODE. Source of operation is in $HG_SOURCE; see "preoutgoing" hook for description.
477 Run after successful invocations of the associated command. The contents of the command line are passed as $HG_ARGS and the result code in $HG_RESULT. Hook failure is ignored.
482 Run before executing the associated command. The contents of the command line are passed as $HG_ARGS. If the hook returns failure, the command doesn\'t execute and Mercurial returns the failure code.
487 Run before a changegroup is added via push, pull or unbundle. Exit status 0 allows the changegroup to proceed. Non\-zero status will cause the push, pull or unbundle to fail. URL from which changes will come is in $HG_URL.
492 Run before starting a local commit. Exit status 0 allows the commit to proceed. Non\-zero status will cause the commit to fail. Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
497 Run before collecting changes to send from the local repository to another. Non\-zero status will cause failure. This lets you prevent pull over http or ssh. Also prevents against local pull, push (outbound) or bundle commands, but not effective, since you can just copy files instead then. Source of operation is in $HG_SOURCE. If "serve", operation is happening on behalf of remote ssh or http repository. If "push", "pull" or "bundle", operation is happening on behalf of repository on same system.
502 Run before creating a tag. Exit status 0 allows the tag to be created. Non\-zero status will cause the tag to fail. ID of changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0.
507 Run after a changegroup has been added via push, pull or unbundle, but before the transaction has been committed. Changegroup is visible to hook program. This lets you validate incoming changes before accepting them. Passed the ID of the first new changeset in $HG_NODE. Exit status 0 allows the transaction to commit. Non\-zero status will cause the transaction to be rolled back and the push, pull or unbundle will fail. URL that was source of changes is in $HG_URL.
512 Run after a changeset has been created but the transaction not yet committed. Changeset is visible to hook program. This lets you validate commit message and changes. Exit status 0 allows the commit to proceed. Non\-zero status will cause the transaction to be rolled back. ID of changeset is in $HG_NODE. Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
517 Run before updating the working directory. Exit status 0 allows the update to proceed. Non\-zero status will prevent the update. Changeset ID of first new parent is in $HG_PARENT1. If merge, ID of second new parent is in $HG_PARENT2.
522 Run after a tag is created. ID of tagged changeset is in $HG_NODE. Name of tag is in $HG_TAG. Tag is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0.
527 Run after updating the working directory. Changeset ID of first new parent is in $HG_PARENT1. If merge, ID of second new parent is in $HG_PARENT2. If update succeeded, $HG_ERROR=0. If update failed (e.g. because conflicts not resolved), $HG_ERROR=1.
531 Note: it is generally better to use standard hooks rather than the
532 generic pre\- and post\- command hooks as they are guaranteed to be
533 called in the appropriate contexts for influencing transactions.
534 Also, hooks like "commit" will be called in all contexts that
535 generate a commit (eg. tag) and not just the commit command.
541 Note2: Environment variables with empty values may not be passed to
542 hooks on platforms like Windows. For instance, $HG_PARENT2 will
543 not be available under Windows for non\-merge changesets while being
544 set to an empty value under Unix\-like systems.
550 The syntax for Python hooks is as follows:
556 hookname = python:modulename.submodule.callable
562 Python hooks are run within the Mercurial process. Each hook is
563 called with at least three keyword arguments: a ui object (keyword
564 "ui"), a repository object (keyword "repo"), and a "hooktype"
565 keyword that tells what kind of hook is used. Arguments listed as
566 environment variables above are passed as keyword arguments, with no
567 "HG_" prefix, and names in lower case.
573 If a Python hook returns a "true" value or raises an exception, this
574 is treated as failure of the hook.
582 Used to access web\-based Mercurial repositories through a HTTP proxy.
586 Host name and (optional) port of the proxy server, for example "myproxy:8000".
591 Optional. Comma\-separated list of host names that should bypass the proxy.
596 Optional. Password to authenticate with at the proxy server.
601 Optional. User name to authenticate with at the proxy server.
607 Configuration for extensions that need to send email messages.
611 Host name of mail server, e.g. "mail.example.com".
616 Optional. Port to connect to on mail server. Default: 25.
621 Optional. Whether to connect to mail server using TLS. True or False. Default: False.
626 Optional. User name to authenticate to SMTP server with. If username is specified, password must also be specified. Default: none.
631 Optional. Password to authenticate to SMTP server with. If username is specified, password must also be specified. Default: none.
636 Optional. It\'s the hostname that the sender can use to identify itself to the MTA.
642 Assigns symbolic names to repositories. The left side is the symbolic name, and the right gives the directory or URL that is the location of the repository. Default paths can be declared by setting the following entries.
646 Directory or URL to use when pulling if no source is specified. Default is set to repository from which the current repository was cloned.
651 Optional. Directory or URL to use when pushing if no destination is specified.
657 Controls generic server settings.
661 Whether to allow clients to clone a repo using the uncompressed streaming protocol. This transfers about 40% more data than a regular clone, but uses less memory and CPU on both server and client. Over a LAN (100Mbps or better) or a very fast WAN, an uncompressed streaming clone is a lot faster (~10x) than a regular clone. Over most WAN connections (anything slower than about 6Mbps), uncompressed streaming is slower, because of the extra data transfer overhead. Default is False.
667 For security reasons, Mercurial will not use the settings in the .hg/hgrc file from a repository if it doesn\'t belong to a trusted user or to a trusted group. The main exception is the web interface, which automatically uses some safe settings, since it\'s common to serve repositories from different users.
671 This section specifies what users and groups are trusted. The
672 current user is always trusted. To trust everybody, list a user
673 or a group with name "*".
679 Comma\-separated list of trusted users.
684 Comma\-separated list of trusted groups.
690 User interface controls.
694 Whether to include the .hg_archival.txt file containing metadata (hashes for the repository base and for tip) in archives created by the hg archive command or downloaded via hgweb. Default is true.
699 Print debugging information. True or False. Default is False.
704 The editor to use during a commit. Default is $EDITOR or "vi".
709 Encoding to try if it\'s not possible to decode the changelog using UTF\-8. Default is ISO\-8859\-1.
714 A file to read per\-user ignore patterns from. This file should be in the same format as a repository\-wide .hgignore file. This option supports hook syntax, so if you want to specify multiple ignore files, you can do so by setting something like "ignore.other = ~/.hgignore2". For details of the ignore file format, see the
721 Allow to prompt the user. True or False. Default is True.
726 Template string for commands that print changesets.
731 The conflict resolution program to use during a manual merge. There are some internal tools available:
736 keep the local version
741 use the other version
746 use the internal non\-interactive merge tool
755 See the merge\-tools section for more information on configuring tools.
757 command to use to apply patches. Look for \'gpatch\' or \'patch\' in PATH if
760 Reduce the amount of output printed. True or False. Default is False.
762 remote command to use for clone/push/pull operations. Default is \'hg\'.
764 Warn if a .hg/hgrc file is ignored due to not being owned by a
765 trusted user or group. True or False. Default is True.
767 Display paths using a slash ("/") as the path separator. This only
768 makes a difference on systems where the default path separator is not
769 the slash character (e.g. Windows uses the backslash character ("\e")).
772 command to use for SSH connections. Default is \'ssh\'.
774 Require exact command names, instead of allowing unambiguous
775 abbreviations. True or False. Default is False.
777 Name of style to use for command output.
779 The timeout used when a lock is held (in seconds), a negative value
780 means no timeout. Default is 600.
782 The committer of a changeset created when running "commit".
783 Typically a person\'s name and email address, e.g. "Fred Widget
784 <fred@example.com>". Default is $EMAIL or username@hostname.
785 If the username in hgrc is empty, it has to be specified manually or
786 in a different hgrc file (e.g. $HOME/.hgrc, if the admin set "username ="
789 Increase the amount of output printed. True or False. Default is False.
797 Web interface configuration.
801 Where to output the access log. Default is stdout.
806 Interface address to bind to. Default is all.
811 List of archive format (bz2, gz, zip) allowed for downloading. Default is empty.
816 (DEPRECATED) Whether to allow .tar.bz2 downloading of repo revisions. Default is false.
821 (DEPRECATED) Whether to allow .tar.gz downloading of repo revisions. Default is false.
826 Whether to allow pulling from the repository. Default is true.
831 Whether to allow pushing to the repository. If empty or not set, push is not allowed. If the special value "*", any remote user can push, including unauthenticated users. Otherwise, the remote user must have been authenticated, and the authenticated user name must be present in this list (separated by whitespace or ","). The contents of the allow_push list are examined after the deny_push list.
836 (DEPRECATED) Whether to allow .zip downloading of repo revisions. Default is false. This feature creates temporary files.
841 Base URL to use when publishing URLs in other locations, so third\-party tools like email notification hooks can construct URLs. Example: "http://hgserver/repos/"
846 Name or email address of the person in charge of the repository. Defaults to ui.username or $EMAIL or "unknown" if unset or empty.
851 Whether to deny pushing to the repository. If empty or not set, push is not denied. If the special value "*", all remote users are denied push. Otherwise, unauthenticated users are all denied, and any authenticated user name present in this list (separated by whitespace or ",") is also denied. The contents of the deny_push list are examined before the allow_push list.
856 Textual description of the repository\'s purpose or contents. Default is "unknown".
861 Character encoding name. Example: "UTF\-8"
866 Where to output the error log. Default is stderr.
871 Whether to hide the repository in the hgwebdir index. Default is false.
876 Whether to use IPv6. Default is false.
881 Repository name to use in the web interface. Default is current working directory.
886 Maximum number of changes to list on the changelog. Default is 10.
891 Maximum number of files to list per changeset. Default is 10.
896 Port to listen on. Default is 8000.
901 Prefix path to serve from. Default is \'\' (server root).
906 Whether to require that inbound pushes be transported over SSL to prevent password sniffing. Default is true.
911 Base URL to use for static files. If unset, static files (e.g. the hgicon.png favicon) will be served by the CGI script itself. Use this setting to serve them directly with the HTTP server. Example: "http://hgserver/static/"
916 How many lines a "zebra stripe" should span in multiline output. Default is 1; set to 0 to disable.
921 Which template map style to use.
926 Where to find the HTML templates. Default is install path.
930 Bryan O\'Sullivan <bos@serpentine.com>.
932 Mercurial was written by Matt Mackall <mpm@selenic.com>.
939 This manual page is copyright 2005 Bryan O\'Sullivan. Mercurial is copyright 2005\-2007 Matt Mackall. Free use of this software is granted under the terms of the GNU General Public License (GPL).
projects / plan9front.git / blob