annotate doc/hgrc.5.txt @ 1171:a425bb927ede

Sort items in each hgrc section.  Add web/description.

HGRC(5)
=======
Bryan O'Sullivan <[e-mail]>

NAME
----
hgrc - configuration files for Mercurial

SYNOPSIS
--------

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

FILES
-----

Mercurial reads configuration data from three files:

/etc/mercurial/hgrc::
    Options in this global configuration file apply to all Mercurial
    commands executed by any user in any directory.

$HOME/.hgrc::
    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.

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

SYNTAX
------

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

    [spam]
    eggs=ham
    green=
       eggs

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

SECTIONS
--------

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.

hooks::
  Commands that get automatically executed by various actions such as
  starting or finishing a commit.
  changegroup;;
    Run after a changegroup has been added via push or pull.
  commit;;
    Run after a changeset has been created. Passed the ID of the newly
    created changeset.
  precommit;;
    Run before starting a commit.  Exit status 0 allows the commit to
    proceed.  Non-zero status will cause the commit to fail.

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

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

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


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


AUTHOR
------
Bryan O'Sullivan <[e-mail]>.

Mercurial was written by Matt Mackall <[e-mail]>.

SEE ALSO
--------
hg(1)

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