##// END OF EJS Templates
help: correct config.profiling.freq name (frequency->freq)...
Kyle Lippincott -
r48580:1a174f12 stable
parent child Browse files
Show More
@@ -1,3093 +1,3093
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.slow-path` 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 To accomodate install of Mercurial without the fast implementation you can
916 To accomodate install of Mercurial without the fast implementation you can
917 downgrade your repository. To do so run the following command:
917 downgrade your repository. To do so run the following command:
918
918
919 $ hg debugupgraderepo \
919 $ hg debugupgraderepo \
920 --run \
920 --run \
921 --config format.use-persistent-nodemap=False \
921 --config format.use-persistent-nodemap=False \
922 --config storage.revlog.persistent-nodemap.slow-path=allow
922 --config storage.revlog.persistent-nodemap.slow-path=allow
923
923
924 ``use-share-safe``
924 ``use-share-safe``
925 Enforce "safe" behaviors for all "shares" that access this repository.
925 Enforce "safe" behaviors for all "shares" that access this repository.
926
926
927 With this feature, "shares" using this repository as a source will:
927 With this feature, "shares" using this repository as a source will:
928
928
929 * read the source repository's configuration (`<source>/.hg/hgrc`).
929 * read the source repository's configuration (`<source>/.hg/hgrc`).
930 * read and use the source repository's "requirements"
930 * read and use the source repository's "requirements"
931 (except the working copy specific one).
931 (except the working copy specific one).
932
932
933 Without this feature, "shares" using this repository as a source will:
933 Without this feature, "shares" using this repository as a source will:
934
934
935 * keep tracking the repository "requirements" in the share only, ignoring
935 * keep tracking the repository "requirements" in the share only, ignoring
936 the source "requirements", possibly diverging from them.
936 the source "requirements", possibly diverging from them.
937 * ignore source repository config. This can create problems, like silently
937 * ignore source repository config. This can create problems, like silently
938 ignoring important hooks.
938 ignoring important hooks.
939
939
940 Beware that existing shares will not be upgraded/downgraded, and by
940 Beware that existing shares will not be upgraded/downgraded, and by
941 default, Mercurial will refuse to interact with them until the mismatch
941 default, Mercurial will refuse to interact with them until the mismatch
942 is resolved. See :hg:`help config share.safe-mismatch.source-safe` and
942 is resolved. See :hg:`help config share.safe-mismatch.source-safe` and
943 :hg:`help config share.safe-mismatch.source-not-safe` for details.
943 :hg:`help config share.safe-mismatch.source-not-safe` for details.
944
944
945 Introduced in Mercurial 5.7.
945 Introduced in Mercurial 5.7.
946
946
947 Disabled by default.
947 Disabled by default.
948
948
949 ``usestore``
949 ``usestore``
950 Enable or disable the "store" repository format which improves
950 Enable or disable the "store" repository format which improves
951 compatibility with systems that fold case or otherwise mangle
951 compatibility with systems that fold case or otherwise mangle
952 filenames. Disabling this option will allow you to store longer filenames
952 filenames. Disabling this option will allow you to store longer filenames
953 in some situations at the expense of compatibility.
953 in some situations at the expense of compatibility.
954
954
955 Repositories with this on-disk format require Mercurial version 0.9.4.
955 Repositories with this on-disk format require Mercurial version 0.9.4.
956
956
957 Enabled by default.
957 Enabled by default.
958
958
959 ``sparse-revlog``
959 ``sparse-revlog``
960 Enable or disable the ``sparse-revlog`` delta strategy. This format improves
960 Enable or disable the ``sparse-revlog`` delta strategy. This format improves
961 delta re-use inside revlog. For very branchy repositories, it results in a
961 delta re-use inside revlog. For very branchy repositories, it results in a
962 smaller store. For repositories with many revisions, it also helps
962 smaller store. For repositories with many revisions, it also helps
963 performance (by using shortened delta chains.)
963 performance (by using shortened delta chains.)
964
964
965 Repositories with this on-disk format require Mercurial version 4.7
965 Repositories with this on-disk format require Mercurial version 4.7
966
966
967 Enabled by default.
967 Enabled by default.
968
968
969 ``revlog-compression``
969 ``revlog-compression``
970 Compression algorithm used by revlog. Supported values are `zlib` and
970 Compression algorithm used by revlog. Supported values are `zlib` and
971 `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
971 `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
972 a newer format that is usually a net win over `zlib`, operating faster at
972 a newer format that is usually a net win over `zlib`, operating faster at
973 better compression rates. Use `zstd` to reduce CPU usage. Multiple values
973 better compression rates. Use `zstd` to reduce CPU usage. Multiple values
974 can be specified, the first available one will be used.
974 can be specified, the first available one will be used.
975
975
976 On some systems, the Mercurial installation may lack `zstd` support.
976 On some systems, the Mercurial installation may lack `zstd` support.
977
977
978 Default is `zstd` if available, `zlib` otherwise.
978 Default is `zstd` if available, `zlib` otherwise.
979
979
980 ``bookmarks-in-store``
980 ``bookmarks-in-store``
981 Store bookmarks in .hg/store/. This means that bookmarks are shared when
981 Store bookmarks in .hg/store/. This means that bookmarks are shared when
982 using `hg share` regardless of the `-B` option.
982 using `hg share` regardless of the `-B` option.
983
983
984 Repositories with this on-disk format require Mercurial version 5.1.
984 Repositories with this on-disk format require Mercurial version 5.1.
985
985
986 Disabled by default.
986 Disabled by default.
987
987
988
988
989 ``graph``
989 ``graph``
990 ---------
990 ---------
991
991
992 Web graph view configuration. This section let you change graph
992 Web graph view configuration. This section let you change graph
993 elements display properties by branches, for instance to make the
993 elements display properties by branches, for instance to make the
994 ``default`` branch stand out.
994 ``default`` branch stand out.
995
995
996 Each line has the following format::
996 Each line has the following format::
997
997
998 <branch>.<argument> = <value>
998 <branch>.<argument> = <value>
999
999
1000 where ``<branch>`` is the name of the branch being
1000 where ``<branch>`` is the name of the branch being
1001 customized. Example::
1001 customized. Example::
1002
1002
1003 [graph]
1003 [graph]
1004 # 2px width
1004 # 2px width
1005 default.width = 2
1005 default.width = 2
1006 # red color
1006 # red color
1007 default.color = FF0000
1007 default.color = FF0000
1008
1008
1009 Supported arguments:
1009 Supported arguments:
1010
1010
1011 ``width``
1011 ``width``
1012 Set branch edges width in pixels.
1012 Set branch edges width in pixels.
1013
1013
1014 ``color``
1014 ``color``
1015 Set branch edges color in hexadecimal RGB notation.
1015 Set branch edges color in hexadecimal RGB notation.
1016
1016
1017 ``hooks``
1017 ``hooks``
1018 ---------
1018 ---------
1019
1019
1020 Commands or Python functions that get automatically executed by
1020 Commands or Python functions that get automatically executed by
1021 various actions such as starting or finishing a commit. Multiple
1021 various actions such as starting or finishing a commit. Multiple
1022 hooks can be run for the same action by appending a suffix to the
1022 hooks can be run for the same action by appending a suffix to the
1023 action. Overriding a site-wide hook can be done by changing its
1023 action. Overriding a site-wide hook can be done by changing its
1024 value or setting it to an empty string. Hooks can be prioritized
1024 value or setting it to an empty string. Hooks can be prioritized
1025 by adding a prefix of ``priority.`` to the hook name on a new line
1025 by adding a prefix of ``priority.`` to the hook name on a new line
1026 and setting the priority. The default priority is 0.
1026 and setting the priority. The default priority is 0.
1027
1027
1028 Example ``.hg/hgrc``::
1028 Example ``.hg/hgrc``::
1029
1029
1030 [hooks]
1030 [hooks]
1031 # update working directory after adding changesets
1031 # update working directory after adding changesets
1032 changegroup.update = hg update
1032 changegroup.update = hg update
1033 # do not use the site-wide hook
1033 # do not use the site-wide hook
1034 incoming =
1034 incoming =
1035 incoming.email = /my/email/hook
1035 incoming.email = /my/email/hook
1036 incoming.autobuild = /my/build/hook
1036 incoming.autobuild = /my/build/hook
1037 # force autobuild hook to run before other incoming hooks
1037 # force autobuild hook to run before other incoming hooks
1038 priority.incoming.autobuild = 1
1038 priority.incoming.autobuild = 1
1039 ### control HGPLAIN setting when running autobuild hook
1039 ### control HGPLAIN setting when running autobuild hook
1040 # HGPLAIN always set (default from Mercurial 5.7)
1040 # HGPLAIN always set (default from Mercurial 5.7)
1041 incoming.autobuild:run-with-plain = yes
1041 incoming.autobuild:run-with-plain = yes
1042 # HGPLAIN never set
1042 # HGPLAIN never set
1043 incoming.autobuild:run-with-plain = no
1043 incoming.autobuild:run-with-plain = no
1044 # HGPLAIN inherited from environment (default before Mercurial 5.7)
1044 # HGPLAIN inherited from environment (default before Mercurial 5.7)
1045 incoming.autobuild:run-with-plain = auto
1045 incoming.autobuild:run-with-plain = auto
1046
1046
1047 Most hooks are run with environment variables set that give useful
1047 Most hooks are run with environment variables set that give useful
1048 additional information. For each hook below, the environment variables
1048 additional information. For each hook below, the environment variables
1049 it is passed are listed with names in the form ``$HG_foo``. The
1049 it is passed are listed with names in the form ``$HG_foo``. The
1050 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
1050 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
1051 They contain the type of hook which triggered the run and the full name
1051 They contain the type of hook which triggered the run and the full name
1052 of the hook in the config, respectively. In the example above, this will
1052 of the hook in the config, respectively. In the example above, this will
1053 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
1053 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
1054
1054
1055 .. container:: windows
1055 .. container:: windows
1056
1056
1057 Some basic Unix syntax can be enabled for portability, including ``$VAR``
1057 Some basic Unix syntax can be enabled for portability, including ``$VAR``
1058 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
1058 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
1059 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
1059 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
1060 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
1060 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
1061 slash or inside of a strong quote. Strong quotes will be replaced by
1061 slash or inside of a strong quote. Strong quotes will be replaced by
1062 double quotes after processing.
1062 double quotes after processing.
1063
1063
1064 This feature is enabled by adding a prefix of ``tonative.`` to the hook
1064 This feature is enabled by adding a prefix of ``tonative.`` to the hook
1065 name on a new line, and setting it to ``True``. For example::
1065 name on a new line, and setting it to ``True``. For example::
1066
1066
1067 [hooks]
1067 [hooks]
1068 incoming.autobuild = /my/build/hook
1068 incoming.autobuild = /my/build/hook
1069 # enable translation to cmd.exe syntax for autobuild hook
1069 # enable translation to cmd.exe syntax for autobuild hook
1070 tonative.incoming.autobuild = True
1070 tonative.incoming.autobuild = True
1071
1071
1072 ``changegroup``
1072 ``changegroup``
1073 Run after a changegroup has been added via push, pull or unbundle. The ID of
1073 Run after a changegroup has been added via push, pull or unbundle. The ID of
1074 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
1074 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
1075 The URL from which changes came is in ``$HG_URL``.
1075 The URL from which changes came is in ``$HG_URL``.
1076
1076
1077 ``commit``
1077 ``commit``
1078 Run after a changeset has been created in the local repository. The ID
1078 Run after a changeset has been created in the local repository. The ID
1079 of the newly created changeset is in ``$HG_NODE``. Parent changeset
1079 of the newly created changeset is in ``$HG_NODE``. Parent changeset
1080 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1080 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1081
1081
1082 ``incoming``
1082 ``incoming``
1083 Run after a changeset has been pulled, pushed, or unbundled into
1083 Run after a changeset has been pulled, pushed, or unbundled into
1084 the local repository. The ID of the newly arrived changeset is in
1084 the local repository. The ID of the newly arrived changeset is in
1085 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
1085 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
1086
1086
1087 ``outgoing``
1087 ``outgoing``
1088 Run after sending changes from the local repository to another. The ID of
1088 Run after sending changes from the local repository to another. The ID of
1089 first changeset sent is in ``$HG_NODE``. The source of operation is in
1089 first changeset sent is in ``$HG_NODE``. The source of operation is in
1090 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
1090 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
1091
1091
1092 ``post-<command>``
1092 ``post-<command>``
1093 Run after successful invocations of the associated command. The
1093 Run after successful invocations of the associated command. The
1094 contents of the command line are passed as ``$HG_ARGS`` and the result
1094 contents of the command line are passed as ``$HG_ARGS`` and the result
1095 code in ``$HG_RESULT``. Parsed command line arguments are passed as
1095 code in ``$HG_RESULT``. Parsed command line arguments are passed as
1096 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
1096 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
1097 the python data internally passed to <command>. ``$HG_OPTS`` is a
1097 the python data internally passed to <command>. ``$HG_OPTS`` is a
1098 dictionary of options (with unspecified options set to their defaults).
1098 dictionary of options (with unspecified options set to their defaults).
1099 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
1099 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
1100
1100
1101 ``fail-<command>``
1101 ``fail-<command>``
1102 Run after a failed invocation of an associated command. The contents
1102 Run after a failed invocation of an associated command. The contents
1103 of the command line are passed as ``$HG_ARGS``. Parsed command line
1103 of the command line are passed as ``$HG_ARGS``. Parsed command line
1104 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
1104 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
1105 string representations of the python data internally passed to
1105 string representations of the python data internally passed to
1106 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
1106 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
1107 options set to their defaults). ``$HG_PATS`` is a list of arguments.
1107 options set to their defaults). ``$HG_PATS`` is a list of arguments.
1108 Hook failure is ignored.
1108 Hook failure is ignored.
1109
1109
1110 ``pre-<command>``
1110 ``pre-<command>``
1111 Run before executing the associated command. The contents of the
1111 Run before executing the associated command. The contents of the
1112 command line are passed as ``$HG_ARGS``. Parsed command line arguments
1112 command line are passed as ``$HG_ARGS``. Parsed command line arguments
1113 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
1113 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
1114 representations of the data internally passed to <command>. ``$HG_OPTS``
1114 representations of the data internally passed to <command>. ``$HG_OPTS``
1115 is a dictionary of options (with unspecified options set to their
1115 is a dictionary of options (with unspecified options set to their
1116 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
1116 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
1117 failure, the command doesn't execute and Mercurial returns the failure
1117 failure, the command doesn't execute and Mercurial returns the failure
1118 code.
1118 code.
1119
1119
1120 ``prechangegroup``
1120 ``prechangegroup``
1121 Run before a changegroup is added via push, pull or unbundle. Exit
1121 Run before a changegroup is added via push, pull or unbundle. Exit
1122 status 0 allows the changegroup to proceed. A non-zero status will
1122 status 0 allows the changegroup to proceed. A non-zero status will
1123 cause the push, pull or unbundle to fail. The URL from which changes
1123 cause the push, pull or unbundle to fail. The URL from which changes
1124 will come is in ``$HG_URL``.
1124 will come is in ``$HG_URL``.
1125
1125
1126 ``precommit``
1126 ``precommit``
1127 Run before starting a local commit. Exit status 0 allows the
1127 Run before starting a local commit. Exit status 0 allows the
1128 commit to proceed. A non-zero status will cause the commit to fail.
1128 commit to proceed. A non-zero status will cause the commit to fail.
1129 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1129 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1130
1130
1131 ``prelistkeys``
1131 ``prelistkeys``
1132 Run before listing pushkeys (like bookmarks) in the
1132 Run before listing pushkeys (like bookmarks) in the
1133 repository. A non-zero status will cause failure. The key namespace is
1133 repository. A non-zero status will cause failure. The key namespace is
1134 in ``$HG_NAMESPACE``.
1134 in ``$HG_NAMESPACE``.
1135
1135
1136 ``preoutgoing``
1136 ``preoutgoing``
1137 Run before collecting changes to send from the local repository to
1137 Run before collecting changes to send from the local repository to
1138 another. A non-zero status will cause failure. This lets you prevent
1138 another. A non-zero status will cause failure. This lets you prevent
1139 pull over HTTP or SSH. It can also prevent propagating commits (via
1139 pull over HTTP or SSH. It can also prevent propagating commits (via
1140 local pull, push (outbound) or bundle commands), but not completely,
1140 local pull, push (outbound) or bundle commands), but not completely,
1141 since you can just copy files instead. The source of operation is in
1141 since you can just copy files instead. The source of operation is in
1142 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1142 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1143 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1143 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1144 is happening on behalf of a repository on same system.
1144 is happening on behalf of a repository on same system.
1145
1145
1146 ``prepushkey``
1146 ``prepushkey``
1147 Run before a pushkey (like a bookmark) is added to the
1147 Run before a pushkey (like a bookmark) is added to the
1148 repository. A non-zero status will cause the key to be rejected. The
1148 repository. A non-zero status will cause the key to be rejected. The
1149 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1149 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1150 the old value (if any) is in ``$HG_OLD``, and the new value is in
1150 the old value (if any) is in ``$HG_OLD``, and the new value is in
1151 ``$HG_NEW``.
1151 ``$HG_NEW``.
1152
1152
1153 ``pretag``
1153 ``pretag``
1154 Run before creating a tag. Exit status 0 allows the tag to be
1154 Run before creating a tag. Exit status 0 allows the tag to be
1155 created. A non-zero status will cause the tag to fail. The ID of the
1155 created. A non-zero status will cause the tag to fail. The ID of the
1156 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1156 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1157 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1157 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1158
1158
1159 ``pretxnopen``
1159 ``pretxnopen``
1160 Run before any new repository transaction is open. The reason for the
1160 Run before any new repository transaction is open. The reason for the
1161 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1161 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1162 transaction will be in ``$HG_TXNID``. A non-zero status will prevent the
1162 transaction will be in ``$HG_TXNID``. A non-zero status will prevent the
1163 transaction from being opened.
1163 transaction from being opened.
1164
1164
1165 ``pretxnclose``
1165 ``pretxnclose``
1166 Run right before the transaction is actually finalized. Any repository change
1166 Run right before the transaction is actually finalized. Any repository change
1167 will be visible to the hook program. This lets you validate the transaction
1167 will be visible to the hook program. This lets you validate the transaction
1168 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1168 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1169 status will cause the transaction to be rolled back. The reason for the
1169 status will cause the transaction to be rolled back. The reason for the
1170 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1170 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1171 the transaction will be in ``$HG_TXNID``. The rest of the available data will
1171 the transaction will be in ``$HG_TXNID``. The rest of the available data will
1172 vary according the transaction type. Changes unbundled to the repository will
1172 vary according the transaction type. Changes unbundled to the repository will
1173 add ``$HG_URL`` and ``$HG_SOURCE``. New changesets will add ``$HG_NODE`` (the
1173 add ``$HG_URL`` and ``$HG_SOURCE``. New changesets will add ``$HG_NODE`` (the
1174 ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last added
1174 ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last added
1175 changeset). Bookmark and phase changes will set ``$HG_BOOKMARK_MOVED`` and
1175 changeset). Bookmark and phase changes will set ``$HG_BOOKMARK_MOVED`` and
1176 ``$HG_PHASES_MOVED`` to ``1`` respectively. The number of new obsmarkers, if
1176 ``$HG_PHASES_MOVED`` to ``1`` respectively. The number of new obsmarkers, if
1177 any, will be in ``$HG_NEW_OBSMARKERS``, etc.
1177 any, will be in ``$HG_NEW_OBSMARKERS``, etc.
1178
1178
1179 ``pretxnclose-bookmark``
1179 ``pretxnclose-bookmark``
1180 Run right before a bookmark change is actually finalized. Any repository
1180 Run right before a bookmark change is actually finalized. Any repository
1181 change will be visible to the hook program. This lets you validate the
1181 change will be visible to the hook program. This lets you validate the
1182 transaction content or change it. Exit status 0 allows the commit to
1182 transaction content or change it. Exit status 0 allows the commit to
1183 proceed. A non-zero status will cause the transaction to be rolled back.
1183 proceed. A non-zero status will cause the transaction to be rolled back.
1184 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1184 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1185 bookmark location will be available in ``$HG_NODE`` while the previous
1185 bookmark location will be available in ``$HG_NODE`` while the previous
1186 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1186 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1187 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1187 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1188 will be empty.
1188 will be empty.
1189 In addition, the reason for the transaction opening will be in
1189 In addition, the reason for the transaction opening will be in
1190 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1190 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1191 ``$HG_TXNID``.
1191 ``$HG_TXNID``.
1192
1192
1193 ``pretxnclose-phase``
1193 ``pretxnclose-phase``
1194 Run right before a phase change is actually finalized. Any repository change
1194 Run right before a phase change is actually finalized. Any repository change
1195 will be visible to the hook program. This lets you validate the transaction
1195 will be visible to the hook program. This lets you validate the transaction
1196 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1196 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1197 status will cause the transaction to be rolled back. The hook is called
1197 status will cause the transaction to be rolled back. The hook is called
1198 multiple times, once for each revision affected by a phase change.
1198 multiple times, once for each revision affected by a phase change.
1199 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1199 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1200 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1200 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1201 will be empty. In addition, the reason for the transaction opening will be in
1201 will be empty. In addition, the reason for the transaction opening will be in
1202 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1202 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1203 ``$HG_TXNID``. The hook is also run for newly added revisions. In this case
1203 ``$HG_TXNID``. The hook is also run for newly added revisions. In this case
1204 the ``$HG_OLDPHASE`` entry will be empty.
1204 the ``$HG_OLDPHASE`` entry will be empty.
1205
1205
1206 ``txnclose``
1206 ``txnclose``
1207 Run after any repository transaction has been committed. At this
1207 Run after any repository transaction has been committed. At this
1208 point, the transaction can no longer be rolled back. The hook will run
1208 point, the transaction can no longer be rolled back. The hook will run
1209 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1209 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1210 details about available variables.
1210 details about available variables.
1211
1211
1212 ``txnclose-bookmark``
1212 ``txnclose-bookmark``
1213 Run after any bookmark change has been committed. At this point, the
1213 Run after any bookmark change has been committed. At this point, the
1214 transaction can no longer be rolled back. The hook will run after the lock
1214 transaction can no longer be rolled back. The hook will run after the lock
1215 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1215 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1216 about available variables.
1216 about available variables.
1217
1217
1218 ``txnclose-phase``
1218 ``txnclose-phase``
1219 Run after any phase change has been committed. At this point, the
1219 Run after any phase change has been committed. At this point, the
1220 transaction can no longer be rolled back. The hook will run after the lock
1220 transaction can no longer be rolled back. The hook will run after the lock
1221 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1221 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1222 available variables.
1222 available variables.
1223
1223
1224 ``txnabort``
1224 ``txnabort``
1225 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1225 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1226 for details about available variables.
1226 for details about available variables.
1227
1227
1228 ``pretxnchangegroup``
1228 ``pretxnchangegroup``
1229 Run after a changegroup has been added via push, pull or unbundle, but before
1229 Run after a changegroup has been added via push, pull or unbundle, but before
1230 the transaction has been committed. The changegroup is visible to the hook
1230 the transaction has been committed. The changegroup is visible to the hook
1231 program. This allows validation of incoming changes before accepting them.
1231 program. This allows validation of incoming changes before accepting them.
1232 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1232 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1233 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1233 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1234 status will cause the transaction to be rolled back, and the push, pull or
1234 status will cause the transaction to be rolled back, and the push, pull or
1235 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1235 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1236
1236
1237 ``pretxncommit``
1237 ``pretxncommit``
1238 Run after a changeset has been created, but before the transaction is
1238 Run after a changeset has been created, but before the transaction is
1239 committed. The changeset is visible to the hook program. This allows
1239 committed. The changeset is visible to the hook program. This allows
1240 validation of the commit message and changes. Exit status 0 allows the
1240 validation of the commit message and changes. Exit status 0 allows the
1241 commit to proceed. A non-zero status will cause the transaction to
1241 commit to proceed. A non-zero status will cause the transaction to
1242 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1242 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1243 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1243 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1244
1244
1245 ``preupdate``
1245 ``preupdate``
1246 Run before updating the working directory. Exit status 0 allows
1246 Run before updating the working directory. Exit status 0 allows
1247 the update to proceed. A non-zero status will prevent the update.
1247 the update to proceed. A non-zero status will prevent the update.
1248 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1248 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1249 merge, the ID of second new parent is in ``$HG_PARENT2``.
1249 merge, the ID of second new parent is in ``$HG_PARENT2``.
1250
1250
1251 ``listkeys``
1251 ``listkeys``
1252 Run after listing pushkeys (like bookmarks) in the repository. The
1252 Run after listing pushkeys (like bookmarks) in the repository. The
1253 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1253 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1254 dictionary containing the keys and values.
1254 dictionary containing the keys and values.
1255
1255
1256 ``pushkey``
1256 ``pushkey``
1257 Run after a pushkey (like a bookmark) is added to the
1257 Run after a pushkey (like a bookmark) is added to the
1258 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1258 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1259 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1259 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1260 value is in ``$HG_NEW``.
1260 value is in ``$HG_NEW``.
1261
1261
1262 ``tag``
1262 ``tag``
1263 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1263 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1264 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1264 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1265 the repository if ``$HG_LOCAL=0``.
1265 the repository if ``$HG_LOCAL=0``.
1266
1266
1267 ``update``
1267 ``update``
1268 Run after updating the working directory. The changeset ID of first
1268 Run after updating the working directory. The changeset ID of first
1269 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1269 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1270 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1270 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1271 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1271 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1272
1272
1273 .. note::
1273 .. note::
1274
1274
1275 It is generally better to use standard hooks rather than the
1275 It is generally better to use standard hooks rather than the
1276 generic pre- and post- command hooks, as they are guaranteed to be
1276 generic pre- and post- command hooks, as they are guaranteed to be
1277 called in the appropriate contexts for influencing transactions.
1277 called in the appropriate contexts for influencing transactions.
1278 Also, hooks like "commit" will be called in all contexts that
1278 Also, hooks like "commit" will be called in all contexts that
1279 generate a commit (e.g. tag) and not just the commit command.
1279 generate a commit (e.g. tag) and not just the commit command.
1280
1280
1281 .. note::
1281 .. note::
1282
1282
1283 Environment variables with empty values may not be passed to
1283 Environment variables with empty values may not be passed to
1284 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1284 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1285 will have an empty value under Unix-like platforms for non-merge
1285 will have an empty value under Unix-like platforms for non-merge
1286 changesets, while it will not be available at all under Windows.
1286 changesets, while it will not be available at all under Windows.
1287
1287
1288 The syntax for Python hooks is as follows::
1288 The syntax for Python hooks is as follows::
1289
1289
1290 hookname = python:modulename.submodule.callable
1290 hookname = python:modulename.submodule.callable
1291 hookname = python:/path/to/python/module.py:callable
1291 hookname = python:/path/to/python/module.py:callable
1292
1292
1293 Python hooks are run within the Mercurial process. Each hook is
1293 Python hooks are run within the Mercurial process. Each hook is
1294 called with at least three keyword arguments: a ui object (keyword
1294 called with at least three keyword arguments: a ui object (keyword
1295 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1295 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1296 keyword that tells what kind of hook is used. Arguments listed as
1296 keyword that tells what kind of hook is used. Arguments listed as
1297 environment variables above are passed as keyword arguments, with no
1297 environment variables above are passed as keyword arguments, with no
1298 ``HG_`` prefix, and names in lower case.
1298 ``HG_`` prefix, and names in lower case.
1299
1299
1300 If a Python hook returns a "true" value or raises an exception, this
1300 If a Python hook returns a "true" value or raises an exception, this
1301 is treated as a failure.
1301 is treated as a failure.
1302
1302
1303
1303
1304 ``hostfingerprints``
1304 ``hostfingerprints``
1305 --------------------
1305 --------------------
1306
1306
1307 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1307 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1308
1308
1309 Fingerprints of the certificates of known HTTPS servers.
1309 Fingerprints of the certificates of known HTTPS servers.
1310
1310
1311 A HTTPS connection to a server with a fingerprint configured here will
1311 A HTTPS connection to a server with a fingerprint configured here will
1312 only succeed if the servers certificate matches the fingerprint.
1312 only succeed if the servers certificate matches the fingerprint.
1313 This is very similar to how ssh known hosts works.
1313 This is very similar to how ssh known hosts works.
1314
1314
1315 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1315 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1316 Multiple values can be specified (separated by spaces or commas). This can
1316 Multiple values can be specified (separated by spaces or commas). This can
1317 be used to define both old and new fingerprints while a host transitions
1317 be used to define both old and new fingerprints while a host transitions
1318 to a new certificate.
1318 to a new certificate.
1319
1319
1320 The CA chain and web.cacerts is not used for servers with a fingerprint.
1320 The CA chain and web.cacerts is not used for servers with a fingerprint.
1321
1321
1322 For example::
1322 For example::
1323
1323
1324 [hostfingerprints]
1324 [hostfingerprints]
1325 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1325 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1326 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1326 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1327
1327
1328 ``hostsecurity``
1328 ``hostsecurity``
1329 ----------------
1329 ----------------
1330
1330
1331 Used to specify global and per-host security settings for connecting to
1331 Used to specify global and per-host security settings for connecting to
1332 other machines.
1332 other machines.
1333
1333
1334 The following options control default behavior for all hosts.
1334 The following options control default behavior for all hosts.
1335
1335
1336 ``ciphers``
1336 ``ciphers``
1337 Defines the cryptographic ciphers to use for connections.
1337 Defines the cryptographic ciphers to use for connections.
1338
1338
1339 Value must be a valid OpenSSL Cipher List Format as documented at
1339 Value must be a valid OpenSSL Cipher List Format as documented at
1340 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1340 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1341
1341
1342 This setting is for advanced users only. Setting to incorrect values
1342 This setting is for advanced users only. Setting to incorrect values
1343 can significantly lower connection security or decrease performance.
1343 can significantly lower connection security or decrease performance.
1344 You have been warned.
1344 You have been warned.
1345
1345
1346 This option requires Python 2.7.
1346 This option requires Python 2.7.
1347
1347
1348 ``minimumprotocol``
1348 ``minimumprotocol``
1349 Defines the minimum channel encryption protocol to use.
1349 Defines the minimum channel encryption protocol to use.
1350
1350
1351 By default, the highest version of TLS supported by both client and server
1351 By default, the highest version of TLS supported by both client and server
1352 is used.
1352 is used.
1353
1353
1354 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1354 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1355
1355
1356 When running on an old Python version, only ``tls1.0`` is allowed since
1356 When running on an old Python version, only ``tls1.0`` is allowed since
1357 old versions of Python only support up to TLS 1.0.
1357 old versions of Python only support up to TLS 1.0.
1358
1358
1359 When running a Python that supports modern TLS versions, the default is
1359 When running a Python that supports modern TLS versions, the default is
1360 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1360 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1361 weakens security and should only be used as a feature of last resort if
1361 weakens security and should only be used as a feature of last resort if
1362 a server does not support TLS 1.1+.
1362 a server does not support TLS 1.1+.
1363
1363
1364 Options in the ``[hostsecurity]`` section can have the form
1364 Options in the ``[hostsecurity]`` section can have the form
1365 ``hostname``:``setting``. This allows multiple settings to be defined on a
1365 ``hostname``:``setting``. This allows multiple settings to be defined on a
1366 per-host basis.
1366 per-host basis.
1367
1367
1368 The following per-host settings can be defined.
1368 The following per-host settings can be defined.
1369
1369
1370 ``ciphers``
1370 ``ciphers``
1371 This behaves like ``ciphers`` as described above except it only applies
1371 This behaves like ``ciphers`` as described above except it only applies
1372 to the host on which it is defined.
1372 to the host on which it is defined.
1373
1373
1374 ``fingerprints``
1374 ``fingerprints``
1375 A list of hashes of the DER encoded peer/remote certificate. Values have
1375 A list of hashes of the DER encoded peer/remote certificate. Values have
1376 the form ``algorithm``:``fingerprint``. e.g.
1376 the form ``algorithm``:``fingerprint``. e.g.
1377 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1377 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1378 In addition, colons (``:``) can appear in the fingerprint part.
1378 In addition, colons (``:``) can appear in the fingerprint part.
1379
1379
1380 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1380 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1381 ``sha512``.
1381 ``sha512``.
1382
1382
1383 Use of ``sha256`` or ``sha512`` is preferred.
1383 Use of ``sha256`` or ``sha512`` is preferred.
1384
1384
1385 If a fingerprint is specified, the CA chain is not validated for this
1385 If a fingerprint is specified, the CA chain is not validated for this
1386 host and Mercurial will require the remote certificate to match one
1386 host and Mercurial will require the remote certificate to match one
1387 of the fingerprints specified. This means if the server updates its
1387 of the fingerprints specified. This means if the server updates its
1388 certificate, Mercurial will abort until a new fingerprint is defined.
1388 certificate, Mercurial will abort until a new fingerprint is defined.
1389 This can provide stronger security than traditional CA-based validation
1389 This can provide stronger security than traditional CA-based validation
1390 at the expense of convenience.
1390 at the expense of convenience.
1391
1391
1392 This option takes precedence over ``verifycertsfile``.
1392 This option takes precedence over ``verifycertsfile``.
1393
1393
1394 ``minimumprotocol``
1394 ``minimumprotocol``
1395 This behaves like ``minimumprotocol`` as described above except it
1395 This behaves like ``minimumprotocol`` as described above except it
1396 only applies to the host on which it is defined.
1396 only applies to the host on which it is defined.
1397
1397
1398 ``verifycertsfile``
1398 ``verifycertsfile``
1399 Path to file a containing a list of PEM encoded certificates used to
1399 Path to file a containing a list of PEM encoded certificates used to
1400 verify the server certificate. Environment variables and ``~user``
1400 verify the server certificate. Environment variables and ``~user``
1401 constructs are expanded in the filename.
1401 constructs are expanded in the filename.
1402
1402
1403 The server certificate or the certificate's certificate authority (CA)
1403 The server certificate or the certificate's certificate authority (CA)
1404 must match a certificate from this file or certificate verification
1404 must match a certificate from this file or certificate verification
1405 will fail and connections to the server will be refused.
1405 will fail and connections to the server will be refused.
1406
1406
1407 If defined, only certificates provided by this file will be used:
1407 If defined, only certificates provided by this file will be used:
1408 ``web.cacerts`` and any system/default certificates will not be
1408 ``web.cacerts`` and any system/default certificates will not be
1409 used.
1409 used.
1410
1410
1411 This option has no effect if the per-host ``fingerprints`` option
1411 This option has no effect if the per-host ``fingerprints`` option
1412 is set.
1412 is set.
1413
1413
1414 The format of the file is as follows::
1414 The format of the file is as follows::
1415
1415
1416 -----BEGIN CERTIFICATE-----
1416 -----BEGIN CERTIFICATE-----
1417 ... (certificate in base64 PEM encoding) ...
1417 ... (certificate in base64 PEM encoding) ...
1418 -----END CERTIFICATE-----
1418 -----END CERTIFICATE-----
1419 -----BEGIN CERTIFICATE-----
1419 -----BEGIN CERTIFICATE-----
1420 ... (certificate in base64 PEM encoding) ...
1420 ... (certificate in base64 PEM encoding) ...
1421 -----END CERTIFICATE-----
1421 -----END CERTIFICATE-----
1422
1422
1423 For example::
1423 For example::
1424
1424
1425 [hostsecurity]
1425 [hostsecurity]
1426 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1426 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1427 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
1427 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
1428 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
1428 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
1429 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1429 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1430
1430
1431 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1431 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1432 when connecting to ``hg.example.com``::
1432 when connecting to ``hg.example.com``::
1433
1433
1434 [hostsecurity]
1434 [hostsecurity]
1435 minimumprotocol = tls1.2
1435 minimumprotocol = tls1.2
1436 hg.example.com:minimumprotocol = tls1.1
1436 hg.example.com:minimumprotocol = tls1.1
1437
1437
1438 ``http_proxy``
1438 ``http_proxy``
1439 --------------
1439 --------------
1440
1440
1441 Used to access web-based Mercurial repositories through a HTTP
1441 Used to access web-based Mercurial repositories through a HTTP
1442 proxy.
1442 proxy.
1443
1443
1444 ``host``
1444 ``host``
1445 Host name and (optional) port of the proxy server, for example
1445 Host name and (optional) port of the proxy server, for example
1446 "myproxy:8000".
1446 "myproxy:8000".
1447
1447
1448 ``no``
1448 ``no``
1449 Optional. Comma-separated list of host names that should bypass
1449 Optional. Comma-separated list of host names that should bypass
1450 the proxy.
1450 the proxy.
1451
1451
1452 ``passwd``
1452 ``passwd``
1453 Optional. Password to authenticate with at the proxy server.
1453 Optional. Password to authenticate with at the proxy server.
1454
1454
1455 ``user``
1455 ``user``
1456 Optional. User name to authenticate with at the proxy server.
1456 Optional. User name to authenticate with at the proxy server.
1457
1457
1458 ``always``
1458 ``always``
1459 Optional. Always use the proxy, even for localhost and any entries
1459 Optional. Always use the proxy, even for localhost and any entries
1460 in ``http_proxy.no``. (default: False)
1460 in ``http_proxy.no``. (default: False)
1461
1461
1462 ``http``
1462 ``http``
1463 ----------
1463 ----------
1464
1464
1465 Used to configure access to Mercurial repositories via HTTP.
1465 Used to configure access to Mercurial repositories via HTTP.
1466
1466
1467 ``timeout``
1467 ``timeout``
1468 If set, blocking operations will timeout after that many seconds.
1468 If set, blocking operations will timeout after that many seconds.
1469 (default: None)
1469 (default: None)
1470
1470
1471 ``merge``
1471 ``merge``
1472 ---------
1472 ---------
1473
1473
1474 This section specifies behavior during merges and updates.
1474 This section specifies behavior during merges and updates.
1475
1475
1476 ``checkignored``
1476 ``checkignored``
1477 Controls behavior when an ignored file on disk has the same name as a tracked
1477 Controls behavior when an ignored file on disk has the same name as a tracked
1478 file in the changeset being merged or updated to, and has different
1478 file in the changeset being merged or updated to, and has different
1479 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1479 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1480 abort on such files. With ``warn``, warn on such files and back them up as
1480 abort on such files. With ``warn``, warn on such files and back them up as
1481 ``.orig``. With ``ignore``, don't print a warning and back them up as
1481 ``.orig``. With ``ignore``, don't print a warning and back them up as
1482 ``.orig``. (default: ``abort``)
1482 ``.orig``. (default: ``abort``)
1483
1483
1484 ``checkunknown``
1484 ``checkunknown``
1485 Controls behavior when an unknown file that isn't ignored has the same name
1485 Controls behavior when an unknown file that isn't ignored has the same name
1486 as a tracked file in the changeset being merged or updated to, and has
1486 as a tracked file in the changeset being merged or updated to, and has
1487 different contents. Similar to ``merge.checkignored``, except for files that
1487 different contents. Similar to ``merge.checkignored``, except for files that
1488 are not ignored. (default: ``abort``)
1488 are not ignored. (default: ``abort``)
1489
1489
1490 ``on-failure``
1490 ``on-failure``
1491 When set to ``continue`` (the default), the merge process attempts to
1491 When set to ``continue`` (the default), the merge process attempts to
1492 merge all unresolved files using the merge chosen tool, regardless of
1492 merge all unresolved files using the merge chosen tool, regardless of
1493 whether previous file merge attempts during the process succeeded or not.
1493 whether previous file merge attempts during the process succeeded or not.
1494 Setting this to ``prompt`` will prompt after any merge failure continue
1494 Setting this to ``prompt`` will prompt after any merge failure continue
1495 or halt the merge process. Setting this to ``halt`` will automatically
1495 or halt the merge process. Setting this to ``halt`` will automatically
1496 halt the merge process on any merge tool failure. The merge process
1496 halt the merge process on any merge tool failure. The merge process
1497 can be restarted by using the ``resolve`` command. When a merge is
1497 can be restarted by using the ``resolve`` command. When a merge is
1498 halted, the repository is left in a normal ``unresolved`` merge state.
1498 halted, the repository is left in a normal ``unresolved`` merge state.
1499 (default: ``continue``)
1499 (default: ``continue``)
1500
1500
1501 ``strict-capability-check``
1501 ``strict-capability-check``
1502 Whether capabilities of internal merge tools are checked strictly
1502 Whether capabilities of internal merge tools are checked strictly
1503 or not, while examining rules to decide merge tool to be used.
1503 or not, while examining rules to decide merge tool to be used.
1504 (default: False)
1504 (default: False)
1505
1505
1506 ``merge-patterns``
1506 ``merge-patterns``
1507 ------------------
1507 ------------------
1508
1508
1509 This section specifies merge tools to associate with particular file
1509 This section specifies merge tools to associate with particular file
1510 patterns. Tools matched here will take precedence over the default
1510 patterns. Tools matched here will take precedence over the default
1511 merge tool. Patterns are globs by default, rooted at the repository
1511 merge tool. Patterns are globs by default, rooted at the repository
1512 root.
1512 root.
1513
1513
1514 Example::
1514 Example::
1515
1515
1516 [merge-patterns]
1516 [merge-patterns]
1517 **.c = kdiff3
1517 **.c = kdiff3
1518 **.jpg = myimgmerge
1518 **.jpg = myimgmerge
1519
1519
1520 ``merge-tools``
1520 ``merge-tools``
1521 ---------------
1521 ---------------
1522
1522
1523 This section configures external merge tools to use for file-level
1523 This section configures external merge tools to use for file-level
1524 merges. This section has likely been preconfigured at install time.
1524 merges. This section has likely been preconfigured at install time.
1525 Use :hg:`config merge-tools` to check the existing configuration.
1525 Use :hg:`config merge-tools` to check the existing configuration.
1526 Also see :hg:`help merge-tools` for more details.
1526 Also see :hg:`help merge-tools` for more details.
1527
1527
1528 Example ``~/.hgrc``::
1528 Example ``~/.hgrc``::
1529
1529
1530 [merge-tools]
1530 [merge-tools]
1531 # Override stock tool location
1531 # Override stock tool location
1532 kdiff3.executable = ~/bin/kdiff3
1532 kdiff3.executable = ~/bin/kdiff3
1533 # Specify command line
1533 # Specify command line
1534 kdiff3.args = $base $local $other -o $output
1534 kdiff3.args = $base $local $other -o $output
1535 # Give higher priority
1535 # Give higher priority
1536 kdiff3.priority = 1
1536 kdiff3.priority = 1
1537
1537
1538 # Changing the priority of preconfigured tool
1538 # Changing the priority of preconfigured tool
1539 meld.priority = 0
1539 meld.priority = 0
1540
1540
1541 # Disable a preconfigured tool
1541 # Disable a preconfigured tool
1542 vimdiff.disabled = yes
1542 vimdiff.disabled = yes
1543
1543
1544 # Define new tool
1544 # Define new tool
1545 myHtmlTool.args = -m $local $other $base $output
1545 myHtmlTool.args = -m $local $other $base $output
1546 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1546 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1547 myHtmlTool.priority = 1
1547 myHtmlTool.priority = 1
1548
1548
1549 Supported arguments:
1549 Supported arguments:
1550
1550
1551 ``priority``
1551 ``priority``
1552 The priority in which to evaluate this tool.
1552 The priority in which to evaluate this tool.
1553 (default: 0)
1553 (default: 0)
1554
1554
1555 ``executable``
1555 ``executable``
1556 Either just the name of the executable or its pathname.
1556 Either just the name of the executable or its pathname.
1557
1557
1558 .. container:: windows
1558 .. container:: windows
1559
1559
1560 On Windows, the path can use environment variables with ${ProgramFiles}
1560 On Windows, the path can use environment variables with ${ProgramFiles}
1561 syntax.
1561 syntax.
1562
1562
1563 (default: the tool name)
1563 (default: the tool name)
1564
1564
1565 ``args``
1565 ``args``
1566 The arguments to pass to the tool executable. You can refer to the
1566 The arguments to pass to the tool executable. You can refer to the
1567 files being merged as well as the output file through these
1567 files being merged as well as the output file through these
1568 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1568 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1569
1569
1570 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1570 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1571 being performed. During an update or merge, ``$local`` represents the original
1571 being performed. During an update or merge, ``$local`` represents the original
1572 state of the file, while ``$other`` represents the commit you are updating to or
1572 state of the file, while ``$other`` represents the commit you are updating to or
1573 the commit you are merging with. During a rebase, ``$local`` represents the
1573 the commit you are merging with. During a rebase, ``$local`` represents the
1574 destination of the rebase, and ``$other`` represents the commit being rebased.
1574 destination of the rebase, and ``$other`` represents the commit being rebased.
1575
1575
1576 Some operations define custom labels to assist with identifying the revisions,
1576 Some operations define custom labels to assist with identifying the revisions,
1577 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1577 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1578 labels are not available, these will be ``local``, ``other``, and ``base``,
1578 labels are not available, these will be ``local``, ``other``, and ``base``,
1579 respectively.
1579 respectively.
1580 (default: ``$local $base $other``)
1580 (default: ``$local $base $other``)
1581
1581
1582 ``premerge``
1582 ``premerge``
1583 Attempt to run internal non-interactive 3-way merge tool before
1583 Attempt to run internal non-interactive 3-way merge tool before
1584 launching external tool. Options are ``true``, ``false``, ``keep``,
1584 launching external tool. Options are ``true``, ``false``, ``keep``,
1585 ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
1585 ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
1586 will leave markers in the file if the premerge fails. The ``keep-merge3``
1586 will leave markers in the file if the premerge fails. The ``keep-merge3``
1587 will do the same but include information about the base of the merge in the
1587 will do the same but include information about the base of the merge in the
1588 marker (see internal :merge3 in :hg:`help merge-tools`). The
1588 marker (see internal :merge3 in :hg:`help merge-tools`). The
1589 ``keep-mergediff`` option is similar but uses a different marker style
1589 ``keep-mergediff`` option is similar but uses a different marker style
1590 (see internal :merge3 in :hg:`help merge-tools`). (default: True)
1590 (see internal :merge3 in :hg:`help merge-tools`). (default: True)
1591
1591
1592 ``binary``
1592 ``binary``
1593 This tool can merge binary files. (default: False, unless tool
1593 This tool can merge binary files. (default: False, unless tool
1594 was selected by file pattern match)
1594 was selected by file pattern match)
1595
1595
1596 ``symlink``
1596 ``symlink``
1597 This tool can merge symlinks. (default: False)
1597 This tool can merge symlinks. (default: False)
1598
1598
1599 ``check``
1599 ``check``
1600 A list of merge success-checking options:
1600 A list of merge success-checking options:
1601
1601
1602 ``changed``
1602 ``changed``
1603 Ask whether merge was successful when the merged file shows no changes.
1603 Ask whether merge was successful when the merged file shows no changes.
1604 ``conflicts``
1604 ``conflicts``
1605 Check whether there are conflicts even though the tool reported success.
1605 Check whether there are conflicts even though the tool reported success.
1606 ``prompt``
1606 ``prompt``
1607 Always prompt for merge success, regardless of success reported by tool.
1607 Always prompt for merge success, regardless of success reported by tool.
1608
1608
1609 ``fixeol``
1609 ``fixeol``
1610 Attempt to fix up EOL changes caused by the merge tool.
1610 Attempt to fix up EOL changes caused by the merge tool.
1611 (default: False)
1611 (default: False)
1612
1612
1613 ``gui``
1613 ``gui``
1614 This tool requires a graphical interface to run. (default: False)
1614 This tool requires a graphical interface to run. (default: False)
1615
1615
1616 ``mergemarkers``
1616 ``mergemarkers``
1617 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1617 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1618 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1618 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1619 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1619 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1620 markers generated during premerge will be ``detailed`` if either this option or
1620 markers generated during premerge will be ``detailed`` if either this option or
1621 the corresponding option in the ``[ui]`` section is ``detailed``.
1621 the corresponding option in the ``[ui]`` section is ``detailed``.
1622 (default: ``basic``)
1622 (default: ``basic``)
1623
1623
1624 ``mergemarkertemplate``
1624 ``mergemarkertemplate``
1625 This setting can be used to override ``mergemarker`` from the
1625 This setting can be used to override ``mergemarker`` from the
1626 ``[command-templates]`` section on a per-tool basis; this applies to the
1626 ``[command-templates]`` section on a per-tool basis; this applies to the
1627 ``$label``-prefixed variables and to the conflict markers that are generated
1627 ``$label``-prefixed variables and to the conflict markers that are generated
1628 if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
1628 if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
1629 in ``[ui]`` for more information.
1629 in ``[ui]`` for more information.
1630
1630
1631 .. container:: windows
1631 .. container:: windows
1632
1632
1633 ``regkey``
1633 ``regkey``
1634 Windows registry key which describes install location of this
1634 Windows registry key which describes install location of this
1635 tool. Mercurial will search for this key first under
1635 tool. Mercurial will search for this key first under
1636 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1636 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1637 (default: None)
1637 (default: None)
1638
1638
1639 ``regkeyalt``
1639 ``regkeyalt``
1640 An alternate Windows registry key to try if the first key is not
1640 An alternate Windows registry key to try if the first key is not
1641 found. The alternate key uses the same ``regname`` and ``regappend``
1641 found. The alternate key uses the same ``regname`` and ``regappend``
1642 semantics of the primary key. The most common use for this key
1642 semantics of the primary key. The most common use for this key
1643 is to search for 32bit applications on 64bit operating systems.
1643 is to search for 32bit applications on 64bit operating systems.
1644 (default: None)
1644 (default: None)
1645
1645
1646 ``regname``
1646 ``regname``
1647 Name of value to read from specified registry key.
1647 Name of value to read from specified registry key.
1648 (default: the unnamed (default) value)
1648 (default: the unnamed (default) value)
1649
1649
1650 ``regappend``
1650 ``regappend``
1651 String to append to the value read from the registry, typically
1651 String to append to the value read from the registry, typically
1652 the executable name of the tool.
1652 the executable name of the tool.
1653 (default: None)
1653 (default: None)
1654
1654
1655 ``pager``
1655 ``pager``
1656 ---------
1656 ---------
1657
1657
1658 Setting used to control when to paginate and with what external tool. See
1658 Setting used to control when to paginate and with what external tool. See
1659 :hg:`help pager` for details.
1659 :hg:`help pager` for details.
1660
1660
1661 ``pager``
1661 ``pager``
1662 Define the external tool used as pager.
1662 Define the external tool used as pager.
1663
1663
1664 If no pager is set, Mercurial uses the environment variable $PAGER.
1664 If no pager is set, Mercurial uses the environment variable $PAGER.
1665 If neither pager.pager, nor $PAGER is set, a default pager will be
1665 If neither pager.pager, nor $PAGER is set, a default pager will be
1666 used, typically `less` on Unix and `more` on Windows. Example::
1666 used, typically `less` on Unix and `more` on Windows. Example::
1667
1667
1668 [pager]
1668 [pager]
1669 pager = less -FRX
1669 pager = less -FRX
1670
1670
1671 ``ignore``
1671 ``ignore``
1672 List of commands to disable the pager for. Example::
1672 List of commands to disable the pager for. Example::
1673
1673
1674 [pager]
1674 [pager]
1675 ignore = version, help, update
1675 ignore = version, help, update
1676
1676
1677 ``patch``
1677 ``patch``
1678 ---------
1678 ---------
1679
1679
1680 Settings used when applying patches, for instance through the 'import'
1680 Settings used when applying patches, for instance through the 'import'
1681 command or with Mercurial Queues extension.
1681 command or with Mercurial Queues extension.
1682
1682
1683 ``eol``
1683 ``eol``
1684 When set to 'strict' patch content and patched files end of lines
1684 When set to 'strict' patch content and patched files end of lines
1685 are preserved. When set to ``lf`` or ``crlf``, both files end of
1685 are preserved. When set to ``lf`` or ``crlf``, both files end of
1686 lines are ignored when patching and the result line endings are
1686 lines are ignored when patching and the result line endings are
1687 normalized to either LF (Unix) or CRLF (Windows). When set to
1687 normalized to either LF (Unix) or CRLF (Windows). When set to
1688 ``auto``, end of lines are again ignored while patching but line
1688 ``auto``, end of lines are again ignored while patching but line
1689 endings in patched files are normalized to their original setting
1689 endings in patched files are normalized to their original setting
1690 on a per-file basis. If target file does not exist or has no end
1690 on a per-file basis. If target file does not exist or has no end
1691 of line, patch line endings are preserved.
1691 of line, patch line endings are preserved.
1692 (default: strict)
1692 (default: strict)
1693
1693
1694 ``fuzz``
1694 ``fuzz``
1695 The number of lines of 'fuzz' to allow when applying patches. This
1695 The number of lines of 'fuzz' to allow when applying patches. This
1696 controls how much context the patcher is allowed to ignore when
1696 controls how much context the patcher is allowed to ignore when
1697 trying to apply a patch.
1697 trying to apply a patch.
1698 (default: 2)
1698 (default: 2)
1699
1699
1700 ``paths``
1700 ``paths``
1701 ---------
1701 ---------
1702
1702
1703 Assigns symbolic names and behavior to repositories.
1703 Assigns symbolic names and behavior to repositories.
1704
1704
1705 Options are symbolic names defining the URL or directory that is the
1705 Options are symbolic names defining the URL or directory that is the
1706 location of the repository. Example::
1706 location of the repository. Example::
1707
1707
1708 [paths]
1708 [paths]
1709 my_server = https://example.com/my_repo
1709 my_server = https://example.com/my_repo
1710 local_path = /home/me/repo
1710 local_path = /home/me/repo
1711
1711
1712 These symbolic names can be used from the command line. To pull
1712 These symbolic names can be used from the command line. To pull
1713 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1713 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1714 :hg:`push local_path`. You can check :hg:`help urls` for details about
1714 :hg:`push local_path`. You can check :hg:`help urls` for details about
1715 valid URLs.
1715 valid URLs.
1716
1716
1717 Options containing colons (``:``) denote sub-options that can influence
1717 Options containing colons (``:``) denote sub-options that can influence
1718 behavior for that specific path. Example::
1718 behavior for that specific path. Example::
1719
1719
1720 [paths]
1720 [paths]
1721 my_server = https://example.com/my_path
1721 my_server = https://example.com/my_path
1722 my_server:pushurl = ssh://example.com/my_path
1722 my_server:pushurl = ssh://example.com/my_path
1723
1723
1724 Paths using the `path://otherpath` scheme will inherit the sub-options value from
1724 Paths using the `path://otherpath` scheme will inherit the sub-options value from
1725 the path they point to.
1725 the path they point to.
1726
1726
1727 The following sub-options can be defined:
1727 The following sub-options can be defined:
1728
1728
1729 ``multi-urls``
1729 ``multi-urls``
1730 A boolean option. When enabled the value of the `[paths]` entry will be
1730 A boolean option. When enabled the value of the `[paths]` entry will be
1731 parsed as a list and the alias will resolve to multiple destination. If some
1731 parsed as a list and the alias will resolve to multiple destination. If some
1732 of the list entry use the `path://` syntax, the suboption will be inherited
1732 of the list entry use the `path://` syntax, the suboption will be inherited
1733 individually.
1733 individually.
1734
1734
1735 ``pushurl``
1735 ``pushurl``
1736 The URL to use for push operations. If not defined, the location
1736 The URL to use for push operations. If not defined, the location
1737 defined by the path's main entry is used.
1737 defined by the path's main entry is used.
1738
1738
1739 ``pushrev``
1739 ``pushrev``
1740 A revset defining which revisions to push by default.
1740 A revset defining which revisions to push by default.
1741
1741
1742 When :hg:`push` is executed without a ``-r`` argument, the revset
1742 When :hg:`push` is executed without a ``-r`` argument, the revset
1743 defined by this sub-option is evaluated to determine what to push.
1743 defined by this sub-option is evaluated to determine what to push.
1744
1744
1745 For example, a value of ``.`` will push the working directory's
1745 For example, a value of ``.`` will push the working directory's
1746 revision by default.
1746 revision by default.
1747
1747
1748 Revsets specifying bookmarks will not result in the bookmark being
1748 Revsets specifying bookmarks will not result in the bookmark being
1749 pushed.
1749 pushed.
1750
1750
1751 The following special named paths exist:
1751 The following special named paths exist:
1752
1752
1753 ``default``
1753 ``default``
1754 The URL or directory to use when no source or remote is specified.
1754 The URL or directory to use when no source or remote is specified.
1755
1755
1756 :hg:`clone` will automatically define this path to the location the
1756 :hg:`clone` will automatically define this path to the location the
1757 repository was cloned from.
1757 repository was cloned from.
1758
1758
1759 ``default-push``
1759 ``default-push``
1760 (deprecated) The URL or directory for the default :hg:`push` location.
1760 (deprecated) The URL or directory for the default :hg:`push` location.
1761 ``default:pushurl`` should be used instead.
1761 ``default:pushurl`` should be used instead.
1762
1762
1763 ``phases``
1763 ``phases``
1764 ----------
1764 ----------
1765
1765
1766 Specifies default handling of phases. See :hg:`help phases` for more
1766 Specifies default handling of phases. See :hg:`help phases` for more
1767 information about working with phases.
1767 information about working with phases.
1768
1768
1769 ``publish``
1769 ``publish``
1770 Controls draft phase behavior when working as a server. When true,
1770 Controls draft phase behavior when working as a server. When true,
1771 pushed changesets are set to public in both client and server and
1771 pushed changesets are set to public in both client and server and
1772 pulled or cloned changesets are set to public in the client.
1772 pulled or cloned changesets are set to public in the client.
1773 (default: True)
1773 (default: True)
1774
1774
1775 ``new-commit``
1775 ``new-commit``
1776 Phase of newly-created commits.
1776 Phase of newly-created commits.
1777 (default: draft)
1777 (default: draft)
1778
1778
1779 ``checksubrepos``
1779 ``checksubrepos``
1780 Check the phase of the current revision of each subrepository. Allowed
1780 Check the phase of the current revision of each subrepository. Allowed
1781 values are "ignore", "follow" and "abort". For settings other than
1781 values are "ignore", "follow" and "abort". For settings other than
1782 "ignore", the phase of the current revision of each subrepository is
1782 "ignore", the phase of the current revision of each subrepository is
1783 checked before committing the parent repository. If any of those phases is
1783 checked before committing the parent repository. If any of those phases is
1784 greater than the phase of the parent repository (e.g. if a subrepo is in a
1784 greater than the phase of the parent repository (e.g. if a subrepo is in a
1785 "secret" phase while the parent repo is in "draft" phase), the commit is
1785 "secret" phase while the parent repo is in "draft" phase), the commit is
1786 either aborted (if checksubrepos is set to "abort") or the higher phase is
1786 either aborted (if checksubrepos is set to "abort") or the higher phase is
1787 used for the parent repository commit (if set to "follow").
1787 used for the parent repository commit (if set to "follow").
1788 (default: follow)
1788 (default: follow)
1789
1789
1790
1790
1791 ``profiling``
1791 ``profiling``
1792 -------------
1792 -------------
1793
1793
1794 Specifies profiling type, format, and file output. Two profilers are
1794 Specifies profiling type, format, and file output. Two profilers are
1795 supported: an instrumenting profiler (named ``ls``), and a sampling
1795 supported: an instrumenting profiler (named ``ls``), and a sampling
1796 profiler (named ``stat``).
1796 profiler (named ``stat``).
1797
1797
1798 In this section description, 'profiling data' stands for the raw data
1798 In this section description, 'profiling data' stands for the raw data
1799 collected during profiling, while 'profiling report' stands for a
1799 collected during profiling, while 'profiling report' stands for a
1800 statistical text report generated from the profiling data.
1800 statistical text report generated from the profiling data.
1801
1801
1802 ``enabled``
1802 ``enabled``
1803 Enable the profiler.
1803 Enable the profiler.
1804 (default: false)
1804 (default: false)
1805
1805
1806 This is equivalent to passing ``--profile`` on the command line.
1806 This is equivalent to passing ``--profile`` on the command line.
1807
1807
1808 ``type``
1808 ``type``
1809 The type of profiler to use.
1809 The type of profiler to use.
1810 (default: stat)
1810 (default: stat)
1811
1811
1812 ``ls``
1812 ``ls``
1813 Use Python's built-in instrumenting profiler. This profiler
1813 Use Python's built-in instrumenting profiler. This profiler
1814 works on all platforms, but each line number it reports is the
1814 works on all platforms, but each line number it reports is the
1815 first line of a function. This restriction makes it difficult to
1815 first line of a function. This restriction makes it difficult to
1816 identify the expensive parts of a non-trivial function.
1816 identify the expensive parts of a non-trivial function.
1817 ``stat``
1817 ``stat``
1818 Use a statistical profiler, statprof. This profiler is most
1818 Use a statistical profiler, statprof. This profiler is most
1819 useful for profiling commands that run for longer than about 0.1
1819 useful for profiling commands that run for longer than about 0.1
1820 seconds.
1820 seconds.
1821
1821
1822 ``format``
1822 ``format``
1823 Profiling format. Specific to the ``ls`` instrumenting profiler.
1823 Profiling format. Specific to the ``ls`` instrumenting profiler.
1824 (default: text)
1824 (default: text)
1825
1825
1826 ``text``
1826 ``text``
1827 Generate a profiling report. When saving to a file, it should be
1827 Generate a profiling report. When saving to a file, it should be
1828 noted that only the report is saved, and the profiling data is
1828 noted that only the report is saved, and the profiling data is
1829 not kept.
1829 not kept.
1830 ``kcachegrind``
1830 ``kcachegrind``
1831 Format profiling data for kcachegrind use: when saving to a
1831 Format profiling data for kcachegrind use: when saving to a
1832 file, the generated file can directly be loaded into
1832 file, the generated file can directly be loaded into
1833 kcachegrind.
1833 kcachegrind.
1834
1834
1835 ``statformat``
1835 ``statformat``
1836 Profiling format for the ``stat`` profiler.
1836 Profiling format for the ``stat`` profiler.
1837 (default: hotpath)
1837 (default: hotpath)
1838
1838
1839 ``hotpath``
1839 ``hotpath``
1840 Show a tree-based display containing the hot path of execution (where
1840 Show a tree-based display containing the hot path of execution (where
1841 most time was spent).
1841 most time was spent).
1842 ``bymethod``
1842 ``bymethod``
1843 Show a table of methods ordered by how frequently they are active.
1843 Show a table of methods ordered by how frequently they are active.
1844 ``byline``
1844 ``byline``
1845 Show a table of lines in files ordered by how frequently they are active.
1845 Show a table of lines in files ordered by how frequently they are active.
1846 ``json``
1846 ``json``
1847 Render profiling data as JSON.
1847 Render profiling data as JSON.
1848
1848
1849 ``frequency``
1849 ``freq``
1850 Sampling frequency. Specific to the ``stat`` sampling profiler.
1850 Sampling frequency. Specific to the ``stat`` sampling profiler.
1851 (default: 1000)
1851 (default: 1000)
1852
1852
1853 ``output``
1853 ``output``
1854 File path where profiling data or report should be saved. If the
1854 File path where profiling data or report should be saved. If the
1855 file exists, it is replaced. (default: None, data is printed on
1855 file exists, it is replaced. (default: None, data is printed on
1856 stderr)
1856 stderr)
1857
1857
1858 ``sort``
1858 ``sort``
1859 Sort field. Specific to the ``ls`` instrumenting profiler.
1859 Sort field. Specific to the ``ls`` instrumenting profiler.
1860 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1860 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1861 ``inlinetime``.
1861 ``inlinetime``.
1862 (default: inlinetime)
1862 (default: inlinetime)
1863
1863
1864 ``time-track``
1864 ``time-track``
1865 Control if the stat profiler track ``cpu`` or ``real`` time.
1865 Control if the stat profiler track ``cpu`` or ``real`` time.
1866 (default: ``cpu`` on Windows, otherwise ``real``)
1866 (default: ``cpu`` on Windows, otherwise ``real``)
1867
1867
1868 ``limit``
1868 ``limit``
1869 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1869 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1870 (default: 30)
1870 (default: 30)
1871
1871
1872 ``nested``
1872 ``nested``
1873 Show at most this number of lines of drill-down info after each main entry.
1873 Show at most this number of lines of drill-down info after each main entry.
1874 This can help explain the difference between Total and Inline.
1874 This can help explain the difference between Total and Inline.
1875 Specific to the ``ls`` instrumenting profiler.
1875 Specific to the ``ls`` instrumenting profiler.
1876 (default: 0)
1876 (default: 0)
1877
1877
1878 ``showmin``
1878 ``showmin``
1879 Minimum fraction of samples an entry must have for it to be displayed.
1879 Minimum fraction of samples an entry must have for it to be displayed.
1880 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1880 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1881 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1881 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1882
1882
1883 Only used by the ``stat`` profiler.
1883 Only used by the ``stat`` profiler.
1884
1884
1885 For the ``hotpath`` format, default is ``0.05``.
1885 For the ``hotpath`` format, default is ``0.05``.
1886 For the ``chrome`` format, default is ``0.005``.
1886 For the ``chrome`` format, default is ``0.005``.
1887
1887
1888 The option is unused on other formats.
1888 The option is unused on other formats.
1889
1889
1890 ``showmax``
1890 ``showmax``
1891 Maximum fraction of samples an entry can have before it is ignored in
1891 Maximum fraction of samples an entry can have before it is ignored in
1892 display. Values format is the same as ``showmin``.
1892 display. Values format is the same as ``showmin``.
1893
1893
1894 Only used by the ``stat`` profiler.
1894 Only used by the ``stat`` profiler.
1895
1895
1896 For the ``chrome`` format, default is ``0.999``.
1896 For the ``chrome`` format, default is ``0.999``.
1897
1897
1898 The option is unused on other formats.
1898 The option is unused on other formats.
1899
1899
1900 ``showtime``
1900 ``showtime``
1901 Show time taken as absolute durations, in addition to percentages.
1901 Show time taken as absolute durations, in addition to percentages.
1902 Only used by the ``hotpath`` format.
1902 Only used by the ``hotpath`` format.
1903 (default: true)
1903 (default: true)
1904
1904
1905 ``progress``
1905 ``progress``
1906 ------------
1906 ------------
1907
1907
1908 Mercurial commands can draw progress bars that are as informative as
1908 Mercurial commands can draw progress bars that are as informative as
1909 possible. Some progress bars only offer indeterminate information, while others
1909 possible. Some progress bars only offer indeterminate information, while others
1910 have a definite end point.
1910 have a definite end point.
1911
1911
1912 ``debug``
1912 ``debug``
1913 Whether to print debug info when updating the progress bar. (default: False)
1913 Whether to print debug info when updating the progress bar. (default: False)
1914
1914
1915 ``delay``
1915 ``delay``
1916 Number of seconds (float) before showing the progress bar. (default: 3)
1916 Number of seconds (float) before showing the progress bar. (default: 3)
1917
1917
1918 ``changedelay``
1918 ``changedelay``
1919 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1919 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1920 that value will be used instead. (default: 1)
1920 that value will be used instead. (default: 1)
1921
1921
1922 ``estimateinterval``
1922 ``estimateinterval``
1923 Maximum sampling interval in seconds for speed and estimated time
1923 Maximum sampling interval in seconds for speed and estimated time
1924 calculation. (default: 60)
1924 calculation. (default: 60)
1925
1925
1926 ``refresh``
1926 ``refresh``
1927 Time in seconds between refreshes of the progress bar. (default: 0.1)
1927 Time in seconds between refreshes of the progress bar. (default: 0.1)
1928
1928
1929 ``format``
1929 ``format``
1930 Format of the progress bar.
1930 Format of the progress bar.
1931
1931
1932 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1932 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1933 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1933 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1934 last 20 characters of the item, but this can be changed by adding either
1934 last 20 characters of the item, but this can be changed by adding either
1935 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1935 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1936 first num characters.
1936 first num characters.
1937
1937
1938 (default: topic bar number estimate)
1938 (default: topic bar number estimate)
1939
1939
1940 ``width``
1940 ``width``
1941 If set, the maximum width of the progress information (that is, min(width,
1941 If set, the maximum width of the progress information (that is, min(width,
1942 term width) will be used).
1942 term width) will be used).
1943
1943
1944 ``clear-complete``
1944 ``clear-complete``
1945 Clear the progress bar after it's done. (default: True)
1945 Clear the progress bar after it's done. (default: True)
1946
1946
1947 ``disable``
1947 ``disable``
1948 If true, don't show a progress bar.
1948 If true, don't show a progress bar.
1949
1949
1950 ``assume-tty``
1950 ``assume-tty``
1951 If true, ALWAYS show a progress bar, unless disable is given.
1951 If true, ALWAYS show a progress bar, unless disable is given.
1952
1952
1953 ``rebase``
1953 ``rebase``
1954 ----------
1954 ----------
1955
1955
1956 ``evolution.allowdivergence``
1956 ``evolution.allowdivergence``
1957 Default to False, when True allow creating divergence when performing
1957 Default to False, when True allow creating divergence when performing
1958 rebase of obsolete changesets.
1958 rebase of obsolete changesets.
1959
1959
1960 ``revsetalias``
1960 ``revsetalias``
1961 ---------------
1961 ---------------
1962
1962
1963 Alias definitions for revsets. See :hg:`help revsets` for details.
1963 Alias definitions for revsets. See :hg:`help revsets` for details.
1964
1964
1965 ``rewrite``
1965 ``rewrite``
1966 -----------
1966 -----------
1967
1967
1968 ``backup-bundle``
1968 ``backup-bundle``
1969 Whether to save stripped changesets to a bundle file. (default: True)
1969 Whether to save stripped changesets to a bundle file. (default: True)
1970
1970
1971 ``update-timestamp``
1971 ``update-timestamp``
1972 If true, updates the date and time of the changeset to current. It is only
1972 If true, updates the date and time of the changeset to current. It is only
1973 applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
1973 applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
1974 current version.
1974 current version.
1975
1975
1976 ``empty-successor``
1976 ``empty-successor``
1977
1977
1978 Control what happens with empty successors that are the result of rewrite
1978 Control what happens with empty successors that are the result of rewrite
1979 operations. If set to ``skip``, the successor is not created. If set to
1979 operations. If set to ``skip``, the successor is not created. If set to
1980 ``keep``, the empty successor is created and kept.
1980 ``keep``, the empty successor is created and kept.
1981
1981
1982 Currently, only the rebase and absorb commands consider this configuration.
1982 Currently, only the rebase and absorb commands consider this configuration.
1983 (EXPERIMENTAL)
1983 (EXPERIMENTAL)
1984
1984
1985 ``share``
1985 ``share``
1986 ---------
1986 ---------
1987
1987
1988 ``safe-mismatch.source-safe``
1988 ``safe-mismatch.source-safe``
1989
1989
1990 Controls what happens when the shared repository does not use the
1990 Controls what happens when the shared repository does not use the
1991 share-safe mechanism but its source repository does.
1991 share-safe mechanism but its source repository does.
1992
1992
1993 Possible values are `abort` (default), `allow`, `upgrade-abort` and
1993 Possible values are `abort` (default), `allow`, `upgrade-abort` and
1994 `upgrade-abort`.
1994 `upgrade-abort`.
1995
1995
1996 ``abort``
1996 ``abort``
1997 Disallows running any command and aborts
1997 Disallows running any command and aborts
1998 ``allow``
1998 ``allow``
1999 Respects the feature presence in the share source
1999 Respects the feature presence in the share source
2000 ``upgrade-abort``
2000 ``upgrade-abort``
2001 tries to upgrade the share to use share-safe; if it fails, aborts
2001 tries to upgrade the share to use share-safe; if it fails, aborts
2002 ``upgrade-allow``
2002 ``upgrade-allow``
2003 tries to upgrade the share; if it fails, continue by
2003 tries to upgrade the share; if it fails, continue by
2004 respecting the share source setting
2004 respecting the share source setting
2005
2005
2006 Check :hg:`help config format.use-share-safe` for details about the
2006 Check :hg:`help config format.use-share-safe` for details about the
2007 share-safe feature.
2007 share-safe feature.
2008
2008
2009 ``safe-mismatch.source-safe.warn``
2009 ``safe-mismatch.source-safe.warn``
2010 Shows a warning on operations if the shared repository does not use
2010 Shows a warning on operations if the shared repository does not use
2011 share-safe, but the source repository does.
2011 share-safe, but the source repository does.
2012 (default: True)
2012 (default: True)
2013
2013
2014 ``safe-mismatch.source-not-safe``
2014 ``safe-mismatch.source-not-safe``
2015
2015
2016 Controls what happens when the shared repository uses the share-safe
2016 Controls what happens when the shared repository uses the share-safe
2017 mechanism but its source does not.
2017 mechanism but its source does not.
2018
2018
2019 Possible values are `abort` (default), `allow`, `downgrade-abort` and
2019 Possible values are `abort` (default), `allow`, `downgrade-abort` and
2020 `downgrade-abort`.
2020 `downgrade-abort`.
2021
2021
2022 ``abort``
2022 ``abort``
2023 Disallows running any command and aborts
2023 Disallows running any command and aborts
2024 ``allow``
2024 ``allow``
2025 Respects the feature presence in the share source
2025 Respects the feature presence in the share source
2026 ``downgrade-abort``
2026 ``downgrade-abort``
2027 tries to downgrade the share to not use share-safe; if it fails, aborts
2027 tries to downgrade the share to not use share-safe; if it fails, aborts
2028 ``downgrade-allow``
2028 ``downgrade-allow``
2029 tries to downgrade the share to not use share-safe;
2029 tries to downgrade the share to not use share-safe;
2030 if it fails, continue by respecting the shared source setting
2030 if it fails, continue by respecting the shared source setting
2031
2031
2032 Check :hg:`help config format.use-share-safe` for details about the
2032 Check :hg:`help config format.use-share-safe` for details about the
2033 share-safe feature.
2033 share-safe feature.
2034
2034
2035 ``safe-mismatch.source-not-safe.warn``
2035 ``safe-mismatch.source-not-safe.warn``
2036 Shows a warning on operations if the shared repository uses share-safe,
2036 Shows a warning on operations if the shared repository uses share-safe,
2037 but the source repository does not.
2037 but the source repository does not.
2038 (default: True)
2038 (default: True)
2039
2039
2040 ``storage``
2040 ``storage``
2041 -----------
2041 -----------
2042
2042
2043 Control the strategy Mercurial uses internally to store history. Options in this
2043 Control the strategy Mercurial uses internally to store history. Options in this
2044 category impact performance and repository size.
2044 category impact performance and repository size.
2045
2045
2046 ``revlog.optimize-delta-parent-choice``
2046 ``revlog.optimize-delta-parent-choice``
2047 When storing a merge revision, both parents will be equally considered as
2047 When storing a merge revision, both parents will be equally considered as
2048 a possible delta base. This results in better delta selection and improved
2048 a possible delta base. This results in better delta selection and improved
2049 revlog compression. This option is enabled by default.
2049 revlog compression. This option is enabled by default.
2050
2050
2051 Turning this option off can result in large increase of repository size for
2051 Turning this option off can result in large increase of repository size for
2052 repository with many merges.
2052 repository with many merges.
2053
2053
2054 ``revlog.persistent-nodemap.mmap``
2054 ``revlog.persistent-nodemap.mmap``
2055 Whether to use the Operating System "memory mapping" feature (when
2055 Whether to use the Operating System "memory mapping" feature (when
2056 possible) to access the persistent nodemap data. This improve performance
2056 possible) to access the persistent nodemap data. This improve performance
2057 and reduce memory pressure.
2057 and reduce memory pressure.
2058
2058
2059 Default to True.
2059 Default to True.
2060
2060
2061 For details on the "persistent-nodemap" feature, see:
2061 For details on the "persistent-nodemap" feature, see:
2062 :hg:`help config format.use-persistent-nodemap`.
2062 :hg:`help config format.use-persistent-nodemap`.
2063
2063
2064 ``revlog.persistent-nodemap.slow-path``
2064 ``revlog.persistent-nodemap.slow-path``
2065 Control the behavior of Merucrial when using a repository with "persistent"
2065 Control the behavior of Merucrial when using a repository with "persistent"
2066 nodemap with an installation of Mercurial without a fast implementation for
2066 nodemap with an installation of Mercurial without a fast implementation for
2067 the feature:
2067 the feature:
2068
2068
2069 ``allow``: Silently use the slower implementation to access the repository.
2069 ``allow``: Silently use the slower implementation to access the repository.
2070 ``warn``: Warn, but use the slower implementation to access the repository.
2070 ``warn``: Warn, but use the slower implementation to access the repository.
2071 ``abort``: Prevent access to such repositories. (This is the default)
2071 ``abort``: Prevent access to such repositories. (This is the default)
2072
2072
2073 For details on the "persistent-nodemap" feature, see:
2073 For details on the "persistent-nodemap" feature, see:
2074 :hg:`help config format.use-persistent-nodemap`.
2074 :hg:`help config format.use-persistent-nodemap`.
2075
2075
2076 ``revlog.reuse-external-delta-parent``
2076 ``revlog.reuse-external-delta-parent``
2077 Control the order in which delta parents are considered when adding new
2077 Control the order in which delta parents are considered when adding new
2078 revisions from an external source.
2078 revisions from an external source.
2079 (typically: apply bundle from `hg pull` or `hg push`).
2079 (typically: apply bundle from `hg pull` or `hg push`).
2080
2080
2081 New revisions are usually provided as a delta against other revisions. By
2081 New revisions are usually provided as a delta against other revisions. By
2082 default, Mercurial will try to reuse this delta first, therefore using the
2082 default, Mercurial will try to reuse this delta first, therefore using the
2083 same "delta parent" as the source. Directly using delta's from the source
2083 same "delta parent" as the source. Directly using delta's from the source
2084 reduces CPU usage and usually speeds up operation. However, in some case,
2084 reduces CPU usage and usually speeds up operation. However, in some case,
2085 the source might have sub-optimal delta bases and forcing their reevaluation
2085 the source might have sub-optimal delta bases and forcing their reevaluation
2086 is useful. For example, pushes from an old client could have sub-optimal
2086 is useful. For example, pushes from an old client could have sub-optimal
2087 delta's parent that the server want to optimize. (lack of general delta, bad
2087 delta's parent that the server want to optimize. (lack of general delta, bad
2088 parents, choice, lack of sparse-revlog, etc).
2088 parents, choice, lack of sparse-revlog, etc).
2089
2089
2090 This option is enabled by default. Turning it off will ensure bad delta
2090 This option is enabled by default. Turning it off will ensure bad delta
2091 parent choices from older client do not propagate to this repository, at
2091 parent choices from older client do not propagate to this repository, at
2092 the cost of a small increase in CPU consumption.
2092 the cost of a small increase in CPU consumption.
2093
2093
2094 Note: this option only control the order in which delta parents are
2094 Note: this option only control the order in which delta parents are
2095 considered. Even when disabled, the existing delta from the source will be
2095 considered. Even when disabled, the existing delta from the source will be
2096 reused if the same delta parent is selected.
2096 reused if the same delta parent is selected.
2097
2097
2098 ``revlog.reuse-external-delta``
2098 ``revlog.reuse-external-delta``
2099 Control the reuse of delta from external source.
2099 Control the reuse of delta from external source.
2100 (typically: apply bundle from `hg pull` or `hg push`).
2100 (typically: apply bundle from `hg pull` or `hg push`).
2101
2101
2102 New revisions are usually provided as a delta against another revision. By
2102 New revisions are usually provided as a delta against another revision. By
2103 default, Mercurial will not recompute the same delta again, trusting
2103 default, Mercurial will not recompute the same delta again, trusting
2104 externally provided deltas. There have been rare cases of small adjustment
2104 externally provided deltas. There have been rare cases of small adjustment
2105 to the diffing algorithm in the past. So in some rare case, recomputing
2105 to the diffing algorithm in the past. So in some rare case, recomputing
2106 delta provided by ancient clients can provides better results. Disabling
2106 delta provided by ancient clients can provides better results. Disabling
2107 this option means going through a full delta recomputation for all incoming
2107 this option means going through a full delta recomputation for all incoming
2108 revisions. It means a large increase in CPU usage and will slow operations
2108 revisions. It means a large increase in CPU usage and will slow operations
2109 down.
2109 down.
2110
2110
2111 This option is enabled by default. When disabled, it also disables the
2111 This option is enabled by default. When disabled, it also disables the
2112 related ``storage.revlog.reuse-external-delta-parent`` option.
2112 related ``storage.revlog.reuse-external-delta-parent`` option.
2113
2113
2114 ``revlog.zlib.level``
2114 ``revlog.zlib.level``
2115 Zlib compression level used when storing data into the repository. Accepted
2115 Zlib compression level used when storing data into the repository. Accepted
2116 Value range from 1 (lowest compression) to 9 (highest compression). Zlib
2116 Value range from 1 (lowest compression) to 9 (highest compression). Zlib
2117 default value is 6.
2117 default value is 6.
2118
2118
2119
2119
2120 ``revlog.zstd.level``
2120 ``revlog.zstd.level``
2121 zstd compression level used when storing data into the repository. Accepted
2121 zstd compression level used when storing data into the repository. Accepted
2122 Value range from 1 (lowest compression) to 22 (highest compression).
2122 Value range from 1 (lowest compression) to 22 (highest compression).
2123 (default 3)
2123 (default 3)
2124
2124
2125 ``server``
2125 ``server``
2126 ----------
2126 ----------
2127
2127
2128 Controls generic server settings.
2128 Controls generic server settings.
2129
2129
2130 ``bookmarks-pushkey-compat``
2130 ``bookmarks-pushkey-compat``
2131 Trigger pushkey hook when being pushed bookmark updates. This config exist
2131 Trigger pushkey hook when being pushed bookmark updates. This config exist
2132 for compatibility purpose (default to True)
2132 for compatibility purpose (default to True)
2133
2133
2134 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
2134 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
2135 movement we recommend you migrate them to ``txnclose-bookmark`` and
2135 movement we recommend you migrate them to ``txnclose-bookmark`` and
2136 ``pretxnclose-bookmark``.
2136 ``pretxnclose-bookmark``.
2137
2137
2138 ``compressionengines``
2138 ``compressionengines``
2139 List of compression engines and their relative priority to advertise
2139 List of compression engines and their relative priority to advertise
2140 to clients.
2140 to clients.
2141
2141
2142 The order of compression engines determines their priority, the first
2142 The order of compression engines determines their priority, the first
2143 having the highest priority. If a compression engine is not listed
2143 having the highest priority. If a compression engine is not listed
2144 here, it won't be advertised to clients.
2144 here, it won't be advertised to clients.
2145
2145
2146 If not set (the default), built-in defaults are used. Run
2146 If not set (the default), built-in defaults are used. Run
2147 :hg:`debuginstall` to list available compression engines and their
2147 :hg:`debuginstall` to list available compression engines and their
2148 default wire protocol priority.
2148 default wire protocol priority.
2149
2149
2150 Older Mercurial clients only support zlib compression and this setting
2150 Older Mercurial clients only support zlib compression and this setting
2151 has no effect for legacy clients.
2151 has no effect for legacy clients.
2152
2152
2153 ``uncompressed``
2153 ``uncompressed``
2154 Whether to allow clients to clone a repository using the
2154 Whether to allow clients to clone a repository using the
2155 uncompressed streaming protocol. This transfers about 40% more
2155 uncompressed streaming protocol. This transfers about 40% more
2156 data than a regular clone, but uses less memory and CPU on both
2156 data than a regular clone, but uses less memory and CPU on both
2157 server and client. Over a LAN (100 Mbps or better) or a very fast
2157 server and client. Over a LAN (100 Mbps or better) or a very fast
2158 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
2158 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
2159 regular clone. Over most WAN connections (anything slower than
2159 regular clone. Over most WAN connections (anything slower than
2160 about 6 Mbps), uncompressed streaming is slower, because of the
2160 about 6 Mbps), uncompressed streaming is slower, because of the
2161 extra data transfer overhead. This mode will also temporarily hold
2161 extra data transfer overhead. This mode will also temporarily hold
2162 the write lock while determining what data to transfer.
2162 the write lock while determining what data to transfer.
2163 (default: True)
2163 (default: True)
2164
2164
2165 ``uncompressedallowsecret``
2165 ``uncompressedallowsecret``
2166 Whether to allow stream clones when the repository contains secret
2166 Whether to allow stream clones when the repository contains secret
2167 changesets. (default: False)
2167 changesets. (default: False)
2168
2168
2169 ``preferuncompressed``
2169 ``preferuncompressed``
2170 When set, clients will try to use the uncompressed streaming
2170 When set, clients will try to use the uncompressed streaming
2171 protocol. (default: False)
2171 protocol. (default: False)
2172
2172
2173 ``disablefullbundle``
2173 ``disablefullbundle``
2174 When set, servers will refuse attempts to do pull-based clones.
2174 When set, servers will refuse attempts to do pull-based clones.
2175 If this option is set, ``preferuncompressed`` and/or clone bundles
2175 If this option is set, ``preferuncompressed`` and/or clone bundles
2176 are highly recommended. Partial clones will still be allowed.
2176 are highly recommended. Partial clones will still be allowed.
2177 (default: False)
2177 (default: False)
2178
2178
2179 ``streamunbundle``
2179 ``streamunbundle``
2180 When set, servers will apply data sent from the client directly,
2180 When set, servers will apply data sent from the client directly,
2181 otherwise it will be written to a temporary file first. This option
2181 otherwise it will be written to a temporary file first. This option
2182 effectively prevents concurrent pushes.
2182 effectively prevents concurrent pushes.
2183
2183
2184 ``pullbundle``
2184 ``pullbundle``
2185 When set, the server will check pullbundle.manifest for bundles
2185 When set, the server will check pullbundle.manifest for bundles
2186 covering the requested heads and common nodes. The first matching
2186 covering the requested heads and common nodes. The first matching
2187 entry will be streamed to the client.
2187 entry will be streamed to the client.
2188
2188
2189 For HTTP transport, the stream will still use zlib compression
2189 For HTTP transport, the stream will still use zlib compression
2190 for older clients.
2190 for older clients.
2191
2191
2192 ``concurrent-push-mode``
2192 ``concurrent-push-mode``
2193 Level of allowed race condition between two pushing clients.
2193 Level of allowed race condition between two pushing clients.
2194
2194
2195 - 'strict': push is abort if another client touched the repository
2195 - 'strict': push is abort if another client touched the repository
2196 while the push was preparing.
2196 while the push was preparing.
2197 - 'check-related': push is only aborted if it affects head that got also
2197 - 'check-related': push is only aborted if it affects head that got also
2198 affected while the push was preparing. (default since 5.4)
2198 affected while the push was preparing. (default since 5.4)
2199
2199
2200 'check-related' only takes effect for compatible clients (version
2200 'check-related' only takes effect for compatible clients (version
2201 4.3 and later). Older clients will use 'strict'.
2201 4.3 and later). Older clients will use 'strict'.
2202
2202
2203 ``validate``
2203 ``validate``
2204 Whether to validate the completeness of pushed changesets by
2204 Whether to validate the completeness of pushed changesets by
2205 checking that all new file revisions specified in manifests are
2205 checking that all new file revisions specified in manifests are
2206 present. (default: False)
2206 present. (default: False)
2207
2207
2208 ``maxhttpheaderlen``
2208 ``maxhttpheaderlen``
2209 Instruct HTTP clients not to send request headers longer than this
2209 Instruct HTTP clients not to send request headers longer than this
2210 many bytes. (default: 1024)
2210 many bytes. (default: 1024)
2211
2211
2212 ``bundle1``
2212 ``bundle1``
2213 Whether to allow clients to push and pull using the legacy bundle1
2213 Whether to allow clients to push and pull using the legacy bundle1
2214 exchange format. (default: True)
2214 exchange format. (default: True)
2215
2215
2216 ``bundle1gd``
2216 ``bundle1gd``
2217 Like ``bundle1`` but only used if the repository is using the
2217 Like ``bundle1`` 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.push``
2220 ``bundle1.push``
2221 Whether to allow clients to push using the legacy bundle1 exchange
2221 Whether to allow clients to push using the legacy bundle1 exchange
2222 format. (default: True)
2222 format. (default: True)
2223
2223
2224 ``bundle1gd.push``
2224 ``bundle1gd.push``
2225 Like ``bundle1.push`` but only used if the repository is using the
2225 Like ``bundle1.push`` but only used if the repository is using the
2226 *generaldelta* storage format. (default: True)
2226 *generaldelta* storage format. (default: True)
2227
2227
2228 ``bundle1.pull``
2228 ``bundle1.pull``
2229 Whether to allow clients to pull using the legacy bundle1 exchange
2229 Whether to allow clients to pull using the legacy bundle1 exchange
2230 format. (default: True)
2230 format. (default: True)
2231
2231
2232 ``bundle1gd.pull``
2232 ``bundle1gd.pull``
2233 Like ``bundle1.pull`` but only used if the repository is using the
2233 Like ``bundle1.pull`` but only used if the repository is using the
2234 *generaldelta* storage format. (default: True)
2234 *generaldelta* storage format. (default: True)
2235
2235
2236 Large repositories using the *generaldelta* storage format should
2236 Large repositories using the *generaldelta* storage format should
2237 consider setting this option because converting *generaldelta*
2237 consider setting this option because converting *generaldelta*
2238 repositories to the exchange format required by the bundle1 data
2238 repositories to the exchange format required by the bundle1 data
2239 format can consume a lot of CPU.
2239 format can consume a lot of CPU.
2240
2240
2241 ``bundle2.stream``
2241 ``bundle2.stream``
2242 Whether to allow clients to pull using the bundle2 streaming protocol.
2242 Whether to allow clients to pull using the bundle2 streaming protocol.
2243 (default: True)
2243 (default: True)
2244
2244
2245 ``zliblevel``
2245 ``zliblevel``
2246 Integer between ``-1`` and ``9`` that controls the zlib compression level
2246 Integer between ``-1`` and ``9`` that controls the zlib compression level
2247 for wire protocol commands that send zlib compressed output (notably the
2247 for wire protocol commands that send zlib compressed output (notably the
2248 commands that send repository history data).
2248 commands that send repository history data).
2249
2249
2250 The default (``-1``) uses the default zlib compression level, which is
2250 The default (``-1``) uses the default zlib compression level, which is
2251 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
2251 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
2252 maximum compression.
2252 maximum compression.
2253
2253
2254 Setting this option allows server operators to make trade-offs between
2254 Setting this option allows server operators to make trade-offs between
2255 bandwidth and CPU used. Lowering the compression lowers CPU utilization
2255 bandwidth and CPU used. Lowering the compression lowers CPU utilization
2256 but sends more bytes to clients.
2256 but sends more bytes to clients.
2257
2257
2258 This option only impacts the HTTP server.
2258 This option only impacts the HTTP server.
2259
2259
2260 ``zstdlevel``
2260 ``zstdlevel``
2261 Integer between ``1`` and ``22`` that controls the zstd compression level
2261 Integer between ``1`` and ``22`` that controls the zstd compression level
2262 for wire protocol commands. ``1`` is the minimal amount of compression and
2262 for wire protocol commands. ``1`` is the minimal amount of compression and
2263 ``22`` is the highest amount of compression.
2263 ``22`` is the highest amount of compression.
2264
2264
2265 The default (``3``) should be significantly faster than zlib while likely
2265 The default (``3``) should be significantly faster than zlib while likely
2266 delivering better compression ratios.
2266 delivering better compression ratios.
2267
2267
2268 This option only impacts the HTTP server.
2268 This option only impacts the HTTP server.
2269
2269
2270 See also ``server.zliblevel``.
2270 See also ``server.zliblevel``.
2271
2271
2272 ``view``
2272 ``view``
2273 Repository filter used when exchanging revisions with the peer.
2273 Repository filter used when exchanging revisions with the peer.
2274
2274
2275 The default view (``served``) excludes secret and hidden changesets.
2275 The default view (``served``) excludes secret and hidden changesets.
2276 Another useful value is ``immutable`` (no draft, secret or hidden
2276 Another useful value is ``immutable`` (no draft, secret or hidden
2277 changesets). (EXPERIMENTAL)
2277 changesets). (EXPERIMENTAL)
2278
2278
2279 ``smtp``
2279 ``smtp``
2280 --------
2280 --------
2281
2281
2282 Configuration for extensions that need to send email messages.
2282 Configuration for extensions that need to send email messages.
2283
2283
2284 ``host``
2284 ``host``
2285 Host name of mail server, e.g. "mail.example.com".
2285 Host name of mail server, e.g. "mail.example.com".
2286
2286
2287 ``port``
2287 ``port``
2288 Optional. Port to connect to on mail server. (default: 465 if
2288 Optional. Port to connect to on mail server. (default: 465 if
2289 ``tls`` is smtps; 25 otherwise)
2289 ``tls`` is smtps; 25 otherwise)
2290
2290
2291 ``tls``
2291 ``tls``
2292 Optional. Method to enable TLS when connecting to mail server: starttls,
2292 Optional. Method to enable TLS when connecting to mail server: starttls,
2293 smtps or none. (default: none)
2293 smtps or none. (default: none)
2294
2294
2295 ``username``
2295 ``username``
2296 Optional. User name for authenticating with the SMTP server.
2296 Optional. User name for authenticating with the SMTP server.
2297 (default: None)
2297 (default: None)
2298
2298
2299 ``password``
2299 ``password``
2300 Optional. Password for authenticating with the SMTP server. If not
2300 Optional. Password for authenticating with the SMTP server. If not
2301 specified, interactive sessions will prompt the user for a
2301 specified, interactive sessions will prompt the user for a
2302 password; non-interactive sessions will fail. (default: None)
2302 password; non-interactive sessions will fail. (default: None)
2303
2303
2304 ``local_hostname``
2304 ``local_hostname``
2305 Optional. The hostname that the sender can use to identify
2305 Optional. The hostname that the sender can use to identify
2306 itself to the MTA.
2306 itself to the MTA.
2307
2307
2308
2308
2309 ``subpaths``
2309 ``subpaths``
2310 ------------
2310 ------------
2311
2311
2312 Subrepository source URLs can go stale if a remote server changes name
2312 Subrepository source URLs can go stale if a remote server changes name
2313 or becomes temporarily unavailable. This section lets you define
2313 or becomes temporarily unavailable. This section lets you define
2314 rewrite rules of the form::
2314 rewrite rules of the form::
2315
2315
2316 <pattern> = <replacement>
2316 <pattern> = <replacement>
2317
2317
2318 where ``pattern`` is a regular expression matching a subrepository
2318 where ``pattern`` is a regular expression matching a subrepository
2319 source URL and ``replacement`` is the replacement string used to
2319 source URL and ``replacement`` is the replacement string used to
2320 rewrite it. Groups can be matched in ``pattern`` and referenced in
2320 rewrite it. Groups can be matched in ``pattern`` and referenced in
2321 ``replacements``. For instance::
2321 ``replacements``. For instance::
2322
2322
2323 http://server/(.*)-hg/ = http://hg.server/\1/
2323 http://server/(.*)-hg/ = http://hg.server/\1/
2324
2324
2325 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2325 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2326
2326
2327 Relative subrepository paths are first made absolute, and the
2327 Relative subrepository paths are first made absolute, and the
2328 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2328 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2329 doesn't match the full path, an attempt is made to apply it on the
2329 doesn't match the full path, an attempt is made to apply it on the
2330 relative path alone. The rules are applied in definition order.
2330 relative path alone. The rules are applied in definition order.
2331
2331
2332 ``subrepos``
2332 ``subrepos``
2333 ------------
2333 ------------
2334
2334
2335 This section contains options that control the behavior of the
2335 This section contains options that control the behavior of the
2336 subrepositories feature. See also :hg:`help subrepos`.
2336 subrepositories feature. See also :hg:`help subrepos`.
2337
2337
2338 Security note: auditing in Mercurial is known to be insufficient to
2338 Security note: auditing in Mercurial is known to be insufficient to
2339 prevent clone-time code execution with carefully constructed Git
2339 prevent clone-time code execution with carefully constructed Git
2340 subrepos. It is unknown if a similar detect is present in Subversion
2340 subrepos. It is unknown if a similar detect is present in Subversion
2341 subrepos. Both Git and Subversion subrepos are disabled by default
2341 subrepos. Both Git and Subversion subrepos are disabled by default
2342 out of security concerns. These subrepo types can be enabled using
2342 out of security concerns. These subrepo types can be enabled using
2343 the respective options below.
2343 the respective options below.
2344
2344
2345 ``allowed``
2345 ``allowed``
2346 Whether subrepositories are allowed in the working directory.
2346 Whether subrepositories are allowed in the working directory.
2347
2347
2348 When false, commands involving subrepositories (like :hg:`update`)
2348 When false, commands involving subrepositories (like :hg:`update`)
2349 will fail for all subrepository types.
2349 will fail for all subrepository types.
2350 (default: true)
2350 (default: true)
2351
2351
2352 ``hg:allowed``
2352 ``hg:allowed``
2353 Whether Mercurial subrepositories are allowed in the working
2353 Whether Mercurial subrepositories are allowed in the working
2354 directory. This option only has an effect if ``subrepos.allowed``
2354 directory. This option only has an effect if ``subrepos.allowed``
2355 is true.
2355 is true.
2356 (default: true)
2356 (default: true)
2357
2357
2358 ``git:allowed``
2358 ``git:allowed``
2359 Whether Git subrepositories are allowed in the working directory.
2359 Whether Git subrepositories are allowed in the working directory.
2360 This option only has an effect if ``subrepos.allowed`` is true.
2360 This option only has an effect if ``subrepos.allowed`` is true.
2361
2361
2362 See the security note above before enabling Git subrepos.
2362 See the security note above before enabling Git subrepos.
2363 (default: false)
2363 (default: false)
2364
2364
2365 ``svn:allowed``
2365 ``svn:allowed``
2366 Whether Subversion subrepositories are allowed in the working
2366 Whether Subversion subrepositories are allowed in the working
2367 directory. This option only has an effect if ``subrepos.allowed``
2367 directory. This option only has an effect if ``subrepos.allowed``
2368 is true.
2368 is true.
2369
2369
2370 See the security note above before enabling Subversion subrepos.
2370 See the security note above before enabling Subversion subrepos.
2371 (default: false)
2371 (default: false)
2372
2372
2373 ``templatealias``
2373 ``templatealias``
2374 -----------------
2374 -----------------
2375
2375
2376 Alias definitions for templates. See :hg:`help templates` for details.
2376 Alias definitions for templates. See :hg:`help templates` for details.
2377
2377
2378 ``templates``
2378 ``templates``
2379 -------------
2379 -------------
2380
2380
2381 Use the ``[templates]`` section to define template strings.
2381 Use the ``[templates]`` section to define template strings.
2382 See :hg:`help templates` for details.
2382 See :hg:`help templates` for details.
2383
2383
2384 ``trusted``
2384 ``trusted``
2385 -----------
2385 -----------
2386
2386
2387 Mercurial will not use the settings in the
2387 Mercurial will not use the settings in the
2388 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2388 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2389 user or to a trusted group, as various hgrc features allow arbitrary
2389 user or to a trusted group, as various hgrc features allow arbitrary
2390 commands to be run. This issue is often encountered when configuring
2390 commands to be run. This issue is often encountered when configuring
2391 hooks or extensions for shared repositories or servers. However,
2391 hooks or extensions for shared repositories or servers. However,
2392 the web interface will use some safe settings from the ``[web]``
2392 the web interface will use some safe settings from the ``[web]``
2393 section.
2393 section.
2394
2394
2395 This section specifies what users and groups are trusted. The
2395 This section specifies what users and groups are trusted. The
2396 current user is always trusted. To trust everybody, list a user or a
2396 current user is always trusted. To trust everybody, list a user or a
2397 group with name ``*``. These settings must be placed in an
2397 group with name ``*``. These settings must be placed in an
2398 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2398 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2399 user or service running Mercurial.
2399 user or service running Mercurial.
2400
2400
2401 ``users``
2401 ``users``
2402 Comma-separated list of trusted users.
2402 Comma-separated list of trusted users.
2403
2403
2404 ``groups``
2404 ``groups``
2405 Comma-separated list of trusted groups.
2405 Comma-separated list of trusted groups.
2406
2406
2407
2407
2408 ``ui``
2408 ``ui``
2409 ------
2409 ------
2410
2410
2411 User interface controls.
2411 User interface controls.
2412
2412
2413 ``archivemeta``
2413 ``archivemeta``
2414 Whether to include the .hg_archival.txt file containing meta data
2414 Whether to include the .hg_archival.txt file containing meta data
2415 (hashes for the repository base and for tip) in archives created
2415 (hashes for the repository base and for tip) in archives created
2416 by the :hg:`archive` command or downloaded via hgweb.
2416 by the :hg:`archive` command or downloaded via hgweb.
2417 (default: True)
2417 (default: True)
2418
2418
2419 ``askusername``
2419 ``askusername``
2420 Whether to prompt for a username when committing. If True, and
2420 Whether to prompt for a username when committing. If True, and
2421 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2421 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2422 be prompted to enter a username. If no username is entered, the
2422 be prompted to enter a username. If no username is entered, the
2423 default ``USER@HOST`` is used instead.
2423 default ``USER@HOST`` is used instead.
2424 (default: False)
2424 (default: False)
2425
2425
2426 ``clonebundles``
2426 ``clonebundles``
2427 Whether the "clone bundles" feature is enabled.
2427 Whether the "clone bundles" feature is enabled.
2428
2428
2429 When enabled, :hg:`clone` may download and apply a server-advertised
2429 When enabled, :hg:`clone` may download and apply a server-advertised
2430 bundle file from a URL instead of using the normal exchange mechanism.
2430 bundle file from a URL instead of using the normal exchange mechanism.
2431
2431
2432 This can likely result in faster and more reliable clones.
2432 This can likely result in faster and more reliable clones.
2433
2433
2434 (default: True)
2434 (default: True)
2435
2435
2436 ``clonebundlefallback``
2436 ``clonebundlefallback``
2437 Whether failure to apply an advertised "clone bundle" from a server
2437 Whether failure to apply an advertised "clone bundle" from a server
2438 should result in fallback to a regular clone.
2438 should result in fallback to a regular clone.
2439
2439
2440 This is disabled by default because servers advertising "clone
2440 This is disabled by default because servers advertising "clone
2441 bundles" often do so to reduce server load. If advertised bundles
2441 bundles" often do so to reduce server load. If advertised bundles
2442 start mass failing and clients automatically fall back to a regular
2442 start mass failing and clients automatically fall back to a regular
2443 clone, this would add significant and unexpected load to the server
2443 clone, this would add significant and unexpected load to the server
2444 since the server is expecting clone operations to be offloaded to
2444 since the server is expecting clone operations to be offloaded to
2445 pre-generated bundles. Failing fast (the default behavior) ensures
2445 pre-generated bundles. Failing fast (the default behavior) ensures
2446 clients don't overwhelm the server when "clone bundle" application
2446 clients don't overwhelm the server when "clone bundle" application
2447 fails.
2447 fails.
2448
2448
2449 (default: False)
2449 (default: False)
2450
2450
2451 ``clonebundleprefers``
2451 ``clonebundleprefers``
2452 Defines preferences for which "clone bundles" to use.
2452 Defines preferences for which "clone bundles" to use.
2453
2453
2454 Servers advertising "clone bundles" may advertise multiple available
2454 Servers advertising "clone bundles" may advertise multiple available
2455 bundles. Each bundle may have different attributes, such as the bundle
2455 bundles. Each bundle may have different attributes, such as the bundle
2456 type and compression format. This option is used to prefer a particular
2456 type and compression format. This option is used to prefer a particular
2457 bundle over another.
2457 bundle over another.
2458
2458
2459 The following keys are defined by Mercurial:
2459 The following keys are defined by Mercurial:
2460
2460
2461 BUNDLESPEC
2461 BUNDLESPEC
2462 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2462 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2463 e.g. ``gzip-v2`` or ``bzip2-v1``.
2463 e.g. ``gzip-v2`` or ``bzip2-v1``.
2464
2464
2465 COMPRESSION
2465 COMPRESSION
2466 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2466 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2467
2467
2468 Server operators may define custom keys.
2468 Server operators may define custom keys.
2469
2469
2470 Example values: ``COMPRESSION=bzip2``,
2470 Example values: ``COMPRESSION=bzip2``,
2471 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2471 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2472
2472
2473 By default, the first bundle advertised by the server is used.
2473 By default, the first bundle advertised by the server is used.
2474
2474
2475 ``color``
2475 ``color``
2476 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2476 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2477 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2477 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2478 seems possible. See :hg:`help color` for details.
2478 seems possible. See :hg:`help color` for details.
2479
2479
2480 ``commitsubrepos``
2480 ``commitsubrepos``
2481 Whether to commit modified subrepositories when committing the
2481 Whether to commit modified subrepositories when committing the
2482 parent repository. If False and one subrepository has uncommitted
2482 parent repository. If False and one subrepository has uncommitted
2483 changes, abort the commit.
2483 changes, abort the commit.
2484 (default: False)
2484 (default: False)
2485
2485
2486 ``debug``
2486 ``debug``
2487 Print debugging information. (default: False)
2487 Print debugging information. (default: False)
2488
2488
2489 ``editor``
2489 ``editor``
2490 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2490 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2491
2491
2492 ``fallbackencoding``
2492 ``fallbackencoding``
2493 Encoding to try if it's not possible to decode the changelog using
2493 Encoding to try if it's not possible to decode the changelog using
2494 UTF-8. (default: ISO-8859-1)
2494 UTF-8. (default: ISO-8859-1)
2495
2495
2496 ``graphnodetemplate``
2496 ``graphnodetemplate``
2497 (DEPRECATED) Use ``command-templates.graphnode`` instead.
2497 (DEPRECATED) Use ``command-templates.graphnode`` instead.
2498
2498
2499 ``ignore``
2499 ``ignore``
2500 A file to read per-user ignore patterns from. This file should be
2500 A file to read per-user ignore patterns from. This file should be
2501 in the same format as a repository-wide .hgignore file. Filenames
2501 in the same format as a repository-wide .hgignore file. Filenames
2502 are relative to the repository root. This option supports hook syntax,
2502 are relative to the repository root. This option supports hook syntax,
2503 so if you want to specify multiple ignore files, you can do so by
2503 so if you want to specify multiple ignore files, you can do so by
2504 setting something like ``ignore.other = ~/.hgignore2``. For details
2504 setting something like ``ignore.other = ~/.hgignore2``. For details
2505 of the ignore file format, see the ``hgignore(5)`` man page.
2505 of the ignore file format, see the ``hgignore(5)`` man page.
2506
2506
2507 ``interactive``
2507 ``interactive``
2508 Allow to prompt the user. (default: True)
2508 Allow to prompt the user. (default: True)
2509
2509
2510 ``interface``
2510 ``interface``
2511 Select the default interface for interactive features (default: text).
2511 Select the default interface for interactive features (default: text).
2512 Possible values are 'text' and 'curses'.
2512 Possible values are 'text' and 'curses'.
2513
2513
2514 ``interface.chunkselector``
2514 ``interface.chunkselector``
2515 Select the interface for change recording (e.g. :hg:`commit -i`).
2515 Select the interface for change recording (e.g. :hg:`commit -i`).
2516 Possible values are 'text' and 'curses'.
2516 Possible values are 'text' and 'curses'.
2517 This config overrides the interface specified by ui.interface.
2517 This config overrides the interface specified by ui.interface.
2518
2518
2519 ``large-file-limit``
2519 ``large-file-limit``
2520 Largest file size that gives no memory use warning.
2520 Largest file size that gives no memory use warning.
2521 Possible values are integers or 0 to disable the check.
2521 Possible values are integers or 0 to disable the check.
2522 (default: 10000000)
2522 (default: 10000000)
2523
2523
2524 ``logtemplate``
2524 ``logtemplate``
2525 (DEPRECATED) Use ``command-templates.log`` instead.
2525 (DEPRECATED) Use ``command-templates.log`` instead.
2526
2526
2527 ``merge``
2527 ``merge``
2528 The conflict resolution program to use during a manual merge.
2528 The conflict resolution program to use during a manual merge.
2529 For more information on merge tools see :hg:`help merge-tools`.
2529 For more information on merge tools see :hg:`help merge-tools`.
2530 For configuring merge tools see the ``[merge-tools]`` section.
2530 For configuring merge tools see the ``[merge-tools]`` section.
2531
2531
2532 ``mergemarkers``
2532 ``mergemarkers``
2533 Sets the merge conflict marker label styling. The ``detailed`` style
2533 Sets the merge conflict marker label styling. The ``detailed`` style
2534 uses the ``command-templates.mergemarker`` setting to style the labels.
2534 uses the ``command-templates.mergemarker`` setting to style the labels.
2535 The ``basic`` style just uses 'local' and 'other' as the marker label.
2535 The ``basic`` style just uses 'local' and 'other' as the marker label.
2536 One of ``basic`` or ``detailed``.
2536 One of ``basic`` or ``detailed``.
2537 (default: ``basic``)
2537 (default: ``basic``)
2538
2538
2539 ``mergemarkertemplate``
2539 ``mergemarkertemplate``
2540 (DEPRECATED) Use ``command-templates.mergemarker`` instead.
2540 (DEPRECATED) Use ``command-templates.mergemarker`` instead.
2541
2541
2542 ``message-output``
2542 ``message-output``
2543 Where to write status and error messages. (default: ``stdio``)
2543 Where to write status and error messages. (default: ``stdio``)
2544
2544
2545 ``channel``
2545 ``channel``
2546 Use separate channel for structured output. (Command-server only)
2546 Use separate channel for structured output. (Command-server only)
2547 ``stderr``
2547 ``stderr``
2548 Everything to stderr.
2548 Everything to stderr.
2549 ``stdio``
2549 ``stdio``
2550 Status to stdout, and error to stderr.
2550 Status to stdout, and error to stderr.
2551
2551
2552 ``origbackuppath``
2552 ``origbackuppath``
2553 The path to a directory used to store generated .orig files. If the path is
2553 The path to a directory used to store generated .orig files. If the path is
2554 not a directory, one will be created. If set, files stored in this
2554 not a directory, one will be created. If set, files stored in this
2555 directory have the same name as the original file and do not have a .orig
2555 directory have the same name as the original file and do not have a .orig
2556 suffix.
2556 suffix.
2557
2557
2558 ``paginate``
2558 ``paginate``
2559 Control the pagination of command output (default: True). See :hg:`help pager`
2559 Control the pagination of command output (default: True). See :hg:`help pager`
2560 for details.
2560 for details.
2561
2561
2562 ``patch``
2562 ``patch``
2563 An optional external tool that ``hg import`` and some extensions
2563 An optional external tool that ``hg import`` and some extensions
2564 will use for applying patches. By default Mercurial uses an
2564 will use for applying patches. By default Mercurial uses an
2565 internal patch utility. The external tool must work as the common
2565 internal patch utility. The external tool must work as the common
2566 Unix ``patch`` program. In particular, it must accept a ``-p``
2566 Unix ``patch`` program. In particular, it must accept a ``-p``
2567 argument to strip patch headers, a ``-d`` argument to specify the
2567 argument to strip patch headers, a ``-d`` argument to specify the
2568 current directory, a file name to patch, and a patch file to take
2568 current directory, a file name to patch, and a patch file to take
2569 from stdin.
2569 from stdin.
2570
2570
2571 It is possible to specify a patch tool together with extra
2571 It is possible to specify a patch tool together with extra
2572 arguments. For example, setting this option to ``patch --merge``
2572 arguments. For example, setting this option to ``patch --merge``
2573 will use the ``patch`` program with its 2-way merge option.
2573 will use the ``patch`` program with its 2-way merge option.
2574
2574
2575 ``portablefilenames``
2575 ``portablefilenames``
2576 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2576 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2577 (default: ``warn``)
2577 (default: ``warn``)
2578
2578
2579 ``warn``
2579 ``warn``
2580 Print a warning message on POSIX platforms, if a file with a non-portable
2580 Print a warning message on POSIX platforms, if a file with a non-portable
2581 filename is added (e.g. a file with a name that can't be created on
2581 filename is added (e.g. a file with a name that can't be created on
2582 Windows because it contains reserved parts like ``AUX``, reserved
2582 Windows because it contains reserved parts like ``AUX``, reserved
2583 characters like ``:``, or would cause a case collision with an existing
2583 characters like ``:``, or would cause a case collision with an existing
2584 file).
2584 file).
2585
2585
2586 ``ignore``
2586 ``ignore``
2587 Don't print a warning.
2587 Don't print a warning.
2588
2588
2589 ``abort``
2589 ``abort``
2590 The command is aborted.
2590 The command is aborted.
2591
2591
2592 ``true``
2592 ``true``
2593 Alias for ``warn``.
2593 Alias for ``warn``.
2594
2594
2595 ``false``
2595 ``false``
2596 Alias for ``ignore``.
2596 Alias for ``ignore``.
2597
2597
2598 .. container:: windows
2598 .. container:: windows
2599
2599
2600 On Windows, this configuration option is ignored and the command aborted.
2600 On Windows, this configuration option is ignored and the command aborted.
2601
2601
2602 ``pre-merge-tool-output-template``
2602 ``pre-merge-tool-output-template``
2603 (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
2603 (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
2604
2604
2605 ``quiet``
2605 ``quiet``
2606 Reduce the amount of output printed.
2606 Reduce the amount of output printed.
2607 (default: False)
2607 (default: False)
2608
2608
2609 ``relative-paths``
2609 ``relative-paths``
2610 Prefer relative paths in the UI.
2610 Prefer relative paths in the UI.
2611
2611
2612 ``remotecmd``
2612 ``remotecmd``
2613 Remote command to use for clone/push/pull operations.
2613 Remote command to use for clone/push/pull operations.
2614 (default: ``hg``)
2614 (default: ``hg``)
2615
2615
2616 ``report_untrusted``
2616 ``report_untrusted``
2617 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2617 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2618 trusted user or group.
2618 trusted user or group.
2619 (default: True)
2619 (default: True)
2620
2620
2621 ``slash``
2621 ``slash``
2622 (Deprecated. Use ``slashpath`` template filter instead.)
2622 (Deprecated. Use ``slashpath`` template filter instead.)
2623
2623
2624 Display paths using a slash (``/``) as the path separator. This
2624 Display paths using a slash (``/``) as the path separator. This
2625 only makes a difference on systems where the default path
2625 only makes a difference on systems where the default path
2626 separator is not the slash character (e.g. Windows uses the
2626 separator is not the slash character (e.g. Windows uses the
2627 backslash character (``\``)).
2627 backslash character (``\``)).
2628 (default: False)
2628 (default: False)
2629
2629
2630 ``statuscopies``
2630 ``statuscopies``
2631 Display copies in the status command.
2631 Display copies in the status command.
2632
2632
2633 ``ssh``
2633 ``ssh``
2634 Command to use for SSH connections. (default: ``ssh``)
2634 Command to use for SSH connections. (default: ``ssh``)
2635
2635
2636 ``ssherrorhint``
2636 ``ssherrorhint``
2637 A hint shown to the user in the case of SSH error (e.g.
2637 A hint shown to the user in the case of SSH error (e.g.
2638 ``Please see http://company/internalwiki/ssh.html``)
2638 ``Please see http://company/internalwiki/ssh.html``)
2639
2639
2640 ``strict``
2640 ``strict``
2641 Require exact command names, instead of allowing unambiguous
2641 Require exact command names, instead of allowing unambiguous
2642 abbreviations. (default: False)
2642 abbreviations. (default: False)
2643
2643
2644 ``style``
2644 ``style``
2645 Name of style to use for command output.
2645 Name of style to use for command output.
2646
2646
2647 ``supportcontact``
2647 ``supportcontact``
2648 A URL where users should report a Mercurial traceback. Use this if you are a
2648 A URL where users should report a Mercurial traceback. Use this if you are a
2649 large organisation with its own Mercurial deployment process and crash
2649 large organisation with its own Mercurial deployment process and crash
2650 reports should be addressed to your internal support.
2650 reports should be addressed to your internal support.
2651
2651
2652 ``textwidth``
2652 ``textwidth``
2653 Maximum width of help text. A longer line generated by ``hg help`` or
2653 Maximum width of help text. A longer line generated by ``hg help`` or
2654 ``hg subcommand --help`` will be broken after white space to get this
2654 ``hg subcommand --help`` will be broken after white space to get this
2655 width or the terminal width, whichever comes first.
2655 width or the terminal width, whichever comes first.
2656 A non-positive value will disable this and the terminal width will be
2656 A non-positive value will disable this and the terminal width will be
2657 used. (default: 78)
2657 used. (default: 78)
2658
2658
2659 ``timeout``
2659 ``timeout``
2660 The timeout used when a lock is held (in seconds), a negative value
2660 The timeout used when a lock is held (in seconds), a negative value
2661 means no timeout. (default: 600)
2661 means no timeout. (default: 600)
2662
2662
2663 ``timeout.warn``
2663 ``timeout.warn``
2664 Time (in seconds) before a warning is printed about held lock. A negative
2664 Time (in seconds) before a warning is printed about held lock. A negative
2665 value means no warning. (default: 0)
2665 value means no warning. (default: 0)
2666
2666
2667 ``traceback``
2667 ``traceback``
2668 Mercurial always prints a traceback when an unknown exception
2668 Mercurial always prints a traceback when an unknown exception
2669 occurs. Setting this to True will make Mercurial print a traceback
2669 occurs. Setting this to True will make Mercurial print a traceback
2670 on all exceptions, even those recognized by Mercurial (such as
2670 on all exceptions, even those recognized by Mercurial (such as
2671 IOError or MemoryError). (default: False)
2671 IOError or MemoryError). (default: False)
2672
2672
2673 ``tweakdefaults``
2673 ``tweakdefaults``
2674
2674
2675 By default Mercurial's behavior changes very little from release
2675 By default Mercurial's behavior changes very little from release
2676 to release, but over time the recommended config settings
2676 to release, but over time the recommended config settings
2677 shift. Enable this config to opt in to get automatic tweaks to
2677 shift. Enable this config to opt in to get automatic tweaks to
2678 Mercurial's behavior over time. This config setting will have no
2678 Mercurial's behavior over time. This config setting will have no
2679 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2679 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2680 not include ``tweakdefaults``. (default: False)
2680 not include ``tweakdefaults``. (default: False)
2681
2681
2682 It currently means::
2682 It currently means::
2683
2683
2684 .. tweakdefaultsmarker
2684 .. tweakdefaultsmarker
2685
2685
2686 ``username``
2686 ``username``
2687 The committer of a changeset created when running "commit".
2687 The committer of a changeset created when running "commit".
2688 Typically a person's name and email address, e.g. ``Fred Widget
2688 Typically a person's name and email address, e.g. ``Fred Widget
2689 <fred@example.com>``. Environment variables in the
2689 <fred@example.com>``. Environment variables in the
2690 username are expanded.
2690 username are expanded.
2691
2691
2692 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2692 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2693 hgrc is empty, e.g. if the system admin set ``username =`` in the
2693 hgrc is empty, e.g. if the system admin set ``username =`` in the
2694 system hgrc, it has to be specified manually or in a different
2694 system hgrc, it has to be specified manually or in a different
2695 hgrc file)
2695 hgrc file)
2696
2696
2697 ``verbose``
2697 ``verbose``
2698 Increase the amount of output printed. (default: False)
2698 Increase the amount of output printed. (default: False)
2699
2699
2700
2700
2701 ``command-templates``
2701 ``command-templates``
2702 ---------------------
2702 ---------------------
2703
2703
2704 Templates used for customizing the output of commands.
2704 Templates used for customizing the output of commands.
2705
2705
2706 ``graphnode``
2706 ``graphnode``
2707 The template used to print changeset nodes in an ASCII revision graph.
2707 The template used to print changeset nodes in an ASCII revision graph.
2708 (default: ``{graphnode}``)
2708 (default: ``{graphnode}``)
2709
2709
2710 ``log``
2710 ``log``
2711 Template string for commands that print changesets.
2711 Template string for commands that print changesets.
2712
2712
2713 ``mergemarker``
2713 ``mergemarker``
2714 The template used to print the commit description next to each conflict
2714 The template used to print the commit description next to each conflict
2715 marker during merge conflicts. See :hg:`help templates` for the template
2715 marker during merge conflicts. See :hg:`help templates` for the template
2716 format.
2716 format.
2717
2717
2718 Defaults to showing the hash, tags, branches, bookmarks, author, and
2718 Defaults to showing the hash, tags, branches, bookmarks, author, and
2719 the first line of the commit description.
2719 the first line of the commit description.
2720
2720
2721 If you use non-ASCII characters in names for tags, branches, bookmarks,
2721 If you use non-ASCII characters in names for tags, branches, bookmarks,
2722 authors, and/or commit descriptions, you must pay attention to encodings of
2722 authors, and/or commit descriptions, you must pay attention to encodings of
2723 managed files. At template expansion, non-ASCII characters use the encoding
2723 managed files. At template expansion, non-ASCII characters use the encoding
2724 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2724 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2725 environment variables that govern your locale. If the encoding of the merge
2725 environment variables that govern your locale. If the encoding of the merge
2726 markers is different from the encoding of the merged files,
2726 markers is different from the encoding of the merged files,
2727 serious problems may occur.
2727 serious problems may occur.
2728
2728
2729 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2729 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2730
2730
2731 ``oneline-summary``
2731 ``oneline-summary``
2732 A template used by `hg rebase` and other commands for showing a one-line
2732 A template used by `hg rebase` and other commands for showing a one-line
2733 summary of a commit. If the template configured here is longer than one
2733 summary of a commit. If the template configured here is longer than one
2734 line, then only the first line is used.
2734 line, then only the first line is used.
2735
2735
2736 The template can be overridden per command by defining a template in
2736 The template can be overridden per command by defining a template in
2737 `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
2737 `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
2738
2738
2739 ``pre-merge-tool-output``
2739 ``pre-merge-tool-output``
2740 A template that is printed before executing an external merge tool. This can
2740 A template that is printed before executing an external merge tool. This can
2741 be used to print out additional context that might be useful to have during
2741 be used to print out additional context that might be useful to have during
2742 the conflict resolution, such as the description of the various commits
2742 the conflict resolution, such as the description of the various commits
2743 involved or bookmarks/tags.
2743 involved or bookmarks/tags.
2744
2744
2745 Additional information is available in the ``local`, ``base``, and ``other``
2745 Additional information is available in the ``local`, ``base``, and ``other``
2746 dicts. For example: ``{local.label}``, ``{base.name}``, or
2746 dicts. For example: ``{local.label}``, ``{base.name}``, or
2747 ``{other.islink}``.
2747 ``{other.islink}``.
2748
2748
2749
2749
2750 ``web``
2750 ``web``
2751 -------
2751 -------
2752
2752
2753 Web interface configuration. The settings in this section apply to
2753 Web interface configuration. The settings in this section apply to
2754 both the builtin webserver (started by :hg:`serve`) and the script you
2754 both the builtin webserver (started by :hg:`serve`) and the script you
2755 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2755 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2756 and WSGI).
2756 and WSGI).
2757
2757
2758 The Mercurial webserver does no authentication (it does not prompt for
2758 The Mercurial webserver does no authentication (it does not prompt for
2759 usernames and passwords to validate *who* users are), but it does do
2759 usernames and passwords to validate *who* users are), but it does do
2760 authorization (it grants or denies access for *authenticated users*
2760 authorization (it grants or denies access for *authenticated users*
2761 based on settings in this section). You must either configure your
2761 based on settings in this section). You must either configure your
2762 webserver to do authentication for you, or disable the authorization
2762 webserver to do authentication for you, or disable the authorization
2763 checks.
2763 checks.
2764
2764
2765 For a quick setup in a trusted environment, e.g., a private LAN, where
2765 For a quick setup in a trusted environment, e.g., a private LAN, where
2766 you want it to accept pushes from anybody, you can use the following
2766 you want it to accept pushes from anybody, you can use the following
2767 command line::
2767 command line::
2768
2768
2769 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2769 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2770
2770
2771 Note that this will allow anybody to push anything to the server and
2771 Note that this will allow anybody to push anything to the server and
2772 that this should not be used for public servers.
2772 that this should not be used for public servers.
2773
2773
2774 The full set of options is:
2774 The full set of options is:
2775
2775
2776 ``accesslog``
2776 ``accesslog``
2777 Where to output the access log. (default: stdout)
2777 Where to output the access log. (default: stdout)
2778
2778
2779 ``address``
2779 ``address``
2780 Interface address to bind to. (default: all)
2780 Interface address to bind to. (default: all)
2781
2781
2782 ``allow-archive``
2782 ``allow-archive``
2783 List of archive format (bz2, gz, zip) allowed for downloading.
2783 List of archive format (bz2, gz, zip) allowed for downloading.
2784 (default: empty)
2784 (default: empty)
2785
2785
2786 ``allowbz2``
2786 ``allowbz2``
2787 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2787 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2788 revisions.
2788 revisions.
2789 (default: False)
2789 (default: False)
2790
2790
2791 ``allowgz``
2791 ``allowgz``
2792 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2792 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2793 revisions.
2793 revisions.
2794 (default: False)
2794 (default: False)
2795
2795
2796 ``allow-pull``
2796 ``allow-pull``
2797 Whether to allow pulling from the repository. (default: True)
2797 Whether to allow pulling from the repository. (default: True)
2798
2798
2799 ``allow-push``
2799 ``allow-push``
2800 Whether to allow pushing to the repository. If empty or not set,
2800 Whether to allow pushing to the repository. If empty or not set,
2801 pushing is not allowed. If the special value ``*``, any remote
2801 pushing is not allowed. If the special value ``*``, any remote
2802 user can push, including unauthenticated users. Otherwise, the
2802 user can push, including unauthenticated users. Otherwise, the
2803 remote user must have been authenticated, and the authenticated
2803 remote user must have been authenticated, and the authenticated
2804 user name must be present in this list. The contents of the
2804 user name must be present in this list. The contents of the
2805 allow-push list are examined after the deny_push list.
2805 allow-push list are examined after the deny_push list.
2806
2806
2807 ``allow_read``
2807 ``allow_read``
2808 If the user has not already been denied repository access due to
2808 If the user has not already been denied repository access due to
2809 the contents of deny_read, this list determines whether to grant
2809 the contents of deny_read, this list determines whether to grant
2810 repository access to the user. If this list is not empty, and the
2810 repository access to the user. If this list is not empty, and the
2811 user is unauthenticated or not present in the list, then access is
2811 user is unauthenticated or not present in the list, then access is
2812 denied for the user. If the list is empty or not set, then access
2812 denied for the user. If the list is empty or not set, then access
2813 is permitted to all users by default. Setting allow_read to the
2813 is permitted to all users by default. Setting allow_read to the
2814 special value ``*`` is equivalent to it not being set (i.e. access
2814 special value ``*`` is equivalent to it not being set (i.e. access
2815 is permitted to all users). The contents of the allow_read list are
2815 is permitted to all users). The contents of the allow_read list are
2816 examined after the deny_read list.
2816 examined after the deny_read list.
2817
2817
2818 ``allowzip``
2818 ``allowzip``
2819 (DEPRECATED) Whether to allow .zip downloading of repository
2819 (DEPRECATED) Whether to allow .zip downloading of repository
2820 revisions. This feature creates temporary files.
2820 revisions. This feature creates temporary files.
2821 (default: False)
2821 (default: False)
2822
2822
2823 ``archivesubrepos``
2823 ``archivesubrepos``
2824 Whether to recurse into subrepositories when archiving.
2824 Whether to recurse into subrepositories when archiving.
2825 (default: False)
2825 (default: False)
2826
2826
2827 ``baseurl``
2827 ``baseurl``
2828 Base URL to use when publishing URLs in other locations, so
2828 Base URL to use when publishing URLs in other locations, so
2829 third-party tools like email notification hooks can construct
2829 third-party tools like email notification hooks can construct
2830 URLs. Example: ``http://hgserver/repos/``.
2830 URLs. Example: ``http://hgserver/repos/``.
2831
2831
2832 ``cacerts``
2832 ``cacerts``
2833 Path to file containing a list of PEM encoded certificate
2833 Path to file containing a list of PEM encoded certificate
2834 authority certificates. Environment variables and ``~user``
2834 authority certificates. Environment variables and ``~user``
2835 constructs are expanded in the filename. If specified on the
2835 constructs are expanded in the filename. If specified on the
2836 client, then it will verify the identity of remote HTTPS servers
2836 client, then it will verify the identity of remote HTTPS servers
2837 with these certificates.
2837 with these certificates.
2838
2838
2839 To disable SSL verification temporarily, specify ``--insecure`` from
2839 To disable SSL verification temporarily, specify ``--insecure`` from
2840 command line.
2840 command line.
2841
2841
2842 You can use OpenSSL's CA certificate file if your platform has
2842 You can use OpenSSL's CA certificate file if your platform has
2843 one. On most Linux systems this will be
2843 one. On most Linux systems this will be
2844 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2844 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2845 generate this file manually. The form must be as follows::
2845 generate this file manually. The form must be as follows::
2846
2846
2847 -----BEGIN CERTIFICATE-----
2847 -----BEGIN CERTIFICATE-----
2848 ... (certificate in base64 PEM encoding) ...
2848 ... (certificate in base64 PEM encoding) ...
2849 -----END CERTIFICATE-----
2849 -----END CERTIFICATE-----
2850 -----BEGIN CERTIFICATE-----
2850 -----BEGIN CERTIFICATE-----
2851 ... (certificate in base64 PEM encoding) ...
2851 ... (certificate in base64 PEM encoding) ...
2852 -----END CERTIFICATE-----
2852 -----END CERTIFICATE-----
2853
2853
2854 ``cache``
2854 ``cache``
2855 Whether to support caching in hgweb. (default: True)
2855 Whether to support caching in hgweb. (default: True)
2856
2856
2857 ``certificate``
2857 ``certificate``
2858 Certificate to use when running :hg:`serve`.
2858 Certificate to use when running :hg:`serve`.
2859
2859
2860 ``collapse``
2860 ``collapse``
2861 With ``descend`` enabled, repositories in subdirectories are shown at
2861 With ``descend`` enabled, repositories in subdirectories are shown at
2862 a single level alongside repositories in the current path. With
2862 a single level alongside repositories in the current path. With
2863 ``collapse`` also enabled, repositories residing at a deeper level than
2863 ``collapse`` also enabled, repositories residing at a deeper level than
2864 the current path are grouped behind navigable directory entries that
2864 the current path are grouped behind navigable directory entries that
2865 lead to the locations of these repositories. In effect, this setting
2865 lead to the locations of these repositories. In effect, this setting
2866 collapses each collection of repositories found within a subdirectory
2866 collapses each collection of repositories found within a subdirectory
2867 into a single entry for that subdirectory. (default: False)
2867 into a single entry for that subdirectory. (default: False)
2868
2868
2869 ``comparisoncontext``
2869 ``comparisoncontext``
2870 Number of lines of context to show in side-by-side file comparison. If
2870 Number of lines of context to show in side-by-side file comparison. If
2871 negative or the value ``full``, whole files are shown. (default: 5)
2871 negative or the value ``full``, whole files are shown. (default: 5)
2872
2872
2873 This setting can be overridden by a ``context`` request parameter to the
2873 This setting can be overridden by a ``context`` request parameter to the
2874 ``comparison`` command, taking the same values.
2874 ``comparison`` command, taking the same values.
2875
2875
2876 ``contact``
2876 ``contact``
2877 Name or email address of the person in charge of the repository.
2877 Name or email address of the person in charge of the repository.
2878 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2878 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2879
2879
2880 ``csp``
2880 ``csp``
2881 Send a ``Content-Security-Policy`` HTTP header with this value.
2881 Send a ``Content-Security-Policy`` HTTP header with this value.
2882
2882
2883 The value may contain a special string ``%nonce%``, which will be replaced
2883 The value may contain a special string ``%nonce%``, which will be replaced
2884 by a randomly-generated one-time use value. If the value contains
2884 by a randomly-generated one-time use value. If the value contains
2885 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2885 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2886 one-time property of the nonce. This nonce will also be inserted into
2886 one-time property of the nonce. This nonce will also be inserted into
2887 ``<script>`` elements containing inline JavaScript.
2887 ``<script>`` elements containing inline JavaScript.
2888
2888
2889 Note: lots of HTML content sent by the server is derived from repository
2889 Note: lots of HTML content sent by the server is derived from repository
2890 data. Please consider the potential for malicious repository data to
2890 data. Please consider the potential for malicious repository data to
2891 "inject" itself into generated HTML content as part of your security
2891 "inject" itself into generated HTML content as part of your security
2892 threat model.
2892 threat model.
2893
2893
2894 ``deny_push``
2894 ``deny_push``
2895 Whether to deny pushing to the repository. If empty or not set,
2895 Whether to deny pushing to the repository. If empty or not set,
2896 push is not denied. If the special value ``*``, all remote users are
2896 push is not denied. If the special value ``*``, all remote users are
2897 denied push. Otherwise, unauthenticated users are all denied, and
2897 denied push. Otherwise, unauthenticated users are all denied, and
2898 any authenticated user name present in this list is also denied. The
2898 any authenticated user name present in this list is also denied. The
2899 contents of the deny_push list are examined before the allow-push list.
2899 contents of the deny_push list are examined before the allow-push list.
2900
2900
2901 ``deny_read``
2901 ``deny_read``
2902 Whether to deny reading/viewing of the repository. If this list is
2902 Whether to deny reading/viewing of the repository. If this list is
2903 not empty, unauthenticated users are all denied, and any
2903 not empty, unauthenticated users are all denied, and any
2904 authenticated user name present in this list is also denied access to
2904 authenticated user name present in this list is also denied access to
2905 the repository. If set to the special value ``*``, all remote users
2905 the repository. If set to the special value ``*``, all remote users
2906 are denied access (rarely needed ;). If deny_read is empty or not set,
2906 are denied access (rarely needed ;). If deny_read is empty or not set,
2907 the determination of repository access depends on the presence and
2907 the determination of repository access depends on the presence and
2908 content of the allow_read list (see description). If both
2908 content of the allow_read list (see description). If both
2909 deny_read and allow_read are empty or not set, then access is
2909 deny_read and allow_read are empty or not set, then access is
2910 permitted to all users by default. If the repository is being
2910 permitted to all users by default. If the repository is being
2911 served via hgwebdir, denied users will not be able to see it in
2911 served via hgwebdir, denied users will not be able to see it in
2912 the list of repositories. The contents of the deny_read list have
2912 the list of repositories. The contents of the deny_read list have
2913 priority over (are examined before) the contents of the allow_read
2913 priority over (are examined before) the contents of the allow_read
2914 list.
2914 list.
2915
2915
2916 ``descend``
2916 ``descend``
2917 hgwebdir indexes will not descend into subdirectories. Only repositories
2917 hgwebdir indexes will not descend into subdirectories. Only repositories
2918 directly in the current path will be shown (other repositories are still
2918 directly in the current path will be shown (other repositories are still
2919 available from the index corresponding to their containing path).
2919 available from the index corresponding to their containing path).
2920
2920
2921 ``description``
2921 ``description``
2922 Textual description of the repository's purpose or contents.
2922 Textual description of the repository's purpose or contents.
2923 (default: "unknown")
2923 (default: "unknown")
2924
2924
2925 ``encoding``
2925 ``encoding``
2926 Character encoding name. (default: the current locale charset)
2926 Character encoding name. (default: the current locale charset)
2927 Example: "UTF-8".
2927 Example: "UTF-8".
2928
2928
2929 ``errorlog``
2929 ``errorlog``
2930 Where to output the error log. (default: stderr)
2930 Where to output the error log. (default: stderr)
2931
2931
2932 ``guessmime``
2932 ``guessmime``
2933 Control MIME types for raw download of file content.
2933 Control MIME types for raw download of file content.
2934 Set to True to let hgweb guess the content type from the file
2934 Set to True to let hgweb guess the content type from the file
2935 extension. This will serve HTML files as ``text/html`` and might
2935 extension. This will serve HTML files as ``text/html`` and might
2936 allow cross-site scripting attacks when serving untrusted
2936 allow cross-site scripting attacks when serving untrusted
2937 repositories. (default: False)
2937 repositories. (default: False)
2938
2938
2939 ``hidden``
2939 ``hidden``
2940 Whether to hide the repository in the hgwebdir index.
2940 Whether to hide the repository in the hgwebdir index.
2941 (default: False)
2941 (default: False)
2942
2942
2943 ``ipv6``
2943 ``ipv6``
2944 Whether to use IPv6. (default: False)
2944 Whether to use IPv6. (default: False)
2945
2945
2946 ``labels``
2946 ``labels``
2947 List of string *labels* associated with the repository.
2947 List of string *labels* associated with the repository.
2948
2948
2949 Labels are exposed as a template keyword and can be used to customize
2949 Labels are exposed as a template keyword and can be used to customize
2950 output. e.g. the ``index`` template can group or filter repositories
2950 output. e.g. the ``index`` template can group or filter repositories
2951 by labels and the ``summary`` template can display additional content
2951 by labels and the ``summary`` template can display additional content
2952 if a specific label is present.
2952 if a specific label is present.
2953
2953
2954 ``logoimg``
2954 ``logoimg``
2955 File name of the logo image that some templates display on each page.
2955 File name of the logo image that some templates display on each page.
2956 The file name is relative to ``staticurl``. That is, the full path to
2956 The file name is relative to ``staticurl``. That is, the full path to
2957 the logo image is "staticurl/logoimg".
2957 the logo image is "staticurl/logoimg".
2958 If unset, ``hglogo.png`` will be used.
2958 If unset, ``hglogo.png`` will be used.
2959
2959
2960 ``logourl``
2960 ``logourl``
2961 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2961 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2962 will be used.
2962 will be used.
2963
2963
2964 ``maxchanges``
2964 ``maxchanges``
2965 Maximum number of changes to list on the changelog. (default: 10)
2965 Maximum number of changes to list on the changelog. (default: 10)
2966
2966
2967 ``maxfiles``
2967 ``maxfiles``
2968 Maximum number of files to list per changeset. (default: 10)
2968 Maximum number of files to list per changeset. (default: 10)
2969
2969
2970 ``maxshortchanges``
2970 ``maxshortchanges``
2971 Maximum number of changes to list on the shortlog, graph or filelog
2971 Maximum number of changes to list on the shortlog, graph or filelog
2972 pages. (default: 60)
2972 pages. (default: 60)
2973
2973
2974 ``name``
2974 ``name``
2975 Repository name to use in the web interface.
2975 Repository name to use in the web interface.
2976 (default: current working directory)
2976 (default: current working directory)
2977
2977
2978 ``port``
2978 ``port``
2979 Port to listen on. (default: 8000)
2979 Port to listen on. (default: 8000)
2980
2980
2981 ``prefix``
2981 ``prefix``
2982 Prefix path to serve from. (default: '' (server root))
2982 Prefix path to serve from. (default: '' (server root))
2983
2983
2984 ``push_ssl``
2984 ``push_ssl``
2985 Whether to require that inbound pushes be transported over SSL to
2985 Whether to require that inbound pushes be transported over SSL to
2986 prevent password sniffing. (default: True)
2986 prevent password sniffing. (default: True)
2987
2987
2988 ``refreshinterval``
2988 ``refreshinterval``
2989 How frequently directory listings re-scan the filesystem for new
2989 How frequently directory listings re-scan the filesystem for new
2990 repositories, in seconds. This is relevant when wildcards are used
2990 repositories, in seconds. This is relevant when wildcards are used
2991 to define paths. Depending on how much filesystem traversal is
2991 to define paths. Depending on how much filesystem traversal is
2992 required, refreshing may negatively impact performance.
2992 required, refreshing may negatively impact performance.
2993
2993
2994 Values less than or equal to 0 always refresh.
2994 Values less than or equal to 0 always refresh.
2995 (default: 20)
2995 (default: 20)
2996
2996
2997 ``server-header``
2997 ``server-header``
2998 Value for HTTP ``Server`` response header.
2998 Value for HTTP ``Server`` response header.
2999
2999
3000 ``static``
3000 ``static``
3001 Directory where static files are served from.
3001 Directory where static files are served from.
3002
3002
3003 ``staticurl``
3003 ``staticurl``
3004 Base URL to use for static files. If unset, static files (e.g. the
3004 Base URL to use for static files. If unset, static files (e.g. the
3005 hgicon.png favicon) will be served by the CGI script itself. Use
3005 hgicon.png favicon) will be served by the CGI script itself. Use
3006 this setting to serve them directly with the HTTP server.
3006 this setting to serve them directly with the HTTP server.
3007 Example: ``http://hgserver/static/``.
3007 Example: ``http://hgserver/static/``.
3008
3008
3009 ``stripes``
3009 ``stripes``
3010 How many lines a "zebra stripe" should span in multi-line output.
3010 How many lines a "zebra stripe" should span in multi-line output.
3011 Set to 0 to disable. (default: 1)
3011 Set to 0 to disable. (default: 1)
3012
3012
3013 ``style``
3013 ``style``
3014 Which template map style to use. The available options are the names of
3014 Which template map style to use. The available options are the names of
3015 subdirectories in the HTML templates path. (default: ``paper``)
3015 subdirectories in the HTML templates path. (default: ``paper``)
3016 Example: ``monoblue``.
3016 Example: ``monoblue``.
3017
3017
3018 ``templates``
3018 ``templates``
3019 Where to find the HTML templates. The default path to the HTML templates
3019 Where to find the HTML templates. The default path to the HTML templates
3020 can be obtained from ``hg debuginstall``.
3020 can be obtained from ``hg debuginstall``.
3021
3021
3022 ``websub``
3022 ``websub``
3023 ----------
3023 ----------
3024
3024
3025 Web substitution filter definition. You can use this section to
3025 Web substitution filter definition. You can use this section to
3026 define a set of regular expression substitution patterns which
3026 define a set of regular expression substitution patterns which
3027 let you automatically modify the hgweb server output.
3027 let you automatically modify the hgweb server output.
3028
3028
3029 The default hgweb templates only apply these substitution patterns
3029 The default hgweb templates only apply these substitution patterns
3030 on the revision description fields. You can apply them anywhere
3030 on the revision description fields. You can apply them anywhere
3031 you want when you create your own templates by adding calls to the
3031 you want when you create your own templates by adding calls to the
3032 "websub" filter (usually after calling the "escape" filter).
3032 "websub" filter (usually after calling the "escape" filter).
3033
3033
3034 This can be used, for example, to convert issue references to links
3034 This can be used, for example, to convert issue references to links
3035 to your issue tracker, or to convert "markdown-like" syntax into
3035 to your issue tracker, or to convert "markdown-like" syntax into
3036 HTML (see the examples below).
3036 HTML (see the examples below).
3037
3037
3038 Each entry in this section names a substitution filter.
3038 Each entry in this section names a substitution filter.
3039 The value of each entry defines the substitution expression itself.
3039 The value of each entry defines the substitution expression itself.
3040 The websub expressions follow the old interhg extension syntax,
3040 The websub expressions follow the old interhg extension syntax,
3041 which in turn imitates the Unix sed replacement syntax::
3041 which in turn imitates the Unix sed replacement syntax::
3042
3042
3043 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
3043 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
3044
3044
3045 You can use any separator other than "/". The final "i" is optional
3045 You can use any separator other than "/". The final "i" is optional
3046 and indicates that the search must be case insensitive.
3046 and indicates that the search must be case insensitive.
3047
3047
3048 Examples::
3048 Examples::
3049
3049
3050 [websub]
3050 [websub]
3051 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
3051 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
3052 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
3052 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
3053 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
3053 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
3054
3054
3055 ``worker``
3055 ``worker``
3056 ----------
3056 ----------
3057
3057
3058 Parallel master/worker configuration. We currently perform working
3058 Parallel master/worker configuration. We currently perform working
3059 directory updates in parallel on Unix-like systems, which greatly
3059 directory updates in parallel on Unix-like systems, which greatly
3060 helps performance.
3060 helps performance.
3061
3061
3062 ``enabled``
3062 ``enabled``
3063 Whether to enable workers code to be used.
3063 Whether to enable workers code to be used.
3064 (default: true)
3064 (default: true)
3065
3065
3066 ``numcpus``
3066 ``numcpus``
3067 Number of CPUs to use for parallel operations. A zero or
3067 Number of CPUs to use for parallel operations. A zero or
3068 negative value is treated as ``use the default``.
3068 negative value is treated as ``use the default``.
3069 (default: 4 or the number of CPUs on the system, whichever is larger)
3069 (default: 4 or the number of CPUs on the system, whichever is larger)
3070
3070
3071 ``backgroundclose``
3071 ``backgroundclose``
3072 Whether to enable closing file handles on background threads during certain
3072 Whether to enable closing file handles on background threads during certain
3073 operations. Some platforms aren't very efficient at closing file
3073 operations. Some platforms aren't very efficient at closing file
3074 handles that have been written or appended to. By performing file closing
3074 handles that have been written or appended to. By performing file closing
3075 on background threads, file write rate can increase substantially.
3075 on background threads, file write rate can increase substantially.
3076 (default: true on Windows, false elsewhere)
3076 (default: true on Windows, false elsewhere)
3077
3077
3078 ``backgroundcloseminfilecount``
3078 ``backgroundcloseminfilecount``
3079 Minimum number of files required to trigger background file closing.
3079 Minimum number of files required to trigger background file closing.
3080 Operations not writing this many files won't start background close
3080 Operations not writing this many files won't start background close
3081 threads.
3081 threads.
3082 (default: 2048)
3082 (default: 2048)
3083
3083
3084 ``backgroundclosemaxqueue``
3084 ``backgroundclosemaxqueue``
3085 The maximum number of opened file handles waiting to be closed in the
3085 The maximum number of opened file handles waiting to be closed in the
3086 background. This option only has an effect if ``backgroundclose`` is
3086 background. This option only has an effect if ``backgroundclose`` is
3087 enabled.
3087 enabled.
3088 (default: 384)
3088 (default: 384)
3089
3089
3090 ``backgroundclosethreadcount``
3090 ``backgroundclosethreadcount``
3091 Number of threads to process background file closes. Only relevant if
3091 Number of threads to process background file closes. Only relevant if
3092 ``backgroundclose`` is enabled.
3092 ``backgroundclose`` is enabled.
3093 (default: 4)
3093 (default: 4)
General Comments 0
You need to be logged in to leave comments. Login now