Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/help/config.txt @ 20333:fa6cb300ded4 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
help: improve description of phases.checksubrepos setting The existing description was a bit hard to understand.
author Angel Ezquerra <angel.ezquerra@gmail.com>
date Wed, 29 Jan 2014 15:16:36 +0100
parents 4c96c50ef937
children 4e41b2fe46cc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
1 The Mercurial system uses a set of configuration files to control
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
2 aspects of its behavior.
9785
b52f0f221325 help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
3
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
4 The configuration files use a simple ini-file format. A configuration
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
5 file consists of sections, led by a ``[section]`` header and followed
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
6 by ``name = value`` entries::
9785
b52f0f221325 help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
7
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
8 [ui]
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
9 username = Firstname Lastname <firstname.lastname@example.net>
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
10 verbose = True
9785
b52f0f221325 help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
11
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
12 The above entries will be referred to as ``ui.username`` and
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
13 ``ui.verbose``, respectively. See the Syntax section below.
9785
b52f0f221325 help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
14
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
15 Files
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
16 =====
9785
b52f0f221325 help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
17
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
18 Mercurial reads configuration data from several files, if they exist.
13955
86b5cc1e8be8 help config: explain that config files do not exist by default
Martin Geisler <mg@lazybytes.net>
parents: 11408
diff changeset
19 These files do not exist by default and you will have to create the
86b5cc1e8be8 help config: explain that config files do not exist by default
Martin Geisler <mg@lazybytes.net>
parents: 11408
diff changeset
20 appropriate configuration files yourself: global configuration like
86b5cc1e8be8 help config: explain that config files do not exist by default
Martin Geisler <mg@lazybytes.net>
parents: 11408
diff changeset
21 the username setting is typically put into
86b5cc1e8be8 help config: explain that config files do not exist by default
Martin Geisler <mg@lazybytes.net>
parents: 11408
diff changeset
22 ``%USERPROFILE%\mercurial.ini`` or ``$HOME/.hgrc`` and local
86b5cc1e8be8 help config: explain that config files do not exist by default
Martin Geisler <mg@lazybytes.net>
parents: 11408
diff changeset
23 configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
86b5cc1e8be8 help config: explain that config files do not exist by default
Martin Geisler <mg@lazybytes.net>
parents: 11408
diff changeset
24
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
25 The names of these files depend on the system on which Mercurial is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
26 installed. ``*.rc`` files from a single directory are read in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
27 alphabetical order, later ones overriding earlier ones. Where multiple
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
28 paths are given below, settings from earlier paths override later
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
29 ones.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
30
16383
f5dd179bfa4a plan9: initial support for plan 9 from bell labs
Steven Stallion <sstallion@gmail.com>
parents: 16361
diff changeset
31 | (All) ``<repo>/.hg/hgrc``
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
32
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
33 Per-repository configuration options that only apply in a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
34 particular repository. This file is not version-controlled, and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
35 will not get transferred during a "clone" operation. Options in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
36 this file override options in all other configuration files. On
16383
f5dd179bfa4a plan9: initial support for plan 9 from bell labs
Steven Stallion <sstallion@gmail.com>
parents: 16361
diff changeset
37 Plan 9 and Unix, most of this file will be ignored if it doesn't
f5dd179bfa4a plan9: initial support for plan 9 from bell labs
Steven Stallion <sstallion@gmail.com>
parents: 16361
diff changeset
38 belong to a trusted user or to a trusted group. See the documentation
f5dd179bfa4a plan9: initial support for plan 9 from bell labs
Steven Stallion <sstallion@gmail.com>
parents: 16361
diff changeset
39 for the ``[trusted]`` section below for more details.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
40
16383
f5dd179bfa4a plan9: initial support for plan 9 from bell labs
Steven Stallion <sstallion@gmail.com>
parents: 16361
diff changeset
41 | (Plan 9) ``$home/lib/hgrc``
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
42 | (Unix) ``$HOME/.hgrc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
43 | (Windows) ``%USERPROFILE%\.hgrc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
44 | (Windows) ``%USERPROFILE%\Mercurial.ini``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
45 | (Windows) ``%HOME%\.hgrc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
46 | (Windows) ``%HOME%\Mercurial.ini``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
47
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
48 Per-user configuration file(s), for the user running Mercurial. On
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
49 Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
50 files apply to all Mercurial commands executed by this user in any
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
51 directory. Options in these files override per-system and per-installation
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
52 options.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
53
16383
f5dd179bfa4a plan9: initial support for plan 9 from bell labs
Steven Stallion <sstallion@gmail.com>
parents: 16361
diff changeset
54 | (Plan 9) ``/lib/mercurial/hgrc``
f5dd179bfa4a plan9: initial support for plan 9 from bell labs
Steven Stallion <sstallion@gmail.com>
parents: 16361
diff changeset
55 | (Plan 9) ``/lib/mercurial/hgrc.d/*.rc``
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
56 | (Unix) ``/etc/mercurial/hgrc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
57 | (Unix) ``/etc/mercurial/hgrc.d/*.rc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
58
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
59 Per-system configuration files, for the system on which Mercurial
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
60 is running. Options in these files apply to all Mercurial commands
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
61 executed by any user in any directory. Options in these files
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
62 override per-installation options.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
63
16383
f5dd179bfa4a plan9: initial support for plan 9 from bell labs
Steven Stallion <sstallion@gmail.com>
parents: 16361
diff changeset
64 | (Plan 9) ``<install-root>/lib/mercurial/hgrc``
f5dd179bfa4a plan9: initial support for plan 9 from bell labs
Steven Stallion <sstallion@gmail.com>
parents: 16361
diff changeset
65 | (Plan 9) ``<install-root>/lib/mercurial/hgrc.d/*.rc``
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
66 | (Unix) ``<install-root>/etc/mercurial/hgrc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
67 | (Unix) ``<install-root>/etc/mercurial/hgrc.d/*.rc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
68
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
69 Per-installation configuration files, searched for in the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
70 directory where Mercurial is installed. ``<install-root>`` is the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
71 parent directory of the **hg** executable (or symlink) being run. For
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
72 example, if installed in ``/shared/tools/bin/hg``, Mercurial will look
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
73 in ``/shared/tools/etc/mercurial/hgrc``. Options in these files apply
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
74 to all Mercurial commands executed by any user in any directory.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
75
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
76 | (Windows) ``<install-dir>\Mercurial.ini`` **or**
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
77 | (Windows) ``<install-dir>\hgrc.d\*.rc`` **or**
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
78 | (Windows) ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
79
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
80 Per-installation/system configuration files, for the system on
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
81 which Mercurial is running. Options in these files apply to all
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
82 Mercurial commands executed by any user in any directory. Registry
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
83 keys contain PATH-like strings, every part of which must reference
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
84 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
85 be read. Mercurial checks each of these locations in the specified
16585
0c35bb01a119 help/config: remove outdated false claim about pywin32
Adrian Buehlmann <adrian@cadifra.com>
parents: 16570
diff changeset
86 order until one or more configuration files are detected.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
87
19183
9d88916fb56f help/config: note 64-bit Windows registry key used with 32-bit Python
Mike Williams <mrw@eandem.co.uk>
parents: 19050
diff changeset
88 .. note:: The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
9d88916fb56f help/config: note 64-bit Windows registry key used with 32-bit Python
Mike Williams <mrw@eandem.co.uk>
parents: 19050
diff changeset
89 is used when running 32-bit Python on 64-bit Windows.
9d88916fb56f help/config: note 64-bit Windows registry key used with 32-bit Python
Mike Williams <mrw@eandem.co.uk>
parents: 19050
diff changeset
90
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
91 Syntax
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
92 ======
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
93
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
94 A configuration file consists of sections, led by a ``[section]`` header
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
95 and followed by ``name = value`` entries (sometimes called
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
96 ``configuration keys``)::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
97
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
98 [spam]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
99 eggs=ham
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
100 green=
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
101 eggs
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
102
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
103 Each line contains one entry. If the lines that follow are indented,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
104 they are treated as continuations of that entry. Leading whitespace is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
105 removed from values. Empty lines are skipped. Lines beginning with
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
106 ``#`` or ``;`` are ignored and may be used to provide comments.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
107
14651
e9e4e9ab62bd help/config: fix 'Mercurial' casing
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14460
diff changeset
108 Configuration keys can be set multiple times, in which case Mercurial
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
109 will use the value that was configured last. As an example::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
110
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
111 [spam]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
112 eggs=large
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
113 ham=serrano
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
114 eggs=small
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
115
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
116 This would set the configuration key named ``eggs`` to ``small``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
117
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
118 It is also possible to define a section multiple times. A section can
14652
73cb35f6fd78 help/config: do not refer to config files as hgrc files
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14651
diff changeset
119 be redefined on the same and/or on different configuration files. For
73cb35f6fd78 help/config: do not refer to config files as hgrc files
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14651
diff changeset
120 example::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
121
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
122 [foo]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
123 eggs=large
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
124 ham=serrano
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
125 eggs=small
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
126
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
127 [bar]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
128 eggs=ham
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
129 green=
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
130 eggs
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
131
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
132 [foo]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
133 ham=prosciutto
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
134 eggs=medium
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
135 bread=toasted
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
136
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
137 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
138 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
139 respectively. As you can see there only thing that matters is the last
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
140 value that was set for each of the configuration keys.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
141
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
142 If a configuration key is set multiple times in different
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
143 configuration files the final value will depend on the order in which
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
144 the different configuration files are read, with settings from earlier
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
145 paths overriding later ones as described on the ``Files`` section
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
146 above.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
147
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
148 A line of the form ``%include file`` will include ``file`` into the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
149 current configuration file. The inclusion is recursive, which means
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
150 that included files can include other files. Filenames are relative to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
151 the configuration file in which the ``%include`` directive is found.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
152 Environment variables and ``~user`` constructs are expanded in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
153 ``file``. This lets you do something like::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
154
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
155 %include ~/.hgrc.d/$HOST.rc
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
156
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
157 to include a different configuration file on each computer you use.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
158
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
159 A line with ``%unset name`` will remove ``name`` from the current
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
160 section, if it has been set previously.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
161
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
162 The values are either free-form text strings, lists of text strings,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
163 or Boolean values. Boolean values can be set to true using any of "1",
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
164 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
165 (all case insensitive).
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
166
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
167 List values are separated by whitespace or comma, except when values are
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
168 placed in double quotation marks::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
169
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
170 allow_read = "John Doe, PhD", brian, betty
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
171
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
172 Quotation marks can be escaped by prefixing them with a backslash. Only
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
173 quotation marks at the beginning of a word is counted as a quotation
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
174 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
175
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
176 Sections
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
177 ========
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
178
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
179 This section describes the different sections that may appear in a
14652
73cb35f6fd78 help/config: do not refer to config files as hgrc files
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14651
diff changeset
180 Mercurial configuration file, the purpose of each section, its possible
73cb35f6fd78 help/config: do not refer to config files as hgrc files
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14651
diff changeset
181 keys, and their possible values.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
182
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
183 ``alias``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
184 ---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
185
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
186 Defines command aliases.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
187 Aliases allow you to define your own commands in terms of other
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
188 commands (or aliases), optionally including arguments. Positional
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
189 arguments in the form of ``$1``, ``$2``, etc in the alias definition
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
190 are expanded by Mercurial before execution. Positional arguments not
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
191 already used by ``$N`` in the definition are put at the end of the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
192 command to be executed.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
193
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
194 Alias definitions consist of lines of the form::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
195
14653
6f96c7a908bd help/config: fix small typo
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14652
diff changeset
196 <alias> = <command> [<argument>]...
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
197
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
198 For example, this definition::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
199
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
200 latest = log --limit 5
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
201
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
202 creates a new command ``latest`` that shows only the five most recent
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
203 changesets. You can define subsequent aliases using earlier ones::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
204
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
205 stable5 = latest -b stable
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
206
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
207 .. note:: It is possible to create aliases with the same names as
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
208 existing commands, which will then override the original
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
209 definitions. This is almost always a bad idea!
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
210
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
211 An alias can start with an exclamation point (``!``) to make it a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
212 shell alias. A shell alias is executed with the shell and will let you
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
213 run arbitrary commands. As an example, ::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
214
16513
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
215 echo = !echo $@
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
216
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
217 will let you do ``hg echo foo`` to have ``foo`` printed in your
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
218 terminal. A better example might be::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
219
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
220 purge = !$HG status --no-status --unknown -0 | xargs -0 rm
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
221
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
222 which will make ``hg purge`` delete all unknown files in the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
223 repository in the same manner as the purge extension.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
224
16513
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
225 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
226 expand to the command arguments. Unmatched arguments are
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
227 removed. ``$0`` expands to the alias name and ``$@`` expands to all
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
228 arguments separated by a space. These expansions happen before the
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
229 command is passed to the shell.
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
230
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
231 Shell aliases are executed in an environment where ``$HG`` expands to
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
232 the path of the Mercurial that was used to execute the alias. This is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
233 useful when you want to call further Mercurial commands in a shell
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
234 alias, as was done above for the purge alias. In addition,
16513
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
235 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
236 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
237
14891
62122c1c830b alias: note interaction of shell aliases with early opts in help
Matt Mackall <mpm@selenic.com>
parents: 14691
diff changeset
238 .. note:: Some global configuration options such as ``-R`` are
62122c1c830b alias: note interaction of shell aliases with early opts in help
Matt Mackall <mpm@selenic.com>
parents: 14691
diff changeset
239 processed before shell aliases and will thus not be passed to
62122c1c830b alias: note interaction of shell aliases with early opts in help
Matt Mackall <mpm@selenic.com>
parents: 14691
diff changeset
240 aliases.
62122c1c830b alias: note interaction of shell aliases with early opts in help
Matt Mackall <mpm@selenic.com>
parents: 14691
diff changeset
241
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
242
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
243 ``annotate``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
244 ------------
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
245
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
246 Settings used when displaying file annotations. All values are
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
247 Booleans and default to False. See ``diff`` section for related
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
248 options for the diff command.
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
249
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
250 ``ignorews``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
251 Ignore white space when comparing lines.
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
252
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
253 ``ignorewsamount``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
254 Ignore changes in the amount of white space.
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
255
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
256 ``ignoreblanklines``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
257 Ignore changes whose lines are all blank.
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
258
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
259
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
260 ``auth``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
261 --------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
262
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
263 Authentication credentials for HTTP authentication. This section
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
264 allows you to store usernames and passwords for use when logging
14654
e21fd445c297 help/config: quote config section names consistently
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14653
diff changeset
265 *into* HTTP servers. See the ``[web]`` configuration section if
e21fd445c297 help/config: quote config section names consistently
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14653
diff changeset
266 you want to configure *who* can login to your HTTP server.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
267
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
268 Each line has the following format::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
269
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
270 <name>.<argument> = <value>
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
271
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
272 where ``<name>`` is used to group arguments into authentication
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
273 entries. Example::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
274
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
275 foo.prefix = hg.intevation.org/mercurial
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
276 foo.username = foo
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
277 foo.password = bar
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
278 foo.schemes = http https
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
279
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
280 bar.prefix = secure.example.org
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
281 bar.key = path/to/file.key
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
282 bar.cert = path/to/file.cert
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
283 bar.schemes = https
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
284
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
285 Supported arguments:
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
286
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
287 ``prefix``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
288 Either ``*`` or a URI prefix with or without the scheme part.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
289 The authentication entry with the longest matching prefix is used
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
290 (where ``*`` matches everything and counts as a match of length
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
291 1). If the prefix doesn't include a scheme, the match is performed
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
292 against the URI with its scheme stripped as well, and the schemes
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
293 argument, q.v., is then subsequently consulted.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
294
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
295 ``username``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
296 Optional. Username to authenticate with. If not given, and the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
297 remote site requires basic or digest authentication, the user will
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
298 be prompted for it. Environment variables are expanded in the
15005
4a43e23b8c55 hgweb: do not ignore [auth] if url has a username (issue2822)
Patrick Mezard <pmezard@gmail.com>
parents: 15004
diff changeset
299 username letting you do ``foo.username = $USER``. If the URI
4a43e23b8c55 hgweb: do not ignore [auth] if url has a username (issue2822)
Patrick Mezard <pmezard@gmail.com>
parents: 15004
diff changeset
300 includes a username, only ``[auth]`` entries with a matching
4a43e23b8c55 hgweb: do not ignore [auth] if url has a username (issue2822)
Patrick Mezard <pmezard@gmail.com>
parents: 15004
diff changeset
301 username or without a username will be considered.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
302
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
303 ``password``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
304 Optional. Password to authenticate with. If not given, and the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
305 remote site requires basic or digest authentication, the user
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
306 will be prompted for it.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
307
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
308 ``key``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
309 Optional. PEM encoded client certificate key file. Environment
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
310 variables are expanded in the filename.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
311
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
312 ``cert``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
313 Optional. PEM encoded client certificate chain file. Environment
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
314 variables are expanded in the filename.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
315
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
316 ``schemes``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
317 Optional. Space separated list of URI schemes to use this
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
318 authentication entry with. Only used if the prefix doesn't include
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
319 a scheme. Supported schemes are http and https. They will match
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
320 static-http and static-https respectively, as well.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
321 Default: https.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
322
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
323 If no suitable authentication entry is found, the user is prompted
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
324 for credentials as usual if required by the remote.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
325
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
326
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
327 ``decode/encode``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
328 -----------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
329
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
330 Filters for transforming files on checkout/checkin. This would
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
331 typically be used for newline processing or other
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
332 localization/canonicalization of files.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
333
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
334 Filters consist of a filter pattern followed by a filter command.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
335 Filter patterns are globs by default, rooted at the repository root.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
336 For example, to match any file ending in ``.txt`` in the root
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
337 directory only, use the pattern ``*.txt``. To match any file ending
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
338 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
339 For each file only the first matching filter applies.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
340
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
341 The filter command can start with a specifier, either ``pipe:`` or
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
342 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
343
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
344 A ``pipe:`` command must accept data on stdin and return the transformed
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
345 data on stdout.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
346
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
347 Pipe example::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
348
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
349 [encode]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
350 # uncompress gzip files on checkin to improve delta compression
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
351 # note: not necessarily a good idea, just an example
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
352 *.gz = pipe: gunzip
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
353
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
354 [decode]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
355 # recompress gzip files when writing them to the working dir (we
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
356 # can safely omit "pipe:", because it's the default)
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
357 *.gz = gzip
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
358
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
359 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
360 with the name of a temporary file that contains the data to be
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
361 filtered by the command. The string ``OUTFILE`` is replaced with the name
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
362 of an empty temporary file, where the filtered data must be written by
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
363 the command.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
364
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
365 .. note:: The tempfile mechanism is recommended for Windows systems,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
366 where the standard shell I/O redirection operators often have
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
367 strange effects and may corrupt the contents of your files.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
368
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
369 This filter mechanism is used internally by the ``eol`` extension to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
370 translate line ending characters between Windows (CRLF) and Unix (LF)
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
371 format. We suggest you use the ``eol`` extension for convenience.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
372
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
373
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
374 ``defaults``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
375 ------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
376
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
377 (defaults are deprecated. Don't use them. Use aliases instead)
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
378
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
379 Use the ``[defaults]`` section to define command defaults, i.e. the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
380 default options/arguments to pass to the specified commands.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
381
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
382 The following example makes :hg:`log` run in verbose mode, and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
383 :hg:`status` show only the modified files, by default::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
384
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
385 [defaults]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
386 log = -v
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
387 status = -m
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
388
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
389 The actual commands, instead of their aliases, must be used when
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
390 defining command defaults. The command defaults will also be applied
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
391 to the aliases of the commands defined.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
392
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
393
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
394 ``diff``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
395 --------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
396
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
397 Settings used when displaying diffs. Everything except for ``unified``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
398 is a Boolean and defaults to False. See ``annotate`` section for
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
399 related options for the annotate command.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
400
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
401 ``git``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
402 Use git extended diff format.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
403
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
404 ``nodates``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
405 Don't include dates in diff headers.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
406
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
407 ``showfunc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
408 Show which function each change is in.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
409
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
410 ``ignorews``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
411 Ignore white space when comparing lines.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
412
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
413 ``ignorewsamount``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
414 Ignore changes in the amount of white space.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
415
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
416 ``ignoreblanklines``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
417 Ignore changes whose lines are all blank.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
418
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
419 ``unified``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
420 Number of lines of context to show.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
421
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
422 ``email``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
423 ---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
424
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
425 Settings for extensions that send email messages.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
426
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
427 ``from``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
428 Optional. Email address to use in "From" header and SMTP envelope
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
429 of outgoing messages.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
430
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
431 ``to``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
432 Optional. Comma-separated list of recipients' email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
433
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
434 ``cc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
435 Optional. Comma-separated list of carbon copy recipients'
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
436 email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
437
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
438 ``bcc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
439 Optional. Comma-separated list of blind carbon copy recipients'
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
440 email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
441
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
442 ``method``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
443 Optional. Method to use to send email messages. If value is ``smtp``
14654
e21fd445c297 help/config: quote config section names consistently
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14653
diff changeset
444 (default), use SMTP (see the ``[smtp]`` section for configuration).
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
445 Otherwise, use as name of program to run that acts like sendmail
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
446 (takes ``-f`` option for sender, list of recipients on command line,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
447 message on stdin). Normally, setting this to ``sendmail`` or
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
448 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
449
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
450 ``charsets``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
451 Optional. Comma-separated list of character sets considered
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
452 convenient for recipients. Addresses, headers, and parts not
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
453 containing patches of outgoing messages will be encoded in the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
454 first character set to which conversion from local encoding
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
455 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
456 conversion fails, the text in question is sent as is. Defaults to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
457 empty (explicit) list.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
458
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
459 Order of outgoing email character sets:
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
460
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
461 1. ``us-ascii``: always first, regardless of settings
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
462 2. ``email.charsets``: in order given by user
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
463 3. ``ui.fallbackencoding``: if not in email.charsets
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
464 4. ``$HGENCODING``: if not in email.charsets
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
465 5. ``utf-8``: always last, regardless of settings
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
466
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
467 Email example::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
468
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
469 [email]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
470 from = Joseph User <joe.user@example.com>
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
471 method = /usr/sbin/sendmail
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
472 # charsets for western Europeans
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
473 # us-ascii, utf-8 omitted, as they are tried first and last
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
474 charsets = iso-8859-1, iso-8859-15, windows-1252
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
475
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
476
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
477 ``extensions``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
478 --------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
479
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
480 Mercurial has an extension mechanism for adding new features. To
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
481 enable an extension, create an entry for it in this section.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
482
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
483 If you know that the extension is already in Python's search path,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
484 you can give the name of the module, followed by ``=``, with nothing
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
485 after the ``=``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
486
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
487 Otherwise, give a name that you choose, followed by ``=``, followed by
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
488 the path to the ``.py`` file (including the file name extension) that
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
489 defines the extension.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
490
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
491 To explicitly disable an extension that is enabled in an hgrc of
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
492 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
493 or ``foo = !`` when path is not supplied.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
494
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
495 Example for ``~/.hgrc``::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
496
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
497 [extensions]
20142
14e283c99908 help: use progress instead of mq as in 'hg help config' example
Matt Mackall <mpm@selenic.com>
parents: 19183
diff changeset
498 # (the progress extension will get loaded from Mercurial's path)
14e283c99908 help: use progress instead of mq as in 'hg help config' example
Matt Mackall <mpm@selenic.com>
parents: 19183
diff changeset
499 progress =
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
500 # (this extension will get loaded from the file specified)
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
501 myfeature = ~/.hgext/myfeature.py
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
502
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
503
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
504 ``format``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
505 ----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
506
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
507 ``usestore``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
508 Enable or disable the "store" repository format which improves
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
509 compatibility with systems that fold case or otherwise mangle
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
510 filenames. Enabled by default. Disabling this option will allow
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
511 you to store longer filenames in some situations at the expense of
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
512 compatibility and ensures that the on-disk format of newly created
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
513 repositories will be compatible with Mercurial before version 0.9.4.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
514
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
515 ``usefncache``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
516 Enable or disable the "fncache" repository format which enhances
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
517 the "store" repository format (which has to be enabled to use
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
518 fncache) to allow longer filenames and avoids using Windows
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
519 reserved names, e.g. "nul". Enabled by default. Disabling this
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
520 option ensures that the on-disk format of newly created
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
521 repositories will be compatible with Mercurial before version 1.1.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
522
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
523 ``dotencode``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
524 Enable or disable the "dotencode" repository format which enhances
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
525 the "fncache" repository format (which has to be enabled to use
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
526 dotencode) to avoid issues with filenames starting with ._ on
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
527 Mac OS X and spaces on Windows. Enabled by default. Disabling this
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
528 option ensures that the on-disk format of newly created
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
529 repositories will be compatible with Mercurial before version 1.7.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
530
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
531 ``graph``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
532 ---------
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
533
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
534 Web graph view configuration. This section let you change graph
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
535 elements display properties by branches, for instance to make the
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
536 ``default`` branch stand out.
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
537
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
538 Each line has the following format::
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
539
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
540 <branch>.<argument> = <value>
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
541
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
542 where ``<branch>`` is the name of the branch being
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
543 customized. Example::
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
544
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
545 [graph]
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
546 # 2px width
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
547 default.width = 2
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
548 # red color
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
549 default.color = FF0000
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
550
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
551 Supported arguments:
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
552
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
553 ``width``
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
554 Set branch edges width in pixels.
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
555
16130
33f702e52906 graph: in hgrc specify line color for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16129
diff changeset
556 ``color``
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
557 Set branch edges color in hexadecimal RGB notation.
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
558
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
559 ``hooks``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
560 ---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
561
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
562 Commands or Python functions that get automatically executed by
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
563 various actions such as starting or finishing a commit. Multiple
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
564 hooks can be run for the same action by appending a suffix to the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
565 action. Overriding a site-wide hook can be done by changing its
15896
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
566 value or setting it to an empty string. Hooks can be prioritized
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
567 by adding a prefix of ``priority`` to the hook name on a new line
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
568 and setting the priority. The default priority is 0 if
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
569 not specified.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
570
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
571 Example ``.hg/hgrc``::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
572
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
573 [hooks]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
574 # update working directory after adding changesets
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
575 changegroup.update = hg update
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
576 # do not use the site-wide hook
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
577 incoming =
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
578 incoming.email = /my/email/hook
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
579 incoming.autobuild = /my/build/hook
15896
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
580 # force autobuild hook to run before other incoming hooks
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
581 priority.incoming.autobuild = 1
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
582
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
583 Most hooks are run with environment variables set that give useful
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
584 additional information. For each hook below, the environment
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
585 variables it is passed are listed with names of the form ``$HG_foo``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
586
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
587 ``changegroup``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
588 Run after a changegroup has been added via push, pull or unbundle.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
589 ID of the first new changeset is in ``$HG_NODE``. URL from which
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
590 changes came is in ``$HG_URL``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
591
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
592 ``commit``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
593 Run after a changeset has been created in the local repository. ID
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
594 of the newly created changeset is in ``$HG_NODE``. Parent changeset
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
595 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
596
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
597 ``incoming``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
598 Run after a changeset has been pulled, pushed, or unbundled into
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
599 the local repository. The ID of the newly arrived changeset is in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
600 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
601
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
602 ``outgoing``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
603 Run after sending changes from local repository to another. ID of
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
604 first changeset sent is in ``$HG_NODE``. Source of operation is in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
605 ``$HG_SOURCE``; see "preoutgoing" hook for description.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
606
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
607 ``post-<command>``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
608 Run after successful invocations of the associated command. The
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
609 contents of the command line are passed as ``$HG_ARGS`` and the result
17680
16ec37411db5 help: removing trailing spaces
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17424
diff changeset
610 code in ``$HG_RESULT``. Parsed command line arguments are passed as
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
611 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
17680
16ec37411db5 help: removing trailing spaces
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17424
diff changeset
612 the python data internally passed to <command>. ``$HG_OPTS`` is a
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
613 dictionary of options (with unspecified options set to their defaults).
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
614 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
615
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
616 ``pre-<command>``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
617 Run before executing the associated command. The contents of the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
618 command line are passed as ``$HG_ARGS``. Parsed command line arguments
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
619 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
620 representations of the data internally passed to <command>. ``$HG_OPTS``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
621 is a dictionary of options (with unspecified options set to their
17680
16ec37411db5 help: removing trailing spaces
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17424
diff changeset
622 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
623 failure, the command doesn't execute and Mercurial returns the failure
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
624 code.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
625
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
626 ``prechangegroup``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
627 Run before a changegroup is added via push, pull or unbundle. Exit
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
628 status 0 allows the changegroup to proceed. Non-zero status will
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
629 cause the push, pull or unbundle to fail. URL from which changes
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
630 will come is in ``$HG_URL``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
631
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
632 ``precommit``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
633 Run before starting a local commit. Exit status 0 allows the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
634 commit to proceed. Non-zero status will cause the commit to fail.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
635 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
636
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
637 ``prelistkeys``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
638 Run before listing pushkeys (like bookmarks) in the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
639 repository. Non-zero status will cause failure. The key namespace is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
640 in ``$HG_NAMESPACE``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
641
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
642 ``preoutgoing``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
643 Run before collecting changes to send from the local repository to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
644 another. Non-zero status will cause failure. This lets you prevent
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
645 pull over HTTP or SSH. Also prevents against local pull, push
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
646 (outbound) or bundle commands, but not effective, since you can
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
647 just copy files instead then. Source of operation is in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
648 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
649 SSH or HTTP repository. If "push", "pull" or "bundle", operation
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
650 is happening on behalf of repository on same system.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
651
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
652 ``prepushkey``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
653 Run before a pushkey (like a bookmark) is added to the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
654 repository. Non-zero status will cause the key to be rejected. The
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
655 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
656 the old value (if any) is in ``$HG_OLD``, and the new value is in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
657 ``$HG_NEW``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
658
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
659 ``pretag``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
660 Run before creating a tag. Exit status 0 allows the tag to be
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
661 created. Non-zero status will cause the tag to fail. ID of
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
662 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
663 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
664
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
665 ``pretxnchangegroup``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
666 Run after a changegroup has been added via push, pull or unbundle,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
667 but before the transaction has been committed. Changegroup is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
668 visible to hook program. This lets you validate incoming changes
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
669 before accepting them. Passed the ID of the first new changeset in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
670 ``$HG_NODE``. Exit status 0 allows the transaction to commit. Non-zero
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
671 status will cause the transaction to be rolled back and the push,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
672 pull or unbundle will fail. URL that was source of changes is in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
673 ``$HG_URL``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
674
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
675 ``pretxncommit``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
676 Run after a changeset has been created but the transaction not yet
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
677 committed. Changeset is visible to hook program. This lets you
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
678 validate commit message and changes. Exit status 0 allows the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
679 commit to proceed. Non-zero status will cause the transaction to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
680 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
681 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
682
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
683 ``preupdate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
684 Run before updating the working directory. Exit status 0 allows
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
685 the update to proceed. Non-zero status will prevent the update.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
686 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
687 of second new parent is in ``$HG_PARENT2``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
688
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
689 ``listkeys``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
690 Run after listing pushkeys (like bookmarks) in the repository. The
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
691 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
692 dictionary containing the keys and values.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
693
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
694 ``pushkey``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
695 Run after a pushkey (like a bookmark) is added to the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
696 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
697 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
698 value is in ``$HG_NEW``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
699
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
700 ``tag``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
701 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
702 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
703 repository if ``$HG_LOCAL=0``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
704
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
705 ``update``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
706 Run after updating the working directory. Changeset ID of first
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
707 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
708 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
709 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
710
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
711 .. note:: It is generally better to use standard hooks rather than the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
712 generic pre- and post- command hooks as they are guaranteed to be
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
713 called in the appropriate contexts for influencing transactions.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
714 Also, hooks like "commit" will be called in all contexts that
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
715 generate a commit (e.g. tag) and not just the commit command.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
716
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
717 .. note:: Environment variables with empty values may not be passed to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
718 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
719 will have an empty value under Unix-like platforms for non-merge
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
720 changesets, while it will not be available at all under Windows.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
721
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
722 The syntax for Python hooks is as follows::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
723
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
724 hookname = python:modulename.submodule.callable
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
725 hookname = python:/path/to/python/module.py:callable
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
726
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
727 Python hooks are run within the Mercurial process. Each hook is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
728 called with at least three keyword arguments: a ui object (keyword
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
729 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
730 keyword that tells what kind of hook is used. Arguments listed as
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
731 environment variables above are passed as keyword arguments, with no
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
732 ``HG_`` prefix, and names in lower case.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
733
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
734 If a Python hook returns a "true" value or raises an exception, this
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
735 is treated as a failure.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
736
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
737
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
738 ``hostfingerprints``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
739 --------------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
740
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
741 Fingerprints of the certificates of known HTTPS servers.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
742 A HTTPS connection to a server with a fingerprint configured here will
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
743 only succeed if the servers certificate matches the fingerprint.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
744 This is very similar to how ssh known hosts works.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
745 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
746 The CA chain and web.cacerts is not used for servers with a fingerprint.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
747
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
748 For example::
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
749
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
750 [hostfingerprints]
18734
b72697653306 help: new SHA-1 fingerprint of hg.intevation.org in hostfingerprints example
Thomas Arendsen Hein <thomas@intevation.de>
parents: 18652
diff changeset
751 hg.intevation.org = 44:ed:af:1f:97:11:b6:01:7a:48:45:fc:10:3c:b7:f9:d4:89:2a:9d
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
752
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
753 This feature is only supported when using Python 2.6 or later.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
754
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
755
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
756 ``http_proxy``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
757 --------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
758
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
759 Used to access web-based Mercurial repositories through a HTTP
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
760 proxy.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
761
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
762 ``host``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
763 Host name and (optional) port of the proxy server, for example
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
764 "myproxy:8000".
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
765
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
766 ``no``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
767 Optional. Comma-separated list of host names that should bypass
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
768 the proxy.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
769
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
770 ``passwd``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
771 Optional. Password to authenticate with at the proxy server.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
772
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
773 ``user``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
774 Optional. User name to authenticate with at the proxy server.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
775
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
776 ``always``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
777 Optional. Always use the proxy, even for localhost and any entries
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
778 in ``http_proxy.no``. True or False. Default: False.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
779
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
780 ``merge-patterns``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
781 ------------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
782
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
783 This section specifies merge tools to associate with particular file
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
784 patterns. Tools matched here will take precedence over the default
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
785 merge tool. Patterns are globs by default, rooted at the repository
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
786 root.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
787
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
788 Example::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
789
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
790 [merge-patterns]
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
791 **.c = kdiff3
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
792 **.jpg = myimgmerge
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
793
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
794 ``merge-tools``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
795 ---------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
796
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
797 This section configures external merge tools to use for file-level
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
798 merges.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
799
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
800 Example ``~/.hgrc``::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
801
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
802 [merge-tools]
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
803 # Override stock tool location
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
804 kdiff3.executable = ~/bin/kdiff3
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
805 # Specify command line
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
806 kdiff3.args = $base $local $other -o $output
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
807 # Give higher priority
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
808 kdiff3.priority = 1
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
809
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
810 # Define new tool
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
811 myHtmlTool.args = -m $local $other $base $output
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
812 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
813 myHtmlTool.priority = 1
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
814
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
815 Supported arguments:
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
816
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
817 ``priority``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
818 The priority in which to evaluate this tool.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
819 Default: 0.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
820
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
821 ``executable``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
822 Either just the name of the executable or its pathname. On Windows,
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
823 the path can use environment variables with ${ProgramFiles} syntax.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
824 Default: the tool name.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
825
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
826 ``args``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
827 The arguments to pass to the tool executable. You can refer to the
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
828 files being merged as well as the output file through these
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
829 variables: ``$base``, ``$local``, ``$other``, ``$output``.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
830 Default: ``$local $base $other``
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
831
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
832 ``premerge``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
833 Attempt to run internal non-interactive 3-way merge tool before
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
834 launching external tool. Options are ``true``, ``false``, or ``keep``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
835 to leave markers in the file if the premerge fails.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
836 Default: True
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
837
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
838 ``binary``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
839 This tool can merge binary files. Defaults to False, unless tool
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
840 was selected by file pattern match.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
841
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
842 ``symlink``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
843 This tool can merge symlinks. Defaults to False, even if tool was
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
844 selected by file pattern match.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
845
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
846 ``check``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
847 A list of merge success-checking options:
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
848
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
849 ``changed``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
850 Ask whether merge was successful when the merged file shows no changes.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
851 ``conflicts``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
852 Check whether there are conflicts even though the tool reported success.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
853 ``prompt``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
854 Always prompt for merge success, regardless of success reported by tool.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
855
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
856 ``fixeol``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
857 Attempt to fix up EOL changes caused by the merge tool.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
858 Default: False
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
859
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
860 ``gui``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
861 This tool requires a graphical interface to run. Default: False
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
862
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
863 ``regkey``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
864 Windows registry key which describes install location of this
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
865 tool. Mercurial will search for this key first under
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
866 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
867 Default: None
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
868
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
869 ``regkeyalt``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
870 An alternate Windows registry key to try if the first key is not
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
871 found. The alternate key uses the same ``regname`` and ``regappend``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
872 semantics of the primary key. The most common use for this key
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
873 is to search for 32bit applications on 64bit operating systems.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
874 Default: None
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
875
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
876 ``regname``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
877 Name of value to read from specified registry key. Defaults to the
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
878 unnamed (default) value.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
879
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
880 ``regappend``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
881 String to append to the value read from the registry, typically
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
882 the executable name of the tool.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
883 Default: None
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
884
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
885
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
886 ``patch``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
887 ---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
888
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
889 Settings used when applying patches, for instance through the 'import'
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
890 command or with Mercurial Queues extension.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
891
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
892 ``eol``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
893 When set to 'strict' patch content and patched files end of lines
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
894 are preserved. When set to ``lf`` or ``crlf``, both files end of
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
895 lines are ignored when patching and the result line endings are
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
896 normalized to either LF (Unix) or CRLF (Windows). When set to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
897 ``auto``, end of lines are again ignored while patching but line
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
898 endings in patched files are normalized to their original setting
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
899 on a per-file basis. If target file does not exist or has no end
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
900 of line, patch line endings are preserved.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
901 Default: strict.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
902
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
903
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
904 ``paths``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
905 ---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
906
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
907 Assigns symbolic names to repositories. The left side is the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
908 symbolic name, and the right gives the directory or URL that is the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
909 location of the repository. Default paths can be declared by setting
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
910 the following entries.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
911
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
912 ``default``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
913 Directory or URL to use when pulling if no source is specified.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
914 Default is set to repository from which the current repository was
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
915 cloned.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
916
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
917 ``default-push``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
918 Optional. Directory or URL to use when pushing if no destination
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
919 is specified.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
920
17685
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
921 Custom paths can be defined by assigning the path to a name that later can be
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
922 used from the command line. Example::
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
923
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
924 [paths]
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
925 my_path = http://example.com/path
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
926
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
927 To push to the path defined in ``my_path`` run the command::
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
928
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
929 hg push my_path
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
930
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
931
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
932 ``phases``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
933 ----------
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
934
16005
591f258ae630 help/config: fix help command markup
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 15999
diff changeset
935 Specifies default handling of phases. See :hg:`help phases` for more
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
936 information about working with phases.
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
937
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
938 ``publish``
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
939 Controls draft phase behavior when working as a server. When true,
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
940 pushed changesets are set to public in both client and server and
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
941 pulled or cloned changesets are set to public in the client.
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
942 Default: True
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
943
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
944 ``new-commit``
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
945 Phase of newly-created commits.
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
946 Default: draft
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
947
20176
4c96c50ef937 subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 20142
diff changeset
948 ``checksubrepos``
20333
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
949 Check the phase of the current revision of each subrepository. Allowed
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
950 values are "ignore", "follow" and "abort". For settings other than
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
951 "ignore", the phase of the current revision of each subrepository is
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
952 checked before committing the parent repository. If any of those phases is
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
953 greater than the phase of the parent repository (e.g. if a subrepo is in a
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
954 "secret" phase while the parent repo is in "draft" phase), the commit is
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
955 either aborted (if checksubrepos is set to "abort") or the higher phase is
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
956 used for the parent repository commit (if set to "follow").
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
957 Default: "follow"
20176
4c96c50ef937 subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 20142
diff changeset
958
4c96c50ef937 subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 20142
diff changeset
959
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
960 ``profiling``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
961 -------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
962
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
963 Specifies profiling type, format, and file output. Two profilers are
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
964 supported: an instrumenting profiler (named ``ls``), and a sampling
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
965 profiler (named ``stat``).
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
966
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
967 In this section description, 'profiling data' stands for the raw data
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
968 collected during profiling, while 'profiling report' stands for a
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
969 statistical text report generated from the profiling data. The
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
970 profiling is done using lsprof.
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
971
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
972 ``type``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
973 The type of profiler to use.
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
974 Default: ls.
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
975
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
976 ``ls``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
977 Use Python's built-in instrumenting profiler. This profiler
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
978 works on all platforms, but each line number it reports is the
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
979 first line of a function. This restriction makes it difficult to
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
980 identify the expensive parts of a non-trivial function.
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
981 ``stat``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
982 Use a third-party statistical profiler, statprof. This profiler
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
983 currently runs only on Unix systems, and is most useful for
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
984 profiling commands that run for longer than about 0.1 seconds.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
985
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
986 ``format``
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
987 Profiling format. Specific to the ``ls`` instrumenting profiler.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
988 Default: text.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
989
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
990 ``text``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
991 Generate a profiling report. When saving to a file, it should be
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
992 noted that only the report is saved, and the profiling data is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
993 not kept.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
994 ``kcachegrind``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
995 Format profiling data for kcachegrind use: when saving to a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
996 file, the generated file can directly be loaded into
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
997 kcachegrind.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
998
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
999 ``frequency``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1000 Sampling frequency. Specific to the ``stat`` sampling profiler.
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1001 Default: 1000.
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1002
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1003 ``output``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1004 File path where profiling data or report should be saved. If the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1005 file exists, it is replaced. Default: None, data is printed on
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1006 stderr
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1007
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1008 ``sort``
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1009 Sort field. Specific to the ``ls`` instrumenting profiler.
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1010 One of ``callcount``, ``reccallcount``, ``totaltime`` and
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1011 ``inlinetime``.
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1012 Default: inlinetime.
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1013
18548
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
1014 ``limit``
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
1015 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
1016 Default: 30.
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
1017
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1018 ``nested``
18642
a40d608e2a7b profiling: replace '+' markup of nested lines with indentation
Mads Kiilerich <mads@kiilerich.com>
parents: 18636
diff changeset
1019 Show at most this number of lines of drill-down info after each main entry.
a40d608e2a7b profiling: replace '+' markup of nested lines with indentation
Mads Kiilerich <mads@kiilerich.com>
parents: 18636
diff changeset
1020 This can help explain the difference between Total and Inline.
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1021 Specific to the ``ls`` instrumenting profiler.
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1022 Default: 5.
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1023
14691
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
1024 ``revsetalias``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1025 ---------------
14691
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
1026
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
1027 Alias definitions for revsets. See :hg:`help revsets` for details.
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
1028
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1029 ``server``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1030 ----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1031
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1032 Controls generic server settings.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1033
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1034 ``uncompressed``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1035 Whether to allow clients to clone a repository using the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1036 uncompressed streaming protocol. This transfers about 40% more
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1037 data than a regular clone, but uses less memory and CPU on both
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1038 server and client. Over a LAN (100 Mbps or better) or a very fast
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1039 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1040 regular clone. Over most WAN connections (anything slower than
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1041 about 6 Mbps), uncompressed streaming is slower, because of the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1042 extra data transfer overhead. This mode will also temporarily hold
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1043 the write lock while determining what data to transfer.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1044 Default is True.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1045
16361
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
1046 ``preferuncompressed``
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
1047 When set, clients will try to use the uncompressed streaming
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
1048 protocol. Default is False.
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
1049
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1050 ``validate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1051 Whether to validate the completeness of pushed changesets by
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1052 checking that all new file revisions specified in manifests are
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1053 present. Default is False.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1054
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1055 ``smtp``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1056 --------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1057
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1058 Configuration for extensions that need to send email messages.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1059
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1060 ``host``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1061 Host name of mail server, e.g. "mail.example.com".
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1062
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1063 ``port``
19050
601c1e226889 smtp: use 465 as default port for SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18958
diff changeset
1064 Optional. Port to connect to on mail server. Default: 465 (if
601c1e226889 smtp: use 465 as default port for SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18958
diff changeset
1065 ``tls`` is smtps) or 25 (otherwise).
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1066
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1067 ``tls``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1068 Optional. Method to enable TLS when connecting to mail server: starttls,
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1069 smtps or none. Default: none.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1070
18888
19d489404d79 smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18734
diff changeset
1071 ``verifycert``
19d489404d79 smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18734
diff changeset
1072 Optional. Verification for the certificate of mail server, when
19d489404d79 smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18734
diff changeset
1073 ``tls`` is starttls or smtps. "strict", "loose" or False. For
19d489404d79 smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18734
diff changeset
1074 "strict" or "loose", the certificate is verified as same as the
19d489404d79 smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18734
diff changeset
1075 verification for HTTPS connections (see ``[hostfingerprints]`` and
19d489404d79 smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18734
diff changeset
1076 ``[web] cacerts`` also). For "strict", sending email is also
19d489404d79 smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18734
diff changeset
1077 aborted, if there is no configuration for mail server in
19d489404d79 smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18734
diff changeset
1078 ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for
19d489404d79 smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18734
diff changeset
1079 :hg:`email` overwrites this as "loose". Default: "strict".
19d489404d79 smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 18734
diff changeset
1080
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1081 ``username``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1082 Optional. User name for authenticating with the SMTP server.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1083 Default: none.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1084
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1085 ``password``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1086 Optional. Password for authenticating with the SMTP server. If not
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1087 specified, interactive sessions will prompt the user for a
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1088 password; non-interactive sessions will fail. Default: none.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1089
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1090 ``local_hostname``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1091 Optional. It's the hostname that the sender can use to identify
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1092 itself to the MTA.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1093
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1094
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1095 ``subpaths``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1096 ------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1097
16549
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
1098 Subrepository source URLs can go stale if a remote server changes name
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
1099 or becomes temporarily unavailable. This section lets you define
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
1100 rewrite rules of the form::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1101
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1102 <pattern> = <replacement>
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1103
16549
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
1104 where ``pattern`` is a regular expression matching a subrepository
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
1105 source URL and ``replacement`` is the replacement string used to
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
1106 rewrite it. Groups can be matched in ``pattern`` and referenced in
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
1107 ``replacements``. For instance::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1108
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1109 http://server/(.*)-hg/ = http://hg.server/\1/
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1110
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1111 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1112
17251
98166640b356 help: fix some instances of 'the the'
Mads Kiilerich <mads@kiilerich.com>
parents: 17202
diff changeset
1113 Relative subrepository paths are first made absolute, and the
16549
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
1114 rewrite rules are then applied on the full (absolute) path. The rules
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
1115 are applied in definition order.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1116
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1117 ``trusted``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1118 -----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1119
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1120 Mercurial will not use the settings in the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1121 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1122 user or to a trusted group, as various hgrc features allow arbitrary
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1123 commands to be run. This issue is often encountered when configuring
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1124 hooks or extensions for shared repositories or servers. However,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1125 the web interface will use some safe settings from the ``[web]``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1126 section.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1127
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1128 This section specifies what users and groups are trusted. The
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1129 current user is always trusted. To trust everybody, list a user or a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1130 group with name ``*``. These settings must be placed in an
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1131 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1132 user or service running Mercurial.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1133
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1134 ``users``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1135 Comma-separated list of trusted users.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1136
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1137 ``groups``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1138 Comma-separated list of trusted groups.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1139
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1140
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1141 ``ui``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1142 ------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1143
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1144 User interface controls.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1145
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1146 ``archivemeta``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1147 Whether to include the .hg_archival.txt file containing meta data
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1148 (hashes for the repository base and for tip) in archives created
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1149 by the :hg:`archive` command or downloaded via hgweb.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1150 Default is True.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1151
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1152 ``askusername``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1153 Whether to prompt for a username when committing. If True, and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1154 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1155 be prompted to enter a username. If no username is entered, the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1156 default ``USER@HOST`` is used instead.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1157 Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1158
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1159 ``commitsubrepos``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1160 Whether to commit modified subrepositories when committing the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1161 parent repository. If False and one subrepository has uncommitted
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1162 changes, abort the commit.
15321
e174353e8cda subrepos: abort commit by default if a subrepo is dirty (BC)
Martin Geisler <mg@lazybytes.net>
parents: 15046
diff changeset
1163 Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1164
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1165 ``debug``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1166 Print debugging information. True or False. Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1167
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1168 ``editor``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1169 The editor to use during a commit. Default is ``$EDITOR`` or ``vi``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1170
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1171 ``fallbackencoding``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1172 Encoding to try if it's not possible to decode the changelog using
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1173 UTF-8. Default is ISO-8859-1.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1174
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1175 ``ignore``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1176 A file to read per-user ignore patterns from. This file should be
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1177 in the same format as a repository-wide .hgignore file. This
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1178 option supports hook syntax, so if you want to specify multiple
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1179 ignore files, you can do so by setting something like
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1180 ``ignore.other = ~/.hgignore2``. For details of the ignore file
14661
8bbb899620ea help/config: replace docutils markup
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14654
diff changeset
1181 format, see the ``hgignore(5)`` man page.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1182
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1183 ``interactive``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1184 Allow to prompt the user. True or False. Default is True.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1185
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1186 ``logtemplate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1187 Template string for commands that print changesets.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1188
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1189 ``merge``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1190 The conflict resolution program to use during a manual merge.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1191 For more information on merge tools see :hg:`help merge-tools`.
14654
e21fd445c297 help/config: quote config section names consistently
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14653
diff changeset
1192 For configuring merge tools see the ``[merge-tools]`` section.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1193
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1194 ``portablefilenames``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1195 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1196 Default is ``warn``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1197 If set to ``warn`` (or ``true``), a warning message is printed on POSIX
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1198 platforms, if a file with a non-portable filename is added (e.g. a file
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1199 with a name that can't be created on Windows because it contains reserved
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1200 parts like ``AUX``, reserved characters like ``:``, or would cause a case
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1201 collision with an existing file).
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1202 If set to ``ignore`` (or ``false``), no warning is printed.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1203 If set to ``abort``, the command is aborted.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1204 On Windows, this configuration option is ignored and the command aborted.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1205
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1206 ``quiet``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1207 Reduce the amount of output printed. True or False. Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1208
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1209 ``remotecmd``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1210 remote command to use for clone/push/pull operations. Default is ``hg``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1211
16391
9cf7c9d529d0 ui: optionally quiesce ssl verification warnings on python 2.5
Steven Stallion <sstallion@gmail.com>
parents: 16383
diff changeset
1212 ``reportoldssl``
9cf7c9d529d0 ui: optionally quiesce ssl verification warnings on python 2.5
Steven Stallion <sstallion@gmail.com>
parents: 16383
diff changeset
1213 Warn if an SSL certificate is unable to be due to using Python
9cf7c9d529d0 ui: optionally quiesce ssl verification warnings on python 2.5
Steven Stallion <sstallion@gmail.com>
parents: 16383
diff changeset
1214 2.5 or earlier. True or False. Default is True.
9cf7c9d529d0 ui: optionally quiesce ssl verification warnings on python 2.5
Steven Stallion <sstallion@gmail.com>
parents: 16383
diff changeset
1215
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1216 ``report_untrusted``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1217 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1218 trusted user or group. True or False. Default is True.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1219
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1220 ``slash``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1221 Display paths using a slash (``/``) as the path separator. This
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1222 only makes a difference on systems where the default path
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1223 separator is not the slash character (e.g. Windows uses the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1224 backslash character (``\``)).
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1225 Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1226
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1227 ``ssh``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1228 command to use for SSH connections. Default is ``ssh``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1229
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1230 ``strict``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1231 Require exact command names, instead of allowing unambiguous
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1232 abbreviations. True or False. Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1233
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1234 ``style``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1235 Name of style to use for command output.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1236
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1237 ``timeout``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1238 The timeout used when a lock is held (in seconds), a negative value
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1239 means no timeout. Default is 600.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1240
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1241 ``traceback``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1242 Mercurial always prints a traceback when an unknown exception
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1243 occurs. Setting this to True will make Mercurial print a traceback
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1244 on all exceptions, even those recognized by Mercurial (such as
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1245 IOError or MemoryError). Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1246
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1247 ``username``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1248 The committer of a changeset created when running "commit".
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1249 Typically a person's name and email address, e.g. ``Fred Widget
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1250 <fred@example.com>``. Default is ``$EMAIL`` or ``username@hostname``. If
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1251 the username in hgrc is empty, it has to be specified manually or
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1252 in a different hgrc file (e.g. ``$HOME/.hgrc``, if the admin set
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1253 ``username =`` in the system hgrc). Environment variables in the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1254 username are expanded.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1255
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1256 ``verbose``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1257 Increase the amount of output printed. True or False. Default is False.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1258
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1259
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1260 ``web``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1261 -------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1262
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1263 Web interface configuration. The settings in this section apply to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1264 both the builtin webserver (started by :hg:`serve`) and the script you
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1265 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1266 and WSGI).
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1267
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1268 The Mercurial webserver does no authentication (it does not prompt for
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1269 usernames and passwords to validate *who* users are), but it does do
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1270 authorization (it grants or denies access for *authenticated users*
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1271 based on settings in this section). You must either configure your
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1272 webserver to do authentication for you, or disable the authorization
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1273 checks.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1274
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1275 For a quick setup in a trusted environment, e.g., a private LAN, where
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1276 you want it to accept pushes from anybody, you can use the following
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1277 command line::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1278
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1279 $ hg --config web.allow_push=* --config web.push_ssl=False serve
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1280
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1281 Note that this will allow anybody to push anything to the server and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1282 that this should not be used for public servers.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1283
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1284 The full set of options is:
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1285
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1286 ``accesslog``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1287 Where to output the access log. Default is stdout.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1288
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1289 ``address``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1290 Interface address to bind to. Default is all.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1291
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1292 ``allow_archive``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1293 List of archive format (bz2, gz, zip) allowed for downloading.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1294 Default is empty.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1295
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1296 ``allowbz2``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1297 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1298 revisions.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1299 Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1300
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1301 ``allowgz``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1302 (DEPRECATED) Whether to allow .tar.gz downloading of repository
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1303 revisions.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1304 Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1305
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1306 ``allowpull``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1307 Whether to allow pulling from the repository. Default is True.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1308
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1309 ``allow_push``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1310 Whether to allow pushing to the repository. If empty or not set,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1311 push is not allowed. If the special value ``*``, any remote user can
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1312 push, including unauthenticated users. Otherwise, the remote user
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1313 must have been authenticated, and the authenticated user name must
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1314 be present in this list. The contents of the allow_push list are
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1315 examined after the deny_push list.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1316
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1317 ``allow_read``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1318 If the user has not already been denied repository access due to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1319 the contents of deny_read, this list determines whether to grant
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1320 repository access to the user. If this list is not empty, and the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1321 user is unauthenticated or not present in the list, then access is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1322 denied for the user. If the list is empty or not set, then access
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1323 is permitted to all users by default. Setting allow_read to the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1324 special value ``*`` is equivalent to it not being set (i.e. access
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1325 is permitted to all users). The contents of the allow_read list are
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1326 examined after the deny_read list.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1327
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1328 ``allowzip``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1329 (DEPRECATED) Whether to allow .zip downloading of repository
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1330 revisions. Default is False. This feature creates temporary files.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1331
17933
8243dd66e0e3 webcommands: allow hgweb's archive to recurse into subrepos
Jordi Guti?rrez Hermoso <jordigh@octave.org>
parents: 17685
diff changeset
1332 ``archivesubrepos``
8243dd66e0e3 webcommands: allow hgweb's archive to recurse into subrepos
Jordi Guti?rrez Hermoso <jordigh@octave.org>
parents: 17685
diff changeset
1333 Whether to recurse into subrepositories when archiving. Default is
8243dd66e0e3 webcommands: allow hgweb's archive to recurse into subrepos
Jordi Guti?rrez Hermoso <jordigh@octave.org>
parents: 17685
diff changeset
1334 False.
8243dd66e0e3 webcommands: allow hgweb's archive to recurse into subrepos
Jordi Guti?rrez Hermoso <jordigh@octave.org>
parents: 17685
diff changeset
1335
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1336 ``baseurl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1337 Base URL to use when publishing URLs in other locations, so
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1338 third-party tools like email notification hooks can construct
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1339 URLs. Example: ``http://hgserver/repos/``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1340
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1341 ``cacerts``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1342 Path to file containing a list of PEM encoded certificate
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1343 authority certificates. Environment variables and ``~user``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1344 constructs are expanded in the filename. If specified on the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1345 client, then it will verify the identity of remote HTTPS servers
16399
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1346 with these certificates.
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1347
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1348 This feature is only supported when using Python 2.6 or later. If you wish
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1349 to use it with earlier versions of Python, install the backported
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1350 version of the ssl library that is available from
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1351 ``http://pypi.python.org``.
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1352
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1353 To disable SSL verification temporarily, specify ``--insecure`` from
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1354 command line.
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1355
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1356 You can use OpenSSL's CA certificate file if your platform has
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1357 one. On most Linux systems this will be
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1358 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
1359 generate this file manually. The form must be as follows::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1360
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1361 -----BEGIN CERTIFICATE-----
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1362 ... (certificate in base64 PEM encoding) ...
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1363 -----END CERTIFICATE-----
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1364 -----BEGIN CERTIFICATE-----
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1365 ... (certificate in base64 PEM encoding) ...
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1366 -----END CERTIFICATE-----
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1367
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1368 ``cache``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1369 Whether to support caching in hgweb. Defaults to True.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1370
16570
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
1371 ``collapse``
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
1372 With ``descend`` enabled, repositories in subdirectories are shown at
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
1373 a single level alongside repositories in the current path. With
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
1374 ``collapse`` also enabled, repositories residing at a deeper level than
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
1375 the current path are grouped behind navigable directory entries that
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
1376 lead to the locations of these repositories. In effect, this setting
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
1377 collapses each collection of repositories found within a subdirectory
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
1378 into a single entry for that subdirectory. Default is False.
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
1379
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1380 ``comparisoncontext``
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1381 Number of lines of context to show in side-by-side file comparison. If
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1382 negative or the value ``full``, whole files are shown. Default is 5.
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1383 This setting can be overridden by a ``context`` request parameter to the
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1384 ``comparison`` command, taking the same values.
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1385
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1386 ``contact``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1387 Name or email address of the person in charge of the repository.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1388 Defaults to ui.username or ``$EMAIL`` or "unknown" if unset or empty.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1389
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1390 ``deny_push``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1391 Whether to deny pushing to the repository. If empty or not set,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1392 push is not denied. If the special value ``*``, all remote users are
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1393 denied push. Otherwise, unauthenticated users are all denied, and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1394 any authenticated user name present in this list is also denied. The
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1395 contents of the deny_push list are examined before the allow_push list.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1396
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1397 ``deny_read``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1398 Whether to deny reading/viewing of the repository. If this list is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1399 not empty, unauthenticated users are all denied, and any
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1400 authenticated user name present in this list is also denied access to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1401 the repository. If set to the special value ``*``, all remote users
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1402 are denied access (rarely needed ;). If deny_read is empty or not set,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1403 the determination of repository access depends on the presence and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1404 content of the allow_read list (see description). If both
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1405 deny_read and allow_read are empty or not set, then access is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1406 permitted to all users by default. If the repository is being
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1407 served via hgwebdir, denied users will not be able to see it in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1408 the list of repositories. The contents of the deny_read list have
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1409 priority over (are examined before) the contents of the allow_read
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1410 list.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1411
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1412 ``descend``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1413 hgwebdir indexes will not descend into subdirectories. Only repositories
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1414 directly in the current path will be shown (other repositories are still
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1415 available from the index corresponding to their containing path).
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1416
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1417 ``description``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1418 Textual description of the repository's purpose or contents.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1419 Default is "unknown".
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1420
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1421 ``encoding``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1422 Character encoding name. Default is the current locale charset.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1423 Example: "UTF-8"
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1424
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1425 ``errorlog``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1426 Where to output the error log. Default is stderr.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1427
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1428 ``guessmime``
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1429 Control MIME types for raw download of file content.
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1430 Set to True to let hgweb guess the content type from the file
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1431 extension. This will serve HTML files as ``text/html`` and might
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1432 allow cross-site scripting attacks when serving untrusted
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1433 repositories. Default is False.
17202
1ae119269ddc hgweb: side-by-side comparison functionality
wujek srujek
parents: 16585
diff changeset
1434
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1435 ``hidden``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1436 Whether to hide the repository in the hgwebdir index.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1437 Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1438
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1439 ``ipv6``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1440 Whether to use IPv6. Default is False.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1441
14938
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
1442 ``logoimg``
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
1443 File name of the logo image that some templates display on each page.
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
1444 The file name is relative to ``staticurl``. That is, the full path to
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
1445 the logo image is "staticurl/logoimg".
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
1446 If unset, ``hglogo.png`` will be used.
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
1447
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1448 ``logourl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1449 Base URL to use for logos. If unset, ``http://mercurial.selenic.com/``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1450 will be used.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1451
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1452 ``maxchanges``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1453 Maximum number of changes to list on the changelog. Default is 10.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1454
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1455 ``maxfiles``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1456 Maximum number of files to list per changeset. Default is 10.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1457
17317
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
1458 ``maxshortchanges``
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
1459 Maximum number of changes to list on the shortlog, graph or filelog
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
1460 pages. Default is 60.
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
1461
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1462 ``name``
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1463 Repository name to use in the web interface. Default is current
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1464 working directory.
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
1465
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1466 ``port``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1467 Port to listen on. Default is 8000.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1468
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1469 ``prefix``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1470 Prefix path to serve from. Default is '' (server root).
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1471
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1472 ``push_ssl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1473 Whether to require that inbound pushes be transported over SSL to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1474 prevent password sniffing. Default is True.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1475
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1476 ``staticurl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1477 Base URL to use for static files. If unset, static files (e.g. the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1478 hgicon.png favicon) will be served by the CGI script itself. Use
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1479 this setting to serve them directly with the HTTP server.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1480 Example: ``http://hgserver/static/``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1481
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1482 ``stripes``
17424
e7cfe3587ea4 fix trivial spelling errors
Mads Kiilerich <mads@kiilerich.com>
parents: 17317
diff changeset
1483 How many lines a "zebra stripe" should span in multi-line output.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1484 Default is 1; set to 0 to disable.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1485
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1486 ``style``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1487 Which template map style to use.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1488
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1489 ``templates``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1490 Where to find the HTML templates. Default is install path.
18628
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1491
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1492 ``websub``
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1493 ----------
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1494
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1495 Web substitution filter definition. You can use this section to
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1496 define a set of regular expression substitution patterns which
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1497 let you automatically modify the hgweb server output.
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1498
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1499 The default hgweb templates only apply these substitution patterns
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1500 on the revision description fields. You can apply them anywhere
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1501 you want when you create your own templates by adding calls to the
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1502 "websub" filter (usually after calling the "escape" filter).
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1503
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1504 This can be used, for example, to convert issue references to links
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1505 to your issue tracker, or to convert "markdown-like" syntax into
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1506 HTML (see the examples below).
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1507
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1508 Each entry in this section names a substitution filter.
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1509 The value of each entry defines the substitution expression itself.
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1510 The websub expressions follow the old interhg extension syntax,
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1511 which in turn imitates the Unix sed replacement syntax::
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1512
18958
c3b920980f22 spelling: fix typos and spelling errors
Mads Kiilerich <madski@unity3d.com>
parents: 18888
diff changeset
1513 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
18628
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1514
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1515 You can use any separator other than "/". The final "i" is optional
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1516 and indicates that the search must be case insensitive.
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1517
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1518 Examples::
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1519
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1520 [websub]
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1521 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1522 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
1523 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
18652
a5e94bee77ed merge crew and main
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 18642 18628
diff changeset
1524
18636
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1525 ``worker``
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1526 ----------
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1527
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1528 Parallel master/worker configuration. We currently perform working
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1529 directory updates in parallel on Unix-like systems, which greatly
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1530 helps performance.
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1531
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1532 ``numcpus``
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1533 Number of CPUs to use for parallel operations. Default is 4 or the
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1534 number of CPUs on the system, whichever is larger. A zero or
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
1535 negative value is treated as ``use the default``.