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