Mercurial > hg
annotate doc/hgrc.5.txt @ 9627:4515761ea531
rst2man: avoid italic for references
The links to other manpages used both italic and bold text nested
within each other. The \fP (select previous font) macro was used
incorrectly to "reset" the nested fonts resulting in:
<roman> text <italic> <bold> hg <italic> (1) <bold> more text
with no switch back to roman. This stops the bleeding and removes the
ugly italic (underline) from the manpage links.
author | Martin Geisler <mg@lazybytes.net> |
---|---|
date | Thu, 22 Oct 2009 00:27:08 +0200 |
parents | 585d2ffe969b |
children | 24dad078603b |
rev | line source |
---|---|
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
1 ====== |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
2 hgrc |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
3 ====== |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
4 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
5 --------------------------------- |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
6 configuration files for Mercurial |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
7 --------------------------------- |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
8 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
9 :Author: Bryan O'Sullivan <bos@serpentine.com> |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
10 :Organization: Mercurial |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
11 :Manual section: 5 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
12 :Manual group: Mercurial Manual |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
13 |
9422
ec26d6986d85
doc: add TOC to hg.1.html and hgrc.5.html
Martin Geisler <mg@lazybytes.net>
parents:
9381
diff
changeset
|
14 .. contents:: |
ec26d6986d85
doc: add TOC to hg.1.html and hgrc.5.html
Martin Geisler <mg@lazybytes.net>
parents:
9381
diff
changeset
|
15 :backlinks: top |
ec26d6986d85
doc: add TOC to hg.1.html and hgrc.5.html
Martin Geisler <mg@lazybytes.net>
parents:
9381
diff
changeset
|
16 :class: htmlonly |
ec26d6986d85
doc: add TOC to hg.1.html and hgrc.5.html
Martin Geisler <mg@lazybytes.net>
parents:
9381
diff
changeset
|
17 |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
18 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
19 SYNOPSIS |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
20 -------- |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
21 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
22 The Mercurial system uses a set of configuration files to control |
8773 | 23 aspects of its behavior. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
24 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
25 FILES |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
26 ----- |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
27 |
1583
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
28 Mercurial reads configuration data from several files, if they exist. |
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
29 The names of these files depend on the system on which Mercurial is |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
30 installed. ``*.rc`` files from a single directory are read in |
8782
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
31 alphabetical order, later ones overriding earlier ones. Where multiple |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
32 paths are given below, settings from later paths override earlier |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
33 ones. |
951
859de3ebc041
Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
938
diff
changeset
|
34 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
35 | (Unix) ``<install-root>/etc/mercurial/hgrc.d/*.rc`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
36 | (Unix) ``<install-root>/etc/mercurial/hgrc`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
37 |
1583
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
38 Per-installation configuration files, searched for in the |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
39 directory where Mercurial is installed. ``<install-root>`` is the |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
40 parent directory of the **hg** executable (or symlink) being run. For |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
41 example, if installed in ``/shared/tools/bin/hg``, Mercurial will look |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
42 in ``/shared/tools/etc/mercurial/hgrc``. Options in these files apply |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
43 to all Mercurial commands executed by any user in any directory. |
1583
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
44 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
45 | (Unix) ``/etc/mercurial/hgrc.d/*.rc`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
46 | (Unix) ``/etc/mercurial/hgrc`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
47 |
1583
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
48 Per-system configuration files, for the system on which Mercurial |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
49 is running. Options in these files apply to all Mercurial commands |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
50 executed by any user in any directory. Options in these files |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
51 override per-installation options. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
52 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
53 | (Windows) ``<install-dir>\Mercurial.ini`` or else |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
54 | (Windows) ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` or else |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
55 | (Windows) ``C:\Mercurial\Mercurial.ini`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
56 |
6310
1a13a5bbbbc1
make hgrc man page tell about ~/.hgrc on Windows
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
6302
diff
changeset
|
57 Per-installation/system configuration files, for the system on |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
58 which Mercurial is running. Options in these files apply to all |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
59 Mercurial commands executed by any user in any directory. Registry |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
60 keys contain PATH-like strings, every part of which must reference |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
61 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will |
8782
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
62 be read. |
6310
1a13a5bbbbc1
make hgrc man page tell about ~/.hgrc on Windows
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
6302
diff
changeset
|
63 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
64 | (Unix) ``$HOME/.hgrc`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
65 | (Windows) ``%HOME%\Mercurial.ini`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
66 | (Windows) ``%HOME%\.hgrc`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
67 | (Windows) ``%USERPROFILE%\Mercurial.ini`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
68 | (Windows) ``%USERPROFILE%\.hgrc`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
69 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
70 Per-user configuration file(s), for the user running Mercurial. On |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
71 Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these |
8782
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
72 files apply to all Mercurial commands executed by this user in any |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
73 directory. Options in these files override per-installation and |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
74 per-system options. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
75 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
76 | (Unix, Windows) ``<repo>/.hg/hgrc`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
77 |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
78 Per-repository configuration options that only apply in a |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
79 particular repository. This file is not version-controlled, and |
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
80 will not get transferred during a "clone" operation. Options in |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
81 this file override options in all other configuration files. On |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
82 Unix, most of this file will be ignored if it doesn't belong to a |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
83 trusted user or to a trusted group. See the documentation for the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
84 trusted section below for more details. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
85 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
86 SYNTAX |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
87 ------ |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
88 |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
89 A configuration file consists of sections, led by a ``[section]`` header |
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
90 and followed by ``name: value`` entries; ``name=value`` is also accepted. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
91 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
92 :: |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
93 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
94 [spam] |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
95 eggs=ham |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
96 green= |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
97 eggs |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
98 |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
99 Each line contains one entry. If the lines that follow are indented, |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
100 they are treated as continuations of that entry. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
101 |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
102 Leading whitespace is removed from values. Empty lines are skipped. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
103 |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
104 Lines beginning with ``#`` or ``;`` are ignored and may be used to provide |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
105 comments. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
106 |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
107 A line of the form ``%include file`` will include ``file`` into the |
9376
68f393788895
hgrc.5: document %include directive
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
108 current configuration file. The inclusion is recursive, which means |
68f393788895
hgrc.5: document %include directive
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
109 that included files can include other files. Filenames are relative to |
9377 | 110 the configuration file in which the ``%include`` directive is found. |
9376
68f393788895
hgrc.5: document %include directive
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
111 |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
112 A line with ``%unset name`` will remove ``name`` from the current |
9380
e499a4147c66
hgrc.5: document %unset directive
Martin Geisler <mg@lazybytes.net>
parents:
9376
diff
changeset
|
113 section, if it has been set previously. |
e499a4147c66
hgrc.5: document %unset directive
Martin Geisler <mg@lazybytes.net>
parents:
9376
diff
changeset
|
114 |
9376
68f393788895
hgrc.5: document %include directive
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
115 |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
116 SECTIONS |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
117 -------- |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
118 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
119 This section describes the different sections that may appear in a |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
120 Mercurial "hgrc" file, the purpose of each section, its possible keys, |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
121 and their possible values. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
122 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
123 ``alias`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
124 """"""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
125 Defines command aliases. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
126 Aliases allow you to define your own commands in terms of other |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
127 commands (or aliases), optionally including arguments. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
128 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
129 Alias definitions consist of lines of the form:: |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
130 |
8655 | 131 <alias> = <command> [<argument]... |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
132 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
133 For example, this definition:: |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
134 |
8655 | 135 latest = log --limit 5 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
136 |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
137 creates a new command ``latest`` that shows only the five most recent |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
138 changesets. You can define subsequent aliases using earlier ones:: |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
139 |
8655 | 140 stable5 = latest -b stable |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
141 |
8782
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
142 NOTE: It is possible to create aliases with the same names as existing |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
143 commands, which will then override the original definitions. This is |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
144 almost always a bad idea! |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
145 |
8655 | 146 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
147 ``auth`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
148 """""""" |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
149 Authentication credentials for HTTP authentication. Each line has |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
150 the following format:: |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
151 |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
152 <name>.<argument> = <value> |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
153 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
154 where <name> is used to group arguments into authentication entries. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
155 Example:: |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
156 |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
157 foo.prefix = hg.intevation.org/mercurial |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
158 foo.username = foo |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
159 foo.password = bar |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
160 foo.schemes = http https |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
161 |
8847
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
162 bar.prefix = secure.example.org |
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
163 bar.key = path/to/file.key |
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
164 bar.cert = path/to/file.cert |
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
165 bar.schemes = https |
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
166 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
167 Supported arguments: |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
168 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
169 ``prefix`` |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
170 Either ``*`` or a URI prefix with or without the scheme part. |
8782
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
171 The authentication entry with the longest matching prefix is used |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
172 (where ``*`` matches everything and counts as a match of length |
8782
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
173 1). If the prefix doesn't include a scheme, the match is performed |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
174 against the URI with its scheme stripped as well, and the schemes |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
175 argument, q.v., is then subsequently consulted. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
176 ``username`` |
8847
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
177 Optional. Username to authenticate with. If not given, and the |
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
178 remote site requires basic or digest authentication, the user |
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
179 will be prompted for it. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
180 ``password`` |
8847
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
181 Optional. Password to authenticate with. If not given, and the |
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
182 remote site requires basic or digest authentication, the user |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
183 will be prompted for it. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
184 ``key`` |
8847
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
185 Optional. PEM encoded client certificate key file. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
186 ``cert`` |
8847
7951f385fcb7
url: support client certificate files over HTTPS (issue643)
Henrik Stuart <hg@hstuart.dk>
parents:
8810
diff
changeset
|
187 Optional. PEM encoded client certificate chain file. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
188 ``schemes`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
189 Optional. Space separated list of URI schemes to use this |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
190 authentication entry with. Only used if the prefix doesn't include |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
191 a scheme. Supported schemes are http and https. They will match |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
192 static-http and static-https respectively, as well. |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
193 Default: https. |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
194 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
195 If no suitable authentication entry is found, the user is prompted |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
196 for credentials as usual if required by the remote. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
197 |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
198 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
199 ``decode/encode`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
200 """"""""""""""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
201 Filters for transforming files on checkout/checkin. This would |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
202 typically be used for newline processing or other |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
203 localization/canonicalization of files. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
204 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
205 Filters consist of a filter pattern followed by a filter command. |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
206 Filter patterns are globs by default, rooted at the repository root. |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
207 For example, to match any file ending in ``.txt`` in the root |
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
208 directory only, use the pattern ``*.txt``. To match any file ending |
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
209 in ``.c`` anywhere in the repository, use the pattern ``**.c``. |
1258 | 210 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
211 The filter command can start with a specifier, either "pipe:" or |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
212 "tempfile:". If no specifier is given, "pipe:" is used by default. |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
213 |
8782
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
214 A "pipe:" command must accept data on stdin and return the transformed |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
215 data on stdout. |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
216 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
217 Pipe example:: |
1258 | 218 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
219 [encode] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
220 # uncompress gzip files on checkin to improve delta compression |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
221 # note: not necessarily a good idea, just an example |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
222 *.gz = pipe: gunzip |
1258 | 223 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
224 [decode] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
225 # recompress gzip files when writing them to the working dir (we |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
226 # can safely omit "pipe:", because it's the default) |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
227 *.gz = gzip |
1258 | 228 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
229 A "tempfile:" command is a template. The string INFILE is replaced |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
230 with the name of a temporary file that contains the data to be |
8782
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
231 filtered by the command. The string OUTFILE is replaced with the name |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
232 of an empty temporary file, where the filtered data must be written by |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
233 the command. |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
234 |
8782
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
235 NOTE: the tempfile mechanism is recommended for Windows systems, where |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
236 the standard shell I/O redirection operators often have strange |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
237 effects and may corrupt the contents of your files. |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
238 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
239 The most common usage is for LF <-> CRLF translation on Windows. For |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
240 this, use the "smart" converters which check for binary files:: |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
241 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
242 [extensions] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
243 hgext.win32text = |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
244 [encode] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
245 ** = cleverencode: |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
246 [decode] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
247 ** = cleverdecode: |
5678
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
248 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
249 or if you only want to translate certain files:: |
5678
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
250 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
251 [extensions] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
252 hgext.win32text = |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
253 [encode] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
254 **.txt = dumbencode: |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
255 [decode] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
256 **.txt = dumbdecode: |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
257 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
258 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
259 ``defaults`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
260 """""""""""" |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
261 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
262 Use the [defaults] section to define command defaults, i.e. the |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
263 default options/arguments to pass to the specified commands. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
264 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
265 The following example makes 'hg log' run in verbose mode, and 'hg |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
266 status' show only the modified files, by default:: |
5081
ea7b982b6c08
Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4717
diff
changeset
|
267 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
268 [defaults] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
269 log = -v |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
270 status = -m |
5081
ea7b982b6c08
Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4717
diff
changeset
|
271 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
272 The actual commands, instead of their aliases, must be used when |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
273 defining command defaults. The command defaults will also be applied |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
274 to the aliases of the commands defined. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
275 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
276 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
277 ``diff`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
278 """""""" |
3039
77637938d43d
add document on command defaults
TK Soh <teekaysoh@yahoo.com>
parents:
3021
diff
changeset
|
279 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
280 Settings used when displaying diffs. They are all Boolean and |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
281 defaults to False. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
282 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
283 ``git`` |
4011
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
284 Use git extended diff format. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
285 ``nodates`` |
4011
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
286 Don't include dates in diff headers. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
287 ``showfunc`` |
4011
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
288 Show which function each change is in. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
289 ``ignorews`` |
4011
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
290 Ignore white space when comparing lines. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
291 ``ignorewsamount`` |
4011
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
292 Ignore changes in the amount of white space. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
293 ``ignoreblanklines`` |
4011
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
294 Ignore changes whose lines are all blank. |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
295 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
296 ``email`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
297 """"""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
298 Settings for extensions that send email messages. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
299 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
300 ``from`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
301 Optional. Email address to use in "From" header and SMTP envelope |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
302 of outgoing messages. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
303 ``to`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
304 Optional. Comma-separated list of recipients' email addresses. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
305 ``cc`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
306 Optional. Comma-separated list of carbon copy recipients' |
2691
accadcb4e4b5
email: reflect that recipients are specified as comma-separated list
Christian Ebert <blacktrash@gmx.net>
parents:
2680
diff
changeset
|
307 email addresses. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
308 ``bcc`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
309 Optional. Comma-separated list of blind carbon copy recipients' |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
310 email addresses. Cannot be set interactively. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
311 ``method`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
312 Optional. Method to use to send email messages. If value is "smtp" |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
313 (default), use SMTP (see section "[smtp]" for configuration). |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
314 Otherwise, use as name of program to run that acts like sendmail |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
315 (takes "-f" option for sender, list of recipients on command line, |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
316 message on stdin). Normally, setting this to "sendmail" or |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
317 "/usr/sbin/sendmail" is enough to use sendmail to send messages. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
318 ``charsets`` |
8773 | 319 Optional. Comma-separated list of character sets considered |
320 convenient for recipients. Addresses, headers, and parts not | |
321 containing patches of outgoing messages will be encoded in the | |
322 first character set to which conversion from local encoding | |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
323 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct |
8773 | 324 conversion fails, the text in question is sent as is. Defaults to |
325 empty (explicit) list. | |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
326 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
327 Order of outgoing email character sets:: |
7241
421f4cbddd68
hgrc.5: explain order of mail.charsets
Christian Ebert <blacktrash@gmx.net>
parents:
7235
diff
changeset
|
328 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
329 us-ascii always first, regardless of settings |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
330 email.charsets in order given by user |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
331 ui.fallbackencoding if not in email.charsets |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
332 $HGENCODING if not in email.charsets |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
333 utf-8 always last, regardless of settings |
2292
903ab41ac7eb
allow to send email using sendmail.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2288
diff
changeset
|
334 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
335 Email example:: |
2292
903ab41ac7eb
allow to send email using sendmail.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2288
diff
changeset
|
336 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
337 [email] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
338 from = Joseph User <joe.user@example.com> |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
339 method = /usr/sbin/sendmail |
8773 | 340 # charsets for western Europeans |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
341 # us-ascii, utf-8 omitted, as they are tried first and last |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
342 charsets = iso-8859-1, iso-8859-15, windows-1252 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
343 |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
344 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
345 ``extensions`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
346 """""""""""""" |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
347 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
348 Mercurial has an extension mechanism for adding new features. To |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
349 enable an extension, create an entry for it in this section. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
350 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
351 If you know that the extension is already in Python's search path, |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
352 you can give the name of the module, followed by ``=``, with nothing |
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
353 after the ``=``. |
2211
b8b7a79a4d88
document [extensions] in doc/hgrc.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2209
diff
changeset
|
354 |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
355 Otherwise, give a name that you choose, followed by ``=``, followed by |
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
356 the path to the ``.py`` file (including the file name extension) that |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
357 defines the extension. |
2211
b8b7a79a4d88
document [extensions] in doc/hgrc.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2209
diff
changeset
|
358 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
359 To explicitly disable an extension that is enabled in an hgrc of |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
360 broader scope, prepend its path with ``!``, as in |
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
361 ``hgext.foo = !/ext/path`` or ``hgext.foo = !`` when path is not |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
362 supplied. |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
363 |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
364 Example for ``~/.hgrc``:: |
6175
7f9f3233a2c6
add explicit extension disabling syntax to hgrc.5
Steve Borho <steve@borho.org>
parents:
6142
diff
changeset
|
365 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
366 [extensions] |
8773 | 367 # (the mq extension will get loaded from Mercurial's path) |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
368 hgext.mq = |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
369 # (this extension will get loaded from the file specified) |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
370 myfeature = ~/.hgext/myfeature.py |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
371 |
2387
62ce297f214f
Expand '~' in path to extensions.
Markus F.X.J. Oberhumer <markus@oberhumer.com>
parents:
2358
diff
changeset
|
372 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
373 ``format`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
374 """""""""" |
4163
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
375 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
376 ``usestore`` |
4163
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
377 Enable or disable the "store" repository format which improves |
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
378 compatibility with systems that fold case or otherwise mangle |
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
379 filenames. Enabled by default. Disabling this option will allow |
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
380 you to store longer filenames in some situations at the expense of |
7235
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
381 compatibility and ensures that the on-disk format of newly created |
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
382 repositories will be compatible with Mercurial before version 0.9.4. |
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
383 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
384 ``usefncache`` |
7235
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
385 Enable or disable the "fncache" repository format which enhances |
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
386 the "store" repository format (which has to be enabled to use |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
387 fncache) to allow longer filenames and avoids using Windows |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
388 reserved names, e.g. "nul". Enabled by default. Disabling this |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
389 option ensures that the on-disk format of newly created |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
390 repositories will be compatible with Mercurial before version 1.1. |
4163
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
391 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
392 ``merge-patterns`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
393 """""""""""""""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
394 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
395 This section specifies merge tools to associate with particular file |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
396 patterns. Tools matched here will take precedence over the default |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
397 merge tool. Patterns are globs by default, rooted at the repository |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
398 root. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
399 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
400 Example:: |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
401 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
402 [merge-patterns] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
403 **.c = kdiff3 |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
404 **.jpg = myimgmerge |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
405 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
406 ``merge-tools`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
407 """"""""""""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
408 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
409 This section configures external merge tools to use for file-level |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
410 merges. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
411 |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
412 Example ``~/.hgrc``:: |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
413 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
414 [merge-tools] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
415 # Override stock tool location |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
416 kdiff3.executable = ~/bin/kdiff3 |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
417 # Specify command line |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
418 kdiff3.args = $base $local $other -o $output |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
419 # Give higher priority |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
420 kdiff3.priority = 1 |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
421 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
422 # Define new tool |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
423 myHtmlTool.args = -m $local $other $base $output |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
424 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
425 myHtmlTool.priority = 1 |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
426 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
427 Supported arguments: |
6445
a1db3d8b9b8a
hgrc.5: fix subsection formatting
Christian Ebert <blacktrash@gmx.net>
parents:
6325
diff
changeset
|
428 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
429 ``priority`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
430 The priority in which to evaluate this tool. |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
431 Default: 0. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
432 ``executable`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
433 Either just the name of the executable or its pathname. |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
434 Default: the tool name. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
435 ``args`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
436 The arguments to pass to the tool executable. You can refer to the |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
437 files being merged as well as the output file through these |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
438 variables: ``$base``, ``$local``, ``$other``, ``$output``. |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
439 Default: ``$local $base $other`` |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
440 ``premerge`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
441 Attempt to run internal non-interactive 3-way merge tool before |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
442 launching external tool. |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
443 Default: True |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
444 ``binary`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
445 This tool can merge binary files. Defaults to False, unless tool |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
446 was selected by file pattern match. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
447 ``symlink`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
448 This tool can merge symlinks. Defaults to False, even if tool was |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
449 selected by file pattern match. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
450 ``checkconflicts`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
451 Check whether there are conflicts even though the tool reported |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
452 success. |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
453 Default: False |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
454 ``checkchanged`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
455 Check whether outputs were written even though the tool reported |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
456 success. |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
457 Default: False |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
458 ``fixeol`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
459 Attempt to fix up EOL changes caused by the merge tool. |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
460 Default: False |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
461 ``gui`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
462 This tool requires a graphical interface to run. Default: False |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
463 ``regkey`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
464 Windows registry key which describes install location of this |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
465 tool. Mercurial will search for this key first under |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
466 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
467 Default: None |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
468 ``regname`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
469 Name of value to read from specified registry key. Defaults to the |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
470 unnamed (default) value. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
471 ``regappend`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
472 String to append to the value read from the registry, typically |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
473 the executable name of the tool. |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
474 Default: None |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
475 |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
476 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
477 ``hooks`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
478 """"""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
479 Commands or Python functions that get automatically executed by |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
480 various actions such as starting or finishing a commit. Multiple |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
481 hooks can be run for the same action by appending a suffix to the |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
482 action. Overriding a site-wide hook can be done by changing its |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
483 value or setting it to an empty string. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
484 |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
485 Example ``.hg/hgrc``:: |
1485
625f3f13d7be
mention running multiple hooks in the doc
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1316
diff
changeset
|
486 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
487 [hooks] |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
488 # do not use the site-wide hook |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
489 incoming = |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
490 incoming.email = /my/email/hook |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
491 incoming.autobuild = /my/build/hook |
1485
625f3f13d7be
mention running multiple hooks in the doc
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1316
diff
changeset
|
492 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
493 Most hooks are run with environment variables set that give useful |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
494 additional information. For each hook below, the environment |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
495 variables it is passed are listed with names of the form "$HG_foo". |
1727
019e6a47a53e
fix names of parent changeset ids in hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1726
diff
changeset
|
496 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
497 ``changegroup`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
498 Run after a changegroup has been added via push, pull or unbundle. |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
499 ID of the first new changeset is in ``$HG_NODE``. URL from which |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
500 changes came is in ``$HG_URL``. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
501 ``commit`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
502 Run after a changeset has been created in the local repository. ID |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
503 of the newly created changeset is in ``$HG_NODE``. Parent changeset |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
504 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
505 ``incoming`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
506 Run after a changeset has been pulled, pushed, or unbundled into |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
507 the local repository. The ID of the newly arrived changeset is in |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
508 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
509 ``outgoing`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
510 Run after sending changes from local repository to another. ID of |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
511 first changeset sent is in ``$HG_NODE``. Source of operation is in |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
512 ``$HG_SOURCE``; see "preoutgoing" hook for description. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
513 ``post-<command>`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
514 Run after successful invocations of the associated command. The |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
515 contents of the command line are passed as ``$HG_ARGS`` and the result |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
516 code in ``$HG_RESULT``. Hook failure is ignored. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
517 ``pre-<command>`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
518 Run before executing the associated command. The contents of the |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
519 command line are passed as ``$HG_ARGS``. If the hook returns failure, |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
520 the command doesn't execute and Mercurial returns the failure |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
521 code. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
522 ``prechangegroup`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
523 Run before a changegroup is added via push, pull or unbundle. Exit |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
524 status 0 allows the changegroup to proceed. Non-zero status will |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
525 cause the push, pull or unbundle to fail. URL from which changes |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
526 will come is in ``$HG_URL``. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
527 ``precommit`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
528 Run before starting a local commit. Exit status 0 allows the |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
529 commit to proceed. Non-zero status will cause the commit to fail. |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
530 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
531 ``preoutgoing`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
532 Run before collecting changes to send from the local repository to |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
533 another. Non-zero status will cause failure. This lets you prevent |
8773 | 534 pull over HTTP or SSH. Also prevents against local pull, push |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
535 (outbound) or bundle commands, but not effective, since you can |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
536 just copy files instead then. Source of operation is in |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
537 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote |
8773 | 538 SSH or HTTP repository. If "push", "pull" or "bundle", operation |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
539 is happening on behalf of repository on same system. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
540 ``pretag`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
541 Run before creating a tag. Exit status 0 allows the tag to be |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
542 created. Non-zero status will cause the tag to fail. ID of |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
543 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
544 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
545 ``pretxnchangegroup`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
546 Run after a changegroup has been added via push, pull or unbundle, |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
547 but before the transaction has been committed. Changegroup is |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
548 visible to hook program. This lets you validate incoming changes |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
549 before accepting them. Passed the ID of the first new changeset in |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
550 ``$HG_NODE``. Exit status 0 allows the transaction to commit. Non-zero |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
551 status will cause the transaction to be rolled back and the push, |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
552 pull or unbundle will fail. URL that was source of changes is in |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
553 ``$HG_URL``. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
554 ``pretxncommit`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
555 Run after a changeset has been created but the transaction not yet |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
556 committed. Changeset is visible to hook program. This lets you |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
557 validate commit message and changes. Exit status 0 allows the |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
558 commit to proceed. Non-zero status will cause the transaction to |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
559 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
560 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
561 ``preupdate`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
562 Run before updating the working directory. Exit status 0 allows |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
563 the update to proceed. Non-zero status will prevent the update. |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
564 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
565 of second new parent is in ``$HG_PARENT2``. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
566 ``tag`` |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
567 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``. |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
568 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
569 repository if ``$HG_LOCAL=0``. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
570 ``update`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
571 Run after updating the working directory. Changeset ID of first |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
572 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
573 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the |
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
574 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``. |
1726
56fb048b102c
prefix hook env var names with HG_.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1721
diff
changeset
|
575 |
8770
cc00191314a7
hgrc.5: use NOTE admonition paragraph
Martin Geisler <mg@lazybytes.net>
parents:
8769
diff
changeset
|
576 NOTE: it is generally better to use standard hooks rather than the |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
577 generic pre- and post- command hooks as they are guaranteed to be |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
578 called in the appropriate contexts for influencing transactions. |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
579 Also, hooks like "commit" will be called in all contexts that |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
580 generate a commit (e.g. tag) and not just the commit command. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
581 |
8770
cc00191314a7
hgrc.5: use NOTE admonition paragraph
Martin Geisler <mg@lazybytes.net>
parents:
8769
diff
changeset
|
582 NOTE: Environment variables with empty values may not be passed to |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
583 hooks on platforms such as Windows. As an example, ``$HG_PARENT2`` will |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
584 have an empty value under Unix-like platforms for non-merge |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
585 changesets, while it will not be available at all under Windows. |
4641
54b735135fd3
Document empty environment variables not being passed to hooks under Windows.
Patrick Mezard <pmezard@gmail.com>
parents:
4052
diff
changeset
|
586 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
587 The syntax for Python hooks is as follows:: |
2155
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
588 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
589 hookname = python:modulename.submodule.callable |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
590 hookname = python:/path/to/python/module.py:callable |
2155
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
591 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
592 Python hooks are run within the Mercurial process. Each hook is |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
593 called with at least three keyword arguments: a ui object (keyword |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
594 "ui"), a repository object (keyword "repo"), and a "hooktype" |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
595 keyword that tells what kind of hook is used. Arguments listed as |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
596 environment variables above are passed as keyword arguments, with no |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
597 ``HG_`` prefix, and names in lower case. |
2155
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
598 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
599 If a Python hook returns a "true" value or raises an exception, this |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
600 is treated as a failure. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
601 |
2155
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
602 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
603 ``http_proxy`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
604 """""""""""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
605 Used to access web-based Mercurial repositories through a HTTP |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
606 proxy. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
607 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
608 ``host`` |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
609 Host name and (optional) port of the proxy server, for example |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
610 "myproxy:8000". |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
611 ``no`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
612 Optional. Comma-separated list of host names that should bypass |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
613 the proxy. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
614 ``passwd`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
615 Optional. Password to authenticate with at the proxy server. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
616 ``user`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
617 Optional. User name to authenticate with at the proxy server. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
618 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
619 ``smtp`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
620 """""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
621 Configuration for extensions that need to send email messages. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
622 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
623 ``host`` |
2853
619f1c65384c
Adjusted documentation for hgrc's "[smtp] host" for change in 9f745d3675d4.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
2691
diff
changeset
|
624 Host name of mail server, e.g. "mail.example.com". |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
625 ``port`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
626 Optional. Port to connect to on mail server. Default: 25. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
627 ``tls`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
628 Optional. Whether to connect to mail server using TLS. True or |
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
629 False. Default: False. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
630 ``username`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
631 Optional. User name to authenticate to SMTP server with. If |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
632 username is specified, password must also be specified. |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
633 Default: none. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
634 ``password`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
635 Optional. Password to authenticate to SMTP server with. If |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
636 username is specified, password must also be specified. |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
637 Default: none. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
638 ``local_hostname`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
639 Optional. It's the hostname that the sender can use to identify |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
640 itself to the MTA. |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
641 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
642 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
643 ``patch`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
644 """"""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
645 Settings used when applying patches, for instance through the 'import' |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
646 command or with Mercurial Queues extension. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
647 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
648 ``eol`` |
8810
ac92775b3b80
Add patch.eol to ignore EOLs when patching (issue1019)
Patrick Mezard <pmezard@gmail.com>
parents:
8782
diff
changeset
|
649 When set to 'strict' patch content and patched files end of lines |
ac92775b3b80
Add patch.eol to ignore EOLs when patching (issue1019)
Patrick Mezard <pmezard@gmail.com>
parents:
8782
diff
changeset
|
650 are preserved. When set to 'lf' or 'crlf', both files end of lines |
ac92775b3b80
Add patch.eol to ignore EOLs when patching (issue1019)
Patrick Mezard <pmezard@gmail.com>
parents:
8782
diff
changeset
|
651 are ignored when patching and the result line endings are |
ac92775b3b80
Add patch.eol to ignore EOLs when patching (issue1019)
Patrick Mezard <pmezard@gmail.com>
parents:
8782
diff
changeset
|
652 normalized to either LF (Unix) or CRLF (Windows). |
ac92775b3b80
Add patch.eol to ignore EOLs when patching (issue1019)
Patrick Mezard <pmezard@gmail.com>
parents:
8782
diff
changeset
|
653 Default: strict. |
ac92775b3b80
Add patch.eol to ignore EOLs when patching (issue1019)
Patrick Mezard <pmezard@gmail.com>
parents:
8782
diff
changeset
|
654 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
655 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
656 ``paths`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
657 """"""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
658 Assigns symbolic names to repositories. The left side is the |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
659 symbolic name, and the right gives the directory or URL that is the |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
660 location of the repository. Default paths can be declared by setting |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
661 the following entries. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
662 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
663 ``default`` |
2277
066d0055e430
Add more specific documentation about defaults for the [paths] section
Daniel <byteshack@gmail.com>
parents:
2266
diff
changeset
|
664 Directory or URL to use when pulling if no source is specified. |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
665 Default is set to repository from which the current repository was |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
666 cloned. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
667 ``default-push`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
668 Optional. Directory or URL to use when pushing if no destination |
2277
066d0055e430
Add more specific documentation about defaults for the [paths] section
Daniel <byteshack@gmail.com>
parents:
2266
diff
changeset
|
669 is specified. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
670 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
671 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
672 ``profiling`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
673 """"""""""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
674 Specifies profiling format and file output. In this section |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
675 description, 'profiling data' stands for the raw data collected |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
676 during profiling, while 'profiling report' stands for a statistical |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
677 text report generated from the profiling data. The profiling is done |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
678 using lsprof. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
679 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
680 ``format`` |
8023
fd9debb3ea1b
profiling: Adding a profiling.format config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
8022
diff
changeset
|
681 Profiling format. |
fd9debb3ea1b
profiling: Adding a profiling.format config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
8022
diff
changeset
|
682 Default: text. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
683 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
684 ``text`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
685 Generate a profiling report. When saving to a file, it should be |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
686 noted that only the report is saved, and the profiling data is |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
687 not kept. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
688 ``kcachegrind`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
689 Format profiling data for kcachegrind use: when saving to a |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
690 file, the generated file can directly be loaded into |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
691 kcachegrind. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
692 ``output`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
693 File path where profiling data or report should be saved. If the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
694 file exists, it is replaced. Default: None, data is printed on |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
695 stderr |
8022
4f3fdfaa3874
profiling: Adding profiling.output config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
7916
diff
changeset
|
696 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
697 ``server`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
698 """""""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
699 Controls generic server settings. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
700 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
701 ``uncompressed`` |
8773 | 702 Whether to allow clients to clone a repository using the |
703 uncompressed streaming protocol. This transfers about 40% more | |
704 data than a regular clone, but uses less memory and CPU on both | |
705 server and client. Over a LAN (100 Mbps or better) or a very fast | |
706 WAN, an uncompressed streaming clone is a lot faster (~10x) than a | |
707 regular clone. Over most WAN connections (anything slower than | |
708 about 6 Mbps), uncompressed streaming is slower, because of the | |
709 extra data transfer overhead. Default is False. | |
2621
5a5852a417b1
clone: disable stream support on server side by default.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2583
diff
changeset
|
710 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
711 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
712 ``trusted`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
713 """"""""""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
714 For security reasons, Mercurial will not use the settings in the |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
715 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
716 user or to a trusted group. The main exception is the web interface, |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
717 which automatically uses some safe settings, since it's common to |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
718 serve repositories from different users. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
719 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
720 This section specifies what users and groups are trusted. The |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
721 current user is always trusted. To trust everybody, list a user or a |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
722 group with name ``*``. |
3552
9b52239dc740
save settings from untrusted config files in a separate configparser
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3551
diff
changeset
|
723 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
724 ``users`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
725 Comma-separated list of trusted users. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
726 ``groups`` |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
727 Comma-separated list of trusted groups. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
728 |
3551
3b07e223534b
Only read .hg/hgrc files from trusted users/groups
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3489
diff
changeset
|
729 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
730 ``ui`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
731 """""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
732 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
733 User interface controls. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
734 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
735 ``archivemeta`` |
8773 | 736 Whether to include the .hg_archival.txt file containing meta data |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
737 (hashes for the repository base and for tip) in archives created |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
738 by the hg archive command or downloaded via hgweb. |
6183
0750e4ba9d3d
Add config option to disable putting .hg_archival.txt inside archives.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
6175
diff
changeset
|
739 Default is true. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
740 ``askusername`` |
6862
7192876ac329
ui: add an option to prompt for the username when it isn't provided
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
6614
diff
changeset
|
741 Whether to prompt for a username when committing. If True, and |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
742 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
743 be prompted to enter a username. If no username is entered, the |
6862
7192876ac329
ui: add an option to prompt for the username when it isn't provided
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
6614
diff
changeset
|
744 default USER@HOST is used instead. |
7192876ac329
ui: add an option to prompt for the username when it isn't provided
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
6614
diff
changeset
|
745 Default is False. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
746 ``debug`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
747 Print debugging information. True or False. Default is False. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
748 ``editor`` |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
749 The editor to use during a commit. Default is ``$EDITOR`` or "vi". |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
750 ``fallbackencoding`` |
3835
d1ce5461beed
Allow the user to specify the fallback encoding for the changelog
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3721
diff
changeset
|
751 Encoding to try if it's not possible to decode the changelog using |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
752 UTF-8. Default is ISO-8859-1. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
753 ``ignore`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
754 A file to read per-user ignore patterns from. This file should be |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
755 in the same format as a repository-wide .hgignore file. This |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
756 option supports hook syntax, so if you want to specify multiple |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
757 ignore files, you can do so by setting something like |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
758 ``ignore.other = ~/.hgignore2``. For details of the ignore file |
9162
2399362b3bb0
doc: link man pages to one another
Martin Geisler <mg@lazybytes.net>
parents:
9161
diff
changeset
|
759 format, see the |hgignore(5)|_ man page. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
760 ``interactive`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
761 Allow to prompt the user. True or False. Default is True. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
762 ``logtemplate`` |
1907
7718885070b1
let commands that show changesets use templates.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1788
diff
changeset
|
763 Template string for commands that print changesets. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
764 ``merge`` |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
765 The conflict resolution program to use during a manual merge. |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
766 There are some internal tools available: |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
767 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
768 ``internal:local`` |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
769 keep the local version |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
770 ``internal:other`` |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
771 use the other version |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
772 ``internal:merge`` |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
773 use the internal non-interactive merge tool |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
774 ``internal:fail`` |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
775 fail to merge |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
776 |
8769
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
777 For more information on configuring merge tools see the |
a5d0e821ab77
hgrc.5: reformatted to avoid big chunks of monospaced text
Martin Geisler <mg@lazybytes.net>
parents:
8768
diff
changeset
|
778 merge-tools section. |
6445
a1db3d8b9b8a
hgrc.5: fix subsection formatting
Christian Ebert <blacktrash@gmx.net>
parents:
6325
diff
changeset
|
779 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
780 ``patch`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
781 command to use to apply patches. Look for 'gpatch' or 'patch' in |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
782 PATH if unset. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
783 ``quiet`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
784 Reduce the amount of output printed. True or False. Default is False. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
785 ``remotecmd`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
786 remote command to use for clone/push/pull operations. Default is 'hg'. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
787 ``report_untrusted`` |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
788 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
789 trusted user or group. True or False. Default is True. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
790 ``slash`` |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
791 Display paths using a slash (``/``) as the path separator. This |
8782
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
792 only makes a difference on systems where the default path |
d19ab9a56bf4
doc: wrap man pages after fixing quoting
Martin Geisler <mg@lazybytes.net>
parents:
8781
diff
changeset
|
793 separator is not the slash character (e.g. Windows uses the |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
794 backslash character (``\``)). |
4527
b422b558015b
Add ui.slash hgrc setting
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
4435
diff
changeset
|
795 Default is False. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
796 ``ssh`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
797 command to use for SSH connections. Default is 'ssh'. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
798 ``strict`` |
2988
63c3a1921a67
Add ui.strict config item.
Bryan O'Sullivan <bos@serpentine.com>
parents:
2853
diff
changeset
|
799 Require exact command names, instead of allowing unambiguous |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
800 abbreviations. True or False. Default is False. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
801 ``style`` |
4715
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
802 Name of style to use for command output. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
803 ``timeout`` |
1787
e431344e604c
add a timeout when a lock is held (default 1024 sec)
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1736
diff
changeset
|
804 The timeout used when a lock is held (in seconds), a negative value |
1788
750b9cd83965
change the default timeout to 600 seconds
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1787
diff
changeset
|
805 means no timeout. Default is 600. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
806 ``username`` |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
807 The committer of a changeset created when running "commit". |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
808 Typically a person's name and email address, e.g. "Fred Widget |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
809 <fred@example.com>". Default is ``$EMAIL`` or username@hostname. If |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
810 the username in hgrc is empty, it has to be specified manually or |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
811 in a different hgrc file (e.g. ``$HOME/.hgrc``, if the admin set |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
812 "username =" in the system hgrc). |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
813 ``verbose`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
814 Increase the amount of output printed. True or False. Default is False. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
815 |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
816 |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
817 ``web`` |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
818 """"""" |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
819 Web interface configuration. |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
820 |
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
821 ``accesslog`` |
938 | 822 Where to output the access log. Default is stdout. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
823 ``address`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
824 Interface address to bind to. Default is all. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
825 ``allow_archive`` |
2358
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
826 List of archive format (bz2, gz, zip) allowed for downloading. |
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
827 Default is empty. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
828 ``allowbz2`` |
8773 | 829 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository |
830 revisions. | |
2358
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
831 Default is false. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
832 ``allowgz`` |
8773 | 833 (DEPRECATED) Whether to allow .tar.gz downloading of repository |
834 revisions. | |
2358
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
835 Default is false. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
836 ``allowpull`` |
964
3f37720e7dc7
hgweb: Make maxfiles, maxchanges, and allowpull proper config options
mpm@selenic.com
parents:
962
diff
changeset
|
837 Whether to allow pulling from the repository. Default is true. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
838 ``allow_push`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
839 Whether to allow pushing to the repository. If empty or not set, |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
840 push is not allowed. If the special value ``*``, any remote user can |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
841 push, including unauthenticated users. Otherwise, the remote user |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
842 must have been authenticated, and the authenticated user name must |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
843 be present in this list (separated by whitespace or ","). The |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
844 contents of the allow_push list are examined after the deny_push |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
845 list. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
846 ``allow_read`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
847 If the user has not already been denied repository access due to |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
848 the contents of deny_read, this list determines whether to grant |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
849 repository access to the user. If this list is not empty, and the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
850 user is unauthenticated or not present in the list (separated by |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
851 whitespace or ","), then access is denied for the user. If the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
852 list is empty or not set, then access is permitted to all users by |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
853 default. Setting allow_read to the special value ``*`` is equivalent |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
854 to it not being set (i.e. access is permitted to all users). The |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
855 contents of the allow_read list are examined after the deny_read |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
856 list. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
857 ``allowzip`` |
8773 | 858 (DEPRECATED) Whether to allow .zip downloading of repository |
859 revisions. Default is false. This feature creates temporary files. | |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
860 ``baseurl`` |
2197
5de8b44f0446
define standard name for base url to use when printing hgweb urls.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2155
diff
changeset
|
861 Base URL to use when publishing URLs in other locations, so |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
862 third-party tools like email notification hooks can construct |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
863 URLs. Example: "http://hgserver/repos/" |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
864 ``contact`` |
2430
4ccd71b83d5e
Add web.contact to the hgrc documentation.
"Daniel Santa Cruz <byteshack@gmail.com>"
parents:
2387
diff
changeset
|
865 Name or email address of the person in charge of the repository. |
9161
e8b653a4b8da
doc: fixup font markup in man pages
Martin Geisler <mg@lazybytes.net>
parents:
9158
diff
changeset
|
866 Defaults to ui.username or ``$EMAIL`` or "unknown" if unset or empty. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
867 ``deny_push`` |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
868 Whether to deny pushing to the repository. If empty or not set, |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
869 push is not denied. If the special value ``*``, all remote users are |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
870 denied push. Otherwise, unauthenticated users are all denied, and |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
871 any authenticated user name present in this list (separated by |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
872 whitespace or ",") is also denied. The contents of the deny_push |
2466
e10665147d26
push over http: server side authorization support.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2430
diff
changeset
|
873 list are examined before the allow_push list. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
874 ``deny_read`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
875 Whether to deny reading/viewing of the repository. If this list is |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
876 not empty, unauthenticated users are all denied, and any |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
877 authenticated user name present in this list (separated by |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
878 whitespace or ",") is also denied access to the repository. If set |
9624
585d2ffe969b
doc, help: stream-line use of inline-literals
Martin Geisler <mg@lazybytes.net>
parents:
9569
diff
changeset
|
879 to the special value ``*``, all remote users are denied access |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
880 (rarely needed ;). If deny_read is empty or not set, the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
881 determination of repository access depends on the presence and |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
882 content of the allow_read list (see description). If both |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
883 deny_read and allow_read are empty or not set, then access is |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
884 permitted to all users by default. If the repository is being |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
885 served via hgwebdir, denied users will not be able to see it in |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
886 the list of repositories. The contents of the deny_read list have |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
887 priority over (are examined before) the contents of the allow_read |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
888 list. |
9363
8635b33eaade
hgweb: add web.descend configuration variable
Dirkjan Ochtman <dirkjan@ochtman.nl>
parents:
9162
diff
changeset
|
889 ``descend`` |
8635b33eaade
hgweb: add web.descend configuration variable
Dirkjan Ochtman <dirkjan@ochtman.nl>
parents:
9162
diff
changeset
|
890 hgwebdir indexes will not descend into subdirectories. Only repositories |
8635b33eaade
hgweb: add web.descend configuration variable
Dirkjan Ochtman <dirkjan@ochtman.nl>
parents:
9162
diff
changeset
|
891 directly in the current path will be shown (other repositories are still |
8635b33eaade
hgweb: add web.descend configuration variable
Dirkjan Ochtman <dirkjan@ochtman.nl>
parents:
9162
diff
changeset
|
892 available from the index corresponding to their containing path). |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
893 ``description`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
894 Textual description of the repository's purpose or contents. |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
895 Default is "unknown". |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
896 ``encoding`` |
4715
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
897 Character encoding name. |
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
898 Example: "UTF-8" |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
899 ``errorlog`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
900 Where to output the error log. Default is stderr. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
901 ``hidden`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
902 Whether to hide the repository in the hgwebdir index. |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
903 Default is false. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
904 ``ipv6`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
905 Whether to use IPv6. Default is false. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
906 ``name`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
907 Repository name to use in the web interface. Default is current |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
908 working directory. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
909 ``maxchanges`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
910 Maximum number of changes to list on the changelog. Default is 10. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
911 ``maxfiles`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
912 Maximum number of files to list per changeset. Default is 10. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
913 ``port`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
914 Port to listen on. Default is 8000. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
915 ``prefix`` |
5972
d83020d0466f
added an entry about the prefix option inside the hgrc man page
Michele Cella <michele.cella@gmail.com>
parents:
5779
diff
changeset
|
916 Prefix path to serve from. Default is '' (server root). |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
917 ``push_ssl`` |
2466
e10665147d26
push over http: server side authorization support.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2430
diff
changeset
|
918 Whether to require that inbound pushes be transported over SSL to |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
919 prevent password sniffing. Default is true. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
920 ``staticurl`` |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
921 Base URL to use for static files. If unset, static files (e.g. the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
922 hgicon.png favicon) will be served by the CGI script itself. Use |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
923 this setting to serve them directly with the HTTP server. |
4084
51e52db6b40d
hgweb: allow static files to be served directly by the HTTP server
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
4052
diff
changeset
|
924 Example: "http://hgserver/static/" |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
925 ``stripes`` |
2666
ebf033bc8eb2
hgweb: Configurable zebra stripes
Frank Kingswood <frank@kingswood-consulting.co.uk>
parents:
2622
diff
changeset
|
926 How many lines a "zebra stripe" should span in multiline output. |
ebf033bc8eb2
hgweb: Configurable zebra stripes
Frank Kingswood <frank@kingswood-consulting.co.uk>
parents:
2622
diff
changeset
|
927 Default is 1; set to 0 to disable. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
928 ``style`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
929 Which template map style to use. |
9158
d6eecafaf12f
doc: use reStructuredText for man and HTML pages
Martin Geisler <mg@lazybytes.net>
parents:
8900
diff
changeset
|
930 ``templates`` |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
931 Where to find the HTML templates. Default is install path. |
1079 | 932 |
938 | 933 |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
934 AUTHOR |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
935 ------ |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
936 Bryan O'Sullivan <bos@serpentine.com>. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
937 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
938 Mercurial was written by Matt Mackall <mpm@selenic.com>. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
939 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
940 SEE ALSO |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
941 -------- |
9162
2399362b3bb0
doc: link man pages to one another
Martin Geisler <mg@lazybytes.net>
parents:
9161
diff
changeset
|
942 |hg(1)|_, |hgignore(5)|_ |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
943 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
944 COPYING |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
945 ------- |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
946 This manual page is copyright 2005 Bryan O'Sullivan. |
8771
a2871de50f50
man pages: updated copyright years
Martin Geisler <mg@lazybytes.net>
parents:
8770
diff
changeset
|
947 Mercurial is copyright 2005-2009 Matt Mackall. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
948 Free use of this software is granted under the terms of the GNU General |
9510
8bd669948b2e
doc: clarify license footers
Adrian Buehlmann <adrian@cadifra.com>
parents:
9422
diff
changeset
|
949 Public License version 2. |
9162
2399362b3bb0
doc: link man pages to one another
Martin Geisler <mg@lazybytes.net>
parents:
9161
diff
changeset
|
950 |
2399362b3bb0
doc: link man pages to one another
Martin Geisler <mg@lazybytes.net>
parents:
9161
diff
changeset
|
951 .. include:: common.txt |