##// END OF EJS Templates
help: add "web/logoimg" setting description
Angel Ezquerra -
r14938:ec18cd25 default
parent child Browse files
Show More
@@ -1,1297 +1,1303 b''
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 | (Unix, Windows) ``<repo>/.hg/hgrc``
32 32
33 33 Per-repository configuration options that only apply in a
34 34 particular repository. This file is not version-controlled, and
35 35 will not get transferred during a "clone" operation. Options in
36 36 this file override options in all other configuration files. On
37 37 Unix, most of this file will be ignored if it doesn't belong to a
38 38 trusted user or to a trusted group. See the documentation for the
39 39 ``[trusted]`` section below for more details.
40 40
41 41 | (Unix) ``$HOME/.hgrc``
42 42 | (Windows) ``%USERPROFILE%\.hgrc``
43 43 | (Windows) ``%USERPROFILE%\Mercurial.ini``
44 44 | (Windows) ``%HOME%\.hgrc``
45 45 | (Windows) ``%HOME%\Mercurial.ini``
46 46
47 47 Per-user configuration file(s), for the user running Mercurial. On
48 48 Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these
49 49 files apply to all Mercurial commands executed by this user in any
50 50 directory. Options in these files override per-system and per-installation
51 51 options.
52 52
53 53 | (Unix) ``/etc/mercurial/hgrc``
54 54 | (Unix) ``/etc/mercurial/hgrc.d/*.rc``
55 55
56 56 Per-system configuration files, for the system on which Mercurial
57 57 is running. Options in these files apply to all Mercurial commands
58 58 executed by any user in any directory. Options in these files
59 59 override per-installation options.
60 60
61 61 | (Unix) ``<install-root>/etc/mercurial/hgrc``
62 62 | (Unix) ``<install-root>/etc/mercurial/hgrc.d/*.rc``
63 63
64 64 Per-installation configuration files, searched for in the
65 65 directory where Mercurial is installed. ``<install-root>`` is the
66 66 parent directory of the **hg** executable (or symlink) being run. For
67 67 example, if installed in ``/shared/tools/bin/hg``, Mercurial will look
68 68 in ``/shared/tools/etc/mercurial/hgrc``. Options in these files apply
69 69 to all Mercurial commands executed by any user in any directory.
70 70
71 71 | (Windows) ``<install-dir>\Mercurial.ini`` **or**
72 72 | (Windows) ``<install-dir>\hgrc.d\*.rc`` **or**
73 73 | (Windows) ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial``
74 74
75 75 Per-installation/system configuration files, for the system on
76 76 which Mercurial is running. Options in these files apply to all
77 77 Mercurial commands executed by any user in any directory. Registry
78 78 keys contain PATH-like strings, every part of which must reference
79 79 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
80 80 be read. Mercurial checks each of these locations in the specified
81 81 order until one or more configuration files are detected. If the
82 82 pywin32 extensions are not installed, Mercurial will only look for
83 83 site-wide configuration in ``C:\Mercurial\Mercurial.ini``.
84 84
85 85 Syntax
86 86 ------
87 87
88 88 A configuration file consists of sections, led by a ``[section]`` header
89 89 and followed by ``name = value`` entries (sometimes called
90 90 ``configuration keys``)::
91 91
92 92 [spam]
93 93 eggs=ham
94 94 green=
95 95 eggs
96 96
97 97 Each line contains one entry. If the lines that follow are indented,
98 98 they are treated as continuations of that entry. Leading whitespace is
99 99 removed from values. Empty lines are skipped. Lines beginning with
100 100 ``#`` or ``;`` are ignored and may be used to provide comments.
101 101
102 102 Configuration keys can be set multiple times, in which case Mercurial
103 103 will use the value that was configured last. As an example::
104 104
105 105 [spam]
106 106 eggs=large
107 107 ham=serrano
108 108 eggs=small
109 109
110 110 This would set the configuration key named ``eggs`` to ``small``.
111 111
112 112 It is also possible to define a section multiple times. A section can
113 113 be redefined on the same and/or on different configuration files. For
114 114 example::
115 115
116 116 [foo]
117 117 eggs=large
118 118 ham=serrano
119 119 eggs=small
120 120
121 121 [bar]
122 122 eggs=ham
123 123 green=
124 124 eggs
125 125
126 126 [foo]
127 127 ham=prosciutto
128 128 eggs=medium
129 129 bread=toasted
130 130
131 131 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
132 132 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
133 133 respectively. As you can see there only thing that matters is the last
134 134 value that was set for each of the configuration keys.
135 135
136 136 If a configuration key is set multiple times in different
137 137 configuration files the final value will depend on the order in which
138 138 the different configuration files are read, with settings from earlier
139 139 paths overriding later ones as described on the ``Files`` section
140 140 above.
141 141
142 142 A line of the form ``%include file`` will include ``file`` into the
143 143 current configuration file. The inclusion is recursive, which means
144 144 that included files can include other files. Filenames are relative to
145 145 the configuration file in which the ``%include`` directive is found.
146 146 Environment variables and ``~user`` constructs are expanded in
147 147 ``file``. This lets you do something like::
148 148
149 149 %include ~/.hgrc.d/$HOST.rc
150 150
151 151 to include a different configuration file on each computer you use.
152 152
153 153 A line with ``%unset name`` will remove ``name`` from the current
154 154 section, if it has been set previously.
155 155
156 156 The values are either free-form text strings, lists of text strings,
157 157 or Boolean values. Boolean values can be set to true using any of "1",
158 158 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
159 159 (all case insensitive).
160 160
161 161 List values are separated by whitespace or comma, except when values are
162 162 placed in double quotation marks::
163 163
164 164 allow_read = "John Doe, PhD", brian, betty
165 165
166 166 Quotation marks can be escaped by prefixing them with a backslash. Only
167 167 quotation marks at the beginning of a word is counted as a quotation
168 168 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
169 169
170 170 Sections
171 171 --------
172 172
173 173 This section describes the different sections that may appear in a
174 174 Mercurial configuration file, the purpose of each section, its possible
175 175 keys, and their possible values.
176 176
177 177 ``alias``
178 178 """""""""
179 179
180 180 Defines command aliases.
181 181 Aliases allow you to define your own commands in terms of other
182 182 commands (or aliases), optionally including arguments. Positional
183 183 arguments in the form of ``$1``, ``$2``, etc in the alias definition
184 184 are expanded by Mercurial before execution. Positional arguments not
185 185 already used by ``$N`` in the definition are put at the end of the
186 186 command to be executed.
187 187
188 188 Alias definitions consist of lines of the form::
189 189
190 190 <alias> = <command> [<argument>]...
191 191
192 192 For example, this definition::
193 193
194 194 latest = log --limit 5
195 195
196 196 creates a new command ``latest`` that shows only the five most recent
197 197 changesets. You can define subsequent aliases using earlier ones::
198 198
199 199 stable5 = latest -b stable
200 200
201 201 .. note:: It is possible to create aliases with the same names as
202 202 existing commands, which will then override the original
203 203 definitions. This is almost always a bad idea!
204 204
205 205 An alias can start with an exclamation point (``!``) to make it a
206 206 shell alias. A shell alias is executed with the shell and will let you
207 207 run arbitrary commands. As an example, ::
208 208
209 209 echo = !echo
210 210
211 211 will let you do ``hg echo foo`` to have ``foo`` printed in your
212 212 terminal. A better example might be::
213 213
214 214 purge = !$HG status --no-status --unknown -0 | xargs -0 rm
215 215
216 216 which will make ``hg purge`` delete all unknown files in the
217 217 repository in the same manner as the purge extension.
218 218
219 219 Shell aliases are executed in an environment where ``$HG`` expand to
220 220 the path of the Mercurial that was used to execute the alias. This is
221 221 useful when you want to call further Mercurial commands in a shell
222 222 alias, as was done above for the purge alias. In addition,
223 223 ``$HG_ARGS`` expand to the arguments given to Mercurial. In the ``hg
224 224 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
225 225
226 226 .. note:: Some global configuration options such as ``-R`` are
227 227 processed before shell aliases and will thus not be passed to
228 228 aliases.
229 229
230 230 ``auth``
231 231 """"""""
232 232
233 233 Authentication credentials for HTTP authentication. This section
234 234 allows you to store usernames and passwords for use when logging
235 235 *into* HTTP servers. See the ``[web]`` configuration section if
236 236 you want to configure *who* can login to your HTTP server.
237 237
238 238 Each line has the following format::
239 239
240 240 <name>.<argument> = <value>
241 241
242 242 where ``<name>`` is used to group arguments into authentication
243 243 entries. Example::
244 244
245 245 foo.prefix = hg.intevation.org/mercurial
246 246 foo.username = foo
247 247 foo.password = bar
248 248 foo.schemes = http https
249 249
250 250 bar.prefix = secure.example.org
251 251 bar.key = path/to/file.key
252 252 bar.cert = path/to/file.cert
253 253 bar.schemes = https
254 254
255 255 Supported arguments:
256 256
257 257 ``prefix``
258 258 Either ``*`` or a URI prefix with or without the scheme part.
259 259 The authentication entry with the longest matching prefix is used
260 260 (where ``*`` matches everything and counts as a match of length
261 261 1). If the prefix doesn't include a scheme, the match is performed
262 262 against the URI with its scheme stripped as well, and the schemes
263 263 argument, q.v., is then subsequently consulted.
264 264
265 265 ``username``
266 266 Optional. Username to authenticate with. If not given, and the
267 267 remote site requires basic or digest authentication, the user will
268 268 be prompted for it. Environment variables are expanded in the
269 269 username letting you do ``foo.username = $USER``.
270 270
271 271 ``password``
272 272 Optional. Password to authenticate with. If not given, and the
273 273 remote site requires basic or digest authentication, the user
274 274 will be prompted for it.
275 275
276 276 ``key``
277 277 Optional. PEM encoded client certificate key file. Environment
278 278 variables are expanded in the filename.
279 279
280 280 ``cert``
281 281 Optional. PEM encoded client certificate chain file. Environment
282 282 variables are expanded in the filename.
283 283
284 284 ``schemes``
285 285 Optional. Space separated list of URI schemes to use this
286 286 authentication entry with. Only used if the prefix doesn't include
287 287 a scheme. Supported schemes are http and https. They will match
288 288 static-http and static-https respectively, as well.
289 289 Default: https.
290 290
291 291 If no suitable authentication entry is found, the user is prompted
292 292 for credentials as usual if required by the remote.
293 293
294 294
295 295 ``decode/encode``
296 296 """""""""""""""""
297 297
298 298 Filters for transforming files on checkout/checkin. This would
299 299 typically be used for newline processing or other
300 300 localization/canonicalization of files.
301 301
302 302 Filters consist of a filter pattern followed by a filter command.
303 303 Filter patterns are globs by default, rooted at the repository root.
304 304 For example, to match any file ending in ``.txt`` in the root
305 305 directory only, use the pattern ``*.txt``. To match any file ending
306 306 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
307 307 For each file only the first matching filter applies.
308 308
309 309 The filter command can start with a specifier, either ``pipe:`` or
310 310 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
311 311
312 312 A ``pipe:`` command must accept data on stdin and return the transformed
313 313 data on stdout.
314 314
315 315 Pipe example::
316 316
317 317 [encode]
318 318 # uncompress gzip files on checkin to improve delta compression
319 319 # note: not necessarily a good idea, just an example
320 320 *.gz = pipe: gunzip
321 321
322 322 [decode]
323 323 # recompress gzip files when writing them to the working dir (we
324 324 # can safely omit "pipe:", because it's the default)
325 325 *.gz = gzip
326 326
327 327 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
328 328 with the name of a temporary file that contains the data to be
329 329 filtered by the command. The string ``OUTFILE`` is replaced with the name
330 330 of an empty temporary file, where the filtered data must be written by
331 331 the command.
332 332
333 333 .. note:: The tempfile mechanism is recommended for Windows systems,
334 334 where the standard shell I/O redirection operators often have
335 335 strange effects and may corrupt the contents of your files.
336 336
337 337 This filter mechanism is used internally by the ``eol`` extension to
338 338 translate line ending characters between Windows (CRLF) and Unix (LF)
339 339 format. We suggest you use the ``eol`` extension for convenience.
340 340
341 341
342 342 ``defaults``
343 343 """"""""""""
344 344
345 345 (defaults are deprecated. Don't use them. Use aliases instead)
346 346
347 347 Use the ``[defaults]`` section to define command defaults, i.e. the
348 348 default options/arguments to pass to the specified commands.
349 349
350 350 The following example makes :hg:`log` run in verbose mode, and
351 351 :hg:`status` show only the modified files, by default::
352 352
353 353 [defaults]
354 354 log = -v
355 355 status = -m
356 356
357 357 The actual commands, instead of their aliases, must be used when
358 358 defining command defaults. The command defaults will also be applied
359 359 to the aliases of the commands defined.
360 360
361 361
362 362 ``diff``
363 363 """"""""
364 364
365 365 Settings used when displaying diffs. Everything except for ``unified`` is a
366 366 Boolean and defaults to False.
367 367
368 368 ``git``
369 369 Use git extended diff format.
370 370
371 371 ``nodates``
372 372 Don't include dates in diff headers.
373 373
374 374 ``showfunc``
375 375 Show which function each change is in.
376 376
377 377 ``ignorews``
378 378 Ignore white space when comparing lines.
379 379
380 380 ``ignorewsamount``
381 381 Ignore changes in the amount of white space.
382 382
383 383 ``ignoreblanklines``
384 384 Ignore changes whose lines are all blank.
385 385
386 386 ``unified``
387 387 Number of lines of context to show.
388 388
389 389 ``email``
390 390 """""""""
391 391
392 392 Settings for extensions that send email messages.
393 393
394 394 ``from``
395 395 Optional. Email address to use in "From" header and SMTP envelope
396 396 of outgoing messages.
397 397
398 398 ``to``
399 399 Optional. Comma-separated list of recipients' email addresses.
400 400
401 401 ``cc``
402 402 Optional. Comma-separated list of carbon copy recipients'
403 403 email addresses.
404 404
405 405 ``bcc``
406 406 Optional. Comma-separated list of blind carbon copy recipients'
407 407 email addresses.
408 408
409 409 ``method``
410 410 Optional. Method to use to send email messages. If value is ``smtp``
411 411 (default), use SMTP (see the ``[smtp]`` section for configuration).
412 412 Otherwise, use as name of program to run that acts like sendmail
413 413 (takes ``-f`` option for sender, list of recipients on command line,
414 414 message on stdin). Normally, setting this to ``sendmail`` or
415 415 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
416 416
417 417 ``charsets``
418 418 Optional. Comma-separated list of character sets considered
419 419 convenient for recipients. Addresses, headers, and parts not
420 420 containing patches of outgoing messages will be encoded in the
421 421 first character set to which conversion from local encoding
422 422 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
423 423 conversion fails, the text in question is sent as is. Defaults to
424 424 empty (explicit) list.
425 425
426 426 Order of outgoing email character sets:
427 427
428 428 1. ``us-ascii``: always first, regardless of settings
429 429 2. ``email.charsets``: in order given by user
430 430 3. ``ui.fallbackencoding``: if not in email.charsets
431 431 4. ``$HGENCODING``: if not in email.charsets
432 432 5. ``utf-8``: always last, regardless of settings
433 433
434 434 Email example::
435 435
436 436 [email]
437 437 from = Joseph User <joe.user@example.com>
438 438 method = /usr/sbin/sendmail
439 439 # charsets for western Europeans
440 440 # us-ascii, utf-8 omitted, as they are tried first and last
441 441 charsets = iso-8859-1, iso-8859-15, windows-1252
442 442
443 443
444 444 ``extensions``
445 445 """"""""""""""
446 446
447 447 Mercurial has an extension mechanism for adding new features. To
448 448 enable an extension, create an entry for it in this section.
449 449
450 450 If you know that the extension is already in Python's search path,
451 451 you can give the name of the module, followed by ``=``, with nothing
452 452 after the ``=``.
453 453
454 454 Otherwise, give a name that you choose, followed by ``=``, followed by
455 455 the path to the ``.py`` file (including the file name extension) that
456 456 defines the extension.
457 457
458 458 To explicitly disable an extension that is enabled in an hgrc of
459 459 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
460 460 or ``foo = !`` when path is not supplied.
461 461
462 462 Example for ``~/.hgrc``::
463 463
464 464 [extensions]
465 465 # (the mq extension will get loaded from Mercurial's path)
466 466 mq =
467 467 # (this extension will get loaded from the file specified)
468 468 myfeature = ~/.hgext/myfeature.py
469 469
470 470
471 471 ``hostfingerprints``
472 472 """"""""""""""""""""
473 473
474 474 Fingerprints of the certificates of known HTTPS servers.
475 475 A HTTPS connection to a server with a fingerprint configured here will
476 476 only succeed if the servers certificate matches the fingerprint.
477 477 This is very similar to how ssh known hosts works.
478 478 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
479 479 The CA chain and web.cacerts is not used for servers with a fingerprint.
480 480
481 481 For example::
482 482
483 483 [hostfingerprints]
484 484 hg.intevation.org = 38:76:52:7c:87:26:9a:8f:4a:f8:d3:de:08:45:3b:ea:d6:4b:ee:cc
485 485
486 486 This feature is only supported when using Python 2.6 or later.
487 487
488 488
489 489 ``format``
490 490 """"""""""
491 491
492 492 ``usestore``
493 493 Enable or disable the "store" repository format which improves
494 494 compatibility with systems that fold case or otherwise mangle
495 495 filenames. Enabled by default. Disabling this option will allow
496 496 you to store longer filenames in some situations at the expense of
497 497 compatibility and ensures that the on-disk format of newly created
498 498 repositories will be compatible with Mercurial before version 0.9.4.
499 499
500 500 ``usefncache``
501 501 Enable or disable the "fncache" repository format which enhances
502 502 the "store" repository format (which has to be enabled to use
503 503 fncache) to allow longer filenames and avoids using Windows
504 504 reserved names, e.g. "nul". Enabled by default. Disabling this
505 505 option ensures that the on-disk format of newly created
506 506 repositories will be compatible with Mercurial before version 1.1.
507 507
508 508 ``dotencode``
509 509 Enable or disable the "dotencode" repository format which enhances
510 510 the "fncache" repository format (which has to be enabled to use
511 511 dotencode) to avoid issues with filenames starting with ._ on
512 512 Mac OS X and spaces on Windows. Enabled by default. Disabling this
513 513 option ensures that the on-disk format of newly created
514 514 repositories will be compatible with Mercurial before version 1.7.
515 515
516 516 ``merge-patterns``
517 517 """"""""""""""""""
518 518
519 519 This section specifies merge tools to associate with particular file
520 520 patterns. Tools matched here will take precedence over the default
521 521 merge tool. Patterns are globs by default, rooted at the repository
522 522 root.
523 523
524 524 Example::
525 525
526 526 [merge-patterns]
527 527 **.c = kdiff3
528 528 **.jpg = myimgmerge
529 529
530 530 ``merge-tools``
531 531 """""""""""""""
532 532
533 533 This section configures external merge tools to use for file-level
534 534 merges.
535 535
536 536 Example ``~/.hgrc``::
537 537
538 538 [merge-tools]
539 539 # Override stock tool location
540 540 kdiff3.executable = ~/bin/kdiff3
541 541 # Specify command line
542 542 kdiff3.args = $base $local $other -o $output
543 543 # Give higher priority
544 544 kdiff3.priority = 1
545 545
546 546 # Define new tool
547 547 myHtmlTool.args = -m $local $other $base $output
548 548 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
549 549 myHtmlTool.priority = 1
550 550
551 551 Supported arguments:
552 552
553 553 ``priority``
554 554 The priority in which to evaluate this tool.
555 555 Default: 0.
556 556
557 557 ``executable``
558 558 Either just the name of the executable or its pathname. On Windows,
559 559 the path can use environment variables with ${ProgramFiles} syntax.
560 560 Default: the tool name.
561 561
562 562 ``args``
563 563 The arguments to pass to the tool executable. You can refer to the
564 564 files being merged as well as the output file through these
565 565 variables: ``$base``, ``$local``, ``$other``, ``$output``.
566 566 Default: ``$local $base $other``
567 567
568 568 ``premerge``
569 569 Attempt to run internal non-interactive 3-way merge tool before
570 570 launching external tool. Options are ``true``, ``false``, or ``keep``
571 571 to leave markers in the file if the premerge fails.
572 572 Default: True
573 573
574 574 ``binary``
575 575 This tool can merge binary files. Defaults to False, unless tool
576 576 was selected by file pattern match.
577 577
578 578 ``symlink``
579 579 This tool can merge symlinks. Defaults to False, even if tool was
580 580 selected by file pattern match.
581 581
582 582 ``check``
583 583 A list of merge success-checking options:
584 584
585 585 ``changed``
586 586 Ask whether merge was successful when the merged file shows no changes.
587 587 ``conflicts``
588 588 Check whether there are conflicts even though the tool reported success.
589 589 ``prompt``
590 590 Always prompt for merge success, regardless of success reported by tool.
591 591
592 592 ``checkchanged``
593 593 True is equivalent to ``check = changed``.
594 594 Default: False
595 595
596 596 ``checkconflicts``
597 597 True is equivalent to ``check = conflicts``.
598 598 Default: False
599 599
600 600 ``fixeol``
601 601 Attempt to fix up EOL changes caused by the merge tool.
602 602 Default: False
603 603
604 604 ``gui``
605 605 This tool requires a graphical interface to run. Default: False
606 606
607 607 ``regkey``
608 608 Windows registry key which describes install location of this
609 609 tool. Mercurial will search for this key first under
610 610 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
611 611 Default: None
612 612
613 613 ``regkeyalt``
614 614 An alternate Windows registry key to try if the first key is not
615 615 found. The alternate key uses the same ``regname`` and ``regappend``
616 616 semantics of the primary key. The most common use for this key
617 617 is to search for 32bit applications on 64bit operating systems.
618 618 Default: None
619 619
620 620 ``regname``
621 621 Name of value to read from specified registry key. Defaults to the
622 622 unnamed (default) value.
623 623
624 624 ``regappend``
625 625 String to append to the value read from the registry, typically
626 626 the executable name of the tool.
627 627 Default: None
628 628
629 629
630 630 ``hooks``
631 631 """""""""
632 632
633 633 Commands or Python functions that get automatically executed by
634 634 various actions such as starting or finishing a commit. Multiple
635 635 hooks can be run for the same action by appending a suffix to the
636 636 action. Overriding a site-wide hook can be done by changing its
637 637 value or setting it to an empty string.
638 638
639 639 Example ``.hg/hgrc``::
640 640
641 641 [hooks]
642 642 # update working directory after adding changesets
643 643 changegroup.update = hg update
644 644 # do not use the site-wide hook
645 645 incoming =
646 646 incoming.email = /my/email/hook
647 647 incoming.autobuild = /my/build/hook
648 648
649 649 Most hooks are run with environment variables set that give useful
650 650 additional information. For each hook below, the environment
651 651 variables it is passed are listed with names of the form ``$HG_foo``.
652 652
653 653 ``changegroup``
654 654 Run after a changegroup has been added via push, pull or unbundle.
655 655 ID of the first new changeset is in ``$HG_NODE``. URL from which
656 656 changes came is in ``$HG_URL``.
657 657
658 658 ``commit``
659 659 Run after a changeset has been created in the local repository. ID
660 660 of the newly created changeset is in ``$HG_NODE``. Parent changeset
661 661 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
662 662
663 663 ``incoming``
664 664 Run after a changeset has been pulled, pushed, or unbundled into
665 665 the local repository. The ID of the newly arrived changeset is in
666 666 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
667 667
668 668 ``outgoing``
669 669 Run after sending changes from local repository to another. ID of
670 670 first changeset sent is in ``$HG_NODE``. Source of operation is in
671 671 ``$HG_SOURCE``; see "preoutgoing" hook for description.
672 672
673 673 ``post-<command>``
674 674 Run after successful invocations of the associated command. The
675 675 contents of the command line are passed as ``$HG_ARGS`` and the result
676 676 code in ``$HG_RESULT``. Parsed command line arguments are passed as
677 677 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
678 678 the python data internally passed to <command>. ``$HG_OPTS`` is a
679 679 dictionary of options (with unspecified options set to their defaults).
680 680 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
681 681
682 682 ``pre-<command>``
683 683 Run before executing the associated command. The contents of the
684 684 command line are passed as ``$HG_ARGS``. Parsed command line arguments
685 685 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
686 686 representations of the data internally passed to <command>. ``$HG_OPTS``
687 687 is a dictionary of options (with unspecified options set to their
688 688 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
689 689 failure, the command doesn't execute and Mercurial returns the failure
690 690 code.
691 691
692 692 ``prechangegroup``
693 693 Run before a changegroup is added via push, pull or unbundle. Exit
694 694 status 0 allows the changegroup to proceed. Non-zero status will
695 695 cause the push, pull or unbundle to fail. URL from which changes
696 696 will come is in ``$HG_URL``.
697 697
698 698 ``precommit``
699 699 Run before starting a local commit. Exit status 0 allows the
700 700 commit to proceed. Non-zero status will cause the commit to fail.
701 701 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
702 702
703 703 ``prelistkeys``
704 704 Run before listing pushkeys (like bookmarks) in the
705 705 repository. Non-zero status will cause failure. The key namespace is
706 706 in ``$HG_NAMESPACE``.
707 707
708 708 ``preoutgoing``
709 709 Run before collecting changes to send from the local repository to
710 710 another. Non-zero status will cause failure. This lets you prevent
711 711 pull over HTTP or SSH. Also prevents against local pull, push
712 712 (outbound) or bundle commands, but not effective, since you can
713 713 just copy files instead then. Source of operation is in
714 714 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
715 715 SSH or HTTP repository. If "push", "pull" or "bundle", operation
716 716 is happening on behalf of repository on same system.
717 717
718 718 ``prepushkey``
719 719 Run before a pushkey (like a bookmark) is added to the
720 720 repository. Non-zero status will cause the key to be rejected. The
721 721 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
722 722 the old value (if any) is in ``$HG_OLD``, and the new value is in
723 723 ``$HG_NEW``.
724 724
725 725 ``pretag``
726 726 Run before creating a tag. Exit status 0 allows the tag to be
727 727 created. Non-zero status will cause the tag to fail. ID of
728 728 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
729 729 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
730 730
731 731 ``pretxnchangegroup``
732 732 Run after a changegroup has been added via push, pull or unbundle,
733 733 but before the transaction has been committed. Changegroup is
734 734 visible to hook program. This lets you validate incoming changes
735 735 before accepting them. Passed the ID of the first new changeset in
736 736 ``$HG_NODE``. Exit status 0 allows the transaction to commit. Non-zero
737 737 status will cause the transaction to be rolled back and the push,
738 738 pull or unbundle will fail. URL that was source of changes is in
739 739 ``$HG_URL``.
740 740
741 741 ``pretxncommit``
742 742 Run after a changeset has been created but the transaction not yet
743 743 committed. Changeset is visible to hook program. This lets you
744 744 validate commit message and changes. Exit status 0 allows the
745 745 commit to proceed. Non-zero status will cause the transaction to
746 746 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
747 747 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
748 748
749 749 ``preupdate``
750 750 Run before updating the working directory. Exit status 0 allows
751 751 the update to proceed. Non-zero status will prevent the update.
752 752 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
753 753 of second new parent is in ``$HG_PARENT2``.
754 754
755 755 ``listkeys``
756 756 Run after listing pushkeys (like bookmarks) in the repository. The
757 757 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
758 758 dictionary containing the keys and values.
759 759
760 760 ``pushkey``
761 761 Run after a pushkey (like a bookmark) is added to the
762 762 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
763 763 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
764 764 value is in ``$HG_NEW``.
765 765
766 766 ``tag``
767 767 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
768 768 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
769 769 repository if ``$HG_LOCAL=0``.
770 770
771 771 ``update``
772 772 Run after updating the working directory. Changeset ID of first
773 773 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
774 774 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
775 775 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
776 776
777 777 .. note:: It is generally better to use standard hooks rather than the
778 778 generic pre- and post- command hooks as they are guaranteed to be
779 779 called in the appropriate contexts for influencing transactions.
780 780 Also, hooks like "commit" will be called in all contexts that
781 781 generate a commit (e.g. tag) and not just the commit command.
782 782
783 783 .. note:: Environment variables with empty values may not be passed to
784 784 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
785 785 will have an empty value under Unix-like platforms for non-merge
786 786 changesets, while it will not be available at all under Windows.
787 787
788 788 The syntax for Python hooks is as follows::
789 789
790 790 hookname = python:modulename.submodule.callable
791 791 hookname = python:/path/to/python/module.py:callable
792 792
793 793 Python hooks are run within the Mercurial process. Each hook is
794 794 called with at least three keyword arguments: a ui object (keyword
795 795 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
796 796 keyword that tells what kind of hook is used. Arguments listed as
797 797 environment variables above are passed as keyword arguments, with no
798 798 ``HG_`` prefix, and names in lower case.
799 799
800 800 If a Python hook returns a "true" value or raises an exception, this
801 801 is treated as a failure.
802 802
803 803
804 804 ``http_proxy``
805 805 """"""""""""""
806 806
807 807 Used to access web-based Mercurial repositories through a HTTP
808 808 proxy.
809 809
810 810 ``host``
811 811 Host name and (optional) port of the proxy server, for example
812 812 "myproxy:8000".
813 813
814 814 ``no``
815 815 Optional. Comma-separated list of host names that should bypass
816 816 the proxy.
817 817
818 818 ``passwd``
819 819 Optional. Password to authenticate with at the proxy server.
820 820
821 821 ``user``
822 822 Optional. User name to authenticate with at the proxy server.
823 823
824 824 ``always``
825 825 Optional. Always use the proxy, even for localhost and any entries
826 826 in ``http_proxy.no``. True or False. Default: False.
827 827
828 828 ``smtp``
829 829 """"""""
830 830
831 831 Configuration for extensions that need to send email messages.
832 832
833 833 ``host``
834 834 Host name of mail server, e.g. "mail.example.com".
835 835
836 836 ``port``
837 837 Optional. Port to connect to on mail server. Default: 25.
838 838
839 839 ``tls``
840 840 Optional. Method to enable TLS when connecting to mail server: starttls,
841 841 smtps or none. Default: none.
842 842
843 843 ``username``
844 844 Optional. User name for authenticating with the SMTP server.
845 845 Default: none.
846 846
847 847 ``password``
848 848 Optional. Password for authenticating with the SMTP server. If not
849 849 specified, interactive sessions will prompt the user for a
850 850 password; non-interactive sessions will fail. Default: none.
851 851
852 852 ``local_hostname``
853 853 Optional. It's the hostname that the sender can use to identify
854 854 itself to the MTA.
855 855
856 856
857 857 ``patch``
858 858 """""""""
859 859
860 860 Settings used when applying patches, for instance through the 'import'
861 861 command or with Mercurial Queues extension.
862 862
863 863 ``eol``
864 864 When set to 'strict' patch content and patched files end of lines
865 865 are preserved. When set to ``lf`` or ``crlf``, both files end of
866 866 lines are ignored when patching and the result line endings are
867 867 normalized to either LF (Unix) or CRLF (Windows). When set to
868 868 ``auto``, end of lines are again ignored while patching but line
869 869 endings in patched files are normalized to their original setting
870 870 on a per-file basis. If target file does not exist or has no end
871 871 of line, patch line endings are preserved.
872 872 Default: strict.
873 873
874 874
875 875 ``paths``
876 876 """""""""
877 877
878 878 Assigns symbolic names to repositories. The left side is the
879 879 symbolic name, and the right gives the directory or URL that is the
880 880 location of the repository. Default paths can be declared by setting
881 881 the following entries.
882 882
883 883 ``default``
884 884 Directory or URL to use when pulling if no source is specified.
885 885 Default is set to repository from which the current repository was
886 886 cloned.
887 887
888 888 ``default-push``
889 889 Optional. Directory or URL to use when pushing if no destination
890 890 is specified.
891 891
892 892
893 893 ``profiling``
894 894 """""""""""""
895 895
896 896 Specifies profiling format and file output. In this section
897 897 description, 'profiling data' stands for the raw data collected
898 898 during profiling, while 'profiling report' stands for a statistical
899 899 text report generated from the profiling data. The profiling is done
900 900 using lsprof.
901 901
902 902 ``format``
903 903 Profiling format.
904 904 Default: text.
905 905
906 906 ``text``
907 907 Generate a profiling report. When saving to a file, it should be
908 908 noted that only the report is saved, and the profiling data is
909 909 not kept.
910 910 ``kcachegrind``
911 911 Format profiling data for kcachegrind use: when saving to a
912 912 file, the generated file can directly be loaded into
913 913 kcachegrind.
914 914
915 915 ``output``
916 916 File path where profiling data or report should be saved. If the
917 917 file exists, it is replaced. Default: None, data is printed on
918 918 stderr
919 919
920 920 ``revsetalias``
921 921 """""""""""""""
922 922
923 923 Alias definitions for revsets. See :hg:`help revsets` for details.
924 924
925 925 ``server``
926 926 """"""""""
927 927
928 928 Controls generic server settings.
929 929
930 930 ``uncompressed``
931 931 Whether to allow clients to clone a repository using the
932 932 uncompressed streaming protocol. This transfers about 40% more
933 933 data than a regular clone, but uses less memory and CPU on both
934 934 server and client. Over a LAN (100 Mbps or better) or a very fast
935 935 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
936 936 regular clone. Over most WAN connections (anything slower than
937 937 about 6 Mbps), uncompressed streaming is slower, because of the
938 938 extra data transfer overhead. This mode will also temporarily hold
939 939 the write lock while determining what data to transfer.
940 940 Default is True.
941 941
942 942 ``validate``
943 943 Whether to validate the completeness of pushed changesets by
944 944 checking that all new file revisions specified in manifests are
945 945 present. Default is False.
946 946
947 947 ``subpaths``
948 948 """"""""""""
949 949
950 950 Defines subrepositories source locations rewriting rules of the form::
951 951
952 952 <pattern> = <replacement>
953 953
954 954 Where ``pattern`` is a regular expression matching the source and
955 955 ``replacement`` is the replacement string used to rewrite it. Groups
956 956 can be matched in ``pattern`` and referenced in ``replacements``. For
957 957 instance::
958 958
959 959 http://server/(.*)-hg/ = http://hg.server/\1/
960 960
961 961 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
962 962
963 963 All patterns are applied in definition order.
964 964
965 965 ``trusted``
966 966 """""""""""
967 967
968 968 Mercurial will not use the settings in the
969 969 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
970 970 user or to a trusted group, as various hgrc features allow arbitrary
971 971 commands to be run. This issue is often encountered when configuring
972 972 hooks or extensions for shared repositories or servers. However,
973 973 the web interface will use some safe settings from the ``[web]``
974 974 section.
975 975
976 976 This section specifies what users and groups are trusted. The
977 977 current user is always trusted. To trust everybody, list a user or a
978 978 group with name ``*``. These settings must be placed in an
979 979 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
980 980 user or service running Mercurial.
981 981
982 982 ``users``
983 983 Comma-separated list of trusted users.
984 984
985 985 ``groups``
986 986 Comma-separated list of trusted groups.
987 987
988 988
989 989 ``ui``
990 990 """"""
991 991
992 992 User interface controls.
993 993
994 994 ``archivemeta``
995 995 Whether to include the .hg_archival.txt file containing meta data
996 996 (hashes for the repository base and for tip) in archives created
997 997 by the :hg:`archive` command or downloaded via hgweb.
998 998 Default is True.
999 999
1000 1000 ``askusername``
1001 1001 Whether to prompt for a username when committing. If True, and
1002 1002 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1003 1003 be prompted to enter a username. If no username is entered, the
1004 1004 default ``USER@HOST`` is used instead.
1005 1005 Default is False.
1006 1006
1007 1007 ``commitsubrepos``
1008 1008 Whether to commit modified subrepositories when committing the
1009 1009 parent repository. If False and one subrepository has uncommitted
1010 1010 changes, abort the commit.
1011 1011 Default is True.
1012 1012
1013 1013 ``debug``
1014 1014 Print debugging information. True or False. Default is False.
1015 1015
1016 1016 ``editor``
1017 1017 The editor to use during a commit. Default is ``$EDITOR`` or ``vi``.
1018 1018
1019 1019 ``fallbackencoding``
1020 1020 Encoding to try if it's not possible to decode the changelog using
1021 1021 UTF-8. Default is ISO-8859-1.
1022 1022
1023 1023 ``ignore``
1024 1024 A file to read per-user ignore patterns from. This file should be
1025 1025 in the same format as a repository-wide .hgignore file. This
1026 1026 option supports hook syntax, so if you want to specify multiple
1027 1027 ignore files, you can do so by setting something like
1028 1028 ``ignore.other = ~/.hgignore2``. For details of the ignore file
1029 1029 format, see the ``hgignore(5)`` man page.
1030 1030
1031 1031 ``interactive``
1032 1032 Allow to prompt the user. True or False. Default is True.
1033 1033
1034 1034 ``logtemplate``
1035 1035 Template string for commands that print changesets.
1036 1036
1037 1037 ``merge``
1038 1038 The conflict resolution program to use during a manual merge.
1039 1039 For more information on merge tools see :hg:`help merge-tools`.
1040 1040 For configuring merge tools see the ``[merge-tools]`` section.
1041 1041
1042 1042 ``portablefilenames``
1043 1043 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1044 1044 Default is ``warn``.
1045 1045 If set to ``warn`` (or ``true``), a warning message is printed on POSIX
1046 1046 platforms, if a file with a non-portable filename is added (e.g. a file
1047 1047 with a name that can't be created on Windows because it contains reserved
1048 1048 parts like ``AUX``, reserved characters like ``:``, or would cause a case
1049 1049 collision with an existing file).
1050 1050 If set to ``ignore`` (or ``false``), no warning is printed.
1051 1051 If set to ``abort``, the command is aborted.
1052 1052 On Windows, this configuration option is ignored and the command aborted.
1053 1053
1054 1054 ``quiet``
1055 1055 Reduce the amount of output printed. True or False. Default is False.
1056 1056
1057 1057 ``remotecmd``
1058 1058 remote command to use for clone/push/pull operations. Default is ``hg``.
1059 1059
1060 1060 ``report_untrusted``
1061 1061 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1062 1062 trusted user or group. True or False. Default is True.
1063 1063
1064 1064 ``slash``
1065 1065 Display paths using a slash (``/``) as the path separator. This
1066 1066 only makes a difference on systems where the default path
1067 1067 separator is not the slash character (e.g. Windows uses the
1068 1068 backslash character (``\``)).
1069 1069 Default is False.
1070 1070
1071 1071 ``ssh``
1072 1072 command to use for SSH connections. Default is ``ssh``.
1073 1073
1074 1074 ``strict``
1075 1075 Require exact command names, instead of allowing unambiguous
1076 1076 abbreviations. True or False. Default is False.
1077 1077
1078 1078 ``style``
1079 1079 Name of style to use for command output.
1080 1080
1081 1081 ``timeout``
1082 1082 The timeout used when a lock is held (in seconds), a negative value
1083 1083 means no timeout. Default is 600.
1084 1084
1085 1085 ``traceback``
1086 1086 Mercurial always prints a traceback when an unknown exception
1087 1087 occurs. Setting this to True will make Mercurial print a traceback
1088 1088 on all exceptions, even those recognized by Mercurial (such as
1089 1089 IOError or MemoryError). Default is False.
1090 1090
1091 1091 ``username``
1092 1092 The committer of a changeset created when running "commit".
1093 1093 Typically a person's name and email address, e.g. ``Fred Widget
1094 1094 <fred@example.com>``. Default is ``$EMAIL`` or ``username@hostname``. If
1095 1095 the username in hgrc is empty, it has to be specified manually or
1096 1096 in a different hgrc file (e.g. ``$HOME/.hgrc``, if the admin set
1097 1097 ``username =`` in the system hgrc). Environment variables in the
1098 1098 username are expanded.
1099 1099
1100 1100 ``verbose``
1101 1101 Increase the amount of output printed. True or False. Default is False.
1102 1102
1103 1103
1104 1104 ``web``
1105 1105 """""""
1106 1106
1107 1107 Web interface configuration. The settings in this section apply to
1108 1108 both the builtin webserver (started by :hg:`serve`) and the script you
1109 1109 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1110 1110 and WSGI).
1111 1111
1112 1112 The Mercurial webserver does no authentication (it does not prompt for
1113 1113 usernames and passwords to validate *who* users are), but it does do
1114 1114 authorization (it grants or denies access for *authenticated users*
1115 1115 based on settings in this section). You must either configure your
1116 1116 webserver to do authentication for you, or disable the authorization
1117 1117 checks.
1118 1118
1119 1119 For a quick setup in a trusted environment, e.g., a private LAN, where
1120 1120 you want it to accept pushes from anybody, you can use the following
1121 1121 command line::
1122 1122
1123 1123 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1124 1124
1125 1125 Note that this will allow anybody to push anything to the server and
1126 1126 that this should not be used for public servers.
1127 1127
1128 1128 The full set of options is:
1129 1129
1130 1130 ``accesslog``
1131 1131 Where to output the access log. Default is stdout.
1132 1132
1133 1133 ``address``
1134 1134 Interface address to bind to. Default is all.
1135 1135
1136 1136 ``allow_archive``
1137 1137 List of archive format (bz2, gz, zip) allowed for downloading.
1138 1138 Default is empty.
1139 1139
1140 1140 ``allowbz2``
1141 1141 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1142 1142 revisions.
1143 1143 Default is False.
1144 1144
1145 1145 ``allowgz``
1146 1146 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1147 1147 revisions.
1148 1148 Default is False.
1149 1149
1150 1150 ``allowpull``
1151 1151 Whether to allow pulling from the repository. Default is True.
1152 1152
1153 1153 ``allow_push``
1154 1154 Whether to allow pushing to the repository. If empty or not set,
1155 1155 push is not allowed. If the special value ``*``, any remote user can
1156 1156 push, including unauthenticated users. Otherwise, the remote user
1157 1157 must have been authenticated, and the authenticated user name must
1158 1158 be present in this list. The contents of the allow_push list are
1159 1159 examined after the deny_push list.
1160 1160
1161 1161 ``allow_read``
1162 1162 If the user has not already been denied repository access due to
1163 1163 the contents of deny_read, this list determines whether to grant
1164 1164 repository access to the user. If this list is not empty, and the
1165 1165 user is unauthenticated or not present in the list, then access is
1166 1166 denied for the user. If the list is empty or not set, then access
1167 1167 is permitted to all users by default. Setting allow_read to the
1168 1168 special value ``*`` is equivalent to it not being set (i.e. access
1169 1169 is permitted to all users). The contents of the allow_read list are
1170 1170 examined after the deny_read list.
1171 1171
1172 1172 ``allowzip``
1173 1173 (DEPRECATED) Whether to allow .zip downloading of repository
1174 1174 revisions. Default is False. This feature creates temporary files.
1175 1175
1176 1176 ``baseurl``
1177 1177 Base URL to use when publishing URLs in other locations, so
1178 1178 third-party tools like email notification hooks can construct
1179 1179 URLs. Example: ``http://hgserver/repos/``.
1180 1180
1181 1181 ``cacerts``
1182 1182 Path to file containing a list of PEM encoded certificate
1183 1183 authority certificates. Environment variables and ``~user``
1184 1184 constructs are expanded in the filename. If specified on the
1185 1185 client, then it will verify the identity of remote HTTPS servers
1186 1186 with these certificates. The form must be as follows::
1187 1187
1188 1188 -----BEGIN CERTIFICATE-----
1189 1189 ... (certificate in base64 PEM encoding) ...
1190 1190 -----END CERTIFICATE-----
1191 1191 -----BEGIN CERTIFICATE-----
1192 1192 ... (certificate in base64 PEM encoding) ...
1193 1193 -----END CERTIFICATE-----
1194 1194
1195 1195 This feature is only supported when using Python 2.6 or later. If you wish
1196 1196 to use it with earlier versions of Python, install the backported
1197 1197 version of the ssl library that is available from
1198 1198 ``http://pypi.python.org``.
1199 1199
1200 1200 You can use OpenSSL's CA certificate file if your platform has one.
1201 1201 On most Linux systems this will be ``/etc/ssl/certs/ca-certificates.crt``.
1202 1202 Otherwise you will have to generate this file manually.
1203 1203
1204 1204 To disable SSL verification temporarily, specify ``--insecure`` from
1205 1205 command line.
1206 1206
1207 1207 ``cache``
1208 1208 Whether to support caching in hgweb. Defaults to True.
1209 1209
1210 1210 ``contact``
1211 1211 Name or email address of the person in charge of the repository.
1212 1212 Defaults to ui.username or ``$EMAIL`` or "unknown" if unset or empty.
1213 1213
1214 1214 ``deny_push``
1215 1215 Whether to deny pushing to the repository. If empty or not set,
1216 1216 push is not denied. If the special value ``*``, all remote users are
1217 1217 denied push. Otherwise, unauthenticated users are all denied, and
1218 1218 any authenticated user name present in this list is also denied. The
1219 1219 contents of the deny_push list are examined before the allow_push list.
1220 1220
1221 1221 ``deny_read``
1222 1222 Whether to deny reading/viewing of the repository. If this list is
1223 1223 not empty, unauthenticated users are all denied, and any
1224 1224 authenticated user name present in this list is also denied access to
1225 1225 the repository. If set to the special value ``*``, all remote users
1226 1226 are denied access (rarely needed ;). If deny_read is empty or not set,
1227 1227 the determination of repository access depends on the presence and
1228 1228 content of the allow_read list (see description). If both
1229 1229 deny_read and allow_read are empty or not set, then access is
1230 1230 permitted to all users by default. If the repository is being
1231 1231 served via hgwebdir, denied users will not be able to see it in
1232 1232 the list of repositories. The contents of the deny_read list have
1233 1233 priority over (are examined before) the contents of the allow_read
1234 1234 list.
1235 1235
1236 1236 ``descend``
1237 1237 hgwebdir indexes will not descend into subdirectories. Only repositories
1238 1238 directly in the current path will be shown (other repositories are still
1239 1239 available from the index corresponding to their containing path).
1240 1240
1241 1241 ``description``
1242 1242 Textual description of the repository's purpose or contents.
1243 1243 Default is "unknown".
1244 1244
1245 1245 ``encoding``
1246 1246 Character encoding name. Default is the current locale charset.
1247 1247 Example: "UTF-8"
1248 1248
1249 1249 ``errorlog``
1250 1250 Where to output the error log. Default is stderr.
1251 1251
1252 1252 ``hidden``
1253 1253 Whether to hide the repository in the hgwebdir index.
1254 1254 Default is False.
1255 1255
1256 1256 ``ipv6``
1257 1257 Whether to use IPv6. Default is False.
1258 1258
1259 ``logoimg``
1260 File name of the logo image that some templates display on each page.
1261 The file name is relative to ``staticurl``. That is, the full path to
1262 the logo image is "staticurl/logoimg".
1263 If unset, ``hglogo.png`` will be used.
1264
1259 1265 ``logourl``
1260 1266 Base URL to use for logos. If unset, ``http://mercurial.selenic.com/``
1261 1267 will be used.
1262 1268
1263 1269 ``name``
1264 1270 Repository name to use in the web interface. Default is current
1265 1271 working directory.
1266 1272
1267 1273 ``maxchanges``
1268 1274 Maximum number of changes to list on the changelog. Default is 10.
1269 1275
1270 1276 ``maxfiles``
1271 1277 Maximum number of files to list per changeset. Default is 10.
1272 1278
1273 1279 ``port``
1274 1280 Port to listen on. Default is 8000.
1275 1281
1276 1282 ``prefix``
1277 1283 Prefix path to serve from. Default is '' (server root).
1278 1284
1279 1285 ``push_ssl``
1280 1286 Whether to require that inbound pushes be transported over SSL to
1281 1287 prevent password sniffing. Default is True.
1282 1288
1283 1289 ``staticurl``
1284 1290 Base URL to use for static files. If unset, static files (e.g. the
1285 1291 hgicon.png favicon) will be served by the CGI script itself. Use
1286 1292 this setting to serve them directly with the HTTP server.
1287 1293 Example: ``http://hgserver/static/``.
1288 1294
1289 1295 ``stripes``
1290 1296 How many lines a "zebra stripe" should span in multiline output.
1291 1297 Default is 1; set to 0 to disable.
1292 1298
1293 1299 ``style``
1294 1300 Which template map style to use.
1295 1301
1296 1302 ``templates``
1297 1303 Where to find the HTML templates. Default is install path.
General Comments 0
You need to be logged in to leave comments. Login now