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