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