##// END OF EJS Templates
help: cleanup grammar in the hooks section
Matt Harbison -
r33250:26c49ed5 4.2.2 stable
parent child Browse files
Show More
@@ -1,2410 +1,2411 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 --debug` can help you understand what is introducing
8 :hg:`config --debug` 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`` (per-repository)
57 - ``<repo>/.hg/hgrc`` (per-repository)
58 - ``$HOME/.hgrc`` (per-user)
58 - ``$HOME/.hgrc`` (per-user)
59 - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
59 - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
60 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
60 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
61 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
61 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
62 - ``/etc/mercurial/hgrc`` (per-system)
62 - ``/etc/mercurial/hgrc`` (per-system)
63 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
63 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
64 - ``<internal>/default.d/*.rc`` (defaults)
64 - ``<internal>/default.d/*.rc`` (defaults)
65
65
66 .. container:: verbose.windows
66 .. container:: verbose.windows
67
67
68 On Windows, the following files are consulted:
68 On Windows, the following files are consulted:
69
69
70 - ``<repo>/.hg/hgrc`` (per-repository)
70 - ``<repo>/.hg/hgrc`` (per-repository)
71 - ``%USERPROFILE%\.hgrc`` (per-user)
71 - ``%USERPROFILE%\.hgrc`` (per-user)
72 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
72 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
73 - ``%HOME%\.hgrc`` (per-user)
73 - ``%HOME%\.hgrc`` (per-user)
74 - ``%HOME%\Mercurial.ini`` (per-user)
74 - ``%HOME%\Mercurial.ini`` (per-user)
75 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
75 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
76 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
76 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
77 - ``<install-dir>\Mercurial.ini`` (per-installation)
77 - ``<install-dir>\Mercurial.ini`` (per-installation)
78 - ``<internal>/default.d/*.rc`` (defaults)
78 - ``<internal>/default.d/*.rc`` (defaults)
79
79
80 .. note::
80 .. note::
81
81
82 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
82 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
83 is used when running 32-bit Python on 64-bit Windows.
83 is used when running 32-bit Python on 64-bit Windows.
84
84
85 .. container:: windows
85 .. container:: windows
86
86
87 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
87 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
88
88
89 .. container:: verbose.plan9
89 .. container:: verbose.plan9
90
90
91 On Plan9, the following files are consulted:
91 On Plan9, the following files are consulted:
92
92
93 - ``<repo>/.hg/hgrc`` (per-repository)
93 - ``<repo>/.hg/hgrc`` (per-repository)
94 - ``$home/lib/hgrc`` (per-user)
94 - ``$home/lib/hgrc`` (per-user)
95 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
95 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
96 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
96 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
97 - ``/lib/mercurial/hgrc`` (per-system)
97 - ``/lib/mercurial/hgrc`` (per-system)
98 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
98 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
99 - ``<internal>/default.d/*.rc`` (defaults)
99 - ``<internal>/default.d/*.rc`` (defaults)
100
100
101 Per-repository configuration options only apply in a
101 Per-repository configuration options only apply in a
102 particular repository. This file is not version-controlled, and
102 particular repository. This file is not version-controlled, and
103 will not get transferred during a "clone" operation. Options in
103 will not get transferred during a "clone" operation. Options in
104 this file override options in all other configuration files.
104 this file override options in all other configuration files.
105
105
106 .. container:: unix.plan9
106 .. container:: unix.plan9
107
107
108 On Plan 9 and Unix, most of this file will be ignored if it doesn't
108 On Plan 9 and Unix, most of this file will be ignored if it doesn't
109 belong to a trusted user or to a trusted group. See
109 belong to a trusted user or to a trusted group. See
110 :hg:`help config.trusted` for more details.
110 :hg:`help config.trusted` for more details.
111
111
112 Per-user configuration file(s) are for the user running Mercurial. Options
112 Per-user configuration file(s) are for the user running Mercurial. Options
113 in these files apply to all Mercurial commands executed by this user in any
113 in these files apply to all Mercurial commands executed by this user in any
114 directory. Options in these files override per-system and per-installation
114 directory. Options in these files override per-system and per-installation
115 options.
115 options.
116
116
117 Per-installation configuration files are searched for in the
117 Per-installation configuration files are searched for in the
118 directory where Mercurial is installed. ``<install-root>`` is the
118 directory where Mercurial is installed. ``<install-root>`` is the
119 parent directory of the **hg** executable (or symlink) being run.
119 parent directory of the **hg** executable (or symlink) being run.
120
120
121 .. container:: unix.plan9
121 .. container:: unix.plan9
122
122
123 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
123 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
124 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
124 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
125 files apply to all Mercurial commands executed by any user in any
125 files apply to all Mercurial commands executed by any user in any
126 directory.
126 directory.
127
127
128 Per-installation configuration files are for the system on
128 Per-installation configuration files are for the system on
129 which Mercurial is running. Options in these files apply to all
129 which Mercurial is running. Options in these files apply to all
130 Mercurial commands executed by any user in any directory. Registry
130 Mercurial commands executed by any user in any directory. Registry
131 keys contain PATH-like strings, every part of which must reference
131 keys contain PATH-like strings, every part of which must reference
132 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
132 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
133 be read. Mercurial checks each of these locations in the specified
133 be read. Mercurial checks each of these locations in the specified
134 order until one or more configuration files are detected.
134 order until one or more configuration files are detected.
135
135
136 Per-system configuration files are for the system on which Mercurial
136 Per-system configuration files are for the system on which Mercurial
137 is running. Options in these files apply to all Mercurial commands
137 is running. Options in these files apply to all Mercurial commands
138 executed by any user in any directory. Options in these files
138 executed by any user in any directory. Options in these files
139 override per-installation options.
139 override per-installation options.
140
140
141 Mercurial comes with some default configuration. The default configuration
141 Mercurial comes with some default configuration. The default configuration
142 files are installed with Mercurial and will be overwritten on upgrades. Default
142 files are installed with Mercurial and will be overwritten on upgrades. Default
143 configuration files should never be edited by users or administrators but can
143 configuration files should never be edited by users or administrators but can
144 be overridden in other configuration files. So far the directory only contains
144 be overridden in other configuration files. So far the directory only contains
145 merge tool configuration but packagers can also put other default configuration
145 merge tool configuration but packagers can also put other default configuration
146 there.
146 there.
147
147
148 Syntax
148 Syntax
149 ======
149 ======
150
150
151 A configuration file consists of sections, led by a ``[section]`` header
151 A configuration file consists of sections, led by a ``[section]`` header
152 and followed by ``name = value`` entries (sometimes called
152 and followed by ``name = value`` entries (sometimes called
153 ``configuration keys``)::
153 ``configuration keys``)::
154
154
155 [spam]
155 [spam]
156 eggs=ham
156 eggs=ham
157 green=
157 green=
158 eggs
158 eggs
159
159
160 Each line contains one entry. If the lines that follow are indented,
160 Each line contains one entry. If the lines that follow are indented,
161 they are treated as continuations of that entry. Leading whitespace is
161 they are treated as continuations of that entry. Leading whitespace is
162 removed from values. Empty lines are skipped. Lines beginning with
162 removed from values. Empty lines are skipped. Lines beginning with
163 ``#`` or ``;`` are ignored and may be used to provide comments.
163 ``#`` or ``;`` are ignored and may be used to provide comments.
164
164
165 Configuration keys can be set multiple times, in which case Mercurial
165 Configuration keys can be set multiple times, in which case Mercurial
166 will use the value that was configured last. As an example::
166 will use the value that was configured last. As an example::
167
167
168 [spam]
168 [spam]
169 eggs=large
169 eggs=large
170 ham=serrano
170 ham=serrano
171 eggs=small
171 eggs=small
172
172
173 This would set the configuration key named ``eggs`` to ``small``.
173 This would set the configuration key named ``eggs`` to ``small``.
174
174
175 It is also possible to define a section multiple times. A section can
175 It is also possible to define a section multiple times. A section can
176 be redefined on the same and/or on different configuration files. For
176 be redefined on the same and/or on different configuration files. For
177 example::
177 example::
178
178
179 [foo]
179 [foo]
180 eggs=large
180 eggs=large
181 ham=serrano
181 ham=serrano
182 eggs=small
182 eggs=small
183
183
184 [bar]
184 [bar]
185 eggs=ham
185 eggs=ham
186 green=
186 green=
187 eggs
187 eggs
188
188
189 [foo]
189 [foo]
190 ham=prosciutto
190 ham=prosciutto
191 eggs=medium
191 eggs=medium
192 bread=toasted
192 bread=toasted
193
193
194 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
194 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
195 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
195 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
196 respectively. As you can see there only thing that matters is the last
196 respectively. As you can see there only thing that matters is the last
197 value that was set for each of the configuration keys.
197 value that was set for each of the configuration keys.
198
198
199 If a configuration key is set multiple times in different
199 If a configuration key is set multiple times in different
200 configuration files the final value will depend on the order in which
200 configuration files the final value will depend on the order in which
201 the different configuration files are read, with settings from earlier
201 the different configuration files are read, with settings from earlier
202 paths overriding later ones as described on the ``Files`` section
202 paths overriding later ones as described on the ``Files`` section
203 above.
203 above.
204
204
205 A line of the form ``%include file`` will include ``file`` into the
205 A line of the form ``%include file`` will include ``file`` into the
206 current configuration file. The inclusion is recursive, which means
206 current configuration file. The inclusion is recursive, which means
207 that included files can include other files. Filenames are relative to
207 that included files can include other files. Filenames are relative to
208 the configuration file in which the ``%include`` directive is found.
208 the configuration file in which the ``%include`` directive is found.
209 Environment variables and ``~user`` constructs are expanded in
209 Environment variables and ``~user`` constructs are expanded in
210 ``file``. This lets you do something like::
210 ``file``. This lets you do something like::
211
211
212 %include ~/.hgrc.d/$HOST.rc
212 %include ~/.hgrc.d/$HOST.rc
213
213
214 to include a different configuration file on each computer you use.
214 to include a different configuration file on each computer you use.
215
215
216 A line with ``%unset name`` will remove ``name`` from the current
216 A line with ``%unset name`` will remove ``name`` from the current
217 section, if it has been set previously.
217 section, if it has been set previously.
218
218
219 The values are either free-form text strings, lists of text strings,
219 The values are either free-form text strings, lists of text strings,
220 or Boolean values. Boolean values can be set to true using any of "1",
220 or Boolean values. Boolean values can be set to true using any of "1",
221 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
221 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
222 (all case insensitive).
222 (all case insensitive).
223
223
224 List values are separated by whitespace or comma, except when values are
224 List values are separated by whitespace or comma, except when values are
225 placed in double quotation marks::
225 placed in double quotation marks::
226
226
227 allow_read = "John Doe, PhD", brian, betty
227 allow_read = "John Doe, PhD", brian, betty
228
228
229 Quotation marks can be escaped by prefixing them with a backslash. Only
229 Quotation marks can be escaped by prefixing them with a backslash. Only
230 quotation marks at the beginning of a word is counted as a quotation
230 quotation marks at the beginning of a word is counted as a quotation
231 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
231 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
232
232
233 Sections
233 Sections
234 ========
234 ========
235
235
236 This section describes the different sections that may appear in a
236 This section describes the different sections that may appear in a
237 Mercurial configuration file, the purpose of each section, its possible
237 Mercurial configuration file, the purpose of each section, its possible
238 keys, and their possible values.
238 keys, and their possible values.
239
239
240 ``alias``
240 ``alias``
241 ---------
241 ---------
242
242
243 Defines command aliases.
243 Defines command aliases.
244
244
245 Aliases allow you to define your own commands in terms of other
245 Aliases allow you to define your own commands in terms of other
246 commands (or aliases), optionally including arguments. Positional
246 commands (or aliases), optionally including arguments. Positional
247 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
247 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
248 are expanded by Mercurial before execution. Positional arguments not
248 are expanded by Mercurial before execution. Positional arguments not
249 already used by ``$N`` in the definition are put at the end of the
249 already used by ``$N`` in the definition are put at the end of the
250 command to be executed.
250 command to be executed.
251
251
252 Alias definitions consist of lines of the form::
252 Alias definitions consist of lines of the form::
253
253
254 <alias> = <command> [<argument>]...
254 <alias> = <command> [<argument>]...
255
255
256 For example, this definition::
256 For example, this definition::
257
257
258 latest = log --limit 5
258 latest = log --limit 5
259
259
260 creates a new command ``latest`` that shows only the five most recent
260 creates a new command ``latest`` that shows only the five most recent
261 changesets. You can define subsequent aliases using earlier ones::
261 changesets. You can define subsequent aliases using earlier ones::
262
262
263 stable5 = latest -b stable
263 stable5 = latest -b stable
264
264
265 .. note::
265 .. note::
266
266
267 It is possible to create aliases with the same names as
267 It is possible to create aliases with the same names as
268 existing commands, which will then override the original
268 existing commands, which will then override the original
269 definitions. This is almost always a bad idea!
269 definitions. This is almost always a bad idea!
270
270
271 An alias can start with an exclamation point (``!``) to make it a
271 An alias can start with an exclamation point (``!``) to make it a
272 shell alias. A shell alias is executed with the shell and will let you
272 shell alias. A shell alias is executed with the shell and will let you
273 run arbitrary commands. As an example, ::
273 run arbitrary commands. As an example, ::
274
274
275 echo = !echo $@
275 echo = !echo $@
276
276
277 will let you do ``hg echo foo`` to have ``foo`` printed in your
277 will let you do ``hg echo foo`` to have ``foo`` printed in your
278 terminal. A better example might be::
278 terminal. A better example might be::
279
279
280 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
280 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
281
281
282 which will make ``hg purge`` delete all unknown files in the
282 which will make ``hg purge`` delete all unknown files in the
283 repository in the same manner as the purge extension.
283 repository in the same manner as the purge extension.
284
284
285 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
285 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
286 expand to the command arguments. Unmatched arguments are
286 expand to the command arguments. Unmatched arguments are
287 removed. ``$0`` expands to the alias name and ``$@`` expands to all
287 removed. ``$0`` expands to the alias name and ``$@`` expands to all
288 arguments separated by a space. ``"$@"`` (with quotes) expands to all
288 arguments separated by a space. ``"$@"`` (with quotes) expands to all
289 arguments quoted individually and separated by a space. These expansions
289 arguments quoted individually and separated by a space. These expansions
290 happen before the command is passed to the shell.
290 happen before the command is passed to the shell.
291
291
292 Shell aliases are executed in an environment where ``$HG`` expands to
292 Shell aliases are executed in an environment where ``$HG`` expands to
293 the path of the Mercurial that was used to execute the alias. This is
293 the path of the Mercurial that was used to execute the alias. This is
294 useful when you want to call further Mercurial commands in a shell
294 useful when you want to call further Mercurial commands in a shell
295 alias, as was done above for the purge alias. In addition,
295 alias, as was done above for the purge alias. In addition,
296 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
296 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
297 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
297 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
298
298
299 .. note::
299 .. note::
300
300
301 Some global configuration options such as ``-R`` are
301 Some global configuration options such as ``-R`` are
302 processed before shell aliases and will thus not be passed to
302 processed before shell aliases and will thus not be passed to
303 aliases.
303 aliases.
304
304
305
305
306 ``annotate``
306 ``annotate``
307 ------------
307 ------------
308
308
309 Settings used when displaying file annotations. All values are
309 Settings used when displaying file annotations. All values are
310 Booleans and default to False. See :hg:`help config.diff` for
310 Booleans and default to False. See :hg:`help config.diff` for
311 related options for the diff command.
311 related options for the diff command.
312
312
313 ``ignorews``
313 ``ignorews``
314 Ignore white space when comparing lines.
314 Ignore white space when comparing lines.
315
315
316 ``ignorewsamount``
316 ``ignorewsamount``
317 Ignore changes in the amount of white space.
317 Ignore changes in the amount of white space.
318
318
319 ``ignoreblanklines``
319 ``ignoreblanklines``
320 Ignore changes whose lines are all blank.
320 Ignore changes whose lines are all blank.
321
321
322
322
323 ``auth``
323 ``auth``
324 --------
324 --------
325
325
326 Authentication credentials and other authentication-like configuration
326 Authentication credentials and other authentication-like configuration
327 for HTTP connections. This section allows you to store usernames and
327 for HTTP connections. This section allows you to store usernames and
328 passwords for use when logging *into* HTTP servers. See
328 passwords for use when logging *into* HTTP servers. See
329 :hg:`help config.web` if you want to configure *who* can login to
329 :hg:`help config.web` if you want to configure *who* can login to
330 your HTTP server.
330 your HTTP server.
331
331
332 The following options apply to all hosts.
332 The following options apply to all hosts.
333
333
334 ``cookiefile``
334 ``cookiefile``
335 Path to a file containing HTTP cookie lines. Cookies matching a
335 Path to a file containing HTTP cookie lines. Cookies matching a
336 host will be sent automatically.
336 host will be sent automatically.
337
337
338 The file format uses the Mozilla cookies.txt format, which defines cookies
338 The file format uses the Mozilla cookies.txt format, which defines cookies
339 on their own lines. Each line contains 7 fields delimited by the tab
339 on their own lines. Each line contains 7 fields delimited by the tab
340 character (domain, is_domain_cookie, path, is_secure, expires, name,
340 character (domain, is_domain_cookie, path, is_secure, expires, name,
341 value). For more info, do an Internet search for "Netscape cookies.txt
341 value). For more info, do an Internet search for "Netscape cookies.txt
342 format."
342 format."
343
343
344 Note: the cookies parser does not handle port numbers on domains. You
344 Note: the cookies parser does not handle port numbers on domains. You
345 will need to remove ports from the domain for the cookie to be recognized.
345 will need to remove ports from the domain for the cookie to be recognized.
346 This could result in a cookie being disclosed to an unwanted server.
346 This could result in a cookie being disclosed to an unwanted server.
347
347
348 The cookies file is read-only.
348 The cookies file is read-only.
349
349
350 Other options in this section are grouped by name and have the following
350 Other options in this section are grouped by name and have the following
351 format::
351 format::
352
352
353 <name>.<argument> = <value>
353 <name>.<argument> = <value>
354
354
355 where ``<name>`` is used to group arguments into authentication
355 where ``<name>`` is used to group arguments into authentication
356 entries. Example::
356 entries. Example::
357
357
358 foo.prefix = hg.intevation.de/mercurial
358 foo.prefix = hg.intevation.de/mercurial
359 foo.username = foo
359 foo.username = foo
360 foo.password = bar
360 foo.password = bar
361 foo.schemes = http https
361 foo.schemes = http https
362
362
363 bar.prefix = secure.example.org
363 bar.prefix = secure.example.org
364 bar.key = path/to/file.key
364 bar.key = path/to/file.key
365 bar.cert = path/to/file.cert
365 bar.cert = path/to/file.cert
366 bar.schemes = https
366 bar.schemes = https
367
367
368 Supported arguments:
368 Supported arguments:
369
369
370 ``prefix``
370 ``prefix``
371 Either ``*`` or a URI prefix with or without the scheme part.
371 Either ``*`` or a URI prefix with or without the scheme part.
372 The authentication entry with the longest matching prefix is used
372 The authentication entry with the longest matching prefix is used
373 (where ``*`` matches everything and counts as a match of length
373 (where ``*`` matches everything and counts as a match of length
374 1). If the prefix doesn't include a scheme, the match is performed
374 1). If the prefix doesn't include a scheme, the match is performed
375 against the URI with its scheme stripped as well, and the schemes
375 against the URI with its scheme stripped as well, and the schemes
376 argument, q.v., is then subsequently consulted.
376 argument, q.v., is then subsequently consulted.
377
377
378 ``username``
378 ``username``
379 Optional. Username to authenticate with. If not given, and the
379 Optional. Username to authenticate with. If not given, and the
380 remote site requires basic or digest authentication, the user will
380 remote site requires basic or digest authentication, the user will
381 be prompted for it. Environment variables are expanded in the
381 be prompted for it. Environment variables are expanded in the
382 username letting you do ``foo.username = $USER``. If the URI
382 username letting you do ``foo.username = $USER``. If the URI
383 includes a username, only ``[auth]`` entries with a matching
383 includes a username, only ``[auth]`` entries with a matching
384 username or without a username will be considered.
384 username or without a username will be considered.
385
385
386 ``password``
386 ``password``
387 Optional. Password to authenticate with. If not given, and the
387 Optional. Password to authenticate with. If not given, and the
388 remote site requires basic or digest authentication, the user
388 remote site requires basic or digest authentication, the user
389 will be prompted for it.
389 will be prompted for it.
390
390
391 ``key``
391 ``key``
392 Optional. PEM encoded client certificate key file. Environment
392 Optional. PEM encoded client certificate key file. Environment
393 variables are expanded in the filename.
393 variables are expanded in the filename.
394
394
395 ``cert``
395 ``cert``
396 Optional. PEM encoded client certificate chain file. Environment
396 Optional. PEM encoded client certificate chain file. Environment
397 variables are expanded in the filename.
397 variables are expanded in the filename.
398
398
399 ``schemes``
399 ``schemes``
400 Optional. Space separated list of URI schemes to use this
400 Optional. Space separated list of URI schemes to use this
401 authentication entry with. Only used if the prefix doesn't include
401 authentication entry with. Only used if the prefix doesn't include
402 a scheme. Supported schemes are http and https. They will match
402 a scheme. Supported schemes are http and https. They will match
403 static-http and static-https respectively, as well.
403 static-http and static-https respectively, as well.
404 (default: https)
404 (default: https)
405
405
406 If no suitable authentication entry is found, the user is prompted
406 If no suitable authentication entry is found, the user is prompted
407 for credentials as usual if required by the remote.
407 for credentials as usual if required by the remote.
408
408
409 ``color``
409 ``color``
410 ---------
410 ---------
411
411
412 Configure the Mercurial color mode. For details about how to define your custom
412 Configure the Mercurial color mode. For details about how to define your custom
413 effect and style see :hg:`help color`.
413 effect and style see :hg:`help color`.
414
414
415 ``mode``
415 ``mode``
416 String: control the method used to output color. One of ``auto``, ``ansi``,
416 String: control the method used to output color. One of ``auto``, ``ansi``,
417 ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
417 ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
418 use ANSI mode by default (or win32 mode on Windows) if it detects a
418 use ANSI mode by default (or win32 mode on Windows) if it detects a
419 terminal. Any invalid value will disable color.
419 terminal. Any invalid value will disable color.
420
420
421 ``pagermode``
421 ``pagermode``
422 String: optional override of ``color.mode`` used with pager.
422 String: optional override of ``color.mode`` used with pager.
423
423
424 On some systems, terminfo mode may cause problems when using
424 On some systems, terminfo mode may cause problems when using
425 color with ``less -R`` as a pager program. less with the -R option
425 color with ``less -R`` as a pager program. less with the -R option
426 will only display ECMA-48 color codes, and terminfo mode may sometimes
426 will only display ECMA-48 color codes, and terminfo mode may sometimes
427 emit codes that less doesn't understand. You can work around this by
427 emit codes that less doesn't understand. You can work around this by
428 either using ansi mode (or auto mode), or by using less -r (which will
428 either using ansi mode (or auto mode), or by using less -r (which will
429 pass through all terminal control codes, not just color control
429 pass through all terminal control codes, not just color control
430 codes).
430 codes).
431
431
432 On some systems (such as MSYS in Windows), the terminal may support
432 On some systems (such as MSYS in Windows), the terminal may support
433 a different color mode than the pager program.
433 a different color mode than the pager program.
434
434
435 ``commands``
435 ``commands``
436 ------------
436 ------------
437
437
438 ``status.relative``
438 ``status.relative``
439 Make paths in :hg:`status` output relative to the current directory.
439 Make paths in :hg:`status` output relative to the current directory.
440 (default: False)
440 (default: False)
441
441
442 ``update.requiredest``
442 ``update.requiredest``
443 Require that the user pass a destination when running :hg:`update`.
443 Require that the user pass a destination when running :hg:`update`.
444 For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
444 For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
445 will be disallowed.
445 will be disallowed.
446 (default: False)
446 (default: False)
447
447
448 ``committemplate``
448 ``committemplate``
449 ------------------
449 ------------------
450
450
451 ``changeset``
451 ``changeset``
452 String: configuration in this section is used as the template to
452 String: configuration in this section is used as the template to
453 customize the text shown in the editor when committing.
453 customize the text shown in the editor when committing.
454
454
455 In addition to pre-defined template keywords, commit log specific one
455 In addition to pre-defined template keywords, commit log specific one
456 below can be used for customization:
456 below can be used for customization:
457
457
458 ``extramsg``
458 ``extramsg``
459 String: Extra message (typically 'Leave message empty to abort
459 String: Extra message (typically 'Leave message empty to abort
460 commit.'). This may be changed by some commands or extensions.
460 commit.'). This may be changed by some commands or extensions.
461
461
462 For example, the template configuration below shows as same text as
462 For example, the template configuration below shows as same text as
463 one shown by default::
463 one shown by default::
464
464
465 [committemplate]
465 [committemplate]
466 changeset = {desc}\n\n
466 changeset = {desc}\n\n
467 HG: Enter commit message. Lines beginning with 'HG:' are removed.
467 HG: Enter commit message. Lines beginning with 'HG:' are removed.
468 HG: {extramsg}
468 HG: {extramsg}
469 HG: --
469 HG: --
470 HG: user: {author}\n{ifeq(p2rev, "-1", "",
470 HG: user: {author}\n{ifeq(p2rev, "-1", "",
471 "HG: branch merge\n")
471 "HG: branch merge\n")
472 }HG: branch '{branch}'\n{if(activebookmark,
472 }HG: branch '{branch}'\n{if(activebookmark,
473 "HG: bookmark '{activebookmark}'\n") }{subrepos %
473 "HG: bookmark '{activebookmark}'\n") }{subrepos %
474 "HG: subrepo {subrepo}\n" }{file_adds %
474 "HG: subrepo {subrepo}\n" }{file_adds %
475 "HG: added {file}\n" }{file_mods %
475 "HG: added {file}\n" }{file_mods %
476 "HG: changed {file}\n" }{file_dels %
476 "HG: changed {file}\n" }{file_dels %
477 "HG: removed {file}\n" }{if(files, "",
477 "HG: removed {file}\n" }{if(files, "",
478 "HG: no files changed\n")}
478 "HG: no files changed\n")}
479
479
480 ``diff()``
480 ``diff()``
481 String: show the diff (see :hg:`help templates` for detail)
481 String: show the diff (see :hg:`help templates` for detail)
482
482
483 Sometimes it is helpful to show the diff of the changeset in the editor without
483 Sometimes it is helpful to show the diff of the changeset in the editor without
484 having to prefix 'HG: ' to each line so that highlighting works correctly. For
484 having to prefix 'HG: ' to each line so that highlighting works correctly. For
485 this, Mercurial provides a special string which will ignore everything below
485 this, Mercurial provides a special string which will ignore everything below
486 it::
486 it::
487
487
488 HG: ------------------------ >8 ------------------------
488 HG: ------------------------ >8 ------------------------
489
489
490 For example, the template configuration below will show the diff below the
490 For example, the template configuration below will show the diff below the
491 extra message::
491 extra message::
492
492
493 [committemplate]
493 [committemplate]
494 changeset = {desc}\n\n
494 changeset = {desc}\n\n
495 HG: Enter commit message. Lines beginning with 'HG:' are removed.
495 HG: Enter commit message. Lines beginning with 'HG:' are removed.
496 HG: {extramsg}
496 HG: {extramsg}
497 HG: ------------------------ >8 ------------------------
497 HG: ------------------------ >8 ------------------------
498 HG: Do not touch the line above.
498 HG: Do not touch the line above.
499 HG: Everything below will be removed.
499 HG: Everything below will be removed.
500 {diff()}
500 {diff()}
501
501
502 .. note::
502 .. note::
503
503
504 For some problematic encodings (see :hg:`help win32mbcs` for
504 For some problematic encodings (see :hg:`help win32mbcs` for
505 detail), this customization should be configured carefully, to
505 detail), this customization should be configured carefully, to
506 avoid showing broken characters.
506 avoid showing broken characters.
507
507
508 For example, if a multibyte character ending with backslash (0x5c) is
508 For example, if a multibyte character ending with backslash (0x5c) is
509 followed by the ASCII character 'n' in the customized template,
509 followed by the ASCII character 'n' in the customized template,
510 the sequence of backslash and 'n' is treated as line-feed unexpectedly
510 the sequence of backslash and 'n' is treated as line-feed unexpectedly
511 (and the multibyte character is broken, too).
511 (and the multibyte character is broken, too).
512
512
513 Customized template is used for commands below (``--edit`` may be
513 Customized template is used for commands below (``--edit`` may be
514 required):
514 required):
515
515
516 - :hg:`backout`
516 - :hg:`backout`
517 - :hg:`commit`
517 - :hg:`commit`
518 - :hg:`fetch` (for merge commit only)
518 - :hg:`fetch` (for merge commit only)
519 - :hg:`graft`
519 - :hg:`graft`
520 - :hg:`histedit`
520 - :hg:`histedit`
521 - :hg:`import`
521 - :hg:`import`
522 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
522 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
523 - :hg:`rebase`
523 - :hg:`rebase`
524 - :hg:`shelve`
524 - :hg:`shelve`
525 - :hg:`sign`
525 - :hg:`sign`
526 - :hg:`tag`
526 - :hg:`tag`
527 - :hg:`transplant`
527 - :hg:`transplant`
528
528
529 Configuring items below instead of ``changeset`` allows showing
529 Configuring items below instead of ``changeset`` allows showing
530 customized message only for specific actions, or showing different
530 customized message only for specific actions, or showing different
531 messages for each action.
531 messages for each action.
532
532
533 - ``changeset.backout`` for :hg:`backout`
533 - ``changeset.backout`` for :hg:`backout`
534 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
534 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
535 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
535 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
536 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
536 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
537 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
537 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
538 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
538 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
539 - ``changeset.gpg.sign`` for :hg:`sign`
539 - ``changeset.gpg.sign`` for :hg:`sign`
540 - ``changeset.graft`` for :hg:`graft`
540 - ``changeset.graft`` for :hg:`graft`
541 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
541 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
542 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
542 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
543 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
543 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
544 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
544 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
545 - ``changeset.import.bypass`` for :hg:`import --bypass`
545 - ``changeset.import.bypass`` for :hg:`import --bypass`
546 - ``changeset.import.normal.merge`` for :hg:`import` on merges
546 - ``changeset.import.normal.merge`` for :hg:`import` on merges
547 - ``changeset.import.normal.normal`` for :hg:`import` on other
547 - ``changeset.import.normal.normal`` for :hg:`import` on other
548 - ``changeset.mq.qnew`` for :hg:`qnew`
548 - ``changeset.mq.qnew`` for :hg:`qnew`
549 - ``changeset.mq.qfold`` for :hg:`qfold`
549 - ``changeset.mq.qfold`` for :hg:`qfold`
550 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
550 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
551 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
551 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
552 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
552 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
553 - ``changeset.rebase.normal`` for :hg:`rebase` on other
553 - ``changeset.rebase.normal`` for :hg:`rebase` on other
554 - ``changeset.shelve.shelve`` for :hg:`shelve`
554 - ``changeset.shelve.shelve`` for :hg:`shelve`
555 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
555 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
556 - ``changeset.tag.remove`` for :hg:`tag --remove`
556 - ``changeset.tag.remove`` for :hg:`tag --remove`
557 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
557 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
558 - ``changeset.transplant.normal`` for :hg:`transplant` on other
558 - ``changeset.transplant.normal`` for :hg:`transplant` on other
559
559
560 These dot-separated lists of names are treated as hierarchical ones.
560 These dot-separated lists of names are treated as hierarchical ones.
561 For example, ``changeset.tag.remove`` customizes the commit message
561 For example, ``changeset.tag.remove`` customizes the commit message
562 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
562 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
563 commit message for :hg:`tag` regardless of ``--remove`` option.
563 commit message for :hg:`tag` regardless of ``--remove`` option.
564
564
565 When the external editor is invoked for a commit, the corresponding
565 When the external editor is invoked for a commit, the corresponding
566 dot-separated list of names without the ``changeset.`` prefix
566 dot-separated list of names without the ``changeset.`` prefix
567 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
567 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
568 variable.
568 variable.
569
569
570 In this section, items other than ``changeset`` can be referred from
570 In this section, items other than ``changeset`` can be referred from
571 others. For example, the configuration to list committed files up
571 others. For example, the configuration to list committed files up
572 below can be referred as ``{listupfiles}``::
572 below can be referred as ``{listupfiles}``::
573
573
574 [committemplate]
574 [committemplate]
575 listupfiles = {file_adds %
575 listupfiles = {file_adds %
576 "HG: added {file}\n" }{file_mods %
576 "HG: added {file}\n" }{file_mods %
577 "HG: changed {file}\n" }{file_dels %
577 "HG: changed {file}\n" }{file_dels %
578 "HG: removed {file}\n" }{if(files, "",
578 "HG: removed {file}\n" }{if(files, "",
579 "HG: no files changed\n")}
579 "HG: no files changed\n")}
580
580
581 ``decode/encode``
581 ``decode/encode``
582 -----------------
582 -----------------
583
583
584 Filters for transforming files on checkout/checkin. This would
584 Filters for transforming files on checkout/checkin. This would
585 typically be used for newline processing or other
585 typically be used for newline processing or other
586 localization/canonicalization of files.
586 localization/canonicalization of files.
587
587
588 Filters consist of a filter pattern followed by a filter command.
588 Filters consist of a filter pattern followed by a filter command.
589 Filter patterns are globs by default, rooted at the repository root.
589 Filter patterns are globs by default, rooted at the repository root.
590 For example, to match any file ending in ``.txt`` in the root
590 For example, to match any file ending in ``.txt`` in the root
591 directory only, use the pattern ``*.txt``. To match any file ending
591 directory only, use the pattern ``*.txt``. To match any file ending
592 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
592 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
593 For each file only the first matching filter applies.
593 For each file only the first matching filter applies.
594
594
595 The filter command can start with a specifier, either ``pipe:`` or
595 The filter command can start with a specifier, either ``pipe:`` or
596 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
596 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
597
597
598 A ``pipe:`` command must accept data on stdin and return the transformed
598 A ``pipe:`` command must accept data on stdin and return the transformed
599 data on stdout.
599 data on stdout.
600
600
601 Pipe example::
601 Pipe example::
602
602
603 [encode]
603 [encode]
604 # uncompress gzip files on checkin to improve delta compression
604 # uncompress gzip files on checkin to improve delta compression
605 # note: not necessarily a good idea, just an example
605 # note: not necessarily a good idea, just an example
606 *.gz = pipe: gunzip
606 *.gz = pipe: gunzip
607
607
608 [decode]
608 [decode]
609 # recompress gzip files when writing them to the working dir (we
609 # recompress gzip files when writing them to the working dir (we
610 # can safely omit "pipe:", because it's the default)
610 # can safely omit "pipe:", because it's the default)
611 *.gz = gzip
611 *.gz = gzip
612
612
613 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
613 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
614 with the name of a temporary file that contains the data to be
614 with the name of a temporary file that contains the data to be
615 filtered by the command. The string ``OUTFILE`` is replaced with the name
615 filtered by the command. The string ``OUTFILE`` is replaced with the name
616 of an empty temporary file, where the filtered data must be written by
616 of an empty temporary file, where the filtered data must be written by
617 the command.
617 the command.
618
618
619 .. container:: windows
619 .. container:: windows
620
620
621 .. note::
621 .. note::
622
622
623 The tempfile mechanism is recommended for Windows systems,
623 The tempfile mechanism is recommended for Windows systems,
624 where the standard shell I/O redirection operators often have
624 where the standard shell I/O redirection operators often have
625 strange effects and may corrupt the contents of your files.
625 strange effects and may corrupt the contents of your files.
626
626
627 This filter mechanism is used internally by the ``eol`` extension to
627 This filter mechanism is used internally by the ``eol`` extension to
628 translate line ending characters between Windows (CRLF) and Unix (LF)
628 translate line ending characters between Windows (CRLF) and Unix (LF)
629 format. We suggest you use the ``eol`` extension for convenience.
629 format. We suggest you use the ``eol`` extension for convenience.
630
630
631
631
632 ``defaults``
632 ``defaults``
633 ------------
633 ------------
634
634
635 (defaults are deprecated. Don't use them. Use aliases instead.)
635 (defaults are deprecated. Don't use them. Use aliases instead.)
636
636
637 Use the ``[defaults]`` section to define command defaults, i.e. the
637 Use the ``[defaults]`` section to define command defaults, i.e. the
638 default options/arguments to pass to the specified commands.
638 default options/arguments to pass to the specified commands.
639
639
640 The following example makes :hg:`log` run in verbose mode, and
640 The following example makes :hg:`log` run in verbose mode, and
641 :hg:`status` show only the modified files, by default::
641 :hg:`status` show only the modified files, by default::
642
642
643 [defaults]
643 [defaults]
644 log = -v
644 log = -v
645 status = -m
645 status = -m
646
646
647 The actual commands, instead of their aliases, must be used when
647 The actual commands, instead of their aliases, must be used when
648 defining command defaults. The command defaults will also be applied
648 defining command defaults. The command defaults will also be applied
649 to the aliases of the commands defined.
649 to the aliases of the commands defined.
650
650
651
651
652 ``diff``
652 ``diff``
653 --------
653 --------
654
654
655 Settings used when displaying diffs. Everything except for ``unified``
655 Settings used when displaying diffs. Everything except for ``unified``
656 is a Boolean and defaults to False. See :hg:`help config.annotate`
656 is a Boolean and defaults to False. See :hg:`help config.annotate`
657 for related options for the annotate command.
657 for related options for the annotate command.
658
658
659 ``git``
659 ``git``
660 Use git extended diff format.
660 Use git extended diff format.
661
661
662 ``nobinary``
662 ``nobinary``
663 Omit git binary patches.
663 Omit git binary patches.
664
664
665 ``nodates``
665 ``nodates``
666 Don't include dates in diff headers.
666 Don't include dates in diff headers.
667
667
668 ``noprefix``
668 ``noprefix``
669 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
669 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
670
670
671 ``showfunc``
671 ``showfunc``
672 Show which function each change is in.
672 Show which function each change is in.
673
673
674 ``ignorews``
674 ``ignorews``
675 Ignore white space when comparing lines.
675 Ignore white space when comparing lines.
676
676
677 ``ignorewsamount``
677 ``ignorewsamount``
678 Ignore changes in the amount of white space.
678 Ignore changes in the amount of white space.
679
679
680 ``ignoreblanklines``
680 ``ignoreblanklines``
681 Ignore changes whose lines are all blank.
681 Ignore changes whose lines are all blank.
682
682
683 ``unified``
683 ``unified``
684 Number of lines of context to show.
684 Number of lines of context to show.
685
685
686 ``email``
686 ``email``
687 ---------
687 ---------
688
688
689 Settings for extensions that send email messages.
689 Settings for extensions that send email messages.
690
690
691 ``from``
691 ``from``
692 Optional. Email address to use in "From" header and SMTP envelope
692 Optional. Email address to use in "From" header and SMTP envelope
693 of outgoing messages.
693 of outgoing messages.
694
694
695 ``to``
695 ``to``
696 Optional. Comma-separated list of recipients' email addresses.
696 Optional. Comma-separated list of recipients' email addresses.
697
697
698 ``cc``
698 ``cc``
699 Optional. Comma-separated list of carbon copy recipients'
699 Optional. Comma-separated list of carbon copy recipients'
700 email addresses.
700 email addresses.
701
701
702 ``bcc``
702 ``bcc``
703 Optional. Comma-separated list of blind carbon copy recipients'
703 Optional. Comma-separated list of blind carbon copy recipients'
704 email addresses.
704 email addresses.
705
705
706 ``method``
706 ``method``
707 Optional. Method to use to send email messages. If value is ``smtp``
707 Optional. Method to use to send email messages. If value is ``smtp``
708 (default), use SMTP (see the ``[smtp]`` section for configuration).
708 (default), use SMTP (see the ``[smtp]`` section for configuration).
709 Otherwise, use as name of program to run that acts like sendmail
709 Otherwise, use as name of program to run that acts like sendmail
710 (takes ``-f`` option for sender, list of recipients on command line,
710 (takes ``-f`` option for sender, list of recipients on command line,
711 message on stdin). Normally, setting this to ``sendmail`` or
711 message on stdin). Normally, setting this to ``sendmail`` or
712 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
712 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
713
713
714 ``charsets``
714 ``charsets``
715 Optional. Comma-separated list of character sets considered
715 Optional. Comma-separated list of character sets considered
716 convenient for recipients. Addresses, headers, and parts not
716 convenient for recipients. Addresses, headers, and parts not
717 containing patches of outgoing messages will be encoded in the
717 containing patches of outgoing messages will be encoded in the
718 first character set to which conversion from local encoding
718 first character set to which conversion from local encoding
719 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
719 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
720 conversion fails, the text in question is sent as is.
720 conversion fails, the text in question is sent as is.
721 (default: '')
721 (default: '')
722
722
723 Order of outgoing email character sets:
723 Order of outgoing email character sets:
724
724
725 1. ``us-ascii``: always first, regardless of settings
725 1. ``us-ascii``: always first, regardless of settings
726 2. ``email.charsets``: in order given by user
726 2. ``email.charsets``: in order given by user
727 3. ``ui.fallbackencoding``: if not in email.charsets
727 3. ``ui.fallbackencoding``: if not in email.charsets
728 4. ``$HGENCODING``: if not in email.charsets
728 4. ``$HGENCODING``: if not in email.charsets
729 5. ``utf-8``: always last, regardless of settings
729 5. ``utf-8``: always last, regardless of settings
730
730
731 Email example::
731 Email example::
732
732
733 [email]
733 [email]
734 from = Joseph User <joe.user@example.com>
734 from = Joseph User <joe.user@example.com>
735 method = /usr/sbin/sendmail
735 method = /usr/sbin/sendmail
736 # charsets for western Europeans
736 # charsets for western Europeans
737 # us-ascii, utf-8 omitted, as they are tried first and last
737 # us-ascii, utf-8 omitted, as they are tried first and last
738 charsets = iso-8859-1, iso-8859-15, windows-1252
738 charsets = iso-8859-1, iso-8859-15, windows-1252
739
739
740
740
741 ``extensions``
741 ``extensions``
742 --------------
742 --------------
743
743
744 Mercurial has an extension mechanism for adding new features. To
744 Mercurial has an extension mechanism for adding new features. To
745 enable an extension, create an entry for it in this section.
745 enable an extension, create an entry for it in this section.
746
746
747 If you know that the extension is already in Python's search path,
747 If you know that the extension is already in Python's search path,
748 you can give the name of the module, followed by ``=``, with nothing
748 you can give the name of the module, followed by ``=``, with nothing
749 after the ``=``.
749 after the ``=``.
750
750
751 Otherwise, give a name that you choose, followed by ``=``, followed by
751 Otherwise, give a name that you choose, followed by ``=``, followed by
752 the path to the ``.py`` file (including the file name extension) that
752 the path to the ``.py`` file (including the file name extension) that
753 defines the extension.
753 defines the extension.
754
754
755 To explicitly disable an extension that is enabled in an hgrc of
755 To explicitly disable an extension that is enabled in an hgrc of
756 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
756 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
757 or ``foo = !`` when path is not supplied.
757 or ``foo = !`` when path is not supplied.
758
758
759 Example for ``~/.hgrc``::
759 Example for ``~/.hgrc``::
760
760
761 [extensions]
761 [extensions]
762 # (the churn extension will get loaded from Mercurial's path)
762 # (the churn extension will get loaded from Mercurial's path)
763 churn =
763 churn =
764 # (this extension will get loaded from the file specified)
764 # (this extension will get loaded from the file specified)
765 myfeature = ~/.hgext/myfeature.py
765 myfeature = ~/.hgext/myfeature.py
766
766
767
767
768 ``format``
768 ``format``
769 ----------
769 ----------
770
770
771 ``usegeneraldelta``
771 ``usegeneraldelta``
772 Enable or disable the "generaldelta" repository format which improves
772 Enable or disable the "generaldelta" repository format which improves
773 repository compression by allowing "revlog" to store delta against arbitrary
773 repository compression by allowing "revlog" to store delta against arbitrary
774 revision instead of the previous stored one. This provides significant
774 revision instead of the previous stored one. This provides significant
775 improvement for repositories with branches.
775 improvement for repositories with branches.
776
776
777 Repositories with this on-disk format require Mercurial version 1.9.
777 Repositories with this on-disk format require Mercurial version 1.9.
778
778
779 Enabled by default.
779 Enabled by default.
780
780
781 ``dotencode``
781 ``dotencode``
782 Enable or disable the "dotencode" repository format which enhances
782 Enable or disable the "dotencode" repository format which enhances
783 the "fncache" repository format (which has to be enabled to use
783 the "fncache" repository format (which has to be enabled to use
784 dotencode) to avoid issues with filenames starting with ._ on
784 dotencode) to avoid issues with filenames starting with ._ on
785 Mac OS X and spaces on Windows.
785 Mac OS X and spaces on Windows.
786
786
787 Repositories with this on-disk format require Mercurial version 1.7.
787 Repositories with this on-disk format require Mercurial version 1.7.
788
788
789 Enabled by default.
789 Enabled by default.
790
790
791 ``usefncache``
791 ``usefncache``
792 Enable or disable the "fncache" repository format which enhances
792 Enable or disable the "fncache" repository format which enhances
793 the "store" repository format (which has to be enabled to use
793 the "store" repository format (which has to be enabled to use
794 fncache) to allow longer filenames and avoids using Windows
794 fncache) to allow longer filenames and avoids using Windows
795 reserved names, e.g. "nul".
795 reserved names, e.g. "nul".
796
796
797 Repositories with this on-disk format require Mercurial version 1.1.
797 Repositories with this on-disk format require Mercurial version 1.1.
798
798
799 Enabled by default.
799 Enabled by default.
800
800
801 ``usestore``
801 ``usestore``
802 Enable or disable the "store" repository format which improves
802 Enable or disable the "store" repository format which improves
803 compatibility with systems that fold case or otherwise mangle
803 compatibility with systems that fold case or otherwise mangle
804 filenames. Disabling this option will allow you to store longer filenames
804 filenames. Disabling this option will allow you to store longer filenames
805 in some situations at the expense of compatibility.
805 in some situations at the expense of compatibility.
806
806
807 Repositories with this on-disk format require Mercurial version 0.9.4.
807 Repositories with this on-disk format require Mercurial version 0.9.4.
808
808
809 Enabled by default.
809 Enabled by default.
810
810
811 ``graph``
811 ``graph``
812 ---------
812 ---------
813
813
814 Web graph view configuration. This section let you change graph
814 Web graph view configuration. This section let you change graph
815 elements display properties by branches, for instance to make the
815 elements display properties by branches, for instance to make the
816 ``default`` branch stand out.
816 ``default`` branch stand out.
817
817
818 Each line has the following format::
818 Each line has the following format::
819
819
820 <branch>.<argument> = <value>
820 <branch>.<argument> = <value>
821
821
822 where ``<branch>`` is the name of the branch being
822 where ``<branch>`` is the name of the branch being
823 customized. Example::
823 customized. Example::
824
824
825 [graph]
825 [graph]
826 # 2px width
826 # 2px width
827 default.width = 2
827 default.width = 2
828 # red color
828 # red color
829 default.color = FF0000
829 default.color = FF0000
830
830
831 Supported arguments:
831 Supported arguments:
832
832
833 ``width``
833 ``width``
834 Set branch edges width in pixels.
834 Set branch edges width in pixels.
835
835
836 ``color``
836 ``color``
837 Set branch edges color in hexadecimal RGB notation.
837 Set branch edges color in hexadecimal RGB notation.
838
838
839 ``hooks``
839 ``hooks``
840 ---------
840 ---------
841
841
842 Commands or Python functions that get automatically executed by
842 Commands or Python functions that get automatically executed by
843 various actions such as starting or finishing a commit. Multiple
843 various actions such as starting or finishing a commit. Multiple
844 hooks can be run for the same action by appending a suffix to the
844 hooks can be run for the same action by appending a suffix to the
845 action. Overriding a site-wide hook can be done by changing its
845 action. Overriding a site-wide hook can be done by changing its
846 value or setting it to an empty string. Hooks can be prioritized
846 value or setting it to an empty string. Hooks can be prioritized
847 by adding a prefix of ``priority.`` to the hook name on a new line
847 by adding a prefix of ``priority.`` to the hook name on a new line
848 and setting the priority. The default priority is 0.
848 and setting the priority. The default priority is 0.
849
849
850 Example ``.hg/hgrc``::
850 Example ``.hg/hgrc``::
851
851
852 [hooks]
852 [hooks]
853 # update working directory after adding changesets
853 # update working directory after adding changesets
854 changegroup.update = hg update
854 changegroup.update = hg update
855 # do not use the site-wide hook
855 # do not use the site-wide hook
856 incoming =
856 incoming =
857 incoming.email = /my/email/hook
857 incoming.email = /my/email/hook
858 incoming.autobuild = /my/build/hook
858 incoming.autobuild = /my/build/hook
859 # force autobuild hook to run before other incoming hooks
859 # force autobuild hook to run before other incoming hooks
860 priority.incoming.autobuild = 1
860 priority.incoming.autobuild = 1
861
861
862 Most hooks are run with environment variables set that give useful
862 Most hooks are run with environment variables set that give useful
863 additional information. For each hook below, the environment variables
863 additional information. For each hook below, the environment variables
864 it is passed are listed with names of the form ``$HG_foo``. The
864 it is passed are listed with names in the form ``$HG_foo``. The
865 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
865 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
866 their respectively contains the type of hook which triggered the run and
866 They contain the type of hook which triggered the run and the full name
867 the full name of the hooks in the config. In the example about this will
867 of the hook in the config, respectively. In the example above, this will
868 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
868 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
869
869
870 ``changegroup``
870 ``changegroup``
871 Run after a changegroup has been added via push, pull or unbundle. ID of the
871 Run after a changegroup has been added via push, pull or unbundle. The ID of
872 first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
872 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
873 from which changes came is in ``$HG_URL``.
873 The URL from which changes came is in ``$HG_URL``.
874
874
875 ``commit``
875 ``commit``
876 Run after a changeset has been created in the local repository. ID
876 Run after a changeset has been created in the local repository. The ID
877 of the newly created changeset is in ``$HG_NODE``. Parent changeset
877 of the newly created changeset is in ``$HG_NODE``. Parent changeset
878 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
878 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
879
879
880 ``incoming``
880 ``incoming``
881 Run after a changeset has been pulled, pushed, or unbundled into
881 Run after a changeset has been pulled, pushed, or unbundled into
882 the local repository. The ID of the newly arrived changeset is in
882 the local repository. The ID of the newly arrived changeset is in
883 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
883 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
884
884
885 ``outgoing``
885 ``outgoing``
886 Run after sending changes from local repository to another. ID of
886 Run after sending changes from the local repository to another. The ID of
887 first changeset sent is in ``$HG_NODE``. Source of operation is in
887 first changeset sent is in ``$HG_NODE``. The source of operation is in
888 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
888 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
889
889
890 ``post-<command>``
890 ``post-<command>``
891 Run after successful invocations of the associated command. The
891 Run after successful invocations of the associated command. The
892 contents of the command line are passed as ``$HG_ARGS`` and the result
892 contents of the command line are passed as ``$HG_ARGS`` and the result
893 code in ``$HG_RESULT``. Parsed command line arguments are passed as
893 code in ``$HG_RESULT``. Parsed command line arguments are passed as
894 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
894 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
895 the python data internally passed to <command>. ``$HG_OPTS`` is a
895 the python data internally passed to <command>. ``$HG_OPTS`` is a
896 dictionary of options (with unspecified options set to their defaults).
896 dictionary of options (with unspecified options set to their defaults).
897 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
897 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
898
898
899 ``fail-<command>``
899 ``fail-<command>``
900 Run after a failed invocation of an associated command. The contents
900 Run after a failed invocation of an associated command. The contents
901 of the command line are passed as ``$HG_ARGS``. Parsed command line
901 of the command line are passed as ``$HG_ARGS``. Parsed command line
902 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
902 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
903 string representations of the python data internally passed to
903 string representations of the python data internally passed to
904 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
904 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
905 options set to their defaults). ``$HG_PATS`` is a list of arguments.
905 options set to their defaults). ``$HG_PATS`` is a list of arguments.
906 Hook failure is ignored.
906 Hook failure is ignored.
907
907
908 ``pre-<command>``
908 ``pre-<command>``
909 Run before executing the associated command. The contents of the
909 Run before executing the associated command. The contents of the
910 command line are passed as ``$HG_ARGS``. Parsed command line arguments
910 command line are passed as ``$HG_ARGS``. Parsed command line arguments
911 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
911 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
912 representations of the data internally passed to <command>. ``$HG_OPTS``
912 representations of the data internally passed to <command>. ``$HG_OPTS``
913 is a dictionary of options (with unspecified options set to their
913 is a dictionary of options (with unspecified options set to their
914 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
914 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
915 failure, the command doesn't execute and Mercurial returns the failure
915 failure, the command doesn't execute and Mercurial returns the failure
916 code.
916 code.
917
917
918 ``prechangegroup``
918 ``prechangegroup``
919 Run before a changegroup is added via push, pull or unbundle. Exit
919 Run before a changegroup is added via push, pull or unbundle. Exit
920 status 0 allows the changegroup to proceed. Non-zero status will
920 status 0 allows the changegroup to proceed. A non-zero status will
921 cause the push, pull or unbundle to fail. URL from which changes
921 cause the push, pull or unbundle to fail. The URL from which changes
922 will come is in ``$HG_URL``.
922 will come is in ``$HG_URL``.
923
923
924 ``precommit``
924 ``precommit``
925 Run before starting a local commit. Exit status 0 allows the
925 Run before starting a local commit. Exit status 0 allows the
926 commit to proceed. Non-zero status will cause the commit to fail.
926 commit to proceed. A non-zero status will cause the commit to fail.
927 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
927 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
928
928
929 ``prelistkeys``
929 ``prelistkeys``
930 Run before listing pushkeys (like bookmarks) in the
930 Run before listing pushkeys (like bookmarks) in the
931 repository. Non-zero status will cause failure. The key namespace is
931 repository. A non-zero status will cause failure. The key namespace is
932 in ``$HG_NAMESPACE``.
932 in ``$HG_NAMESPACE``.
933
933
934 ``preoutgoing``
934 ``preoutgoing``
935 Run before collecting changes to send from the local repository to
935 Run before collecting changes to send from the local repository to
936 another. Non-zero status will cause failure. This lets you prevent
936 another. A non-zero status will cause failure. This lets you prevent
937 pull over HTTP or SSH. Also prevents against local pull, push
937 pull over HTTP or SSH. It can also prevent propagating commits (via
938 (outbound) or bundle commands, but not effective, since you can
938 local pull, push (outbound) or bundle commands), but not completely,
939 just copy files instead then. Source of operation is in
939 since you can just copy files instead. The source of operation is in
940 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
940 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
941 SSH or HTTP repository. If "push", "pull" or "bundle", operation
941 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
942 is happening on behalf of repository on same system.
942 is happening on behalf of a repository on same system.
943
943
944 ``prepushkey``
944 ``prepushkey``
945 Run before a pushkey (like a bookmark) is added to the
945 Run before a pushkey (like a bookmark) is added to the
946 repository. Non-zero status will cause the key to be rejected. The
946 repository. A non-zero status will cause the key to be rejected. The
947 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
947 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
948 the old value (if any) is in ``$HG_OLD``, and the new value is in
948 the old value (if any) is in ``$HG_OLD``, and the new value is in
949 ``$HG_NEW``.
949 ``$HG_NEW``.
950
950
951 ``pretag``
951 ``pretag``
952 Run before creating a tag. Exit status 0 allows the tag to be
952 Run before creating a tag. Exit status 0 allows the tag to be
953 created. Non-zero status will cause the tag to fail. ID of
953 created. A non-zero status will cause the tag to fail. The ID of the
954 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
954 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
955 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
955 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
956
956
957 ``pretxnopen``
957 ``pretxnopen``
958 Run before any new repository transaction is open. The reason for the
958 Run before any new repository transaction is open. The reason for the
959 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
959 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
960 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
960 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
961 transaction from being opened.
961 transaction from being opened.
962
962
963 ``pretxnclose``
963 ``pretxnclose``
964 Run right before the transaction is actually finalized. Any repository change
964 Run right before the transaction is actually finalized. Any repository change
965 will be visible to the hook program. This lets you validate the transaction
965 will be visible to the hook program. This lets you validate the transaction
966 content or change it. Exit status 0 allows the commit to proceed. Non-zero
966 content or change it. Exit status 0 allows the commit to proceed. A non-zero
967 status will cause the transaction to be rolled back. The reason for the
967 status will cause the transaction to be rolled back. The reason for the
968 transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
968 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
969 the transaction will be in ``HG_TXNID``. The rest of the available data will
969 the transaction will be in ``HG_TXNID``. The rest of the available data will
970 vary according the transaction type. New changesets will add ``$HG_NODE`` (id
970 vary according the transaction type. New changesets will add ``$HG_NODE``
971 of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
971 (the ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last
972 changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
972 added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables. Bookmark and
973 changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
973 phase changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``
974 respectively, etc.
974
975
975 ``txnclose``
976 ``txnclose``
976 Run after any repository transaction has been committed. At this
977 Run after any repository transaction has been committed. At this
977 point, the transaction can no longer be rolled back. The hook will run
978 point, the transaction can no longer be rolled back. The hook will run
978 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
979 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
979 details about available variables.
980 details about available variables.
980
981
981 ``txnabort``
982 ``txnabort``
982 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
983 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
983 docs for details about available variables.
984 for details about available variables.
984
985
985 ``pretxnchangegroup``
986 ``pretxnchangegroup``
986 Run after a changegroup has been added via push, pull or unbundle, but before
987 Run after a changegroup has been added via push, pull or unbundle, but before
987 the transaction has been committed. Changegroup is visible to hook program.
988 the transaction has been committed. The changegroup is visible to the hook
988 This lets you validate incoming changes before accepting them. Passed the ID
989 program. This allows validation of incoming changes before accepting them.
989 of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
990 The ID of the first new changeset is in ``$HG_NODE`` and last is in
990 Exit status 0 allows the transaction to commit. Non-zero status will cause
991 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
991 the transaction to be rolled back and the push, pull or unbundle will fail.
992 status will cause the transaction to be rolled back, and the push, pull or
992 URL that was source of changes is in ``$HG_URL``.
993 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
993
994
994 ``pretxncommit``
995 ``pretxncommit``
995 Run after a changeset has been created but the transaction not yet
996 Run after a changeset has been created, but before the transaction is
996 committed. Changeset is visible to hook program. This lets you
997 committed. The changeset is visible to the hook program. This allows
997 validate commit message and changes. Exit status 0 allows the
998 validation of the commit message and changes. Exit status 0 allows the
998 commit to proceed. Non-zero status will cause the transaction to
999 commit to proceed. A non-zero status will cause the transaction to
999 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
1000 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1000 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1001 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1001
1002
1002 ``preupdate``
1003 ``preupdate``
1003 Run before updating the working directory. Exit status 0 allows
1004 Run before updating the working directory. Exit status 0 allows
1004 the update to proceed. Non-zero status will prevent the update.
1005 the update to proceed. A non-zero status will prevent the update.
1005 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
1006 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1006 of second new parent is in ``$HG_PARENT2``.
1007 merge, the ID of second new parent is in ``$HG_PARENT2``.
1007
1008
1008 ``listkeys``
1009 ``listkeys``
1009 Run after listing pushkeys (like bookmarks) in the repository. The
1010 Run after listing pushkeys (like bookmarks) in the repository. The
1010 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1011 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1011 dictionary containing the keys and values.
1012 dictionary containing the keys and values.
1012
1013
1013 ``pushkey``
1014 ``pushkey``
1014 Run after a pushkey (like a bookmark) is added to the
1015 Run after a pushkey (like a bookmark) is added to the
1015 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1016 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1016 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1017 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1017 value is in ``$HG_NEW``.
1018 value is in ``$HG_NEW``.
1018
1019
1019 ``tag``
1020 ``tag``
1020 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
1021 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1021 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
1022 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1022 repository if ``$HG_LOCAL=0``.
1023 the repository if ``$HG_LOCAL=0``.
1023
1024
1024 ``update``
1025 ``update``
1025 Run after updating the working directory. Changeset ID of first
1026 Run after updating the working directory. The changeset ID of first
1026 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
1027 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1027 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1028 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1028 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
1029 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1029
1030
1030 .. note::
1031 .. note::
1031
1032
1032 It is generally better to use standard hooks rather than the
1033 It is generally better to use standard hooks rather than the
1033 generic pre- and post- command hooks as they are guaranteed to be
1034 generic pre- and post- command hooks, as they are guaranteed to be
1034 called in the appropriate contexts for influencing transactions.
1035 called in the appropriate contexts for influencing transactions.
1035 Also, hooks like "commit" will be called in all contexts that
1036 Also, hooks like "commit" will be called in all contexts that
1036 generate a commit (e.g. tag) and not just the commit command.
1037 generate a commit (e.g. tag) and not just the commit command.
1037
1038
1038 .. note::
1039 .. note::
1039
1040
1040 Environment variables with empty values may not be passed to
1041 Environment variables with empty values may not be passed to
1041 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1042 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1042 will have an empty value under Unix-like platforms for non-merge
1043 will have an empty value under Unix-like platforms for non-merge
1043 changesets, while it will not be available at all under Windows.
1044 changesets, while it will not be available at all under Windows.
1044
1045
1045 The syntax for Python hooks is as follows::
1046 The syntax for Python hooks is as follows::
1046
1047
1047 hookname = python:modulename.submodule.callable
1048 hookname = python:modulename.submodule.callable
1048 hookname = python:/path/to/python/module.py:callable
1049 hookname = python:/path/to/python/module.py:callable
1049
1050
1050 Python hooks are run within the Mercurial process. Each hook is
1051 Python hooks are run within the Mercurial process. Each hook is
1051 called with at least three keyword arguments: a ui object (keyword
1052 called with at least three keyword arguments: a ui object (keyword
1052 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1053 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1053 keyword that tells what kind of hook is used. Arguments listed as
1054 keyword that tells what kind of hook is used. Arguments listed as
1054 environment variables above are passed as keyword arguments, with no
1055 environment variables above are passed as keyword arguments, with no
1055 ``HG_`` prefix, and names in lower case.
1056 ``HG_`` prefix, and names in lower case.
1056
1057
1057 If a Python hook returns a "true" value or raises an exception, this
1058 If a Python hook returns a "true" value or raises an exception, this
1058 is treated as a failure.
1059 is treated as a failure.
1059
1060
1060
1061
1061 ``hostfingerprints``
1062 ``hostfingerprints``
1062 --------------------
1063 --------------------
1063
1064
1064 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1065 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1065
1066
1066 Fingerprints of the certificates of known HTTPS servers.
1067 Fingerprints of the certificates of known HTTPS servers.
1067
1068
1068 A HTTPS connection to a server with a fingerprint configured here will
1069 A HTTPS connection to a server with a fingerprint configured here will
1069 only succeed if the servers certificate matches the fingerprint.
1070 only succeed if the servers certificate matches the fingerprint.
1070 This is very similar to how ssh known hosts works.
1071 This is very similar to how ssh known hosts works.
1071
1072
1072 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1073 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1073 Multiple values can be specified (separated by spaces or commas). This can
1074 Multiple values can be specified (separated by spaces or commas). This can
1074 be used to define both old and new fingerprints while a host transitions
1075 be used to define both old and new fingerprints while a host transitions
1075 to a new certificate.
1076 to a new certificate.
1076
1077
1077 The CA chain and web.cacerts is not used for servers with a fingerprint.
1078 The CA chain and web.cacerts is not used for servers with a fingerprint.
1078
1079
1079 For example::
1080 For example::
1080
1081
1081 [hostfingerprints]
1082 [hostfingerprints]
1082 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1083 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1083 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1084 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1084
1085
1085 ``hostsecurity``
1086 ``hostsecurity``
1086 ----------------
1087 ----------------
1087
1088
1088 Used to specify global and per-host security settings for connecting to
1089 Used to specify global and per-host security settings for connecting to
1089 other machines.
1090 other machines.
1090
1091
1091 The following options control default behavior for all hosts.
1092 The following options control default behavior for all hosts.
1092
1093
1093 ``ciphers``
1094 ``ciphers``
1094 Defines the cryptographic ciphers to use for connections.
1095 Defines the cryptographic ciphers to use for connections.
1095
1096
1096 Value must be a valid OpenSSL Cipher List Format as documented at
1097 Value must be a valid OpenSSL Cipher List Format as documented at
1097 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1098 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1098
1099
1099 This setting is for advanced users only. Setting to incorrect values
1100 This setting is for advanced users only. Setting to incorrect values
1100 can significantly lower connection security or decrease performance.
1101 can significantly lower connection security or decrease performance.
1101 You have been warned.
1102 You have been warned.
1102
1103
1103 This option requires Python 2.7.
1104 This option requires Python 2.7.
1104
1105
1105 ``minimumprotocol``
1106 ``minimumprotocol``
1106 Defines the minimum channel encryption protocol to use.
1107 Defines the minimum channel encryption protocol to use.
1107
1108
1108 By default, the highest version of TLS supported by both client and server
1109 By default, the highest version of TLS supported by both client and server
1109 is used.
1110 is used.
1110
1111
1111 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1112 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1112
1113
1113 When running on an old Python version, only ``tls1.0`` is allowed since
1114 When running on an old Python version, only ``tls1.0`` is allowed since
1114 old versions of Python only support up to TLS 1.0.
1115 old versions of Python only support up to TLS 1.0.
1115
1116
1116 When running a Python that supports modern TLS versions, the default is
1117 When running a Python that supports modern TLS versions, the default is
1117 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1118 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1118 weakens security and should only be used as a feature of last resort if
1119 weakens security and should only be used as a feature of last resort if
1119 a server does not support TLS 1.1+.
1120 a server does not support TLS 1.1+.
1120
1121
1121 Options in the ``[hostsecurity]`` section can have the form
1122 Options in the ``[hostsecurity]`` section can have the form
1122 ``hostname``:``setting``. This allows multiple settings to be defined on a
1123 ``hostname``:``setting``. This allows multiple settings to be defined on a
1123 per-host basis.
1124 per-host basis.
1124
1125
1125 The following per-host settings can be defined.
1126 The following per-host settings can be defined.
1126
1127
1127 ``ciphers``
1128 ``ciphers``
1128 This behaves like ``ciphers`` as described above except it only applies
1129 This behaves like ``ciphers`` as described above except it only applies
1129 to the host on which it is defined.
1130 to the host on which it is defined.
1130
1131
1131 ``fingerprints``
1132 ``fingerprints``
1132 A list of hashes of the DER encoded peer/remote certificate. Values have
1133 A list of hashes of the DER encoded peer/remote certificate. Values have
1133 the form ``algorithm``:``fingerprint``. e.g.
1134 the form ``algorithm``:``fingerprint``. e.g.
1134 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1135 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1135
1136
1136 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1137 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1137 ``sha512``.
1138 ``sha512``.
1138
1139
1139 Use of ``sha256`` or ``sha512`` is preferred.
1140 Use of ``sha256`` or ``sha512`` is preferred.
1140
1141
1141 If a fingerprint is specified, the CA chain is not validated for this
1142 If a fingerprint is specified, the CA chain is not validated for this
1142 host and Mercurial will require the remote certificate to match one
1143 host and Mercurial will require the remote certificate to match one
1143 of the fingerprints specified. This means if the server updates its
1144 of the fingerprints specified. This means if the server updates its
1144 certificate, Mercurial will abort until a new fingerprint is defined.
1145 certificate, Mercurial will abort until a new fingerprint is defined.
1145 This can provide stronger security than traditional CA-based validation
1146 This can provide stronger security than traditional CA-based validation
1146 at the expense of convenience.
1147 at the expense of convenience.
1147
1148
1148 This option takes precedence over ``verifycertsfile``.
1149 This option takes precedence over ``verifycertsfile``.
1149
1150
1150 ``minimumprotocol``
1151 ``minimumprotocol``
1151 This behaves like ``minimumprotocol`` as described above except it
1152 This behaves like ``minimumprotocol`` as described above except it
1152 only applies to the host on which it is defined.
1153 only applies to the host on which it is defined.
1153
1154
1154 ``verifycertsfile``
1155 ``verifycertsfile``
1155 Path to file a containing a list of PEM encoded certificates used to
1156 Path to file a containing a list of PEM encoded certificates used to
1156 verify the server certificate. Environment variables and ``~user``
1157 verify the server certificate. Environment variables and ``~user``
1157 constructs are expanded in the filename.
1158 constructs are expanded in the filename.
1158
1159
1159 The server certificate or the certificate's certificate authority (CA)
1160 The server certificate or the certificate's certificate authority (CA)
1160 must match a certificate from this file or certificate verification
1161 must match a certificate from this file or certificate verification
1161 will fail and connections to the server will be refused.
1162 will fail and connections to the server will be refused.
1162
1163
1163 If defined, only certificates provided by this file will be used:
1164 If defined, only certificates provided by this file will be used:
1164 ``web.cacerts`` and any system/default certificates will not be
1165 ``web.cacerts`` and any system/default certificates will not be
1165 used.
1166 used.
1166
1167
1167 This option has no effect if the per-host ``fingerprints`` option
1168 This option has no effect if the per-host ``fingerprints`` option
1168 is set.
1169 is set.
1169
1170
1170 The format of the file is as follows::
1171 The format of the file is as follows::
1171
1172
1172 -----BEGIN CERTIFICATE-----
1173 -----BEGIN CERTIFICATE-----
1173 ... (certificate in base64 PEM encoding) ...
1174 ... (certificate in base64 PEM encoding) ...
1174 -----END CERTIFICATE-----
1175 -----END CERTIFICATE-----
1175 -----BEGIN CERTIFICATE-----
1176 -----BEGIN CERTIFICATE-----
1176 ... (certificate in base64 PEM encoding) ...
1177 ... (certificate in base64 PEM encoding) ...
1177 -----END CERTIFICATE-----
1178 -----END CERTIFICATE-----
1178
1179
1179 For example::
1180 For example::
1180
1181
1181 [hostsecurity]
1182 [hostsecurity]
1182 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1183 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1183 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
1184 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
1184 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1185 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1185
1186
1186 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1187 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1187 when connecting to ``hg.example.com``::
1188 when connecting to ``hg.example.com``::
1188
1189
1189 [hostsecurity]
1190 [hostsecurity]
1190 minimumprotocol = tls1.2
1191 minimumprotocol = tls1.2
1191 hg.example.com:minimumprotocol = tls1.1
1192 hg.example.com:minimumprotocol = tls1.1
1192
1193
1193 ``http_proxy``
1194 ``http_proxy``
1194 --------------
1195 --------------
1195
1196
1196 Used to access web-based Mercurial repositories through a HTTP
1197 Used to access web-based Mercurial repositories through a HTTP
1197 proxy.
1198 proxy.
1198
1199
1199 ``host``
1200 ``host``
1200 Host name and (optional) port of the proxy server, for example
1201 Host name and (optional) port of the proxy server, for example
1201 "myproxy:8000".
1202 "myproxy:8000".
1202
1203
1203 ``no``
1204 ``no``
1204 Optional. Comma-separated list of host names that should bypass
1205 Optional. Comma-separated list of host names that should bypass
1205 the proxy.
1206 the proxy.
1206
1207
1207 ``passwd``
1208 ``passwd``
1208 Optional. Password to authenticate with at the proxy server.
1209 Optional. Password to authenticate with at the proxy server.
1209
1210
1210 ``user``
1211 ``user``
1211 Optional. User name to authenticate with at the proxy server.
1212 Optional. User name to authenticate with at the proxy server.
1212
1213
1213 ``always``
1214 ``always``
1214 Optional. Always use the proxy, even for localhost and any entries
1215 Optional. Always use the proxy, even for localhost and any entries
1215 in ``http_proxy.no``. (default: False)
1216 in ``http_proxy.no``. (default: False)
1216
1217
1217 ``merge``
1218 ``merge``
1218 ---------
1219 ---------
1219
1220
1220 This section specifies behavior during merges and updates.
1221 This section specifies behavior during merges and updates.
1221
1222
1222 ``checkignored``
1223 ``checkignored``
1223 Controls behavior when an ignored file on disk has the same name as a tracked
1224 Controls behavior when an ignored file on disk has the same name as a tracked
1224 file in the changeset being merged or updated to, and has different
1225 file in the changeset being merged or updated to, and has different
1225 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1226 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1226 abort on such files. With ``warn``, warn on such files and back them up as
1227 abort on such files. With ``warn``, warn on such files and back them up as
1227 ``.orig``. With ``ignore``, don't print a warning and back them up as
1228 ``.orig``. With ``ignore``, don't print a warning and back them up as
1228 ``.orig``. (default: ``abort``)
1229 ``.orig``. (default: ``abort``)
1229
1230
1230 ``checkunknown``
1231 ``checkunknown``
1231 Controls behavior when an unknown file that isn't ignored has the same name
1232 Controls behavior when an unknown file that isn't ignored has the same name
1232 as a tracked file in the changeset being merged or updated to, and has
1233 as a tracked file in the changeset being merged or updated to, and has
1233 different contents. Similar to ``merge.checkignored``, except for files that
1234 different contents. Similar to ``merge.checkignored``, except for files that
1234 are not ignored. (default: ``abort``)
1235 are not ignored. (default: ``abort``)
1235
1236
1236 ``merge-patterns``
1237 ``merge-patterns``
1237 ------------------
1238 ------------------
1238
1239
1239 This section specifies merge tools to associate with particular file
1240 This section specifies merge tools to associate with particular file
1240 patterns. Tools matched here will take precedence over the default
1241 patterns. Tools matched here will take precedence over the default
1241 merge tool. Patterns are globs by default, rooted at the repository
1242 merge tool. Patterns are globs by default, rooted at the repository
1242 root.
1243 root.
1243
1244
1244 Example::
1245 Example::
1245
1246
1246 [merge-patterns]
1247 [merge-patterns]
1247 **.c = kdiff3
1248 **.c = kdiff3
1248 **.jpg = myimgmerge
1249 **.jpg = myimgmerge
1249
1250
1250 ``merge-tools``
1251 ``merge-tools``
1251 ---------------
1252 ---------------
1252
1253
1253 This section configures external merge tools to use for file-level
1254 This section configures external merge tools to use for file-level
1254 merges. This section has likely been preconfigured at install time.
1255 merges. This section has likely been preconfigured at install time.
1255 Use :hg:`config merge-tools` to check the existing configuration.
1256 Use :hg:`config merge-tools` to check the existing configuration.
1256 Also see :hg:`help merge-tools` for more details.
1257 Also see :hg:`help merge-tools` for more details.
1257
1258
1258 Example ``~/.hgrc``::
1259 Example ``~/.hgrc``::
1259
1260
1260 [merge-tools]
1261 [merge-tools]
1261 # Override stock tool location
1262 # Override stock tool location
1262 kdiff3.executable = ~/bin/kdiff3
1263 kdiff3.executable = ~/bin/kdiff3
1263 # Specify command line
1264 # Specify command line
1264 kdiff3.args = $base $local $other -o $output
1265 kdiff3.args = $base $local $other -o $output
1265 # Give higher priority
1266 # Give higher priority
1266 kdiff3.priority = 1
1267 kdiff3.priority = 1
1267
1268
1268 # Changing the priority of preconfigured tool
1269 # Changing the priority of preconfigured tool
1269 meld.priority = 0
1270 meld.priority = 0
1270
1271
1271 # Disable a preconfigured tool
1272 # Disable a preconfigured tool
1272 vimdiff.disabled = yes
1273 vimdiff.disabled = yes
1273
1274
1274 # Define new tool
1275 # Define new tool
1275 myHtmlTool.args = -m $local $other $base $output
1276 myHtmlTool.args = -m $local $other $base $output
1276 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1277 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1277 myHtmlTool.priority = 1
1278 myHtmlTool.priority = 1
1278
1279
1279 Supported arguments:
1280 Supported arguments:
1280
1281
1281 ``priority``
1282 ``priority``
1282 The priority in which to evaluate this tool.
1283 The priority in which to evaluate this tool.
1283 (default: 0)
1284 (default: 0)
1284
1285
1285 ``executable``
1286 ``executable``
1286 Either just the name of the executable or its pathname.
1287 Either just the name of the executable or its pathname.
1287
1288
1288 .. container:: windows
1289 .. container:: windows
1289
1290
1290 On Windows, the path can use environment variables with ${ProgramFiles}
1291 On Windows, the path can use environment variables with ${ProgramFiles}
1291 syntax.
1292 syntax.
1292
1293
1293 (default: the tool name)
1294 (default: the tool name)
1294
1295
1295 ``args``
1296 ``args``
1296 The arguments to pass to the tool executable. You can refer to the
1297 The arguments to pass to the tool executable. You can refer to the
1297 files being merged as well as the output file through these
1298 files being merged as well as the output file through these
1298 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1299 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1299 of ``$local`` and ``$other`` can vary depending on which action is being
1300 of ``$local`` and ``$other`` can vary depending on which action is being
1300 performed. During and update or merge, ``$local`` represents the original
1301 performed. During and update or merge, ``$local`` represents the original
1301 state of the file, while ``$other`` represents the commit you are updating
1302 state of the file, while ``$other`` represents the commit you are updating
1302 to or the commit you are merging with. During a rebase ``$local``
1303 to or the commit you are merging with. During a rebase ``$local``
1303 represents the destination of the rebase, and ``$other`` represents the
1304 represents the destination of the rebase, and ``$other`` represents the
1304 commit being rebased.
1305 commit being rebased.
1305 (default: ``$local $base $other``)
1306 (default: ``$local $base $other``)
1306
1307
1307 ``premerge``
1308 ``premerge``
1308 Attempt to run internal non-interactive 3-way merge tool before
1309 Attempt to run internal non-interactive 3-way merge tool before
1309 launching external tool. Options are ``true``, ``false``, ``keep`` or
1310 launching external tool. Options are ``true``, ``false``, ``keep`` or
1310 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1311 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1311 premerge fails. The ``keep-merge3`` will do the same but include information
1312 premerge fails. The ``keep-merge3`` will do the same but include information
1312 about the base of the merge in the marker (see internal :merge3 in
1313 about the base of the merge in the marker (see internal :merge3 in
1313 :hg:`help merge-tools`).
1314 :hg:`help merge-tools`).
1314 (default: True)
1315 (default: True)
1315
1316
1316 ``binary``
1317 ``binary``
1317 This tool can merge binary files. (default: False, unless tool
1318 This tool can merge binary files. (default: False, unless tool
1318 was selected by file pattern match)
1319 was selected by file pattern match)
1319
1320
1320 ``symlink``
1321 ``symlink``
1321 This tool can merge symlinks. (default: False)
1322 This tool can merge symlinks. (default: False)
1322
1323
1323 ``check``
1324 ``check``
1324 A list of merge success-checking options:
1325 A list of merge success-checking options:
1325
1326
1326 ``changed``
1327 ``changed``
1327 Ask whether merge was successful when the merged file shows no changes.
1328 Ask whether merge was successful when the merged file shows no changes.
1328 ``conflicts``
1329 ``conflicts``
1329 Check whether there are conflicts even though the tool reported success.
1330 Check whether there are conflicts even though the tool reported success.
1330 ``prompt``
1331 ``prompt``
1331 Always prompt for merge success, regardless of success reported by tool.
1332 Always prompt for merge success, regardless of success reported by tool.
1332
1333
1333 ``fixeol``
1334 ``fixeol``
1334 Attempt to fix up EOL changes caused by the merge tool.
1335 Attempt to fix up EOL changes caused by the merge tool.
1335 (default: False)
1336 (default: False)
1336
1337
1337 ``gui``
1338 ``gui``
1338 This tool requires a graphical interface to run. (default: False)
1339 This tool requires a graphical interface to run. (default: False)
1339
1340
1340 .. container:: windows
1341 .. container:: windows
1341
1342
1342 ``regkey``
1343 ``regkey``
1343 Windows registry key which describes install location of this
1344 Windows registry key which describes install location of this
1344 tool. Mercurial will search for this key first under
1345 tool. Mercurial will search for this key first under
1345 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1346 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1346 (default: None)
1347 (default: None)
1347
1348
1348 ``regkeyalt``
1349 ``regkeyalt``
1349 An alternate Windows registry key to try if the first key is not
1350 An alternate Windows registry key to try if the first key is not
1350 found. The alternate key uses the same ``regname`` and ``regappend``
1351 found. The alternate key uses the same ``regname`` and ``regappend``
1351 semantics of the primary key. The most common use for this key
1352 semantics of the primary key. The most common use for this key
1352 is to search for 32bit applications on 64bit operating systems.
1353 is to search for 32bit applications on 64bit operating systems.
1353 (default: None)
1354 (default: None)
1354
1355
1355 ``regname``
1356 ``regname``
1356 Name of value to read from specified registry key.
1357 Name of value to read from specified registry key.
1357 (default: the unnamed (default) value)
1358 (default: the unnamed (default) value)
1358
1359
1359 ``regappend``
1360 ``regappend``
1360 String to append to the value read from the registry, typically
1361 String to append to the value read from the registry, typically
1361 the executable name of the tool.
1362 the executable name of the tool.
1362 (default: None)
1363 (default: None)
1363
1364
1364 ``pager``
1365 ``pager``
1365 ---------
1366 ---------
1366
1367
1367 Setting used to control when to paginate and with what external tool. See
1368 Setting used to control when to paginate and with what external tool. See
1368 :hg:`help pager` for details.
1369 :hg:`help pager` for details.
1369
1370
1370 ``pager``
1371 ``pager``
1371 Define the external tool used as pager.
1372 Define the external tool used as pager.
1372
1373
1373 If no pager is set, Mercurial uses the environment variable $PAGER.
1374 If no pager is set, Mercurial uses the environment variable $PAGER.
1374 If neither pager.pager, nor $PAGER is set, a default pager will be
1375 If neither pager.pager, nor $PAGER is set, a default pager will be
1375 used, typically `less` on Unix and `more` on Windows. Example::
1376 used, typically `less` on Unix and `more` on Windows. Example::
1376
1377
1377 [pager]
1378 [pager]
1378 pager = less -FRX
1379 pager = less -FRX
1379
1380
1380 ``ignore``
1381 ``ignore``
1381 List of commands to disable the pager for. Example::
1382 List of commands to disable the pager for. Example::
1382
1383
1383 [pager]
1384 [pager]
1384 ignore = version, help, update
1385 ignore = version, help, update
1385
1386
1386 ``patch``
1387 ``patch``
1387 ---------
1388 ---------
1388
1389
1389 Settings used when applying patches, for instance through the 'import'
1390 Settings used when applying patches, for instance through the 'import'
1390 command or with Mercurial Queues extension.
1391 command or with Mercurial Queues extension.
1391
1392
1392 ``eol``
1393 ``eol``
1393 When set to 'strict' patch content and patched files end of lines
1394 When set to 'strict' patch content and patched files end of lines
1394 are preserved. When set to ``lf`` or ``crlf``, both files end of
1395 are preserved. When set to ``lf`` or ``crlf``, both files end of
1395 lines are ignored when patching and the result line endings are
1396 lines are ignored when patching and the result line endings are
1396 normalized to either LF (Unix) or CRLF (Windows). When set to
1397 normalized to either LF (Unix) or CRLF (Windows). When set to
1397 ``auto``, end of lines are again ignored while patching but line
1398 ``auto``, end of lines are again ignored while patching but line
1398 endings in patched files are normalized to their original setting
1399 endings in patched files are normalized to their original setting
1399 on a per-file basis. If target file does not exist or has no end
1400 on a per-file basis. If target file does not exist or has no end
1400 of line, patch line endings are preserved.
1401 of line, patch line endings are preserved.
1401 (default: strict)
1402 (default: strict)
1402
1403
1403 ``fuzz``
1404 ``fuzz``
1404 The number of lines of 'fuzz' to allow when applying patches. This
1405 The number of lines of 'fuzz' to allow when applying patches. This
1405 controls how much context the patcher is allowed to ignore when
1406 controls how much context the patcher is allowed to ignore when
1406 trying to apply a patch.
1407 trying to apply a patch.
1407 (default: 2)
1408 (default: 2)
1408
1409
1409 ``paths``
1410 ``paths``
1410 ---------
1411 ---------
1411
1412
1412 Assigns symbolic names and behavior to repositories.
1413 Assigns symbolic names and behavior to repositories.
1413
1414
1414 Options are symbolic names defining the URL or directory that is the
1415 Options are symbolic names defining the URL or directory that is the
1415 location of the repository. Example::
1416 location of the repository. Example::
1416
1417
1417 [paths]
1418 [paths]
1418 my_server = https://example.com/my_repo
1419 my_server = https://example.com/my_repo
1419 local_path = /home/me/repo
1420 local_path = /home/me/repo
1420
1421
1421 These symbolic names can be used from the command line. To pull
1422 These symbolic names can be used from the command line. To pull
1422 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1423 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1423 :hg:`push local_path`.
1424 :hg:`push local_path`.
1424
1425
1425 Options containing colons (``:``) denote sub-options that can influence
1426 Options containing colons (``:``) denote sub-options that can influence
1426 behavior for that specific path. Example::
1427 behavior for that specific path. Example::
1427
1428
1428 [paths]
1429 [paths]
1429 my_server = https://example.com/my_path
1430 my_server = https://example.com/my_path
1430 my_server:pushurl = ssh://example.com/my_path
1431 my_server:pushurl = ssh://example.com/my_path
1431
1432
1432 The following sub-options can be defined:
1433 The following sub-options can be defined:
1433
1434
1434 ``pushurl``
1435 ``pushurl``
1435 The URL to use for push operations. If not defined, the location
1436 The URL to use for push operations. If not defined, the location
1436 defined by the path's main entry is used.
1437 defined by the path's main entry is used.
1437
1438
1438 ``pushrev``
1439 ``pushrev``
1439 A revset defining which revisions to push by default.
1440 A revset defining which revisions to push by default.
1440
1441
1441 When :hg:`push` is executed without a ``-r`` argument, the revset
1442 When :hg:`push` is executed without a ``-r`` argument, the revset
1442 defined by this sub-option is evaluated to determine what to push.
1443 defined by this sub-option is evaluated to determine what to push.
1443
1444
1444 For example, a value of ``.`` will push the working directory's
1445 For example, a value of ``.`` will push the working directory's
1445 revision by default.
1446 revision by default.
1446
1447
1447 Revsets specifying bookmarks will not result in the bookmark being
1448 Revsets specifying bookmarks will not result in the bookmark being
1448 pushed.
1449 pushed.
1449
1450
1450 The following special named paths exist:
1451 The following special named paths exist:
1451
1452
1452 ``default``
1453 ``default``
1453 The URL or directory to use when no source or remote is specified.
1454 The URL or directory to use when no source or remote is specified.
1454
1455
1455 :hg:`clone` will automatically define this path to the location the
1456 :hg:`clone` will automatically define this path to the location the
1456 repository was cloned from.
1457 repository was cloned from.
1457
1458
1458 ``default-push``
1459 ``default-push``
1459 (deprecated) The URL or directory for the default :hg:`push` location.
1460 (deprecated) The URL or directory for the default :hg:`push` location.
1460 ``default:pushurl`` should be used instead.
1461 ``default:pushurl`` should be used instead.
1461
1462
1462 ``phases``
1463 ``phases``
1463 ----------
1464 ----------
1464
1465
1465 Specifies default handling of phases. See :hg:`help phases` for more
1466 Specifies default handling of phases. See :hg:`help phases` for more
1466 information about working with phases.
1467 information about working with phases.
1467
1468
1468 ``publish``
1469 ``publish``
1469 Controls draft phase behavior when working as a server. When true,
1470 Controls draft phase behavior when working as a server. When true,
1470 pushed changesets are set to public in both client and server and
1471 pushed changesets are set to public in both client and server and
1471 pulled or cloned changesets are set to public in the client.
1472 pulled or cloned changesets are set to public in the client.
1472 (default: True)
1473 (default: True)
1473
1474
1474 ``new-commit``
1475 ``new-commit``
1475 Phase of newly-created commits.
1476 Phase of newly-created commits.
1476 (default: draft)
1477 (default: draft)
1477
1478
1478 ``checksubrepos``
1479 ``checksubrepos``
1479 Check the phase of the current revision of each subrepository. Allowed
1480 Check the phase of the current revision of each subrepository. Allowed
1480 values are "ignore", "follow" and "abort". For settings other than
1481 values are "ignore", "follow" and "abort". For settings other than
1481 "ignore", the phase of the current revision of each subrepository is
1482 "ignore", the phase of the current revision of each subrepository is
1482 checked before committing the parent repository. If any of those phases is
1483 checked before committing the parent repository. If any of those phases is
1483 greater than the phase of the parent repository (e.g. if a subrepo is in a
1484 greater than the phase of the parent repository (e.g. if a subrepo is in a
1484 "secret" phase while the parent repo is in "draft" phase), the commit is
1485 "secret" phase while the parent repo is in "draft" phase), the commit is
1485 either aborted (if checksubrepos is set to "abort") or the higher phase is
1486 either aborted (if checksubrepos is set to "abort") or the higher phase is
1486 used for the parent repository commit (if set to "follow").
1487 used for the parent repository commit (if set to "follow").
1487 (default: follow)
1488 (default: follow)
1488
1489
1489
1490
1490 ``profiling``
1491 ``profiling``
1491 -------------
1492 -------------
1492
1493
1493 Specifies profiling type, format, and file output. Two profilers are
1494 Specifies profiling type, format, and file output. Two profilers are
1494 supported: an instrumenting profiler (named ``ls``), and a sampling
1495 supported: an instrumenting profiler (named ``ls``), and a sampling
1495 profiler (named ``stat``).
1496 profiler (named ``stat``).
1496
1497
1497 In this section description, 'profiling data' stands for the raw data
1498 In this section description, 'profiling data' stands for the raw data
1498 collected during profiling, while 'profiling report' stands for a
1499 collected during profiling, while 'profiling report' stands for a
1499 statistical text report generated from the profiling data. The
1500 statistical text report generated from the profiling data. The
1500 profiling is done using lsprof.
1501 profiling is done using lsprof.
1501
1502
1502 ``enabled``
1503 ``enabled``
1503 Enable the profiler.
1504 Enable the profiler.
1504 (default: false)
1505 (default: false)
1505
1506
1506 This is equivalent to passing ``--profile`` on the command line.
1507 This is equivalent to passing ``--profile`` on the command line.
1507
1508
1508 ``type``
1509 ``type``
1509 The type of profiler to use.
1510 The type of profiler to use.
1510 (default: stat)
1511 (default: stat)
1511
1512
1512 ``ls``
1513 ``ls``
1513 Use Python's built-in instrumenting profiler. This profiler
1514 Use Python's built-in instrumenting profiler. This profiler
1514 works on all platforms, but each line number it reports is the
1515 works on all platforms, but each line number it reports is the
1515 first line of a function. This restriction makes it difficult to
1516 first line of a function. This restriction makes it difficult to
1516 identify the expensive parts of a non-trivial function.
1517 identify the expensive parts of a non-trivial function.
1517 ``stat``
1518 ``stat``
1518 Use a statistical profiler, statprof. This profiler is most
1519 Use a statistical profiler, statprof. This profiler is most
1519 useful for profiling commands that run for longer than about 0.1
1520 useful for profiling commands that run for longer than about 0.1
1520 seconds.
1521 seconds.
1521
1522
1522 ``format``
1523 ``format``
1523 Profiling format. Specific to the ``ls`` instrumenting profiler.
1524 Profiling format. Specific to the ``ls`` instrumenting profiler.
1524 (default: text)
1525 (default: text)
1525
1526
1526 ``text``
1527 ``text``
1527 Generate a profiling report. When saving to a file, it should be
1528 Generate a profiling report. When saving to a file, it should be
1528 noted that only the report is saved, and the profiling data is
1529 noted that only the report is saved, and the profiling data is
1529 not kept.
1530 not kept.
1530 ``kcachegrind``
1531 ``kcachegrind``
1531 Format profiling data for kcachegrind use: when saving to a
1532 Format profiling data for kcachegrind use: when saving to a
1532 file, the generated file can directly be loaded into
1533 file, the generated file can directly be loaded into
1533 kcachegrind.
1534 kcachegrind.
1534
1535
1535 ``statformat``
1536 ``statformat``
1536 Profiling format for the ``stat`` profiler.
1537 Profiling format for the ``stat`` profiler.
1537 (default: hotpath)
1538 (default: hotpath)
1538
1539
1539 ``hotpath``
1540 ``hotpath``
1540 Show a tree-based display containing the hot path of execution (where
1541 Show a tree-based display containing the hot path of execution (where
1541 most time was spent).
1542 most time was spent).
1542 ``bymethod``
1543 ``bymethod``
1543 Show a table of methods ordered by how frequently they are active.
1544 Show a table of methods ordered by how frequently they are active.
1544 ``byline``
1545 ``byline``
1545 Show a table of lines in files ordered by how frequently they are active.
1546 Show a table of lines in files ordered by how frequently they are active.
1546 ``json``
1547 ``json``
1547 Render profiling data as JSON.
1548 Render profiling data as JSON.
1548
1549
1549 ``frequency``
1550 ``frequency``
1550 Sampling frequency. Specific to the ``stat`` sampling profiler.
1551 Sampling frequency. Specific to the ``stat`` sampling profiler.
1551 (default: 1000)
1552 (default: 1000)
1552
1553
1553 ``output``
1554 ``output``
1554 File path where profiling data or report should be saved. If the
1555 File path where profiling data or report should be saved. If the
1555 file exists, it is replaced. (default: None, data is printed on
1556 file exists, it is replaced. (default: None, data is printed on
1556 stderr)
1557 stderr)
1557
1558
1558 ``sort``
1559 ``sort``
1559 Sort field. Specific to the ``ls`` instrumenting profiler.
1560 Sort field. Specific to the ``ls`` instrumenting profiler.
1560 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1561 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1561 ``inlinetime``.
1562 ``inlinetime``.
1562 (default: inlinetime)
1563 (default: inlinetime)
1563
1564
1564 ``limit``
1565 ``limit``
1565 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1566 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1566 (default: 30)
1567 (default: 30)
1567
1568
1568 ``nested``
1569 ``nested``
1569 Show at most this number of lines of drill-down info after each main entry.
1570 Show at most this number of lines of drill-down info after each main entry.
1570 This can help explain the difference between Total and Inline.
1571 This can help explain the difference between Total and Inline.
1571 Specific to the ``ls`` instrumenting profiler.
1572 Specific to the ``ls`` instrumenting profiler.
1572 (default: 5)
1573 (default: 5)
1573
1574
1574 ``progress``
1575 ``progress``
1575 ------------
1576 ------------
1576
1577
1577 Mercurial commands can draw progress bars that are as informative as
1578 Mercurial commands can draw progress bars that are as informative as
1578 possible. Some progress bars only offer indeterminate information, while others
1579 possible. Some progress bars only offer indeterminate information, while others
1579 have a definite end point.
1580 have a definite end point.
1580
1581
1581 ``delay``
1582 ``delay``
1582 Number of seconds (float) before showing the progress bar. (default: 3)
1583 Number of seconds (float) before showing the progress bar. (default: 3)
1583
1584
1584 ``changedelay``
1585 ``changedelay``
1585 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1586 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1586 that value will be used instead. (default: 1)
1587 that value will be used instead. (default: 1)
1587
1588
1588 ``refresh``
1589 ``refresh``
1589 Time in seconds between refreshes of the progress bar. (default: 0.1)
1590 Time in seconds between refreshes of the progress bar. (default: 0.1)
1590
1591
1591 ``format``
1592 ``format``
1592 Format of the progress bar.
1593 Format of the progress bar.
1593
1594
1594 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1595 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1595 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1596 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1596 last 20 characters of the item, but this can be changed by adding either
1597 last 20 characters of the item, but this can be changed by adding either
1597 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1598 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1598 first num characters.
1599 first num characters.
1599
1600
1600 (default: topic bar number estimate)
1601 (default: topic bar number estimate)
1601
1602
1602 ``width``
1603 ``width``
1603 If set, the maximum width of the progress information (that is, min(width,
1604 If set, the maximum width of the progress information (that is, min(width,
1604 term width) will be used).
1605 term width) will be used).
1605
1606
1606 ``clear-complete``
1607 ``clear-complete``
1607 Clear the progress bar after it's done. (default: True)
1608 Clear the progress bar after it's done. (default: True)
1608
1609
1609 ``disable``
1610 ``disable``
1610 If true, don't show a progress bar.
1611 If true, don't show a progress bar.
1611
1612
1612 ``assume-tty``
1613 ``assume-tty``
1613 If true, ALWAYS show a progress bar, unless disable is given.
1614 If true, ALWAYS show a progress bar, unless disable is given.
1614
1615
1615 ``rebase``
1616 ``rebase``
1616 ----------
1617 ----------
1617
1618
1618 ``allowdivergence``
1619 ``allowdivergence``
1619 Default to False, when True allow creating divergence when performing
1620 Default to False, when True allow creating divergence when performing
1620 rebase of obsolete changesets.
1621 rebase of obsolete changesets.
1621
1622
1622 ``revsetalias``
1623 ``revsetalias``
1623 ---------------
1624 ---------------
1624
1625
1625 Alias definitions for revsets. See :hg:`help revsets` for details.
1626 Alias definitions for revsets. See :hg:`help revsets` for details.
1626
1627
1627 ``server``
1628 ``server``
1628 ----------
1629 ----------
1629
1630
1630 Controls generic server settings.
1631 Controls generic server settings.
1631
1632
1632 ``compressionengines``
1633 ``compressionengines``
1633 List of compression engines and their relative priority to advertise
1634 List of compression engines and their relative priority to advertise
1634 to clients.
1635 to clients.
1635
1636
1636 The order of compression engines determines their priority, the first
1637 The order of compression engines determines their priority, the first
1637 having the highest priority. If a compression engine is not listed
1638 having the highest priority. If a compression engine is not listed
1638 here, it won't be advertised to clients.
1639 here, it won't be advertised to clients.
1639
1640
1640 If not set (the default), built-in defaults are used. Run
1641 If not set (the default), built-in defaults are used. Run
1641 :hg:`debuginstall` to list available compression engines and their
1642 :hg:`debuginstall` to list available compression engines and their
1642 default wire protocol priority.
1643 default wire protocol priority.
1643
1644
1644 Older Mercurial clients only support zlib compression and this setting
1645 Older Mercurial clients only support zlib compression and this setting
1645 has no effect for legacy clients.
1646 has no effect for legacy clients.
1646
1647
1647 ``uncompressed``
1648 ``uncompressed``
1648 Whether to allow clients to clone a repository using the
1649 Whether to allow clients to clone a repository using the
1649 uncompressed streaming protocol. This transfers about 40% more
1650 uncompressed streaming protocol. This transfers about 40% more
1650 data than a regular clone, but uses less memory and CPU on both
1651 data than a regular clone, but uses less memory and CPU on both
1651 server and client. Over a LAN (100 Mbps or better) or a very fast
1652 server and client. Over a LAN (100 Mbps or better) or a very fast
1652 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1653 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1653 regular clone. Over most WAN connections (anything slower than
1654 regular clone. Over most WAN connections (anything slower than
1654 about 6 Mbps), uncompressed streaming is slower, because of the
1655 about 6 Mbps), uncompressed streaming is slower, because of the
1655 extra data transfer overhead. This mode will also temporarily hold
1656 extra data transfer overhead. This mode will also temporarily hold
1656 the write lock while determining what data to transfer.
1657 the write lock while determining what data to transfer.
1657 (default: True)
1658 (default: True)
1658
1659
1659 ``preferuncompressed``
1660 ``preferuncompressed``
1660 When set, clients will try to use the uncompressed streaming
1661 When set, clients will try to use the uncompressed streaming
1661 protocol. (default: False)
1662 protocol. (default: False)
1662
1663
1663 ``validate``
1664 ``validate``
1664 Whether to validate the completeness of pushed changesets by
1665 Whether to validate the completeness of pushed changesets by
1665 checking that all new file revisions specified in manifests are
1666 checking that all new file revisions specified in manifests are
1666 present. (default: False)
1667 present. (default: False)
1667
1668
1668 ``maxhttpheaderlen``
1669 ``maxhttpheaderlen``
1669 Instruct HTTP clients not to send request headers longer than this
1670 Instruct HTTP clients not to send request headers longer than this
1670 many bytes. (default: 1024)
1671 many bytes. (default: 1024)
1671
1672
1672 ``bundle1``
1673 ``bundle1``
1673 Whether to allow clients to push and pull using the legacy bundle1
1674 Whether to allow clients to push and pull using the legacy bundle1
1674 exchange format. (default: True)
1675 exchange format. (default: True)
1675
1676
1676 ``bundle1gd``
1677 ``bundle1gd``
1677 Like ``bundle1`` but only used if the repository is using the
1678 Like ``bundle1`` but only used if the repository is using the
1678 *generaldelta* storage format. (default: True)
1679 *generaldelta* storage format. (default: True)
1679
1680
1680 ``bundle1.push``
1681 ``bundle1.push``
1681 Whether to allow clients to push using the legacy bundle1 exchange
1682 Whether to allow clients to push using the legacy bundle1 exchange
1682 format. (default: True)
1683 format. (default: True)
1683
1684
1684 ``bundle1gd.push``
1685 ``bundle1gd.push``
1685 Like ``bundle1.push`` but only used if the repository is using the
1686 Like ``bundle1.push`` but only used if the repository is using the
1686 *generaldelta* storage format. (default: True)
1687 *generaldelta* storage format. (default: True)
1687
1688
1688 ``bundle1.pull``
1689 ``bundle1.pull``
1689 Whether to allow clients to pull using the legacy bundle1 exchange
1690 Whether to allow clients to pull using the legacy bundle1 exchange
1690 format. (default: True)
1691 format. (default: True)
1691
1692
1692 ``bundle1gd.pull``
1693 ``bundle1gd.pull``
1693 Like ``bundle1.pull`` but only used if the repository is using the
1694 Like ``bundle1.pull`` but only used if the repository is using the
1694 *generaldelta* storage format. (default: True)
1695 *generaldelta* storage format. (default: True)
1695
1696
1696 Large repositories using the *generaldelta* storage format should
1697 Large repositories using the *generaldelta* storage format should
1697 consider setting this option because converting *generaldelta*
1698 consider setting this option because converting *generaldelta*
1698 repositories to the exchange format required by the bundle1 data
1699 repositories to the exchange format required by the bundle1 data
1699 format can consume a lot of CPU.
1700 format can consume a lot of CPU.
1700
1701
1701 ``zliblevel``
1702 ``zliblevel``
1702 Integer between ``-1`` and ``9`` that controls the zlib compression level
1703 Integer between ``-1`` and ``9`` that controls the zlib compression level
1703 for wire protocol commands that send zlib compressed output (notably the
1704 for wire protocol commands that send zlib compressed output (notably the
1704 commands that send repository history data).
1705 commands that send repository history data).
1705
1706
1706 The default (``-1``) uses the default zlib compression level, which is
1707 The default (``-1``) uses the default zlib compression level, which is
1707 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
1708 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
1708 maximum compression.
1709 maximum compression.
1709
1710
1710 Setting this option allows server operators to make trade-offs between
1711 Setting this option allows server operators to make trade-offs between
1711 bandwidth and CPU used. Lowering the compression lowers CPU utilization
1712 bandwidth and CPU used. Lowering the compression lowers CPU utilization
1712 but sends more bytes to clients.
1713 but sends more bytes to clients.
1713
1714
1714 This option only impacts the HTTP server.
1715 This option only impacts the HTTP server.
1715
1716
1716 ``zstdlevel``
1717 ``zstdlevel``
1717 Integer between ``1`` and ``22`` that controls the zstd compression level
1718 Integer between ``1`` and ``22`` that controls the zstd compression level
1718 for wire protocol commands. ``1`` is the minimal amount of compression and
1719 for wire protocol commands. ``1`` is the minimal amount of compression and
1719 ``22`` is the highest amount of compression.
1720 ``22`` is the highest amount of compression.
1720
1721
1721 The default (``3``) should be significantly faster than zlib while likely
1722 The default (``3``) should be significantly faster than zlib while likely
1722 delivering better compression ratios.
1723 delivering better compression ratios.
1723
1724
1724 This option only impacts the HTTP server.
1725 This option only impacts the HTTP server.
1725
1726
1726 See also ``server.zliblevel``.
1727 See also ``server.zliblevel``.
1727
1728
1728 ``smtp``
1729 ``smtp``
1729 --------
1730 --------
1730
1731
1731 Configuration for extensions that need to send email messages.
1732 Configuration for extensions that need to send email messages.
1732
1733
1733 ``host``
1734 ``host``
1734 Host name of mail server, e.g. "mail.example.com".
1735 Host name of mail server, e.g. "mail.example.com".
1735
1736
1736 ``port``
1737 ``port``
1737 Optional. Port to connect to on mail server. (default: 465 if
1738 Optional. Port to connect to on mail server. (default: 465 if
1738 ``tls`` is smtps; 25 otherwise)
1739 ``tls`` is smtps; 25 otherwise)
1739
1740
1740 ``tls``
1741 ``tls``
1741 Optional. Method to enable TLS when connecting to mail server: starttls,
1742 Optional. Method to enable TLS when connecting to mail server: starttls,
1742 smtps or none. (default: none)
1743 smtps or none. (default: none)
1743
1744
1744 ``username``
1745 ``username``
1745 Optional. User name for authenticating with the SMTP server.
1746 Optional. User name for authenticating with the SMTP server.
1746 (default: None)
1747 (default: None)
1747
1748
1748 ``password``
1749 ``password``
1749 Optional. Password for authenticating with the SMTP server. If not
1750 Optional. Password for authenticating with the SMTP server. If not
1750 specified, interactive sessions will prompt the user for a
1751 specified, interactive sessions will prompt the user for a
1751 password; non-interactive sessions will fail. (default: None)
1752 password; non-interactive sessions will fail. (default: None)
1752
1753
1753 ``local_hostname``
1754 ``local_hostname``
1754 Optional. The hostname that the sender can use to identify
1755 Optional. The hostname that the sender can use to identify
1755 itself to the MTA.
1756 itself to the MTA.
1756
1757
1757
1758
1758 ``subpaths``
1759 ``subpaths``
1759 ------------
1760 ------------
1760
1761
1761 Subrepository source URLs can go stale if a remote server changes name
1762 Subrepository source URLs can go stale if a remote server changes name
1762 or becomes temporarily unavailable. This section lets you define
1763 or becomes temporarily unavailable. This section lets you define
1763 rewrite rules of the form::
1764 rewrite rules of the form::
1764
1765
1765 <pattern> = <replacement>
1766 <pattern> = <replacement>
1766
1767
1767 where ``pattern`` is a regular expression matching a subrepository
1768 where ``pattern`` is a regular expression matching a subrepository
1768 source URL and ``replacement`` is the replacement string used to
1769 source URL and ``replacement`` is the replacement string used to
1769 rewrite it. Groups can be matched in ``pattern`` and referenced in
1770 rewrite it. Groups can be matched in ``pattern`` and referenced in
1770 ``replacements``. For instance::
1771 ``replacements``. For instance::
1771
1772
1772 http://server/(.*)-hg/ = http://hg.server/\1/
1773 http://server/(.*)-hg/ = http://hg.server/\1/
1773
1774
1774 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1775 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1775
1776
1776 Relative subrepository paths are first made absolute, and the
1777 Relative subrepository paths are first made absolute, and the
1777 rewrite rules are then applied on the full (absolute) path. If ``pattern``
1778 rewrite rules are then applied on the full (absolute) path. If ``pattern``
1778 doesn't match the full path, an attempt is made to apply it on the
1779 doesn't match the full path, an attempt is made to apply it on the
1779 relative path alone. The rules are applied in definition order.
1780 relative path alone. The rules are applied in definition order.
1780
1781
1781 ``templatealias``
1782 ``templatealias``
1782 -----------------
1783 -----------------
1783
1784
1784 Alias definitions for templates. See :hg:`help templates` for details.
1785 Alias definitions for templates. See :hg:`help templates` for details.
1785
1786
1786 ``templates``
1787 ``templates``
1787 -------------
1788 -------------
1788
1789
1789 Use the ``[templates]`` section to define template strings.
1790 Use the ``[templates]`` section to define template strings.
1790 See :hg:`help templates` for details.
1791 See :hg:`help templates` for details.
1791
1792
1792 ``trusted``
1793 ``trusted``
1793 -----------
1794 -----------
1794
1795
1795 Mercurial will not use the settings in the
1796 Mercurial will not use the settings in the
1796 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1797 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1797 user or to a trusted group, as various hgrc features allow arbitrary
1798 user or to a trusted group, as various hgrc features allow arbitrary
1798 commands to be run. This issue is often encountered when configuring
1799 commands to be run. This issue is often encountered when configuring
1799 hooks or extensions for shared repositories or servers. However,
1800 hooks or extensions for shared repositories or servers. However,
1800 the web interface will use some safe settings from the ``[web]``
1801 the web interface will use some safe settings from the ``[web]``
1801 section.
1802 section.
1802
1803
1803 This section specifies what users and groups are trusted. The
1804 This section specifies what users and groups are trusted. The
1804 current user is always trusted. To trust everybody, list a user or a
1805 current user is always trusted. To trust everybody, list a user or a
1805 group with name ``*``. These settings must be placed in an
1806 group with name ``*``. These settings must be placed in an
1806 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1807 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1807 user or service running Mercurial.
1808 user or service running Mercurial.
1808
1809
1809 ``users``
1810 ``users``
1810 Comma-separated list of trusted users.
1811 Comma-separated list of trusted users.
1811
1812
1812 ``groups``
1813 ``groups``
1813 Comma-separated list of trusted groups.
1814 Comma-separated list of trusted groups.
1814
1815
1815
1816
1816 ``ui``
1817 ``ui``
1817 ------
1818 ------
1818
1819
1819 User interface controls.
1820 User interface controls.
1820
1821
1821 ``archivemeta``
1822 ``archivemeta``
1822 Whether to include the .hg_archival.txt file containing meta data
1823 Whether to include the .hg_archival.txt file containing meta data
1823 (hashes for the repository base and for tip) in archives created
1824 (hashes for the repository base and for tip) in archives created
1824 by the :hg:`archive` command or downloaded via hgweb.
1825 by the :hg:`archive` command or downloaded via hgweb.
1825 (default: True)
1826 (default: True)
1826
1827
1827 ``askusername``
1828 ``askusername``
1828 Whether to prompt for a username when committing. If True, and
1829 Whether to prompt for a username when committing. If True, and
1829 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1830 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1830 be prompted to enter a username. If no username is entered, the
1831 be prompted to enter a username. If no username is entered, the
1831 default ``USER@HOST`` is used instead.
1832 default ``USER@HOST`` is used instead.
1832 (default: False)
1833 (default: False)
1833
1834
1834 ``clonebundles``
1835 ``clonebundles``
1835 Whether the "clone bundles" feature is enabled.
1836 Whether the "clone bundles" feature is enabled.
1836
1837
1837 When enabled, :hg:`clone` may download and apply a server-advertised
1838 When enabled, :hg:`clone` may download and apply a server-advertised
1838 bundle file from a URL instead of using the normal exchange mechanism.
1839 bundle file from a URL instead of using the normal exchange mechanism.
1839
1840
1840 This can likely result in faster and more reliable clones.
1841 This can likely result in faster and more reliable clones.
1841
1842
1842 (default: True)
1843 (default: True)
1843
1844
1844 ``clonebundlefallback``
1845 ``clonebundlefallback``
1845 Whether failure to apply an advertised "clone bundle" from a server
1846 Whether failure to apply an advertised "clone bundle" from a server
1846 should result in fallback to a regular clone.
1847 should result in fallback to a regular clone.
1847
1848
1848 This is disabled by default because servers advertising "clone
1849 This is disabled by default because servers advertising "clone
1849 bundles" often do so to reduce server load. If advertised bundles
1850 bundles" often do so to reduce server load. If advertised bundles
1850 start mass failing and clients automatically fall back to a regular
1851 start mass failing and clients automatically fall back to a regular
1851 clone, this would add significant and unexpected load to the server
1852 clone, this would add significant and unexpected load to the server
1852 since the server is expecting clone operations to be offloaded to
1853 since the server is expecting clone operations to be offloaded to
1853 pre-generated bundles. Failing fast (the default behavior) ensures
1854 pre-generated bundles. Failing fast (the default behavior) ensures
1854 clients don't overwhelm the server when "clone bundle" application
1855 clients don't overwhelm the server when "clone bundle" application
1855 fails.
1856 fails.
1856
1857
1857 (default: False)
1858 (default: False)
1858
1859
1859 ``clonebundleprefers``
1860 ``clonebundleprefers``
1860 Defines preferences for which "clone bundles" to use.
1861 Defines preferences for which "clone bundles" to use.
1861
1862
1862 Servers advertising "clone bundles" may advertise multiple available
1863 Servers advertising "clone bundles" may advertise multiple available
1863 bundles. Each bundle may have different attributes, such as the bundle
1864 bundles. Each bundle may have different attributes, such as the bundle
1864 type and compression format. This option is used to prefer a particular
1865 type and compression format. This option is used to prefer a particular
1865 bundle over another.
1866 bundle over another.
1866
1867
1867 The following keys are defined by Mercurial:
1868 The following keys are defined by Mercurial:
1868
1869
1869 BUNDLESPEC
1870 BUNDLESPEC
1870 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1871 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1871 e.g. ``gzip-v2`` or ``bzip2-v1``.
1872 e.g. ``gzip-v2`` or ``bzip2-v1``.
1872
1873
1873 COMPRESSION
1874 COMPRESSION
1874 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1875 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1875
1876
1876 Server operators may define custom keys.
1877 Server operators may define custom keys.
1877
1878
1878 Example values: ``COMPRESSION=bzip2``,
1879 Example values: ``COMPRESSION=bzip2``,
1879 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1880 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1880
1881
1881 By default, the first bundle advertised by the server is used.
1882 By default, the first bundle advertised by the server is used.
1882
1883
1883 ``color``
1884 ``color``
1884 When to colorize output. Possible value are Boolean ("yes" or "no"), or
1885 When to colorize output. Possible value are Boolean ("yes" or "no"), or
1885 "debug", or "always". (default: "yes"). "yes" will use color whenever it
1886 "debug", or "always". (default: "yes"). "yes" will use color whenever it
1886 seems possible. See :hg:`help color` for details.
1887 seems possible. See :hg:`help color` for details.
1887
1888
1888 ``commitsubrepos``
1889 ``commitsubrepos``
1889 Whether to commit modified subrepositories when committing the
1890 Whether to commit modified subrepositories when committing the
1890 parent repository. If False and one subrepository has uncommitted
1891 parent repository. If False and one subrepository has uncommitted
1891 changes, abort the commit.
1892 changes, abort the commit.
1892 (default: False)
1893 (default: False)
1893
1894
1894 ``debug``
1895 ``debug``
1895 Print debugging information. (default: False)
1896 Print debugging information. (default: False)
1896
1897
1897 ``editor``
1898 ``editor``
1898 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1899 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1899
1900
1900 ``fallbackencoding``
1901 ``fallbackencoding``
1901 Encoding to try if it's not possible to decode the changelog using
1902 Encoding to try if it's not possible to decode the changelog using
1902 UTF-8. (default: ISO-8859-1)
1903 UTF-8. (default: ISO-8859-1)
1903
1904
1904 ``graphnodetemplate``
1905 ``graphnodetemplate``
1905 The template used to print changeset nodes in an ASCII revision graph.
1906 The template used to print changeset nodes in an ASCII revision graph.
1906 (default: ``{graphnode}``)
1907 (default: ``{graphnode}``)
1907
1908
1908 ``ignore``
1909 ``ignore``
1909 A file to read per-user ignore patterns from. This file should be
1910 A file to read per-user ignore patterns from. This file should be
1910 in the same format as a repository-wide .hgignore file. Filenames
1911 in the same format as a repository-wide .hgignore file. Filenames
1911 are relative to the repository root. This option supports hook syntax,
1912 are relative to the repository root. This option supports hook syntax,
1912 so if you want to specify multiple ignore files, you can do so by
1913 so if you want to specify multiple ignore files, you can do so by
1913 setting something like ``ignore.other = ~/.hgignore2``. For details
1914 setting something like ``ignore.other = ~/.hgignore2``. For details
1914 of the ignore file format, see the ``hgignore(5)`` man page.
1915 of the ignore file format, see the ``hgignore(5)`` man page.
1915
1916
1916 ``interactive``
1917 ``interactive``
1917 Allow to prompt the user. (default: True)
1918 Allow to prompt the user. (default: True)
1918
1919
1919 ``interface``
1920 ``interface``
1920 Select the default interface for interactive features (default: text).
1921 Select the default interface for interactive features (default: text).
1921 Possible values are 'text' and 'curses'.
1922 Possible values are 'text' and 'curses'.
1922
1923
1923 ``interface.chunkselector``
1924 ``interface.chunkselector``
1924 Select the interface for change recording (e.g. :hg:`commit -i`).
1925 Select the interface for change recording (e.g. :hg:`commit -i`).
1925 Possible values are 'text' and 'curses'.
1926 Possible values are 'text' and 'curses'.
1926 This config overrides the interface specified by ui.interface.
1927 This config overrides the interface specified by ui.interface.
1927
1928
1928 ``logtemplate``
1929 ``logtemplate``
1929 Template string for commands that print changesets.
1930 Template string for commands that print changesets.
1930
1931
1931 ``merge``
1932 ``merge``
1932 The conflict resolution program to use during a manual merge.
1933 The conflict resolution program to use during a manual merge.
1933 For more information on merge tools see :hg:`help merge-tools`.
1934 For more information on merge tools see :hg:`help merge-tools`.
1934 For configuring merge tools see the ``[merge-tools]`` section.
1935 For configuring merge tools see the ``[merge-tools]`` section.
1935
1936
1936 ``mergemarkers``
1937 ``mergemarkers``
1937 Sets the merge conflict marker label styling. The ``detailed``
1938 Sets the merge conflict marker label styling. The ``detailed``
1938 style uses the ``mergemarkertemplate`` setting to style the labels.
1939 style uses the ``mergemarkertemplate`` setting to style the labels.
1939 The ``basic`` style just uses 'local' and 'other' as the marker label.
1940 The ``basic`` style just uses 'local' and 'other' as the marker label.
1940 One of ``basic`` or ``detailed``.
1941 One of ``basic`` or ``detailed``.
1941 (default: ``basic``)
1942 (default: ``basic``)
1942
1943
1943 ``mergemarkertemplate``
1944 ``mergemarkertemplate``
1944 The template used to print the commit description next to each conflict
1945 The template used to print the commit description next to each conflict
1945 marker during merge conflicts. See :hg:`help templates` for the template
1946 marker during merge conflicts. See :hg:`help templates` for the template
1946 format.
1947 format.
1947
1948
1948 Defaults to showing the hash, tags, branches, bookmarks, author, and
1949 Defaults to showing the hash, tags, branches, bookmarks, author, and
1949 the first line of the commit description.
1950 the first line of the commit description.
1950
1951
1951 If you use non-ASCII characters in names for tags, branches, bookmarks,
1952 If you use non-ASCII characters in names for tags, branches, bookmarks,
1952 authors, and/or commit descriptions, you must pay attention to encodings of
1953 authors, and/or commit descriptions, you must pay attention to encodings of
1953 managed files. At template expansion, non-ASCII characters use the encoding
1954 managed files. At template expansion, non-ASCII characters use the encoding
1954 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1955 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1955 environment variables that govern your locale. If the encoding of the merge
1956 environment variables that govern your locale. If the encoding of the merge
1956 markers is different from the encoding of the merged files,
1957 markers is different from the encoding of the merged files,
1957 serious problems may occur.
1958 serious problems may occur.
1958
1959
1959 ``origbackuppath``
1960 ``origbackuppath``
1960 The path to a directory used to store generated .orig files. If the path is
1961 The path to a directory used to store generated .orig files. If the path is
1961 not a directory, one will be created.
1962 not a directory, one will be created.
1962
1963
1963 ``paginate``
1964 ``paginate``
1964 Control the pagination of command output (default: True). See :hg:`help pager`
1965 Control the pagination of command output (default: True). See :hg:`help pager`
1965 for details.
1966 for details.
1966
1967
1967 ``patch``
1968 ``patch``
1968 An optional external tool that ``hg import`` and some extensions
1969 An optional external tool that ``hg import`` and some extensions
1969 will use for applying patches. By default Mercurial uses an
1970 will use for applying patches. By default Mercurial uses an
1970 internal patch utility. The external tool must work as the common
1971 internal patch utility. The external tool must work as the common
1971 Unix ``patch`` program. In particular, it must accept a ``-p``
1972 Unix ``patch`` program. In particular, it must accept a ``-p``
1972 argument to strip patch headers, a ``-d`` argument to specify the
1973 argument to strip patch headers, a ``-d`` argument to specify the
1973 current directory, a file name to patch, and a patch file to take
1974 current directory, a file name to patch, and a patch file to take
1974 from stdin.
1975 from stdin.
1975
1976
1976 It is possible to specify a patch tool together with extra
1977 It is possible to specify a patch tool together with extra
1977 arguments. For example, setting this option to ``patch --merge``
1978 arguments. For example, setting this option to ``patch --merge``
1978 will use the ``patch`` program with its 2-way merge option.
1979 will use the ``patch`` program with its 2-way merge option.
1979
1980
1980 ``portablefilenames``
1981 ``portablefilenames``
1981 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1982 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1982 (default: ``warn``)
1983 (default: ``warn``)
1983
1984
1984 ``warn``
1985 ``warn``
1985 Print a warning message on POSIX platforms, if a file with a non-portable
1986 Print a warning message on POSIX platforms, if a file with a non-portable
1986 filename is added (e.g. a file with a name that can't be created on
1987 filename is added (e.g. a file with a name that can't be created on
1987 Windows because it contains reserved parts like ``AUX``, reserved
1988 Windows because it contains reserved parts like ``AUX``, reserved
1988 characters like ``:``, or would cause a case collision with an existing
1989 characters like ``:``, or would cause a case collision with an existing
1989 file).
1990 file).
1990
1991
1991 ``ignore``
1992 ``ignore``
1992 Don't print a warning.
1993 Don't print a warning.
1993
1994
1994 ``abort``
1995 ``abort``
1995 The command is aborted.
1996 The command is aborted.
1996
1997
1997 ``true``
1998 ``true``
1998 Alias for ``warn``.
1999 Alias for ``warn``.
1999
2000
2000 ``false``
2001 ``false``
2001 Alias for ``ignore``.
2002 Alias for ``ignore``.
2002
2003
2003 .. container:: windows
2004 .. container:: windows
2004
2005
2005 On Windows, this configuration option is ignored and the command aborted.
2006 On Windows, this configuration option is ignored and the command aborted.
2006
2007
2007 ``quiet``
2008 ``quiet``
2008 Reduce the amount of output printed.
2009 Reduce the amount of output printed.
2009 (default: False)
2010 (default: False)
2010
2011
2011 ``remotecmd``
2012 ``remotecmd``
2012 Remote command to use for clone/push/pull operations.
2013 Remote command to use for clone/push/pull operations.
2013 (default: ``hg``)
2014 (default: ``hg``)
2014
2015
2015 ``report_untrusted``
2016 ``report_untrusted``
2016 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2017 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2017 trusted user or group.
2018 trusted user or group.
2018 (default: True)
2019 (default: True)
2019
2020
2020 ``slash``
2021 ``slash``
2021 Display paths using a slash (``/``) as the path separator. This
2022 Display paths using a slash (``/``) as the path separator. This
2022 only makes a difference on systems where the default path
2023 only makes a difference on systems where the default path
2023 separator is not the slash character (e.g. Windows uses the
2024 separator is not the slash character (e.g. Windows uses the
2024 backslash character (``\``)).
2025 backslash character (``\``)).
2025 (default: False)
2026 (default: False)
2026
2027
2027 ``statuscopies``
2028 ``statuscopies``
2028 Display copies in the status command.
2029 Display copies in the status command.
2029
2030
2030 ``ssh``
2031 ``ssh``
2031 Command to use for SSH connections. (default: ``ssh``)
2032 Command to use for SSH connections. (default: ``ssh``)
2032
2033
2033 ``strict``
2034 ``strict``
2034 Require exact command names, instead of allowing unambiguous
2035 Require exact command names, instead of allowing unambiguous
2035 abbreviations. (default: False)
2036 abbreviations. (default: False)
2036
2037
2037 ``style``
2038 ``style``
2038 Name of style to use for command output.
2039 Name of style to use for command output.
2039
2040
2040 ``supportcontact``
2041 ``supportcontact``
2041 A URL where users should report a Mercurial traceback. Use this if you are a
2042 A URL where users should report a Mercurial traceback. Use this if you are a
2042 large organisation with its own Mercurial deployment process and crash
2043 large organisation with its own Mercurial deployment process and crash
2043 reports should be addressed to your internal support.
2044 reports should be addressed to your internal support.
2044
2045
2045 ``textwidth``
2046 ``textwidth``
2046 Maximum width of help text. A longer line generated by ``hg help`` or
2047 Maximum width of help text. A longer line generated by ``hg help`` or
2047 ``hg subcommand --help`` will be broken after white space to get this
2048 ``hg subcommand --help`` will be broken after white space to get this
2048 width or the terminal width, whichever comes first.
2049 width or the terminal width, whichever comes first.
2049 A non-positive value will disable this and the terminal width will be
2050 A non-positive value will disable this and the terminal width will be
2050 used. (default: 78)
2051 used. (default: 78)
2051
2052
2052 ``timeout``
2053 ``timeout``
2053 The timeout used when a lock is held (in seconds), a negative value
2054 The timeout used when a lock is held (in seconds), a negative value
2054 means no timeout. (default: 600)
2055 means no timeout. (default: 600)
2055
2056
2056 ``traceback``
2057 ``traceback``
2057 Mercurial always prints a traceback when an unknown exception
2058 Mercurial always prints a traceback when an unknown exception
2058 occurs. Setting this to True will make Mercurial print a traceback
2059 occurs. Setting this to True will make Mercurial print a traceback
2059 on all exceptions, even those recognized by Mercurial (such as
2060 on all exceptions, even those recognized by Mercurial (such as
2060 IOError or MemoryError). (default: False)
2061 IOError or MemoryError). (default: False)
2061
2062
2062 ``username``
2063 ``username``
2063 The committer of a changeset created when running "commit".
2064 The committer of a changeset created when running "commit".
2064 Typically a person's name and email address, e.g. ``Fred Widget
2065 Typically a person's name and email address, e.g. ``Fred Widget
2065 <fred@example.com>``. Environment variables in the
2066 <fred@example.com>``. Environment variables in the
2066 username are expanded.
2067 username are expanded.
2067
2068
2068 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2069 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2069 hgrc is empty, e.g. if the system admin set ``username =`` in the
2070 hgrc is empty, e.g. if the system admin set ``username =`` in the
2070 system hgrc, it has to be specified manually or in a different
2071 system hgrc, it has to be specified manually or in a different
2071 hgrc file)
2072 hgrc file)
2072
2073
2073 ``verbose``
2074 ``verbose``
2074 Increase the amount of output printed. (default: False)
2075 Increase the amount of output printed. (default: False)
2075
2076
2076
2077
2077 ``web``
2078 ``web``
2078 -------
2079 -------
2079
2080
2080 Web interface configuration. The settings in this section apply to
2081 Web interface configuration. The settings in this section apply to
2081 both the builtin webserver (started by :hg:`serve`) and the script you
2082 both the builtin webserver (started by :hg:`serve`) and the script you
2082 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2083 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2083 and WSGI).
2084 and WSGI).
2084
2085
2085 The Mercurial webserver does no authentication (it does not prompt for
2086 The Mercurial webserver does no authentication (it does not prompt for
2086 usernames and passwords to validate *who* users are), but it does do
2087 usernames and passwords to validate *who* users are), but it does do
2087 authorization (it grants or denies access for *authenticated users*
2088 authorization (it grants or denies access for *authenticated users*
2088 based on settings in this section). You must either configure your
2089 based on settings in this section). You must either configure your
2089 webserver to do authentication for you, or disable the authorization
2090 webserver to do authentication for you, or disable the authorization
2090 checks.
2091 checks.
2091
2092
2092 For a quick setup in a trusted environment, e.g., a private LAN, where
2093 For a quick setup in a trusted environment, e.g., a private LAN, where
2093 you want it to accept pushes from anybody, you can use the following
2094 you want it to accept pushes from anybody, you can use the following
2094 command line::
2095 command line::
2095
2096
2096 $ hg --config web.allow_push=* --config web.push_ssl=False serve
2097 $ hg --config web.allow_push=* --config web.push_ssl=False serve
2097
2098
2098 Note that this will allow anybody to push anything to the server and
2099 Note that this will allow anybody to push anything to the server and
2099 that this should not be used for public servers.
2100 that this should not be used for public servers.
2100
2101
2101 The full set of options is:
2102 The full set of options is:
2102
2103
2103 ``accesslog``
2104 ``accesslog``
2104 Where to output the access log. (default: stdout)
2105 Where to output the access log. (default: stdout)
2105
2106
2106 ``address``
2107 ``address``
2107 Interface address to bind to. (default: all)
2108 Interface address to bind to. (default: all)
2108
2109
2109 ``allow_archive``
2110 ``allow_archive``
2110 List of archive format (bz2, gz, zip) allowed for downloading.
2111 List of archive format (bz2, gz, zip) allowed for downloading.
2111 (default: empty)
2112 (default: empty)
2112
2113
2113 ``allowbz2``
2114 ``allowbz2``
2114 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2115 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2115 revisions.
2116 revisions.
2116 (default: False)
2117 (default: False)
2117
2118
2118 ``allowgz``
2119 ``allowgz``
2119 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2120 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2120 revisions.
2121 revisions.
2121 (default: False)
2122 (default: False)
2122
2123
2123 ``allowpull``
2124 ``allowpull``
2124 Whether to allow pulling from the repository. (default: True)
2125 Whether to allow pulling from the repository. (default: True)
2125
2126
2126 ``allow_push``
2127 ``allow_push``
2127 Whether to allow pushing to the repository. If empty or not set,
2128 Whether to allow pushing to the repository. If empty or not set,
2128 pushing is not allowed. If the special value ``*``, any remote
2129 pushing is not allowed. If the special value ``*``, any remote
2129 user can push, including unauthenticated users. Otherwise, the
2130 user can push, including unauthenticated users. Otherwise, the
2130 remote user must have been authenticated, and the authenticated
2131 remote user must have been authenticated, and the authenticated
2131 user name must be present in this list. The contents of the
2132 user name must be present in this list. The contents of the
2132 allow_push list are examined after the deny_push list.
2133 allow_push list are examined after the deny_push list.
2133
2134
2134 ``allow_read``
2135 ``allow_read``
2135 If the user has not already been denied repository access due to
2136 If the user has not already been denied repository access due to
2136 the contents of deny_read, this list determines whether to grant
2137 the contents of deny_read, this list determines whether to grant
2137 repository access to the user. If this list is not empty, and the
2138 repository access to the user. If this list is not empty, and the
2138 user is unauthenticated or not present in the list, then access is
2139 user is unauthenticated or not present in the list, then access is
2139 denied for the user. If the list is empty or not set, then access
2140 denied for the user. If the list is empty or not set, then access
2140 is permitted to all users by default. Setting allow_read to the
2141 is permitted to all users by default. Setting allow_read to the
2141 special value ``*`` is equivalent to it not being set (i.e. access
2142 special value ``*`` is equivalent to it not being set (i.e. access
2142 is permitted to all users). The contents of the allow_read list are
2143 is permitted to all users). The contents of the allow_read list are
2143 examined after the deny_read list.
2144 examined after the deny_read list.
2144
2145
2145 ``allowzip``
2146 ``allowzip``
2146 (DEPRECATED) Whether to allow .zip downloading of repository
2147 (DEPRECATED) Whether to allow .zip downloading of repository
2147 revisions. This feature creates temporary files.
2148 revisions. This feature creates temporary files.
2148 (default: False)
2149 (default: False)
2149
2150
2150 ``archivesubrepos``
2151 ``archivesubrepos``
2151 Whether to recurse into subrepositories when archiving.
2152 Whether to recurse into subrepositories when archiving.
2152 (default: False)
2153 (default: False)
2153
2154
2154 ``baseurl``
2155 ``baseurl``
2155 Base URL to use when publishing URLs in other locations, so
2156 Base URL to use when publishing URLs in other locations, so
2156 third-party tools like email notification hooks can construct
2157 third-party tools like email notification hooks can construct
2157 URLs. Example: ``http://hgserver/repos/``.
2158 URLs. Example: ``http://hgserver/repos/``.
2158
2159
2159 ``cacerts``
2160 ``cacerts``
2160 Path to file containing a list of PEM encoded certificate
2161 Path to file containing a list of PEM encoded certificate
2161 authority certificates. Environment variables and ``~user``
2162 authority certificates. Environment variables and ``~user``
2162 constructs are expanded in the filename. If specified on the
2163 constructs are expanded in the filename. If specified on the
2163 client, then it will verify the identity of remote HTTPS servers
2164 client, then it will verify the identity of remote HTTPS servers
2164 with these certificates.
2165 with these certificates.
2165
2166
2166 To disable SSL verification temporarily, specify ``--insecure`` from
2167 To disable SSL verification temporarily, specify ``--insecure`` from
2167 command line.
2168 command line.
2168
2169
2169 You can use OpenSSL's CA certificate file if your platform has
2170 You can use OpenSSL's CA certificate file if your platform has
2170 one. On most Linux systems this will be
2171 one. On most Linux systems this will be
2171 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2172 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2172 generate this file manually. The form must be as follows::
2173 generate this file manually. The form must be as follows::
2173
2174
2174 -----BEGIN CERTIFICATE-----
2175 -----BEGIN CERTIFICATE-----
2175 ... (certificate in base64 PEM encoding) ...
2176 ... (certificate in base64 PEM encoding) ...
2176 -----END CERTIFICATE-----
2177 -----END CERTIFICATE-----
2177 -----BEGIN CERTIFICATE-----
2178 -----BEGIN CERTIFICATE-----
2178 ... (certificate in base64 PEM encoding) ...
2179 ... (certificate in base64 PEM encoding) ...
2179 -----END CERTIFICATE-----
2180 -----END CERTIFICATE-----
2180
2181
2181 ``cache``
2182 ``cache``
2182 Whether to support caching in hgweb. (default: True)
2183 Whether to support caching in hgweb. (default: True)
2183
2184
2184 ``certificate``
2185 ``certificate``
2185 Certificate to use when running :hg:`serve`.
2186 Certificate to use when running :hg:`serve`.
2186
2187
2187 ``collapse``
2188 ``collapse``
2188 With ``descend`` enabled, repositories in subdirectories are shown at
2189 With ``descend`` enabled, repositories in subdirectories are shown at
2189 a single level alongside repositories in the current path. With
2190 a single level alongside repositories in the current path. With
2190 ``collapse`` also enabled, repositories residing at a deeper level than
2191 ``collapse`` also enabled, repositories residing at a deeper level than
2191 the current path are grouped behind navigable directory entries that
2192 the current path are grouped behind navigable directory entries that
2192 lead to the locations of these repositories. In effect, this setting
2193 lead to the locations of these repositories. In effect, this setting
2193 collapses each collection of repositories found within a subdirectory
2194 collapses each collection of repositories found within a subdirectory
2194 into a single entry for that subdirectory. (default: False)
2195 into a single entry for that subdirectory. (default: False)
2195
2196
2196 ``comparisoncontext``
2197 ``comparisoncontext``
2197 Number of lines of context to show in side-by-side file comparison. If
2198 Number of lines of context to show in side-by-side file comparison. If
2198 negative or the value ``full``, whole files are shown. (default: 5)
2199 negative or the value ``full``, whole files are shown. (default: 5)
2199
2200
2200 This setting can be overridden by a ``context`` request parameter to the
2201 This setting can be overridden by a ``context`` request parameter to the
2201 ``comparison`` command, taking the same values.
2202 ``comparison`` command, taking the same values.
2202
2203
2203 ``contact``
2204 ``contact``
2204 Name or email address of the person in charge of the repository.
2205 Name or email address of the person in charge of the repository.
2205 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2206 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2206
2207
2207 ``csp``
2208 ``csp``
2208 Send a ``Content-Security-Policy`` HTTP header with this value.
2209 Send a ``Content-Security-Policy`` HTTP header with this value.
2209
2210
2210 The value may contain a special string ``%nonce%``, which will be replaced
2211 The value may contain a special string ``%nonce%``, which will be replaced
2211 by a randomly-generated one-time use value. If the value contains
2212 by a randomly-generated one-time use value. If the value contains
2212 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2213 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2213 one-time property of the nonce. This nonce will also be inserted into
2214 one-time property of the nonce. This nonce will also be inserted into
2214 ``<script>`` elements containing inline JavaScript.
2215 ``<script>`` elements containing inline JavaScript.
2215
2216
2216 Note: lots of HTML content sent by the server is derived from repository
2217 Note: lots of HTML content sent by the server is derived from repository
2217 data. Please consider the potential for malicious repository data to
2218 data. Please consider the potential for malicious repository data to
2218 "inject" itself into generated HTML content as part of your security
2219 "inject" itself into generated HTML content as part of your security
2219 threat model.
2220 threat model.
2220
2221
2221 ``deny_push``
2222 ``deny_push``
2222 Whether to deny pushing to the repository. If empty or not set,
2223 Whether to deny pushing to the repository. If empty or not set,
2223 push is not denied. If the special value ``*``, all remote users are
2224 push is not denied. If the special value ``*``, all remote users are
2224 denied push. Otherwise, unauthenticated users are all denied, and
2225 denied push. Otherwise, unauthenticated users are all denied, and
2225 any authenticated user name present in this list is also denied. The
2226 any authenticated user name present in this list is also denied. The
2226 contents of the deny_push list are examined before the allow_push list.
2227 contents of the deny_push list are examined before the allow_push list.
2227
2228
2228 ``deny_read``
2229 ``deny_read``
2229 Whether to deny reading/viewing of the repository. If this list is
2230 Whether to deny reading/viewing of the repository. If this list is
2230 not empty, unauthenticated users are all denied, and any
2231 not empty, unauthenticated users are all denied, and any
2231 authenticated user name present in this list is also denied access to
2232 authenticated user name present in this list is also denied access to
2232 the repository. If set to the special value ``*``, all remote users
2233 the repository. If set to the special value ``*``, all remote users
2233 are denied access (rarely needed ;). If deny_read is empty or not set,
2234 are denied access (rarely needed ;). If deny_read is empty or not set,
2234 the determination of repository access depends on the presence and
2235 the determination of repository access depends on the presence and
2235 content of the allow_read list (see description). If both
2236 content of the allow_read list (see description). If both
2236 deny_read and allow_read are empty or not set, then access is
2237 deny_read and allow_read are empty or not set, then access is
2237 permitted to all users by default. If the repository is being
2238 permitted to all users by default. If the repository is being
2238 served via hgwebdir, denied users will not be able to see it in
2239 served via hgwebdir, denied users will not be able to see it in
2239 the list of repositories. The contents of the deny_read list have
2240 the list of repositories. The contents of the deny_read list have
2240 priority over (are examined before) the contents of the allow_read
2241 priority over (are examined before) the contents of the allow_read
2241 list.
2242 list.
2242
2243
2243 ``descend``
2244 ``descend``
2244 hgwebdir indexes will not descend into subdirectories. Only repositories
2245 hgwebdir indexes will not descend into subdirectories. Only repositories
2245 directly in the current path will be shown (other repositories are still
2246 directly in the current path will be shown (other repositories are still
2246 available from the index corresponding to their containing path).
2247 available from the index corresponding to their containing path).
2247
2248
2248 ``description``
2249 ``description``
2249 Textual description of the repository's purpose or contents.
2250 Textual description of the repository's purpose or contents.
2250 (default: "unknown")
2251 (default: "unknown")
2251
2252
2252 ``encoding``
2253 ``encoding``
2253 Character encoding name. (default: the current locale charset)
2254 Character encoding name. (default: the current locale charset)
2254 Example: "UTF-8".
2255 Example: "UTF-8".
2255
2256
2256 ``errorlog``
2257 ``errorlog``
2257 Where to output the error log. (default: stderr)
2258 Where to output the error log. (default: stderr)
2258
2259
2259 ``guessmime``
2260 ``guessmime``
2260 Control MIME types for raw download of file content.
2261 Control MIME types for raw download of file content.
2261 Set to True to let hgweb guess the content type from the file
2262 Set to True to let hgweb guess the content type from the file
2262 extension. This will serve HTML files as ``text/html`` and might
2263 extension. This will serve HTML files as ``text/html`` and might
2263 allow cross-site scripting attacks when serving untrusted
2264 allow cross-site scripting attacks when serving untrusted
2264 repositories. (default: False)
2265 repositories. (default: False)
2265
2266
2266 ``hidden``
2267 ``hidden``
2267 Whether to hide the repository in the hgwebdir index.
2268 Whether to hide the repository in the hgwebdir index.
2268 (default: False)
2269 (default: False)
2269
2270
2270 ``ipv6``
2271 ``ipv6``
2271 Whether to use IPv6. (default: False)
2272 Whether to use IPv6. (default: False)
2272
2273
2273 ``labels``
2274 ``labels``
2274 List of string *labels* associated with the repository.
2275 List of string *labels* associated with the repository.
2275
2276
2276 Labels are exposed as a template keyword and can be used to customize
2277 Labels are exposed as a template keyword and can be used to customize
2277 output. e.g. the ``index`` template can group or filter repositories
2278 output. e.g. the ``index`` template can group or filter repositories
2278 by labels and the ``summary`` template can display additional content
2279 by labels and the ``summary`` template can display additional content
2279 if a specific label is present.
2280 if a specific label is present.
2280
2281
2281 ``logoimg``
2282 ``logoimg``
2282 File name of the logo image that some templates display on each page.
2283 File name of the logo image that some templates display on each page.
2283 The file name is relative to ``staticurl``. That is, the full path to
2284 The file name is relative to ``staticurl``. That is, the full path to
2284 the logo image is "staticurl/logoimg".
2285 the logo image is "staticurl/logoimg".
2285 If unset, ``hglogo.png`` will be used.
2286 If unset, ``hglogo.png`` will be used.
2286
2287
2287 ``logourl``
2288 ``logourl``
2288 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2289 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2289 will be used.
2290 will be used.
2290
2291
2291 ``maxchanges``
2292 ``maxchanges``
2292 Maximum number of changes to list on the changelog. (default: 10)
2293 Maximum number of changes to list on the changelog. (default: 10)
2293
2294
2294 ``maxfiles``
2295 ``maxfiles``
2295 Maximum number of files to list per changeset. (default: 10)
2296 Maximum number of files to list per changeset. (default: 10)
2296
2297
2297 ``maxshortchanges``
2298 ``maxshortchanges``
2298 Maximum number of changes to list on the shortlog, graph or filelog
2299 Maximum number of changes to list on the shortlog, graph or filelog
2299 pages. (default: 60)
2300 pages. (default: 60)
2300
2301
2301 ``name``
2302 ``name``
2302 Repository name to use in the web interface.
2303 Repository name to use in the web interface.
2303 (default: current working directory)
2304 (default: current working directory)
2304
2305
2305 ``port``
2306 ``port``
2306 Port to listen on. (default: 8000)
2307 Port to listen on. (default: 8000)
2307
2308
2308 ``prefix``
2309 ``prefix``
2309 Prefix path to serve from. (default: '' (server root))
2310 Prefix path to serve from. (default: '' (server root))
2310
2311
2311 ``push_ssl``
2312 ``push_ssl``
2312 Whether to require that inbound pushes be transported over SSL to
2313 Whether to require that inbound pushes be transported over SSL to
2313 prevent password sniffing. (default: True)
2314 prevent password sniffing. (default: True)
2314
2315
2315 ``refreshinterval``
2316 ``refreshinterval``
2316 How frequently directory listings re-scan the filesystem for new
2317 How frequently directory listings re-scan the filesystem for new
2317 repositories, in seconds. This is relevant when wildcards are used
2318 repositories, in seconds. This is relevant when wildcards are used
2318 to define paths. Depending on how much filesystem traversal is
2319 to define paths. Depending on how much filesystem traversal is
2319 required, refreshing may negatively impact performance.
2320 required, refreshing may negatively impact performance.
2320
2321
2321 Values less than or equal to 0 always refresh.
2322 Values less than or equal to 0 always refresh.
2322 (default: 20)
2323 (default: 20)
2323
2324
2324 ``staticurl``
2325 ``staticurl``
2325 Base URL to use for static files. If unset, static files (e.g. the
2326 Base URL to use for static files. If unset, static files (e.g. the
2326 hgicon.png favicon) will be served by the CGI script itself. Use
2327 hgicon.png favicon) will be served by the CGI script itself. Use
2327 this setting to serve them directly with the HTTP server.
2328 this setting to serve them directly with the HTTP server.
2328 Example: ``http://hgserver/static/``.
2329 Example: ``http://hgserver/static/``.
2329
2330
2330 ``stripes``
2331 ``stripes``
2331 How many lines a "zebra stripe" should span in multi-line output.
2332 How many lines a "zebra stripe" should span in multi-line output.
2332 Set to 0 to disable. (default: 1)
2333 Set to 0 to disable. (default: 1)
2333
2334
2334 ``style``
2335 ``style``
2335 Which template map style to use. The available options are the names of
2336 Which template map style to use. The available options are the names of
2336 subdirectories in the HTML templates path. (default: ``paper``)
2337 subdirectories in the HTML templates path. (default: ``paper``)
2337 Example: ``monoblue``.
2338 Example: ``monoblue``.
2338
2339
2339 ``templates``
2340 ``templates``
2340 Where to find the HTML templates. The default path to the HTML templates
2341 Where to find the HTML templates. The default path to the HTML templates
2341 can be obtained from ``hg debuginstall``.
2342 can be obtained from ``hg debuginstall``.
2342
2343
2343 ``websub``
2344 ``websub``
2344 ----------
2345 ----------
2345
2346
2346 Web substitution filter definition. You can use this section to
2347 Web substitution filter definition. You can use this section to
2347 define a set of regular expression substitution patterns which
2348 define a set of regular expression substitution patterns which
2348 let you automatically modify the hgweb server output.
2349 let you automatically modify the hgweb server output.
2349
2350
2350 The default hgweb templates only apply these substitution patterns
2351 The default hgweb templates only apply these substitution patterns
2351 on the revision description fields. You can apply them anywhere
2352 on the revision description fields. You can apply them anywhere
2352 you want when you create your own templates by adding calls to the
2353 you want when you create your own templates by adding calls to the
2353 "websub" filter (usually after calling the "escape" filter).
2354 "websub" filter (usually after calling the "escape" filter).
2354
2355
2355 This can be used, for example, to convert issue references to links
2356 This can be used, for example, to convert issue references to links
2356 to your issue tracker, or to convert "markdown-like" syntax into
2357 to your issue tracker, or to convert "markdown-like" syntax into
2357 HTML (see the examples below).
2358 HTML (see the examples below).
2358
2359
2359 Each entry in this section names a substitution filter.
2360 Each entry in this section names a substitution filter.
2360 The value of each entry defines the substitution expression itself.
2361 The value of each entry defines the substitution expression itself.
2361 The websub expressions follow the old interhg extension syntax,
2362 The websub expressions follow the old interhg extension syntax,
2362 which in turn imitates the Unix sed replacement syntax::
2363 which in turn imitates the Unix sed replacement syntax::
2363
2364
2364 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2365 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2365
2366
2366 You can use any separator other than "/". The final "i" is optional
2367 You can use any separator other than "/". The final "i" is optional
2367 and indicates that the search must be case insensitive.
2368 and indicates that the search must be case insensitive.
2368
2369
2369 Examples::
2370 Examples::
2370
2371
2371 [websub]
2372 [websub]
2372 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2373 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2373 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2374 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2374 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2375 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2375
2376
2376 ``worker``
2377 ``worker``
2377 ----------
2378 ----------
2378
2379
2379 Parallel master/worker configuration. We currently perform working
2380 Parallel master/worker configuration. We currently perform working
2380 directory updates in parallel on Unix-like systems, which greatly
2381 directory updates in parallel on Unix-like systems, which greatly
2381 helps performance.
2382 helps performance.
2382
2383
2383 ``numcpus``
2384 ``numcpus``
2384 Number of CPUs to use for parallel operations. A zero or
2385 Number of CPUs to use for parallel operations. A zero or
2385 negative value is treated as ``use the default``.
2386 negative value is treated as ``use the default``.
2386 (default: 4 or the number of CPUs on the system, whichever is larger)
2387 (default: 4 or the number of CPUs on the system, whichever is larger)
2387
2388
2388 ``backgroundclose``
2389 ``backgroundclose``
2389 Whether to enable closing file handles on background threads during certain
2390 Whether to enable closing file handles on background threads during certain
2390 operations. Some platforms aren't very efficient at closing file
2391 operations. Some platforms aren't very efficient at closing file
2391 handles that have been written or appended to. By performing file closing
2392 handles that have been written or appended to. By performing file closing
2392 on background threads, file write rate can increase substantially.
2393 on background threads, file write rate can increase substantially.
2393 (default: true on Windows, false elsewhere)
2394 (default: true on Windows, false elsewhere)
2394
2395
2395 ``backgroundcloseminfilecount``
2396 ``backgroundcloseminfilecount``
2396 Minimum number of files required to trigger background file closing.
2397 Minimum number of files required to trigger background file closing.
2397 Operations not writing this many files won't start background close
2398 Operations not writing this many files won't start background close
2398 threads.
2399 threads.
2399 (default: 2048)
2400 (default: 2048)
2400
2401
2401 ``backgroundclosemaxqueue``
2402 ``backgroundclosemaxqueue``
2402 The maximum number of opened file handles waiting to be closed in the
2403 The maximum number of opened file handles waiting to be closed in the
2403 background. This option only has an effect if ``backgroundclose`` is
2404 background. This option only has an effect if ``backgroundclose`` is
2404 enabled.
2405 enabled.
2405 (default: 384)
2406 (default: 384)
2406
2407
2407 ``backgroundclosethreadcount``
2408 ``backgroundclosethreadcount``
2408 Number of threads to process background file closes. Only relevant if
2409 Number of threads to process background file closes. Only relevant if
2409 ``backgroundclose`` is enabled.
2410 ``backgroundclose`` is enabled.
2410 (default: 4)
2411 (default: 4)
General Comments 0
You need to be logged in to leave comments. Login now