comparison doc/hgrc.5.txt @ 8782:d19ab9a56bf4

doc: wrap man pages after fixing quoting

8781:385a2d94885e

FILES
-----

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.

(Unix) `<install-root>/etc/mercurial/hgrc.d/*.rc`::
(Unix) `<install-root>/etc/mercurial/hgrc`::
    Per-installation configuration files, searched for in the
    directory where Mercurial is installed. `<install-root>` is the

(Windows) `C:\Mercurial\Mercurial.ini`::
    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.

(Unix) `$HOME/.hgrc`::
(Windows) `%HOME%\Mercurial.ini`::
(Windows) `%HOME%\.hgrc`::
(Windows) `%USERPROFILE%\Mercurial.ini`::
(Windows) `%USERPROFILE%\.hgrc`::
    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 these files override
    per-installation and per-system options.

(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. Options in

creates a new command `latest` that shows only the five most recent
changesets. You can define subsequent aliases using earlier ones:

    stable5 = latest -b stable

NOTE: It is possible to create aliases with the same names as
existing commands, which will then override the original definitions.
This is almost always a bad idea!
--

[[auth]]
auth::
Authentication credentials for HTTP authentication. Each line has

    foo.schemes = http https

Supported arguments:

  prefix;;
    Either "++\*++" or a URI prefix with or without the scheme part. The
    authentication entry with the longest matching prefix is used
    (where "++*++" matches everything and counts as a match of length 1).
    If the prefix doesn't include a scheme, the match is performed
    against the URI with its scheme stripped as well, and the schemes
    argument, q.v., is then subsequently consulted.
  username;;
    Username to authenticate with.
  password;;

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

  [encode]
  # uncompress gzip files on checkin to improve delta compression

  # 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 and may corrupt the contents of your files.

The most common usage is for LF <-> CRLF translation on Windows. For
this, use the "smart" converters which check for binary files:

  [extensions]

    remote command to use for clone/push/pull operations. Default is 'hg'.
  report_untrusted;;
    Warn if a `.hg/hgrc` file is ignored due to not being owned by a
    trusted user or group. True or False. Default is True.
  slash;;
    Display paths using a slash ("++/++") as the path separator. This only
    makes a difference on systems where the default path separator is
    not the slash character (e.g. Windows uses the backslash character
    ("++\++")).
    Default is False.
  ssh;;
    command to use for SSH connections. Default is 'ssh'.
  strict;;
    Require exact command names, instead of allowing unambiguous

8782:d19ab9a56bf4

FILES
-----

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.

(Unix) `<install-root>/etc/mercurial/hgrc.d/*.rc`::
(Unix) `<install-root>/etc/mercurial/hgrc`::
    Per-installation configuration files, searched for in the
    directory where Mercurial is installed. `<install-root>` is the

(Windows) `C:\Mercurial\Mercurial.ini`::
    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.

(Unix) `$HOME/.hgrc`::
(Windows) `%HOME%\Mercurial.ini`::
(Windows) `%HOME%\.hgrc`::
(Windows) `%USERPROFILE%\Mercurial.ini`::
(Windows) `%USERPROFILE%\.hgrc`::
    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 these files override per-installation and
    per-system options.

(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. Options in

creates a new command `latest` that shows only the five most recent
changesets. You can define subsequent aliases using earlier ones:

    stable5 = latest -b stable

NOTE: It is possible to create aliases with the same names as existing
commands, which will then override the original definitions. This is
almost always a bad idea!
--

[[auth]]
auth::
Authentication credentials for HTTP authentication. Each line has

    foo.schemes = http https

Supported arguments:

  prefix;;
    Either "++\*++" or a URI prefix with or without the scheme part.
    The authentication entry with the longest matching prefix is used
    (where "++*++" matches everything and counts as a match of length
    1). If the prefix doesn't include a scheme, the match is performed
    against the URI with its scheme stripped as well, and the schemes
    argument, q.v., is then subsequently consulted.
  username;;
    Username to authenticate with.
  password;;

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

  [encode]
  # uncompress gzip files on checkin to improve delta compression

  # 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 and may corrupt the contents of your files.

The most common usage is for LF <-> CRLF translation on Windows. For
this, use the "smart" converters which check for binary files:

  [extensions]

    remote command to use for clone/push/pull operations. Default is 'hg'.
  report_untrusted;;
    Warn if a `.hg/hgrc` file is ignored due to not being owned by a
    trusted user or group. True or False. Default is True.
  slash;;
    Display paths using a slash ("++/++") as the path separator. This
    only makes a difference on systems where the default path
    separator is not the slash character (e.g. Windows uses the
    backslash character ("++\++")).
    Default is False.
  ssh;;
    command to use for SSH connections. Default is 'ssh'.
  strict;;
    Require exact command names, instead of allowing unambiguous