##// END OF EJS Templates
help: add missing `.` in config reference...
marmoute -
r49576:4344fd26 stable
parent child Browse files
Show More
@@ -1,3151 +1,3151 b''
1 The Mercurial system uses a set of configuration files to control
1 The Mercurial system uses a set of configuration files to control
2 aspects of its behavior.
2 aspects of its behavior.
3
3
4 Troubleshooting
4 Troubleshooting
5 ===============
5 ===============
6
6
7 If you're having problems with your configuration,
7 If you're having problems with your configuration,
8 :hg:`config --source` can help you understand what is introducing
8 :hg:`config --source` can help you understand what is introducing
9 a setting into your environment.
9 a setting into your environment.
10
10
11 See :hg:`help config.syntax` and :hg:`help config.files`
11 See :hg:`help config.syntax` and :hg:`help config.files`
12 for information about how and where to override things.
12 for information about how and where to override things.
13
13
14 Structure
14 Structure
15 =========
15 =========
16
16
17 The configuration files use a simple ini-file format. A configuration
17 The configuration files use a simple ini-file format. A configuration
18 file consists of sections, led by a ``[section]`` header and followed
18 file consists of sections, led by a ``[section]`` header and followed
19 by ``name = value`` entries::
19 by ``name = value`` entries::
20
20
21 [ui]
21 [ui]
22 username = Firstname Lastname <firstname.lastname@example.net>
22 username = Firstname Lastname <firstname.lastname@example.net>
23 verbose = True
23 verbose = True
24
24
25 The above entries will be referred to as ``ui.username`` and
25 The above entries will be referred to as ``ui.username`` and
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
27
27
28 Files
28 Files
29 =====
29 =====
30
30
31 Mercurial reads configuration data from several files, if they exist.
31 Mercurial reads configuration data from several files, if they exist.
32 These files do not exist by default and you will have to create the
32 These files do not exist by default and you will have to create the
33 appropriate configuration files yourself:
33 appropriate configuration files yourself:
34
34
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
36
36
37 Global configuration like the username setting is typically put into:
37 Global configuration like the username setting is typically put into:
38
38
39 .. container:: windows
39 .. container:: windows
40
40
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
42
42
43 .. container:: unix.plan9
43 .. container:: unix.plan9
44
44
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
46
46
47 The names of these files depend on the system on which Mercurial is
47 The names of these files depend on the system on which Mercurial is
48 installed. ``*.rc`` files from a single directory are read in
48 installed. ``*.rc`` files from a single directory are read in
49 alphabetical order, later ones overriding earlier ones. Where multiple
49 alphabetical order, later ones overriding earlier ones. Where multiple
50 paths are given below, settings from earlier paths override later
50 paths are given below, settings from earlier paths override later
51 ones.
51 ones.
52
52
53 .. container:: verbose.unix
53 .. container:: verbose.unix
54
54
55 On Unix, the following files are consulted:
55 On Unix, the following files are consulted:
56
56
57 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
57 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
58 - ``<repo>/.hg/hgrc`` (per-repository)
58 - ``<repo>/.hg/hgrc`` (per-repository)
59 - ``$HOME/.hgrc`` (per-user)
59 - ``$HOME/.hgrc`` (per-user)
60 - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
60 - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
61 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
61 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
62 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
62 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
63 - ``/etc/mercurial/hgrc`` (per-system)
63 - ``/etc/mercurial/hgrc`` (per-system)
64 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
64 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
65 - ``<internal>/*.rc`` (defaults)
65 - ``<internal>/*.rc`` (defaults)
66
66
67 .. container:: verbose.windows
67 .. container:: verbose.windows
68
68
69 On Windows, the following files are consulted:
69 On Windows, the following files are consulted:
70
70
71 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
71 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
72 - ``<repo>/.hg/hgrc`` (per-repository)
72 - ``<repo>/.hg/hgrc`` (per-repository)
73 - ``%USERPROFILE%\.hgrc`` (per-user)
73 - ``%USERPROFILE%\.hgrc`` (per-user)
74 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
74 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
75 - ``%HOME%\.hgrc`` (per-user)
75 - ``%HOME%\.hgrc`` (per-user)
76 - ``%HOME%\Mercurial.ini`` (per-user)
76 - ``%HOME%\Mercurial.ini`` (per-user)
77 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-system)
77 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-system)
78 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
78 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
79 - ``<install-dir>\Mercurial.ini`` (per-installation)
79 - ``<install-dir>\Mercurial.ini`` (per-installation)
80 - ``%PROGRAMDATA%\Mercurial\hgrc`` (per-system)
80 - ``%PROGRAMDATA%\Mercurial\hgrc`` (per-system)
81 - ``%PROGRAMDATA%\Mercurial\Mercurial.ini`` (per-system)
81 - ``%PROGRAMDATA%\Mercurial\Mercurial.ini`` (per-system)
82 - ``%PROGRAMDATA%\Mercurial\hgrc.d\*.rc`` (per-system)
82 - ``%PROGRAMDATA%\Mercurial\hgrc.d\*.rc`` (per-system)
83 - ``<internal>/*.rc`` (defaults)
83 - ``<internal>/*.rc`` (defaults)
84
84
85 .. note::
85 .. note::
86
86
87 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
87 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
88 is used when running 32-bit Python on 64-bit Windows.
88 is used when running 32-bit Python on 64-bit Windows.
89
89
90 .. container:: verbose.plan9
90 .. container:: verbose.plan9
91
91
92 On Plan9, the following files are consulted:
92 On Plan9, the following files are consulted:
93
93
94 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
94 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
95 - ``<repo>/.hg/hgrc`` (per-repository)
95 - ``<repo>/.hg/hgrc`` (per-repository)
96 - ``$home/lib/hgrc`` (per-user)
96 - ``$home/lib/hgrc`` (per-user)
97 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
97 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
98 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
98 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
99 - ``/lib/mercurial/hgrc`` (per-system)
99 - ``/lib/mercurial/hgrc`` (per-system)
100 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
100 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
101 - ``<internal>/*.rc`` (defaults)
101 - ``<internal>/*.rc`` (defaults)
102
102
103 Per-repository configuration options only apply in a
103 Per-repository configuration options only apply in a
104 particular repository. This file is not version-controlled, and
104 particular repository. This file is not version-controlled, and
105 will not get transferred during a "clone" operation. Options in
105 will not get transferred during a "clone" operation. Options in
106 this file override options in all other configuration files.
106 this file override options in all other configuration files.
107
107
108 .. container:: unix.plan9
108 .. container:: unix.plan9
109
109
110 On Plan 9 and Unix, most of this file will be ignored if it doesn't
110 On Plan 9 and Unix, most of this file will be ignored if it doesn't
111 belong to a trusted user or to a trusted group. See
111 belong to a trusted user or to a trusted group. See
112 :hg:`help config.trusted` for more details.
112 :hg:`help config.trusted` for more details.
113
113
114 Per-user configuration file(s) are for the user running Mercurial. Options
114 Per-user configuration file(s) are for the user running Mercurial. Options
115 in these files apply to all Mercurial commands executed by this user in any
115 in these files apply to all Mercurial commands executed by this user in any
116 directory. Options in these files override per-system and per-installation
116 directory. Options in these files override per-system and per-installation
117 options.
117 options.
118
118
119 Per-installation configuration files are searched for in the
119 Per-installation configuration files are searched for in the
120 directory where Mercurial is installed. ``<install-root>`` is the
120 directory where Mercurial is installed. ``<install-root>`` is the
121 parent directory of the **hg** executable (or symlink) being run.
121 parent directory of the **hg** executable (or symlink) being run.
122
122
123 .. container:: unix.plan9
123 .. container:: unix.plan9
124
124
125 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
125 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
126 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
126 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
127 files apply to all Mercurial commands executed by any user in any
127 files apply to all Mercurial commands executed by any user in any
128 directory.
128 directory.
129
129
130 Per-installation configuration files are for the system on
130 Per-installation configuration files are for the system on
131 which Mercurial is running. Options in these files apply to all
131 which Mercurial is running. Options in these files apply to all
132 Mercurial commands executed by any user in any directory. Registry
132 Mercurial commands executed by any user in any directory. Registry
133 keys contain PATH-like strings, every part of which must reference
133 keys contain PATH-like strings, every part of which must reference
134 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
134 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
135 be read. Mercurial checks each of these locations in the specified
135 be read. Mercurial checks each of these locations in the specified
136 order until one or more configuration files are detected.
136 order until one or more configuration files are detected.
137
137
138 Per-system configuration files are for the system on which Mercurial
138 Per-system configuration files are for the system on which Mercurial
139 is running. Options in these files apply to all Mercurial commands
139 is running. Options in these files apply to all Mercurial commands
140 executed by any user in any directory. Options in these files
140 executed by any user in any directory. Options in these files
141 override per-installation options.
141 override per-installation options.
142
142
143 Mercurial comes with some default configuration. The default configuration
143 Mercurial comes with some default configuration. The default configuration
144 files are installed with Mercurial and will be overwritten on upgrades. Default
144 files are installed with Mercurial and will be overwritten on upgrades. Default
145 configuration files should never be edited by users or administrators but can
145 configuration files should never be edited by users or administrators but can
146 be overridden in other configuration files. So far the directory only contains
146 be overridden in other configuration files. So far the directory only contains
147 merge tool configuration but packagers can also put other default configuration
147 merge tool configuration but packagers can also put other default configuration
148 there.
148 there.
149
149
150 On versions 5.7 and later, if share-safe functionality is enabled,
150 On versions 5.7 and later, if share-safe functionality is enabled,
151 shares will read config file of share source too.
151 shares will read config file of share source too.
152 `<share-source/.hg/hgrc>` is read before reading `<repo/.hg/hgrc>`.
152 `<share-source/.hg/hgrc>` is read before reading `<repo/.hg/hgrc>`.
153
153
154 For configs which should not be shared, `<repo/.hg/hgrc-not-shared>`
154 For configs which should not be shared, `<repo/.hg/hgrc-not-shared>`
155 should be used.
155 should be used.
156
156
157 Syntax
157 Syntax
158 ======
158 ======
159
159
160 A configuration file consists of sections, led by a ``[section]`` header
160 A configuration file consists of sections, led by a ``[section]`` header
161 and followed by ``name = value`` entries (sometimes called
161 and followed by ``name = value`` entries (sometimes called
162 ``configuration keys``)::
162 ``configuration keys``)::
163
163
164 [spam]
164 [spam]
165 eggs=ham
165 eggs=ham
166 green=
166 green=
167 eggs
167 eggs
168
168
169 Each line contains one entry. If the lines that follow are indented,
169 Each line contains one entry. If the lines that follow are indented,
170 they are treated as continuations of that entry. Leading whitespace is
170 they are treated as continuations of that entry. Leading whitespace is
171 removed from values. Empty lines are skipped. Lines beginning with
171 removed from values. Empty lines are skipped. Lines beginning with
172 ``#`` or ``;`` are ignored and may be used to provide comments.
172 ``#`` or ``;`` are ignored and may be used to provide comments.
173
173
174 Configuration keys can be set multiple times, in which case Mercurial
174 Configuration keys can be set multiple times, in which case Mercurial
175 will use the value that was configured last. As an example::
175 will use the value that was configured last. As an example::
176
176
177 [spam]
177 [spam]
178 eggs=large
178 eggs=large
179 ham=serrano
179 ham=serrano
180 eggs=small
180 eggs=small
181
181
182 This would set the configuration key named ``eggs`` to ``small``.
182 This would set the configuration key named ``eggs`` to ``small``.
183
183
184 It is also possible to define a section multiple times. A section can
184 It is also possible to define a section multiple times. A section can
185 be redefined on the same and/or on different configuration files. For
185 be redefined on the same and/or on different configuration files. For
186 example::
186 example::
187
187
188 [foo]
188 [foo]
189 eggs=large
189 eggs=large
190 ham=serrano
190 ham=serrano
191 eggs=small
191 eggs=small
192
192
193 [bar]
193 [bar]
194 eggs=ham
194 eggs=ham
195 green=
195 green=
196 eggs
196 eggs
197
197
198 [foo]
198 [foo]
199 ham=prosciutto
199 ham=prosciutto
200 eggs=medium
200 eggs=medium
201 bread=toasted
201 bread=toasted
202
202
203 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
203 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
204 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
204 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
205 respectively. As you can see there only thing that matters is the last
205 respectively. As you can see there only thing that matters is the last
206 value that was set for each of the configuration keys.
206 value that was set for each of the configuration keys.
207
207
208 If a configuration key is set multiple times in different
208 If a configuration key is set multiple times in different
209 configuration files the final value will depend on the order in which
209 configuration files the final value will depend on the order in which
210 the different configuration files are read, with settings from earlier
210 the different configuration files are read, with settings from earlier
211 paths overriding later ones as described on the ``Files`` section
211 paths overriding later ones as described on the ``Files`` section
212 above.
212 above.
213
213
214 A line of the form ``%include file`` will include ``file`` into the
214 A line of the form ``%include file`` will include ``file`` into the
215 current configuration file. The inclusion is recursive, which means
215 current configuration file. The inclusion is recursive, which means
216 that included files can include other files. Filenames are relative to
216 that included files can include other files. Filenames are relative to
217 the configuration file in which the ``%include`` directive is found.
217 the configuration file in which the ``%include`` directive is found.
218 Environment variables and ``~user`` constructs are expanded in
218 Environment variables and ``~user`` constructs are expanded in
219 ``file``. This lets you do something like::
219 ``file``. This lets you do something like::
220
220
221 %include ~/.hgrc.d/$HOST.rc
221 %include ~/.hgrc.d/$HOST.rc
222
222
223 to include a different configuration file on each computer you use.
223 to include a different configuration file on each computer you use.
224
224
225 A line with ``%unset name`` will remove ``name`` from the current
225 A line with ``%unset name`` will remove ``name`` from the current
226 section, if it has been set previously.
226 section, if it has been set previously.
227
227
228 The values are either free-form text strings, lists of text strings,
228 The values are either free-form text strings, lists of text strings,
229 or Boolean values. Boolean values can be set to true using any of "1",
229 or Boolean values. Boolean values can be set to true using any of "1",
230 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
230 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
231 (all case insensitive).
231 (all case insensitive).
232
232
233 List values are separated by whitespace or comma, except when values are
233 List values are separated by whitespace or comma, except when values are
234 placed in double quotation marks::
234 placed in double quotation marks::
235
235
236 allow_read = "John Doe, PhD", brian, betty
236 allow_read = "John Doe, PhD", brian, betty
237
237
238 Quotation marks can be escaped by prefixing them with a backslash. Only
238 Quotation marks can be escaped by prefixing them with a backslash. Only
239 quotation marks at the beginning of a word is counted as a quotation
239 quotation marks at the beginning of a word is counted as a quotation
240 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
240 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
241
241
242 Sections
242 Sections
243 ========
243 ========
244
244
245 This section describes the different sections that may appear in a
245 This section describes the different sections that may appear in a
246 Mercurial configuration file, the purpose of each section, its possible
246 Mercurial configuration file, the purpose of each section, its possible
247 keys, and their possible values.
247 keys, and their possible values.
248
248
249 ``alias``
249 ``alias``
250 ---------
250 ---------
251
251
252 Defines command aliases.
252 Defines command aliases.
253
253
254 Aliases allow you to define your own commands in terms of other
254 Aliases allow you to define your own commands in terms of other
255 commands (or aliases), optionally including arguments. Positional
255 commands (or aliases), optionally including arguments. Positional
256 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
256 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
257 are expanded by Mercurial before execution. Positional arguments not
257 are expanded by Mercurial before execution. Positional arguments not
258 already used by ``$N`` in the definition are put at the end of the
258 already used by ``$N`` in the definition are put at the end of the
259 command to be executed.
259 command to be executed.
260
260
261 Alias definitions consist of lines of the form::
261 Alias definitions consist of lines of the form::
262
262
263 <alias> = <command> [<argument>]...
263 <alias> = <command> [<argument>]...
264
264
265 For example, this definition::
265 For example, this definition::
266
266
267 latest = log --limit 5
267 latest = log --limit 5
268
268
269 creates a new command ``latest`` that shows only the five most recent
269 creates a new command ``latest`` that shows only the five most recent
270 changesets. You can define subsequent aliases using earlier ones::
270 changesets. You can define subsequent aliases using earlier ones::
271
271
272 stable5 = latest -b stable
272 stable5 = latest -b stable
273
273
274 .. note::
274 .. note::
275
275
276 It is possible to create aliases with the same names as
276 It is possible to create aliases with the same names as
277 existing commands, which will then override the original
277 existing commands, which will then override the original
278 definitions. This is almost always a bad idea!
278 definitions. This is almost always a bad idea!
279
279
280 An alias can start with an exclamation point (``!``) to make it a
280 An alias can start with an exclamation point (``!``) to make it a
281 shell alias. A shell alias is executed with the shell and will let you
281 shell alias. A shell alias is executed with the shell and will let you
282 run arbitrary commands. As an example, ::
282 run arbitrary commands. As an example, ::
283
283
284 echo = !echo $@
284 echo = !echo $@
285
285
286 will let you do ``hg echo foo`` to have ``foo`` printed in your
286 will let you do ``hg echo foo`` to have ``foo`` printed in your
287 terminal. A better example might be::
287 terminal. A better example might be::
288
288
289 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
289 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
290
290
291 which will make ``hg purge`` delete all unknown files in the
291 which will make ``hg purge`` delete all unknown files in the
292 repository in the same manner as the purge extension.
292 repository in the same manner as the purge extension.
293
293
294 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
294 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
295 expand to the command arguments. Unmatched arguments are
295 expand to the command arguments. Unmatched arguments are
296 removed. ``$0`` expands to the alias name and ``$@`` expands to all
296 removed. ``$0`` expands to the alias name and ``$@`` expands to all
297 arguments separated by a space. ``"$@"`` (with quotes) expands to all
297 arguments separated by a space. ``"$@"`` (with quotes) expands to all
298 arguments quoted individually and separated by a space. These expansions
298 arguments quoted individually and separated by a space. These expansions
299 happen before the command is passed to the shell.
299 happen before the command is passed to the shell.
300
300
301 Shell aliases are executed in an environment where ``$HG`` expands to
301 Shell aliases are executed in an environment where ``$HG`` expands to
302 the path of the Mercurial that was used to execute the alias. This is
302 the path of the Mercurial that was used to execute the alias. This is
303 useful when you want to call further Mercurial commands in a shell
303 useful when you want to call further Mercurial commands in a shell
304 alias, as was done above for the purge alias. In addition,
304 alias, as was done above for the purge alias. In addition,
305 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
305 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
306 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
306 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
307
307
308 .. note::
308 .. note::
309
309
310 Some global configuration options such as ``-R`` are
310 Some global configuration options such as ``-R`` are
311 processed before shell aliases and will thus not be passed to
311 processed before shell aliases and will thus not be passed to
312 aliases.
312 aliases.
313
313
314
314
315 ``annotate``
315 ``annotate``
316 ------------
316 ------------
317
317
318 Settings used when displaying file annotations. All values are
318 Settings used when displaying file annotations. All values are
319 Booleans and default to False. See :hg:`help config.diff` for
319 Booleans and default to False. See :hg:`help config.diff` for
320 related options for the diff command.
320 related options for the diff command.
321
321
322 ``ignorews``
322 ``ignorews``
323 Ignore white space when comparing lines.
323 Ignore white space when comparing lines.
324
324
325 ``ignorewseol``
325 ``ignorewseol``
326 Ignore white space at the end of a line when comparing lines.
326 Ignore white space at the end of a line when comparing lines.
327
327
328 ``ignorewsamount``
328 ``ignorewsamount``
329 Ignore changes in the amount of white space.
329 Ignore changes in the amount of white space.
330
330
331 ``ignoreblanklines``
331 ``ignoreblanklines``
332 Ignore changes whose lines are all blank.
332 Ignore changes whose lines are all blank.
333
333
334
334
335 ``auth``
335 ``auth``
336 --------
336 --------
337
337
338 Authentication credentials and other authentication-like configuration
338 Authentication credentials and other authentication-like configuration
339 for HTTP connections. This section allows you to store usernames and
339 for HTTP connections. This section allows you to store usernames and
340 passwords for use when logging *into* HTTP servers. See
340 passwords for use when logging *into* HTTP servers. See
341 :hg:`help config.web` if you want to configure *who* can login to
341 :hg:`help config.web` if you want to configure *who* can login to
342 your HTTP server.
342 your HTTP server.
343
343
344 The following options apply to all hosts.
344 The following options apply to all hosts.
345
345
346 ``cookiefile``
346 ``cookiefile``
347 Path to a file containing HTTP cookie lines. Cookies matching a
347 Path to a file containing HTTP cookie lines. Cookies matching a
348 host will be sent automatically.
348 host will be sent automatically.
349
349
350 The file format uses the Mozilla cookies.txt format, which defines cookies
350 The file format uses the Mozilla cookies.txt format, which defines cookies
351 on their own lines. Each line contains 7 fields delimited by the tab
351 on their own lines. Each line contains 7 fields delimited by the tab
352 character (domain, is_domain_cookie, path, is_secure, expires, name,
352 character (domain, is_domain_cookie, path, is_secure, expires, name,
353 value). For more info, do an Internet search for "Netscape cookies.txt
353 value). For more info, do an Internet search for "Netscape cookies.txt
354 format."
354 format."
355
355
356 Note: the cookies parser does not handle port numbers on domains. You
356 Note: the cookies parser does not handle port numbers on domains. You
357 will need to remove ports from the domain for the cookie to be recognized.
357 will need to remove ports from the domain for the cookie to be recognized.
358 This could result in a cookie being disclosed to an unwanted server.
358 This could result in a cookie being disclosed to an unwanted server.
359
359
360 The cookies file is read-only.
360 The cookies file is read-only.
361
361
362 Other options in this section are grouped by name and have the following
362 Other options in this section are grouped by name and have the following
363 format::
363 format::
364
364
365 <name>.<argument> = <value>
365 <name>.<argument> = <value>
366
366
367 where ``<name>`` is used to group arguments into authentication
367 where ``<name>`` is used to group arguments into authentication
368 entries. Example::
368 entries. Example::
369
369
370 foo.prefix = hg.intevation.de/mercurial
370 foo.prefix = hg.intevation.de/mercurial
371 foo.username = foo
371 foo.username = foo
372 foo.password = bar
372 foo.password = bar
373 foo.schemes = http https
373 foo.schemes = http https
374
374
375 bar.prefix = secure.example.org
375 bar.prefix = secure.example.org
376 bar.key = path/to/file.key
376 bar.key = path/to/file.key
377 bar.cert = path/to/file.cert
377 bar.cert = path/to/file.cert
378 bar.schemes = https
378 bar.schemes = https
379
379
380 Supported arguments:
380 Supported arguments:
381
381
382 ``prefix``
382 ``prefix``
383 Either ``*`` or a URI prefix with or without the scheme part.
383 Either ``*`` or a URI prefix with or without the scheme part.
384 The authentication entry with the longest matching prefix is used
384 The authentication entry with the longest matching prefix is used
385 (where ``*`` matches everything and counts as a match of length
385 (where ``*`` matches everything and counts as a match of length
386 1). If the prefix doesn't include a scheme, the match is performed
386 1). If the prefix doesn't include a scheme, the match is performed
387 against the URI with its scheme stripped as well, and the schemes
387 against the URI with its scheme stripped as well, and the schemes
388 argument, q.v., is then subsequently consulted.
388 argument, q.v., is then subsequently consulted.
389
389
390 ``username``
390 ``username``
391 Optional. Username to authenticate with. If not given, and the
391 Optional. Username to authenticate with. If not given, and the
392 remote site requires basic or digest authentication, the user will
392 remote site requires basic or digest authentication, the user will
393 be prompted for it. Environment variables are expanded in the
393 be prompted for it. Environment variables are expanded in the
394 username letting you do ``foo.username = $USER``. If the URI
394 username letting you do ``foo.username = $USER``. If the URI
395 includes a username, only ``[auth]`` entries with a matching
395 includes a username, only ``[auth]`` entries with a matching
396 username or without a username will be considered.
396 username or without a username will be considered.
397
397
398 ``password``
398 ``password``
399 Optional. Password to authenticate with. If not given, and the
399 Optional. Password to authenticate with. If not given, and the
400 remote site requires basic or digest authentication, the user
400 remote site requires basic or digest authentication, the user
401 will be prompted for it.
401 will be prompted for it.
402
402
403 ``key``
403 ``key``
404 Optional. PEM encoded client certificate key file. Environment
404 Optional. PEM encoded client certificate key file. Environment
405 variables are expanded in the filename.
405 variables are expanded in the filename.
406
406
407 ``cert``
407 ``cert``
408 Optional. PEM encoded client certificate chain file. Environment
408 Optional. PEM encoded client certificate chain file. Environment
409 variables are expanded in the filename.
409 variables are expanded in the filename.
410
410
411 ``schemes``
411 ``schemes``
412 Optional. Space separated list of URI schemes to use this
412 Optional. Space separated list of URI schemes to use this
413 authentication entry with. Only used if the prefix doesn't include
413 authentication entry with. Only used if the prefix doesn't include
414 a scheme. Supported schemes are http and https. They will match
414 a scheme. Supported schemes are http and https. They will match
415 static-http and static-https respectively, as well.
415 static-http and static-https respectively, as well.
416 (default: https)
416 (default: https)
417
417
418 If no suitable authentication entry is found, the user is prompted
418 If no suitable authentication entry is found, the user is prompted
419 for credentials as usual if required by the remote.
419 for credentials as usual if required by the remote.
420
420
421 ``cmdserver``
421 ``cmdserver``
422 -------------
422 -------------
423
423
424 Controls command server settings. (ADVANCED)
424 Controls command server settings. (ADVANCED)
425
425
426 ``message-encodings``
426 ``message-encodings``
427 List of encodings for the ``m`` (message) channel. The first encoding
427 List of encodings for the ``m`` (message) channel. The first encoding
428 supported by the server will be selected and advertised in the hello
428 supported by the server will be selected and advertised in the hello
429 message. This is useful only when ``ui.message-output`` is set to
429 message. This is useful only when ``ui.message-output`` is set to
430 ``channel``. Supported encodings are ``cbor``.
430 ``channel``. Supported encodings are ``cbor``.
431
431
432 ``shutdown-on-interrupt``
432 ``shutdown-on-interrupt``
433 If set to false, the server's main loop will continue running after
433 If set to false, the server's main loop will continue running after
434 SIGINT received. ``runcommand`` requests can still be interrupted by
434 SIGINT received. ``runcommand`` requests can still be interrupted by
435 SIGINT. Close the write end of the pipe to shut down the server
435 SIGINT. Close the write end of the pipe to shut down the server
436 process gracefully.
436 process gracefully.
437 (default: True)
437 (default: True)
438
438
439 ``color``
439 ``color``
440 ---------
440 ---------
441
441
442 Configure the Mercurial color mode. For details about how to define your custom
442 Configure the Mercurial color mode. For details about how to define your custom
443 effect and style see :hg:`help color`.
443 effect and style see :hg:`help color`.
444
444
445 ``mode``
445 ``mode``
446 String: control the method used to output color. One of ``auto``, ``ansi``,
446 String: control the method used to output color. One of ``auto``, ``ansi``,
447 ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
447 ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
448 use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a
448 use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a
449 terminal. Any invalid value will disable color.
449 terminal. Any invalid value will disable color.
450
450
451 ``pagermode``
451 ``pagermode``
452 String: optional override of ``color.mode`` used with pager.
452 String: optional override of ``color.mode`` used with pager.
453
453
454 On some systems, terminfo mode may cause problems when using
454 On some systems, terminfo mode may cause problems when using
455 color with ``less -R`` as a pager program. less with the -R option
455 color with ``less -R`` as a pager program. less with the -R option
456 will only display ECMA-48 color codes, and terminfo mode may sometimes
456 will only display ECMA-48 color codes, and terminfo mode may sometimes
457 emit codes that less doesn't understand. You can work around this by
457 emit codes that less doesn't understand. You can work around this by
458 either using ansi mode (or auto mode), or by using less -r (which will
458 either using ansi mode (or auto mode), or by using less -r (which will
459 pass through all terminal control codes, not just color control
459 pass through all terminal control codes, not just color control
460 codes).
460 codes).
461
461
462 On some systems (such as MSYS in Windows), the terminal may support
462 On some systems (such as MSYS in Windows), the terminal may support
463 a different color mode than the pager program.
463 a different color mode than the pager program.
464
464
465 ``commands``
465 ``commands``
466 ------------
466 ------------
467
467
468 ``commit.post-status``
468 ``commit.post-status``
469 Show status of files in the working directory after successful commit.
469 Show status of files in the working directory after successful commit.
470 (default: False)
470 (default: False)
471
471
472 ``merge.require-rev``
472 ``merge.require-rev``
473 Require that the revision to merge the current commit with be specified on
473 Require that the revision to merge the current commit with be specified on
474 the command line. If this is enabled and a revision is not specified, the
474 the command line. If this is enabled and a revision is not specified, the
475 command aborts.
475 command aborts.
476 (default: False)
476 (default: False)
477
477
478 ``push.require-revs``
478 ``push.require-revs``
479 Require revisions to push be specified using one or more mechanisms such as
479 Require revisions to push be specified using one or more mechanisms such as
480 specifying them positionally on the command line, using ``-r``, ``-b``,
480 specifying them positionally on the command line, using ``-r``, ``-b``,
481 and/or ``-B`` on the command line, or using ``paths.<path>:pushrev`` in the
481 and/or ``-B`` on the command line, or using ``paths.<path>:pushrev`` in the
482 configuration. If this is enabled and revisions are not specified, the
482 configuration. If this is enabled and revisions are not specified, the
483 command aborts.
483 command aborts.
484 (default: False)
484 (default: False)
485
485
486 ``resolve.confirm``
486 ``resolve.confirm``
487 Confirm before performing action if no filename is passed.
487 Confirm before performing action if no filename is passed.
488 (default: False)
488 (default: False)
489
489
490 ``resolve.explicit-re-merge``
490 ``resolve.explicit-re-merge``
491 Require uses of ``hg resolve`` to specify which action it should perform,
491 Require uses of ``hg resolve`` to specify which action it should perform,
492 instead of re-merging files by default.
492 instead of re-merging files by default.
493 (default: False)
493 (default: False)
494
494
495 ``resolve.mark-check``
495 ``resolve.mark-check``
496 Determines what level of checking :hg:`resolve --mark` will perform before
496 Determines what level of checking :hg:`resolve --mark` will perform before
497 marking files as resolved. Valid values are ``none`, ``warn``, and
497 marking files as resolved. Valid values are ``none`, ``warn``, and
498 ``abort``. ``warn`` will output a warning listing the file(s) that still
498 ``abort``. ``warn`` will output a warning listing the file(s) that still
499 have conflict markers in them, but will still mark everything resolved.
499 have conflict markers in them, but will still mark everything resolved.
500 ``abort`` will output the same warning but will not mark things as resolved.
500 ``abort`` will output the same warning but will not mark things as resolved.
501 If --all is passed and this is set to ``abort``, only a warning will be
501 If --all is passed and this is set to ``abort``, only a warning will be
502 shown (an error will not be raised).
502 shown (an error will not be raised).
503 (default: ``none``)
503 (default: ``none``)
504
504
505 ``status.relative``
505 ``status.relative``
506 Make paths in :hg:`status` output relative to the current directory.
506 Make paths in :hg:`status` output relative to the current directory.
507 (default: False)
507 (default: False)
508
508
509 ``status.terse``
509 ``status.terse``
510 Default value for the --terse flag, which condenses status output.
510 Default value for the --terse flag, which condenses status output.
511 (default: empty)
511 (default: empty)
512
512
513 ``update.check``
513 ``update.check``
514 Determines what level of checking :hg:`update` will perform before moving
514 Determines what level of checking :hg:`update` will perform before moving
515 to a destination revision. Valid values are ``abort``, ``none``,
515 to a destination revision. Valid values are ``abort``, ``none``,
516 ``linear``, and ``noconflict``. ``abort`` always fails if the working
516 ``linear``, and ``noconflict``. ``abort`` always fails if the working
517 directory has uncommitted changes. ``none`` performs no checking, and may
517 directory has uncommitted changes. ``none`` performs no checking, and may
518 result in a merge with uncommitted changes. ``linear`` allows any update
518 result in a merge with uncommitted changes. ``linear`` allows any update
519 as long as it follows a straight line in the revision history, and may
519 as long as it follows a straight line in the revision history, and may
520 trigger a merge with uncommitted changes. ``noconflict`` will allow any
520 trigger a merge with uncommitted changes. ``noconflict`` will allow any
521 update which would not trigger a merge with uncommitted changes, if any
521 update which would not trigger a merge with uncommitted changes, if any
522 are present.
522 are present.
523 (default: ``linear``)
523 (default: ``linear``)
524
524
525 ``update.requiredest``
525 ``update.requiredest``
526 Require that the user pass a destination when running :hg:`update`.
526 Require that the user pass a destination when running :hg:`update`.
527 For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
527 For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
528 will be disallowed.
528 will be disallowed.
529 (default: False)
529 (default: False)
530
530
531 ``committemplate``
531 ``committemplate``
532 ------------------
532 ------------------
533
533
534 ``changeset``
534 ``changeset``
535 String: configuration in this section is used as the template to
535 String: configuration in this section is used as the template to
536 customize the text shown in the editor when committing.
536 customize the text shown in the editor when committing.
537
537
538 In addition to pre-defined template keywords, commit log specific one
538 In addition to pre-defined template keywords, commit log specific one
539 below can be used for customization:
539 below can be used for customization:
540
540
541 ``extramsg``
541 ``extramsg``
542 String: Extra message (typically 'Leave message empty to abort
542 String: Extra message (typically 'Leave message empty to abort
543 commit.'). This may be changed by some commands or extensions.
543 commit.'). This may be changed by some commands or extensions.
544
544
545 For example, the template configuration below shows as same text as
545 For example, the template configuration below shows as same text as
546 one shown by default::
546 one shown by default::
547
547
548 [committemplate]
548 [committemplate]
549 changeset = {desc}\n\n
549 changeset = {desc}\n\n
550 HG: Enter commit message. Lines beginning with 'HG:' are removed.
550 HG: Enter commit message. Lines beginning with 'HG:' are removed.
551 HG: {extramsg}
551 HG: {extramsg}
552 HG: --
552 HG: --
553 HG: user: {author}\n{ifeq(p2rev, "-1", "",
553 HG: user: {author}\n{ifeq(p2rev, "-1", "",
554 "HG: branch merge\n")
554 "HG: branch merge\n")
555 }HG: branch '{branch}'\n{if(activebookmark,
555 }HG: branch '{branch}'\n{if(activebookmark,
556 "HG: bookmark '{activebookmark}'\n") }{subrepos %
556 "HG: bookmark '{activebookmark}'\n") }{subrepos %
557 "HG: subrepo {subrepo}\n" }{file_adds %
557 "HG: subrepo {subrepo}\n" }{file_adds %
558 "HG: added {file}\n" }{file_mods %
558 "HG: added {file}\n" }{file_mods %
559 "HG: changed {file}\n" }{file_dels %
559 "HG: changed {file}\n" }{file_dels %
560 "HG: removed {file}\n" }{if(files, "",
560 "HG: removed {file}\n" }{if(files, "",
561 "HG: no files changed\n")}
561 "HG: no files changed\n")}
562
562
563 ``diff()``
563 ``diff()``
564 String: show the diff (see :hg:`help templates` for detail)
564 String: show the diff (see :hg:`help templates` for detail)
565
565
566 Sometimes it is helpful to show the diff of the changeset in the editor without
566 Sometimes it is helpful to show the diff of the changeset in the editor without
567 having to prefix 'HG: ' to each line so that highlighting works correctly. For
567 having to prefix 'HG: ' to each line so that highlighting works correctly. For
568 this, Mercurial provides a special string which will ignore everything below
568 this, Mercurial provides a special string which will ignore everything below
569 it::
569 it::
570
570
571 HG: ------------------------ >8 ------------------------
571 HG: ------------------------ >8 ------------------------
572
572
573 For example, the template configuration below will show the diff below the
573 For example, the template configuration below will show the diff below the
574 extra message::
574 extra message::
575
575
576 [committemplate]
576 [committemplate]
577 changeset = {desc}\n\n
577 changeset = {desc}\n\n
578 HG: Enter commit message. Lines beginning with 'HG:' are removed.
578 HG: Enter commit message. Lines beginning with 'HG:' are removed.
579 HG: {extramsg}
579 HG: {extramsg}
580 HG: ------------------------ >8 ------------------------
580 HG: ------------------------ >8 ------------------------
581 HG: Do not touch the line above.
581 HG: Do not touch the line above.
582 HG: Everything below will be removed.
582 HG: Everything below will be removed.
583 {diff()}
583 {diff()}
584
584
585 .. note::
585 .. note::
586
586
587 For some problematic encodings (see :hg:`help win32mbcs` for
587 For some problematic encodings (see :hg:`help win32mbcs` for
588 detail), this customization should be configured carefully, to
588 detail), this customization should be configured carefully, to
589 avoid showing broken characters.
589 avoid showing broken characters.
590
590
591 For example, if a multibyte character ending with backslash (0x5c) is
591 For example, if a multibyte character ending with backslash (0x5c) is
592 followed by the ASCII character 'n' in the customized template,
592 followed by the ASCII character 'n' in the customized template,
593 the sequence of backslash and 'n' is treated as line-feed unexpectedly
593 the sequence of backslash and 'n' is treated as line-feed unexpectedly
594 (and the multibyte character is broken, too).
594 (and the multibyte character is broken, too).
595
595
596 Customized template is used for commands below (``--edit`` may be
596 Customized template is used for commands below (``--edit`` may be
597 required):
597 required):
598
598
599 - :hg:`backout`
599 - :hg:`backout`
600 - :hg:`commit`
600 - :hg:`commit`
601 - :hg:`fetch` (for merge commit only)
601 - :hg:`fetch` (for merge commit only)
602 - :hg:`graft`
602 - :hg:`graft`
603 - :hg:`histedit`
603 - :hg:`histedit`
604 - :hg:`import`
604 - :hg:`import`
605 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
605 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
606 - :hg:`rebase`
606 - :hg:`rebase`
607 - :hg:`shelve`
607 - :hg:`shelve`
608 - :hg:`sign`
608 - :hg:`sign`
609 - :hg:`tag`
609 - :hg:`tag`
610 - :hg:`transplant`
610 - :hg:`transplant`
611
611
612 Configuring items below instead of ``changeset`` allows showing
612 Configuring items below instead of ``changeset`` allows showing
613 customized message only for specific actions, or showing different
613 customized message only for specific actions, or showing different
614 messages for each action.
614 messages for each action.
615
615
616 - ``changeset.backout`` for :hg:`backout`
616 - ``changeset.backout`` for :hg:`backout`
617 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
617 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
618 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
618 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
619 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
619 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
620 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
620 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
621 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
621 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
622 - ``changeset.gpg.sign`` for :hg:`sign`
622 - ``changeset.gpg.sign`` for :hg:`sign`
623 - ``changeset.graft`` for :hg:`graft`
623 - ``changeset.graft`` for :hg:`graft`
624 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
624 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
625 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
625 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
626 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
626 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
627 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
627 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
628 - ``changeset.import.bypass`` for :hg:`import --bypass`
628 - ``changeset.import.bypass`` for :hg:`import --bypass`
629 - ``changeset.import.normal.merge`` for :hg:`import` on merges
629 - ``changeset.import.normal.merge`` for :hg:`import` on merges
630 - ``changeset.import.normal.normal`` for :hg:`import` on other
630 - ``changeset.import.normal.normal`` for :hg:`import` on other
631 - ``changeset.mq.qnew`` for :hg:`qnew`
631 - ``changeset.mq.qnew`` for :hg:`qnew`
632 - ``changeset.mq.qfold`` for :hg:`qfold`
632 - ``changeset.mq.qfold`` for :hg:`qfold`
633 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
633 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
634 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
634 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
635 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
635 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
636 - ``changeset.rebase.normal`` for :hg:`rebase` on other
636 - ``changeset.rebase.normal`` for :hg:`rebase` on other
637 - ``changeset.shelve.shelve`` for :hg:`shelve`
637 - ``changeset.shelve.shelve`` for :hg:`shelve`
638 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
638 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
639 - ``changeset.tag.remove`` for :hg:`tag --remove`
639 - ``changeset.tag.remove`` for :hg:`tag --remove`
640 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
640 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
641 - ``changeset.transplant.normal`` for :hg:`transplant` on other
641 - ``changeset.transplant.normal`` for :hg:`transplant` on other
642
642
643 These dot-separated lists of names are treated as hierarchical ones.
643 These dot-separated lists of names are treated as hierarchical ones.
644 For example, ``changeset.tag.remove`` customizes the commit message
644 For example, ``changeset.tag.remove`` customizes the commit message
645 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
645 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
646 commit message for :hg:`tag` regardless of ``--remove`` option.
646 commit message for :hg:`tag` regardless of ``--remove`` option.
647
647
648 When the external editor is invoked for a commit, the corresponding
648 When the external editor is invoked for a commit, the corresponding
649 dot-separated list of names without the ``changeset.`` prefix
649 dot-separated list of names without the ``changeset.`` prefix
650 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
650 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
651 variable.
651 variable.
652
652
653 In this section, items other than ``changeset`` can be referred from
653 In this section, items other than ``changeset`` can be referred from
654 others. For example, the configuration to list committed files up
654 others. For example, the configuration to list committed files up
655 below can be referred as ``{listupfiles}``::
655 below can be referred as ``{listupfiles}``::
656
656
657 [committemplate]
657 [committemplate]
658 listupfiles = {file_adds %
658 listupfiles = {file_adds %
659 "HG: added {file}\n" }{file_mods %
659 "HG: added {file}\n" }{file_mods %
660 "HG: changed {file}\n" }{file_dels %
660 "HG: changed {file}\n" }{file_dels %
661 "HG: removed {file}\n" }{if(files, "",
661 "HG: removed {file}\n" }{if(files, "",
662 "HG: no files changed\n")}
662 "HG: no files changed\n")}
663
663
664 ``decode/encode``
664 ``decode/encode``
665 -----------------
665 -----------------
666
666
667 Filters for transforming files on checkout/checkin. This would
667 Filters for transforming files on checkout/checkin. This would
668 typically be used for newline processing or other
668 typically be used for newline processing or other
669 localization/canonicalization of files.
669 localization/canonicalization of files.
670
670
671 Filters consist of a filter pattern followed by a filter command.
671 Filters consist of a filter pattern followed by a filter command.
672 Filter patterns are globs by default, rooted at the repository root.
672 Filter patterns are globs by default, rooted at the repository root.
673 For example, to match any file ending in ``.txt`` in the root
673 For example, to match any file ending in ``.txt`` in the root
674 directory only, use the pattern ``*.txt``. To match any file ending
674 directory only, use the pattern ``*.txt``. To match any file ending
675 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
675 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
676 For each file only the first matching filter applies.
676 For each file only the first matching filter applies.
677
677
678 The filter command can start with a specifier, either ``pipe:`` or
678 The filter command can start with a specifier, either ``pipe:`` or
679 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
679 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
680
680
681 A ``pipe:`` command must accept data on stdin and return the transformed
681 A ``pipe:`` command must accept data on stdin and return the transformed
682 data on stdout.
682 data on stdout.
683
683
684 Pipe example::
684 Pipe example::
685
685
686 [encode]
686 [encode]
687 # uncompress gzip files on checkin to improve delta compression
687 # uncompress gzip files on checkin to improve delta compression
688 # note: not necessarily a good idea, just an example
688 # note: not necessarily a good idea, just an example
689 *.gz = pipe: gunzip
689 *.gz = pipe: gunzip
690
690
691 [decode]
691 [decode]
692 # recompress gzip files when writing them to the working dir (we
692 # recompress gzip files when writing them to the working dir (we
693 # can safely omit "pipe:", because it's the default)
693 # can safely omit "pipe:", because it's the default)
694 *.gz = gzip
694 *.gz = gzip
695
695
696 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
696 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
697 with the name of a temporary file that contains the data to be
697 with the name of a temporary file that contains the data to be
698 filtered by the command. The string ``OUTFILE`` is replaced with the name
698 filtered by the command. The string ``OUTFILE`` is replaced with the name
699 of an empty temporary file, where the filtered data must be written by
699 of an empty temporary file, where the filtered data must be written by
700 the command.
700 the command.
701
701
702 .. container:: windows
702 .. container:: windows
703
703
704 .. note::
704 .. note::
705
705
706 The tempfile mechanism is recommended for Windows systems,
706 The tempfile mechanism is recommended for Windows systems,
707 where the standard shell I/O redirection operators often have
707 where the standard shell I/O redirection operators often have
708 strange effects and may corrupt the contents of your files.
708 strange effects and may corrupt the contents of your files.
709
709
710 This filter mechanism is used internally by the ``eol`` extension to
710 This filter mechanism is used internally by the ``eol`` extension to
711 translate line ending characters between Windows (CRLF) and Unix (LF)
711 translate line ending characters between Windows (CRLF) and Unix (LF)
712 format. We suggest you use the ``eol`` extension for convenience.
712 format. We suggest you use the ``eol`` extension for convenience.
713
713
714
714
715 ``defaults``
715 ``defaults``
716 ------------
716 ------------
717
717
718 (defaults are deprecated. Don't use them. Use aliases instead.)
718 (defaults are deprecated. Don't use them. Use aliases instead.)
719
719
720 Use the ``[defaults]`` section to define command defaults, i.e. the
720 Use the ``[defaults]`` section to define command defaults, i.e. the
721 default options/arguments to pass to the specified commands.
721 default options/arguments to pass to the specified commands.
722
722
723 The following example makes :hg:`log` run in verbose mode, and
723 The following example makes :hg:`log` run in verbose mode, and
724 :hg:`status` show only the modified files, by default::
724 :hg:`status` show only the modified files, by default::
725
725
726 [defaults]
726 [defaults]
727 log = -v
727 log = -v
728 status = -m
728 status = -m
729
729
730 The actual commands, instead of their aliases, must be used when
730 The actual commands, instead of their aliases, must be used when
731 defining command defaults. The command defaults will also be applied
731 defining command defaults. The command defaults will also be applied
732 to the aliases of the commands defined.
732 to the aliases of the commands defined.
733
733
734
734
735 ``diff``
735 ``diff``
736 --------
736 --------
737
737
738 Settings used when displaying diffs. Everything except for ``unified``
738 Settings used when displaying diffs. Everything except for ``unified``
739 is a Boolean and defaults to False. See :hg:`help config.annotate`
739 is a Boolean and defaults to False. See :hg:`help config.annotate`
740 for related options for the annotate command.
740 for related options for the annotate command.
741
741
742 ``git``
742 ``git``
743 Use git extended diff format.
743 Use git extended diff format.
744
744
745 ``nobinary``
745 ``nobinary``
746 Omit git binary patches.
746 Omit git binary patches.
747
747
748 ``nodates``
748 ``nodates``
749 Don't include dates in diff headers.
749 Don't include dates in diff headers.
750
750
751 ``noprefix``
751 ``noprefix``
752 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
752 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
753
753
754 ``showfunc``
754 ``showfunc``
755 Show which function each change is in.
755 Show which function each change is in.
756
756
757 ``ignorews``
757 ``ignorews``
758 Ignore white space when comparing lines.
758 Ignore white space when comparing lines.
759
759
760 ``ignorewsamount``
760 ``ignorewsamount``
761 Ignore changes in the amount of white space.
761 Ignore changes in the amount of white space.
762
762
763 ``ignoreblanklines``
763 ``ignoreblanklines``
764 Ignore changes whose lines are all blank.
764 Ignore changes whose lines are all blank.
765
765
766 ``unified``
766 ``unified``
767 Number of lines of context to show.
767 Number of lines of context to show.
768
768
769 ``word-diff``
769 ``word-diff``
770 Highlight changed words.
770 Highlight changed words.
771
771
772 ``email``
772 ``email``
773 ---------
773 ---------
774
774
775 Settings for extensions that send email messages.
775 Settings for extensions that send email messages.
776
776
777 ``from``
777 ``from``
778 Optional. Email address to use in "From" header and SMTP envelope
778 Optional. Email address to use in "From" header and SMTP envelope
779 of outgoing messages.
779 of outgoing messages.
780
780
781 ``to``
781 ``to``
782 Optional. Comma-separated list of recipients' email addresses.
782 Optional. Comma-separated list of recipients' email addresses.
783
783
784 ``cc``
784 ``cc``
785 Optional. Comma-separated list of carbon copy recipients'
785 Optional. Comma-separated list of carbon copy recipients'
786 email addresses.
786 email addresses.
787
787
788 ``bcc``
788 ``bcc``
789 Optional. Comma-separated list of blind carbon copy recipients'
789 Optional. Comma-separated list of blind carbon copy recipients'
790 email addresses.
790 email addresses.
791
791
792 ``method``
792 ``method``
793 Optional. Method to use to send email messages. If value is ``smtp``
793 Optional. Method to use to send email messages. If value is ``smtp``
794 (default), use SMTP (see the ``[smtp]`` section for configuration).
794 (default), use SMTP (see the ``[smtp]`` section for configuration).
795 Otherwise, use as name of program to run that acts like sendmail
795 Otherwise, use as name of program to run that acts like sendmail
796 (takes ``-f`` option for sender, list of recipients on command line,
796 (takes ``-f`` option for sender, list of recipients on command line,
797 message on stdin). Normally, setting this to ``sendmail`` or
797 message on stdin). Normally, setting this to ``sendmail`` or
798 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
798 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
799
799
800 ``charsets``
800 ``charsets``
801 Optional. Comma-separated list of character sets considered
801 Optional. Comma-separated list of character sets considered
802 convenient for recipients. Addresses, headers, and parts not
802 convenient for recipients. Addresses, headers, and parts not
803 containing patches of outgoing messages will be encoded in the
803 containing patches of outgoing messages will be encoded in the
804 first character set to which conversion from local encoding
804 first character set to which conversion from local encoding
805 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
805 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
806 conversion fails, the text in question is sent as is.
806 conversion fails, the text in question is sent as is.
807 (default: '')
807 (default: '')
808
808
809 Order of outgoing email character sets:
809 Order of outgoing email character sets:
810
810
811 1. ``us-ascii``: always first, regardless of settings
811 1. ``us-ascii``: always first, regardless of settings
812 2. ``email.charsets``: in order given by user
812 2. ``email.charsets``: in order given by user
813 3. ``ui.fallbackencoding``: if not in email.charsets
813 3. ``ui.fallbackencoding``: if not in email.charsets
814 4. ``$HGENCODING``: if not in email.charsets
814 4. ``$HGENCODING``: if not in email.charsets
815 5. ``utf-8``: always last, regardless of settings
815 5. ``utf-8``: always last, regardless of settings
816
816
817 Email example::
817 Email example::
818
818
819 [email]
819 [email]
820 from = Joseph User <joe.user@example.com>
820 from = Joseph User <joe.user@example.com>
821 method = /usr/sbin/sendmail
821 method = /usr/sbin/sendmail
822 # charsets for western Europeans
822 # charsets for western Europeans
823 # us-ascii, utf-8 omitted, as they are tried first and last
823 # us-ascii, utf-8 omitted, as they are tried first and last
824 charsets = iso-8859-1, iso-8859-15, windows-1252
824 charsets = iso-8859-1, iso-8859-15, windows-1252
825
825
826
826
827 ``extensions``
827 ``extensions``
828 --------------
828 --------------
829
829
830 Mercurial has an extension mechanism for adding new features. To
830 Mercurial has an extension mechanism for adding new features. To
831 enable an extension, create an entry for it in this section.
831 enable an extension, create an entry for it in this section.
832
832
833 If you know that the extension is already in Python's search path,
833 If you know that the extension is already in Python's search path,
834 you can give the name of the module, followed by ``=``, with nothing
834 you can give the name of the module, followed by ``=``, with nothing
835 after the ``=``.
835 after the ``=``.
836
836
837 Otherwise, give a name that you choose, followed by ``=``, followed by
837 Otherwise, give a name that you choose, followed by ``=``, followed by
838 the path to the ``.py`` file (including the file name extension) that
838 the path to the ``.py`` file (including the file name extension) that
839 defines the extension.
839 defines the extension.
840
840
841 To explicitly disable an extension that is enabled in an hgrc of
841 To explicitly disable an extension that is enabled in an hgrc of
842 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
842 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
843 or ``foo = !`` when path is not supplied.
843 or ``foo = !`` when path is not supplied.
844
844
845 Example for ``~/.hgrc``::
845 Example for ``~/.hgrc``::
846
846
847 [extensions]
847 [extensions]
848 # (the churn extension will get loaded from Mercurial's path)
848 # (the churn extension will get loaded from Mercurial's path)
849 churn =
849 churn =
850 # (this extension will get loaded from the file specified)
850 # (this extension will get loaded from the file specified)
851 myfeature = ~/.hgext/myfeature.py
851 myfeature = ~/.hgext/myfeature.py
852
852
853
853
854 ``format``
854 ``format``
855 ----------
855 ----------
856
856
857 Configuration that controls the repository format. Newer format options are more
857 Configuration that controls the repository format. Newer format options are more
858 powerful, but incompatible with some older versions of Mercurial. Format options
858 powerful, but incompatible with some older versions of Mercurial. Format options
859 are considered at repository initialization only. You need to make a new clone
859 are considered at repository initialization only. You need to make a new clone
860 for config changes to be taken into account.
860 for config changes to be taken into account.
861
861
862 For more details about repository format and version compatibility, see
862 For more details about repository format and version compatibility, see
863 https://www.mercurial-scm.org/wiki/MissingRequirement
863 https://www.mercurial-scm.org/wiki/MissingRequirement
864
864
865 ``usegeneraldelta``
865 ``usegeneraldelta``
866 Enable or disable the "generaldelta" repository format which improves
866 Enable or disable the "generaldelta" repository format which improves
867 repository compression by allowing "revlog" to store deltas against
867 repository compression by allowing "revlog" to store deltas against
868 arbitrary revisions instead of the previously stored one. This provides
868 arbitrary revisions instead of the previously stored one. This provides
869 significant improvement for repositories with branches.
869 significant improvement for repositories with branches.
870
870
871 Repositories with this on-disk format require Mercurial version 1.9.
871 Repositories with this on-disk format require Mercurial version 1.9.
872
872
873 Enabled by default.
873 Enabled by default.
874
874
875 ``dotencode``
875 ``dotencode``
876 Enable or disable the "dotencode" repository format which enhances
876 Enable or disable the "dotencode" repository format which enhances
877 the "fncache" repository format (which has to be enabled to use
877 the "fncache" repository format (which has to be enabled to use
878 dotencode) to avoid issues with filenames starting with "._" on
878 dotencode) to avoid issues with filenames starting with "._" on
879 Mac OS X and spaces on Windows.
879 Mac OS X and spaces on Windows.
880
880
881 Repositories with this on-disk format require Mercurial version 1.7.
881 Repositories with this on-disk format require Mercurial version 1.7.
882
882
883 Enabled by default.
883 Enabled by default.
884
884
885 ``usefncache``
885 ``usefncache``
886 Enable or disable the "fncache" repository format which enhances
886 Enable or disable the "fncache" repository format which enhances
887 the "store" repository format (which has to be enabled to use
887 the "store" repository format (which has to be enabled to use
888 fncache) to allow longer filenames and avoids using Windows
888 fncache) to allow longer filenames and avoids using Windows
889 reserved names, e.g. "nul".
889 reserved names, e.g. "nul".
890
890
891 Repositories with this on-disk format require Mercurial version 1.1.
891 Repositories with this on-disk format require Mercurial version 1.1.
892
892
893 Enabled by default.
893 Enabled by default.
894
894
895 ``use-dirstate-v2``
895 ``use-dirstate-v2``
896 Enable or disable the experimental "dirstate-v2" feature. The dirstate
896 Enable or disable the experimental "dirstate-v2" feature. The dirstate
897 functionality is shared by all commands interacting with the working copy.
897 functionality is shared by all commands interacting with the working copy.
898 The new version is more robust, faster and stores more information.
898 The new version is more robust, faster and stores more information.
899
899
900 The performance-improving version of this feature is currently only
900 The performance-improving version of this feature is currently only
901 implemented in Rust (see :hg:`help rust`), so people not using a version of
901 implemented in Rust (see :hg:`help rust`), so people not using a version of
902 Mercurial compiled with the Rust parts might actually suffer some slowdown.
902 Mercurial compiled with the Rust parts might actually suffer some slowdown.
903 For this reason, such versions will by default refuse to access repositories
903 For this reason, such versions will by default refuse to access repositories
904 with "dirstate-v2" enabled.
904 with "dirstate-v2" enabled.
905
905
906 This behavior can be adjusted via configuration: check
906 This behavior can be adjusted via configuration: check
907 :hg:`help config.storage.dirstate-v2.slow-path` for details.
907 :hg:`help config.storage.dirstate-v2.slow-path` for details.
908
908
909 Repositories with this on-disk format require Mercurial 6.0 or above.
909 Repositories with this on-disk format require Mercurial 6.0 or above.
910
910
911 By default this format variant is disabled if the fast implementation is not
911 By default this format variant is disabled if the fast implementation is not
912 available, and enabled by default if the fast implementation is available.
912 available, and enabled by default if the fast implementation is available.
913
913
914 To accomodate installations of Mercurial without the fast implementation,
914 To accomodate installations of Mercurial without the fast implementation,
915 you can downgrade your repository. To do so run the following command:
915 you can downgrade your repository. To do so run the following command:
916
916
917 $ hg debugupgraderepo \
917 $ hg debugupgraderepo \
918 --run \
918 --run \
919 --config format.use-dirstate-v2=False \
919 --config format.use-dirstate-v2=False \
920 --config storage.dirstate-v2.slow-path=allow
920 --config storage.dirstate-v2.slow-path=allow
921
921
922 For a more comprehensive guide, see :hg:`help internals.dirstate-v2`.
922 For a more comprehensive guide, see :hg:`help internals.dirstate-v2`.
923
923
924 ``use-persistent-nodemap``
924 ``use-persistent-nodemap``
925 Enable or disable the "persistent-nodemap" feature which improves
925 Enable or disable the "persistent-nodemap" feature which improves
926 performance if the Rust extensions are available.
926 performance if the Rust extensions are available.
927
927
928 The "persistent-nodemap" persist the "node -> rev" on disk removing the
928 The "persistent-nodemap" persist the "node -> rev" on disk removing the
929 need to dynamically build that mapping for each Mercurial invocation. This
929 need to dynamically build that mapping for each Mercurial invocation. This
930 significantly reduces the startup cost of various local and server-side
930 significantly reduces the startup cost of various local and server-side
931 operation for larger repositories.
931 operation for larger repositories.
932
932
933 The performance-improving version of this feature is currently only
933 The performance-improving version of this feature is currently only
934 implemented in Rust (see :hg:`help rust`), so people not using a version of
934 implemented in Rust (see :hg:`help rust`), so people not using a version of
935 Mercurial compiled with the Rust parts might actually suffer some slowdown.
935 Mercurial compiled with the Rust parts might actually suffer some slowdown.
936 For this reason, such versions will by default refuse to access repositories
936 For this reason, such versions will by default refuse to access repositories
937 with "persistent-nodemap".
937 with "persistent-nodemap".
938
938
939 This behavior can be adjusted via configuration: check
939 This behavior can be adjusted via configuration: check
940 :hg:`help config.storage.revlog.persistent-nodemap.slow-path` for details.
940 :hg:`help config.storage.revlog.persistent-nodemap.slow-path` for details.
941
941
942 Repositories with this on-disk format require Mercurial 5.4 or above.
942 Repositories with this on-disk format require Mercurial 5.4 or above.
943
943
944 By default this format variant is disabled if the fast implementation is not
944 By default this format variant is disabled if the fast implementation is not
945 available, and enabled by default if the fast implementation is available.
945 available, and enabled by default if the fast implementation is available.
946
946
947 To accomodate installations of Mercurial without the fast implementation,
947 To accomodate installations of Mercurial without the fast implementation,
948 you can downgrade your repository. To do so run the following command:
948 you can downgrade your repository. To do so run the following command:
949
949
950 $ hg debugupgraderepo \
950 $ hg debugupgraderepo \
951 --run \
951 --run \
952 --config format.use-persistent-nodemap=False \
952 --config format.use-persistent-nodemap=False \
953 --config storage.revlog.persistent-nodemap.slow-path=allow
953 --config storage.revlog.persistent-nodemap.slow-path=allow
954
954
955 ``use-share-safe``
955 ``use-share-safe``
956 Enforce "safe" behaviors for all "shares" that access this repository.
956 Enforce "safe" behaviors for all "shares" that access this repository.
957
957
958 With this feature, "shares" using this repository as a source will:
958 With this feature, "shares" using this repository as a source will:
959
959
960 * read the source repository's configuration (`<source>/.hg/hgrc`).
960 * read the source repository's configuration (`<source>/.hg/hgrc`).
961 * read and use the source repository's "requirements"
961 * read and use the source repository's "requirements"
962 (except the working copy specific one).
962 (except the working copy specific one).
963
963
964 Without this feature, "shares" using this repository as a source will:
964 Without this feature, "shares" using this repository as a source will:
965
965
966 * keep tracking the repository "requirements" in the share only, ignoring
966 * keep tracking the repository "requirements" in the share only, ignoring
967 the source "requirements", possibly diverging from them.
967 the source "requirements", possibly diverging from them.
968 * ignore source repository config. This can create problems, like silently
968 * ignore source repository config. This can create problems, like silently
969 ignoring important hooks.
969 ignoring important hooks.
970
970
971 Beware that existing shares will not be upgraded/downgraded, and by
971 Beware that existing shares will not be upgraded/downgraded, and by
972 default, Mercurial will refuse to interact with them until the mismatch
972 default, Mercurial will refuse to interact with them until the mismatch
973 is resolved. See :hg:`help config share.safe-mismatch.source-safe` and
973 is resolved. See :hg:`help config.share.safe-mismatch.source-safe` and
974 :hg:`help config share.safe-mismatch.source-not-safe` for details.
974 :hg:`help config.share.safe-mismatch.source-not-safe` for details.
975
975
976 Introduced in Mercurial 5.7.
976 Introduced in Mercurial 5.7.
977
977
978 Disabled by default.
978 Disabled by default.
979
979
980 ``usestore``
980 ``usestore``
981 Enable or disable the "store" repository format which improves
981 Enable or disable the "store" repository format which improves
982 compatibility with systems that fold case or otherwise mangle
982 compatibility with systems that fold case or otherwise mangle
983 filenames. Disabling this option will allow you to store longer filenames
983 filenames. Disabling this option will allow you to store longer filenames
984 in some situations at the expense of compatibility.
984 in some situations at the expense of compatibility.
985
985
986 Repositories with this on-disk format require Mercurial version 0.9.4.
986 Repositories with this on-disk format require Mercurial version 0.9.4.
987
987
988 Enabled by default.
988 Enabled by default.
989
989
990 ``sparse-revlog``
990 ``sparse-revlog``
991 Enable or disable the ``sparse-revlog`` delta strategy. This format improves
991 Enable or disable the ``sparse-revlog`` delta strategy. This format improves
992 delta re-use inside revlog. For very branchy repositories, it results in a
992 delta re-use inside revlog. For very branchy repositories, it results in a
993 smaller store. For repositories with many revisions, it also helps
993 smaller store. For repositories with many revisions, it also helps
994 performance (by using shortened delta chains.)
994 performance (by using shortened delta chains.)
995
995
996 Repositories with this on-disk format require Mercurial version 4.7
996 Repositories with this on-disk format require Mercurial version 4.7
997
997
998 Enabled by default.
998 Enabled by default.
999
999
1000 ``revlog-compression``
1000 ``revlog-compression``
1001 Compression algorithm used by revlog. Supported values are `zlib` and
1001 Compression algorithm used by revlog. Supported values are `zlib` and
1002 `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
1002 `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
1003 a newer format that is usually a net win over `zlib`, operating faster at
1003 a newer format that is usually a net win over `zlib`, operating faster at
1004 better compression rates. Use `zstd` to reduce CPU usage. Multiple values
1004 better compression rates. Use `zstd` to reduce CPU usage. Multiple values
1005 can be specified, the first available one will be used.
1005 can be specified, the first available one will be used.
1006
1006
1007 On some systems, the Mercurial installation may lack `zstd` support.
1007 On some systems, the Mercurial installation may lack `zstd` support.
1008
1008
1009 Default is `zstd` if available, `zlib` otherwise.
1009 Default is `zstd` if available, `zlib` otherwise.
1010
1010
1011 ``bookmarks-in-store``
1011 ``bookmarks-in-store``
1012 Store bookmarks in .hg/store/. This means that bookmarks are shared when
1012 Store bookmarks in .hg/store/. This means that bookmarks are shared when
1013 using `hg share` regardless of the `-B` option.
1013 using `hg share` regardless of the `-B` option.
1014
1014
1015 Repositories with this on-disk format require Mercurial version 5.1.
1015 Repositories with this on-disk format require Mercurial version 5.1.
1016
1016
1017 Disabled by default.
1017 Disabled by default.
1018
1018
1019
1019
1020 ``graph``
1020 ``graph``
1021 ---------
1021 ---------
1022
1022
1023 Web graph view configuration. This section let you change graph
1023 Web graph view configuration. This section let you change graph
1024 elements display properties by branches, for instance to make the
1024 elements display properties by branches, for instance to make the
1025 ``default`` branch stand out.
1025 ``default`` branch stand out.
1026
1026
1027 Each line has the following format::
1027 Each line has the following format::
1028
1028
1029 <branch>.<argument> = <value>
1029 <branch>.<argument> = <value>
1030
1030
1031 where ``<branch>`` is the name of the branch being
1031 where ``<branch>`` is the name of the branch being
1032 customized. Example::
1032 customized. Example::
1033
1033
1034 [graph]
1034 [graph]
1035 # 2px width
1035 # 2px width
1036 default.width = 2
1036 default.width = 2
1037 # red color
1037 # red color
1038 default.color = FF0000
1038 default.color = FF0000
1039
1039
1040 Supported arguments:
1040 Supported arguments:
1041
1041
1042 ``width``
1042 ``width``
1043 Set branch edges width in pixels.
1043 Set branch edges width in pixels.
1044
1044
1045 ``color``
1045 ``color``
1046 Set branch edges color in hexadecimal RGB notation.
1046 Set branch edges color in hexadecimal RGB notation.
1047
1047
1048 ``hooks``
1048 ``hooks``
1049 ---------
1049 ---------
1050
1050
1051 Commands or Python functions that get automatically executed by
1051 Commands or Python functions that get automatically executed by
1052 various actions such as starting or finishing a commit. Multiple
1052 various actions such as starting or finishing a commit. Multiple
1053 hooks can be run for the same action by appending a suffix to the
1053 hooks can be run for the same action by appending a suffix to the
1054 action. Overriding a site-wide hook can be done by changing its
1054 action. Overriding a site-wide hook can be done by changing its
1055 value or setting it to an empty string. Hooks can be prioritized
1055 value or setting it to an empty string. Hooks can be prioritized
1056 by adding a prefix of ``priority.`` to the hook name on a new line
1056 by adding a prefix of ``priority.`` to the hook name on a new line
1057 and setting the priority. The default priority is 0.
1057 and setting the priority. The default priority is 0.
1058
1058
1059 Example ``.hg/hgrc``::
1059 Example ``.hg/hgrc``::
1060
1060
1061 [hooks]
1061 [hooks]
1062 # update working directory after adding changesets
1062 # update working directory after adding changesets
1063 changegroup.update = hg update
1063 changegroup.update = hg update
1064 # do not use the site-wide hook
1064 # do not use the site-wide hook
1065 incoming =
1065 incoming =
1066 incoming.email = /my/email/hook
1066 incoming.email = /my/email/hook
1067 incoming.autobuild = /my/build/hook
1067 incoming.autobuild = /my/build/hook
1068 # force autobuild hook to run before other incoming hooks
1068 # force autobuild hook to run before other incoming hooks
1069 priority.incoming.autobuild = 1
1069 priority.incoming.autobuild = 1
1070 ### control HGPLAIN setting when running autobuild hook
1070 ### control HGPLAIN setting when running autobuild hook
1071 # HGPLAIN always set (default from Mercurial 5.7)
1071 # HGPLAIN always set (default from Mercurial 5.7)
1072 incoming.autobuild:run-with-plain = yes
1072 incoming.autobuild:run-with-plain = yes
1073 # HGPLAIN never set
1073 # HGPLAIN never set
1074 incoming.autobuild:run-with-plain = no
1074 incoming.autobuild:run-with-plain = no
1075 # HGPLAIN inherited from environment (default before Mercurial 5.7)
1075 # HGPLAIN inherited from environment (default before Mercurial 5.7)
1076 incoming.autobuild:run-with-plain = auto
1076 incoming.autobuild:run-with-plain = auto
1077
1077
1078 Most hooks are run with environment variables set that give useful
1078 Most hooks are run with environment variables set that give useful
1079 additional information. For each hook below, the environment variables
1079 additional information. For each hook below, the environment variables
1080 it is passed are listed with names in the form ``$HG_foo``. The
1080 it is passed are listed with names in the form ``$HG_foo``. The
1081 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
1081 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
1082 They contain the type of hook which triggered the run and the full name
1082 They contain the type of hook which triggered the run and the full name
1083 of the hook in the config, respectively. In the example above, this will
1083 of the hook in the config, respectively. In the example above, this will
1084 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
1084 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
1085
1085
1086 .. container:: windows
1086 .. container:: windows
1087
1087
1088 Some basic Unix syntax can be enabled for portability, including ``$VAR``
1088 Some basic Unix syntax can be enabled for portability, including ``$VAR``
1089 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
1089 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
1090 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
1090 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
1091 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
1091 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
1092 slash or inside of a strong quote. Strong quotes will be replaced by
1092 slash or inside of a strong quote. Strong quotes will be replaced by
1093 double quotes after processing.
1093 double quotes after processing.
1094
1094
1095 This feature is enabled by adding a prefix of ``tonative.`` to the hook
1095 This feature is enabled by adding a prefix of ``tonative.`` to the hook
1096 name on a new line, and setting it to ``True``. For example::
1096 name on a new line, and setting it to ``True``. For example::
1097
1097
1098 [hooks]
1098 [hooks]
1099 incoming.autobuild = /my/build/hook
1099 incoming.autobuild = /my/build/hook
1100 # enable translation to cmd.exe syntax for autobuild hook
1100 # enable translation to cmd.exe syntax for autobuild hook
1101 tonative.incoming.autobuild = True
1101 tonative.incoming.autobuild = True
1102
1102
1103 ``changegroup``
1103 ``changegroup``
1104 Run after a changegroup has been added via push, pull or unbundle. The ID of
1104 Run after a changegroup has been added via push, pull or unbundle. The ID of
1105 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
1105 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
1106 The URL from which changes came is in ``$HG_URL``.
1106 The URL from which changes came is in ``$HG_URL``.
1107
1107
1108 ``commit``
1108 ``commit``
1109 Run after a changeset has been created in the local repository. The ID
1109 Run after a changeset has been created in the local repository. The ID
1110 of the newly created changeset is in ``$HG_NODE``. Parent changeset
1110 of the newly created changeset is in ``$HG_NODE``. Parent changeset
1111 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1111 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1112
1112
1113 ``incoming``
1113 ``incoming``
1114 Run after a changeset has been pulled, pushed, or unbundled into
1114 Run after a changeset has been pulled, pushed, or unbundled into
1115 the local repository. The ID of the newly arrived changeset is in
1115 the local repository. The ID of the newly arrived changeset is in
1116 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
1116 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
1117
1117
1118 ``outgoing``
1118 ``outgoing``
1119 Run after sending changes from the local repository to another. The ID of
1119 Run after sending changes from the local repository to another. The ID of
1120 first changeset sent is in ``$HG_NODE``. The source of operation is in
1120 first changeset sent is in ``$HG_NODE``. The source of operation is in
1121 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
1121 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
1122
1122
1123 ``post-<command>``
1123 ``post-<command>``
1124 Run after successful invocations of the associated command. The
1124 Run after successful invocations of the associated command. The
1125 contents of the command line are passed as ``$HG_ARGS`` and the result
1125 contents of the command line are passed as ``$HG_ARGS`` and the result
1126 code in ``$HG_RESULT``. Parsed command line arguments are passed as
1126 code in ``$HG_RESULT``. Parsed command line arguments are passed as
1127 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
1127 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
1128 the python data internally passed to <command>. ``$HG_OPTS`` is a
1128 the python data internally passed to <command>. ``$HG_OPTS`` is a
1129 dictionary of options (with unspecified options set to their defaults).
1129 dictionary of options (with unspecified options set to their defaults).
1130 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
1130 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
1131
1131
1132 ``fail-<command>``
1132 ``fail-<command>``
1133 Run after a failed invocation of an associated command. The contents
1133 Run after a failed invocation of an associated command. The contents
1134 of the command line are passed as ``$HG_ARGS``. Parsed command line
1134 of the command line are passed as ``$HG_ARGS``. Parsed command line
1135 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
1135 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
1136 string representations of the python data internally passed to
1136 string representations of the python data internally passed to
1137 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
1137 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
1138 options set to their defaults). ``$HG_PATS`` is a list of arguments.
1138 options set to their defaults). ``$HG_PATS`` is a list of arguments.
1139 Hook failure is ignored.
1139 Hook failure is ignored.
1140
1140
1141 ``pre-<command>``
1141 ``pre-<command>``
1142 Run before executing the associated command. The contents of the
1142 Run before executing the associated command. The contents of the
1143 command line are passed as ``$HG_ARGS``. Parsed command line arguments
1143 command line are passed as ``$HG_ARGS``. Parsed command line arguments
1144 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
1144 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
1145 representations of the data internally passed to <command>. ``$HG_OPTS``
1145 representations of the data internally passed to <command>. ``$HG_OPTS``
1146 is a dictionary of options (with unspecified options set to their
1146 is a dictionary of options (with unspecified options set to their
1147 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
1147 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
1148 failure, the command doesn't execute and Mercurial returns the failure
1148 failure, the command doesn't execute and Mercurial returns the failure
1149 code.
1149 code.
1150
1150
1151 ``prechangegroup``
1151 ``prechangegroup``
1152 Run before a changegroup is added via push, pull or unbundle. Exit
1152 Run before a changegroup is added via push, pull or unbundle. Exit
1153 status 0 allows the changegroup to proceed. A non-zero status will
1153 status 0 allows the changegroup to proceed. A non-zero status will
1154 cause the push, pull or unbundle to fail. The URL from which changes
1154 cause the push, pull or unbundle to fail. The URL from which changes
1155 will come is in ``$HG_URL``.
1155 will come is in ``$HG_URL``.
1156
1156
1157 ``precommit``
1157 ``precommit``
1158 Run before starting a local commit. Exit status 0 allows the
1158 Run before starting a local commit. Exit status 0 allows the
1159 commit to proceed. A non-zero status will cause the commit to fail.
1159 commit to proceed. A non-zero status will cause the commit to fail.
1160 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1160 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1161
1161
1162 ``prelistkeys``
1162 ``prelistkeys``
1163 Run before listing pushkeys (like bookmarks) in the
1163 Run before listing pushkeys (like bookmarks) in the
1164 repository. A non-zero status will cause failure. The key namespace is
1164 repository. A non-zero status will cause failure. The key namespace is
1165 in ``$HG_NAMESPACE``.
1165 in ``$HG_NAMESPACE``.
1166
1166
1167 ``preoutgoing``
1167 ``preoutgoing``
1168 Run before collecting changes to send from the local repository to
1168 Run before collecting changes to send from the local repository to
1169 another. A non-zero status will cause failure. This lets you prevent
1169 another. A non-zero status will cause failure. This lets you prevent
1170 pull over HTTP or SSH. It can also prevent propagating commits (via
1170 pull over HTTP or SSH. It can also prevent propagating commits (via
1171 local pull, push (outbound) or bundle commands), but not completely,
1171 local pull, push (outbound) or bundle commands), but not completely,
1172 since you can just copy files instead. The source of operation is in
1172 since you can just copy files instead. The source of operation is in
1173 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1173 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1174 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1174 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1175 is happening on behalf of a repository on same system.
1175 is happening on behalf of a repository on same system.
1176
1176
1177 ``prepushkey``
1177 ``prepushkey``
1178 Run before a pushkey (like a bookmark) is added to the
1178 Run before a pushkey (like a bookmark) is added to the
1179 repository. A non-zero status will cause the key to be rejected. The
1179 repository. A non-zero status will cause the key to be rejected. The
1180 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1180 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1181 the old value (if any) is in ``$HG_OLD``, and the new value is in
1181 the old value (if any) is in ``$HG_OLD``, and the new value is in
1182 ``$HG_NEW``.
1182 ``$HG_NEW``.
1183
1183
1184 ``pretag``
1184 ``pretag``
1185 Run before creating a tag. Exit status 0 allows the tag to be
1185 Run before creating a tag. Exit status 0 allows the tag to be
1186 created. A non-zero status will cause the tag to fail. The ID of the
1186 created. A non-zero status will cause the tag to fail. The ID of the
1187 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1187 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1188 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1188 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1189
1189
1190 ``pretxnopen``
1190 ``pretxnopen``
1191 Run before any new repository transaction is open. The reason for the
1191 Run before any new repository transaction is open. The reason for the
1192 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1192 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1193 transaction will be in ``$HG_TXNID``. A non-zero status will prevent the
1193 transaction will be in ``$HG_TXNID``. A non-zero status will prevent the
1194 transaction from being opened.
1194 transaction from being opened.
1195
1195
1196 ``pretxnclose``
1196 ``pretxnclose``
1197 Run right before the transaction is actually finalized. Any repository change
1197 Run right before the transaction is actually finalized. Any repository change
1198 will be visible to the hook program. This lets you validate the transaction
1198 will be visible to the hook program. This lets you validate the transaction
1199 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1199 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1200 status will cause the transaction to be rolled back. The reason for the
1200 status will cause the transaction to be rolled back. The reason for the
1201 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1201 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1202 the transaction will be in ``$HG_TXNID``. The rest of the available data will
1202 the transaction will be in ``$HG_TXNID``. The rest of the available data will
1203 vary according the transaction type. Changes unbundled to the repository will
1203 vary according the transaction type. Changes unbundled to the repository will
1204 add ``$HG_URL`` and ``$HG_SOURCE``. New changesets will add ``$HG_NODE`` (the
1204 add ``$HG_URL`` and ``$HG_SOURCE``. New changesets will add ``$HG_NODE`` (the
1205 ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last added
1205 ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last added
1206 changeset). Bookmark and phase changes will set ``$HG_BOOKMARK_MOVED`` and
1206 changeset). Bookmark and phase changes will set ``$HG_BOOKMARK_MOVED`` and
1207 ``$HG_PHASES_MOVED`` to ``1`` respectively. The number of new obsmarkers, if
1207 ``$HG_PHASES_MOVED`` to ``1`` respectively. The number of new obsmarkers, if
1208 any, will be in ``$HG_NEW_OBSMARKERS``, etc.
1208 any, will be in ``$HG_NEW_OBSMARKERS``, etc.
1209
1209
1210 ``pretxnclose-bookmark``
1210 ``pretxnclose-bookmark``
1211 Run right before a bookmark change is actually finalized. Any repository
1211 Run right before a bookmark change is actually finalized. Any repository
1212 change will be visible to the hook program. This lets you validate the
1212 change will be visible to the hook program. This lets you validate the
1213 transaction content or change it. Exit status 0 allows the commit to
1213 transaction content or change it. Exit status 0 allows the commit to
1214 proceed. A non-zero status will cause the transaction to be rolled back.
1214 proceed. A non-zero status will cause the transaction to be rolled back.
1215 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1215 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1216 bookmark location will be available in ``$HG_NODE`` while the previous
1216 bookmark location will be available in ``$HG_NODE`` while the previous
1217 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1217 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1218 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1218 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1219 will be empty.
1219 will be empty.
1220 In addition, the reason for the transaction opening will be in
1220 In addition, the reason for the transaction opening will be in
1221 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1221 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1222 ``$HG_TXNID``.
1222 ``$HG_TXNID``.
1223
1223
1224 ``pretxnclose-phase``
1224 ``pretxnclose-phase``
1225 Run right before a phase change is actually finalized. Any repository change
1225 Run right before a phase change is actually finalized. Any repository change
1226 will be visible to the hook program. This lets you validate the transaction
1226 will be visible to the hook program. This lets you validate the transaction
1227 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1227 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1228 status will cause the transaction to be rolled back. The hook is called
1228 status will cause the transaction to be rolled back. The hook is called
1229 multiple times, once for each revision affected by a phase change.
1229 multiple times, once for each revision affected by a phase change.
1230 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1230 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1231 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1231 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1232 will be empty. In addition, the reason for the transaction opening will be in
1232 will be empty. In addition, the reason for the transaction opening will be in
1233 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1233 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1234 ``$HG_TXNID``. The hook is also run for newly added revisions. In this case
1234 ``$HG_TXNID``. The hook is also run for newly added revisions. In this case
1235 the ``$HG_OLDPHASE`` entry will be empty.
1235 the ``$HG_OLDPHASE`` entry will be empty.
1236
1236
1237 ``txnclose``
1237 ``txnclose``
1238 Run after any repository transaction has been committed. At this
1238 Run after any repository transaction has been committed. At this
1239 point, the transaction can no longer be rolled back. The hook will run
1239 point, the transaction can no longer be rolled back. The hook will run
1240 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1240 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1241 details about available variables.
1241 details about available variables.
1242
1242
1243 ``txnclose-bookmark``
1243 ``txnclose-bookmark``
1244 Run after any bookmark change has been committed. At this point, the
1244 Run after any bookmark change has been committed. At this point, the
1245 transaction can no longer be rolled back. The hook will run after the lock
1245 transaction can no longer be rolled back. The hook will run after the lock
1246 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1246 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1247 about available variables.
1247 about available variables.
1248
1248
1249 ``txnclose-phase``
1249 ``txnclose-phase``
1250 Run after any phase change has been committed. At this point, the
1250 Run after any phase change has been committed. At this point, the
1251 transaction can no longer be rolled back. The hook will run after the lock
1251 transaction can no longer be rolled back. The hook will run after the lock
1252 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1252 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1253 available variables.
1253 available variables.
1254
1254
1255 ``txnabort``
1255 ``txnabort``
1256 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1256 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1257 for details about available variables.
1257 for details about available variables.
1258
1258
1259 ``pretxnchangegroup``
1259 ``pretxnchangegroup``
1260 Run after a changegroup has been added via push, pull or unbundle, but before
1260 Run after a changegroup has been added via push, pull or unbundle, but before
1261 the transaction has been committed. The changegroup is visible to the hook
1261 the transaction has been committed. The changegroup is visible to the hook
1262 program. This allows validation of incoming changes before accepting them.
1262 program. This allows validation of incoming changes before accepting them.
1263 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1263 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1264 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1264 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1265 status will cause the transaction to be rolled back, and the push, pull or
1265 status will cause the transaction to be rolled back, and the push, pull or
1266 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1266 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1267
1267
1268 ``pretxncommit``
1268 ``pretxncommit``
1269 Run after a changeset has been created, but before the transaction is
1269 Run after a changeset has been created, but before the transaction is
1270 committed. The changeset is visible to the hook program. This allows
1270 committed. The changeset is visible to the hook program. This allows
1271 validation of the commit message and changes. Exit status 0 allows the
1271 validation of the commit message and changes. Exit status 0 allows the
1272 commit to proceed. A non-zero status will cause the transaction to
1272 commit to proceed. A non-zero status will cause the transaction to
1273 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1273 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1274 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1274 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1275
1275
1276 ``preupdate``
1276 ``preupdate``
1277 Run before updating the working directory. Exit status 0 allows
1277 Run before updating the working directory. Exit status 0 allows
1278 the update to proceed. A non-zero status will prevent the update.
1278 the update to proceed. A non-zero status will prevent the update.
1279 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1279 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1280 merge, the ID of second new parent is in ``$HG_PARENT2``.
1280 merge, the ID of second new parent is in ``$HG_PARENT2``.
1281
1281
1282 ``listkeys``
1282 ``listkeys``
1283 Run after listing pushkeys (like bookmarks) in the repository. The
1283 Run after listing pushkeys (like bookmarks) in the repository. The
1284 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1284 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1285 dictionary containing the keys and values.
1285 dictionary containing the keys and values.
1286
1286
1287 ``pushkey``
1287 ``pushkey``
1288 Run after a pushkey (like a bookmark) is added to the
1288 Run after a pushkey (like a bookmark) is added to the
1289 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1289 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1290 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1290 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1291 value is in ``$HG_NEW``.
1291 value is in ``$HG_NEW``.
1292
1292
1293 ``tag``
1293 ``tag``
1294 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1294 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1295 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1295 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1296 the repository if ``$HG_LOCAL=0``.
1296 the repository if ``$HG_LOCAL=0``.
1297
1297
1298 ``update``
1298 ``update``
1299 Run after updating the working directory. The changeset ID of first
1299 Run after updating the working directory. The changeset ID of first
1300 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1300 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1301 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1301 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1302 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1302 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1303
1303
1304 .. note::
1304 .. note::
1305
1305
1306 It is generally better to use standard hooks rather than the
1306 It is generally better to use standard hooks rather than the
1307 generic pre- and post- command hooks, as they are guaranteed to be
1307 generic pre- and post- command hooks, as they are guaranteed to be
1308 called in the appropriate contexts for influencing transactions.
1308 called in the appropriate contexts for influencing transactions.
1309 Also, hooks like "commit" will be called in all contexts that
1309 Also, hooks like "commit" will be called in all contexts that
1310 generate a commit (e.g. tag) and not just the commit command.
1310 generate a commit (e.g. tag) and not just the commit command.
1311
1311
1312 .. note::
1312 .. note::
1313
1313
1314 Environment variables with empty values may not be passed to
1314 Environment variables with empty values may not be passed to
1315 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1315 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1316 will have an empty value under Unix-like platforms for non-merge
1316 will have an empty value under Unix-like platforms for non-merge
1317 changesets, while it will not be available at all under Windows.
1317 changesets, while it will not be available at all under Windows.
1318
1318
1319 The syntax for Python hooks is as follows::
1319 The syntax for Python hooks is as follows::
1320
1320
1321 hookname = python:modulename.submodule.callable
1321 hookname = python:modulename.submodule.callable
1322 hookname = python:/path/to/python/module.py:callable
1322 hookname = python:/path/to/python/module.py:callable
1323
1323
1324 Python hooks are run within the Mercurial process. Each hook is
1324 Python hooks are run within the Mercurial process. Each hook is
1325 called with at least three keyword arguments: a ui object (keyword
1325 called with at least three keyword arguments: a ui object (keyword
1326 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1326 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1327 keyword that tells what kind of hook is used. Arguments listed as
1327 keyword that tells what kind of hook is used. Arguments listed as
1328 environment variables above are passed as keyword arguments, with no
1328 environment variables above are passed as keyword arguments, with no
1329 ``HG_`` prefix, and names in lower case.
1329 ``HG_`` prefix, and names in lower case.
1330
1330
1331 If a Python hook returns a "true" value or raises an exception, this
1331 If a Python hook returns a "true" value or raises an exception, this
1332 is treated as a failure.
1332 is treated as a failure.
1333
1333
1334
1334
1335 ``hostfingerprints``
1335 ``hostfingerprints``
1336 --------------------
1336 --------------------
1337
1337
1338 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1338 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1339
1339
1340 Fingerprints of the certificates of known HTTPS servers.
1340 Fingerprints of the certificates of known HTTPS servers.
1341
1341
1342 A HTTPS connection to a server with a fingerprint configured here will
1342 A HTTPS connection to a server with a fingerprint configured here will
1343 only succeed if the servers certificate matches the fingerprint.
1343 only succeed if the servers certificate matches the fingerprint.
1344 This is very similar to how ssh known hosts works.
1344 This is very similar to how ssh known hosts works.
1345
1345
1346 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1346 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1347 Multiple values can be specified (separated by spaces or commas). This can
1347 Multiple values can be specified (separated by spaces or commas). This can
1348 be used to define both old and new fingerprints while a host transitions
1348 be used to define both old and new fingerprints while a host transitions
1349 to a new certificate.
1349 to a new certificate.
1350
1350
1351 The CA chain and web.cacerts is not used for servers with a fingerprint.
1351 The CA chain and web.cacerts is not used for servers with a fingerprint.
1352
1352
1353 For example::
1353 For example::
1354
1354
1355 [hostfingerprints]
1355 [hostfingerprints]
1356 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1356 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1357 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1357 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1358
1358
1359 ``hostsecurity``
1359 ``hostsecurity``
1360 ----------------
1360 ----------------
1361
1361
1362 Used to specify global and per-host security settings for connecting to
1362 Used to specify global and per-host security settings for connecting to
1363 other machines.
1363 other machines.
1364
1364
1365 The following options control default behavior for all hosts.
1365 The following options control default behavior for all hosts.
1366
1366
1367 ``ciphers``
1367 ``ciphers``
1368 Defines the cryptographic ciphers to use for connections.
1368 Defines the cryptographic ciphers to use for connections.
1369
1369
1370 Value must be a valid OpenSSL Cipher List Format as documented at
1370 Value must be a valid OpenSSL Cipher List Format as documented at
1371 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1371 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1372
1372
1373 This setting is for advanced users only. Setting to incorrect values
1373 This setting is for advanced users only. Setting to incorrect values
1374 can significantly lower connection security or decrease performance.
1374 can significantly lower connection security or decrease performance.
1375 You have been warned.
1375 You have been warned.
1376
1376
1377 This option requires Python 2.7.
1377 This option requires Python 2.7.
1378
1378
1379 ``minimumprotocol``
1379 ``minimumprotocol``
1380 Defines the minimum channel encryption protocol to use.
1380 Defines the minimum channel encryption protocol to use.
1381
1381
1382 By default, the highest version of TLS supported by both client and server
1382 By default, the highest version of TLS supported by both client and server
1383 is used.
1383 is used.
1384
1384
1385 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1385 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1386
1386
1387 When running on an old Python version, only ``tls1.0`` is allowed since
1387 When running on an old Python version, only ``tls1.0`` is allowed since
1388 old versions of Python only support up to TLS 1.0.
1388 old versions of Python only support up to TLS 1.0.
1389
1389
1390 When running a Python that supports modern TLS versions, the default is
1390 When running a Python that supports modern TLS versions, the default is
1391 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1391 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1392 weakens security and should only be used as a feature of last resort if
1392 weakens security and should only be used as a feature of last resort if
1393 a server does not support TLS 1.1+.
1393 a server does not support TLS 1.1+.
1394
1394
1395 Options in the ``[hostsecurity]`` section can have the form
1395 Options in the ``[hostsecurity]`` section can have the form
1396 ``hostname``:``setting``. This allows multiple settings to be defined on a
1396 ``hostname``:``setting``. This allows multiple settings to be defined on a
1397 per-host basis.
1397 per-host basis.
1398
1398
1399 The following per-host settings can be defined.
1399 The following per-host settings can be defined.
1400
1400
1401 ``ciphers``
1401 ``ciphers``
1402 This behaves like ``ciphers`` as described above except it only applies
1402 This behaves like ``ciphers`` as described above except it only applies
1403 to the host on which it is defined.
1403 to the host on which it is defined.
1404
1404
1405 ``fingerprints``
1405 ``fingerprints``
1406 A list of hashes of the DER encoded peer/remote certificate. Values have
1406 A list of hashes of the DER encoded peer/remote certificate. Values have
1407 the form ``algorithm``:``fingerprint``. e.g.
1407 the form ``algorithm``:``fingerprint``. e.g.
1408 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1408 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1409 In addition, colons (``:``) can appear in the fingerprint part.
1409 In addition, colons (``:``) can appear in the fingerprint part.
1410
1410
1411 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1411 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1412 ``sha512``.
1412 ``sha512``.
1413
1413
1414 Use of ``sha256`` or ``sha512`` is preferred.
1414 Use of ``sha256`` or ``sha512`` is preferred.
1415
1415
1416 If a fingerprint is specified, the CA chain is not validated for this
1416 If a fingerprint is specified, the CA chain is not validated for this
1417 host and Mercurial will require the remote certificate to match one
1417 host and Mercurial will require the remote certificate to match one
1418 of the fingerprints specified. This means if the server updates its
1418 of the fingerprints specified. This means if the server updates its
1419 certificate, Mercurial will abort until a new fingerprint is defined.
1419 certificate, Mercurial will abort until a new fingerprint is defined.
1420 This can provide stronger security than traditional CA-based validation
1420 This can provide stronger security than traditional CA-based validation
1421 at the expense of convenience.
1421 at the expense of convenience.
1422
1422
1423 This option takes precedence over ``verifycertsfile``.
1423 This option takes precedence over ``verifycertsfile``.
1424
1424
1425 ``minimumprotocol``
1425 ``minimumprotocol``
1426 This behaves like ``minimumprotocol`` as described above except it
1426 This behaves like ``minimumprotocol`` as described above except it
1427 only applies to the host on which it is defined.
1427 only applies to the host on which it is defined.
1428
1428
1429 ``verifycertsfile``
1429 ``verifycertsfile``
1430 Path to file a containing a list of PEM encoded certificates used to
1430 Path to file a containing a list of PEM encoded certificates used to
1431 verify the server certificate. Environment variables and ``~user``
1431 verify the server certificate. Environment variables and ``~user``
1432 constructs are expanded in the filename.
1432 constructs are expanded in the filename.
1433
1433
1434 The server certificate or the certificate's certificate authority (CA)
1434 The server certificate or the certificate's certificate authority (CA)
1435 must match a certificate from this file or certificate verification
1435 must match a certificate from this file or certificate verification
1436 will fail and connections to the server will be refused.
1436 will fail and connections to the server will be refused.
1437
1437
1438 If defined, only certificates provided by this file will be used:
1438 If defined, only certificates provided by this file will be used:
1439 ``web.cacerts`` and any system/default certificates will not be
1439 ``web.cacerts`` and any system/default certificates will not be
1440 used.
1440 used.
1441
1441
1442 This option has no effect if the per-host ``fingerprints`` option
1442 This option has no effect if the per-host ``fingerprints`` option
1443 is set.
1443 is set.
1444
1444
1445 The format of the file is as follows::
1445 The format of the file is as follows::
1446
1446
1447 -----BEGIN CERTIFICATE-----
1447 -----BEGIN CERTIFICATE-----
1448 ... (certificate in base64 PEM encoding) ...
1448 ... (certificate in base64 PEM encoding) ...
1449 -----END CERTIFICATE-----
1449 -----END CERTIFICATE-----
1450 -----BEGIN CERTIFICATE-----
1450 -----BEGIN CERTIFICATE-----
1451 ... (certificate in base64 PEM encoding) ...
1451 ... (certificate in base64 PEM encoding) ...
1452 -----END CERTIFICATE-----
1452 -----END CERTIFICATE-----
1453
1453
1454 For example::
1454 For example::
1455
1455
1456 [hostsecurity]
1456 [hostsecurity]
1457 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1457 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1458 hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1458 hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1459 hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2
1459 hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2
1460 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1460 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1461
1461
1462 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1462 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1463 when connecting to ``hg.example.com``::
1463 when connecting to ``hg.example.com``::
1464
1464
1465 [hostsecurity]
1465 [hostsecurity]
1466 minimumprotocol = tls1.2
1466 minimumprotocol = tls1.2
1467 hg.example.com:minimumprotocol = tls1.1
1467 hg.example.com:minimumprotocol = tls1.1
1468
1468
1469 ``http_proxy``
1469 ``http_proxy``
1470 --------------
1470 --------------
1471
1471
1472 Used to access web-based Mercurial repositories through a HTTP
1472 Used to access web-based Mercurial repositories through a HTTP
1473 proxy.
1473 proxy.
1474
1474
1475 ``host``
1475 ``host``
1476 Host name and (optional) port of the proxy server, for example
1476 Host name and (optional) port of the proxy server, for example
1477 "myproxy:8000".
1477 "myproxy:8000".
1478
1478
1479 ``no``
1479 ``no``
1480 Optional. Comma-separated list of host names that should bypass
1480 Optional. Comma-separated list of host names that should bypass
1481 the proxy.
1481 the proxy.
1482
1482
1483 ``passwd``
1483 ``passwd``
1484 Optional. Password to authenticate with at the proxy server.
1484 Optional. Password to authenticate with at the proxy server.
1485
1485
1486 ``user``
1486 ``user``
1487 Optional. User name to authenticate with at the proxy server.
1487 Optional. User name to authenticate with at the proxy server.
1488
1488
1489 ``always``
1489 ``always``
1490 Optional. Always use the proxy, even for localhost and any entries
1490 Optional. Always use the proxy, even for localhost and any entries
1491 in ``http_proxy.no``. (default: False)
1491 in ``http_proxy.no``. (default: False)
1492
1492
1493 ``http``
1493 ``http``
1494 ----------
1494 ----------
1495
1495
1496 Used to configure access to Mercurial repositories via HTTP.
1496 Used to configure access to Mercurial repositories via HTTP.
1497
1497
1498 ``timeout``
1498 ``timeout``
1499 If set, blocking operations will timeout after that many seconds.
1499 If set, blocking operations will timeout after that many seconds.
1500 (default: None)
1500 (default: None)
1501
1501
1502 ``merge``
1502 ``merge``
1503 ---------
1503 ---------
1504
1504
1505 This section specifies behavior during merges and updates.
1505 This section specifies behavior during merges and updates.
1506
1506
1507 ``checkignored``
1507 ``checkignored``
1508 Controls behavior when an ignored file on disk has the same name as a tracked
1508 Controls behavior when an ignored file on disk has the same name as a tracked
1509 file in the changeset being merged or updated to, and has different
1509 file in the changeset being merged or updated to, and has different
1510 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1510 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1511 abort on such files. With ``warn``, warn on such files and back them up as
1511 abort on such files. With ``warn``, warn on such files and back them up as
1512 ``.orig``. With ``ignore``, don't print a warning and back them up as
1512 ``.orig``. With ``ignore``, don't print a warning and back them up as
1513 ``.orig``. (default: ``abort``)
1513 ``.orig``. (default: ``abort``)
1514
1514
1515 ``checkunknown``
1515 ``checkunknown``
1516 Controls behavior when an unknown file that isn't ignored has the same name
1516 Controls behavior when an unknown file that isn't ignored has the same name
1517 as a tracked file in the changeset being merged or updated to, and has
1517 as a tracked file in the changeset being merged or updated to, and has
1518 different contents. Similar to ``merge.checkignored``, except for files that
1518 different contents. Similar to ``merge.checkignored``, except for files that
1519 are not ignored. (default: ``abort``)
1519 are not ignored. (default: ``abort``)
1520
1520
1521 ``on-failure``
1521 ``on-failure``
1522 When set to ``continue`` (the default), the merge process attempts to
1522 When set to ``continue`` (the default), the merge process attempts to
1523 merge all unresolved files using the merge chosen tool, regardless of
1523 merge all unresolved files using the merge chosen tool, regardless of
1524 whether previous file merge attempts during the process succeeded or not.
1524 whether previous file merge attempts during the process succeeded or not.
1525 Setting this to ``prompt`` will prompt after any merge failure continue
1525 Setting this to ``prompt`` will prompt after any merge failure continue
1526 or halt the merge process. Setting this to ``halt`` will automatically
1526 or halt the merge process. Setting this to ``halt`` will automatically
1527 halt the merge process on any merge tool failure. The merge process
1527 halt the merge process on any merge tool failure. The merge process
1528 can be restarted by using the ``resolve`` command. When a merge is
1528 can be restarted by using the ``resolve`` command. When a merge is
1529 halted, the repository is left in a normal ``unresolved`` merge state.
1529 halted, the repository is left in a normal ``unresolved`` merge state.
1530 (default: ``continue``)
1530 (default: ``continue``)
1531
1531
1532 ``strict-capability-check``
1532 ``strict-capability-check``
1533 Whether capabilities of internal merge tools are checked strictly
1533 Whether capabilities of internal merge tools are checked strictly
1534 or not, while examining rules to decide merge tool to be used.
1534 or not, while examining rules to decide merge tool to be used.
1535 (default: False)
1535 (default: False)
1536
1536
1537 ``merge-patterns``
1537 ``merge-patterns``
1538 ------------------
1538 ------------------
1539
1539
1540 This section specifies merge tools to associate with particular file
1540 This section specifies merge tools to associate with particular file
1541 patterns. Tools matched here will take precedence over the default
1541 patterns. Tools matched here will take precedence over the default
1542 merge tool. Patterns are globs by default, rooted at the repository
1542 merge tool. Patterns are globs by default, rooted at the repository
1543 root.
1543 root.
1544
1544
1545 Example::
1545 Example::
1546
1546
1547 [merge-patterns]
1547 [merge-patterns]
1548 **.c = kdiff3
1548 **.c = kdiff3
1549 **.jpg = myimgmerge
1549 **.jpg = myimgmerge
1550
1550
1551 ``merge-tools``
1551 ``merge-tools``
1552 ---------------
1552 ---------------
1553
1553
1554 This section configures external merge tools to use for file-level
1554 This section configures external merge tools to use for file-level
1555 merges. This section has likely been preconfigured at install time.
1555 merges. This section has likely been preconfigured at install time.
1556 Use :hg:`config merge-tools` to check the existing configuration.
1556 Use :hg:`config merge-tools` to check the existing configuration.
1557 Also see :hg:`help merge-tools` for more details.
1557 Also see :hg:`help merge-tools` for more details.
1558
1558
1559 Example ``~/.hgrc``::
1559 Example ``~/.hgrc``::
1560
1560
1561 [merge-tools]
1561 [merge-tools]
1562 # Override stock tool location
1562 # Override stock tool location
1563 kdiff3.executable = ~/bin/kdiff3
1563 kdiff3.executable = ~/bin/kdiff3
1564 # Specify command line
1564 # Specify command line
1565 kdiff3.args = $base $local $other -o $output
1565 kdiff3.args = $base $local $other -o $output
1566 # Give higher priority
1566 # Give higher priority
1567 kdiff3.priority = 1
1567 kdiff3.priority = 1
1568
1568
1569 # Changing the priority of preconfigured tool
1569 # Changing the priority of preconfigured tool
1570 meld.priority = 0
1570 meld.priority = 0
1571
1571
1572 # Disable a preconfigured tool
1572 # Disable a preconfigured tool
1573 vimdiff.disabled = yes
1573 vimdiff.disabled = yes
1574
1574
1575 # Define new tool
1575 # Define new tool
1576 myHtmlTool.args = -m $local $other $base $output
1576 myHtmlTool.args = -m $local $other $base $output
1577 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1577 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1578 myHtmlTool.priority = 1
1578 myHtmlTool.priority = 1
1579
1579
1580 Supported arguments:
1580 Supported arguments:
1581
1581
1582 ``priority``
1582 ``priority``
1583 The priority in which to evaluate this tool.
1583 The priority in which to evaluate this tool.
1584 (default: 0)
1584 (default: 0)
1585
1585
1586 ``executable``
1586 ``executable``
1587 Either just the name of the executable or its pathname.
1587 Either just the name of the executable or its pathname.
1588
1588
1589 .. container:: windows
1589 .. container:: windows
1590
1590
1591 On Windows, the path can use environment variables with ${ProgramFiles}
1591 On Windows, the path can use environment variables with ${ProgramFiles}
1592 syntax.
1592 syntax.
1593
1593
1594 (default: the tool name)
1594 (default: the tool name)
1595
1595
1596 ``args``
1596 ``args``
1597 The arguments to pass to the tool executable. You can refer to the
1597 The arguments to pass to the tool executable. You can refer to the
1598 files being merged as well as the output file through these
1598 files being merged as well as the output file through these
1599 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1599 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1600
1600
1601 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1601 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1602 being performed. During an update or merge, ``$local`` represents the original
1602 being performed. During an update or merge, ``$local`` represents the original
1603 state of the file, while ``$other`` represents the commit you are updating to or
1603 state of the file, while ``$other`` represents the commit you are updating to or
1604 the commit you are merging with. During a rebase, ``$local`` represents the
1604 the commit you are merging with. During a rebase, ``$local`` represents the
1605 destination of the rebase, and ``$other`` represents the commit being rebased.
1605 destination of the rebase, and ``$other`` represents the commit being rebased.
1606
1606
1607 Some operations define custom labels to assist with identifying the revisions,
1607 Some operations define custom labels to assist with identifying the revisions,
1608 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1608 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1609 labels are not available, these will be ``local``, ``other``, and ``base``,
1609 labels are not available, these will be ``local``, ``other``, and ``base``,
1610 respectively.
1610 respectively.
1611 (default: ``$local $base $other``)
1611 (default: ``$local $base $other``)
1612
1612
1613 ``premerge``
1613 ``premerge``
1614 Attempt to run internal non-interactive 3-way merge tool before
1614 Attempt to run internal non-interactive 3-way merge tool before
1615 launching external tool. Options are ``true``, ``false``, ``keep``,
1615 launching external tool. Options are ``true``, ``false``, ``keep``,
1616 ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
1616 ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
1617 will leave markers in the file if the premerge fails. The ``keep-merge3``
1617 will leave markers in the file if the premerge fails. The ``keep-merge3``
1618 will do the same but include information about the base of the merge in the
1618 will do the same but include information about the base of the merge in the
1619 marker (see internal :merge3 in :hg:`help merge-tools`). The
1619 marker (see internal :merge3 in :hg:`help merge-tools`). The
1620 ``keep-mergediff`` option is similar but uses a different marker style
1620 ``keep-mergediff`` option is similar but uses a different marker style
1621 (see internal :merge3 in :hg:`help merge-tools`). (default: True)
1621 (see internal :merge3 in :hg:`help merge-tools`). (default: True)
1622
1622
1623 ``binary``
1623 ``binary``
1624 This tool can merge binary files. (default: False, unless tool
1624 This tool can merge binary files. (default: False, unless tool
1625 was selected by file pattern match)
1625 was selected by file pattern match)
1626
1626
1627 ``symlink``
1627 ``symlink``
1628 This tool can merge symlinks. (default: False)
1628 This tool can merge symlinks. (default: False)
1629
1629
1630 ``check``
1630 ``check``
1631 A list of merge success-checking options:
1631 A list of merge success-checking options:
1632
1632
1633 ``changed``
1633 ``changed``
1634 Ask whether merge was successful when the merged file shows no changes.
1634 Ask whether merge was successful when the merged file shows no changes.
1635 ``conflicts``
1635 ``conflicts``
1636 Check whether there are conflicts even though the tool reported success.
1636 Check whether there are conflicts even though the tool reported success.
1637 ``prompt``
1637 ``prompt``
1638 Always prompt for merge success, regardless of success reported by tool.
1638 Always prompt for merge success, regardless of success reported by tool.
1639
1639
1640 ``fixeol``
1640 ``fixeol``
1641 Attempt to fix up EOL changes caused by the merge tool.
1641 Attempt to fix up EOL changes caused by the merge tool.
1642 (default: False)
1642 (default: False)
1643
1643
1644 ``gui``
1644 ``gui``
1645 This tool requires a graphical interface to run. (default: False)
1645 This tool requires a graphical interface to run. (default: False)
1646
1646
1647 ``mergemarkers``
1647 ``mergemarkers``
1648 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1648 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1649 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1649 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1650 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1650 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1651 markers generated during premerge will be ``detailed`` if either this option or
1651 markers generated during premerge will be ``detailed`` if either this option or
1652 the corresponding option in the ``[ui]`` section is ``detailed``.
1652 the corresponding option in the ``[ui]`` section is ``detailed``.
1653 (default: ``basic``)
1653 (default: ``basic``)
1654
1654
1655 ``mergemarkertemplate``
1655 ``mergemarkertemplate``
1656 This setting can be used to override ``mergemarker`` from the
1656 This setting can be used to override ``mergemarker`` from the
1657 ``[command-templates]`` section on a per-tool basis; this applies to the
1657 ``[command-templates]`` section on a per-tool basis; this applies to the
1658 ``$label``-prefixed variables and to the conflict markers that are generated
1658 ``$label``-prefixed variables and to the conflict markers that are generated
1659 if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
1659 if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
1660 in ``[ui]`` for more information.
1660 in ``[ui]`` for more information.
1661
1661
1662 .. container:: windows
1662 .. container:: windows
1663
1663
1664 ``regkey``
1664 ``regkey``
1665 Windows registry key which describes install location of this
1665 Windows registry key which describes install location of this
1666 tool. Mercurial will search for this key first under
1666 tool. Mercurial will search for this key first under
1667 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1667 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1668 (default: None)
1668 (default: None)
1669
1669
1670 ``regkeyalt``
1670 ``regkeyalt``
1671 An alternate Windows registry key to try if the first key is not
1671 An alternate Windows registry key to try if the first key is not
1672 found. The alternate key uses the same ``regname`` and ``regappend``
1672 found. The alternate key uses the same ``regname`` and ``regappend``
1673 semantics of the primary key. The most common use for this key
1673 semantics of the primary key. The most common use for this key
1674 is to search for 32bit applications on 64bit operating systems.
1674 is to search for 32bit applications on 64bit operating systems.
1675 (default: None)
1675 (default: None)
1676
1676
1677 ``regname``
1677 ``regname``
1678 Name of value to read from specified registry key.
1678 Name of value to read from specified registry key.
1679 (default: the unnamed (default) value)
1679 (default: the unnamed (default) value)
1680
1680
1681 ``regappend``
1681 ``regappend``
1682 String to append to the value read from the registry, typically
1682 String to append to the value read from the registry, typically
1683 the executable name of the tool.
1683 the executable name of the tool.
1684 (default: None)
1684 (default: None)
1685
1685
1686 ``pager``
1686 ``pager``
1687 ---------
1687 ---------
1688
1688
1689 Setting used to control when to paginate and with what external tool. See
1689 Setting used to control when to paginate and with what external tool. See
1690 :hg:`help pager` for details.
1690 :hg:`help pager` for details.
1691
1691
1692 ``pager``
1692 ``pager``
1693 Define the external tool used as pager.
1693 Define the external tool used as pager.
1694
1694
1695 If no pager is set, Mercurial uses the environment variable $PAGER.
1695 If no pager is set, Mercurial uses the environment variable $PAGER.
1696 If neither pager.pager, nor $PAGER is set, a default pager will be
1696 If neither pager.pager, nor $PAGER is set, a default pager will be
1697 used, typically `less` on Unix and `more` on Windows. Example::
1697 used, typically `less` on Unix and `more` on Windows. Example::
1698
1698
1699 [pager]
1699 [pager]
1700 pager = less -FRX
1700 pager = less -FRX
1701
1701
1702 ``ignore``
1702 ``ignore``
1703 List of commands to disable the pager for. Example::
1703 List of commands to disable the pager for. Example::
1704
1704
1705 [pager]
1705 [pager]
1706 ignore = version, help, update
1706 ignore = version, help, update
1707
1707
1708 ``patch``
1708 ``patch``
1709 ---------
1709 ---------
1710
1710
1711 Settings used when applying patches, for instance through the 'import'
1711 Settings used when applying patches, for instance through the 'import'
1712 command or with Mercurial Queues extension.
1712 command or with Mercurial Queues extension.
1713
1713
1714 ``eol``
1714 ``eol``
1715 When set to 'strict' patch content and patched files end of lines
1715 When set to 'strict' patch content and patched files end of lines
1716 are preserved. When set to ``lf`` or ``crlf``, both files end of
1716 are preserved. When set to ``lf`` or ``crlf``, both files end of
1717 lines are ignored when patching and the result line endings are
1717 lines are ignored when patching and the result line endings are
1718 normalized to either LF (Unix) or CRLF (Windows). When set to
1718 normalized to either LF (Unix) or CRLF (Windows). When set to
1719 ``auto``, end of lines are again ignored while patching but line
1719 ``auto``, end of lines are again ignored while patching but line
1720 endings in patched files are normalized to their original setting
1720 endings in patched files are normalized to their original setting
1721 on a per-file basis. If target file does not exist or has no end
1721 on a per-file basis. If target file does not exist or has no end
1722 of line, patch line endings are preserved.
1722 of line, patch line endings are preserved.
1723 (default: strict)
1723 (default: strict)
1724
1724
1725 ``fuzz``
1725 ``fuzz``
1726 The number of lines of 'fuzz' to allow when applying patches. This
1726 The number of lines of 'fuzz' to allow when applying patches. This
1727 controls how much context the patcher is allowed to ignore when
1727 controls how much context the patcher is allowed to ignore when
1728 trying to apply a patch.
1728 trying to apply a patch.
1729 (default: 2)
1729 (default: 2)
1730
1730
1731 ``paths``
1731 ``paths``
1732 ---------
1732 ---------
1733
1733
1734 Assigns symbolic names and behavior to repositories.
1734 Assigns symbolic names and behavior to repositories.
1735
1735
1736 Options are symbolic names defining the URL or directory that is the
1736 Options are symbolic names defining the URL or directory that is the
1737 location of the repository. Example::
1737 location of the repository. Example::
1738
1738
1739 [paths]
1739 [paths]
1740 my_server = https://example.com/my_repo
1740 my_server = https://example.com/my_repo
1741 local_path = /home/me/repo
1741 local_path = /home/me/repo
1742
1742
1743 These symbolic names can be used from the command line. To pull
1743 These symbolic names can be used from the command line. To pull
1744 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1744 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1745 :hg:`push local_path`. You can check :hg:`help urls` for details about
1745 :hg:`push local_path`. You can check :hg:`help urls` for details about
1746 valid URLs.
1746 valid URLs.
1747
1747
1748 Options containing colons (``:``) denote sub-options that can influence
1748 Options containing colons (``:``) denote sub-options that can influence
1749 behavior for that specific path. Example::
1749 behavior for that specific path. Example::
1750
1750
1751 [paths]
1751 [paths]
1752 my_server = https://example.com/my_path
1752 my_server = https://example.com/my_path
1753 my_server:pushurl = ssh://example.com/my_path
1753 my_server:pushurl = ssh://example.com/my_path
1754
1754
1755 Paths using the `path://otherpath` scheme will inherit the sub-options value from
1755 Paths using the `path://otherpath` scheme will inherit the sub-options value from
1756 the path they point to.
1756 the path they point to.
1757
1757
1758 The following sub-options can be defined:
1758 The following sub-options can be defined:
1759
1759
1760 ``multi-urls``
1760 ``multi-urls``
1761 A boolean option. When enabled the value of the `[paths]` entry will be
1761 A boolean option. When enabled the value of the `[paths]` entry will be
1762 parsed as a list and the alias will resolve to multiple destination. If some
1762 parsed as a list and the alias will resolve to multiple destination. If some
1763 of the list entry use the `path://` syntax, the suboption will be inherited
1763 of the list entry use the `path://` syntax, the suboption will be inherited
1764 individually.
1764 individually.
1765
1765
1766 ``pushurl``
1766 ``pushurl``
1767 The URL to use for push operations. If not defined, the location
1767 The URL to use for push operations. If not defined, the location
1768 defined by the path's main entry is used.
1768 defined by the path's main entry is used.
1769
1769
1770 ``pushrev``
1770 ``pushrev``
1771 A revset defining which revisions to push by default.
1771 A revset defining which revisions to push by default.
1772
1772
1773 When :hg:`push` is executed without a ``-r`` argument, the revset
1773 When :hg:`push` is executed without a ``-r`` argument, the revset
1774 defined by this sub-option is evaluated to determine what to push.
1774 defined by this sub-option is evaluated to determine what to push.
1775
1775
1776 For example, a value of ``.`` will push the working directory's
1776 For example, a value of ``.`` will push the working directory's
1777 revision by default.
1777 revision by default.
1778
1778
1779 Revsets specifying bookmarks will not result in the bookmark being
1779 Revsets specifying bookmarks will not result in the bookmark being
1780 pushed.
1780 pushed.
1781
1781
1782 ``bookmarks.mode``
1782 ``bookmarks.mode``
1783 How bookmark will be dealt during the exchange. It support the following value
1783 How bookmark will be dealt during the exchange. It support the following value
1784
1784
1785 - ``default``: the default behavior, local and remote bookmarks are "merged"
1785 - ``default``: the default behavior, local and remote bookmarks are "merged"
1786 on push/pull.
1786 on push/pull.
1787
1787
1788 - ``mirror``: when pulling, replace local bookmarks by remote bookmarks. This
1788 - ``mirror``: when pulling, replace local bookmarks by remote bookmarks. This
1789 is useful to replicate a repository, or as an optimization.
1789 is useful to replicate a repository, or as an optimization.
1790
1790
1791 - ``ignore``: ignore bookmarks during exchange.
1791 - ``ignore``: ignore bookmarks during exchange.
1792 (This currently only affect pulling)
1792 (This currently only affect pulling)
1793
1793
1794 The following special named paths exist:
1794 The following special named paths exist:
1795
1795
1796 ``default``
1796 ``default``
1797 The URL or directory to use when no source or remote is specified.
1797 The URL or directory to use when no source or remote is specified.
1798
1798
1799 :hg:`clone` will automatically define this path to the location the
1799 :hg:`clone` will automatically define this path to the location the
1800 repository was cloned from.
1800 repository was cloned from.
1801
1801
1802 ``default-push``
1802 ``default-push``
1803 (deprecated) The URL or directory for the default :hg:`push` location.
1803 (deprecated) The URL or directory for the default :hg:`push` location.
1804 ``default:pushurl`` should be used instead.
1804 ``default:pushurl`` should be used instead.
1805
1805
1806 ``phases``
1806 ``phases``
1807 ----------
1807 ----------
1808
1808
1809 Specifies default handling of phases. See :hg:`help phases` for more
1809 Specifies default handling of phases. See :hg:`help phases` for more
1810 information about working with phases.
1810 information about working with phases.
1811
1811
1812 ``publish``
1812 ``publish``
1813 Controls draft phase behavior when working as a server. When true,
1813 Controls draft phase behavior when working as a server. When true,
1814 pushed changesets are set to public in both client and server and
1814 pushed changesets are set to public in both client and server and
1815 pulled or cloned changesets are set to public in the client.
1815 pulled or cloned changesets are set to public in the client.
1816 (default: True)
1816 (default: True)
1817
1817
1818 ``new-commit``
1818 ``new-commit``
1819 Phase of newly-created commits.
1819 Phase of newly-created commits.
1820 (default: draft)
1820 (default: draft)
1821
1821
1822 ``checksubrepos``
1822 ``checksubrepos``
1823 Check the phase of the current revision of each subrepository. Allowed
1823 Check the phase of the current revision of each subrepository. Allowed
1824 values are "ignore", "follow" and "abort". For settings other than
1824 values are "ignore", "follow" and "abort". For settings other than
1825 "ignore", the phase of the current revision of each subrepository is
1825 "ignore", the phase of the current revision of each subrepository is
1826 checked before committing the parent repository. If any of those phases is
1826 checked before committing the parent repository. If any of those phases is
1827 greater than the phase of the parent repository (e.g. if a subrepo is in a
1827 greater than the phase of the parent repository (e.g. if a subrepo is in a
1828 "secret" phase while the parent repo is in "draft" phase), the commit is
1828 "secret" phase while the parent repo is in "draft" phase), the commit is
1829 either aborted (if checksubrepos is set to "abort") or the higher phase is
1829 either aborted (if checksubrepos is set to "abort") or the higher phase is
1830 used for the parent repository commit (if set to "follow").
1830 used for the parent repository commit (if set to "follow").
1831 (default: follow)
1831 (default: follow)
1832
1832
1833
1833
1834 ``profiling``
1834 ``profiling``
1835 -------------
1835 -------------
1836
1836
1837 Specifies profiling type, format, and file output. Two profilers are
1837 Specifies profiling type, format, and file output. Two profilers are
1838 supported: an instrumenting profiler (named ``ls``), and a sampling
1838 supported: an instrumenting profiler (named ``ls``), and a sampling
1839 profiler (named ``stat``).
1839 profiler (named ``stat``).
1840
1840
1841 In this section description, 'profiling data' stands for the raw data
1841 In this section description, 'profiling data' stands for the raw data
1842 collected during profiling, while 'profiling report' stands for a
1842 collected during profiling, while 'profiling report' stands for a
1843 statistical text report generated from the profiling data.
1843 statistical text report generated from the profiling data.
1844
1844
1845 ``enabled``
1845 ``enabled``
1846 Enable the profiler.
1846 Enable the profiler.
1847 (default: false)
1847 (default: false)
1848
1848
1849 This is equivalent to passing ``--profile`` on the command line.
1849 This is equivalent to passing ``--profile`` on the command line.
1850
1850
1851 ``type``
1851 ``type``
1852 The type of profiler to use.
1852 The type of profiler to use.
1853 (default: stat)
1853 (default: stat)
1854
1854
1855 ``ls``
1855 ``ls``
1856 Use Python's built-in instrumenting profiler. This profiler
1856 Use Python's built-in instrumenting profiler. This profiler
1857 works on all platforms, but each line number it reports is the
1857 works on all platforms, but each line number it reports is the
1858 first line of a function. This restriction makes it difficult to
1858 first line of a function. This restriction makes it difficult to
1859 identify the expensive parts of a non-trivial function.
1859 identify the expensive parts of a non-trivial function.
1860 ``stat``
1860 ``stat``
1861 Use a statistical profiler, statprof. This profiler is most
1861 Use a statistical profiler, statprof. This profiler is most
1862 useful for profiling commands that run for longer than about 0.1
1862 useful for profiling commands that run for longer than about 0.1
1863 seconds.
1863 seconds.
1864
1864
1865 ``format``
1865 ``format``
1866 Profiling format. Specific to the ``ls`` instrumenting profiler.
1866 Profiling format. Specific to the ``ls`` instrumenting profiler.
1867 (default: text)
1867 (default: text)
1868
1868
1869 ``text``
1869 ``text``
1870 Generate a profiling report. When saving to a file, it should be
1870 Generate a profiling report. When saving to a file, it should be
1871 noted that only the report is saved, and the profiling data is
1871 noted that only the report is saved, and the profiling data is
1872 not kept.
1872 not kept.
1873 ``kcachegrind``
1873 ``kcachegrind``
1874 Format profiling data for kcachegrind use: when saving to a
1874 Format profiling data for kcachegrind use: when saving to a
1875 file, the generated file can directly be loaded into
1875 file, the generated file can directly be loaded into
1876 kcachegrind.
1876 kcachegrind.
1877
1877
1878 ``statformat``
1878 ``statformat``
1879 Profiling format for the ``stat`` profiler.
1879 Profiling format for the ``stat`` profiler.
1880 (default: hotpath)
1880 (default: hotpath)
1881
1881
1882 ``hotpath``
1882 ``hotpath``
1883 Show a tree-based display containing the hot path of execution (where
1883 Show a tree-based display containing the hot path of execution (where
1884 most time was spent).
1884 most time was spent).
1885 ``bymethod``
1885 ``bymethod``
1886 Show a table of methods ordered by how frequently they are active.
1886 Show a table of methods ordered by how frequently they are active.
1887 ``byline``
1887 ``byline``
1888 Show a table of lines in files ordered by how frequently they are active.
1888 Show a table of lines in files ordered by how frequently they are active.
1889 ``json``
1889 ``json``
1890 Render profiling data as JSON.
1890 Render profiling data as JSON.
1891
1891
1892 ``freq``
1892 ``freq``
1893 Sampling frequency. Specific to the ``stat`` sampling profiler.
1893 Sampling frequency. Specific to the ``stat`` sampling profiler.
1894 (default: 1000)
1894 (default: 1000)
1895
1895
1896 ``output``
1896 ``output``
1897 File path where profiling data or report should be saved. If the
1897 File path where profiling data or report should be saved. If the
1898 file exists, it is replaced. (default: None, data is printed on
1898 file exists, it is replaced. (default: None, data is printed on
1899 stderr)
1899 stderr)
1900
1900
1901 ``sort``
1901 ``sort``
1902 Sort field. Specific to the ``ls`` instrumenting profiler.
1902 Sort field. Specific to the ``ls`` instrumenting profiler.
1903 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1903 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1904 ``inlinetime``.
1904 ``inlinetime``.
1905 (default: inlinetime)
1905 (default: inlinetime)
1906
1906
1907 ``time-track``
1907 ``time-track``
1908 Control if the stat profiler track ``cpu`` or ``real`` time.
1908 Control if the stat profiler track ``cpu`` or ``real`` time.
1909 (default: ``cpu`` on Windows, otherwise ``real``)
1909 (default: ``cpu`` on Windows, otherwise ``real``)
1910
1910
1911 ``limit``
1911 ``limit``
1912 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1912 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1913 (default: 30)
1913 (default: 30)
1914
1914
1915 ``nested``
1915 ``nested``
1916 Show at most this number of lines of drill-down info after each main entry.
1916 Show at most this number of lines of drill-down info after each main entry.
1917 This can help explain the difference between Total and Inline.
1917 This can help explain the difference between Total and Inline.
1918 Specific to the ``ls`` instrumenting profiler.
1918 Specific to the ``ls`` instrumenting profiler.
1919 (default: 0)
1919 (default: 0)
1920
1920
1921 ``showmin``
1921 ``showmin``
1922 Minimum fraction of samples an entry must have for it to be displayed.
1922 Minimum fraction of samples an entry must have for it to be displayed.
1923 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1923 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1924 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1924 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1925
1925
1926 Only used by the ``stat`` profiler.
1926 Only used by the ``stat`` profiler.
1927
1927
1928 For the ``hotpath`` format, default is ``0.05``.
1928 For the ``hotpath`` format, default is ``0.05``.
1929 For the ``chrome`` format, default is ``0.005``.
1929 For the ``chrome`` format, default is ``0.005``.
1930
1930
1931 The option is unused on other formats.
1931 The option is unused on other formats.
1932
1932
1933 ``showmax``
1933 ``showmax``
1934 Maximum fraction of samples an entry can have before it is ignored in
1934 Maximum fraction of samples an entry can have before it is ignored in
1935 display. Values format is the same as ``showmin``.
1935 display. Values format is the same as ``showmin``.
1936
1936
1937 Only used by the ``stat`` profiler.
1937 Only used by the ``stat`` profiler.
1938
1938
1939 For the ``chrome`` format, default is ``0.999``.
1939 For the ``chrome`` format, default is ``0.999``.
1940
1940
1941 The option is unused on other formats.
1941 The option is unused on other formats.
1942
1942
1943 ``showtime``
1943 ``showtime``
1944 Show time taken as absolute durations, in addition to percentages.
1944 Show time taken as absolute durations, in addition to percentages.
1945 Only used by the ``hotpath`` format.
1945 Only used by the ``hotpath`` format.
1946 (default: true)
1946 (default: true)
1947
1947
1948 ``progress``
1948 ``progress``
1949 ------------
1949 ------------
1950
1950
1951 Mercurial commands can draw progress bars that are as informative as
1951 Mercurial commands can draw progress bars that are as informative as
1952 possible. Some progress bars only offer indeterminate information, while others
1952 possible. Some progress bars only offer indeterminate information, while others
1953 have a definite end point.
1953 have a definite end point.
1954
1954
1955 ``debug``
1955 ``debug``
1956 Whether to print debug info when updating the progress bar. (default: False)
1956 Whether to print debug info when updating the progress bar. (default: False)
1957
1957
1958 ``delay``
1958 ``delay``
1959 Number of seconds (float) before showing the progress bar. (default: 3)
1959 Number of seconds (float) before showing the progress bar. (default: 3)
1960
1960
1961 ``changedelay``
1961 ``changedelay``
1962 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1962 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1963 that value will be used instead. (default: 1)
1963 that value will be used instead. (default: 1)
1964
1964
1965 ``estimateinterval``
1965 ``estimateinterval``
1966 Maximum sampling interval in seconds for speed and estimated time
1966 Maximum sampling interval in seconds for speed and estimated time
1967 calculation. (default: 60)
1967 calculation. (default: 60)
1968
1968
1969 ``refresh``
1969 ``refresh``
1970 Time in seconds between refreshes of the progress bar. (default: 0.1)
1970 Time in seconds between refreshes of the progress bar. (default: 0.1)
1971
1971
1972 ``format``
1972 ``format``
1973 Format of the progress bar.
1973 Format of the progress bar.
1974
1974
1975 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1975 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1976 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1976 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1977 last 20 characters of the item, but this can be changed by adding either
1977 last 20 characters of the item, but this can be changed by adding either
1978 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1978 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1979 first num characters.
1979 first num characters.
1980
1980
1981 (default: topic bar number estimate)
1981 (default: topic bar number estimate)
1982
1982
1983 ``width``
1983 ``width``
1984 If set, the maximum width of the progress information (that is, min(width,
1984 If set, the maximum width of the progress information (that is, min(width,
1985 term width) will be used).
1985 term width) will be used).
1986
1986
1987 ``clear-complete``
1987 ``clear-complete``
1988 Clear the progress bar after it's done. (default: True)
1988 Clear the progress bar after it's done. (default: True)
1989
1989
1990 ``disable``
1990 ``disable``
1991 If true, don't show a progress bar.
1991 If true, don't show a progress bar.
1992
1992
1993 ``assume-tty``
1993 ``assume-tty``
1994 If true, ALWAYS show a progress bar, unless disable is given.
1994 If true, ALWAYS show a progress bar, unless disable is given.
1995
1995
1996 ``rebase``
1996 ``rebase``
1997 ----------
1997 ----------
1998
1998
1999 ``evolution.allowdivergence``
1999 ``evolution.allowdivergence``
2000 Default to False, when True allow creating divergence when performing
2000 Default to False, when True allow creating divergence when performing
2001 rebase of obsolete changesets.
2001 rebase of obsolete changesets.
2002
2002
2003 ``revsetalias``
2003 ``revsetalias``
2004 ---------------
2004 ---------------
2005
2005
2006 Alias definitions for revsets. See :hg:`help revsets` for details.
2006 Alias definitions for revsets. See :hg:`help revsets` for details.
2007
2007
2008 ``rewrite``
2008 ``rewrite``
2009 -----------
2009 -----------
2010
2010
2011 ``backup-bundle``
2011 ``backup-bundle``
2012 Whether to save stripped changesets to a bundle file. (default: True)
2012 Whether to save stripped changesets to a bundle file. (default: True)
2013
2013
2014 ``update-timestamp``
2014 ``update-timestamp``
2015 If true, updates the date and time of the changeset to current. It is only
2015 If true, updates the date and time of the changeset to current. It is only
2016 applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
2016 applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
2017 current version.
2017 current version.
2018
2018
2019 ``empty-successor``
2019 ``empty-successor``
2020
2020
2021 Control what happens with empty successors that are the result of rewrite
2021 Control what happens with empty successors that are the result of rewrite
2022 operations. If set to ``skip``, the successor is not created. If set to
2022 operations. If set to ``skip``, the successor is not created. If set to
2023 ``keep``, the empty successor is created and kept.
2023 ``keep``, the empty successor is created and kept.
2024
2024
2025 Currently, only the rebase and absorb commands consider this configuration.
2025 Currently, only the rebase and absorb commands consider this configuration.
2026 (EXPERIMENTAL)
2026 (EXPERIMENTAL)
2027
2027
2028 ``share``
2028 ``share``
2029 ---------
2029 ---------
2030
2030
2031 ``safe-mismatch.source-safe``
2031 ``safe-mismatch.source-safe``
2032
2032
2033 Controls what happens when the shared repository does not use the
2033 Controls what happens when the shared repository does not use the
2034 share-safe mechanism but its source repository does.
2034 share-safe mechanism but its source repository does.
2035
2035
2036 Possible values are `abort` (default), `allow`, `upgrade-abort` and
2036 Possible values are `abort` (default), `allow`, `upgrade-abort` and
2037 `upgrade-abort`.
2037 `upgrade-abort`.
2038
2038
2039 ``abort``
2039 ``abort``
2040 Disallows running any command and aborts
2040 Disallows running any command and aborts
2041 ``allow``
2041 ``allow``
2042 Respects the feature presence in the share source
2042 Respects the feature presence in the share source
2043 ``upgrade-abort``
2043 ``upgrade-abort``
2044 tries to upgrade the share to use share-safe; if it fails, aborts
2044 tries to upgrade the share to use share-safe; if it fails, aborts
2045 ``upgrade-allow``
2045 ``upgrade-allow``
2046 tries to upgrade the share; if it fails, continue by
2046 tries to upgrade the share; if it fails, continue by
2047 respecting the share source setting
2047 respecting the share source setting
2048
2048
2049 Check :hg:`help config format.use-share-safe` for details about the
2049 Check :hg:`help config.format.use-share-safe` for details about the
2050 share-safe feature.
2050 share-safe feature.
2051
2051
2052 ``safe-mismatch.source-safe.warn``
2052 ``safe-mismatch.source-safe.warn``
2053 Shows a warning on operations if the shared repository does not use
2053 Shows a warning on operations if the shared repository does not use
2054 share-safe, but the source repository does.
2054 share-safe, but the source repository does.
2055 (default: True)
2055 (default: True)
2056
2056
2057 ``safe-mismatch.source-not-safe``
2057 ``safe-mismatch.source-not-safe``
2058
2058
2059 Controls what happens when the shared repository uses the share-safe
2059 Controls what happens when the shared repository uses the share-safe
2060 mechanism but its source does not.
2060 mechanism but its source does not.
2061
2061
2062 Possible values are `abort` (default), `allow`, `downgrade-abort` and
2062 Possible values are `abort` (default), `allow`, `downgrade-abort` and
2063 `downgrade-abort`.
2063 `downgrade-abort`.
2064
2064
2065 ``abort``
2065 ``abort``
2066 Disallows running any command and aborts
2066 Disallows running any command and aborts
2067 ``allow``
2067 ``allow``
2068 Respects the feature presence in the share source
2068 Respects the feature presence in the share source
2069 ``downgrade-abort``
2069 ``downgrade-abort``
2070 tries to downgrade the share to not use share-safe; if it fails, aborts
2070 tries to downgrade the share to not use share-safe; if it fails, aborts
2071 ``downgrade-allow``
2071 ``downgrade-allow``
2072 tries to downgrade the share to not use share-safe;
2072 tries to downgrade the share to not use share-safe;
2073 if it fails, continue by respecting the shared source setting
2073 if it fails, continue by respecting the shared source setting
2074
2074
2075 Check :hg:`help config format.use-share-safe` for details about the
2075 Check :hg:`help config.format.use-share-safe` for details about the
2076 share-safe feature.
2076 share-safe feature.
2077
2077
2078 ``safe-mismatch.source-not-safe.warn``
2078 ``safe-mismatch.source-not-safe.warn``
2079 Shows a warning on operations if the shared repository uses share-safe,
2079 Shows a warning on operations if the shared repository uses share-safe,
2080 but the source repository does not.
2080 but the source repository does not.
2081 (default: True)
2081 (default: True)
2082
2082
2083 ``storage``
2083 ``storage``
2084 -----------
2084 -----------
2085
2085
2086 Control the strategy Mercurial uses internally to store history. Options in this
2086 Control the strategy Mercurial uses internally to store history. Options in this
2087 category impact performance and repository size.
2087 category impact performance and repository size.
2088
2088
2089 ``revlog.issue6528.fix-incoming``
2089 ``revlog.issue6528.fix-incoming``
2090 Version 5.8 of Mercurial had a bug leading to altering the parent of file
2090 Version 5.8 of Mercurial had a bug leading to altering the parent of file
2091 revision with copy information (or any other metadata) on exchange. This
2091 revision with copy information (or any other metadata) on exchange. This
2092 leads to the copy metadata to be overlooked by various internal logic. The
2092 leads to the copy metadata to be overlooked by various internal logic. The
2093 issue was fixed in Mercurial 5.8.1.
2093 issue was fixed in Mercurial 5.8.1.
2094 (See https://bz.mercurial-scm.org/show_bug.cgi?id=6528 for details)
2094 (See https://bz.mercurial-scm.org/show_bug.cgi?id=6528 for details)
2095
2095
2096 As a result Mercurial is now checking and fixing incoming file revisions to
2096 As a result Mercurial is now checking and fixing incoming file revisions to
2097 make sure there parents are in the right order. This behavior can be
2097 make sure there parents are in the right order. This behavior can be
2098 disabled by setting this option to `no`. This apply to revisions added
2098 disabled by setting this option to `no`. This apply to revisions added
2099 through push, pull, clone and unbundle.
2099 through push, pull, clone and unbundle.
2100
2100
2101 To fix affected revisions that already exist within the repository, one can
2101 To fix affected revisions that already exist within the repository, one can
2102 use :hg:`debug-repair-issue-6528`.
2102 use :hg:`debug-repair-issue-6528`.
2103
2103
2104 ``revlog.optimize-delta-parent-choice``
2104 ``revlog.optimize-delta-parent-choice``
2105 When storing a merge revision, both parents will be equally considered as
2105 When storing a merge revision, both parents will be equally considered as
2106 a possible delta base. This results in better delta selection and improved
2106 a possible delta base. This results in better delta selection and improved
2107 revlog compression. This option is enabled by default.
2107 revlog compression. This option is enabled by default.
2108
2108
2109 Turning this option off can result in large increase of repository size for
2109 Turning this option off can result in large increase of repository size for
2110 repository with many merges.
2110 repository with many merges.
2111
2111
2112 ``revlog.persistent-nodemap.mmap``
2112 ``revlog.persistent-nodemap.mmap``
2113 Whether to use the Operating System "memory mapping" feature (when
2113 Whether to use the Operating System "memory mapping" feature (when
2114 possible) to access the persistent nodemap data. This improve performance
2114 possible) to access the persistent nodemap data. This improve performance
2115 and reduce memory pressure.
2115 and reduce memory pressure.
2116
2116
2117 Default to True.
2117 Default to True.
2118
2118
2119 For details on the "persistent-nodemap" feature, see:
2119 For details on the "persistent-nodemap" feature, see:
2120 :hg:`help config format.use-persistent-nodemap`.
2120 :hg:`help config.format.use-persistent-nodemap`.
2121
2121
2122 ``revlog.persistent-nodemap.slow-path``
2122 ``revlog.persistent-nodemap.slow-path``
2123 Control the behavior of Merucrial when using a repository with "persistent"
2123 Control the behavior of Merucrial when using a repository with "persistent"
2124 nodemap with an installation of Mercurial without a fast implementation for
2124 nodemap with an installation of Mercurial without a fast implementation for
2125 the feature:
2125 the feature:
2126
2126
2127 ``allow``: Silently use the slower implementation to access the repository.
2127 ``allow``: Silently use the slower implementation to access the repository.
2128 ``warn``: Warn, but use the slower implementation to access the repository.
2128 ``warn``: Warn, but use the slower implementation to access the repository.
2129 ``abort``: Prevent access to such repositories. (This is the default)
2129 ``abort``: Prevent access to such repositories. (This is the default)
2130
2130
2131 For details on the "persistent-nodemap" feature, see:
2131 For details on the "persistent-nodemap" feature, see:
2132 :hg:`help config format.use-persistent-nodemap`.
2132 :hg:`help config.format.use-persistent-nodemap`.
2133
2133
2134 ``revlog.reuse-external-delta-parent``
2134 ``revlog.reuse-external-delta-parent``
2135 Control the order in which delta parents are considered when adding new
2135 Control the order in which delta parents are considered when adding new
2136 revisions from an external source.
2136 revisions from an external source.
2137 (typically: apply bundle from `hg pull` or `hg push`).
2137 (typically: apply bundle from `hg pull` or `hg push`).
2138
2138
2139 New revisions are usually provided as a delta against other revisions. By
2139 New revisions are usually provided as a delta against other revisions. By
2140 default, Mercurial will try to reuse this delta first, therefore using the
2140 default, Mercurial will try to reuse this delta first, therefore using the
2141 same "delta parent" as the source. Directly using delta's from the source
2141 same "delta parent" as the source. Directly using delta's from the source
2142 reduces CPU usage and usually speeds up operation. However, in some case,
2142 reduces CPU usage and usually speeds up operation. However, in some case,
2143 the source might have sub-optimal delta bases and forcing their reevaluation
2143 the source might have sub-optimal delta bases and forcing their reevaluation
2144 is useful. For example, pushes from an old client could have sub-optimal
2144 is useful. For example, pushes from an old client could have sub-optimal
2145 delta's parent that the server want to optimize. (lack of general delta, bad
2145 delta's parent that the server want to optimize. (lack of general delta, bad
2146 parents, choice, lack of sparse-revlog, etc).
2146 parents, choice, lack of sparse-revlog, etc).
2147
2147
2148 This option is enabled by default. Turning it off will ensure bad delta
2148 This option is enabled by default. Turning it off will ensure bad delta
2149 parent choices from older client do not propagate to this repository, at
2149 parent choices from older client do not propagate to this repository, at
2150 the cost of a small increase in CPU consumption.
2150 the cost of a small increase in CPU consumption.
2151
2151
2152 Note: this option only control the order in which delta parents are
2152 Note: this option only control the order in which delta parents are
2153 considered. Even when disabled, the existing delta from the source will be
2153 considered. Even when disabled, the existing delta from the source will be
2154 reused if the same delta parent is selected.
2154 reused if the same delta parent is selected.
2155
2155
2156 ``revlog.reuse-external-delta``
2156 ``revlog.reuse-external-delta``
2157 Control the reuse of delta from external source.
2157 Control the reuse of delta from external source.
2158 (typically: apply bundle from `hg pull` or `hg push`).
2158 (typically: apply bundle from `hg pull` or `hg push`).
2159
2159
2160 New revisions are usually provided as a delta against another revision. By
2160 New revisions are usually provided as a delta against another revision. By
2161 default, Mercurial will not recompute the same delta again, trusting
2161 default, Mercurial will not recompute the same delta again, trusting
2162 externally provided deltas. There have been rare cases of small adjustment
2162 externally provided deltas. There have been rare cases of small adjustment
2163 to the diffing algorithm in the past. So in some rare case, recomputing
2163 to the diffing algorithm in the past. So in some rare case, recomputing
2164 delta provided by ancient clients can provides better results. Disabling
2164 delta provided by ancient clients can provides better results. Disabling
2165 this option means going through a full delta recomputation for all incoming
2165 this option means going through a full delta recomputation for all incoming
2166 revisions. It means a large increase in CPU usage and will slow operations
2166 revisions. It means a large increase in CPU usage and will slow operations
2167 down.
2167 down.
2168
2168
2169 This option is enabled by default. When disabled, it also disables the
2169 This option is enabled by default. When disabled, it also disables the
2170 related ``storage.revlog.reuse-external-delta-parent`` option.
2170 related ``storage.revlog.reuse-external-delta-parent`` option.
2171
2171
2172 ``revlog.zlib.level``
2172 ``revlog.zlib.level``
2173 Zlib compression level used when storing data into the repository. Accepted
2173 Zlib compression level used when storing data into the repository. Accepted
2174 Value range from 1 (lowest compression) to 9 (highest compression). Zlib
2174 Value range from 1 (lowest compression) to 9 (highest compression). Zlib
2175 default value is 6.
2175 default value is 6.
2176
2176
2177
2177
2178 ``revlog.zstd.level``
2178 ``revlog.zstd.level``
2179 zstd compression level used when storing data into the repository. Accepted
2179 zstd compression level used when storing data into the repository. Accepted
2180 Value range from 1 (lowest compression) to 22 (highest compression).
2180 Value range from 1 (lowest compression) to 22 (highest compression).
2181 (default 3)
2181 (default 3)
2182
2182
2183 ``server``
2183 ``server``
2184 ----------
2184 ----------
2185
2185
2186 Controls generic server settings.
2186 Controls generic server settings.
2187
2187
2188 ``bookmarks-pushkey-compat``
2188 ``bookmarks-pushkey-compat``
2189 Trigger pushkey hook when being pushed bookmark updates. This config exist
2189 Trigger pushkey hook when being pushed bookmark updates. This config exist
2190 for compatibility purpose (default to True)
2190 for compatibility purpose (default to True)
2191
2191
2192 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
2192 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
2193 movement we recommend you migrate them to ``txnclose-bookmark`` and
2193 movement we recommend you migrate them to ``txnclose-bookmark`` and
2194 ``pretxnclose-bookmark``.
2194 ``pretxnclose-bookmark``.
2195
2195
2196 ``compressionengines``
2196 ``compressionengines``
2197 List of compression engines and their relative priority to advertise
2197 List of compression engines and their relative priority to advertise
2198 to clients.
2198 to clients.
2199
2199
2200 The order of compression engines determines their priority, the first
2200 The order of compression engines determines their priority, the first
2201 having the highest priority. If a compression engine is not listed
2201 having the highest priority. If a compression engine is not listed
2202 here, it won't be advertised to clients.
2202 here, it won't be advertised to clients.
2203
2203
2204 If not set (the default), built-in defaults are used. Run
2204 If not set (the default), built-in defaults are used. Run
2205 :hg:`debuginstall` to list available compression engines and their
2205 :hg:`debuginstall` to list available compression engines and their
2206 default wire protocol priority.
2206 default wire protocol priority.
2207
2207
2208 Older Mercurial clients only support zlib compression and this setting
2208 Older Mercurial clients only support zlib compression and this setting
2209 has no effect for legacy clients.
2209 has no effect for legacy clients.
2210
2210
2211 ``uncompressed``
2211 ``uncompressed``
2212 Whether to allow clients to clone a repository using the
2212 Whether to allow clients to clone a repository using the
2213 uncompressed streaming protocol. This transfers about 40% more
2213 uncompressed streaming protocol. This transfers about 40% more
2214 data than a regular clone, but uses less memory and CPU on both
2214 data than a regular clone, but uses less memory and CPU on both
2215 server and client. Over a LAN (100 Mbps or better) or a very fast
2215 server and client. Over a LAN (100 Mbps or better) or a very fast
2216 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
2216 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
2217 regular clone. Over most WAN connections (anything slower than
2217 regular clone. Over most WAN connections (anything slower than
2218 about 6 Mbps), uncompressed streaming is slower, because of the
2218 about 6 Mbps), uncompressed streaming is slower, because of the
2219 extra data transfer overhead. This mode will also temporarily hold
2219 extra data transfer overhead. This mode will also temporarily hold
2220 the write lock while determining what data to transfer.
2220 the write lock while determining what data to transfer.
2221 (default: True)
2221 (default: True)
2222
2222
2223 ``uncompressedallowsecret``
2223 ``uncompressedallowsecret``
2224 Whether to allow stream clones when the repository contains secret
2224 Whether to allow stream clones when the repository contains secret
2225 changesets. (default: False)
2225 changesets. (default: False)
2226
2226
2227 ``preferuncompressed``
2227 ``preferuncompressed``
2228 When set, clients will try to use the uncompressed streaming
2228 When set, clients will try to use the uncompressed streaming
2229 protocol. (default: False)
2229 protocol. (default: False)
2230
2230
2231 ``disablefullbundle``
2231 ``disablefullbundle``
2232 When set, servers will refuse attempts to do pull-based clones.
2232 When set, servers will refuse attempts to do pull-based clones.
2233 If this option is set, ``preferuncompressed`` and/or clone bundles
2233 If this option is set, ``preferuncompressed`` and/or clone bundles
2234 are highly recommended. Partial clones will still be allowed.
2234 are highly recommended. Partial clones will still be allowed.
2235 (default: False)
2235 (default: False)
2236
2236
2237 ``streamunbundle``
2237 ``streamunbundle``
2238 When set, servers will apply data sent from the client directly,
2238 When set, servers will apply data sent from the client directly,
2239 otherwise it will be written to a temporary file first. This option
2239 otherwise it will be written to a temporary file first. This option
2240 effectively prevents concurrent pushes.
2240 effectively prevents concurrent pushes.
2241
2241
2242 ``pullbundle``
2242 ``pullbundle``
2243 When set, the server will check pullbundle.manifest for bundles
2243 When set, the server will check pullbundle.manifest for bundles
2244 covering the requested heads and common nodes. The first matching
2244 covering the requested heads and common nodes. The first matching
2245 entry will be streamed to the client.
2245 entry will be streamed to the client.
2246
2246
2247 For HTTP transport, the stream will still use zlib compression
2247 For HTTP transport, the stream will still use zlib compression
2248 for older clients.
2248 for older clients.
2249
2249
2250 ``concurrent-push-mode``
2250 ``concurrent-push-mode``
2251 Level of allowed race condition between two pushing clients.
2251 Level of allowed race condition between two pushing clients.
2252
2252
2253 - 'strict': push is abort if another client touched the repository
2253 - 'strict': push is abort if another client touched the repository
2254 while the push was preparing.
2254 while the push was preparing.
2255 - 'check-related': push is only aborted if it affects head that got also
2255 - 'check-related': push is only aborted if it affects head that got also
2256 affected while the push was preparing. (default since 5.4)
2256 affected while the push was preparing. (default since 5.4)
2257
2257
2258 'check-related' only takes effect for compatible clients (version
2258 'check-related' only takes effect for compatible clients (version
2259 4.3 and later). Older clients will use 'strict'.
2259 4.3 and later). Older clients will use 'strict'.
2260
2260
2261 ``validate``
2261 ``validate``
2262 Whether to validate the completeness of pushed changesets by
2262 Whether to validate the completeness of pushed changesets by
2263 checking that all new file revisions specified in manifests are
2263 checking that all new file revisions specified in manifests are
2264 present. (default: False)
2264 present. (default: False)
2265
2265
2266 ``maxhttpheaderlen``
2266 ``maxhttpheaderlen``
2267 Instruct HTTP clients not to send request headers longer than this
2267 Instruct HTTP clients not to send request headers longer than this
2268 many bytes. (default: 1024)
2268 many bytes. (default: 1024)
2269
2269
2270 ``bundle1``
2270 ``bundle1``
2271 Whether to allow clients to push and pull using the legacy bundle1
2271 Whether to allow clients to push and pull using the legacy bundle1
2272 exchange format. (default: True)
2272 exchange format. (default: True)
2273
2273
2274 ``bundle1gd``
2274 ``bundle1gd``
2275 Like ``bundle1`` but only used if the repository is using the
2275 Like ``bundle1`` but only used if the repository is using the
2276 *generaldelta* storage format. (default: True)
2276 *generaldelta* storage format. (default: True)
2277
2277
2278 ``bundle1.push``
2278 ``bundle1.push``
2279 Whether to allow clients to push using the legacy bundle1 exchange
2279 Whether to allow clients to push using the legacy bundle1 exchange
2280 format. (default: True)
2280 format. (default: True)
2281
2281
2282 ``bundle1gd.push``
2282 ``bundle1gd.push``
2283 Like ``bundle1.push`` but only used if the repository is using the
2283 Like ``bundle1.push`` but only used if the repository is using the
2284 *generaldelta* storage format. (default: True)
2284 *generaldelta* storage format. (default: True)
2285
2285
2286 ``bundle1.pull``
2286 ``bundle1.pull``
2287 Whether to allow clients to pull using the legacy bundle1 exchange
2287 Whether to allow clients to pull using the legacy bundle1 exchange
2288 format. (default: True)
2288 format. (default: True)
2289
2289
2290 ``bundle1gd.pull``
2290 ``bundle1gd.pull``
2291 Like ``bundle1.pull`` but only used if the repository is using the
2291 Like ``bundle1.pull`` but only used if the repository is using the
2292 *generaldelta* storage format. (default: True)
2292 *generaldelta* storage format. (default: True)
2293
2293
2294 Large repositories using the *generaldelta* storage format should
2294 Large repositories using the *generaldelta* storage format should
2295 consider setting this option because converting *generaldelta*
2295 consider setting this option because converting *generaldelta*
2296 repositories to the exchange format required by the bundle1 data
2296 repositories to the exchange format required by the bundle1 data
2297 format can consume a lot of CPU.
2297 format can consume a lot of CPU.
2298
2298
2299 ``bundle2.stream``
2299 ``bundle2.stream``
2300 Whether to allow clients to pull using the bundle2 streaming protocol.
2300 Whether to allow clients to pull using the bundle2 streaming protocol.
2301 (default: True)
2301 (default: True)
2302
2302
2303 ``zliblevel``
2303 ``zliblevel``
2304 Integer between ``-1`` and ``9`` that controls the zlib compression level
2304 Integer between ``-1`` and ``9`` that controls the zlib compression level
2305 for wire protocol commands that send zlib compressed output (notably the
2305 for wire protocol commands that send zlib compressed output (notably the
2306 commands that send repository history data).
2306 commands that send repository history data).
2307
2307
2308 The default (``-1``) uses the default zlib compression level, which is
2308 The default (``-1``) uses the default zlib compression level, which is
2309 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
2309 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
2310 maximum compression.
2310 maximum compression.
2311
2311
2312 Setting this option allows server operators to make trade-offs between
2312 Setting this option allows server operators to make trade-offs between
2313 bandwidth and CPU used. Lowering the compression lowers CPU utilization
2313 bandwidth and CPU used. Lowering the compression lowers CPU utilization
2314 but sends more bytes to clients.
2314 but sends more bytes to clients.
2315
2315
2316 This option only impacts the HTTP server.
2316 This option only impacts the HTTP server.
2317
2317
2318 ``zstdlevel``
2318 ``zstdlevel``
2319 Integer between ``1`` and ``22`` that controls the zstd compression level
2319 Integer between ``1`` and ``22`` that controls the zstd compression level
2320 for wire protocol commands. ``1`` is the minimal amount of compression and
2320 for wire protocol commands. ``1`` is the minimal amount of compression and
2321 ``22`` is the highest amount of compression.
2321 ``22`` is the highest amount of compression.
2322
2322
2323 The default (``3``) should be significantly faster than zlib while likely
2323 The default (``3``) should be significantly faster than zlib while likely
2324 delivering better compression ratios.
2324 delivering better compression ratios.
2325
2325
2326 This option only impacts the HTTP server.
2326 This option only impacts the HTTP server.
2327
2327
2328 See also ``server.zliblevel``.
2328 See also ``server.zliblevel``.
2329
2329
2330 ``view``
2330 ``view``
2331 Repository filter used when exchanging revisions with the peer.
2331 Repository filter used when exchanging revisions with the peer.
2332
2332
2333 The default view (``served``) excludes secret and hidden changesets.
2333 The default view (``served``) excludes secret and hidden changesets.
2334 Another useful value is ``immutable`` (no draft, secret or hidden
2334 Another useful value is ``immutable`` (no draft, secret or hidden
2335 changesets). (EXPERIMENTAL)
2335 changesets). (EXPERIMENTAL)
2336
2336
2337 ``smtp``
2337 ``smtp``
2338 --------
2338 --------
2339
2339
2340 Configuration for extensions that need to send email messages.
2340 Configuration for extensions that need to send email messages.
2341
2341
2342 ``host``
2342 ``host``
2343 Host name of mail server, e.g. "mail.example.com".
2343 Host name of mail server, e.g. "mail.example.com".
2344
2344
2345 ``port``
2345 ``port``
2346 Optional. Port to connect to on mail server. (default: 465 if
2346 Optional. Port to connect to on mail server. (default: 465 if
2347 ``tls`` is smtps; 25 otherwise)
2347 ``tls`` is smtps; 25 otherwise)
2348
2348
2349 ``tls``
2349 ``tls``
2350 Optional. Method to enable TLS when connecting to mail server: starttls,
2350 Optional. Method to enable TLS when connecting to mail server: starttls,
2351 smtps or none. (default: none)
2351 smtps or none. (default: none)
2352
2352
2353 ``username``
2353 ``username``
2354 Optional. User name for authenticating with the SMTP server.
2354 Optional. User name for authenticating with the SMTP server.
2355 (default: None)
2355 (default: None)
2356
2356
2357 ``password``
2357 ``password``
2358 Optional. Password for authenticating with the SMTP server. If not
2358 Optional. Password for authenticating with the SMTP server. If not
2359 specified, interactive sessions will prompt the user for a
2359 specified, interactive sessions will prompt the user for a
2360 password; non-interactive sessions will fail. (default: None)
2360 password; non-interactive sessions will fail. (default: None)
2361
2361
2362 ``local_hostname``
2362 ``local_hostname``
2363 Optional. The hostname that the sender can use to identify
2363 Optional. The hostname that the sender can use to identify
2364 itself to the MTA.
2364 itself to the MTA.
2365
2365
2366
2366
2367 ``subpaths``
2367 ``subpaths``
2368 ------------
2368 ------------
2369
2369
2370 Subrepository source URLs can go stale if a remote server changes name
2370 Subrepository source URLs can go stale if a remote server changes name
2371 or becomes temporarily unavailable. This section lets you define
2371 or becomes temporarily unavailable. This section lets you define
2372 rewrite rules of the form::
2372 rewrite rules of the form::
2373
2373
2374 <pattern> = <replacement>
2374 <pattern> = <replacement>
2375
2375
2376 where ``pattern`` is a regular expression matching a subrepository
2376 where ``pattern`` is a regular expression matching a subrepository
2377 source URL and ``replacement`` is the replacement string used to
2377 source URL and ``replacement`` is the replacement string used to
2378 rewrite it. Groups can be matched in ``pattern`` and referenced in
2378 rewrite it. Groups can be matched in ``pattern`` and referenced in
2379 ``replacements``. For instance::
2379 ``replacements``. For instance::
2380
2380
2381 http://server/(.*)-hg/ = http://hg.server/\1/
2381 http://server/(.*)-hg/ = http://hg.server/\1/
2382
2382
2383 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2383 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2384
2384
2385 Relative subrepository paths are first made absolute, and the
2385 Relative subrepository paths are first made absolute, and the
2386 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2386 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2387 doesn't match the full path, an attempt is made to apply it on the
2387 doesn't match the full path, an attempt is made to apply it on the
2388 relative path alone. The rules are applied in definition order.
2388 relative path alone. The rules are applied in definition order.
2389
2389
2390 ``subrepos``
2390 ``subrepos``
2391 ------------
2391 ------------
2392
2392
2393 This section contains options that control the behavior of the
2393 This section contains options that control the behavior of the
2394 subrepositories feature. See also :hg:`help subrepos`.
2394 subrepositories feature. See also :hg:`help subrepos`.
2395
2395
2396 Security note: auditing in Mercurial is known to be insufficient to
2396 Security note: auditing in Mercurial is known to be insufficient to
2397 prevent clone-time code execution with carefully constructed Git
2397 prevent clone-time code execution with carefully constructed Git
2398 subrepos. It is unknown if a similar detect is present in Subversion
2398 subrepos. It is unknown if a similar detect is present in Subversion
2399 subrepos. Both Git and Subversion subrepos are disabled by default
2399 subrepos. Both Git and Subversion subrepos are disabled by default
2400 out of security concerns. These subrepo types can be enabled using
2400 out of security concerns. These subrepo types can be enabled using
2401 the respective options below.
2401 the respective options below.
2402
2402
2403 ``allowed``
2403 ``allowed``
2404 Whether subrepositories are allowed in the working directory.
2404 Whether subrepositories are allowed in the working directory.
2405
2405
2406 When false, commands involving subrepositories (like :hg:`update`)
2406 When false, commands involving subrepositories (like :hg:`update`)
2407 will fail for all subrepository types.
2407 will fail for all subrepository types.
2408 (default: true)
2408 (default: true)
2409
2409
2410 ``hg:allowed``
2410 ``hg:allowed``
2411 Whether Mercurial subrepositories are allowed in the working
2411 Whether Mercurial subrepositories are allowed in the working
2412 directory. This option only has an effect if ``subrepos.allowed``
2412 directory. This option only has an effect if ``subrepos.allowed``
2413 is true.
2413 is true.
2414 (default: true)
2414 (default: true)
2415
2415
2416 ``git:allowed``
2416 ``git:allowed``
2417 Whether Git subrepositories are allowed in the working directory.
2417 Whether Git subrepositories are allowed in the working directory.
2418 This option only has an effect if ``subrepos.allowed`` is true.
2418 This option only has an effect if ``subrepos.allowed`` is true.
2419
2419
2420 See the security note above before enabling Git subrepos.
2420 See the security note above before enabling Git subrepos.
2421 (default: false)
2421 (default: false)
2422
2422
2423 ``svn:allowed``
2423 ``svn:allowed``
2424 Whether Subversion subrepositories are allowed in the working
2424 Whether Subversion subrepositories are allowed in the working
2425 directory. This option only has an effect if ``subrepos.allowed``
2425 directory. This option only has an effect if ``subrepos.allowed``
2426 is true.
2426 is true.
2427
2427
2428 See the security note above before enabling Subversion subrepos.
2428 See the security note above before enabling Subversion subrepos.
2429 (default: false)
2429 (default: false)
2430
2430
2431 ``templatealias``
2431 ``templatealias``
2432 -----------------
2432 -----------------
2433
2433
2434 Alias definitions for templates. See :hg:`help templates` for details.
2434 Alias definitions for templates. See :hg:`help templates` for details.
2435
2435
2436 ``templates``
2436 ``templates``
2437 -------------
2437 -------------
2438
2438
2439 Use the ``[templates]`` section to define template strings.
2439 Use the ``[templates]`` section to define template strings.
2440 See :hg:`help templates` for details.
2440 See :hg:`help templates` for details.
2441
2441
2442 ``trusted``
2442 ``trusted``
2443 -----------
2443 -----------
2444
2444
2445 Mercurial will not use the settings in the
2445 Mercurial will not use the settings in the
2446 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2446 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2447 user or to a trusted group, as various hgrc features allow arbitrary
2447 user or to a trusted group, as various hgrc features allow arbitrary
2448 commands to be run. This issue is often encountered when configuring
2448 commands to be run. This issue is often encountered when configuring
2449 hooks or extensions for shared repositories or servers. However,
2449 hooks or extensions for shared repositories or servers. However,
2450 the web interface will use some safe settings from the ``[web]``
2450 the web interface will use some safe settings from the ``[web]``
2451 section.
2451 section.
2452
2452
2453 This section specifies what users and groups are trusted. The
2453 This section specifies what users and groups are trusted. The
2454 current user is always trusted. To trust everybody, list a user or a
2454 current user is always trusted. To trust everybody, list a user or a
2455 group with name ``*``. These settings must be placed in an
2455 group with name ``*``. These settings must be placed in an
2456 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2456 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2457 user or service running Mercurial.
2457 user or service running Mercurial.
2458
2458
2459 ``users``
2459 ``users``
2460 Comma-separated list of trusted users.
2460 Comma-separated list of trusted users.
2461
2461
2462 ``groups``
2462 ``groups``
2463 Comma-separated list of trusted groups.
2463 Comma-separated list of trusted groups.
2464
2464
2465
2465
2466 ``ui``
2466 ``ui``
2467 ------
2467 ------
2468
2468
2469 User interface controls.
2469 User interface controls.
2470
2470
2471 ``archivemeta``
2471 ``archivemeta``
2472 Whether to include the .hg_archival.txt file containing meta data
2472 Whether to include the .hg_archival.txt file containing meta data
2473 (hashes for the repository base and for tip) in archives created
2473 (hashes for the repository base and for tip) in archives created
2474 by the :hg:`archive` command or downloaded via hgweb.
2474 by the :hg:`archive` command or downloaded via hgweb.
2475 (default: True)
2475 (default: True)
2476
2476
2477 ``askusername``
2477 ``askusername``
2478 Whether to prompt for a username when committing. If True, and
2478 Whether to prompt for a username when committing. If True, and
2479 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2479 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2480 be prompted to enter a username. If no username is entered, the
2480 be prompted to enter a username. If no username is entered, the
2481 default ``USER@HOST`` is used instead.
2481 default ``USER@HOST`` is used instead.
2482 (default: False)
2482 (default: False)
2483
2483
2484 ``clonebundles``
2484 ``clonebundles``
2485 Whether the "clone bundles" feature is enabled.
2485 Whether the "clone bundles" feature is enabled.
2486
2486
2487 When enabled, :hg:`clone` may download and apply a server-advertised
2487 When enabled, :hg:`clone` may download and apply a server-advertised
2488 bundle file from a URL instead of using the normal exchange mechanism.
2488 bundle file from a URL instead of using the normal exchange mechanism.
2489
2489
2490 This can likely result in faster and more reliable clones.
2490 This can likely result in faster and more reliable clones.
2491
2491
2492 (default: True)
2492 (default: True)
2493
2493
2494 ``clonebundlefallback``
2494 ``clonebundlefallback``
2495 Whether failure to apply an advertised "clone bundle" from a server
2495 Whether failure to apply an advertised "clone bundle" from a server
2496 should result in fallback to a regular clone.
2496 should result in fallback to a regular clone.
2497
2497
2498 This is disabled by default because servers advertising "clone
2498 This is disabled by default because servers advertising "clone
2499 bundles" often do so to reduce server load. If advertised bundles
2499 bundles" often do so to reduce server load. If advertised bundles
2500 start mass failing and clients automatically fall back to a regular
2500 start mass failing and clients automatically fall back to a regular
2501 clone, this would add significant and unexpected load to the server
2501 clone, this would add significant and unexpected load to the server
2502 since the server is expecting clone operations to be offloaded to
2502 since the server is expecting clone operations to be offloaded to
2503 pre-generated bundles. Failing fast (the default behavior) ensures
2503 pre-generated bundles. Failing fast (the default behavior) ensures
2504 clients don't overwhelm the server when "clone bundle" application
2504 clients don't overwhelm the server when "clone bundle" application
2505 fails.
2505 fails.
2506
2506
2507 (default: False)
2507 (default: False)
2508
2508
2509 ``clonebundleprefers``
2509 ``clonebundleprefers``
2510 Defines preferences for which "clone bundles" to use.
2510 Defines preferences for which "clone bundles" to use.
2511
2511
2512 Servers advertising "clone bundles" may advertise multiple available
2512 Servers advertising "clone bundles" may advertise multiple available
2513 bundles. Each bundle may have different attributes, such as the bundle
2513 bundles. Each bundle may have different attributes, such as the bundle
2514 type and compression format. This option is used to prefer a particular
2514 type and compression format. This option is used to prefer a particular
2515 bundle over another.
2515 bundle over another.
2516
2516
2517 The following keys are defined by Mercurial:
2517 The following keys are defined by Mercurial:
2518
2518
2519 BUNDLESPEC
2519 BUNDLESPEC
2520 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2520 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2521 e.g. ``gzip-v2`` or ``bzip2-v1``.
2521 e.g. ``gzip-v2`` or ``bzip2-v1``.
2522
2522
2523 COMPRESSION
2523 COMPRESSION
2524 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2524 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2525
2525
2526 Server operators may define custom keys.
2526 Server operators may define custom keys.
2527
2527
2528 Example values: ``COMPRESSION=bzip2``,
2528 Example values: ``COMPRESSION=bzip2``,
2529 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2529 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2530
2530
2531 By default, the first bundle advertised by the server is used.
2531 By default, the first bundle advertised by the server is used.
2532
2532
2533 ``color``
2533 ``color``
2534 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2534 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2535 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2535 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2536 seems possible. See :hg:`help color` for details.
2536 seems possible. See :hg:`help color` for details.
2537
2537
2538 ``commitsubrepos``
2538 ``commitsubrepos``
2539 Whether to commit modified subrepositories when committing the
2539 Whether to commit modified subrepositories when committing the
2540 parent repository. If False and one subrepository has uncommitted
2540 parent repository. If False and one subrepository has uncommitted
2541 changes, abort the commit.
2541 changes, abort the commit.
2542 (default: False)
2542 (default: False)
2543
2543
2544 ``debug``
2544 ``debug``
2545 Print debugging information. (default: False)
2545 Print debugging information. (default: False)
2546
2546
2547 ``editor``
2547 ``editor``
2548 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2548 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2549
2549
2550 ``fallbackencoding``
2550 ``fallbackencoding``
2551 Encoding to try if it's not possible to decode the changelog using
2551 Encoding to try if it's not possible to decode the changelog using
2552 UTF-8. (default: ISO-8859-1)
2552 UTF-8. (default: ISO-8859-1)
2553
2553
2554 ``graphnodetemplate``
2554 ``graphnodetemplate``
2555 (DEPRECATED) Use ``command-templates.graphnode`` instead.
2555 (DEPRECATED) Use ``command-templates.graphnode`` instead.
2556
2556
2557 ``ignore``
2557 ``ignore``
2558 A file to read per-user ignore patterns from. This file should be
2558 A file to read per-user ignore patterns from. This file should be
2559 in the same format as a repository-wide .hgignore file. Filenames
2559 in the same format as a repository-wide .hgignore file. Filenames
2560 are relative to the repository root. This option supports hook syntax,
2560 are relative to the repository root. This option supports hook syntax,
2561 so if you want to specify multiple ignore files, you can do so by
2561 so if you want to specify multiple ignore files, you can do so by
2562 setting something like ``ignore.other = ~/.hgignore2``. For details
2562 setting something like ``ignore.other = ~/.hgignore2``. For details
2563 of the ignore file format, see the ``hgignore(5)`` man page.
2563 of the ignore file format, see the ``hgignore(5)`` man page.
2564
2564
2565 ``interactive``
2565 ``interactive``
2566 Allow to prompt the user. (default: True)
2566 Allow to prompt the user. (default: True)
2567
2567
2568 ``interface``
2568 ``interface``
2569 Select the default interface for interactive features (default: text).
2569 Select the default interface for interactive features (default: text).
2570 Possible values are 'text' and 'curses'.
2570 Possible values are 'text' and 'curses'.
2571
2571
2572 ``interface.chunkselector``
2572 ``interface.chunkselector``
2573 Select the interface for change recording (e.g. :hg:`commit -i`).
2573 Select the interface for change recording (e.g. :hg:`commit -i`).
2574 Possible values are 'text' and 'curses'.
2574 Possible values are 'text' and 'curses'.
2575 This config overrides the interface specified by ui.interface.
2575 This config overrides the interface specified by ui.interface.
2576
2576
2577 ``large-file-limit``
2577 ``large-file-limit``
2578 Largest file size that gives no memory use warning.
2578 Largest file size that gives no memory use warning.
2579 Possible values are integers or 0 to disable the check.
2579 Possible values are integers or 0 to disable the check.
2580 (default: 10000000)
2580 (default: 10000000)
2581
2581
2582 ``logtemplate``
2582 ``logtemplate``
2583 (DEPRECATED) Use ``command-templates.log`` instead.
2583 (DEPRECATED) Use ``command-templates.log`` instead.
2584
2584
2585 ``merge``
2585 ``merge``
2586 The conflict resolution program to use during a manual merge.
2586 The conflict resolution program to use during a manual merge.
2587 For more information on merge tools see :hg:`help merge-tools`.
2587 For more information on merge tools see :hg:`help merge-tools`.
2588 For configuring merge tools see the ``[merge-tools]`` section.
2588 For configuring merge tools see the ``[merge-tools]`` section.
2589
2589
2590 ``mergemarkers``
2590 ``mergemarkers``
2591 Sets the merge conflict marker label styling. The ``detailed`` style
2591 Sets the merge conflict marker label styling. The ``detailed`` style
2592 uses the ``command-templates.mergemarker`` setting to style the labels.
2592 uses the ``command-templates.mergemarker`` setting to style the labels.
2593 The ``basic`` style just uses 'local' and 'other' as the marker label.
2593 The ``basic`` style just uses 'local' and 'other' as the marker label.
2594 One of ``basic`` or ``detailed``.
2594 One of ``basic`` or ``detailed``.
2595 (default: ``basic``)
2595 (default: ``basic``)
2596
2596
2597 ``mergemarkertemplate``
2597 ``mergemarkertemplate``
2598 (DEPRECATED) Use ``command-templates.mergemarker`` instead.
2598 (DEPRECATED) Use ``command-templates.mergemarker`` instead.
2599
2599
2600 ``message-output``
2600 ``message-output``
2601 Where to write status and error messages. (default: ``stdio``)
2601 Where to write status and error messages. (default: ``stdio``)
2602
2602
2603 ``channel``
2603 ``channel``
2604 Use separate channel for structured output. (Command-server only)
2604 Use separate channel for structured output. (Command-server only)
2605 ``stderr``
2605 ``stderr``
2606 Everything to stderr.
2606 Everything to stderr.
2607 ``stdio``
2607 ``stdio``
2608 Status to stdout, and error to stderr.
2608 Status to stdout, and error to stderr.
2609
2609
2610 ``origbackuppath``
2610 ``origbackuppath``
2611 The path to a directory used to store generated .orig files. If the path is
2611 The path to a directory used to store generated .orig files. If the path is
2612 not a directory, one will be created. If set, files stored in this
2612 not a directory, one will be created. If set, files stored in this
2613 directory have the same name as the original file and do not have a .orig
2613 directory have the same name as the original file and do not have a .orig
2614 suffix.
2614 suffix.
2615
2615
2616 ``paginate``
2616 ``paginate``
2617 Control the pagination of command output (default: True). See :hg:`help pager`
2617 Control the pagination of command output (default: True). See :hg:`help pager`
2618 for details.
2618 for details.
2619
2619
2620 ``patch``
2620 ``patch``
2621 An optional external tool that ``hg import`` and some extensions
2621 An optional external tool that ``hg import`` and some extensions
2622 will use for applying patches. By default Mercurial uses an
2622 will use for applying patches. By default Mercurial uses an
2623 internal patch utility. The external tool must work as the common
2623 internal patch utility. The external tool must work as the common
2624 Unix ``patch`` program. In particular, it must accept a ``-p``
2624 Unix ``patch`` program. In particular, it must accept a ``-p``
2625 argument to strip patch headers, a ``-d`` argument to specify the
2625 argument to strip patch headers, a ``-d`` argument to specify the
2626 current directory, a file name to patch, and a patch file to take
2626 current directory, a file name to patch, and a patch file to take
2627 from stdin.
2627 from stdin.
2628
2628
2629 It is possible to specify a patch tool together with extra
2629 It is possible to specify a patch tool together with extra
2630 arguments. For example, setting this option to ``patch --merge``
2630 arguments. For example, setting this option to ``patch --merge``
2631 will use the ``patch`` program with its 2-way merge option.
2631 will use the ``patch`` program with its 2-way merge option.
2632
2632
2633 ``portablefilenames``
2633 ``portablefilenames``
2634 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2634 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2635 (default: ``warn``)
2635 (default: ``warn``)
2636
2636
2637 ``warn``
2637 ``warn``
2638 Print a warning message on POSIX platforms, if a file with a non-portable
2638 Print a warning message on POSIX platforms, if a file with a non-portable
2639 filename is added (e.g. a file with a name that can't be created on
2639 filename is added (e.g. a file with a name that can't be created on
2640 Windows because it contains reserved parts like ``AUX``, reserved
2640 Windows because it contains reserved parts like ``AUX``, reserved
2641 characters like ``:``, or would cause a case collision with an existing
2641 characters like ``:``, or would cause a case collision with an existing
2642 file).
2642 file).
2643
2643
2644 ``ignore``
2644 ``ignore``
2645 Don't print a warning.
2645 Don't print a warning.
2646
2646
2647 ``abort``
2647 ``abort``
2648 The command is aborted.
2648 The command is aborted.
2649
2649
2650 ``true``
2650 ``true``
2651 Alias for ``warn``.
2651 Alias for ``warn``.
2652
2652
2653 ``false``
2653 ``false``
2654 Alias for ``ignore``.
2654 Alias for ``ignore``.
2655
2655
2656 .. container:: windows
2656 .. container:: windows
2657
2657
2658 On Windows, this configuration option is ignored and the command aborted.
2658 On Windows, this configuration option is ignored and the command aborted.
2659
2659
2660 ``pre-merge-tool-output-template``
2660 ``pre-merge-tool-output-template``
2661 (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
2661 (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
2662
2662
2663 ``quiet``
2663 ``quiet``
2664 Reduce the amount of output printed.
2664 Reduce the amount of output printed.
2665 (default: False)
2665 (default: False)
2666
2666
2667 ``relative-paths``
2667 ``relative-paths``
2668 Prefer relative paths in the UI.
2668 Prefer relative paths in the UI.
2669
2669
2670 ``remotecmd``
2670 ``remotecmd``
2671 Remote command to use for clone/push/pull operations.
2671 Remote command to use for clone/push/pull operations.
2672 (default: ``hg``)
2672 (default: ``hg``)
2673
2673
2674 ``report_untrusted``
2674 ``report_untrusted``
2675 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2675 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2676 trusted user or group.
2676 trusted user or group.
2677 (default: True)
2677 (default: True)
2678
2678
2679 ``slash``
2679 ``slash``
2680 (Deprecated. Use ``slashpath`` template filter instead.)
2680 (Deprecated. Use ``slashpath`` template filter instead.)
2681
2681
2682 Display paths using a slash (``/``) as the path separator. This
2682 Display paths using a slash (``/``) as the path separator. This
2683 only makes a difference on systems where the default path
2683 only makes a difference on systems where the default path
2684 separator is not the slash character (e.g. Windows uses the
2684 separator is not the slash character (e.g. Windows uses the
2685 backslash character (``\``)).
2685 backslash character (``\``)).
2686 (default: False)
2686 (default: False)
2687
2687
2688 ``statuscopies``
2688 ``statuscopies``
2689 Display copies in the status command.
2689 Display copies in the status command.
2690
2690
2691 ``ssh``
2691 ``ssh``
2692 Command to use for SSH connections. (default: ``ssh``)
2692 Command to use for SSH connections. (default: ``ssh``)
2693
2693
2694 ``ssherrorhint``
2694 ``ssherrorhint``
2695 A hint shown to the user in the case of SSH error (e.g.
2695 A hint shown to the user in the case of SSH error (e.g.
2696 ``Please see http://company/internalwiki/ssh.html``)
2696 ``Please see http://company/internalwiki/ssh.html``)
2697
2697
2698 ``strict``
2698 ``strict``
2699 Require exact command names, instead of allowing unambiguous
2699 Require exact command names, instead of allowing unambiguous
2700 abbreviations. (default: False)
2700 abbreviations. (default: False)
2701
2701
2702 ``style``
2702 ``style``
2703 Name of style to use for command output.
2703 Name of style to use for command output.
2704
2704
2705 ``supportcontact``
2705 ``supportcontact``
2706 A URL where users should report a Mercurial traceback. Use this if you are a
2706 A URL where users should report a Mercurial traceback. Use this if you are a
2707 large organisation with its own Mercurial deployment process and crash
2707 large organisation with its own Mercurial deployment process and crash
2708 reports should be addressed to your internal support.
2708 reports should be addressed to your internal support.
2709
2709
2710 ``textwidth``
2710 ``textwidth``
2711 Maximum width of help text. A longer line generated by ``hg help`` or
2711 Maximum width of help text. A longer line generated by ``hg help`` or
2712 ``hg subcommand --help`` will be broken after white space to get this
2712 ``hg subcommand --help`` will be broken after white space to get this
2713 width or the terminal width, whichever comes first.
2713 width or the terminal width, whichever comes first.
2714 A non-positive value will disable this and the terminal width will be
2714 A non-positive value will disable this and the terminal width will be
2715 used. (default: 78)
2715 used. (default: 78)
2716
2716
2717 ``timeout``
2717 ``timeout``
2718 The timeout used when a lock is held (in seconds), a negative value
2718 The timeout used when a lock is held (in seconds), a negative value
2719 means no timeout. (default: 600)
2719 means no timeout. (default: 600)
2720
2720
2721 ``timeout.warn``
2721 ``timeout.warn``
2722 Time (in seconds) before a warning is printed about held lock. A negative
2722 Time (in seconds) before a warning is printed about held lock. A negative
2723 value means no warning. (default: 0)
2723 value means no warning. (default: 0)
2724
2724
2725 ``traceback``
2725 ``traceback``
2726 Mercurial always prints a traceback when an unknown exception
2726 Mercurial always prints a traceback when an unknown exception
2727 occurs. Setting this to True will make Mercurial print a traceback
2727 occurs. Setting this to True will make Mercurial print a traceback
2728 on all exceptions, even those recognized by Mercurial (such as
2728 on all exceptions, even those recognized by Mercurial (such as
2729 IOError or MemoryError). (default: False)
2729 IOError or MemoryError). (default: False)
2730
2730
2731 ``tweakdefaults``
2731 ``tweakdefaults``
2732
2732
2733 By default Mercurial's behavior changes very little from release
2733 By default Mercurial's behavior changes very little from release
2734 to release, but over time the recommended config settings
2734 to release, but over time the recommended config settings
2735 shift. Enable this config to opt in to get automatic tweaks to
2735 shift. Enable this config to opt in to get automatic tweaks to
2736 Mercurial's behavior over time. This config setting will have no
2736 Mercurial's behavior over time. This config setting will have no
2737 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2737 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2738 not include ``tweakdefaults``. (default: False)
2738 not include ``tweakdefaults``. (default: False)
2739
2739
2740 It currently means::
2740 It currently means::
2741
2741
2742 .. tweakdefaultsmarker
2742 .. tweakdefaultsmarker
2743
2743
2744 ``username``
2744 ``username``
2745 The committer of a changeset created when running "commit".
2745 The committer of a changeset created when running "commit".
2746 Typically a person's name and email address, e.g. ``Fred Widget
2746 Typically a person's name and email address, e.g. ``Fred Widget
2747 <fred@example.com>``. Environment variables in the
2747 <fred@example.com>``. Environment variables in the
2748 username are expanded.
2748 username are expanded.
2749
2749
2750 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2750 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2751 hgrc is empty, e.g. if the system admin set ``username =`` in the
2751 hgrc is empty, e.g. if the system admin set ``username =`` in the
2752 system hgrc, it has to be specified manually or in a different
2752 system hgrc, it has to be specified manually or in a different
2753 hgrc file)
2753 hgrc file)
2754
2754
2755 ``verbose``
2755 ``verbose``
2756 Increase the amount of output printed. (default: False)
2756 Increase the amount of output printed. (default: False)
2757
2757
2758
2758
2759 ``command-templates``
2759 ``command-templates``
2760 ---------------------
2760 ---------------------
2761
2761
2762 Templates used for customizing the output of commands.
2762 Templates used for customizing the output of commands.
2763
2763
2764 ``graphnode``
2764 ``graphnode``
2765 The template used to print changeset nodes in an ASCII revision graph.
2765 The template used to print changeset nodes in an ASCII revision graph.
2766 (default: ``{graphnode}``)
2766 (default: ``{graphnode}``)
2767
2767
2768 ``log``
2768 ``log``
2769 Template string for commands that print changesets.
2769 Template string for commands that print changesets.
2770
2770
2771 ``mergemarker``
2771 ``mergemarker``
2772 The template used to print the commit description next to each conflict
2772 The template used to print the commit description next to each conflict
2773 marker during merge conflicts. See :hg:`help templates` for the template
2773 marker during merge conflicts. See :hg:`help templates` for the template
2774 format.
2774 format.
2775
2775
2776 Defaults to showing the hash, tags, branches, bookmarks, author, and
2776 Defaults to showing the hash, tags, branches, bookmarks, author, and
2777 the first line of the commit description.
2777 the first line of the commit description.
2778
2778
2779 If you use non-ASCII characters in names for tags, branches, bookmarks,
2779 If you use non-ASCII characters in names for tags, branches, bookmarks,
2780 authors, and/or commit descriptions, you must pay attention to encodings of
2780 authors, and/or commit descriptions, you must pay attention to encodings of
2781 managed files. At template expansion, non-ASCII characters use the encoding
2781 managed files. At template expansion, non-ASCII characters use the encoding
2782 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2782 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2783 environment variables that govern your locale. If the encoding of the merge
2783 environment variables that govern your locale. If the encoding of the merge
2784 markers is different from the encoding of the merged files,
2784 markers is different from the encoding of the merged files,
2785 serious problems may occur.
2785 serious problems may occur.
2786
2786
2787 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2787 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2788
2788
2789 ``oneline-summary``
2789 ``oneline-summary``
2790 A template used by `hg rebase` and other commands for showing a one-line
2790 A template used by `hg rebase` and other commands for showing a one-line
2791 summary of a commit. If the template configured here is longer than one
2791 summary of a commit. If the template configured here is longer than one
2792 line, then only the first line is used.
2792 line, then only the first line is used.
2793
2793
2794 The template can be overridden per command by defining a template in
2794 The template can be overridden per command by defining a template in
2795 `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
2795 `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
2796
2796
2797 ``pre-merge-tool-output``
2797 ``pre-merge-tool-output``
2798 A template that is printed before executing an external merge tool. This can
2798 A template that is printed before executing an external merge tool. This can
2799 be used to print out additional context that might be useful to have during
2799 be used to print out additional context that might be useful to have during
2800 the conflict resolution, such as the description of the various commits
2800 the conflict resolution, such as the description of the various commits
2801 involved or bookmarks/tags.
2801 involved or bookmarks/tags.
2802
2802
2803 Additional information is available in the ``local`, ``base``, and ``other``
2803 Additional information is available in the ``local`, ``base``, and ``other``
2804 dicts. For example: ``{local.label}``, ``{base.name}``, or
2804 dicts. For example: ``{local.label}``, ``{base.name}``, or
2805 ``{other.islink}``.
2805 ``{other.islink}``.
2806
2806
2807
2807
2808 ``web``
2808 ``web``
2809 -------
2809 -------
2810
2810
2811 Web interface configuration. The settings in this section apply to
2811 Web interface configuration. The settings in this section apply to
2812 both the builtin webserver (started by :hg:`serve`) and the script you
2812 both the builtin webserver (started by :hg:`serve`) and the script you
2813 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2813 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2814 and WSGI).
2814 and WSGI).
2815
2815
2816 The Mercurial webserver does no authentication (it does not prompt for
2816 The Mercurial webserver does no authentication (it does not prompt for
2817 usernames and passwords to validate *who* users are), but it does do
2817 usernames and passwords to validate *who* users are), but it does do
2818 authorization (it grants or denies access for *authenticated users*
2818 authorization (it grants or denies access for *authenticated users*
2819 based on settings in this section). You must either configure your
2819 based on settings in this section). You must either configure your
2820 webserver to do authentication for you, or disable the authorization
2820 webserver to do authentication for you, or disable the authorization
2821 checks.
2821 checks.
2822
2822
2823 For a quick setup in a trusted environment, e.g., a private LAN, where
2823 For a quick setup in a trusted environment, e.g., a private LAN, where
2824 you want it to accept pushes from anybody, you can use the following
2824 you want it to accept pushes from anybody, you can use the following
2825 command line::
2825 command line::
2826
2826
2827 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2827 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2828
2828
2829 Note that this will allow anybody to push anything to the server and
2829 Note that this will allow anybody to push anything to the server and
2830 that this should not be used for public servers.
2830 that this should not be used for public servers.
2831
2831
2832 The full set of options is:
2832 The full set of options is:
2833
2833
2834 ``accesslog``
2834 ``accesslog``
2835 Where to output the access log. (default: stdout)
2835 Where to output the access log. (default: stdout)
2836
2836
2837 ``address``
2837 ``address``
2838 Interface address to bind to. (default: all)
2838 Interface address to bind to. (default: all)
2839
2839
2840 ``allow-archive``
2840 ``allow-archive``
2841 List of archive format (bz2, gz, zip) allowed for downloading.
2841 List of archive format (bz2, gz, zip) allowed for downloading.
2842 (default: empty)
2842 (default: empty)
2843
2843
2844 ``allowbz2``
2844 ``allowbz2``
2845 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2845 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2846 revisions.
2846 revisions.
2847 (default: False)
2847 (default: False)
2848
2848
2849 ``allowgz``
2849 ``allowgz``
2850 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2850 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2851 revisions.
2851 revisions.
2852 (default: False)
2852 (default: False)
2853
2853
2854 ``allow-pull``
2854 ``allow-pull``
2855 Whether to allow pulling from the repository. (default: True)
2855 Whether to allow pulling from the repository. (default: True)
2856
2856
2857 ``allow-push``
2857 ``allow-push``
2858 Whether to allow pushing to the repository. If empty or not set,
2858 Whether to allow pushing to the repository. If empty or not set,
2859 pushing is not allowed. If the special value ``*``, any remote
2859 pushing is not allowed. If the special value ``*``, any remote
2860 user can push, including unauthenticated users. Otherwise, the
2860 user can push, including unauthenticated users. Otherwise, the
2861 remote user must have been authenticated, and the authenticated
2861 remote user must have been authenticated, and the authenticated
2862 user name must be present in this list. The contents of the
2862 user name must be present in this list. The contents of the
2863 allow-push list are examined after the deny_push list.
2863 allow-push list are examined after the deny_push list.
2864
2864
2865 ``allow_read``
2865 ``allow_read``
2866 If the user has not already been denied repository access due to
2866 If the user has not already been denied repository access due to
2867 the contents of deny_read, this list determines whether to grant
2867 the contents of deny_read, this list determines whether to grant
2868 repository access to the user. If this list is not empty, and the
2868 repository access to the user. If this list is not empty, and the
2869 user is unauthenticated or not present in the list, then access is
2869 user is unauthenticated or not present in the list, then access is
2870 denied for the user. If the list is empty or not set, then access
2870 denied for the user. If the list is empty or not set, then access
2871 is permitted to all users by default. Setting allow_read to the
2871 is permitted to all users by default. Setting allow_read to the
2872 special value ``*`` is equivalent to it not being set (i.e. access
2872 special value ``*`` is equivalent to it not being set (i.e. access
2873 is permitted to all users). The contents of the allow_read list are
2873 is permitted to all users). The contents of the allow_read list are
2874 examined after the deny_read list.
2874 examined after the deny_read list.
2875
2875
2876 ``allowzip``
2876 ``allowzip``
2877 (DEPRECATED) Whether to allow .zip downloading of repository
2877 (DEPRECATED) Whether to allow .zip downloading of repository
2878 revisions. This feature creates temporary files.
2878 revisions. This feature creates temporary files.
2879 (default: False)
2879 (default: False)
2880
2880
2881 ``archivesubrepos``
2881 ``archivesubrepos``
2882 Whether to recurse into subrepositories when archiving.
2882 Whether to recurse into subrepositories when archiving.
2883 (default: False)
2883 (default: False)
2884
2884
2885 ``baseurl``
2885 ``baseurl``
2886 Base URL to use when publishing URLs in other locations, so
2886 Base URL to use when publishing URLs in other locations, so
2887 third-party tools like email notification hooks can construct
2887 third-party tools like email notification hooks can construct
2888 URLs. Example: ``http://hgserver/repos/``.
2888 URLs. Example: ``http://hgserver/repos/``.
2889
2889
2890 ``cacerts``
2890 ``cacerts``
2891 Path to file containing a list of PEM encoded certificate
2891 Path to file containing a list of PEM encoded certificate
2892 authority certificates. Environment variables and ``~user``
2892 authority certificates. Environment variables and ``~user``
2893 constructs are expanded in the filename. If specified on the
2893 constructs are expanded in the filename. If specified on the
2894 client, then it will verify the identity of remote HTTPS servers
2894 client, then it will verify the identity of remote HTTPS servers
2895 with these certificates.
2895 with these certificates.
2896
2896
2897 To disable SSL verification temporarily, specify ``--insecure`` from
2897 To disable SSL verification temporarily, specify ``--insecure`` from
2898 command line.
2898 command line.
2899
2899
2900 You can use OpenSSL's CA certificate file if your platform has
2900 You can use OpenSSL's CA certificate file if your platform has
2901 one. On most Linux systems this will be
2901 one. On most Linux systems this will be
2902 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2902 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2903 generate this file manually. The form must be as follows::
2903 generate this file manually. The form must be as follows::
2904
2904
2905 -----BEGIN CERTIFICATE-----
2905 -----BEGIN CERTIFICATE-----
2906 ... (certificate in base64 PEM encoding) ...
2906 ... (certificate in base64 PEM encoding) ...
2907 -----END CERTIFICATE-----
2907 -----END CERTIFICATE-----
2908 -----BEGIN CERTIFICATE-----
2908 -----BEGIN CERTIFICATE-----
2909 ... (certificate in base64 PEM encoding) ...
2909 ... (certificate in base64 PEM encoding) ...
2910 -----END CERTIFICATE-----
2910 -----END CERTIFICATE-----
2911
2911
2912 ``cache``
2912 ``cache``
2913 Whether to support caching in hgweb. (default: True)
2913 Whether to support caching in hgweb. (default: True)
2914
2914
2915 ``certificate``
2915 ``certificate``
2916 Certificate to use when running :hg:`serve`.
2916 Certificate to use when running :hg:`serve`.
2917
2917
2918 ``collapse``
2918 ``collapse``
2919 With ``descend`` enabled, repositories in subdirectories are shown at
2919 With ``descend`` enabled, repositories in subdirectories are shown at
2920 a single level alongside repositories in the current path. With
2920 a single level alongside repositories in the current path. With
2921 ``collapse`` also enabled, repositories residing at a deeper level than
2921 ``collapse`` also enabled, repositories residing at a deeper level than
2922 the current path are grouped behind navigable directory entries that
2922 the current path are grouped behind navigable directory entries that
2923 lead to the locations of these repositories. In effect, this setting
2923 lead to the locations of these repositories. In effect, this setting
2924 collapses each collection of repositories found within a subdirectory
2924 collapses each collection of repositories found within a subdirectory
2925 into a single entry for that subdirectory. (default: False)
2925 into a single entry for that subdirectory. (default: False)
2926
2926
2927 ``comparisoncontext``
2927 ``comparisoncontext``
2928 Number of lines of context to show in side-by-side file comparison. If
2928 Number of lines of context to show in side-by-side file comparison. If
2929 negative or the value ``full``, whole files are shown. (default: 5)
2929 negative or the value ``full``, whole files are shown. (default: 5)
2930
2930
2931 This setting can be overridden by a ``context`` request parameter to the
2931 This setting can be overridden by a ``context`` request parameter to the
2932 ``comparison`` command, taking the same values.
2932 ``comparison`` command, taking the same values.
2933
2933
2934 ``contact``
2934 ``contact``
2935 Name or email address of the person in charge of the repository.
2935 Name or email address of the person in charge of the repository.
2936 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2936 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2937
2937
2938 ``csp``
2938 ``csp``
2939 Send a ``Content-Security-Policy`` HTTP header with this value.
2939 Send a ``Content-Security-Policy`` HTTP header with this value.
2940
2940
2941 The value may contain a special string ``%nonce%``, which will be replaced
2941 The value may contain a special string ``%nonce%``, which will be replaced
2942 by a randomly-generated one-time use value. If the value contains
2942 by a randomly-generated one-time use value. If the value contains
2943 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2943 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2944 one-time property of the nonce. This nonce will also be inserted into
2944 one-time property of the nonce. This nonce will also be inserted into
2945 ``<script>`` elements containing inline JavaScript.
2945 ``<script>`` elements containing inline JavaScript.
2946
2946
2947 Note: lots of HTML content sent by the server is derived from repository
2947 Note: lots of HTML content sent by the server is derived from repository
2948 data. Please consider the potential for malicious repository data to
2948 data. Please consider the potential for malicious repository data to
2949 "inject" itself into generated HTML content as part of your security
2949 "inject" itself into generated HTML content as part of your security
2950 threat model.
2950 threat model.
2951
2951
2952 ``deny_push``
2952 ``deny_push``
2953 Whether to deny pushing to the repository. If empty or not set,
2953 Whether to deny pushing to the repository. If empty or not set,
2954 push is not denied. If the special value ``*``, all remote users are
2954 push is not denied. If the special value ``*``, all remote users are
2955 denied push. Otherwise, unauthenticated users are all denied, and
2955 denied push. Otherwise, unauthenticated users are all denied, and
2956 any authenticated user name present in this list is also denied. The
2956 any authenticated user name present in this list is also denied. The
2957 contents of the deny_push list are examined before the allow-push list.
2957 contents of the deny_push list are examined before the allow-push list.
2958
2958
2959 ``deny_read``
2959 ``deny_read``
2960 Whether to deny reading/viewing of the repository. If this list is
2960 Whether to deny reading/viewing of the repository. If this list is
2961 not empty, unauthenticated users are all denied, and any
2961 not empty, unauthenticated users are all denied, and any
2962 authenticated user name present in this list is also denied access to
2962 authenticated user name present in this list is also denied access to
2963 the repository. If set to the special value ``*``, all remote users
2963 the repository. If set to the special value ``*``, all remote users
2964 are denied access (rarely needed ;). If deny_read is empty or not set,
2964 are denied access (rarely needed ;). If deny_read is empty or not set,
2965 the determination of repository access depends on the presence and
2965 the determination of repository access depends on the presence and
2966 content of the allow_read list (see description). If both
2966 content of the allow_read list (see description). If both
2967 deny_read and allow_read are empty or not set, then access is
2967 deny_read and allow_read are empty or not set, then access is
2968 permitted to all users by default. If the repository is being
2968 permitted to all users by default. If the repository is being
2969 served via hgwebdir, denied users will not be able to see it in
2969 served via hgwebdir, denied users will not be able to see it in
2970 the list of repositories. The contents of the deny_read list have
2970 the list of repositories. The contents of the deny_read list have
2971 priority over (are examined before) the contents of the allow_read
2971 priority over (are examined before) the contents of the allow_read
2972 list.
2972 list.
2973
2973
2974 ``descend``
2974 ``descend``
2975 hgwebdir indexes will not descend into subdirectories. Only repositories
2975 hgwebdir indexes will not descend into subdirectories. Only repositories
2976 directly in the current path will be shown (other repositories are still
2976 directly in the current path will be shown (other repositories are still
2977 available from the index corresponding to their containing path).
2977 available from the index corresponding to their containing path).
2978
2978
2979 ``description``
2979 ``description``
2980 Textual description of the repository's purpose or contents.
2980 Textual description of the repository's purpose or contents.
2981 (default: "unknown")
2981 (default: "unknown")
2982
2982
2983 ``encoding``
2983 ``encoding``
2984 Character encoding name. (default: the current locale charset)
2984 Character encoding name. (default: the current locale charset)
2985 Example: "UTF-8".
2985 Example: "UTF-8".
2986
2986
2987 ``errorlog``
2987 ``errorlog``
2988 Where to output the error log. (default: stderr)
2988 Where to output the error log. (default: stderr)
2989
2989
2990 ``guessmime``
2990 ``guessmime``
2991 Control MIME types for raw download of file content.
2991 Control MIME types for raw download of file content.
2992 Set to True to let hgweb guess the content type from the file
2992 Set to True to let hgweb guess the content type from the file
2993 extension. This will serve HTML files as ``text/html`` and might
2993 extension. This will serve HTML files as ``text/html`` and might
2994 allow cross-site scripting attacks when serving untrusted
2994 allow cross-site scripting attacks when serving untrusted
2995 repositories. (default: False)
2995 repositories. (default: False)
2996
2996
2997 ``hidden``
2997 ``hidden``
2998 Whether to hide the repository in the hgwebdir index.
2998 Whether to hide the repository in the hgwebdir index.
2999 (default: False)
2999 (default: False)
3000
3000
3001 ``ipv6``
3001 ``ipv6``
3002 Whether to use IPv6. (default: False)
3002 Whether to use IPv6. (default: False)
3003
3003
3004 ``labels``
3004 ``labels``
3005 List of string *labels* associated with the repository.
3005 List of string *labels* associated with the repository.
3006
3006
3007 Labels are exposed as a template keyword and can be used to customize
3007 Labels are exposed as a template keyword and can be used to customize
3008 output. e.g. the ``index`` template can group or filter repositories
3008 output. e.g. the ``index`` template can group or filter repositories
3009 by labels and the ``summary`` template can display additional content
3009 by labels and the ``summary`` template can display additional content
3010 if a specific label is present.
3010 if a specific label is present.
3011
3011
3012 ``logoimg``
3012 ``logoimg``
3013 File name of the logo image that some templates display on each page.
3013 File name of the logo image that some templates display on each page.
3014 The file name is relative to ``staticurl``. That is, the full path to
3014 The file name is relative to ``staticurl``. That is, the full path to
3015 the logo image is "staticurl/logoimg".
3015 the logo image is "staticurl/logoimg".
3016 If unset, ``hglogo.png`` will be used.
3016 If unset, ``hglogo.png`` will be used.
3017
3017
3018 ``logourl``
3018 ``logourl``
3019 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
3019 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
3020 will be used.
3020 will be used.
3021
3021
3022 ``maxchanges``
3022 ``maxchanges``
3023 Maximum number of changes to list on the changelog. (default: 10)
3023 Maximum number of changes to list on the changelog. (default: 10)
3024
3024
3025 ``maxfiles``
3025 ``maxfiles``
3026 Maximum number of files to list per changeset. (default: 10)
3026 Maximum number of files to list per changeset. (default: 10)
3027
3027
3028 ``maxshortchanges``
3028 ``maxshortchanges``
3029 Maximum number of changes to list on the shortlog, graph or filelog
3029 Maximum number of changes to list on the shortlog, graph or filelog
3030 pages. (default: 60)
3030 pages. (default: 60)
3031
3031
3032 ``name``
3032 ``name``
3033 Repository name to use in the web interface.
3033 Repository name to use in the web interface.
3034 (default: current working directory)
3034 (default: current working directory)
3035
3035
3036 ``port``
3036 ``port``
3037 Port to listen on. (default: 8000)
3037 Port to listen on. (default: 8000)
3038
3038
3039 ``prefix``
3039 ``prefix``
3040 Prefix path to serve from. (default: '' (server root))
3040 Prefix path to serve from. (default: '' (server root))
3041
3041
3042 ``push_ssl``
3042 ``push_ssl``
3043 Whether to require that inbound pushes be transported over SSL to
3043 Whether to require that inbound pushes be transported over SSL to
3044 prevent password sniffing. (default: True)
3044 prevent password sniffing. (default: True)
3045
3045
3046 ``refreshinterval``
3046 ``refreshinterval``
3047 How frequently directory listings re-scan the filesystem for new
3047 How frequently directory listings re-scan the filesystem for new
3048 repositories, in seconds. This is relevant when wildcards are used
3048 repositories, in seconds. This is relevant when wildcards are used
3049 to define paths. Depending on how much filesystem traversal is
3049 to define paths. Depending on how much filesystem traversal is
3050 required, refreshing may negatively impact performance.
3050 required, refreshing may negatively impact performance.
3051
3051
3052 Values less than or equal to 0 always refresh.
3052 Values less than or equal to 0 always refresh.
3053 (default: 20)
3053 (default: 20)
3054
3054
3055 ``server-header``
3055 ``server-header``
3056 Value for HTTP ``Server`` response header.
3056 Value for HTTP ``Server`` response header.
3057
3057
3058 ``static``
3058 ``static``
3059 Directory where static files are served from.
3059 Directory where static files are served from.
3060
3060
3061 ``staticurl``
3061 ``staticurl``
3062 Base URL to use for static files. If unset, static files (e.g. the
3062 Base URL to use for static files. If unset, static files (e.g. the
3063 hgicon.png favicon) will be served by the CGI script itself. Use
3063 hgicon.png favicon) will be served by the CGI script itself. Use
3064 this setting to serve them directly with the HTTP server.
3064 this setting to serve them directly with the HTTP server.
3065 Example: ``http://hgserver/static/``.
3065 Example: ``http://hgserver/static/``.
3066
3066
3067 ``stripes``
3067 ``stripes``
3068 How many lines a "zebra stripe" should span in multi-line output.
3068 How many lines a "zebra stripe" should span in multi-line output.
3069 Set to 0 to disable. (default: 1)
3069 Set to 0 to disable. (default: 1)
3070
3070
3071 ``style``
3071 ``style``
3072 Which template map style to use. The available options are the names of
3072 Which template map style to use. The available options are the names of
3073 subdirectories in the HTML templates path. (default: ``paper``)
3073 subdirectories in the HTML templates path. (default: ``paper``)
3074 Example: ``monoblue``.
3074 Example: ``monoblue``.
3075
3075
3076 ``templates``
3076 ``templates``
3077 Where to find the HTML templates. The default path to the HTML templates
3077 Where to find the HTML templates. The default path to the HTML templates
3078 can be obtained from ``hg debuginstall``.
3078 can be obtained from ``hg debuginstall``.
3079
3079
3080 ``websub``
3080 ``websub``
3081 ----------
3081 ----------
3082
3082
3083 Web substitution filter definition. You can use this section to
3083 Web substitution filter definition. You can use this section to
3084 define a set of regular expression substitution patterns which
3084 define a set of regular expression substitution patterns which
3085 let you automatically modify the hgweb server output.
3085 let you automatically modify the hgweb server output.
3086
3086
3087 The default hgweb templates only apply these substitution patterns
3087 The default hgweb templates only apply these substitution patterns
3088 on the revision description fields. You can apply them anywhere
3088 on the revision description fields. You can apply them anywhere
3089 you want when you create your own templates by adding calls to the
3089 you want when you create your own templates by adding calls to the
3090 "websub" filter (usually after calling the "escape" filter).
3090 "websub" filter (usually after calling the "escape" filter).
3091
3091
3092 This can be used, for example, to convert issue references to links
3092 This can be used, for example, to convert issue references to links
3093 to your issue tracker, or to convert "markdown-like" syntax into
3093 to your issue tracker, or to convert "markdown-like" syntax into
3094 HTML (see the examples below).
3094 HTML (see the examples below).
3095
3095
3096 Each entry in this section names a substitution filter.
3096 Each entry in this section names a substitution filter.
3097 The value of each entry defines the substitution expression itself.
3097 The value of each entry defines the substitution expression itself.
3098 The websub expressions follow the old interhg extension syntax,
3098 The websub expressions follow the old interhg extension syntax,
3099 which in turn imitates the Unix sed replacement syntax::
3099 which in turn imitates the Unix sed replacement syntax::
3100
3100
3101 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
3101 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
3102
3102
3103 You can use any separator other than "/". The final "i" is optional
3103 You can use any separator other than "/". The final "i" is optional
3104 and indicates that the search must be case insensitive.
3104 and indicates that the search must be case insensitive.
3105
3105
3106 Examples::
3106 Examples::
3107
3107
3108 [websub]
3108 [websub]
3109 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
3109 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
3110 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
3110 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
3111 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
3111 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
3112
3112
3113 ``worker``
3113 ``worker``
3114 ----------
3114 ----------
3115
3115
3116 Parallel master/worker configuration. We currently perform working
3116 Parallel master/worker configuration. We currently perform working
3117 directory updates in parallel on Unix-like systems, which greatly
3117 directory updates in parallel on Unix-like systems, which greatly
3118 helps performance.
3118 helps performance.
3119
3119
3120 ``enabled``
3120 ``enabled``
3121 Whether to enable workers code to be used.
3121 Whether to enable workers code to be used.
3122 (default: true)
3122 (default: true)
3123
3123
3124 ``numcpus``
3124 ``numcpus``
3125 Number of CPUs to use for parallel operations. A zero or
3125 Number of CPUs to use for parallel operations. A zero or
3126 negative value is treated as ``use the default``.
3126 negative value is treated as ``use the default``.
3127 (default: 4 or the number of CPUs on the system, whichever is larger)
3127 (default: 4 or the number of CPUs on the system, whichever is larger)
3128
3128
3129 ``backgroundclose``
3129 ``backgroundclose``
3130 Whether to enable closing file handles on background threads during certain
3130 Whether to enable closing file handles on background threads during certain
3131 operations. Some platforms aren't very efficient at closing file
3131 operations. Some platforms aren't very efficient at closing file
3132 handles that have been written or appended to. By performing file closing
3132 handles that have been written or appended to. By performing file closing
3133 on background threads, file write rate can increase substantially.
3133 on background threads, file write rate can increase substantially.
3134 (default: true on Windows, false elsewhere)
3134 (default: true on Windows, false elsewhere)
3135
3135
3136 ``backgroundcloseminfilecount``
3136 ``backgroundcloseminfilecount``
3137 Minimum number of files required to trigger background file closing.
3137 Minimum number of files required to trigger background file closing.
3138 Operations not writing this many files won't start background close
3138 Operations not writing this many files won't start background close
3139 threads.
3139 threads.
3140 (default: 2048)
3140 (default: 2048)
3141
3141
3142 ``backgroundclosemaxqueue``
3142 ``backgroundclosemaxqueue``
3143 The maximum number of opened file handles waiting to be closed in the
3143 The maximum number of opened file handles waiting to be closed in the
3144 background. This option only has an effect if ``backgroundclose`` is
3144 background. This option only has an effect if ``backgroundclose`` is
3145 enabled.
3145 enabled.
3146 (default: 384)
3146 (default: 384)
3147
3147
3148 ``backgroundclosethreadcount``
3148 ``backgroundclosethreadcount``
3149 Number of threads to process background file closes. Only relevant if
3149 Number of threads to process background file closes. Only relevant if
3150 ``backgroundclose`` is enabled.
3150 ``backgroundclose`` is enabled.
3151 (default: 4)
3151 (default: 4)
General Comments 0
You need to be logged in to leave comments. Login now