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