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