##// END OF EJS Templates
help: remove references to "Python 2.6 or later"...
Gregory Szorc -
r28846:18f2fc51 default
parent child Browse files
Show More
@@ -1,2079 +1,2071
1 The Mercurial system uses a set of configuration files to control
1 The Mercurial system uses a set of configuration files to control
2 aspects of its behavior.
2 aspects of its behavior.
3
3
4 Troubleshooting
4 Troubleshooting
5 ===============
5 ===============
6
6
7 If you're having problems with your configuration,
7 If you're having problems with your configuration,
8 :hg:`config --debug` can help you understand what is introducing
8 :hg:`config --debug` can help you understand what is introducing
9 a setting into your environment.
9 a setting into your environment.
10
10
11 See :hg:`help config.syntax` and :hg:`help config.files`
11 See :hg:`help config.syntax` and :hg:`help config.files`
12 for information about how and where to override things.
12 for information about how and where to override things.
13
13
14 Structure
14 Structure
15 =========
15 =========
16
16
17 The configuration files use a simple ini-file format. A configuration
17 The configuration files use a simple ini-file format. A configuration
18 file consists of sections, led by a ``[section]`` header and followed
18 file consists of sections, led by a ``[section]`` header and followed
19 by ``name = value`` entries::
19 by ``name = value`` entries::
20
20
21 [ui]
21 [ui]
22 username = Firstname Lastname <firstname.lastname@example.net>
22 username = Firstname Lastname <firstname.lastname@example.net>
23 verbose = True
23 verbose = True
24
24
25 The above entries will be referred to as ``ui.username`` and
25 The above entries will be referred to as ``ui.username`` and
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
27
27
28 Files
28 Files
29 =====
29 =====
30
30
31 Mercurial reads configuration data from several files, if they exist.
31 Mercurial reads configuration data from several files, if they exist.
32 These files do not exist by default and you will have to create the
32 These files do not exist by default and you will have to create the
33 appropriate configuration files yourself:
33 appropriate configuration files yourself:
34
34
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
36
36
37 Global configuration like the username setting is typically put into:
37 Global configuration like the username setting is typically put into:
38
38
39 .. container:: windows
39 .. container:: windows
40
40
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
42
42
43 .. container:: unix.plan9
43 .. container:: unix.plan9
44
44
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
46
46
47 The names of these files depend on the system on which Mercurial is
47 The names of these files depend on the system on which Mercurial is
48 installed. ``*.rc`` files from a single directory are read in
48 installed. ``*.rc`` files from a single directory are read in
49 alphabetical order, later ones overriding earlier ones. Where multiple
49 alphabetical order, later ones overriding earlier ones. Where multiple
50 paths are given below, settings from earlier paths override later
50 paths are given below, settings from earlier paths override later
51 ones.
51 ones.
52
52
53 .. container:: verbose.unix
53 .. container:: verbose.unix
54
54
55 On Unix, the following files are consulted:
55 On Unix, the following files are consulted:
56
56
57 - ``<repo>/.hg/hgrc`` (per-repository)
57 - ``<repo>/.hg/hgrc`` (per-repository)
58 - ``$HOME/.hgrc`` (per-user)
58 - ``$HOME/.hgrc`` (per-user)
59 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
59 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
60 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
60 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
61 - ``/etc/mercurial/hgrc`` (per-system)
61 - ``/etc/mercurial/hgrc`` (per-system)
62 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
62 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
63 - ``<internal>/default.d/*.rc`` (defaults)
63 - ``<internal>/default.d/*.rc`` (defaults)
64
64
65 .. container:: verbose.windows
65 .. container:: verbose.windows
66
66
67 On Windows, the following files are consulted:
67 On Windows, the following files are consulted:
68
68
69 - ``<repo>/.hg/hgrc`` (per-repository)
69 - ``<repo>/.hg/hgrc`` (per-repository)
70 - ``%USERPROFILE%\.hgrc`` (per-user)
70 - ``%USERPROFILE%\.hgrc`` (per-user)
71 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
71 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
72 - ``%HOME%\.hgrc`` (per-user)
72 - ``%HOME%\.hgrc`` (per-user)
73 - ``%HOME%\Mercurial.ini`` (per-user)
73 - ``%HOME%\Mercurial.ini`` (per-user)
74 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
74 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
75 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
75 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
76 - ``<install-dir>\Mercurial.ini`` (per-installation)
76 - ``<install-dir>\Mercurial.ini`` (per-installation)
77 - ``<internal>/default.d/*.rc`` (defaults)
77 - ``<internal>/default.d/*.rc`` (defaults)
78
78
79 .. note::
79 .. note::
80
80
81 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
81 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
82 is used when running 32-bit Python on 64-bit Windows.
82 is used when running 32-bit Python on 64-bit Windows.
83
83
84 .. container:: windows
84 .. container:: windows
85
85
86 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
86 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
87
87
88 .. container:: verbose.plan9
88 .. container:: verbose.plan9
89
89
90 On Plan9, the following files are consulted:
90 On Plan9, the following files are consulted:
91
91
92 - ``<repo>/.hg/hgrc`` (per-repository)
92 - ``<repo>/.hg/hgrc`` (per-repository)
93 - ``$home/lib/hgrc`` (per-user)
93 - ``$home/lib/hgrc`` (per-user)
94 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
94 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
95 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
95 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
96 - ``/lib/mercurial/hgrc`` (per-system)
96 - ``/lib/mercurial/hgrc`` (per-system)
97 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
97 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
98 - ``<internal>/default.d/*.rc`` (defaults)
98 - ``<internal>/default.d/*.rc`` (defaults)
99
99
100 Per-repository configuration options only apply in a
100 Per-repository configuration options only apply in a
101 particular repository. This file is not version-controlled, and
101 particular repository. This file is not version-controlled, and
102 will not get transferred during a "clone" operation. Options in
102 will not get transferred during a "clone" operation. Options in
103 this file override options in all other configuration files.
103 this file override options in all other configuration files.
104
104
105 .. container:: unix.plan9
105 .. container:: unix.plan9
106
106
107 On Plan 9 and Unix, most of this file will be ignored if it doesn't
107 On Plan 9 and Unix, most of this file will be ignored if it doesn't
108 belong to a trusted user or to a trusted group. See
108 belong to a trusted user or to a trusted group. See
109 :hg:`help config.trusted` for more details.
109 :hg:`help config.trusted` for more details.
110
110
111 Per-user configuration file(s) are for the user running Mercurial. Options
111 Per-user configuration file(s) are for the user running Mercurial. Options
112 in these files apply to all Mercurial commands executed by this user in any
112 in these files apply to all Mercurial commands executed by this user in any
113 directory. Options in these files override per-system and per-installation
113 directory. Options in these files override per-system and per-installation
114 options.
114 options.
115
115
116 Per-installation configuration files are searched for in the
116 Per-installation configuration files are searched for in the
117 directory where Mercurial is installed. ``<install-root>`` is the
117 directory where Mercurial is installed. ``<install-root>`` is the
118 parent directory of the **hg** executable (or symlink) being run.
118 parent directory of the **hg** executable (or symlink) being run.
119
119
120 .. container:: unix.plan9
120 .. container:: unix.plan9
121
121
122 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
122 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
123 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
123 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
124 files apply to all Mercurial commands executed by any user in any
124 files apply to all Mercurial commands executed by any user in any
125 directory.
125 directory.
126
126
127 Per-installation configuration files are for the system on
127 Per-installation configuration files are for the system on
128 which Mercurial is running. Options in these files apply to all
128 which Mercurial is running. Options in these files apply to all
129 Mercurial commands executed by any user in any directory. Registry
129 Mercurial commands executed by any user in any directory. Registry
130 keys contain PATH-like strings, every part of which must reference
130 keys contain PATH-like strings, every part of which must reference
131 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
131 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
132 be read. Mercurial checks each of these locations in the specified
132 be read. Mercurial checks each of these locations in the specified
133 order until one or more configuration files are detected.
133 order until one or more configuration files are detected.
134
134
135 Per-system configuration files are for the system on which Mercurial
135 Per-system configuration files are for the system on which Mercurial
136 is running. Options in these files apply to all Mercurial commands
136 is running. Options in these files apply to all Mercurial commands
137 executed by any user in any directory. Options in these files
137 executed by any user in any directory. Options in these files
138 override per-installation options.
138 override per-installation options.
139
139
140 Mercurial comes with some default configuration. The default configuration
140 Mercurial comes with some default configuration. The default configuration
141 files are installed with Mercurial and will be overwritten on upgrades. Default
141 files are installed with Mercurial and will be overwritten on upgrades. Default
142 configuration files should never be edited by users or administrators but can
142 configuration files should never be edited by users or administrators but can
143 be overridden in other configuration files. So far the directory only contains
143 be overridden in other configuration files. So far the directory only contains
144 merge tool configuration but packagers can also put other default configuration
144 merge tool configuration but packagers can also put other default configuration
145 there.
145 there.
146
146
147 Syntax
147 Syntax
148 ======
148 ======
149
149
150 A configuration file consists of sections, led by a ``[section]`` header
150 A configuration file consists of sections, led by a ``[section]`` header
151 and followed by ``name = value`` entries (sometimes called
151 and followed by ``name = value`` entries (sometimes called
152 ``configuration keys``)::
152 ``configuration keys``)::
153
153
154 [spam]
154 [spam]
155 eggs=ham
155 eggs=ham
156 green=
156 green=
157 eggs
157 eggs
158
158
159 Each line contains one entry. If the lines that follow are indented,
159 Each line contains one entry. If the lines that follow are indented,
160 they are treated as continuations of that entry. Leading whitespace is
160 they are treated as continuations of that entry. Leading whitespace is
161 removed from values. Empty lines are skipped. Lines beginning with
161 removed from values. Empty lines are skipped. Lines beginning with
162 ``#`` or ``;`` are ignored and may be used to provide comments.
162 ``#`` or ``;`` are ignored and may be used to provide comments.
163
163
164 Configuration keys can be set multiple times, in which case Mercurial
164 Configuration keys can be set multiple times, in which case Mercurial
165 will use the value that was configured last. As an example::
165 will use the value that was configured last. As an example::
166
166
167 [spam]
167 [spam]
168 eggs=large
168 eggs=large
169 ham=serrano
169 ham=serrano
170 eggs=small
170 eggs=small
171
171
172 This would set the configuration key named ``eggs`` to ``small``.
172 This would set the configuration key named ``eggs`` to ``small``.
173
173
174 It is also possible to define a section multiple times. A section can
174 It is also possible to define a section multiple times. A section can
175 be redefined on the same and/or on different configuration files. For
175 be redefined on the same and/or on different configuration files. For
176 example::
176 example::
177
177
178 [foo]
178 [foo]
179 eggs=large
179 eggs=large
180 ham=serrano
180 ham=serrano
181 eggs=small
181 eggs=small
182
182
183 [bar]
183 [bar]
184 eggs=ham
184 eggs=ham
185 green=
185 green=
186 eggs
186 eggs
187
187
188 [foo]
188 [foo]
189 ham=prosciutto
189 ham=prosciutto
190 eggs=medium
190 eggs=medium
191 bread=toasted
191 bread=toasted
192
192
193 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
193 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
194 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
194 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
195 respectively. As you can see there only thing that matters is the last
195 respectively. As you can see there only thing that matters is the last
196 value that was set for each of the configuration keys.
196 value that was set for each of the configuration keys.
197
197
198 If a configuration key is set multiple times in different
198 If a configuration key is set multiple times in different
199 configuration files the final value will depend on the order in which
199 configuration files the final value will depend on the order in which
200 the different configuration files are read, with settings from earlier
200 the different configuration files are read, with settings from earlier
201 paths overriding later ones as described on the ``Files`` section
201 paths overriding later ones as described on the ``Files`` section
202 above.
202 above.
203
203
204 A line of the form ``%include file`` will include ``file`` into the
204 A line of the form ``%include file`` will include ``file`` into the
205 current configuration file. The inclusion is recursive, which means
205 current configuration file. The inclusion is recursive, which means
206 that included files can include other files. Filenames are relative to
206 that included files can include other files. Filenames are relative to
207 the configuration file in which the ``%include`` directive is found.
207 the configuration file in which the ``%include`` directive is found.
208 Environment variables and ``~user`` constructs are expanded in
208 Environment variables and ``~user`` constructs are expanded in
209 ``file``. This lets you do something like::
209 ``file``. This lets you do something like::
210
210
211 %include ~/.hgrc.d/$HOST.rc
211 %include ~/.hgrc.d/$HOST.rc
212
212
213 to include a different configuration file on each computer you use.
213 to include a different configuration file on each computer you use.
214
214
215 A line with ``%unset name`` will remove ``name`` from the current
215 A line with ``%unset name`` will remove ``name`` from the current
216 section, if it has been set previously.
216 section, if it has been set previously.
217
217
218 The values are either free-form text strings, lists of text strings,
218 The values are either free-form text strings, lists of text strings,
219 or Boolean values. Boolean values can be set to true using any of "1",
219 or Boolean values. Boolean values can be set to true using any of "1",
220 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
220 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
221 (all case insensitive).
221 (all case insensitive).
222
222
223 List values are separated by whitespace or comma, except when values are
223 List values are separated by whitespace or comma, except when values are
224 placed in double quotation marks::
224 placed in double quotation marks::
225
225
226 allow_read = "John Doe, PhD", brian, betty
226 allow_read = "John Doe, PhD", brian, betty
227
227
228 Quotation marks can be escaped by prefixing them with a backslash. Only
228 Quotation marks can be escaped by prefixing them with a backslash. Only
229 quotation marks at the beginning of a word is counted as a quotation
229 quotation marks at the beginning of a word is counted as a quotation
230 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
230 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
231
231
232 Sections
232 Sections
233 ========
233 ========
234
234
235 This section describes the different sections that may appear in a
235 This section describes the different sections that may appear in a
236 Mercurial configuration file, the purpose of each section, its possible
236 Mercurial configuration file, the purpose of each section, its possible
237 keys, and their possible values.
237 keys, and their possible values.
238
238
239 ``alias``
239 ``alias``
240 ---------
240 ---------
241
241
242 Defines command aliases.
242 Defines command aliases.
243
243
244 Aliases allow you to define your own commands in terms of other
244 Aliases allow you to define your own commands in terms of other
245 commands (or aliases), optionally including arguments. Positional
245 commands (or aliases), optionally including arguments. Positional
246 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
246 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
247 are expanded by Mercurial before execution. Positional arguments not
247 are expanded by Mercurial before execution. Positional arguments not
248 already used by ``$N`` in the definition are put at the end of the
248 already used by ``$N`` in the definition are put at the end of the
249 command to be executed.
249 command to be executed.
250
250
251 Alias definitions consist of lines of the form::
251 Alias definitions consist of lines of the form::
252
252
253 <alias> = <command> [<argument>]...
253 <alias> = <command> [<argument>]...
254
254
255 For example, this definition::
255 For example, this definition::
256
256
257 latest = log --limit 5
257 latest = log --limit 5
258
258
259 creates a new command ``latest`` that shows only the five most recent
259 creates a new command ``latest`` that shows only the five most recent
260 changesets. You can define subsequent aliases using earlier ones::
260 changesets. You can define subsequent aliases using earlier ones::
261
261
262 stable5 = latest -b stable
262 stable5 = latest -b stable
263
263
264 .. note::
264 .. note::
265
265
266 It is possible to create aliases with the same names as
266 It is possible to create aliases with the same names as
267 existing commands, which will then override the original
267 existing commands, which will then override the original
268 definitions. This is almost always a bad idea!
268 definitions. This is almost always a bad idea!
269
269
270 An alias can start with an exclamation point (``!``) to make it a
270 An alias can start with an exclamation point (``!``) to make it a
271 shell alias. A shell alias is executed with the shell and will let you
271 shell alias. A shell alias is executed with the shell and will let you
272 run arbitrary commands. As an example, ::
272 run arbitrary commands. As an example, ::
273
273
274 echo = !echo $@
274 echo = !echo $@
275
275
276 will let you do ``hg echo foo`` to have ``foo`` printed in your
276 will let you do ``hg echo foo`` to have ``foo`` printed in your
277 terminal. A better example might be::
277 terminal. A better example might be::
278
278
279 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm
279 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm
280
280
281 which will make ``hg purge`` delete all unknown files in the
281 which will make ``hg purge`` delete all unknown files in the
282 repository in the same manner as the purge extension.
282 repository in the same manner as the purge extension.
283
283
284 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
284 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
285 expand to the command arguments. Unmatched arguments are
285 expand to the command arguments. Unmatched arguments are
286 removed. ``$0`` expands to the alias name and ``$@`` expands to all
286 removed. ``$0`` expands to the alias name and ``$@`` expands to all
287 arguments separated by a space. ``"$@"`` (with quotes) expands to all
287 arguments separated by a space. ``"$@"`` (with quotes) expands to all
288 arguments quoted individually and separated by a space. These expansions
288 arguments quoted individually and separated by a space. These expansions
289 happen before the command is passed to the shell.
289 happen before the command is passed to the shell.
290
290
291 Shell aliases are executed in an environment where ``$HG`` expands to
291 Shell aliases are executed in an environment where ``$HG`` expands to
292 the path of the Mercurial that was used to execute the alias. This is
292 the path of the Mercurial that was used to execute the alias. This is
293 useful when you want to call further Mercurial commands in a shell
293 useful when you want to call further Mercurial commands in a shell
294 alias, as was done above for the purge alias. In addition,
294 alias, as was done above for the purge alias. In addition,
295 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
295 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
296 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
296 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
297
297
298 .. note::
298 .. note::
299
299
300 Some global configuration options such as ``-R`` are
300 Some global configuration options such as ``-R`` are
301 processed before shell aliases and will thus not be passed to
301 processed before shell aliases and will thus not be passed to
302 aliases.
302 aliases.
303
303
304
304
305 ``annotate``
305 ``annotate``
306 ------------
306 ------------
307
307
308 Settings used when displaying file annotations. All values are
308 Settings used when displaying file annotations. All values are
309 Booleans and default to False. See :hg:`help config.diff` for
309 Booleans and default to False. See :hg:`help config.diff` for
310 related options for the diff command.
310 related options for the diff command.
311
311
312 ``ignorews``
312 ``ignorews``
313 Ignore white space when comparing lines.
313 Ignore white space when comparing lines.
314
314
315 ``ignorewsamount``
315 ``ignorewsamount``
316 Ignore changes in the amount of white space.
316 Ignore changes in the amount of white space.
317
317
318 ``ignoreblanklines``
318 ``ignoreblanklines``
319 Ignore changes whose lines are all blank.
319 Ignore changes whose lines are all blank.
320
320
321
321
322 ``auth``
322 ``auth``
323 --------
323 --------
324
324
325 Authentication credentials for HTTP authentication. This section
325 Authentication credentials for HTTP authentication. This section
326 allows you to store usernames and passwords for use when logging
326 allows you to store usernames and passwords for use when logging
327 *into* HTTP servers. See :hg:`help config.web` if
327 *into* HTTP servers. See :hg:`help config.web` if
328 you want to configure *who* can login to your HTTP server.
328 you want to configure *who* can login to your HTTP server.
329
329
330 Each line has the following format::
330 Each line has the following format::
331
331
332 <name>.<argument> = <value>
332 <name>.<argument> = <value>
333
333
334 where ``<name>`` is used to group arguments into authentication
334 where ``<name>`` is used to group arguments into authentication
335 entries. Example::
335 entries. Example::
336
336
337 foo.prefix = hg.intevation.de/mercurial
337 foo.prefix = hg.intevation.de/mercurial
338 foo.username = foo
338 foo.username = foo
339 foo.password = bar
339 foo.password = bar
340 foo.schemes = http https
340 foo.schemes = http https
341
341
342 bar.prefix = secure.example.org
342 bar.prefix = secure.example.org
343 bar.key = path/to/file.key
343 bar.key = path/to/file.key
344 bar.cert = path/to/file.cert
344 bar.cert = path/to/file.cert
345 bar.schemes = https
345 bar.schemes = https
346
346
347 Supported arguments:
347 Supported arguments:
348
348
349 ``prefix``
349 ``prefix``
350 Either ``*`` or a URI prefix with or without the scheme part.
350 Either ``*`` or a URI prefix with or without the scheme part.
351 The authentication entry with the longest matching prefix is used
351 The authentication entry with the longest matching prefix is used
352 (where ``*`` matches everything and counts as a match of length
352 (where ``*`` matches everything and counts as a match of length
353 1). If the prefix doesn't include a scheme, the match is performed
353 1). If the prefix doesn't include a scheme, the match is performed
354 against the URI with its scheme stripped as well, and the schemes
354 against the URI with its scheme stripped as well, and the schemes
355 argument, q.v., is then subsequently consulted.
355 argument, q.v., is then subsequently consulted.
356
356
357 ``username``
357 ``username``
358 Optional. Username to authenticate with. If not given, and the
358 Optional. Username to authenticate with. If not given, and the
359 remote site requires basic or digest authentication, the user will
359 remote site requires basic or digest authentication, the user will
360 be prompted for it. Environment variables are expanded in the
360 be prompted for it. Environment variables are expanded in the
361 username letting you do ``foo.username = $USER``. If the URI
361 username letting you do ``foo.username = $USER``. If the URI
362 includes a username, only ``[auth]`` entries with a matching
362 includes a username, only ``[auth]`` entries with a matching
363 username or without a username will be considered.
363 username or without a username will be considered.
364
364
365 ``password``
365 ``password``
366 Optional. Password to authenticate with. If not given, and the
366 Optional. Password to authenticate with. If not given, and the
367 remote site requires basic or digest authentication, the user
367 remote site requires basic or digest authentication, the user
368 will be prompted for it.
368 will be prompted for it.
369
369
370 ``key``
370 ``key``
371 Optional. PEM encoded client certificate key file. Environment
371 Optional. PEM encoded client certificate key file. Environment
372 variables are expanded in the filename.
372 variables are expanded in the filename.
373
373
374 ``cert``
374 ``cert``
375 Optional. PEM encoded client certificate chain file. Environment
375 Optional. PEM encoded client certificate chain file. Environment
376 variables are expanded in the filename.
376 variables are expanded in the filename.
377
377
378 ``schemes``
378 ``schemes``
379 Optional. Space separated list of URI schemes to use this
379 Optional. Space separated list of URI schemes to use this
380 authentication entry with. Only used if the prefix doesn't include
380 authentication entry with. Only used if the prefix doesn't include
381 a scheme. Supported schemes are http and https. They will match
381 a scheme. Supported schemes are http and https. They will match
382 static-http and static-https respectively, as well.
382 static-http and static-https respectively, as well.
383 (default: https)
383 (default: https)
384
384
385 If no suitable authentication entry is found, the user is prompted
385 If no suitable authentication entry is found, the user is prompted
386 for credentials as usual if required by the remote.
386 for credentials as usual if required by the remote.
387
387
388
388
389 ``committemplate``
389 ``committemplate``
390 ------------------
390 ------------------
391
391
392 ``changeset``
392 ``changeset``
393 String: configuration in this section is used as the template to
393 String: configuration in this section is used as the template to
394 customize the text shown in the editor when committing.
394 customize the text shown in the editor when committing.
395
395
396 In addition to pre-defined template keywords, commit log specific one
396 In addition to pre-defined template keywords, commit log specific one
397 below can be used for customization:
397 below can be used for customization:
398
398
399 ``extramsg``
399 ``extramsg``
400 String: Extra message (typically 'Leave message empty to abort
400 String: Extra message (typically 'Leave message empty to abort
401 commit.'). This may be changed by some commands or extensions.
401 commit.'). This may be changed by some commands or extensions.
402
402
403 For example, the template configuration below shows as same text as
403 For example, the template configuration below shows as same text as
404 one shown by default::
404 one shown by default::
405
405
406 [committemplate]
406 [committemplate]
407 changeset = {desc}\n\n
407 changeset = {desc}\n\n
408 HG: Enter commit message. Lines beginning with 'HG:' are removed.
408 HG: Enter commit message. Lines beginning with 'HG:' are removed.
409 HG: {extramsg}
409 HG: {extramsg}
410 HG: --
410 HG: --
411 HG: user: {author}\n{ifeq(p2rev, "-1", "",
411 HG: user: {author}\n{ifeq(p2rev, "-1", "",
412 "HG: branch merge\n")
412 "HG: branch merge\n")
413 }HG: branch '{branch}'\n{if(activebookmark,
413 }HG: branch '{branch}'\n{if(activebookmark,
414 "HG: bookmark '{activebookmark}'\n") }{subrepos %
414 "HG: bookmark '{activebookmark}'\n") }{subrepos %
415 "HG: subrepo {subrepo}\n" }{file_adds %
415 "HG: subrepo {subrepo}\n" }{file_adds %
416 "HG: added {file}\n" }{file_mods %
416 "HG: added {file}\n" }{file_mods %
417 "HG: changed {file}\n" }{file_dels %
417 "HG: changed {file}\n" }{file_dels %
418 "HG: removed {file}\n" }{if(files, "",
418 "HG: removed {file}\n" }{if(files, "",
419 "HG: no files changed\n")}
419 "HG: no files changed\n")}
420
420
421 .. note::
421 .. note::
422
422
423 For some problematic encodings (see :hg:`help win32mbcs` for
423 For some problematic encodings (see :hg:`help win32mbcs` for
424 detail), this customization should be configured carefully, to
424 detail), this customization should be configured carefully, to
425 avoid showing broken characters.
425 avoid showing broken characters.
426
426
427 For example, if a multibyte character ending with backslash (0x5c) is
427 For example, if a multibyte character ending with backslash (0x5c) is
428 followed by the ASCII character 'n' in the customized template,
428 followed by the ASCII character 'n' in the customized template,
429 the sequence of backslash and 'n' is treated as line-feed unexpectedly
429 the sequence of backslash and 'n' is treated as line-feed unexpectedly
430 (and the multibyte character is broken, too).
430 (and the multibyte character is broken, too).
431
431
432 Customized template is used for commands below (``--edit`` may be
432 Customized template is used for commands below (``--edit`` may be
433 required):
433 required):
434
434
435 - :hg:`backout`
435 - :hg:`backout`
436 - :hg:`commit`
436 - :hg:`commit`
437 - :hg:`fetch` (for merge commit only)
437 - :hg:`fetch` (for merge commit only)
438 - :hg:`graft`
438 - :hg:`graft`
439 - :hg:`histedit`
439 - :hg:`histedit`
440 - :hg:`import`
440 - :hg:`import`
441 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
441 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
442 - :hg:`rebase`
442 - :hg:`rebase`
443 - :hg:`shelve`
443 - :hg:`shelve`
444 - :hg:`sign`
444 - :hg:`sign`
445 - :hg:`tag`
445 - :hg:`tag`
446 - :hg:`transplant`
446 - :hg:`transplant`
447
447
448 Configuring items below instead of ``changeset`` allows showing
448 Configuring items below instead of ``changeset`` allows showing
449 customized message only for specific actions, or showing different
449 customized message only for specific actions, or showing different
450 messages for each action.
450 messages for each action.
451
451
452 - ``changeset.backout`` for :hg:`backout`
452 - ``changeset.backout`` for :hg:`backout`
453 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
453 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
454 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
454 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
455 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
455 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
456 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
456 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
457 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
457 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
458 - ``changeset.gpg.sign`` for :hg:`sign`
458 - ``changeset.gpg.sign`` for :hg:`sign`
459 - ``changeset.graft`` for :hg:`graft`
459 - ``changeset.graft`` for :hg:`graft`
460 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
460 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
461 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
461 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
462 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
462 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
463 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
463 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
464 - ``changeset.import.bypass`` for :hg:`import --bypass`
464 - ``changeset.import.bypass`` for :hg:`import --bypass`
465 - ``changeset.import.normal.merge`` for :hg:`import` on merges
465 - ``changeset.import.normal.merge`` for :hg:`import` on merges
466 - ``changeset.import.normal.normal`` for :hg:`import` on other
466 - ``changeset.import.normal.normal`` for :hg:`import` on other
467 - ``changeset.mq.qnew`` for :hg:`qnew`
467 - ``changeset.mq.qnew`` for :hg:`qnew`
468 - ``changeset.mq.qfold`` for :hg:`qfold`
468 - ``changeset.mq.qfold`` for :hg:`qfold`
469 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
469 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
470 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
470 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
471 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
471 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
472 - ``changeset.rebase.normal`` for :hg:`rebase` on other
472 - ``changeset.rebase.normal`` for :hg:`rebase` on other
473 - ``changeset.shelve.shelve`` for :hg:`shelve`
473 - ``changeset.shelve.shelve`` for :hg:`shelve`
474 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
474 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
475 - ``changeset.tag.remove`` for :hg:`tag --remove`
475 - ``changeset.tag.remove`` for :hg:`tag --remove`
476 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
476 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
477 - ``changeset.transplant.normal`` for :hg:`transplant` on other
477 - ``changeset.transplant.normal`` for :hg:`transplant` on other
478
478
479 These dot-separated lists of names are treated as hierarchical ones.
479 These dot-separated lists of names are treated as hierarchical ones.
480 For example, ``changeset.tag.remove`` customizes the commit message
480 For example, ``changeset.tag.remove`` customizes the commit message
481 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
481 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
482 commit message for :hg:`tag` regardless of ``--remove`` option.
482 commit message for :hg:`tag` regardless of ``--remove`` option.
483
483
484 When the external editor is invoked for a commit, the corresponding
484 When the external editor is invoked for a commit, the corresponding
485 dot-separated list of names without the ``changeset.`` prefix
485 dot-separated list of names without the ``changeset.`` prefix
486 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
486 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
487 variable.
487 variable.
488
488
489 In this section, items other than ``changeset`` can be referred from
489 In this section, items other than ``changeset`` can be referred from
490 others. For example, the configuration to list committed files up
490 others. For example, the configuration to list committed files up
491 below can be referred as ``{listupfiles}``::
491 below can be referred as ``{listupfiles}``::
492
492
493 [committemplate]
493 [committemplate]
494 listupfiles = {file_adds %
494 listupfiles = {file_adds %
495 "HG: added {file}\n" }{file_mods %
495 "HG: added {file}\n" }{file_mods %
496 "HG: changed {file}\n" }{file_dels %
496 "HG: changed {file}\n" }{file_dels %
497 "HG: removed {file}\n" }{if(files, "",
497 "HG: removed {file}\n" }{if(files, "",
498 "HG: no files changed\n")}
498 "HG: no files changed\n")}
499
499
500 ``decode/encode``
500 ``decode/encode``
501 -----------------
501 -----------------
502
502
503 Filters for transforming files on checkout/checkin. This would
503 Filters for transforming files on checkout/checkin. This would
504 typically be used for newline processing or other
504 typically be used for newline processing or other
505 localization/canonicalization of files.
505 localization/canonicalization of files.
506
506
507 Filters consist of a filter pattern followed by a filter command.
507 Filters consist of a filter pattern followed by a filter command.
508 Filter patterns are globs by default, rooted at the repository root.
508 Filter patterns are globs by default, rooted at the repository root.
509 For example, to match any file ending in ``.txt`` in the root
509 For example, to match any file ending in ``.txt`` in the root
510 directory only, use the pattern ``*.txt``. To match any file ending
510 directory only, use the pattern ``*.txt``. To match any file ending
511 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
511 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
512 For each file only the first matching filter applies.
512 For each file only the first matching filter applies.
513
513
514 The filter command can start with a specifier, either ``pipe:`` or
514 The filter command can start with a specifier, either ``pipe:`` or
515 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
515 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
516
516
517 A ``pipe:`` command must accept data on stdin and return the transformed
517 A ``pipe:`` command must accept data on stdin and return the transformed
518 data on stdout.
518 data on stdout.
519
519
520 Pipe example::
520 Pipe example::
521
521
522 [encode]
522 [encode]
523 # uncompress gzip files on checkin to improve delta compression
523 # uncompress gzip files on checkin to improve delta compression
524 # note: not necessarily a good idea, just an example
524 # note: not necessarily a good idea, just an example
525 *.gz = pipe: gunzip
525 *.gz = pipe: gunzip
526
526
527 [decode]
527 [decode]
528 # recompress gzip files when writing them to the working dir (we
528 # recompress gzip files when writing them to the working dir (we
529 # can safely omit "pipe:", because it's the default)
529 # can safely omit "pipe:", because it's the default)
530 *.gz = gzip
530 *.gz = gzip
531
531
532 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
532 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
533 with the name of a temporary file that contains the data to be
533 with the name of a temporary file that contains the data to be
534 filtered by the command. The string ``OUTFILE`` is replaced with the name
534 filtered by the command. The string ``OUTFILE`` is replaced with the name
535 of an empty temporary file, where the filtered data must be written by
535 of an empty temporary file, where the filtered data must be written by
536 the command.
536 the command.
537
537
538 .. container:: windows
538 .. container:: windows
539
539
540 .. note::
540 .. note::
541
541
542 The tempfile mechanism is recommended for Windows systems,
542 The tempfile mechanism is recommended for Windows systems,
543 where the standard shell I/O redirection operators often have
543 where the standard shell I/O redirection operators often have
544 strange effects and may corrupt the contents of your files.
544 strange effects and may corrupt the contents of your files.
545
545
546 This filter mechanism is used internally by the ``eol`` extension to
546 This filter mechanism is used internally by the ``eol`` extension to
547 translate line ending characters between Windows (CRLF) and Unix (LF)
547 translate line ending characters between Windows (CRLF) and Unix (LF)
548 format. We suggest you use the ``eol`` extension for convenience.
548 format. We suggest you use the ``eol`` extension for convenience.
549
549
550
550
551 ``defaults``
551 ``defaults``
552 ------------
552 ------------
553
553
554 (defaults are deprecated. Don't use them. Use aliases instead.)
554 (defaults are deprecated. Don't use them. Use aliases instead.)
555
555
556 Use the ``[defaults]`` section to define command defaults, i.e. the
556 Use the ``[defaults]`` section to define command defaults, i.e. the
557 default options/arguments to pass to the specified commands.
557 default options/arguments to pass to the specified commands.
558
558
559 The following example makes :hg:`log` run in verbose mode, and
559 The following example makes :hg:`log` run in verbose mode, and
560 :hg:`status` show only the modified files, by default::
560 :hg:`status` show only the modified files, by default::
561
561
562 [defaults]
562 [defaults]
563 log = -v
563 log = -v
564 status = -m
564 status = -m
565
565
566 The actual commands, instead of their aliases, must be used when
566 The actual commands, instead of their aliases, must be used when
567 defining command defaults. The command defaults will also be applied
567 defining command defaults. The command defaults will also be applied
568 to the aliases of the commands defined.
568 to the aliases of the commands defined.
569
569
570
570
571 ``diff``
571 ``diff``
572 --------
572 --------
573
573
574 Settings used when displaying diffs. Everything except for ``unified``
574 Settings used when displaying diffs. Everything except for ``unified``
575 is a Boolean and defaults to False. See :hg:`help config.annotate`
575 is a Boolean and defaults to False. See :hg:`help config.annotate`
576 for related options for the annotate command.
576 for related options for the annotate command.
577
577
578 ``git``
578 ``git``
579 Use git extended diff format.
579 Use git extended diff format.
580
580
581 ``nobinary``
581 ``nobinary``
582 Omit git binary patches.
582 Omit git binary patches.
583
583
584 ``nodates``
584 ``nodates``
585 Don't include dates in diff headers.
585 Don't include dates in diff headers.
586
586
587 ``noprefix``
587 ``noprefix``
588 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
588 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
589
589
590 ``showfunc``
590 ``showfunc``
591 Show which function each change is in.
591 Show which function each change is in.
592
592
593 ``ignorews``
593 ``ignorews``
594 Ignore white space when comparing lines.
594 Ignore white space when comparing lines.
595
595
596 ``ignorewsamount``
596 ``ignorewsamount``
597 Ignore changes in the amount of white space.
597 Ignore changes in the amount of white space.
598
598
599 ``ignoreblanklines``
599 ``ignoreblanklines``
600 Ignore changes whose lines are all blank.
600 Ignore changes whose lines are all blank.
601
601
602 ``unified``
602 ``unified``
603 Number of lines of context to show.
603 Number of lines of context to show.
604
604
605 ``email``
605 ``email``
606 ---------
606 ---------
607
607
608 Settings for extensions that send email messages.
608 Settings for extensions that send email messages.
609
609
610 ``from``
610 ``from``
611 Optional. Email address to use in "From" header and SMTP envelope
611 Optional. Email address to use in "From" header and SMTP envelope
612 of outgoing messages.
612 of outgoing messages.
613
613
614 ``to``
614 ``to``
615 Optional. Comma-separated list of recipients' email addresses.
615 Optional. Comma-separated list of recipients' email addresses.
616
616
617 ``cc``
617 ``cc``
618 Optional. Comma-separated list of carbon copy recipients'
618 Optional. Comma-separated list of carbon copy recipients'
619 email addresses.
619 email addresses.
620
620
621 ``bcc``
621 ``bcc``
622 Optional. Comma-separated list of blind carbon copy recipients'
622 Optional. Comma-separated list of blind carbon copy recipients'
623 email addresses.
623 email addresses.
624
624
625 ``method``
625 ``method``
626 Optional. Method to use to send email messages. If value is ``smtp``
626 Optional. Method to use to send email messages. If value is ``smtp``
627 (default), use SMTP (see the ``[smtp]`` section for configuration).
627 (default), use SMTP (see the ``[smtp]`` section for configuration).
628 Otherwise, use as name of program to run that acts like sendmail
628 Otherwise, use as name of program to run that acts like sendmail
629 (takes ``-f`` option for sender, list of recipients on command line,
629 (takes ``-f`` option for sender, list of recipients on command line,
630 message on stdin). Normally, setting this to ``sendmail`` or
630 message on stdin). Normally, setting this to ``sendmail`` or
631 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
631 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
632
632
633 ``charsets``
633 ``charsets``
634 Optional. Comma-separated list of character sets considered
634 Optional. Comma-separated list of character sets considered
635 convenient for recipients. Addresses, headers, and parts not
635 convenient for recipients. Addresses, headers, and parts not
636 containing patches of outgoing messages will be encoded in the
636 containing patches of outgoing messages will be encoded in the
637 first character set to which conversion from local encoding
637 first character set to which conversion from local encoding
638 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
638 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
639 conversion fails, the text in question is sent as is.
639 conversion fails, the text in question is sent as is.
640 (default: '')
640 (default: '')
641
641
642 Order of outgoing email character sets:
642 Order of outgoing email character sets:
643
643
644 1. ``us-ascii``: always first, regardless of settings
644 1. ``us-ascii``: always first, regardless of settings
645 2. ``email.charsets``: in order given by user
645 2. ``email.charsets``: in order given by user
646 3. ``ui.fallbackencoding``: if not in email.charsets
646 3. ``ui.fallbackencoding``: if not in email.charsets
647 4. ``$HGENCODING``: if not in email.charsets
647 4. ``$HGENCODING``: if not in email.charsets
648 5. ``utf-8``: always last, regardless of settings
648 5. ``utf-8``: always last, regardless of settings
649
649
650 Email example::
650 Email example::
651
651
652 [email]
652 [email]
653 from = Joseph User <joe.user@example.com>
653 from = Joseph User <joe.user@example.com>
654 method = /usr/sbin/sendmail
654 method = /usr/sbin/sendmail
655 # charsets for western Europeans
655 # charsets for western Europeans
656 # us-ascii, utf-8 omitted, as they are tried first and last
656 # us-ascii, utf-8 omitted, as they are tried first and last
657 charsets = iso-8859-1, iso-8859-15, windows-1252
657 charsets = iso-8859-1, iso-8859-15, windows-1252
658
658
659
659
660 ``extensions``
660 ``extensions``
661 --------------
661 --------------
662
662
663 Mercurial has an extension mechanism for adding new features. To
663 Mercurial has an extension mechanism for adding new features. To
664 enable an extension, create an entry for it in this section.
664 enable an extension, create an entry for it in this section.
665
665
666 If you know that the extension is already in Python's search path,
666 If you know that the extension is already in Python's search path,
667 you can give the name of the module, followed by ``=``, with nothing
667 you can give the name of the module, followed by ``=``, with nothing
668 after the ``=``.
668 after the ``=``.
669
669
670 Otherwise, give a name that you choose, followed by ``=``, followed by
670 Otherwise, give a name that you choose, followed by ``=``, followed by
671 the path to the ``.py`` file (including the file name extension) that
671 the path to the ``.py`` file (including the file name extension) that
672 defines the extension.
672 defines the extension.
673
673
674 To explicitly disable an extension that is enabled in an hgrc of
674 To explicitly disable an extension that is enabled in an hgrc of
675 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
675 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
676 or ``foo = !`` when path is not supplied.
676 or ``foo = !`` when path is not supplied.
677
677
678 Example for ``~/.hgrc``::
678 Example for ``~/.hgrc``::
679
679
680 [extensions]
680 [extensions]
681 # (the color extension will get loaded from Mercurial's path)
681 # (the color extension will get loaded from Mercurial's path)
682 color =
682 color =
683 # (this extension will get loaded from the file specified)
683 # (this extension will get loaded from the file specified)
684 myfeature = ~/.hgext/myfeature.py
684 myfeature = ~/.hgext/myfeature.py
685
685
686
686
687 ``format``
687 ``format``
688 ----------
688 ----------
689
689
690 ``usegeneraldelta``
690 ``usegeneraldelta``
691 Enable or disable the "generaldelta" repository format which improves
691 Enable or disable the "generaldelta" repository format which improves
692 repository compression by allowing "revlog" to store delta against arbitrary
692 repository compression by allowing "revlog" to store delta against arbitrary
693 revision instead of the previous stored one. This provides significant
693 revision instead of the previous stored one. This provides significant
694 improvement for repositories with branches.
694 improvement for repositories with branches.
695
695
696 Repositories with this on-disk format require Mercurial version 1.9.
696 Repositories with this on-disk format require Mercurial version 1.9.
697
697
698 Enabled by default.
698 Enabled by default.
699
699
700 ``dotencode``
700 ``dotencode``
701 Enable or disable the "dotencode" repository format which enhances
701 Enable or disable the "dotencode" repository format which enhances
702 the "fncache" repository format (which has to be enabled to use
702 the "fncache" repository format (which has to be enabled to use
703 dotencode) to avoid issues with filenames starting with ._ on
703 dotencode) to avoid issues with filenames starting with ._ on
704 Mac OS X and spaces on Windows.
704 Mac OS X and spaces on Windows.
705
705
706 Repositories with this on-disk format require Mercurial version 1.7.
706 Repositories with this on-disk format require Mercurial version 1.7.
707
707
708 Enabled by default.
708 Enabled by default.
709
709
710 ``usefncache``
710 ``usefncache``
711 Enable or disable the "fncache" repository format which enhances
711 Enable or disable the "fncache" repository format which enhances
712 the "store" repository format (which has to be enabled to use
712 the "store" repository format (which has to be enabled to use
713 fncache) to allow longer filenames and avoids using Windows
713 fncache) to allow longer filenames and avoids using Windows
714 reserved names, e.g. "nul".
714 reserved names, e.g. "nul".
715
715
716 Repositories with this on-disk format require Mercurial version 1.1.
716 Repositories with this on-disk format require Mercurial version 1.1.
717
717
718 Enabled by default.
718 Enabled by default.
719
719
720 ``usestore``
720 ``usestore``
721 Enable or disable the "store" repository format which improves
721 Enable or disable the "store" repository format which improves
722 compatibility with systems that fold case or otherwise mangle
722 compatibility with systems that fold case or otherwise mangle
723 filenames. Disabling this option will allow you to store longer filenames
723 filenames. Disabling this option will allow you to store longer filenames
724 in some situations at the expense of compatibility.
724 in some situations at the expense of compatibility.
725
725
726 Repositories with this on-disk format require Mercurial version 0.9.4.
726 Repositories with this on-disk format require Mercurial version 0.9.4.
727
727
728 Enabled by default.
728 Enabled by default.
729
729
730 ``graph``
730 ``graph``
731 ---------
731 ---------
732
732
733 Web graph view configuration. This section let you change graph
733 Web graph view configuration. This section let you change graph
734 elements display properties by branches, for instance to make the
734 elements display properties by branches, for instance to make the
735 ``default`` branch stand out.
735 ``default`` branch stand out.
736
736
737 Each line has the following format::
737 Each line has the following format::
738
738
739 <branch>.<argument> = <value>
739 <branch>.<argument> = <value>
740
740
741 where ``<branch>`` is the name of the branch being
741 where ``<branch>`` is the name of the branch being
742 customized. Example::
742 customized. Example::
743
743
744 [graph]
744 [graph]
745 # 2px width
745 # 2px width
746 default.width = 2
746 default.width = 2
747 # red color
747 # red color
748 default.color = FF0000
748 default.color = FF0000
749
749
750 Supported arguments:
750 Supported arguments:
751
751
752 ``width``
752 ``width``
753 Set branch edges width in pixels.
753 Set branch edges width in pixels.
754
754
755 ``color``
755 ``color``
756 Set branch edges color in hexadecimal RGB notation.
756 Set branch edges color in hexadecimal RGB notation.
757
757
758 ``hooks``
758 ``hooks``
759 ---------
759 ---------
760
760
761 Commands or Python functions that get automatically executed by
761 Commands or Python functions that get automatically executed by
762 various actions such as starting or finishing a commit. Multiple
762 various actions such as starting or finishing a commit. Multiple
763 hooks can be run for the same action by appending a suffix to the
763 hooks can be run for the same action by appending a suffix to the
764 action. Overriding a site-wide hook can be done by changing its
764 action. Overriding a site-wide hook can be done by changing its
765 value or setting it to an empty string. Hooks can be prioritized
765 value or setting it to an empty string. Hooks can be prioritized
766 by adding a prefix of ``priority.`` to the hook name on a new line
766 by adding a prefix of ``priority.`` to the hook name on a new line
767 and setting the priority. The default priority is 0.
767 and setting the priority. The default priority is 0.
768
768
769 Example ``.hg/hgrc``::
769 Example ``.hg/hgrc``::
770
770
771 [hooks]
771 [hooks]
772 # update working directory after adding changesets
772 # update working directory after adding changesets
773 changegroup.update = hg update
773 changegroup.update = hg update
774 # do not use the site-wide hook
774 # do not use the site-wide hook
775 incoming =
775 incoming =
776 incoming.email = /my/email/hook
776 incoming.email = /my/email/hook
777 incoming.autobuild = /my/build/hook
777 incoming.autobuild = /my/build/hook
778 # force autobuild hook to run before other incoming hooks
778 # force autobuild hook to run before other incoming hooks
779 priority.incoming.autobuild = 1
779 priority.incoming.autobuild = 1
780
780
781 Most hooks are run with environment variables set that give useful
781 Most hooks are run with environment variables set that give useful
782 additional information. For each hook below, the environment
782 additional information. For each hook below, the environment
783 variables it is passed are listed with names of the form ``$HG_foo``.
783 variables it is passed are listed with names of the form ``$HG_foo``.
784
784
785 ``changegroup``
785 ``changegroup``
786 Run after a changegroup has been added via push, pull or unbundle. ID of the
786 Run after a changegroup has been added via push, pull or unbundle. ID of the
787 first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
787 first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
788 from which changes came is in ``$HG_URL``.
788 from which changes came is in ``$HG_URL``.
789
789
790 ``commit``
790 ``commit``
791 Run after a changeset has been created in the local repository. ID
791 Run after a changeset has been created in the local repository. ID
792 of the newly created changeset is in ``$HG_NODE``. Parent changeset
792 of the newly created changeset is in ``$HG_NODE``. Parent changeset
793 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
793 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
794
794
795 ``incoming``
795 ``incoming``
796 Run after a changeset has been pulled, pushed, or unbundled into
796 Run after a changeset has been pulled, pushed, or unbundled into
797 the local repository. The ID of the newly arrived changeset is in
797 the local repository. The ID of the newly arrived changeset is in
798 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
798 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
799
799
800 ``outgoing``
800 ``outgoing``
801 Run after sending changes from local repository to another. ID of
801 Run after sending changes from local repository to another. ID of
802 first changeset sent is in ``$HG_NODE``. Source of operation is in
802 first changeset sent is in ``$HG_NODE``. Source of operation is in
803 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
803 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
804
804
805 ``post-<command>``
805 ``post-<command>``
806 Run after successful invocations of the associated command. The
806 Run after successful invocations of the associated command. The
807 contents of the command line are passed as ``$HG_ARGS`` and the result
807 contents of the command line are passed as ``$HG_ARGS`` and the result
808 code in ``$HG_RESULT``. Parsed command line arguments are passed as
808 code in ``$HG_RESULT``. Parsed command line arguments are passed as
809 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
809 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
810 the python data internally passed to <command>. ``$HG_OPTS`` is a
810 the python data internally passed to <command>. ``$HG_OPTS`` is a
811 dictionary of options (with unspecified options set to their defaults).
811 dictionary of options (with unspecified options set to their defaults).
812 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
812 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
813
813
814 ``pre-<command>``
814 ``pre-<command>``
815 Run before executing the associated command. The contents of the
815 Run before executing the associated command. The contents of the
816 command line are passed as ``$HG_ARGS``. Parsed command line arguments
816 command line are passed as ``$HG_ARGS``. Parsed command line arguments
817 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
817 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
818 representations of the data internally passed to <command>. ``$HG_OPTS``
818 representations of the data internally passed to <command>. ``$HG_OPTS``
819 is a dictionary of options (with unspecified options set to their
819 is a dictionary of options (with unspecified options set to their
820 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
820 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
821 failure, the command doesn't execute and Mercurial returns the failure
821 failure, the command doesn't execute and Mercurial returns the failure
822 code.
822 code.
823
823
824 ``prechangegroup``
824 ``prechangegroup``
825 Run before a changegroup is added via push, pull or unbundle. Exit
825 Run before a changegroup is added via push, pull or unbundle. Exit
826 status 0 allows the changegroup to proceed. Non-zero status will
826 status 0 allows the changegroup to proceed. Non-zero status will
827 cause the push, pull or unbundle to fail. URL from which changes
827 cause the push, pull or unbundle to fail. URL from which changes
828 will come is in ``$HG_URL``.
828 will come is in ``$HG_URL``.
829
829
830 ``precommit``
830 ``precommit``
831 Run before starting a local commit. Exit status 0 allows the
831 Run before starting a local commit. Exit status 0 allows the
832 commit to proceed. Non-zero status will cause the commit to fail.
832 commit to proceed. Non-zero status will cause the commit to fail.
833 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
833 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
834
834
835 ``prelistkeys``
835 ``prelistkeys``
836 Run before listing pushkeys (like bookmarks) in the
836 Run before listing pushkeys (like bookmarks) in the
837 repository. Non-zero status will cause failure. The key namespace is
837 repository. Non-zero status will cause failure. The key namespace is
838 in ``$HG_NAMESPACE``.
838 in ``$HG_NAMESPACE``.
839
839
840 ``preoutgoing``
840 ``preoutgoing``
841 Run before collecting changes to send from the local repository to
841 Run before collecting changes to send from the local repository to
842 another. Non-zero status will cause failure. This lets you prevent
842 another. Non-zero status will cause failure. This lets you prevent
843 pull over HTTP or SSH. Also prevents against local pull, push
843 pull over HTTP or SSH. Also prevents against local pull, push
844 (outbound) or bundle commands, but not effective, since you can
844 (outbound) or bundle commands, but not effective, since you can
845 just copy files instead then. Source of operation is in
845 just copy files instead then. Source of operation is in
846 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
846 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
847 SSH or HTTP repository. If "push", "pull" or "bundle", operation
847 SSH or HTTP repository. If "push", "pull" or "bundle", operation
848 is happening on behalf of repository on same system.
848 is happening on behalf of repository on same system.
849
849
850 ``prepushkey``
850 ``prepushkey``
851 Run before a pushkey (like a bookmark) is added to the
851 Run before a pushkey (like a bookmark) is added to the
852 repository. Non-zero status will cause the key to be rejected. The
852 repository. Non-zero status will cause the key to be rejected. The
853 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
853 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
854 the old value (if any) is in ``$HG_OLD``, and the new value is in
854 the old value (if any) is in ``$HG_OLD``, and the new value is in
855 ``$HG_NEW``.
855 ``$HG_NEW``.
856
856
857 ``pretag``
857 ``pretag``
858 Run before creating a tag. Exit status 0 allows the tag to be
858 Run before creating a tag. Exit status 0 allows the tag to be
859 created. Non-zero status will cause the tag to fail. ID of
859 created. Non-zero status will cause the tag to fail. ID of
860 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
860 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
861 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
861 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
862
862
863 ``pretxnopen``
863 ``pretxnopen``
864 Run before any new repository transaction is open. The reason for the
864 Run before any new repository transaction is open. The reason for the
865 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
865 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
866 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
866 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
867 transaction from being opened.
867 transaction from being opened.
868
868
869 ``pretxnclose``
869 ``pretxnclose``
870 Run right before the transaction is actually finalized. Any repository change
870 Run right before the transaction is actually finalized. Any repository change
871 will be visible to the hook program. This lets you validate the transaction
871 will be visible to the hook program. This lets you validate the transaction
872 content or change it. Exit status 0 allows the commit to proceed. Non-zero
872 content or change it. Exit status 0 allows the commit to proceed. Non-zero
873 status will cause the transaction to be rolled back. The reason for the
873 status will cause the transaction to be rolled back. The reason for the
874 transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
874 transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
875 the transaction will be in ``HG_TXNID``. The rest of the available data will
875 the transaction will be in ``HG_TXNID``. The rest of the available data will
876 vary according the transaction type. New changesets will add ``$HG_NODE`` (id
876 vary according the transaction type. New changesets will add ``$HG_NODE`` (id
877 of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
877 of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
878 changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
878 changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
879 changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
879 changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
880
880
881 ``txnclose``
881 ``txnclose``
882 Run after any repository transaction has been committed. At this
882 Run after any repository transaction has been committed. At this
883 point, the transaction can no longer be rolled back. The hook will run
883 point, the transaction can no longer be rolled back. The hook will run
884 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
884 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
885 details about available variables.
885 details about available variables.
886
886
887 ``txnabort``
887 ``txnabort``
888 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
888 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
889 docs for details about available variables.
889 docs for details about available variables.
890
890
891 ``pretxnchangegroup``
891 ``pretxnchangegroup``
892 Run after a changegroup has been added via push, pull or unbundle, but before
892 Run after a changegroup has been added via push, pull or unbundle, but before
893 the transaction has been committed. Changegroup is visible to hook program.
893 the transaction has been committed. Changegroup is visible to hook program.
894 This lets you validate incoming changes before accepting them. Passed the ID
894 This lets you validate incoming changes before accepting them. Passed the ID
895 of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
895 of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
896 Exit status 0 allows the transaction to commit. Non-zero status will cause
896 Exit status 0 allows the transaction to commit. Non-zero status will cause
897 the transaction to be rolled back and the push, pull or unbundle will fail.
897 the transaction to be rolled back and the push, pull or unbundle will fail.
898 URL that was source of changes is in ``$HG_URL``.
898 URL that was source of changes is in ``$HG_URL``.
899
899
900 ``pretxncommit``
900 ``pretxncommit``
901 Run after a changeset has been created but the transaction not yet
901 Run after a changeset has been created but the transaction not yet
902 committed. Changeset is visible to hook program. This lets you
902 committed. Changeset is visible to hook program. This lets you
903 validate commit message and changes. Exit status 0 allows the
903 validate commit message and changes. Exit status 0 allows the
904 commit to proceed. Non-zero status will cause the transaction to
904 commit to proceed. Non-zero status will cause the transaction to
905 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
905 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
906 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
906 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
907
907
908 ``preupdate``
908 ``preupdate``
909 Run before updating the working directory. Exit status 0 allows
909 Run before updating the working directory. Exit status 0 allows
910 the update to proceed. Non-zero status will prevent the update.
910 the update to proceed. Non-zero status will prevent the update.
911 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
911 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
912 of second new parent is in ``$HG_PARENT2``.
912 of second new parent is in ``$HG_PARENT2``.
913
913
914 ``listkeys``
914 ``listkeys``
915 Run after listing pushkeys (like bookmarks) in the repository. The
915 Run after listing pushkeys (like bookmarks) in the repository. The
916 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
916 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
917 dictionary containing the keys and values.
917 dictionary containing the keys and values.
918
918
919 ``pushkey``
919 ``pushkey``
920 Run after a pushkey (like a bookmark) is added to the
920 Run after a pushkey (like a bookmark) is added to the
921 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
921 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
922 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
922 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
923 value is in ``$HG_NEW``.
923 value is in ``$HG_NEW``.
924
924
925 ``tag``
925 ``tag``
926 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
926 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
927 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
927 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
928 repository if ``$HG_LOCAL=0``.
928 repository if ``$HG_LOCAL=0``.
929
929
930 ``update``
930 ``update``
931 Run after updating the working directory. Changeset ID of first
931 Run after updating the working directory. Changeset ID of first
932 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
932 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
933 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
933 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
934 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
934 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
935
935
936 .. note::
936 .. note::
937
937
938 It is generally better to use standard hooks rather than the
938 It is generally better to use standard hooks rather than the
939 generic pre- and post- command hooks as they are guaranteed to be
939 generic pre- and post- command hooks as they are guaranteed to be
940 called in the appropriate contexts for influencing transactions.
940 called in the appropriate contexts for influencing transactions.
941 Also, hooks like "commit" will be called in all contexts that
941 Also, hooks like "commit" will be called in all contexts that
942 generate a commit (e.g. tag) and not just the commit command.
942 generate a commit (e.g. tag) and not just the commit command.
943
943
944 .. note::
944 .. note::
945
945
946 Environment variables with empty values may not be passed to
946 Environment variables with empty values may not be passed to
947 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
947 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
948 will have an empty value under Unix-like platforms for non-merge
948 will have an empty value under Unix-like platforms for non-merge
949 changesets, while it will not be available at all under Windows.
949 changesets, while it will not be available at all under Windows.
950
950
951 The syntax for Python hooks is as follows::
951 The syntax for Python hooks is as follows::
952
952
953 hookname = python:modulename.submodule.callable
953 hookname = python:modulename.submodule.callable
954 hookname = python:/path/to/python/module.py:callable
954 hookname = python:/path/to/python/module.py:callable
955
955
956 Python hooks are run within the Mercurial process. Each hook is
956 Python hooks are run within the Mercurial process. Each hook is
957 called with at least three keyword arguments: a ui object (keyword
957 called with at least three keyword arguments: a ui object (keyword
958 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
958 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
959 keyword that tells what kind of hook is used. Arguments listed as
959 keyword that tells what kind of hook is used. Arguments listed as
960 environment variables above are passed as keyword arguments, with no
960 environment variables above are passed as keyword arguments, with no
961 ``HG_`` prefix, and names in lower case.
961 ``HG_`` prefix, and names in lower case.
962
962
963 If a Python hook returns a "true" value or raises an exception, this
963 If a Python hook returns a "true" value or raises an exception, this
964 is treated as a failure.
964 is treated as a failure.
965
965
966
966
967 ``hostfingerprints``
967 ``hostfingerprints``
968 --------------------
968 --------------------
969
969
970 Fingerprints of the certificates of known HTTPS servers.
970 Fingerprints of the certificates of known HTTPS servers.
971
971
972 A HTTPS connection to a server with a fingerprint configured here will
972 A HTTPS connection to a server with a fingerprint configured here will
973 only succeed if the servers certificate matches the fingerprint.
973 only succeed if the servers certificate matches the fingerprint.
974 This is very similar to how ssh known hosts works.
974 This is very similar to how ssh known hosts works.
975
975
976 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
976 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
977 Multiple values can be specified (separated by spaces or commas). This can
977 Multiple values can be specified (separated by spaces or commas). This can
978 be used to define both old and new fingerprints while a host transitions
978 be used to define both old and new fingerprints while a host transitions
979 to a new certificate.
979 to a new certificate.
980
980
981 The CA chain and web.cacerts is not used for servers with a fingerprint.
981 The CA chain and web.cacerts is not used for servers with a fingerprint.
982
982
983 For example::
983 For example::
984
984
985 [hostfingerprints]
985 [hostfingerprints]
986 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
986 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
987 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
987 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
988
988
989 This feature is only supported when using Python 2.6 or later.
990
991
992 ``http_proxy``
989 ``http_proxy``
993 --------------
990 --------------
994
991
995 Used to access web-based Mercurial repositories through a HTTP
992 Used to access web-based Mercurial repositories through a HTTP
996 proxy.
993 proxy.
997
994
998 ``host``
995 ``host``
999 Host name and (optional) port of the proxy server, for example
996 Host name and (optional) port of the proxy server, for example
1000 "myproxy:8000".
997 "myproxy:8000".
1001
998
1002 ``no``
999 ``no``
1003 Optional. Comma-separated list of host names that should bypass
1000 Optional. Comma-separated list of host names that should bypass
1004 the proxy.
1001 the proxy.
1005
1002
1006 ``passwd``
1003 ``passwd``
1007 Optional. Password to authenticate with at the proxy server.
1004 Optional. Password to authenticate with at the proxy server.
1008
1005
1009 ``user``
1006 ``user``
1010 Optional. User name to authenticate with at the proxy server.
1007 Optional. User name to authenticate with at the proxy server.
1011
1008
1012 ``always``
1009 ``always``
1013 Optional. Always use the proxy, even for localhost and any entries
1010 Optional. Always use the proxy, even for localhost and any entries
1014 in ``http_proxy.no``. (default: False)
1011 in ``http_proxy.no``. (default: False)
1015
1012
1016 ``merge``
1013 ``merge``
1017 ---------
1014 ---------
1018
1015
1019 This section specifies behavior during merges and updates.
1016 This section specifies behavior during merges and updates.
1020
1017
1021 ``checkignored``
1018 ``checkignored``
1022 Controls behavior when an ignored file on disk has the same name as a tracked
1019 Controls behavior when an ignored file on disk has the same name as a tracked
1023 file in the changeset being merged or updated to, and has different
1020 file in the changeset being merged or updated to, and has different
1024 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1021 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1025 abort on such files. With ``warn``, warn on such files and back them up as
1022 abort on such files. With ``warn``, warn on such files and back them up as
1026 .orig. With ``ignore``, don't print a warning and back them up as
1023 .orig. With ``ignore``, don't print a warning and back them up as
1027 .orig. (default: ``abort``)
1024 .orig. (default: ``abort``)
1028
1025
1029 ``checkunknown``
1026 ``checkunknown``
1030 Controls behavior when an unknown file that isn't ignored has the same name
1027 Controls behavior when an unknown file that isn't ignored has the same name
1031 as a tracked file in the changeset being merged or updated to, and has
1028 as a tracked file in the changeset being merged or updated to, and has
1032 different contents. Similar to ``merge.checkignored``, except for files that
1029 different contents. Similar to ``merge.checkignored``, except for files that
1033 are not ignored. (default: ``abort``)
1030 are not ignored. (default: ``abort``)
1034
1031
1035 ``merge-patterns``
1032 ``merge-patterns``
1036 ------------------
1033 ------------------
1037
1034
1038 This section specifies merge tools to associate with particular file
1035 This section specifies merge tools to associate with particular file
1039 patterns. Tools matched here will take precedence over the default
1036 patterns. Tools matched here will take precedence over the default
1040 merge tool. Patterns are globs by default, rooted at the repository
1037 merge tool. Patterns are globs by default, rooted at the repository
1041 root.
1038 root.
1042
1039
1043 Example::
1040 Example::
1044
1041
1045 [merge-patterns]
1042 [merge-patterns]
1046 **.c = kdiff3
1043 **.c = kdiff3
1047 **.jpg = myimgmerge
1044 **.jpg = myimgmerge
1048
1045
1049 ``merge-tools``
1046 ``merge-tools``
1050 ---------------
1047 ---------------
1051
1048
1052 This section configures external merge tools to use for file-level
1049 This section configures external merge tools to use for file-level
1053 merges. This section has likely been preconfigured at install time.
1050 merges. This section has likely been preconfigured at install time.
1054 Use :hg:`config merge-tools` to check the existing configuration.
1051 Use :hg:`config merge-tools` to check the existing configuration.
1055 Also see :hg:`help merge-tools` for more details.
1052 Also see :hg:`help merge-tools` for more details.
1056
1053
1057 Example ``~/.hgrc``::
1054 Example ``~/.hgrc``::
1058
1055
1059 [merge-tools]
1056 [merge-tools]
1060 # Override stock tool location
1057 # Override stock tool location
1061 kdiff3.executable = ~/bin/kdiff3
1058 kdiff3.executable = ~/bin/kdiff3
1062 # Specify command line
1059 # Specify command line
1063 kdiff3.args = $base $local $other -o $output
1060 kdiff3.args = $base $local $other -o $output
1064 # Give higher priority
1061 # Give higher priority
1065 kdiff3.priority = 1
1062 kdiff3.priority = 1
1066
1063
1067 # Changing the priority of preconfigured tool
1064 # Changing the priority of preconfigured tool
1068 meld.priority = 0
1065 meld.priority = 0
1069
1066
1070 # Disable a preconfigured tool
1067 # Disable a preconfigured tool
1071 vimdiff.disabled = yes
1068 vimdiff.disabled = yes
1072
1069
1073 # Define new tool
1070 # Define new tool
1074 myHtmlTool.args = -m $local $other $base $output
1071 myHtmlTool.args = -m $local $other $base $output
1075 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1072 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1076 myHtmlTool.priority = 1
1073 myHtmlTool.priority = 1
1077
1074
1078 Supported arguments:
1075 Supported arguments:
1079
1076
1080 ``priority``
1077 ``priority``
1081 The priority in which to evaluate this tool.
1078 The priority in which to evaluate this tool.
1082 (default: 0)
1079 (default: 0)
1083
1080
1084 ``executable``
1081 ``executable``
1085 Either just the name of the executable or its pathname.
1082 Either just the name of the executable or its pathname.
1086
1083
1087 .. container:: windows
1084 .. container:: windows
1088
1085
1089 On Windows, the path can use environment variables with ${ProgramFiles}
1086 On Windows, the path can use environment variables with ${ProgramFiles}
1090 syntax.
1087 syntax.
1091
1088
1092 (default: the tool name)
1089 (default: the tool name)
1093
1090
1094 ``args``
1091 ``args``
1095 The arguments to pass to the tool executable. You can refer to the
1092 The arguments to pass to the tool executable. You can refer to the
1096 files being merged as well as the output file through these
1093 files being merged as well as the output file through these
1097 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1094 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1098 of ``$local`` and ``$other`` can vary depending on which action is being
1095 of ``$local`` and ``$other`` can vary depending on which action is being
1099 performed. During and update or merge, ``$local`` represents the original
1096 performed. During and update or merge, ``$local`` represents the original
1100 state of the file, while ``$other`` represents the commit you are updating
1097 state of the file, while ``$other`` represents the commit you are updating
1101 to or the commit you are merging with. During a rebase ``$local``
1098 to or the commit you are merging with. During a rebase ``$local``
1102 represents the destination of the rebase, and ``$other`` represents the
1099 represents the destination of the rebase, and ``$other`` represents the
1103 commit being rebased.
1100 commit being rebased.
1104 (default: ``$local $base $other``)
1101 (default: ``$local $base $other``)
1105
1102
1106 ``premerge``
1103 ``premerge``
1107 Attempt to run internal non-interactive 3-way merge tool before
1104 Attempt to run internal non-interactive 3-way merge tool before
1108 launching external tool. Options are ``true``, ``false``, ``keep`` or
1105 launching external tool. Options are ``true``, ``false``, ``keep`` or
1109 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1106 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1110 premerge fails. The ``keep-merge3`` will do the same but include information
1107 premerge fails. The ``keep-merge3`` will do the same but include information
1111 about the base of the merge in the marker (see internal :merge3 in
1108 about the base of the merge in the marker (see internal :merge3 in
1112 :hg:`help merge-tools`).
1109 :hg:`help merge-tools`).
1113 (default: True)
1110 (default: True)
1114
1111
1115 ``binary``
1112 ``binary``
1116 This tool can merge binary files. (default: False, unless tool
1113 This tool can merge binary files. (default: False, unless tool
1117 was selected by file pattern match)
1114 was selected by file pattern match)
1118
1115
1119 ``symlink``
1116 ``symlink``
1120 This tool can merge symlinks. (default: False)
1117 This tool can merge symlinks. (default: False)
1121
1118
1122 ``check``
1119 ``check``
1123 A list of merge success-checking options:
1120 A list of merge success-checking options:
1124
1121
1125 ``changed``
1122 ``changed``
1126 Ask whether merge was successful when the merged file shows no changes.
1123 Ask whether merge was successful when the merged file shows no changes.
1127 ``conflicts``
1124 ``conflicts``
1128 Check whether there are conflicts even though the tool reported success.
1125 Check whether there are conflicts even though the tool reported success.
1129 ``prompt``
1126 ``prompt``
1130 Always prompt for merge success, regardless of success reported by tool.
1127 Always prompt for merge success, regardless of success reported by tool.
1131
1128
1132 ``fixeol``
1129 ``fixeol``
1133 Attempt to fix up EOL changes caused by the merge tool.
1130 Attempt to fix up EOL changes caused by the merge tool.
1134 (default: False)
1131 (default: False)
1135
1132
1136 ``gui``
1133 ``gui``
1137 This tool requires a graphical interface to run. (default: False)
1134 This tool requires a graphical interface to run. (default: False)
1138
1135
1139 .. container:: windows
1136 .. container:: windows
1140
1137
1141 ``regkey``
1138 ``regkey``
1142 Windows registry key which describes install location of this
1139 Windows registry key which describes install location of this
1143 tool. Mercurial will search for this key first under
1140 tool. Mercurial will search for this key first under
1144 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1141 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1145 (default: None)
1142 (default: None)
1146
1143
1147 ``regkeyalt``
1144 ``regkeyalt``
1148 An alternate Windows registry key to try if the first key is not
1145 An alternate Windows registry key to try if the first key is not
1149 found. The alternate key uses the same ``regname`` and ``regappend``
1146 found. The alternate key uses the same ``regname`` and ``regappend``
1150 semantics of the primary key. The most common use for this key
1147 semantics of the primary key. The most common use for this key
1151 is to search for 32bit applications on 64bit operating systems.
1148 is to search for 32bit applications on 64bit operating systems.
1152 (default: None)
1149 (default: None)
1153
1150
1154 ``regname``
1151 ``regname``
1155 Name of value to read from specified registry key.
1152 Name of value to read from specified registry key.
1156 (default: the unnamed (default) value)
1153 (default: the unnamed (default) value)
1157
1154
1158 ``regappend``
1155 ``regappend``
1159 String to append to the value read from the registry, typically
1156 String to append to the value read from the registry, typically
1160 the executable name of the tool.
1157 the executable name of the tool.
1161 (default: None)
1158 (default: None)
1162
1159
1163
1160
1164 ``patch``
1161 ``patch``
1165 ---------
1162 ---------
1166
1163
1167 Settings used when applying patches, for instance through the 'import'
1164 Settings used when applying patches, for instance through the 'import'
1168 command or with Mercurial Queues extension.
1165 command or with Mercurial Queues extension.
1169
1166
1170 ``eol``
1167 ``eol``
1171 When set to 'strict' patch content and patched files end of lines
1168 When set to 'strict' patch content and patched files end of lines
1172 are preserved. When set to ``lf`` or ``crlf``, both files end of
1169 are preserved. When set to ``lf`` or ``crlf``, both files end of
1173 lines are ignored when patching and the result line endings are
1170 lines are ignored when patching and the result line endings are
1174 normalized to either LF (Unix) or CRLF (Windows). When set to
1171 normalized to either LF (Unix) or CRLF (Windows). When set to
1175 ``auto``, end of lines are again ignored while patching but line
1172 ``auto``, end of lines are again ignored while patching but line
1176 endings in patched files are normalized to their original setting
1173 endings in patched files are normalized to their original setting
1177 on a per-file basis. If target file does not exist or has no end
1174 on a per-file basis. If target file does not exist or has no end
1178 of line, patch line endings are preserved.
1175 of line, patch line endings are preserved.
1179 (default: strict)
1176 (default: strict)
1180
1177
1181 ``fuzz``
1178 ``fuzz``
1182 The number of lines of 'fuzz' to allow when applying patches. This
1179 The number of lines of 'fuzz' to allow when applying patches. This
1183 controls how much context the patcher is allowed to ignore when
1180 controls how much context the patcher is allowed to ignore when
1184 trying to apply a patch.
1181 trying to apply a patch.
1185 (default: 2)
1182 (default: 2)
1186
1183
1187 ``paths``
1184 ``paths``
1188 ---------
1185 ---------
1189
1186
1190 Assigns symbolic names and behavior to repositories.
1187 Assigns symbolic names and behavior to repositories.
1191
1188
1192 Options are symbolic names defining the URL or directory that is the
1189 Options are symbolic names defining the URL or directory that is the
1193 location of the repository. Example::
1190 location of the repository. Example::
1194
1191
1195 [paths]
1192 [paths]
1196 my_server = https://example.com/my_repo
1193 my_server = https://example.com/my_repo
1197 local_path = /home/me/repo
1194 local_path = /home/me/repo
1198
1195
1199 These symbolic names can be used from the command line. To pull
1196 These symbolic names can be used from the command line. To pull
1200 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1197 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1201 :hg:`push local_path`.
1198 :hg:`push local_path`.
1202
1199
1203 Options containing colons (``:``) denote sub-options that can influence
1200 Options containing colons (``:``) denote sub-options that can influence
1204 behavior for that specific path. Example::
1201 behavior for that specific path. Example::
1205
1202
1206 [paths]
1203 [paths]
1207 my_server = https://example.com/my_path
1204 my_server = https://example.com/my_path
1208 my_server:pushurl = ssh://example.com/my_path
1205 my_server:pushurl = ssh://example.com/my_path
1209
1206
1210 The following sub-options can be defined:
1207 The following sub-options can be defined:
1211
1208
1212 ``pushurl``
1209 ``pushurl``
1213 The URL to use for push operations. If not defined, the location
1210 The URL to use for push operations. If not defined, the location
1214 defined by the path's main entry is used.
1211 defined by the path's main entry is used.
1215
1212
1216 The following special named paths exist:
1213 The following special named paths exist:
1217
1214
1218 ``default``
1215 ``default``
1219 The URL or directory to use when no source or remote is specified.
1216 The URL or directory to use when no source or remote is specified.
1220
1217
1221 :hg:`clone` will automatically define this path to the location the
1218 :hg:`clone` will automatically define this path to the location the
1222 repository was cloned from.
1219 repository was cloned from.
1223
1220
1224 ``default-push``
1221 ``default-push``
1225 (deprecated) The URL or directory for the default :hg:`push` location.
1222 (deprecated) The URL or directory for the default :hg:`push` location.
1226 ``default:pushurl`` should be used instead.
1223 ``default:pushurl`` should be used instead.
1227
1224
1228 ``phases``
1225 ``phases``
1229 ----------
1226 ----------
1230
1227
1231 Specifies default handling of phases. See :hg:`help phases` for more
1228 Specifies default handling of phases. See :hg:`help phases` for more
1232 information about working with phases.
1229 information about working with phases.
1233
1230
1234 ``publish``
1231 ``publish``
1235 Controls draft phase behavior when working as a server. When true,
1232 Controls draft phase behavior when working as a server. When true,
1236 pushed changesets are set to public in both client and server and
1233 pushed changesets are set to public in both client and server and
1237 pulled or cloned changesets are set to public in the client.
1234 pulled or cloned changesets are set to public in the client.
1238 (default: True)
1235 (default: True)
1239
1236
1240 ``new-commit``
1237 ``new-commit``
1241 Phase of newly-created commits.
1238 Phase of newly-created commits.
1242 (default: draft)
1239 (default: draft)
1243
1240
1244 ``checksubrepos``
1241 ``checksubrepos``
1245 Check the phase of the current revision of each subrepository. Allowed
1242 Check the phase of the current revision of each subrepository. Allowed
1246 values are "ignore", "follow" and "abort". For settings other than
1243 values are "ignore", "follow" and "abort". For settings other than
1247 "ignore", the phase of the current revision of each subrepository is
1244 "ignore", the phase of the current revision of each subrepository is
1248 checked before committing the parent repository. If any of those phases is
1245 checked before committing the parent repository. If any of those phases is
1249 greater than the phase of the parent repository (e.g. if a subrepo is in a
1246 greater than the phase of the parent repository (e.g. if a subrepo is in a
1250 "secret" phase while the parent repo is in "draft" phase), the commit is
1247 "secret" phase while the parent repo is in "draft" phase), the commit is
1251 either aborted (if checksubrepos is set to "abort") or the higher phase is
1248 either aborted (if checksubrepos is set to "abort") or the higher phase is
1252 used for the parent repository commit (if set to "follow").
1249 used for the parent repository commit (if set to "follow").
1253 (default: follow)
1250 (default: follow)
1254
1251
1255
1252
1256 ``profiling``
1253 ``profiling``
1257 -------------
1254 -------------
1258
1255
1259 Specifies profiling type, format, and file output. Two profilers are
1256 Specifies profiling type, format, and file output. Two profilers are
1260 supported: an instrumenting profiler (named ``ls``), and a sampling
1257 supported: an instrumenting profiler (named ``ls``), and a sampling
1261 profiler (named ``stat``).
1258 profiler (named ``stat``).
1262
1259
1263 In this section description, 'profiling data' stands for the raw data
1260 In this section description, 'profiling data' stands for the raw data
1264 collected during profiling, while 'profiling report' stands for a
1261 collected during profiling, while 'profiling report' stands for a
1265 statistical text report generated from the profiling data. The
1262 statistical text report generated from the profiling data. The
1266 profiling is done using lsprof.
1263 profiling is done using lsprof.
1267
1264
1268 ``type``
1265 ``type``
1269 The type of profiler to use.
1266 The type of profiler to use.
1270 (default: ls)
1267 (default: ls)
1271
1268
1272 ``ls``
1269 ``ls``
1273 Use Python's built-in instrumenting profiler. This profiler
1270 Use Python's built-in instrumenting profiler. This profiler
1274 works on all platforms, but each line number it reports is the
1271 works on all platforms, but each line number it reports is the
1275 first line of a function. This restriction makes it difficult to
1272 first line of a function. This restriction makes it difficult to
1276 identify the expensive parts of a non-trivial function.
1273 identify the expensive parts of a non-trivial function.
1277 ``stat``
1274 ``stat``
1278 Use a third-party statistical profiler, statprof. This profiler
1275 Use a third-party statistical profiler, statprof. This profiler
1279 currently runs only on Unix systems, and is most useful for
1276 currently runs only on Unix systems, and is most useful for
1280 profiling commands that run for longer than about 0.1 seconds.
1277 profiling commands that run for longer than about 0.1 seconds.
1281
1278
1282 ``format``
1279 ``format``
1283 Profiling format. Specific to the ``ls`` instrumenting profiler.
1280 Profiling format. Specific to the ``ls`` instrumenting profiler.
1284 (default: text)
1281 (default: text)
1285
1282
1286 ``text``
1283 ``text``
1287 Generate a profiling report. When saving to a file, it should be
1284 Generate a profiling report. When saving to a file, it should be
1288 noted that only the report is saved, and the profiling data is
1285 noted that only the report is saved, and the profiling data is
1289 not kept.
1286 not kept.
1290 ``kcachegrind``
1287 ``kcachegrind``
1291 Format profiling data for kcachegrind use: when saving to a
1288 Format profiling data for kcachegrind use: when saving to a
1292 file, the generated file can directly be loaded into
1289 file, the generated file can directly be loaded into
1293 kcachegrind.
1290 kcachegrind.
1294
1291
1295 ``frequency``
1292 ``frequency``
1296 Sampling frequency. Specific to the ``stat`` sampling profiler.
1293 Sampling frequency. Specific to the ``stat`` sampling profiler.
1297 (default: 1000)
1294 (default: 1000)
1298
1295
1299 ``output``
1296 ``output``
1300 File path where profiling data or report should be saved. If the
1297 File path where profiling data or report should be saved. If the
1301 file exists, it is replaced. (default: None, data is printed on
1298 file exists, it is replaced. (default: None, data is printed on
1302 stderr)
1299 stderr)
1303
1300
1304 ``sort``
1301 ``sort``
1305 Sort field. Specific to the ``ls`` instrumenting profiler.
1302 Sort field. Specific to the ``ls`` instrumenting profiler.
1306 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1303 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1307 ``inlinetime``.
1304 ``inlinetime``.
1308 (default: inlinetime)
1305 (default: inlinetime)
1309
1306
1310 ``limit``
1307 ``limit``
1311 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1308 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1312 (default: 30)
1309 (default: 30)
1313
1310
1314 ``nested``
1311 ``nested``
1315 Show at most this number of lines of drill-down info after each main entry.
1312 Show at most this number of lines of drill-down info after each main entry.
1316 This can help explain the difference between Total and Inline.
1313 This can help explain the difference between Total and Inline.
1317 Specific to the ``ls`` instrumenting profiler.
1314 Specific to the ``ls`` instrumenting profiler.
1318 (default: 5)
1315 (default: 5)
1319
1316
1320 ``progress``
1317 ``progress``
1321 ------------
1318 ------------
1322
1319
1323 Mercurial commands can draw progress bars that are as informative as
1320 Mercurial commands can draw progress bars that are as informative as
1324 possible. Some progress bars only offer indeterminate information, while others
1321 possible. Some progress bars only offer indeterminate information, while others
1325 have a definite end point.
1322 have a definite end point.
1326
1323
1327 ``delay``
1324 ``delay``
1328 Number of seconds (float) before showing the progress bar. (default: 3)
1325 Number of seconds (float) before showing the progress bar. (default: 3)
1329
1326
1330 ``changedelay``
1327 ``changedelay``
1331 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1328 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1332 that value will be used instead. (default: 1)
1329 that value will be used instead. (default: 1)
1333
1330
1334 ``refresh``
1331 ``refresh``
1335 Time in seconds between refreshes of the progress bar. (default: 0.1)
1332 Time in seconds between refreshes of the progress bar. (default: 0.1)
1336
1333
1337 ``format``
1334 ``format``
1338 Format of the progress bar.
1335 Format of the progress bar.
1339
1336
1340 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1337 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1341 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1338 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1342 last 20 characters of the item, but this can be changed by adding either
1339 last 20 characters of the item, but this can be changed by adding either
1343 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1340 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1344 first num characters.
1341 first num characters.
1345
1342
1346 (default: topic bar number estimate)
1343 (default: topic bar number estimate)
1347
1344
1348 ``width``
1345 ``width``
1349 If set, the maximum width of the progress information (that is, min(width,
1346 If set, the maximum width of the progress information (that is, min(width,
1350 term width) will be used).
1347 term width) will be used).
1351
1348
1352 ``clear-complete``
1349 ``clear-complete``
1353 Clear the progress bar after it's done. (default: True)
1350 Clear the progress bar after it's done. (default: True)
1354
1351
1355 ``disable``
1352 ``disable``
1356 If true, don't show a progress bar.
1353 If true, don't show a progress bar.
1357
1354
1358 ``assume-tty``
1355 ``assume-tty``
1359 If true, ALWAYS show a progress bar, unless disable is given.
1356 If true, ALWAYS show a progress bar, unless disable is given.
1360
1357
1361 ``rebase``
1358 ``rebase``
1362 ----------
1359 ----------
1363
1360
1364 ``allowdivergence``
1361 ``allowdivergence``
1365 Default to False, when True allow creating divergence when performing
1362 Default to False, when True allow creating divergence when performing
1366 rebase of obsolete changesets.
1363 rebase of obsolete changesets.
1367
1364
1368 ``revsetalias``
1365 ``revsetalias``
1369 ---------------
1366 ---------------
1370
1367
1371 Alias definitions for revsets. See :hg:`help revsets` for details.
1368 Alias definitions for revsets. See :hg:`help revsets` for details.
1372
1369
1373 ``server``
1370 ``server``
1374 ----------
1371 ----------
1375
1372
1376 Controls generic server settings.
1373 Controls generic server settings.
1377
1374
1378 ``uncompressed``
1375 ``uncompressed``
1379 Whether to allow clients to clone a repository using the
1376 Whether to allow clients to clone a repository using the
1380 uncompressed streaming protocol. This transfers about 40% more
1377 uncompressed streaming protocol. This transfers about 40% more
1381 data than a regular clone, but uses less memory and CPU on both
1378 data than a regular clone, but uses less memory and CPU on both
1382 server and client. Over a LAN (100 Mbps or better) or a very fast
1379 server and client. Over a LAN (100 Mbps or better) or a very fast
1383 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1380 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1384 regular clone. Over most WAN connections (anything slower than
1381 regular clone. Over most WAN connections (anything slower than
1385 about 6 Mbps), uncompressed streaming is slower, because of the
1382 about 6 Mbps), uncompressed streaming is slower, because of the
1386 extra data transfer overhead. This mode will also temporarily hold
1383 extra data transfer overhead. This mode will also temporarily hold
1387 the write lock while determining what data to transfer.
1384 the write lock while determining what data to transfer.
1388 (default: True)
1385 (default: True)
1389
1386
1390 ``preferuncompressed``
1387 ``preferuncompressed``
1391 When set, clients will try to use the uncompressed streaming
1388 When set, clients will try to use the uncompressed streaming
1392 protocol. (default: False)
1389 protocol. (default: False)
1393
1390
1394 ``validate``
1391 ``validate``
1395 Whether to validate the completeness of pushed changesets by
1392 Whether to validate the completeness of pushed changesets by
1396 checking that all new file revisions specified in manifests are
1393 checking that all new file revisions specified in manifests are
1397 present. (default: False)
1394 present. (default: False)
1398
1395
1399 ``maxhttpheaderlen``
1396 ``maxhttpheaderlen``
1400 Instruct HTTP clients not to send request headers longer than this
1397 Instruct HTTP clients not to send request headers longer than this
1401 many bytes. (default: 1024)
1398 many bytes. (default: 1024)
1402
1399
1403 ``bundle1``
1400 ``bundle1``
1404 Whether to allow clients to push and pull using the legacy bundle1
1401 Whether to allow clients to push and pull using the legacy bundle1
1405 exchange format. (default: True)
1402 exchange format. (default: True)
1406
1403
1407 ``bundle1gd``
1404 ``bundle1gd``
1408 Like ``bundle1`` but only used if the repository is using the
1405 Like ``bundle1`` but only used if the repository is using the
1409 *generaldelta* storage format. (default: True)
1406 *generaldelta* storage format. (default: True)
1410
1407
1411 ``bundle1.push``
1408 ``bundle1.push``
1412 Whether to allow clients to push using the legacy bundle1 exchange
1409 Whether to allow clients to push using the legacy bundle1 exchange
1413 format. (default: True)
1410 format. (default: True)
1414
1411
1415 ``bundle1gd.push``
1412 ``bundle1gd.push``
1416 Like ``bundle1.push`` but only used if the repository is using the
1413 Like ``bundle1.push`` but only used if the repository is using the
1417 *generaldelta* storage format. (default: True)
1414 *generaldelta* storage format. (default: True)
1418
1415
1419 ``bundle1.pull``
1416 ``bundle1.pull``
1420 Whether to allow clients to pull using the legacy bundle1 exchange
1417 Whether to allow clients to pull using the legacy bundle1 exchange
1421 format. (default: True)
1418 format. (default: True)
1422
1419
1423 ``bundle1gd.pull``
1420 ``bundle1gd.pull``
1424 Like ``bundle1.pull`` but only used if the repository is using the
1421 Like ``bundle1.pull`` but only used if the repository is using the
1425 *generaldelta* storage format. (default: True)
1422 *generaldelta* storage format. (default: True)
1426
1423
1427 Large repositories using the *generaldelta* storage format should
1424 Large repositories using the *generaldelta* storage format should
1428 consider setting this option because converting *generaldelta*
1425 consider setting this option because converting *generaldelta*
1429 repositories to the exchange format required by the bundle1 data
1426 repositories to the exchange format required by the bundle1 data
1430 format can consume a lot of CPU.
1427 format can consume a lot of CPU.
1431
1428
1432 ``smtp``
1429 ``smtp``
1433 --------
1430 --------
1434
1431
1435 Configuration for extensions that need to send email messages.
1432 Configuration for extensions that need to send email messages.
1436
1433
1437 ``host``
1434 ``host``
1438 Host name of mail server, e.g. "mail.example.com".
1435 Host name of mail server, e.g. "mail.example.com".
1439
1436
1440 ``port``
1437 ``port``
1441 Optional. Port to connect to on mail server. (default: 465 if
1438 Optional. Port to connect to on mail server. (default: 465 if
1442 ``tls`` is smtps; 25 otherwise)
1439 ``tls`` is smtps; 25 otherwise)
1443
1440
1444 ``tls``
1441 ``tls``
1445 Optional. Method to enable TLS when connecting to mail server: starttls,
1442 Optional. Method to enable TLS when connecting to mail server: starttls,
1446 smtps or none. (default: none)
1443 smtps or none. (default: none)
1447
1444
1448 ``verifycert``
1445 ``verifycert``
1449 Optional. Verification for the certificate of mail server, when
1446 Optional. Verification for the certificate of mail server, when
1450 ``tls`` is starttls or smtps. "strict", "loose" or False. For
1447 ``tls`` is starttls or smtps. "strict", "loose" or False. For
1451 "strict" or "loose", the certificate is verified as same as the
1448 "strict" or "loose", the certificate is verified as same as the
1452 verification for HTTPS connections (see ``[hostfingerprints]`` and
1449 verification for HTTPS connections (see ``[hostfingerprints]`` and
1453 ``[web] cacerts`` also). For "strict", sending email is also
1450 ``[web] cacerts`` also). For "strict", sending email is also
1454 aborted, if there is no configuration for mail server in
1451 aborted, if there is no configuration for mail server in
1455 ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for
1452 ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for
1456 :hg:`email` overwrites this as "loose". (default: strict)
1453 :hg:`email` overwrites this as "loose". (default: strict)
1457
1454
1458 ``username``
1455 ``username``
1459 Optional. User name for authenticating with the SMTP server.
1456 Optional. User name for authenticating with the SMTP server.
1460 (default: None)
1457 (default: None)
1461
1458
1462 ``password``
1459 ``password``
1463 Optional. Password for authenticating with the SMTP server. If not
1460 Optional. Password for authenticating with the SMTP server. If not
1464 specified, interactive sessions will prompt the user for a
1461 specified, interactive sessions will prompt the user for a
1465 password; non-interactive sessions will fail. (default: None)
1462 password; non-interactive sessions will fail. (default: None)
1466
1463
1467 ``local_hostname``
1464 ``local_hostname``
1468 Optional. The hostname that the sender can use to identify
1465 Optional. The hostname that the sender can use to identify
1469 itself to the MTA.
1466 itself to the MTA.
1470
1467
1471
1468
1472 ``subpaths``
1469 ``subpaths``
1473 ------------
1470 ------------
1474
1471
1475 Subrepository source URLs can go stale if a remote server changes name
1472 Subrepository source URLs can go stale if a remote server changes name
1476 or becomes temporarily unavailable. This section lets you define
1473 or becomes temporarily unavailable. This section lets you define
1477 rewrite rules of the form::
1474 rewrite rules of the form::
1478
1475
1479 <pattern> = <replacement>
1476 <pattern> = <replacement>
1480
1477
1481 where ``pattern`` is a regular expression matching a subrepository
1478 where ``pattern`` is a regular expression matching a subrepository
1482 source URL and ``replacement`` is the replacement string used to
1479 source URL and ``replacement`` is the replacement string used to
1483 rewrite it. Groups can be matched in ``pattern`` and referenced in
1480 rewrite it. Groups can be matched in ``pattern`` and referenced in
1484 ``replacements``. For instance::
1481 ``replacements``. For instance::
1485
1482
1486 http://server/(.*)-hg/ = http://hg.server/\1/
1483 http://server/(.*)-hg/ = http://hg.server/\1/
1487
1484
1488 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1485 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1489
1486
1490 Relative subrepository paths are first made absolute, and the
1487 Relative subrepository paths are first made absolute, and the
1491 rewrite rules are then applied on the full (absolute) path. The rules
1488 rewrite rules are then applied on the full (absolute) path. The rules
1492 are applied in definition order.
1489 are applied in definition order.
1493
1490
1494 ``trusted``
1491 ``trusted``
1495 -----------
1492 -----------
1496
1493
1497 Mercurial will not use the settings in the
1494 Mercurial will not use the settings in the
1498 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1495 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1499 user or to a trusted group, as various hgrc features allow arbitrary
1496 user or to a trusted group, as various hgrc features allow arbitrary
1500 commands to be run. This issue is often encountered when configuring
1497 commands to be run. This issue is often encountered when configuring
1501 hooks or extensions for shared repositories or servers. However,
1498 hooks or extensions for shared repositories or servers. However,
1502 the web interface will use some safe settings from the ``[web]``
1499 the web interface will use some safe settings from the ``[web]``
1503 section.
1500 section.
1504
1501
1505 This section specifies what users and groups are trusted. The
1502 This section specifies what users and groups are trusted. The
1506 current user is always trusted. To trust everybody, list a user or a
1503 current user is always trusted. To trust everybody, list a user or a
1507 group with name ``*``. These settings must be placed in an
1504 group with name ``*``. These settings must be placed in an
1508 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1505 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1509 user or service running Mercurial.
1506 user or service running Mercurial.
1510
1507
1511 ``users``
1508 ``users``
1512 Comma-separated list of trusted users.
1509 Comma-separated list of trusted users.
1513
1510
1514 ``groups``
1511 ``groups``
1515 Comma-separated list of trusted groups.
1512 Comma-separated list of trusted groups.
1516
1513
1517
1514
1518 ``ui``
1515 ``ui``
1519 ------
1516 ------
1520
1517
1521 User interface controls.
1518 User interface controls.
1522
1519
1523 ``archivemeta``
1520 ``archivemeta``
1524 Whether to include the .hg_archival.txt file containing meta data
1521 Whether to include the .hg_archival.txt file containing meta data
1525 (hashes for the repository base and for tip) in archives created
1522 (hashes for the repository base and for tip) in archives created
1526 by the :hg:`archive` command or downloaded via hgweb.
1523 by the :hg:`archive` command or downloaded via hgweb.
1527 (default: True)
1524 (default: True)
1528
1525
1529 ``askusername``
1526 ``askusername``
1530 Whether to prompt for a username when committing. If True, and
1527 Whether to prompt for a username when committing. If True, and
1531 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1528 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1532 be prompted to enter a username. If no username is entered, the
1529 be prompted to enter a username. If no username is entered, the
1533 default ``USER@HOST`` is used instead.
1530 default ``USER@HOST`` is used instead.
1534 (default: False)
1531 (default: False)
1535
1532
1536 ``clonebundles``
1533 ``clonebundles``
1537 Whether the "clone bundles" feature is enabled.
1534 Whether the "clone bundles" feature is enabled.
1538
1535
1539 When enabled, :hg:`clone` may download and apply a server-advertised
1536 When enabled, :hg:`clone` may download and apply a server-advertised
1540 bundle file from a URL instead of using the normal exchange mechanism.
1537 bundle file from a URL instead of using the normal exchange mechanism.
1541
1538
1542 This can likely result in faster and more reliable clones.
1539 This can likely result in faster and more reliable clones.
1543
1540
1544 (default: True)
1541 (default: True)
1545
1542
1546 ``clonebundlefallback``
1543 ``clonebundlefallback``
1547 Whether failure to apply an advertised "clone bundle" from a server
1544 Whether failure to apply an advertised "clone bundle" from a server
1548 should result in fallback to a regular clone.
1545 should result in fallback to a regular clone.
1549
1546
1550 This is disabled by default because servers advertising "clone
1547 This is disabled by default because servers advertising "clone
1551 bundles" often do so to reduce server load. If advertised bundles
1548 bundles" often do so to reduce server load. If advertised bundles
1552 start mass failing and clients automatically fall back to a regular
1549 start mass failing and clients automatically fall back to a regular
1553 clone, this would add significant and unexpected load to the server
1550 clone, this would add significant and unexpected load to the server
1554 since the server is expecting clone operations to be offloaded to
1551 since the server is expecting clone operations to be offloaded to
1555 pre-generated bundles. Failing fast (the default behavior) ensures
1552 pre-generated bundles. Failing fast (the default behavior) ensures
1556 clients don't overwhelm the server when "clone bundle" application
1553 clients don't overwhelm the server when "clone bundle" application
1557 fails.
1554 fails.
1558
1555
1559 (default: False)
1556 (default: False)
1560
1557
1561 ``clonebundleprefers``
1558 ``clonebundleprefers``
1562 Defines preferences for which "clone bundles" to use.
1559 Defines preferences for which "clone bundles" to use.
1563
1560
1564 Servers advertising "clone bundles" may advertise multiple available
1561 Servers advertising "clone bundles" may advertise multiple available
1565 bundles. Each bundle may have different attributes, such as the bundle
1562 bundles. Each bundle may have different attributes, such as the bundle
1566 type and compression format. This option is used to prefer a particular
1563 type and compression format. This option is used to prefer a particular
1567 bundle over another.
1564 bundle over another.
1568
1565
1569 The following keys are defined by Mercurial:
1566 The following keys are defined by Mercurial:
1570
1567
1571 BUNDLESPEC
1568 BUNDLESPEC
1572 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1569 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1573 e.g. ``gzip-v2`` or ``bzip2-v1``.
1570 e.g. ``gzip-v2`` or ``bzip2-v1``.
1574
1571
1575 COMPRESSION
1572 COMPRESSION
1576 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1573 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1577
1574
1578 Server operators may define custom keys.
1575 Server operators may define custom keys.
1579
1576
1580 Example values: ``COMPRESSION=bzip2``,
1577 Example values: ``COMPRESSION=bzip2``,
1581 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1578 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1582
1579
1583 By default, the first bundle advertised by the server is used.
1580 By default, the first bundle advertised by the server is used.
1584
1581
1585 ``commitsubrepos``
1582 ``commitsubrepos``
1586 Whether to commit modified subrepositories when committing the
1583 Whether to commit modified subrepositories when committing the
1587 parent repository. If False and one subrepository has uncommitted
1584 parent repository. If False and one subrepository has uncommitted
1588 changes, abort the commit.
1585 changes, abort the commit.
1589 (default: False)
1586 (default: False)
1590
1587
1591 ``debug``
1588 ``debug``
1592 Print debugging information. (default: False)
1589 Print debugging information. (default: False)
1593
1590
1594 ``editor``
1591 ``editor``
1595 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1592 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1596
1593
1597 ``fallbackencoding``
1594 ``fallbackencoding``
1598 Encoding to try if it's not possible to decode the changelog using
1595 Encoding to try if it's not possible to decode the changelog using
1599 UTF-8. (default: ISO-8859-1)
1596 UTF-8. (default: ISO-8859-1)
1600
1597
1601 ``graphnodetemplate``
1598 ``graphnodetemplate``
1602 The template used to print changeset nodes in an ASCII revision graph.
1599 The template used to print changeset nodes in an ASCII revision graph.
1603 (default: ``{graphnode}``)
1600 (default: ``{graphnode}``)
1604
1601
1605 ``ignore``
1602 ``ignore``
1606 A file to read per-user ignore patterns from. This file should be
1603 A file to read per-user ignore patterns from. This file should be
1607 in the same format as a repository-wide .hgignore file. Filenames
1604 in the same format as a repository-wide .hgignore file. Filenames
1608 are relative to the repository root. This option supports hook syntax,
1605 are relative to the repository root. This option supports hook syntax,
1609 so if you want to specify multiple ignore files, you can do so by
1606 so if you want to specify multiple ignore files, you can do so by
1610 setting something like ``ignore.other = ~/.hgignore2``. For details
1607 setting something like ``ignore.other = ~/.hgignore2``. For details
1611 of the ignore file format, see the ``hgignore(5)`` man page.
1608 of the ignore file format, see the ``hgignore(5)`` man page.
1612
1609
1613 ``interactive``
1610 ``interactive``
1614 Allow to prompt the user. (default: True)
1611 Allow to prompt the user. (default: True)
1615
1612
1616 ``interface``
1613 ``interface``
1617 Select the default interface for interactive features (default: text).
1614 Select the default interface for interactive features (default: text).
1618 Possible values are 'text' and 'curses'.
1615 Possible values are 'text' and 'curses'.
1619
1616
1620 ``interface.chunkselector``
1617 ``interface.chunkselector``
1621 Select the interface for change recording (e.g. :hg:`commit` -i).
1618 Select the interface for change recording (e.g. :hg:`commit` -i).
1622 Possible values are 'text' and 'curses'.
1619 Possible values are 'text' and 'curses'.
1623 This config overrides the interface specified by ui.interface.
1620 This config overrides the interface specified by ui.interface.
1624
1621
1625 ``logtemplate``
1622 ``logtemplate``
1626 Template string for commands that print changesets.
1623 Template string for commands that print changesets.
1627
1624
1628 ``merge``
1625 ``merge``
1629 The conflict resolution program to use during a manual merge.
1626 The conflict resolution program to use during a manual merge.
1630 For more information on merge tools see :hg:`help merge-tools`.
1627 For more information on merge tools see :hg:`help merge-tools`.
1631 For configuring merge tools see the ``[merge-tools]`` section.
1628 For configuring merge tools see the ``[merge-tools]`` section.
1632
1629
1633 ``mergemarkers``
1630 ``mergemarkers``
1634 Sets the merge conflict marker label styling. The ``detailed``
1631 Sets the merge conflict marker label styling. The ``detailed``
1635 style uses the ``mergemarkertemplate`` setting to style the labels.
1632 style uses the ``mergemarkertemplate`` setting to style the labels.
1636 The ``basic`` style just uses 'local' and 'other' as the marker label.
1633 The ``basic`` style just uses 'local' and 'other' as the marker label.
1637 One of ``basic`` or ``detailed``.
1634 One of ``basic`` or ``detailed``.
1638 (default: ``basic``)
1635 (default: ``basic``)
1639
1636
1640 ``mergemarkertemplate``
1637 ``mergemarkertemplate``
1641 The template used to print the commit description next to each conflict
1638 The template used to print the commit description next to each conflict
1642 marker during merge conflicts. See :hg:`help templates` for the template
1639 marker during merge conflicts. See :hg:`help templates` for the template
1643 format.
1640 format.
1644
1641
1645 Defaults to showing the hash, tags, branches, bookmarks, author, and
1642 Defaults to showing the hash, tags, branches, bookmarks, author, and
1646 the first line of the commit description.
1643 the first line of the commit description.
1647
1644
1648 If you use non-ASCII characters in names for tags, branches, bookmarks,
1645 If you use non-ASCII characters in names for tags, branches, bookmarks,
1649 authors, and/or commit descriptions, you must pay attention to encodings of
1646 authors, and/or commit descriptions, you must pay attention to encodings of
1650 managed files. At template expansion, non-ASCII characters use the encoding
1647 managed files. At template expansion, non-ASCII characters use the encoding
1651 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1648 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1652 environment variables that govern your locale. If the encoding of the merge
1649 environment variables that govern your locale. If the encoding of the merge
1653 markers is different from the encoding of the merged files,
1650 markers is different from the encoding of the merged files,
1654 serious problems may occur.
1651 serious problems may occur.
1655
1652
1656 ``origbackuppath``
1653 ``origbackuppath``
1657 The path to a directory used to store generated .orig files. If the path is
1654 The path to a directory used to store generated .orig files. If the path is
1658 not a directory, one will be created.
1655 not a directory, one will be created.
1659
1656
1660 ``patch``
1657 ``patch``
1661 An optional external tool that ``hg import`` and some extensions
1658 An optional external tool that ``hg import`` and some extensions
1662 will use for applying patches. By default Mercurial uses an
1659 will use for applying patches. By default Mercurial uses an
1663 internal patch utility. The external tool must work as the common
1660 internal patch utility. The external tool must work as the common
1664 Unix ``patch`` program. In particular, it must accept a ``-p``
1661 Unix ``patch`` program. In particular, it must accept a ``-p``
1665 argument to strip patch headers, a ``-d`` argument to specify the
1662 argument to strip patch headers, a ``-d`` argument to specify the
1666 current directory, a file name to patch, and a patch file to take
1663 current directory, a file name to patch, and a patch file to take
1667 from stdin.
1664 from stdin.
1668
1665
1669 It is possible to specify a patch tool together with extra
1666 It is possible to specify a patch tool together with extra
1670 arguments. For example, setting this option to ``patch --merge``
1667 arguments. For example, setting this option to ``patch --merge``
1671 will use the ``patch`` program with its 2-way merge option.
1668 will use the ``patch`` program with its 2-way merge option.
1672
1669
1673 ``portablefilenames``
1670 ``portablefilenames``
1674 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1671 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1675 (default: ``warn``)
1672 (default: ``warn``)
1676
1673
1677 ``warn``
1674 ``warn``
1678 Print a warning message on POSIX platforms, if a file with a non-portable
1675 Print a warning message on POSIX platforms, if a file with a non-portable
1679 filename is added (e.g. a file with a name that can't be created on
1676 filename is added (e.g. a file with a name that can't be created on
1680 Windows because it contains reserved parts like ``AUX``, reserved
1677 Windows because it contains reserved parts like ``AUX``, reserved
1681 characters like ``:``, or would cause a case collision with an existing
1678 characters like ``:``, or would cause a case collision with an existing
1682 file).
1679 file).
1683
1680
1684 ``ignore``
1681 ``ignore``
1685 Don't print a warning.
1682 Don't print a warning.
1686
1683
1687 ``abort``
1684 ``abort``
1688 The command is aborted.
1685 The command is aborted.
1689
1686
1690 ``true``
1687 ``true``
1691 Alias for ``warn``.
1688 Alias for ``warn``.
1692
1689
1693 ``false``
1690 ``false``
1694 Alias for ``ignore``.
1691 Alias for ``ignore``.
1695
1692
1696 .. container:: windows
1693 .. container:: windows
1697
1694
1698 On Windows, this configuration option is ignored and the command aborted.
1695 On Windows, this configuration option is ignored and the command aborted.
1699
1696
1700 ``quiet``
1697 ``quiet``
1701 Reduce the amount of output printed.
1698 Reduce the amount of output printed.
1702 (default: False)
1699 (default: False)
1703
1700
1704 ``remotecmd``
1701 ``remotecmd``
1705 Remote command to use for clone/push/pull operations.
1702 Remote command to use for clone/push/pull operations.
1706 (default: ``hg``)
1703 (default: ``hg``)
1707
1704
1708 ``report_untrusted``
1705 ``report_untrusted``
1709 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1706 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1710 trusted user or group.
1707 trusted user or group.
1711 (default: True)
1708 (default: True)
1712
1709
1713 ``slash``
1710 ``slash``
1714 Display paths using a slash (``/``) as the path separator. This
1711 Display paths using a slash (``/``) as the path separator. This
1715 only makes a difference on systems where the default path
1712 only makes a difference on systems where the default path
1716 separator is not the slash character (e.g. Windows uses the
1713 separator is not the slash character (e.g. Windows uses the
1717 backslash character (``\``)).
1714 backslash character (``\``)).
1718 (default: False)
1715 (default: False)
1719
1716
1720 ``statuscopies``
1717 ``statuscopies``
1721 Display copies in the status command.
1718 Display copies in the status command.
1722
1719
1723 ``ssh``
1720 ``ssh``
1724 Command to use for SSH connections. (default: ``ssh``)
1721 Command to use for SSH connections. (default: ``ssh``)
1725
1722
1726 ``strict``
1723 ``strict``
1727 Require exact command names, instead of allowing unambiguous
1724 Require exact command names, instead of allowing unambiguous
1728 abbreviations. (default: False)
1725 abbreviations. (default: False)
1729
1726
1730 ``style``
1727 ``style``
1731 Name of style to use for command output.
1728 Name of style to use for command output.
1732
1729
1733 ``supportcontact``
1730 ``supportcontact``
1734 A URL where users should report a Mercurial traceback. Use this if you are a
1731 A URL where users should report a Mercurial traceback. Use this if you are a
1735 large organisation with its own Mercurial deployment process and crash
1732 large organisation with its own Mercurial deployment process and crash
1736 reports should be addressed to your internal support.
1733 reports should be addressed to your internal support.
1737
1734
1738 ``timeout``
1735 ``timeout``
1739 The timeout used when a lock is held (in seconds), a negative value
1736 The timeout used when a lock is held (in seconds), a negative value
1740 means no timeout. (default: 600)
1737 means no timeout. (default: 600)
1741
1738
1742 ``traceback``
1739 ``traceback``
1743 Mercurial always prints a traceback when an unknown exception
1740 Mercurial always prints a traceback when an unknown exception
1744 occurs. Setting this to True will make Mercurial print a traceback
1741 occurs. Setting this to True will make Mercurial print a traceback
1745 on all exceptions, even those recognized by Mercurial (such as
1742 on all exceptions, even those recognized by Mercurial (such as
1746 IOError or MemoryError). (default: False)
1743 IOError or MemoryError). (default: False)
1747
1744
1748 ``username``
1745 ``username``
1749 The committer of a changeset created when running "commit".
1746 The committer of a changeset created when running "commit".
1750 Typically a person's name and email address, e.g. ``Fred Widget
1747 Typically a person's name and email address, e.g. ``Fred Widget
1751 <fred@example.com>``. Environment variables in the
1748 <fred@example.com>``. Environment variables in the
1752 username are expanded.
1749 username are expanded.
1753
1750
1754 (default: ``$EMAIL`` or ``username@hostname``. If the username in
1751 (default: ``$EMAIL`` or ``username@hostname``. If the username in
1755 hgrc is empty, e.g. if the system admin set ``username =`` in the
1752 hgrc is empty, e.g. if the system admin set ``username =`` in the
1756 system hgrc, it has to be specified manually or in a different
1753 system hgrc, it has to be specified manually or in a different
1757 hgrc file)
1754 hgrc file)
1758
1755
1759 ``verbose``
1756 ``verbose``
1760 Increase the amount of output printed. (default: False)
1757 Increase the amount of output printed. (default: False)
1761
1758
1762
1759
1763 ``web``
1760 ``web``
1764 -------
1761 -------
1765
1762
1766 Web interface configuration. The settings in this section apply to
1763 Web interface configuration. The settings in this section apply to
1767 both the builtin webserver (started by :hg:`serve`) and the script you
1764 both the builtin webserver (started by :hg:`serve`) and the script you
1768 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1765 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1769 and WSGI).
1766 and WSGI).
1770
1767
1771 The Mercurial webserver does no authentication (it does not prompt for
1768 The Mercurial webserver does no authentication (it does not prompt for
1772 usernames and passwords to validate *who* users are), but it does do
1769 usernames and passwords to validate *who* users are), but it does do
1773 authorization (it grants or denies access for *authenticated users*
1770 authorization (it grants or denies access for *authenticated users*
1774 based on settings in this section). You must either configure your
1771 based on settings in this section). You must either configure your
1775 webserver to do authentication for you, or disable the authorization
1772 webserver to do authentication for you, or disable the authorization
1776 checks.
1773 checks.
1777
1774
1778 For a quick setup in a trusted environment, e.g., a private LAN, where
1775 For a quick setup in a trusted environment, e.g., a private LAN, where
1779 you want it to accept pushes from anybody, you can use the following
1776 you want it to accept pushes from anybody, you can use the following
1780 command line::
1777 command line::
1781
1778
1782 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1779 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1783
1780
1784 Note that this will allow anybody to push anything to the server and
1781 Note that this will allow anybody to push anything to the server and
1785 that this should not be used for public servers.
1782 that this should not be used for public servers.
1786
1783
1787 The full set of options is:
1784 The full set of options is:
1788
1785
1789 ``accesslog``
1786 ``accesslog``
1790 Where to output the access log. (default: stdout)
1787 Where to output the access log. (default: stdout)
1791
1788
1792 ``address``
1789 ``address``
1793 Interface address to bind to. (default: all)
1790 Interface address to bind to. (default: all)
1794
1791
1795 ``allow_archive``
1792 ``allow_archive``
1796 List of archive format (bz2, gz, zip) allowed for downloading.
1793 List of archive format (bz2, gz, zip) allowed for downloading.
1797 (default: empty)
1794 (default: empty)
1798
1795
1799 ``allowbz2``
1796 ``allowbz2``
1800 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1797 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1801 revisions.
1798 revisions.
1802 (default: False)
1799 (default: False)
1803
1800
1804 ``allowgz``
1801 ``allowgz``
1805 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1802 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1806 revisions.
1803 revisions.
1807 (default: False)
1804 (default: False)
1808
1805
1809 ``allowpull``
1806 ``allowpull``
1810 Whether to allow pulling from the repository. (default: True)
1807 Whether to allow pulling from the repository. (default: True)
1811
1808
1812 ``allow_push``
1809 ``allow_push``
1813 Whether to allow pushing to the repository. If empty or not set,
1810 Whether to allow pushing to the repository. If empty or not set,
1814 pushing is not allowed. If the special value ``*``, any remote
1811 pushing is not allowed. If the special value ``*``, any remote
1815 user can push, including unauthenticated users. Otherwise, the
1812 user can push, including unauthenticated users. Otherwise, the
1816 remote user must have been authenticated, and the authenticated
1813 remote user must have been authenticated, and the authenticated
1817 user name must be present in this list. The contents of the
1814 user name must be present in this list. The contents of the
1818 allow_push list are examined after the deny_push list.
1815 allow_push list are examined after the deny_push list.
1819
1816
1820 ``allow_read``
1817 ``allow_read``
1821 If the user has not already been denied repository access due to
1818 If the user has not already been denied repository access due to
1822 the contents of deny_read, this list determines whether to grant
1819 the contents of deny_read, this list determines whether to grant
1823 repository access to the user. If this list is not empty, and the
1820 repository access to the user. If this list is not empty, and the
1824 user is unauthenticated or not present in the list, then access is
1821 user is unauthenticated or not present in the list, then access is
1825 denied for the user. If the list is empty or not set, then access
1822 denied for the user. If the list is empty or not set, then access
1826 is permitted to all users by default. Setting allow_read to the
1823 is permitted to all users by default. Setting allow_read to the
1827 special value ``*`` is equivalent to it not being set (i.e. access
1824 special value ``*`` is equivalent to it not being set (i.e. access
1828 is permitted to all users). The contents of the allow_read list are
1825 is permitted to all users). The contents of the allow_read list are
1829 examined after the deny_read list.
1826 examined after the deny_read list.
1830
1827
1831 ``allowzip``
1828 ``allowzip``
1832 (DEPRECATED) Whether to allow .zip downloading of repository
1829 (DEPRECATED) Whether to allow .zip downloading of repository
1833 revisions. This feature creates temporary files.
1830 revisions. This feature creates temporary files.
1834 (default: False)
1831 (default: False)
1835
1832
1836 ``archivesubrepos``
1833 ``archivesubrepos``
1837 Whether to recurse into subrepositories when archiving.
1834 Whether to recurse into subrepositories when archiving.
1838 (default: False)
1835 (default: False)
1839
1836
1840 ``baseurl``
1837 ``baseurl``
1841 Base URL to use when publishing URLs in other locations, so
1838 Base URL to use when publishing URLs in other locations, so
1842 third-party tools like email notification hooks can construct
1839 third-party tools like email notification hooks can construct
1843 URLs. Example: ``http://hgserver/repos/``.
1840 URLs. Example: ``http://hgserver/repos/``.
1844
1841
1845 ``cacerts``
1842 ``cacerts``
1846 Path to file containing a list of PEM encoded certificate
1843 Path to file containing a list of PEM encoded certificate
1847 authority certificates. Environment variables and ``~user``
1844 authority certificates. Environment variables and ``~user``
1848 constructs are expanded in the filename. If specified on the
1845 constructs are expanded in the filename. If specified on the
1849 client, then it will verify the identity of remote HTTPS servers
1846 client, then it will verify the identity of remote HTTPS servers
1850 with these certificates.
1847 with these certificates.
1851
1848
1852 This feature is only supported when using Python 2.6 or later. If you wish
1853 to use it with earlier versions of Python, install the backported
1854 version of the ssl library that is available from
1855 ``http://pypi.python.org``.
1856
1857 To disable SSL verification temporarily, specify ``--insecure`` from
1849 To disable SSL verification temporarily, specify ``--insecure`` from
1858 command line.
1850 command line.
1859
1851
1860 You can use OpenSSL's CA certificate file if your platform has
1852 You can use OpenSSL's CA certificate file if your platform has
1861 one. On most Linux systems this will be
1853 one. On most Linux systems this will be
1862 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
1854 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
1863 generate this file manually. The form must be as follows::
1855 generate this file manually. The form must be as follows::
1864
1856
1865 -----BEGIN CERTIFICATE-----
1857 -----BEGIN CERTIFICATE-----
1866 ... (certificate in base64 PEM encoding) ...
1858 ... (certificate in base64 PEM encoding) ...
1867 -----END CERTIFICATE-----
1859 -----END CERTIFICATE-----
1868 -----BEGIN CERTIFICATE-----
1860 -----BEGIN CERTIFICATE-----
1869 ... (certificate in base64 PEM encoding) ...
1861 ... (certificate in base64 PEM encoding) ...
1870 -----END CERTIFICATE-----
1862 -----END CERTIFICATE-----
1871
1863
1872 ``cache``
1864 ``cache``
1873 Whether to support caching in hgweb. (default: True)
1865 Whether to support caching in hgweb. (default: True)
1874
1866
1875 ``certificate``
1867 ``certificate``
1876 Certificate to use when running :hg:`serve`.
1868 Certificate to use when running :hg:`serve`.
1877
1869
1878 ``collapse``
1870 ``collapse``
1879 With ``descend`` enabled, repositories in subdirectories are shown at
1871 With ``descend`` enabled, repositories in subdirectories are shown at
1880 a single level alongside repositories in the current path. With
1872 a single level alongside repositories in the current path. With
1881 ``collapse`` also enabled, repositories residing at a deeper level than
1873 ``collapse`` also enabled, repositories residing at a deeper level than
1882 the current path are grouped behind navigable directory entries that
1874 the current path are grouped behind navigable directory entries that
1883 lead to the locations of these repositories. In effect, this setting
1875 lead to the locations of these repositories. In effect, this setting
1884 collapses each collection of repositories found within a subdirectory
1876 collapses each collection of repositories found within a subdirectory
1885 into a single entry for that subdirectory. (default: False)
1877 into a single entry for that subdirectory. (default: False)
1886
1878
1887 ``comparisoncontext``
1879 ``comparisoncontext``
1888 Number of lines of context to show in side-by-side file comparison. If
1880 Number of lines of context to show in side-by-side file comparison. If
1889 negative or the value ``full``, whole files are shown. (default: 5)
1881 negative or the value ``full``, whole files are shown. (default: 5)
1890
1882
1891 This setting can be overridden by a ``context`` request parameter to the
1883 This setting can be overridden by a ``context`` request parameter to the
1892 ``comparison`` command, taking the same values.
1884 ``comparison`` command, taking the same values.
1893
1885
1894 ``contact``
1886 ``contact``
1895 Name or email address of the person in charge of the repository.
1887 Name or email address of the person in charge of the repository.
1896 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
1888 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
1897
1889
1898 ``deny_push``
1890 ``deny_push``
1899 Whether to deny pushing to the repository. If empty or not set,
1891 Whether to deny pushing to the repository. If empty or not set,
1900 push is not denied. If the special value ``*``, all remote users are
1892 push is not denied. If the special value ``*``, all remote users are
1901 denied push. Otherwise, unauthenticated users are all denied, and
1893 denied push. Otherwise, unauthenticated users are all denied, and
1902 any authenticated user name present in this list is also denied. The
1894 any authenticated user name present in this list is also denied. The
1903 contents of the deny_push list are examined before the allow_push list.
1895 contents of the deny_push list are examined before the allow_push list.
1904
1896
1905 ``deny_read``
1897 ``deny_read``
1906 Whether to deny reading/viewing of the repository. If this list is
1898 Whether to deny reading/viewing of the repository. If this list is
1907 not empty, unauthenticated users are all denied, and any
1899 not empty, unauthenticated users are all denied, and any
1908 authenticated user name present in this list is also denied access to
1900 authenticated user name present in this list is also denied access to
1909 the repository. If set to the special value ``*``, all remote users
1901 the repository. If set to the special value ``*``, all remote users
1910 are denied access (rarely needed ;). If deny_read is empty or not set,
1902 are denied access (rarely needed ;). If deny_read is empty or not set,
1911 the determination of repository access depends on the presence and
1903 the determination of repository access depends on the presence and
1912 content of the allow_read list (see description). If both
1904 content of the allow_read list (see description). If both
1913 deny_read and allow_read are empty or not set, then access is
1905 deny_read and allow_read are empty or not set, then access is
1914 permitted to all users by default. If the repository is being
1906 permitted to all users by default. If the repository is being
1915 served via hgwebdir, denied users will not be able to see it in
1907 served via hgwebdir, denied users will not be able to see it in
1916 the list of repositories. The contents of the deny_read list have
1908 the list of repositories. The contents of the deny_read list have
1917 priority over (are examined before) the contents of the allow_read
1909 priority over (are examined before) the contents of the allow_read
1918 list.
1910 list.
1919
1911
1920 ``descend``
1912 ``descend``
1921 hgwebdir indexes will not descend into subdirectories. Only repositories
1913 hgwebdir indexes will not descend into subdirectories. Only repositories
1922 directly in the current path will be shown (other repositories are still
1914 directly in the current path will be shown (other repositories are still
1923 available from the index corresponding to their containing path).
1915 available from the index corresponding to their containing path).
1924
1916
1925 ``description``
1917 ``description``
1926 Textual description of the repository's purpose or contents.
1918 Textual description of the repository's purpose or contents.
1927 (default: "unknown")
1919 (default: "unknown")
1928
1920
1929 ``encoding``
1921 ``encoding``
1930 Character encoding name. (default: the current locale charset)
1922 Character encoding name. (default: the current locale charset)
1931 Example: "UTF-8".
1923 Example: "UTF-8".
1932
1924
1933 ``errorlog``
1925 ``errorlog``
1934 Where to output the error log. (default: stderr)
1926 Where to output the error log. (default: stderr)
1935
1927
1936 ``guessmime``
1928 ``guessmime``
1937 Control MIME types for raw download of file content.
1929 Control MIME types for raw download of file content.
1938 Set to True to let hgweb guess the content type from the file
1930 Set to True to let hgweb guess the content type from the file
1939 extension. This will serve HTML files as ``text/html`` and might
1931 extension. This will serve HTML files as ``text/html`` and might
1940 allow cross-site scripting attacks when serving untrusted
1932 allow cross-site scripting attacks when serving untrusted
1941 repositories. (default: False)
1933 repositories. (default: False)
1942
1934
1943 ``hidden``
1935 ``hidden``
1944 Whether to hide the repository in the hgwebdir index.
1936 Whether to hide the repository in the hgwebdir index.
1945 (default: False)
1937 (default: False)
1946
1938
1947 ``ipv6``
1939 ``ipv6``
1948 Whether to use IPv6. (default: False)
1940 Whether to use IPv6. (default: False)
1949
1941
1950 ``logoimg``
1942 ``logoimg``
1951 File name of the logo image that some templates display on each page.
1943 File name of the logo image that some templates display on each page.
1952 The file name is relative to ``staticurl``. That is, the full path to
1944 The file name is relative to ``staticurl``. That is, the full path to
1953 the logo image is "staticurl/logoimg".
1945 the logo image is "staticurl/logoimg".
1954 If unset, ``hglogo.png`` will be used.
1946 If unset, ``hglogo.png`` will be used.
1955
1947
1956 ``logourl``
1948 ``logourl``
1957 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
1949 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
1958 will be used.
1950 will be used.
1959
1951
1960 ``maxchanges``
1952 ``maxchanges``
1961 Maximum number of changes to list on the changelog. (default: 10)
1953 Maximum number of changes to list on the changelog. (default: 10)
1962
1954
1963 ``maxfiles``
1955 ``maxfiles``
1964 Maximum number of files to list per changeset. (default: 10)
1956 Maximum number of files to list per changeset. (default: 10)
1965
1957
1966 ``maxshortchanges``
1958 ``maxshortchanges``
1967 Maximum number of changes to list on the shortlog, graph or filelog
1959 Maximum number of changes to list on the shortlog, graph or filelog
1968 pages. (default: 60)
1960 pages. (default: 60)
1969
1961
1970 ``name``
1962 ``name``
1971 Repository name to use in the web interface.
1963 Repository name to use in the web interface.
1972 (default: current working directory)
1964 (default: current working directory)
1973
1965
1974 ``port``
1966 ``port``
1975 Port to listen on. (default: 8000)
1967 Port to listen on. (default: 8000)
1976
1968
1977 ``prefix``
1969 ``prefix``
1978 Prefix path to serve from. (default: '' (server root))
1970 Prefix path to serve from. (default: '' (server root))
1979
1971
1980 ``push_ssl``
1972 ``push_ssl``
1981 Whether to require that inbound pushes be transported over SSL to
1973 Whether to require that inbound pushes be transported over SSL to
1982 prevent password sniffing. (default: True)
1974 prevent password sniffing. (default: True)
1983
1975
1984 ``refreshinterval``
1976 ``refreshinterval``
1985 How frequently directory listings re-scan the filesystem for new
1977 How frequently directory listings re-scan the filesystem for new
1986 repositories, in seconds. This is relevant when wildcards are used
1978 repositories, in seconds. This is relevant when wildcards are used
1987 to define paths. Depending on how much filesystem traversal is
1979 to define paths. Depending on how much filesystem traversal is
1988 required, refreshing may negatively impact performance.
1980 required, refreshing may negatively impact performance.
1989
1981
1990 Values less than or equal to 0 always refresh.
1982 Values less than or equal to 0 always refresh.
1991 (default: 20)
1983 (default: 20)
1992
1984
1993 ``staticurl``
1985 ``staticurl``
1994 Base URL to use for static files. If unset, static files (e.g. the
1986 Base URL to use for static files. If unset, static files (e.g. the
1995 hgicon.png favicon) will be served by the CGI script itself. Use
1987 hgicon.png favicon) will be served by the CGI script itself. Use
1996 this setting to serve them directly with the HTTP server.
1988 this setting to serve them directly with the HTTP server.
1997 Example: ``http://hgserver/static/``.
1989 Example: ``http://hgserver/static/``.
1998
1990
1999 ``stripes``
1991 ``stripes``
2000 How many lines a "zebra stripe" should span in multi-line output.
1992 How many lines a "zebra stripe" should span in multi-line output.
2001 Set to 0 to disable. (default: 1)
1993 Set to 0 to disable. (default: 1)
2002
1994
2003 ``style``
1995 ``style``
2004 Which template map style to use. The available options are the names of
1996 Which template map style to use. The available options are the names of
2005 subdirectories in the HTML templates path. (default: ``paper``)
1997 subdirectories in the HTML templates path. (default: ``paper``)
2006 Example: ``monoblue``.
1998 Example: ``monoblue``.
2007
1999
2008 ``templates``
2000 ``templates``
2009 Where to find the HTML templates. The default path to the HTML templates
2001 Where to find the HTML templates. The default path to the HTML templates
2010 can be obtained from ``hg debuginstall``.
2002 can be obtained from ``hg debuginstall``.
2011
2003
2012 ``websub``
2004 ``websub``
2013 ----------
2005 ----------
2014
2006
2015 Web substitution filter definition. You can use this section to
2007 Web substitution filter definition. You can use this section to
2016 define a set of regular expression substitution patterns which
2008 define a set of regular expression substitution patterns which
2017 let you automatically modify the hgweb server output.
2009 let you automatically modify the hgweb server output.
2018
2010
2019 The default hgweb templates only apply these substitution patterns
2011 The default hgweb templates only apply these substitution patterns
2020 on the revision description fields. You can apply them anywhere
2012 on the revision description fields. You can apply them anywhere
2021 you want when you create your own templates by adding calls to the
2013 you want when you create your own templates by adding calls to the
2022 "websub" filter (usually after calling the "escape" filter).
2014 "websub" filter (usually after calling the "escape" filter).
2023
2015
2024 This can be used, for example, to convert issue references to links
2016 This can be used, for example, to convert issue references to links
2025 to your issue tracker, or to convert "markdown-like" syntax into
2017 to your issue tracker, or to convert "markdown-like" syntax into
2026 HTML (see the examples below).
2018 HTML (see the examples below).
2027
2019
2028 Each entry in this section names a substitution filter.
2020 Each entry in this section names a substitution filter.
2029 The value of each entry defines the substitution expression itself.
2021 The value of each entry defines the substitution expression itself.
2030 The websub expressions follow the old interhg extension syntax,
2022 The websub expressions follow the old interhg extension syntax,
2031 which in turn imitates the Unix sed replacement syntax::
2023 which in turn imitates the Unix sed replacement syntax::
2032
2024
2033 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2025 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2034
2026
2035 You can use any separator other than "/". The final "i" is optional
2027 You can use any separator other than "/". The final "i" is optional
2036 and indicates that the search must be case insensitive.
2028 and indicates that the search must be case insensitive.
2037
2029
2038 Examples::
2030 Examples::
2039
2031
2040 [websub]
2032 [websub]
2041 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2033 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2042 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2034 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2043 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2035 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2044
2036
2045 ``worker``
2037 ``worker``
2046 ----------
2038 ----------
2047
2039
2048 Parallel master/worker configuration. We currently perform working
2040 Parallel master/worker configuration. We currently perform working
2049 directory updates in parallel on Unix-like systems, which greatly
2041 directory updates in parallel on Unix-like systems, which greatly
2050 helps performance.
2042 helps performance.
2051
2043
2052 ``numcpus``
2044 ``numcpus``
2053 Number of CPUs to use for parallel operations. A zero or
2045 Number of CPUs to use for parallel operations. A zero or
2054 negative value is treated as ``use the default``.
2046 negative value is treated as ``use the default``.
2055 (default: 4 or the number of CPUs on the system, whichever is larger)
2047 (default: 4 or the number of CPUs on the system, whichever is larger)
2056
2048
2057 ``backgroundclose``
2049 ``backgroundclose``
2058 Whether to enable closing file handles on background threads during certain
2050 Whether to enable closing file handles on background threads during certain
2059 operations. Some platforms aren't very efficient at closing file
2051 operations. Some platforms aren't very efficient at closing file
2060 handles that have been written or appended to. By performing file closing
2052 handles that have been written or appended to. By performing file closing
2061 on background threads, file write rate can increase substantially.
2053 on background threads, file write rate can increase substantially.
2062 (default: true on Windows, false elsewhere)
2054 (default: true on Windows, false elsewhere)
2063
2055
2064 ``backgroundcloseminfilecount``
2056 ``backgroundcloseminfilecount``
2065 Minimum number of files required to trigger background file closing.
2057 Minimum number of files required to trigger background file closing.
2066 Operations not writing this many files won't start background close
2058 Operations not writing this many files won't start background close
2067 threads.
2059 threads.
2068 (default: 2048)
2060 (default: 2048)
2069
2061
2070 ``backgroundclosemaxqueue``
2062 ``backgroundclosemaxqueue``
2071 The maximum number of opened file handles waiting to be closed in the
2063 The maximum number of opened file handles waiting to be closed in the
2072 background. This option only has an effect if ``backgroundclose`` is
2064 background. This option only has an effect if ``backgroundclose`` is
2073 enabled.
2065 enabled.
2074 (default: 384)
2066 (default: 384)
2075
2067
2076 ``backgroundclosethreadcount``
2068 ``backgroundclosethreadcount``
2077 Number of threads to process background file closes. Only relevant if
2069 Number of threads to process background file closes. Only relevant if
2078 ``backgroundclose`` is enabled.
2070 ``backgroundclose`` is enabled.
2079 (default: 4)
2071 (default: 4)
General Comments 0
You need to be logged in to leave comments. Login now