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