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