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