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