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