view doc/hgrc.5.txt @ 1508:b254243b7159

fix a warning when py2exe is not used
author Benoit Boissinot <>
date Fri, 04 Nov 2005 11:37:45 -0800
parents 625f3f13d7be
children 32a4e6802864
line wrap: on
line source

Bryan O'Sullivan <>

hgrc - configuration files for Mercurial


The Mercurial system uses a set of configuration files to control
aspects of its behaviour.


Mercurial reads configuration data from up to three files, if they
exist.  The names of these files depend on the system on which
Mercurial is installed.

(Unix)    /etc/mercurial/hgrc::
(Windows) C:\Mercurial\Mercurial.ini::
    Options in this global configuration file apply to all Mercurial
    commands executed by any user in any directory.

(Unix)    $HOME/.hgrc::
(Windows) C:\Documents and Settings\USERNAME\Mercurial.ini
    Per-user configuration options that apply to all Mercurial commands,
    no matter from which directory they are run.  Values in this file
    override global settings.

(Unix, Windows) <repo>/.hg/hgrc::
    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.  Values in
    this file override global and per-user settings.


A configuration file consists of sections, led by a "[section]" header
and followed by "name: value" entries; "name=value" is also accepted.


Each line contains one entry.  If the lines that follow are indented,
they are treated as continuations of that entry.

Leading whitespace is removed from values.  Empty lines are skipped.

The optional values can contain format strings which refer to other
values in the same section, or values in a special DEFAULT section.

Lines beginning with "#" or ";" are ignored and may be used to provide


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.

  Filters for transforming files on checkout/checkin. This would
  typically be used for newline processing or other
  localization/canonicalization of files.

  Filters consist of a filter pattern followed by a filter command.
  Filter patterns are globs by default, rooted at the repository
  root.  For example, to match any file ending in ".txt" in the root
  directory only, use the pattern "*.txt".  To match any file ending
  in ".c" anywhere in the repository, use the pattern "**.c".

  The filter command can start with a specifier, either "pipe:" or
  "tempfile:".  If no specifier is given, "pipe:" is used by default.

  A "pipe:" command must accept data on stdin and return the
  transformed data on stdout.

  Pipe example:

    # uncompress gzip files on checkin to improve delta compression
    # note: not necessarily a good idea, just an example
    *.gz = pipe: gunzip

    # recompress gzip files when writing them to the working dir (we
    # can safely omit "pipe:", because it's the default)
    *.gz = gzip

  A "tempfile:" command is a template.  The string INFILE is replaced
  with the name of a temporary file that contains the data to be
  filtered by the command.  The string OUTFILE is replaced with the
  name of an empty temporary file, where the filtered data must be
  written by the command.

  NOTE: the tempfile mechanism is recommended for Windows systems,
  where the standard shell I/O redirection operators often have
  strange effects.  In particular, if you are doing line ending
  conversion on Windows using the popular dos2unix and unix2dos
  programs, you *must* use the tempfile mechanism, as using pipes will
  corrupt the contents of your files.

  Tempfile example:

    # convert files to unix line ending conventions on checkin
    **.txt = tempfile: dos2unix -n INFILE OUTFILE

    # convert files to windows line ending conventions when writing
    # them to the working dir
    **.txt = tempfile: unix2dos -n INFILE OUTFILE

  Commands that get automatically executed by various actions such as
  starting or finishing a commit. Multiple commands 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.

  Example .hg/hgrc:

    # do not use the site-wide hook
    commit = = /my/email/hook
    commit.autobuild = /my/build/hook

    Run after a changegroup has been added via push or pull. Passed
    the ID of the first new changeset in $NODE.
    Run after a changeset has been created or for each changeset
    pulled. Passed the ID of the newly created changeset in
    environment variable $NODE.
    Run before starting a commit.  Exit status 0 allows the commit to
    proceed.  Non-zero status will cause the commit to fail.

  Used to access web-based Mercurial repositories through a HTTP
    Host name and (optional) port of the proxy server, for example
    Optional.  Comma-separated list of host names that should bypass
    the proxy.
    Optional.  Password to authenticate with at the proxy server.
    Optional.  User name to authenticate with at the proxy server.

  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.

  User interface controls.
    Print debugging information.  True or False.  Default is False.
    The editor to use during a commit.  Default is $EDITOR or "vi".
    Allow to prompt the user.  True or False.  Default is True.
    The conflict resolution program to use during a manual merge.
    Default is "hgmerge".
    Reduce the amount of output printed.  True or False.  Default is False.
    remote command to use for clone/push/pull operations. Default is 'hg'.
    command to use for SSH connections. Default is 'ssh'.
    The committer of a changeset created when running "commit".
    Typically a person's name and email address, e.g. "Fred Widget
    <>".  Default is $EMAIL or username@hostname.
    Increase the amount of output printed.  True or False.  Default is False.

  Web interface configuration.
    Where to output the access log. Default is stdout.
    Interface address to bind to. Default is all.
    Whether to allow .tar.bz2 downloading of repo revisions. Default is false.
    Whether to allow .tar.gz downloading of repo revisions. Default is false.
    Whether to allow pulling from the repository. Default is true.
    Whether to allow .zip downloading of repo revisions. Default is false.
    This feature creates temporary files.
    Textual description of the repository's purpose or contents.
    Default is "unknown".
    Where to output the error log. Default is stderr.
    Whether to use IPv6. Default is false.
    Repository name to use in the web interface. Default is current
    working directory.
    Maximum number of changes to list on the changelog. Default is 10.
    Maximum number of files to list per changeset. Default is 10.
    Port to listen on. Default is 8000.
    Which template map style to use.
    Where to find the HTML templates. Default is install path.

Bryan O'Sullivan <>.

Mercurial was written by Matt Mackall <>.


This manual page is copyright 2005 Bryan O'Sullivan.
Mercurial is copyright 2005 Matt Mackall.
Free use of this software is granted under the terms of the GNU General
Public License (GPL).