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