1HGRC(5) Mercurial Manual HGRC(5)
2
6 hgrc - configuration files for Mercurial
7
9 The Mercurial system uses a set of configuration files to control as‐
10 pects of its behavior.
11
13 If you're having problems with your configuration, hg config --debug
14 can help you understand what is introducing a setting into your envi‐
15 ronment.
16 See hg help config.syntax and hg help config.files for information
18 about how and where to override things.
19
21 The configuration files use a simple ini-file format. A configuration
22 file consists of sections, led by a [section] header and followed by
23 name = value entries:
24 [ui]
26 username = Firstname Lastname <firstname.lastname@example.net>
27 verbose = True
28 The above entries will be referred to as ui.username and ui.verbose,
30 respectively. See hg help config.syntax.
31
33 Mercurial reads configuration data from several files, if they exist.
34 These files do not exist by default and you will have to create the ap‐
35 propriate configuration files yourself:
36 Local configuration is put into the per-repository <repo>/.hg/hgrc
38 file.
39 Global configuration like the username setting is typically put into:
41 • %USERPROFILE%\mercurial.ini (on Windows)
43 • $HOME/.hgrc (on Unix, Plan9)
45 The names of these files depend on the system on which Mercurial is in‐
47 stalled. *.rc files from a single directory are read in alphabetical
48 order, later ones overriding earlier ones. Where multiple paths are
49 given below, settings from earlier paths override later ones.
50 On Unix, the following files are consulted:
52 • <repo>/.hg/hgrc-not-shared (per-repository)
54 • <repo>/.hg/hgrc (per-repository)
56 • $HOME/.hgrc (per-user)
58 • ${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc (per-user)
60 • <install-root>/etc/mercurial/hgrc (per-installation)
62 • <install-root>/etc/mercurial/hgrc.d/*.rc (per-installation)
64 • /etc/mercurial/hgrc (per-system)
66 • /etc/mercurial/hgrc.d/*.rc (per-system)
68 • <internal>/*.rc (defaults)
70 On Windows, the following files are consulted:
72 • <repo>/.hg/hgrc-not-shared (per-repository)
74 • <repo>/.hg/hgrc (per-repository)
76 • %USERPROFILE%\.hgrc (per-user)
78 • %USERPROFILE%\Mercurial.ini (per-user)
80 • %HOME%\.hgrc (per-user)
82 • %HOME%\Mercurial.ini (per-user)
84 • HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial (per-system)
86 • <install-dir>\hgrc.d\*.rc (per-installation)
88 • <install-dir>\Mercurial.ini (per-installation)
90 • %PROGRAMDATA%\Mercurial\hgrc (per-system)
92 • %PROGRAMDATA%\Mercurial\Mercurial.ini (per-system)
94 • %PROGRAMDATA%\Mercurial\hgrc.d\*.rc (per-system)
96 • <internal>/*.rc (defaults)
98 Note The registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercu‐
100 rial is used when running 32-bit Python on 64-bit Windows.
101 On Plan9, the following files are consulted:
103 • <repo>/.hg/hgrc-not-shared (per-repository)
105 • <repo>/.hg/hgrc (per-repository)
107 • $home/lib/hgrc (per-user)
109 • <install-root>/lib/mercurial/hgrc (per-installation)
111 • <install-root>/lib/mercurial/hgrc.d/*.rc (per-installation)
113 • /lib/mercurial/hgrc (per-system)
115 • /lib/mercurial/hgrc.d/*.rc (per-system)
117 • <internal>/*.rc (defaults)
119 Per-repository configuration options only apply in a particular reposi‐
121 tory. This file is not version-controlled, and will not get transferred
122 during a "clone" operation. Options in this file override options in
123 all other configuration files.
124 On Plan 9 and Unix, most of this file will be ignored if it doesn't be‐
126 long to a trusted user or to a trusted group. See hg help config.trust‐
127 ed for more details.
128 Per-user configuration file(s) are for the user running Mercurial. Op‐
130 tions in these files apply to all Mercurial commands executed by this
131 user in any directory. Options in these files override per-system and
132 per-installation options.
133 Per-installation configuration files are searched for in the directory
135 where Mercurial is installed. <install-root> is the parent directory of
136 the hg executable (or symlink) being run.
137 For example, if installed in /shared/tools/bin/hg, Mercurial will look
139 in /shared/tools/etc/mercurial/hgrc. Options in these files apply to
140 all Mercurial commands executed by any user in any directory.
141 Per-installation configuration files are for the system on which Mercu‐
143 rial is running. Options in these files apply to all Mercurial commands
144 executed by any user in any directory. Registry keys contain PATH-like
145 strings, every part of which must reference a Mercurial.ini file or be
146 a directory where *.rc files will be read. Mercurial checks each of
147 these locations in the specified order until one or more configuration
148 files are detected.
149 Per-system configuration files are for the system on which Mercurial is
151 running. Options in these files apply to all Mercurial commands exe‐
152 cuted by any user in any directory. Options in these files override
153 per-installation options.
154 Mercurial comes with some default configuration. The default configura‐
156 tion files are installed with Mercurial and will be overwritten on up‐
157 grades. Default configuration files should never be edited by users or
158 administrators but can be overridden in other configuration files. So
159 far the directory only contains merge tool configuration but packagers
160 can also put other default configuration there.
161 On versions 5.7 and later, if share-safe functionality is enabled,
163 shares will read config file of share source too.
164 <share-source/.hg/hgrc> is read before reading <repo/.hg/hgrc>.
165 For configs which should not be shared, <repo/.hg/hgrc-not-shared>
167 should be used.
168
170 A configuration file consists of sections, led by a [section] header
171 and followed by name = value entries (sometimes called configuration
172 keys):
173 [spam]
175 eggs=ham
176 green=
177 eggs
178 Each line contains one entry. If the lines that follow are indented,
180 they are treated as continuations of that entry. Leading whitespace is
181 removed from values. Empty lines are skipped. Lines beginning with # or
182 ; are ignored and may be used to provide comments.
183 Configuration keys can be set multiple times, in which case Mercurial
185 will use the value that was configured last. As an example:
186 [spam]
188 eggs=large
189 ham=serrano
190 eggs=small
191 This would set the configuration key named eggs to small.
193 It is also possible to define a section multiple times. A section can
195 be redefined on the same and/or on different configuration files. For
196 example:
197 [foo]
199 eggs=large
200 ham=serrano
201 eggs=small
202 [bar]
204 eggs=ham
205 green=
206 eggs
207 [foo]
209 ham=prosciutto
210 eggs=medium
211 bread=toasted
212 This would set the eggs, ham, and bread configuration keys of the foo
214 section to medium, prosciutto, and toasted, respectively. As you can
215 see there only thing that matters is the last value that was set for
216 each of the configuration keys.
217 If a configuration key is set multiple times in different configuration
219 files the final value will depend on the order in which the different
220 configuration files are read, with settings from earlier paths overrid‐
221 ing later ones as described on the Files section above.
222 A line of the form %include file will include file into the current
224 configuration file. The inclusion is recursive, which means that in‐
225 cluded files can include other files. Filenames are relative to the
226 configuration file in which the %include directive is found. Environ‐
227 ment variables and ~user constructs are expanded in file. This lets you
228 do something like:
229 %include ~/.hgrc.d/$HOST.rc
231 to include a different configuration file on each computer you use.
233 A line with %unset name will remove name from the current section, if
235 it has been set previously.
236 The values are either free-form text strings, lists of text strings, or
238 Boolean values. Boolean values can be set to true using any of "1",
239 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
240 (all case insensitive).
241 List values are separated by whitespace or comma, except when values
243 are placed in double quotation marks:
244 allow_read = "John Doe, PhD", brian, betty
246 Quotation marks can be escaped by prefixing them with a backslash. Only
248 quotation marks at the beginning of a word is counted as a quotation
249 (e.g., foo"bar baz is the list of foo"bar and baz).
250
252 This section describes the different sections that may appear in a Mer‐
253 curial configuration file, the purpose of each section, its possible
254 keys, and their possible values.
255 alias
257 Defines command aliases.
258 Aliases allow you to define your own commands in terms of other com‐
260 mands (or aliases), optionally including arguments. Positional argu‐
261 ments in the form of $1, $2, etc. in the alias definition are expanded
262 by Mercurial before execution. Positional arguments not already used by
263 $N in the definition are put at the end of the command to be executed.
264 Alias definitions consist of lines of the form:
266 <alias> = <command> [<argument>]...
268 For example, this definition:
270 latest = log --limit 5
272 creates a new command latest that shows only the five most recent
274 changesets. You can define subsequent aliases using earlier ones:
275 stable5 = latest -b stable
277 Note It is possible to create aliases with the same names as existing
279 commands, which will then override the original definitions.
280 This is almost always a bad idea!
281 An alias can start with an exclamation point (!) to make it a shell
283 alias. A shell alias is executed with the shell and will let you run
284 arbitrary commands. As an example,
285 echo = !echo $@
287 will let you do hg echo foo to have foo printed in your terminal. A
289 better example might be:
290 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
292 which will make hg purge delete all unknown files in the repository in
294 the same manner as the purge extension.
295 Positional arguments like $1, $2, etc. in the alias definition expand
297 to the command arguments. Unmatched arguments are removed. $0 expands
298 to the alias name and $@ expands to all arguments separated by a space.
299 "$@" (with quotes) expands to all arguments quoted individually and
300 separated by a space. These expansions happen before the command is
301 passed to the shell.
302 Shell aliases are executed in an environment where $HG expands to the
304 path of the Mercurial that was used to execute the alias. This is use‐
305 ful when you want to call further Mercurial commands in a shell alias,
306 as was done above for the purge alias. In addition, $HG_ARGS expands to
307 the arguments given to Mercurial. In the hg echo foo call above,
308 $HG_ARGS would expand to echo foo.
309 Note Some global configuration options such as -R are processed be‐
311 fore shell aliases and will thus not be passed to aliases.
312 annotate
314 Settings used when displaying file annotations. All values are Booleans
315 and default to False. See hg help config.diff for related options for
316 the diff command.
317 ignorews
319 Ignore white space when comparing lines.
321 ignorewseol
323 Ignore white space at the end of a line when comparing lines.
325 ignorewsamount
327 Ignore changes in the amount of white space.
329 ignoreblanklines
331 Ignore changes whose lines are all blank.
333 auth
335 Authentication credentials and other authentication-like configuration
336 for HTTP connections. This section allows you to store usernames and
337 passwords for use when logging into HTTP servers. See hg help con‐
338 fig.web if you want to configure who can login to your HTTP server.
339 The following options apply to all hosts.
341 cookiefile
343 Path to a file containing HTTP cookie lines. Cookies matching a
345 host will be sent automatically.
346 The file format uses the Mozilla cookies.txt format, which de‐
348 fines cookies on their own lines. Each line contains 7 fields
349 delimited by the tab character (domain, is_domain_cookie, path,
350 is_secure, expires, name, value). For more info, do an Internet
351 search for "Netscape cookies.txt format."
352 Note: the cookies parser does not handle port numbers on do‐
354 mains. You will need to remove ports from the domain for the
355 cookie to be recognized. This could result in a cookie being
356 disclosed to an unwanted server.
357 The cookies file is read-only.
359 Other options in this section are grouped by name and have the follow‐
361 ing format:
362 <name>.<argument> = <value>
364 where <name> is used to group arguments into authentication entries.
366 Example:
367 foo.prefix = hg.intevation.de/mercurial
369 foo.username = foo
370 foo.password = bar
371 foo.schemes = http https
372 bar.prefix = secure.example.org
374 bar.key = path/to/file.key
375 bar.cert = path/to/file.cert
376 bar.schemes = https
377 Supported arguments:
379 prefix
381 Either * or a URI prefix with or without the scheme part. The
383 authentication entry with the longest matching prefix is used
384 (where * matches everything and counts as a match of length 1).
385 If the prefix doesn't include a scheme, the match is performed
386 against the URI with its scheme stripped as well, and the
387 schemes argument, q.v., is then subsequently consulted.
388 username
390 Optional. Username to authenticate with. If not given, and the
392 remote site requires basic or digest authentication, the user
393 will be prompted for it. Environment variables are expanded in
394 the username letting you do foo.username = $USER. If the URI in‐
395 cludes a username, only [auth] entries with a matching username
396 or without a username will be considered.
397 password
399 Optional. Password to authenticate with. If not given, and the
401 remote site requires basic or digest authentication, the user
402 will be prompted for it.
403 key
405 Optional. PEM encoded client certificate key file. Environment
407 variables are expanded in the filename.
408 cert
410 Optional. PEM encoded client certificate chain file. Environment
412 variables are expanded in the filename.
413 schemes
415 Optional. Space separated list of URI schemes to use this au‐
417 thentication entry with. Only used if the prefix doesn't include
418 a scheme. Supported schemes are http and https. They will match
419 static-http and static-https respectively, as well. (default:
420 https)
421 If no suitable authentication entry is found, the user is prompted for
423 credentials as usual if required by the remote.
424 cmdserver
426 Controls command server settings. (ADVANCED)
427 message-encodings
429 List of encodings for the m (message) channel. The first encod‐
431 ing supported by the server will be selected and advertised in
432 the hello message. This is useful only when ui.message-output is
433 set to channel. Supported encodings are cbor.
434 shutdown-on-interrupt
436 If set to false, the server's main loop will continue running
438 after SIGINT received. runcommand requests can still be inter‐
439 rupted by SIGINT. Close the write end of the pipe to shut down
440 the server process gracefully. (default: True)
441 color
443 Configure the Mercurial color mode. For details about how to define
444 your custom effect and style see hg help color.
445 mode
447 String: control the method used to output color. One of auto,
449 ansi, win32, terminfo or debug. In auto mode, Mercurial will use
450 ANSI mode by default (or win32 mode prior to Windows 10) if it
451 detects a terminal. Any invalid value will disable color.
452 pagermode
454 String: optional override of color.mode used with pager.
456 On some systems, terminfo mode may cause problems when using
458 color with less -R as a pager program. less with the -R option
459 will only display ECMA-48 color codes, and terminfo mode may
460 sometimes emit codes that less doesn't understand. You can work
461 around this by either using ansi mode (or auto mode), or by us‐
462 ing less -r (which will pass through all terminal control codes,
463 not just color control codes).
464 On some systems (such as MSYS in Windows), the terminal may sup‐
466 port a different color mode than the pager program.
467 commands
469 commit.post-status
470 Show status of files in the working directory after successful
472 commit. (default: False)
473 merge.require-rev
475 Require that the revision to merge the current commit with be
477 specified on the command line. If this is enabled and a revision
478 is not specified, the command aborts. (default: False)
479 push.require-revs
481 Require revisions to push be specified using one or more mecha‐
483 nisms such as specifying them positionally on the command line,
484 using -r, -b, and/or -B on the command line, or using
485 paths.<path>:pushrev in the configuration. If this is enabled
486 and revisions are not specified, the command aborts. (default:
487 False)
488 resolve.confirm
490 Confirm before performing action if no filename is passed. (de‐
492 fault: False)
493 resolve.explicit-re-merge
495 Require uses of hg resolve to specify which action it should
497 perform, instead of re-merging files by default. (default:
498 False)
499 resolve.mark-check
501 Determines what level of checking hg resolve --mark will perform
503 before marking files as resolved. Valid values are none`,
504 ``warn, and abort. warn will output a warning listing the
505 file(s) that still have conflict markers in them, but will still
506 mark everything resolved. abort will output the same warning
507 but will not mark things as resolved. If --all is passed and
508 this is set to abort, only a warning will be shown (an error
509 will not be raised). (default: none)
510 status.relative
512 Make paths in hg status output relative to the current direc‐
514 tory. (default: False)
515 status.terse
517 Default value for the --terse flag, which condenses status out‐
519 put. (default: empty)
520 update.check
522 Determines what level of checking hg update will perform before
524 moving to a destination revision. Valid values are abort, none,
525 linear, and noconflict. abort always fails if the working direc‐
526 tory has uncommitted changes. none performs no checking, and may
527 result in a merge with uncommitted changes. linear allows any
528 update as long as it follows a straight line in the revision
529 history, and may trigger a merge with uncommitted changes. no‐
530 conflict will allow any update which would not trigger a merge
531 with uncommitted changes, if any are present. (default: linear)
532 update.requiredest
534 Require that the user pass a destination when running hg update.
536 For example, hg update .:: will be allowed, but a plain hg up‐
537 date will be disallowed. (default: False)
538 committemplate
540 changeset
541 String: configuration in this section is used as the template to
543 customize the text shown in the editor when committing.
544 In addition to pre-defined template keywords, commit log specific one
546 below can be used for customization:
547 extramsg
549 String: Extra message (typically 'Leave message empty to abort
551 commit.'). This may be changed by some commands or extensions.
552 For example, the template configuration below shows as same text as one
554 shown by default:
555 [committemplate]
557 changeset = {desc}\n\n
558 HG: Enter commit message. Lines beginning with 'HG:' are removed.
559 HG: {extramsg}
560 HG: --
561 HG: user: {author}\n{ifeq(p2rev, "-1", "",
562 "HG: branch merge\n")
563 }HG: branch '{branch}'\n{if(activebookmark,
564 "HG: bookmark '{activebookmark}'\n") }{subrepos %
565 "HG: subrepo {subrepo}\n" }{file_adds %
566 "HG: added {file}\n" }{file_mods %
567 "HG: changed {file}\n" }{file_dels %
568 "HG: removed {file}\n" }{if(files, "",
569 "HG: no files changed\n")}
570 diff()
572 String: show the diff (see hg help templates for detail)
574 Sometimes it is helpful to show the diff of the changeset in the editor
576 without having to prefix 'HG: ' to each line so that highlighting works
577 correctly. For this, Mercurial provides a special string which will ig‐
578 nore everything below it:
579 HG: ------------------------ >8 ------------------------
581 For example, the template configuration below will show the diff below
583 the extra message:
584 [committemplate]
586 changeset = {desc}\n\n
587 HG: Enter commit message. Lines beginning with 'HG:' are removed.
588 HG: {extramsg}
589 HG: ------------------------ >8 ------------------------
590 HG: Do not touch the line above.
591 HG: Everything below will be removed.
592 {diff()}
593 Note For some problematic encodings (see hg help win32mbcs for de‐
595 tail), this customization should be configured carefully, to
596 avoid showing broken characters.
597 For example, if a multibyte character ending with backslash
599 (0x5c) is followed by the ASCII character 'n' in the customized
600 template, the sequence of backslash and 'n' is treated as
601 line-feed unexpectedly (and the multibyte character is broken,
602 too).
603 Customized template is used for commands below (--edit may be re‐
605 quired):
606 • hg backout
608 • hg commit
610 • hg fetch (for merge commit only)
612 • hg graft
614 • hg histedit
616 • hg import
618 • hg qfold, hg qnew and hg qrefresh
620 • hg rebase
622 • hg shelve
624 • hg sign
626 • hg tag
628 • hg transplant
630 Configuring items below instead of changeset allows showing customized
632 message only for specific actions, or showing different messages for
633 each action.
634 • changeset.backout for hg backout
636 • changeset.commit.amend.merge for hg commit --amend on merges
638 • changeset.commit.amend.normal for hg commit --amend on other
640 • changeset.commit.normal.merge for hg commit on merges
642 • changeset.commit.normal.normal for hg commit on other
644 • changeset.fetch for hg fetch (impling merge commit)
646 • changeset.gpg.sign for hg sign
648 • changeset.graft for hg graft
650 • changeset.histedit.edit for edit of hg histedit
652 • changeset.histedit.fold for fold of hg histedit
654 • changeset.histedit.mess for mess of hg histedit
656 • changeset.histedit.pick for pick of hg histedit
658 • changeset.import.bypass for hg import --bypass
660 • changeset.import.normal.merge for hg import on merges
662 • changeset.import.normal.normal for hg import on other
664 • changeset.mq.qnew for hg qnew
666 • changeset.mq.qfold for hg qfold
668 • changeset.mq.qrefresh for hg qrefresh
670 • changeset.rebase.collapse for hg rebase --collapse
672 • changeset.rebase.merge for hg rebase on merges
674 • changeset.rebase.normal for hg rebase on other
676 • changeset.shelve.shelve for hg shelve
678 • changeset.tag.add for hg tag without --remove
680 • changeset.tag.remove for hg tag --remove
682 • changeset.transplant.merge for hg transplant on merges
684 • changeset.transplant.normal for hg transplant on other
686 These dot-separated lists of names are treated as hierarchical ones.
688 For example, changeset.tag.remove customizes the commit message only
689 for hg tag --remove, but changeset.tag customizes the commit message
690 for hg tag regardless of --remove option.
691 When the external editor is invoked for a commit, the corresponding
693 dot-separated list of names without the changeset. prefix (e.g. com‐
694 mit.normal.normal) is in the HGEDITFORM environment variable.
695 In this section, items other than changeset can be referred from oth‐
697 ers. For example, the configuration to list committed files up below
698 can be referred as {listupfiles}:
699 [committemplate]
701 listupfiles = {file_adds %
702 "HG: added {file}\n" }{file_mods %
703 "HG: changed {file}\n" }{file_dels %
704 "HG: removed {file}\n" }{if(files, "",
705 "HG: no files changed\n")}
706 decode/encode
708 Filters for transforming files on checkout/checkin. This would typi‐
709 cally be used for newline processing or other localization/canonical‐
710 ization of files.
711 Filters consist of a filter pattern followed by a filter command. Fil‐
713 ter patterns are globs by default, rooted at the repository root. For
714 example, to match any file ending in .txt in the root directory only,
715 use the pattern *.txt. To match any file ending in .c anywhere in the
716 repository, use the pattern **.c. For each file only the first match‐
717 ing filter applies.
718 The filter command can start with a specifier, either pipe: or temp‐
720 file:. If no specifier is given, pipe: is used by default.
721 A pipe: command must accept data on stdin and return the transformed
723 data on stdout.
724 Pipe example:
726 [encode]
728 # uncompress gzip files on checkin to improve delta compression
729 # note: not necessarily a good idea, just an example
730 *.gz = pipe: gunzip
731 [decode]
733 # recompress gzip files when writing them to the working dir (we
734 # can safely omit "pipe:", because it's the default)
735 *.gz = gzip
736 A tempfile: command is a template. The string INFILE is replaced with
738 the name of a temporary file that contains the data to be filtered by
739 the command. The string OUTFILE is replaced with the name of an empty
740 temporary file, where the filtered data must be written by the command.
741 Note The tempfile mechanism is recommended for Windows systems, where
743 the standard shell I/O redirection operators often have strange
744 effects and may corrupt the contents of your files.
745 This filter mechanism is used internally by the eol extension to trans‐
747 late line ending characters between Windows (CRLF) and Unix (LF) for‐
748 mat. We suggest you use the eol extension for convenience.
749 defaults
751 (defaults are deprecated. Don't use them. Use aliases instead.)
752 Use the [defaults] section to define command defaults, i.e. the default
754 options/arguments to pass to the specified commands.
755 The following example makes hg log run in verbose mode, and hg status
757 show only the modified files, by default:
758 [defaults]
760 log = -v
761 status = -m
762 The actual commands, instead of their aliases, must be used when defin‐
764 ing command defaults. The command defaults will also be applied to the
765 aliases of the commands defined.
766 diff
768 Settings used when displaying diffs. Everything except for unified is a
769 Boolean and defaults to False. See hg help config.annotate for related
770 options for the annotate command.
771 git
773 Use git extended diff format.
775 nobinary
777 Omit git binary patches.
779 nodates
781 Don't include dates in diff headers.
783 noprefix
785 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain
787 mode.
788 showfunc
790 Show which function each change is in.
792 ignorews
794 Ignore white space when comparing lines.
796 ignorewsamount
798 Ignore changes in the amount of white space.
800 ignoreblanklines
802 Ignore changes whose lines are all blank.
804 unified
806 Number of lines of context to show.
808 word-diff
810 Highlight changed words.
812 email
814 Settings for extensions that send email messages.
815 from
817 Optional. Email address to use in "From" header and SMTP enve‐
819 lope of outgoing messages.
820 to
822 Optional. Comma-separated list of recipients' email addresses.
824 cc
826 Optional. Comma-separated list of carbon copy recipients' email
828 addresses.
829 bcc
831 Optional. Comma-separated list of blind carbon copy recipients'
833 email addresses.
834 method
836 Optional. Method to use to send email messages. If value is smtp
838 (default), use SMTP (see the [smtp] section for configuration).
839 Otherwise, use as name of program to run that acts like sendmail
840 (takes -f option for sender, list of recipients on command line,
841 message on stdin). Normally, setting this to sendmail or
842 /usr/sbin/sendmail is enough to use sendmail to send messages.
843 charsets
845 Optional. Comma-separated list of character sets considered con‐
847 venient for recipients. Addresses, headers, and parts not con‐
848 taining patches of outgoing messages will be encoded in the
849 first character set to which conversion from local encoding
850 ($HGENCODING, ui.fallbackencoding) succeeds. If correct conver‐
851 sion fails, the text in question is sent as is. (default: '')
852 Order of outgoing email character sets:
854 1. us-ascii: always first, regardless of settings
856 2. email.charsets: in order given by user
858 3. ui.fallbackencoding: if not in email.charsets
860 4. $HGENCODING: if not in email.charsets
862 5. utf-8: always last, regardless of settings
864 Email example:
866 [email]
868 from = Joseph User <joe.user@example.com>
869 method = /usr/sbin/sendmail
870 # charsets for western Europeans
871 # us-ascii, utf-8 omitted, as they are tried first and last
872 charsets = iso-8859-1, iso-8859-15, windows-1252
873 extensions
875 Mercurial has an extension mechanism for adding new features. To enable
876 an extension, create an entry for it in this section.
877 If you know that the extension is already in Python's search path, you
879 can give the name of the module, followed by =, with nothing after the
880 =.
881 Otherwise, give a name that you choose, followed by =, followed by the
883 path to the .py file (including the file name extension) that defines
884 the extension.
885 To explicitly disable an extension that is enabled in an hgrc of
887 broader scope, prepend its path with !, as in foo = !/ext/path or foo =
888 ! when path is not supplied.
889 Example for ~/.hgrc:
891 [extensions]
893 # (the churn extension will get loaded from Mercurial's path)
894 churn =
895 # (this extension will get loaded from the file specified)
896 myfeature = ~/.hgext/myfeature.py
897 format
899 Configuration that controls the repository format. Newer format options
900 are more powerful, but incompatible with some older versions of Mercu‐
901 rial. Format options are considered at repository initialization only.
902 You need to make a new clone for config changes to be taken into ac‐
903 count.
904 For more details about repository format and version compatibility, see
906 https://www.mercurial-scm.org/wiki/MissingRequirement
907 usegeneraldelta
909 Enable or disable the "generaldelta" repository format which im‐
911 proves repository compression by allowing "revlog" to store
912 deltas against arbitrary revisions instead of the previously
913 stored one. This provides significant improvement for reposito‐
914 ries with branches.
915 Repositories with this on-disk format require Mercurial version
917 1.9.
918 Enabled by default.
920 dotencode
922 Enable or disable the "dotencode" repository format which en‐
924 hances the "fncache" repository format (which has to be enabled
925 to use dotencode) to avoid issues with filenames starting with
926 "._" on Mac OS X and spaces on Windows.
927 Repositories with this on-disk format require Mercurial version
929 1.7.
930 Enabled by default.
932 usefncache
934 Enable or disable the "fncache" repository format which enhances
936 the "store" repository format (which has to be enabled to use
937 fncache) to allow longer filenames and avoids using Windows re‐
938 served names, e.g. "nul".
939 Repositories with this on-disk format require Mercurial version
941 1.1.
942 Enabled by default.
944 use-persistent-nodemap
946 Enable or disable the "persistent-nodemap" feature which im‐
948 proves performance if the rust extensions are available.
949 The "persistence-nodemap" persist the "node -> rev" on disk re‐
951 moving the need to dynamically build that mapping for each Mer‐
952 curial invocation. This significantly reduce the startup cost of
953 various local and server-side operation for larger repository.
954 The performance improving version of this feature is currently
956 only implemented in Rust, so people not using a version of Mer‐
957 curial compiled with the Rust part might actually suffer some
958 slowdown. For this reason, Such version will by default refuse
959 to access such repositories. That behavior can be controlled by
960 configuration. Check hg help config.storage.revlog.persis‐
961 tent-nodemap.slowpath for details.
962 Repository with this on-disk format require Mercurial version
964 5.4 or above.
965 Disabled by default.
967 use-share-safe
969 Enforce "safe" behaviors for all "shares" that access this
971 repository.
972 With this feature, "shares" using this repository as a source
974 will:
975 • read the source repository's configuration
977 (<source>/.hg/hgrc).
978 • read and use the source repository's "requirements" (except
980 the working copy specific one).
981 Without this feature, "shares" using this repository as a source
983 will:
984 • keep tracking the repository "requirements" in the share only,
986 ignoring the source "requirements", possibly diverging from
987 them.
988 • ignore source repository config. This can create problems,
990 like silently ignoring important hooks.
991 Beware that existing shares will not be upgraded/downgraded, and
993 by default, Mercurial will refuse to interact with them until
994 the mismatch is resolved. See hg help config share.safe-mis‐
995 match.source-safe and hg help config share.safe-mis‐
996 match.source-not-safe for details.
997 Introduced in Mercurial 5.7.
999 Disabled by default.
1001 usestore
1003 Enable or disable the "store" repository format which improves
1005 compatibility with systems that fold case or otherwise mangle
1006 filenames. Disabling this option will allow you to store longer
1007 filenames in some situations at the expense of compatibility.
1008 Repositories with this on-disk format require Mercurial version
1010 0.9.4.
1011 Enabled by default.
1013 sparse-revlog
1015 Enable or disable the sparse-revlog delta strategy. This format
1017 improves delta re-use inside revlog. For very branchy reposito‐
1018 ries, it results in a smaller store. For repositories with many
1019 revisions, it also helps performance (by using shortened delta
1020 chains.)
1021 Repositories with this on-disk format require Mercurial version
1023 4.7
1024 Enabled by default.
1026 revlog-compression
1028 Compression algorithm used by revlog. Supported values are zlib
1030 and zstd. The zlib engine is the historical default of Mercu‐
1031 rial. zstd is a newer format that is usually a net win over
1032 zlib, operating faster at better compression rates. Use zstd to
1033 reduce CPU usage. Multiple values can be specified, the first
1034 available one will be used.
1035 On some systems, the Mercurial installation may lack zstd sup‐
1037 port.
1038 Default is zlib.
1040 bookmarks-in-store
1042 Store bookmarks in .hg/store/. This means that bookmarks are
1044 shared when using hg share regardless of the -B option.
1045 Repositories with this on-disk format require Mercurial version
1047 5.1.
1048 Disabled by default.
1050 graph
1052 Web graph view configuration. This section let you change graph ele‐
1053 ments display properties by branches, for instance to make the default
1054 branch stand out.
1055 Each line has the following format:
1057 <branch>.<argument> = <value>
1059 where <branch> is the name of the branch being customized. Example:
1061 [graph]
1063 # 2px width
1064 default.width = 2
1065 # red color
1066 default.color = FF0000
1067 Supported arguments:
1069 width
1071 Set branch edges width in pixels.
1073 color
1075 Set branch edges color in hexadecimal RGB notation.
1077 hooks
1079 Commands or Python functions that get automatically executed by various
1080 actions such as starting or finishing a commit. Multiple hooks can be
1081 run for the same action by appending a suffix to the action. Overriding
1082 a site-wide hook can be done by changing its value or setting it to an
1083 empty string. Hooks can be prioritized by adding a prefix of priority.
1084 to the hook name on a new line and setting the priority. The default
1085 priority is 0.
1086 Example .hg/hgrc:
1088 [hooks]
1090 # update working directory after adding changesets
1091 changegroup.update = hg update
1092 # do not use the site-wide hook
1093 incoming =
1094 incoming.email = /my/email/hook
1095 incoming.autobuild = /my/build/hook
1096 # force autobuild hook to run before other incoming hooks
1097 priority.incoming.autobuild = 1
1098 ### control HGPLAIN setting when running autobuild hook
1099 # HGPLAIN always set (default from Mercurial 5.7)
1100 incoming.autobuild:run-with-plain = yes
1101 # HGPLAIN never set
1102 incoming.autobuild:run-with-plain = no
1103 # HGPLAIN inherited from environment (default before Mercurial 5.7)
1104 incoming.autobuild:run-with-plain = auto
1105 Most hooks are run with environment variables set that give useful ad‐
1107 ditional information. For each hook below, the environment variables it
1108 is passed are listed with names in the form $HG_foo. The $HG_HOOKTYPE
1109 and $HG_HOOKNAME variables are set for all hooks. They contain the
1110 type of hook which triggered the run and the full name of the hook in
1111 the config, respectively. In the example above, this will be $HG_HOOK‐
1112 TYPE=incoming and $HG_HOOKNAME=incoming.email.
1113 Some basic Unix syntax can be enabled for portability, including $VAR
1115 and ${VAR} style variables. A ~ followed by \ or / will be expanded to
1116 %USERPROFILE% to simulate a subset of tilde expansion on Unix. To use
1117 a literal $ or ~, it must be escaped with a back slash or inside of a
1118 strong quote. Strong quotes will be replaced by double quotes after
1119 processing.
1120 This feature is enabled by adding a prefix of tonative. to the hook
1122 name on a new line, and setting it to True. For example:
1123 [hooks]
1125 incoming.autobuild = /my/build/hook
1126 # enable translation to cmd.exe syntax for autobuild hook
1127 tonative.incoming.autobuild = True
1128 changegroup
1130 Run after a changegroup has been added via push, pull or unbun‐
1132 dle. The ID of the first new changeset is in $HG_NODE and last
1133 is in $HG_NODE_LAST. The URL from which changes came is in
1134 $HG_URL.
1135 commit
1137 Run after a changeset has been created in the local repository.
1139 The ID of the newly created changeset is in $HG_NODE. Parent
1140 changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
1141 incoming
1143 Run after a changeset has been pulled, pushed, or unbundled into
1145 the local repository. The ID of the newly arrived changeset is
1146 in $HG_NODE. The URL that was source of the changes is in
1147 $HG_URL.
1148 outgoing
1150 Run after sending changes from the local repository to another.
1152 The ID of first changeset sent is in $HG_NODE. The source of op‐
1153 eration is in $HG_SOURCE. Also see hg help config.hooks.preout‐
1154 going.
1155 post-<command>
1157 Run after successful invocations of the associated command. The
1159 contents of the command line are passed as $HG_ARGS and the re‐
1160 sult code in $HG_RESULT. Parsed command line arguments are
1161 passed as $HG_PATS and $HG_OPTS. These contain string represen‐
1162 tations of the python data internally passed to <command>.
1163 $HG_OPTS is a dictionary of options (with unspecified options
1164 set to their defaults). $HG_PATS is a list of arguments. Hook
1165 failure is ignored.
1166 fail-<command>
1168 Run after a failed invocation of an associated command. The con‐
1170 tents of the command line are passed as $HG_ARGS. Parsed command
1171 line arguments are passed as $HG_PATS and $HG_OPTS. These con‐
1172 tain string representations of the python data internally passed
1173 to <command>. $HG_OPTS is a dictionary of options (with unspeci‐
1174 fied options set to their defaults). $HG_PATS is a list of argu‐
1175 ments. Hook failure is ignored.
1176 pre-<command>
1178 Run before executing the associated command. The contents of the
1180 command line are passed as $HG_ARGS. Parsed command line argu‐
1181 ments are passed as $HG_PATS and $HG_OPTS. These contain string
1182 representations of the data internally passed to <command>.
1183 $HG_OPTS is a dictionary of options (with unspecified options
1184 set to their defaults). $HG_PATS is a list of arguments. If the
1185 hook returns failure, the command doesn't execute and Mercurial
1186 returns the failure code.
1187 prechangegroup
1189 Run before a changegroup is added via push, pull or unbundle.
1191 Exit status 0 allows the changegroup to proceed. A non-zero sta‐
1192 tus will cause the push, pull or unbundle to fail. The URL from
1193 which changes will come is in $HG_URL.
1194 precommit
1196 Run before starting a local commit. Exit status 0 allows the
1198 commit to proceed. A non-zero status will cause the commit to
1199 fail. Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
1200 prelistkeys
1202 Run before listing pushkeys (like bookmarks) in the repository.
1204 A non-zero status will cause failure. The key namespace is in
1205 $HG_NAMESPACE.
1206 preoutgoing
1208 Run before collecting changes to send from the local repository
1210 to another. A non-zero status will cause failure. This lets you
1211 prevent pull over HTTP or SSH. It can also prevent propagating
1212 commits (via local pull, push (outbound) or bundle commands),
1213 but not completely, since you can just copy files instead. The
1214 source of operation is in $HG_SOURCE. If "serve", the operation
1215 is happening on behalf of a remote SSH or HTTP repository. If
1216 "push", "pull" or "bundle", the operation is happening on behalf
1217 of a repository on same system.
1218 prepushkey
1220 Run before a pushkey (like a bookmark) is added to the reposi‐
1222 tory. A non-zero status will cause the key to be rejected. The
1223 key namespace is in $HG_NAMESPACE, the key is in $HG_KEY, the
1224 old value (if any) is in $HG_OLD, and the new value is in
1225 $HG_NEW.
1226 pretag
1228 Run before creating a tag. Exit status 0 allows the tag to be
1230 created. A non-zero status will cause the tag to fail. The ID of
1231 the changeset to tag is in $HG_NODE. The name of tag is in
1232 $HG_TAG. The tag is local if $HG_LOCAL=1, or in the repository
1233 if $HG_LOCAL=0.
1234 pretxnopen
1236 Run before any new repository transaction is open. The reason
1238 for the transaction will be in $HG_TXNNAME, and a unique identi‐
1239 fier for the transaction will be in HG_TXNID. A non-zero status
1240 will prevent the transaction from being opened.
1241 pretxnclose
1243 Run right before the transaction is actually finalized. Any
1245 repository change will be visible to the hook program. This lets
1246 you validate the transaction content or change it. Exit status 0
1247 allows the commit to proceed. A non-zero status will cause the
1248 transaction to be rolled back. The reason for the transaction
1249 opening will be in $HG_TXNNAME, and a unique identifier for the
1250 transaction will be in HG_TXNID. The rest of the available data
1251 will vary according the transaction type. New changesets will
1252 add $HG_NODE (the ID of the first added changeset),
1253 $HG_NODE_LAST (the ID of the last added changeset), $HG_URL and
1254 $HG_SOURCE variables. Bookmark and phase changes will set
1255 HG_BOOKMARK_MOVED and HG_PHASES_MOVED to 1 respectively, etc.
1256 pretxnclose-bookmark
1258 Run right before a bookmark change is actually finalized. Any
1260 repository change will be visible to the hook program. This lets
1261 you validate the transaction content or change it. Exit status 0
1262 allows the commit to proceed. A non-zero status will cause the
1263 transaction to be rolled back. The name of the bookmark will be
1264 available in $HG_BOOKMARK, the new bookmark location will be
1265 available in $HG_NODE while the previous location will be avail‐
1266 able in $HG_OLDNODE. In case of a bookmark creation $HG_OLDNODE
1267 will be empty. In case of deletion $HG_NODE will be empty. In
1268 addition, the reason for the transaction opening will be in
1269 $HG_TXNNAME, and a unique identifier for the transaction will be
1270 in HG_TXNID.
1271 pretxnclose-phase
1273 Run right before a phase change is actually finalized. Any
1275 repository change will be visible to the hook program. This lets
1276 you validate the transaction content or change it. Exit status 0
1277 allows the commit to proceed. A non-zero status will cause the
1278 transaction to be rolled back. The hook is called multiple
1279 times, once for each revision affected by a phase change. The
1280 affected node is available in $HG_NODE, the phase in $HG_PHASE
1281 while the previous $HG_OLDPHASE. In case of new node, $HG_OLD‐
1282 PHASE will be empty. In addition, the reason for the transac‐
1283 tion opening will be in $HG_TXNNAME, and a unique identifier for
1284 the transaction will be in HG_TXNID. The hook is also run for
1285 newly added revisions. In this case the $HG_OLDPHASE entry will
1286 be empty.
1287 txnclose
1289 Run after any repository transaction has been committed. At this
1291 point, the transaction can no longer be rolled back. The hook
1292 will run after the lock is released. See hg help con‐
1293 fig.hooks.pretxnclose for details about available variables.
1294 txnclose-bookmark
1296 Run after any bookmark change has been committed. At this point,
1298 the transaction can no longer be rolled back. The hook will run
1299 after the lock is released. See hg help config.hooks.pretxn‐
1300 close-bookmark for details about available variables.
1301 txnclose-phase
1303 Run after any phase change has been committed. At this point,
1305 the transaction can no longer be rolled back. The hook will run
1306 after the lock is released. See hg help config.hooks.pretxn‐
1307 close-phase for details about available variables.
1308 txnabort
1310 Run when a transaction is aborted. See hg help con‐
1312 fig.hooks.pretxnclose for details about available variables.
1313 pretxnchangegroup
1315 Run after a changegroup has been added via push, pull or unbun‐
1317 dle, but before the transaction has been committed. The change‐
1318 group is visible to the hook program. This allows validation of
1319 incoming changes before accepting them. The ID of the first new
1320 changeset is in $HG_NODE and last is in $HG_NODE_LAST. Exit sta‐
1321 tus 0 allows the transaction to commit. A non-zero status will
1322 cause the transaction to be rolled back, and the push, pull or
1323 unbundle will fail. The URL that was the source of changes is in
1324 $HG_URL.
1325 pretxncommit
1327 Run after a changeset has been created, but before the transac‐
1329 tion is committed. The changeset is visible to the hook program.
1330 This allows validation of the commit message and changes. Exit
1331 status 0 allows the commit to proceed. A non-zero status will
1332 cause the transaction to be rolled back. The ID of the new
1333 changeset is in $HG_NODE. The parent changeset IDs are in
1334 $HG_PARENT1 and $HG_PARENT2.
1335 preupdate
1337 Run before updating the working directory. Exit status 0 allows
1339 the update to proceed. A non-zero status will prevent the up‐
1340 date. The changeset ID of first new parent is in $HG_PARENT1.
1341 If updating to a merge, the ID of second new parent is in
1342 $HG_PARENT2.
1343 listkeys
1345 Run after listing pushkeys (like bookmarks) in the repository.
1347 The key namespace is in $HG_NAMESPACE. $HG_VALUES is a dictio‐
1348 nary containing the keys and values.
1349 pushkey
1351 Run after a pushkey (like a bookmark) is added to the reposi‐
1353 tory. The key namespace is in $HG_NAMESPACE, the key is in
1354 $HG_KEY, the old value (if any) is in $HG_OLD, and the new value
1355 is in $HG_NEW.
1356 tag
1358 Run after a tag is created. The ID of the tagged changeset is in
1360 $HG_NODE. The name of tag is in $HG_TAG. The tag is local if
1361 $HG_LOCAL=1, or in the repository if $HG_LOCAL=0.
1362 update
1364 Run after updating the working directory. The changeset ID of
1366 first new parent is in $HG_PARENT1. If updating to a merge, the
1367 ID of second new parent is in $HG_PARENT2. If the update suc‐
1368 ceeded, $HG_ERROR=0. If the update failed (e.g. because con‐
1369 flicts were not resolved), $HG_ERROR=1.
1370 Note It is generally better to use standard hooks rather than the
1372 generic pre- and post- command hooks, as they are guaranteed to
1373 be called in the appropriate contexts for influencing transac‐
1374 tions. Also, hooks like "commit" will be called in all contexts
1375 that generate a commit (e.g. tag) and not just the commit com‐
1376 mand.
1377 Note Environment variables with empty values may not be passed to
1379 hooks on platforms such as Windows. As an example, $HG_PARENT2
1380 will have an empty value under Unix-like platforms for non-merge
1381 changesets, while it will not be available at all under Windows.
1382 The syntax for Python hooks is as follows:
1384 hookname = python:modulename.submodule.callable
1386 hookname = python:/path/to/python/module.py:callable
1387 Python hooks are run within the Mercurial process. Each hook is called
1389 with at least three keyword arguments: a ui object (keyword ui), a
1390 repository object (keyword repo), and a hooktype keyword that tells
1391 what kind of hook is used. Arguments listed as environment variables
1392 above are passed as keyword arguments, with no HG_ prefix, and names in
1393 lower case.
1394 If a Python hook returns a "true" value or raises an exception, this is
1396 treated as a failure.
1397 hostfingerprints
1399 (Deprecated. Use [hostsecurity]'s fingerprints options instead.)
1400 Fingerprints of the certificates of known HTTPS servers.
1402 A HTTPS connection to a server with a fingerprint configured here will
1404 only succeed if the servers certificate matches the fingerprint. This
1405 is very similar to how ssh known hosts works.
1406 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1408 Multiple values can be specified (separated by spaces or commas). This
1409 can be used to define both old and new fingerprints while a host tran‐
1410 sitions to a new certificate.
1411 The CA chain and web.cacerts is not used for servers with a finger‐
1413 print.
1414 For example:
1416 [hostfingerprints]
1418 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1419 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1420 hostsecurity
1422 Used to specify global and per-host security settings for connecting to
1423 other machines.
1424 The following options control default behavior for all hosts.
1426 ciphers
1428 Defines the cryptographic ciphers to use for connections.
1430 Value must be a valid OpenSSL Cipher List Format as documented
1432 at
1433 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT
1434 .
1435 This setting is for advanced users only. Setting to incorrect
1437 values can significantly lower connection security or decrease
1438 performance. You have been warned.
1439 This option requires Python 2.7.
1441 minimumprotocol
1443 Defines the minimum channel encryption protocol to use.
1445 By default, the highest version of TLS supported by both client
1447 and server is used.
1448 Allowed values are: tls1.0, tls1.1, tls1.2.
1450 When running on an old Python version, only tls1.0 is allowed
1452 since old versions of Python only support up to TLS 1.0.
1453 When running a Python that supports modern TLS versions, the de‐
1455 fault is tls1.1. tls1.0 can still be used to allow TLS 1.0. How‐
1456 ever, this weakens security and should only be used as a feature
1457 of last resort if a server does not support TLS 1.1+.
1458 Options in the [hostsecurity] section can have the form hostname:set‐
1460 ting. This allows multiple settings to be defined on a per-host basis.
1461 The following per-host settings can be defined.
1463 ciphers
1465 This behaves like ciphers as described above except it only ap‐
1467 plies to the host on which it is defined.
1468 fingerprints
1470 A list of hashes of the DER encoded peer/remote certificate.
1472 Values have the form algorithm:fingerprint. e.g.
1473 sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2.
1474 In addition, colons (:) can appear in the fingerprint part.
1475 The following algorithms/prefixes are supported: sha1, sha256,
1477 sha512.
1478 Use of sha256 or sha512 is preferred.
1480 If a fingerprint is specified, the CA chain is not validated for
1482 this host and Mercurial will require the remote certificate to
1483 match one of the fingerprints specified. This means if the
1484 server updates its certificate, Mercurial will abort until a new
1485 fingerprint is defined. This can provide stronger security than
1486 traditional CA-based validation at the expense of convenience.
1487 This option takes precedence over verifycertsfile.
1489 minimumprotocol
1491 This behaves like minimumprotocol as described above except it
1493 only applies to the host on which it is defined.
1494 verifycertsfile
1496 Path to file a containing a list of PEM encoded certificates
1498 used to verify the server certificate. Environment variables and
1499 ~user constructs are expanded in the filename.
1500 The server certificate or the certificate's certificate author‐
1502 ity (CA) must match a certificate from this file or certificate
1503 verification will fail and connections to the server will be re‐
1504 fused.
1505 If defined, only certificates provided by this file will be
1507 used: web.cacerts and any system/default certificates will not
1508 be used.
1509 This option has no effect if the per-host fingerprints option is
1511 set.
1512 The format of the file is as follows:
1514 -----BEGIN CERTIFICATE-----
1516 ... (certificate in base64 PEM encoding) ...
1517 -----END CERTIFICATE-----
1518 -----BEGIN CERTIFICATE-----
1519 ... (certificate in base64 PEM encoding) ...
1520 -----END CERTIFICATE-----
1521 For example:
1523 [hostsecurity]
1525 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1526 hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1527 hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2
1528 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1529 To change the default minimum protocol version to TLS 1.2 but to allow
1531 TLS 1.1 when connecting to hg.example.com:
1532 [hostsecurity]
1534 minimumprotocol = tls1.2
1535 hg.example.com:minimumprotocol = tls1.1
1536 http_proxy
1538 Used to access web-based Mercurial repositories through a HTTP proxy.
1539 host
1541 Host name and (optional) port of the proxy server, for example
1543 "myproxy:8000".
1544 no
1546 Optional. Comma-separated list of host names that should bypass
1548 the proxy.
1549 passwd
1551 Optional. Password to authenticate with at the proxy server.
1553 user
1555 Optional. User name to authenticate with at the proxy server.
1557 always
1559 Optional. Always use the proxy, even for localhost and any en‐
1561 tries in http_proxy.no. (default: False)
1562 http
1564 Used to configure access to Mercurial repositories via HTTP.
1565 timeout
1567 If set, blocking operations will timeout after that many sec‐
1569 onds. (default: None)
1570 merge
1572 This section specifies behavior during merges and updates.
1573 checkignored
1575 Controls behavior when an ignored file on disk has the same name
1577 as a tracked file in the changeset being merged or updated to,
1578 and has different contents. Options are abort, warn and ignore.
1579 With abort, abort on such files. With warn, warn on such files
1580 and back them up as .orig. With ignore, don't print a warning
1581 and back them up as .orig. (default: abort)
1582 checkunknown
1584 Controls behavior when an unknown file that isn't ignored has
1586 the same name as a tracked file in the changeset being merged or
1587 updated to, and has different contents. Similar to merge.check‐
1588 ignored, except for files that are not ignored. (default: abort)
1589 on-failure
1591 When set to continue (the default), the merge process attempts
1593 to merge all unresolved files using the merge chosen tool, re‐
1594 gardless of whether previous file merge attempts during the
1595 process succeeded or not. Setting this to prompt will prompt
1596 after any merge failure continue or halt the merge process. Set‐
1597 ting this to halt will automatically halt the merge process on
1598 any merge tool failure. The merge process can be restarted by
1599 using the resolve command. When a merge is halted, the reposi‐
1600 tory is left in a normal unresolved merge state. (default: con‐
1601 tinue)
1602 strict-capability-check
1604 Whether capabilities of internal merge tools are checked
1606 strictly or not, while examining rules to decide merge tool to
1607 be used. (default: False)
1608 merge-patterns
1610 This section specifies merge tools to associate with particular file
1611 patterns. Tools matched here will take precedence over the default
1612 merge tool. Patterns are globs by default, rooted at the repository
1613 root.
1614 Example:
1616 [merge-patterns]
1618 **.c = kdiff3
1619 **.jpg = myimgmerge
1620 merge-tools
1622 This section configures external merge tools to use for file-level
1623 merges. This section has likely been preconfigured at install time.
1624 Use hg config merge-tools to check the existing configuration. Also
1625 see hg help merge-tools for more details.
1626 Example ~/.hgrc:
1628 [merge-tools]
1630 # Override stock tool location
1631 kdiff3.executable = ~/bin/kdiff3
1632 # Specify command line
1633 kdiff3.args = $base $local $other -o $output
1634 # Give higher priority
1635 kdiff3.priority = 1
1636 # Changing the priority of preconfigured tool
1638 meld.priority = 0
1639 # Disable a preconfigured tool
1641 vimdiff.disabled = yes
1642 # Define new tool
1644 myHtmlTool.args = -m $local $other $base $output
1645 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1646 myHtmlTool.priority = 1
1647 Supported arguments:
1649 priority
1651 The priority in which to evaluate this tool. (default: 0)
1653 executable
1655 Either just the name of the executable or its pathname.
1657 On Windows, the path can use environment variables with ${Pro‐
1659 gramFiles} syntax.
1660 (default: the tool name)
1662 args
1664 The arguments to pass to the tool executable. You can refer to
1666 the files being merged as well as the output file through these
1667 variables: $base, $local, $other, $output.
1668 The meaning of $local and $other can vary depending on which ac‐
1670 tion is being performed. During an update or merge, $local rep‐
1671 resents the original state of the file, while $other represents
1672 the commit you are updating to or the commit you are merging
1673 with. During a rebase, $local represents the destination of the
1674 rebase, and $other represents the commit being rebased.
1675 Some operations define custom labels to assist with identifying
1677 the revisions, accessible via $labellocal, $labelother, and $la‐
1678 belbase. If custom labels are not available, these will be lo‐
1679 cal, other, and base, respectively. (default: $local $base
1680 $other)
1681 premerge
1683 Attempt to run internal non-interactive 3-way merge tool before
1685 launching external tool. Options are true, false, keep,
1686 keep-merge3, or keep-mergediff (experimental). The keep option
1687 will leave markers in the file if the premerge fails. The
1688 keep-merge3 will do the same but include information about the
1689 base of the merge in the marker (see internal :merge3 in hg help
1690 merge-tools). The keep-mergediff option is similar but uses a
1691 different marker style (see internal :merge3 in hg help
1692 merge-tools). (default: True)
1693 binary
1695 This tool can merge binary files. (default: False, unless tool
1697 was selected by file pattern match)
1698 symlink
1700 This tool can merge symlinks. (default: False)
1702 check
1704 A list of merge success-checking options:
1706 changed
1708 Ask whether merge was successful when the merged file
1710 shows no changes.
1711 conflicts
1713 Check whether there are conflicts even though the tool
1715 reported success.
1716 prompt
1718 Always prompt for merge success, regardless of success
1720 reported by tool.
1721 fixeol
1723 Attempt to fix up EOL changes caused by the merge tool. (de‐
1725 fault: False)
1726 gui
1728 This tool requires a graphical interface to run. (default:
1730 False)
1731 mergemarkers
1733 Controls whether the labels passed via $labellocal, $labelother,
1735 and $labelbase are detailed (respecting mergemarkertemplate) or
1736 basic. If premerge is keep or keep-merge3, the conflict markers
1737 generated during premerge will be detailed if either this option
1738 or the corresponding option in the [ui] section is detailed.
1739 (default: basic)
1740 mergemarkertemplate
1742 This setting can be used to override mergemarker from the [com‐
1744 mand-templates] section on a per-tool basis; this applies to the
1745 $label-prefixed variables and to the conflict markers that are
1746 generated if premerge is keep` or ``keep-merge3. See the corre‐
1747 sponding variable in [ui] for more information.
1748 regkey
1750 Windows registry key which describes install location of this
1752 tool. Mercurial will search for this key first under HKEY_CUR‐
1753 RENT_USER and then under HKEY_LOCAL_MACHINE. (default: None)
1754 regkeyalt
1756 An alternate Windows registry key to try if the first key is not
1758 found. The alternate key uses the same regname and regappend
1759 semantics of the primary key. The most common use for this key
1760 is to search for 32bit applications on 64bit operating systems.
1761 (default: None)
1762 regname
1764 Name of value to read from specified registry key. (default:
1766 the unnamed (default) value)
1767 regappend
1769 String to append to the value read from the registry, typically
1771 the executable name of the tool. (default: None)
1772 pager
1774 Setting used to control when to paginate and with what external tool.
1775 See hg help pager for details.
1776 pager
1778 Define the external tool used as pager.
1780 If no pager is set, Mercurial uses the environment variable
1782 $PAGER. If neither pager.pager, nor $PAGER is set, a default
1783 pager will be used, typically less on Unix and more on Windows.
1784 Example:
1785 [pager]
1787 pager = less -FRX
1788 ignore
1790 List of commands to disable the pager for. Example:
1792 [pager]
1794 ignore = version, help, update
1795 patch
1797 Settings used when applying patches, for instance through the 'import'
1798 command or with Mercurial Queues extension.
1799 eol
1801 When set to 'strict' patch content and patched files end of
1803 lines are preserved. When set to lf or crlf, both files end of
1804 lines are ignored when patching and the result line endings are
1805 normalized to either LF (Unix) or CRLF (Windows). When set to
1806 auto, end of lines are again ignored while patching but line
1807 endings in patched files are normalized to their original set‐
1808 ting on a per-file basis. If target file does not exist or has
1809 no end of line, patch line endings are preserved. (default:
1810 strict)
1811 fuzz
1813 The number of lines of 'fuzz' to allow when applying patches.
1815 This controls how much context the patcher is allowed to ignore
1816 when trying to apply a patch. (default: 2)
1817 paths
1819 Assigns symbolic names and behavior to repositories.
1820 Options are symbolic names defining the URL or directory that is the
1822 location of the repository. Example:
1823 [paths]
1825 my_server = https://example.com/my_repo
1826 local_path = /home/me/repo
1827 These symbolic names can be used from the command line. To pull from
1829 my_server: hg pull my_server. To push to local_path: hg push local_path
1830 .
1831 Options containing colons (:) denote sub-options that can influence be‐
1833 havior for that specific path. Example:
1834 [paths]
1836 my_server = https://example.com/my_path
1837 my_server:pushurl = ssh://example.com/my_path
1838 The following sub-options can be defined:
1840 pushurl
1842 The URL to use for push operations. If not defined, the location
1844 defined by the path's main entry is used.
1845 pushrev
1847 A revset defining which revisions to push by default.
1849 When hg push is executed without a -r argument, the revset de‐
1851 fined by this sub-option is evaluated to determine what to push.
1852 For example, a value of . will push the working directory's re‐
1854 vision by default.
1855 Revsets specifying bookmarks will not result in the bookmark be‐
1857 ing pushed.
1858 The following special named paths exist:
1860 default
1862 The URL or directory to use when no source or remote is speci‐
1864 fied.
1865 hg clone will automatically define this path to the location the
1867 repository was cloned from.
1868 default-push
1870 (deprecated) The URL or directory for the default hg push loca‐
1872 tion. default:pushurl should be used instead.
1873 phases
1875 Specifies default handling of phases. See hg help phases for more in‐
1876 formation about working with phases.
1877 publish
1879 Controls draft phase behavior when working as a server. When
1881 true, pushed changesets are set to public in both client and
1882 server and pulled or cloned changesets are set to public in the
1883 client. (default: True)
1884 new-commit
1886 Phase of newly-created commits. (default: draft)
1888 checksubrepos
1890 Check the phase of the current revision of each subrepository.
1892 Allowed values are "ignore", "follow" and "abort". For settings
1893 other than "ignore", the phase of the current revision of each
1894 subrepository is checked before committing the parent reposi‐
1895 tory. If any of those phases is greater than the phase of the
1896 parent repository (e.g. if a subrepo is in a "secret" phase
1897 while the parent repo is in "draft" phase), the commit is either
1898 aborted (if checksubrepos is set to "abort") or the higher phase
1899 is used for the parent repository commit (if set to "follow").
1900 (default: follow)
1901 profiling
1903 Specifies profiling type, format, and file output. Two profilers are
1904 supported: an instrumenting profiler (named ls), and a sampling pro‐
1905 filer (named stat).
1906 In this section description, 'profiling data' stands for the raw data
1908 collected during profiling, while 'profiling report' stands for a sta‐
1909 tistical text report generated from the profiling data.
1910 enabled
1912 Enable the profiler. (default: false)
1914 This is equivalent to passing --profile on the command line.
1916 type
1918 The type of profiler to use. (default: stat)
1920 ls
1922 Use Python's built-in instrumenting profiler. This pro‐
1924 filer works on all platforms, but each line number it re‐
1925 ports is the first line of a function. This restriction
1926 makes it difficult to identify the expensive parts of a
1927 non-trivial function.
1928 stat
1930 Use a statistical profiler, statprof. This profiler is
1932 most useful for profiling commands that run for longer
1933 than about 0.1 seconds.
1934 format
1936 Profiling format. Specific to the ls instrumenting profiler.
1938 (default: text)
1939 text
1941 Generate a profiling report. When saving to a file, it
1943 should be noted that only the report is saved, and the
1944 profiling data is not kept.
1945 kcachegrind
1947 Format profiling data for kcachegrind use: when saving to
1949 a file, the generated file can directly be loaded into
1950 kcachegrind.
1951 statformat
1953 Profiling format for the stat profiler. (default: hotpath)
1955 hotpath
1957 Show a tree-based display containing the hot path of exe‐
1959 cution (where most time was spent).
1960 bymethod
1962 Show a table of methods ordered by how frequently they
1964 are active.
1965 byline
1967 Show a table of lines in files ordered by how frequently
1969 they are active.
1970 json
1972 Render profiling data as JSON.
1974 frequency
1976 Sampling frequency. Specific to the stat sampling profiler.
1978 (default: 1000)
1979 output
1981 File path where profiling data or report should be saved. If the
1983 file exists, it is replaced. (default: None, data is printed on
1984 stderr)
1985 sort
1987 Sort field. Specific to the ls instrumenting profiler. One of
1989 callcount, reccallcount, totaltime and inlinetime. (default:
1990 inlinetime)
1991 time-track
1993 Control if the stat profiler track cpu or real time. (default:
1995 cpu on Windows, otherwise real)
1996 limit
1998 Number of lines to show. Specific to the ls instrumenting pro‐
2000 filer. (default: 30)
2001 nested
2003 Show at most this number of lines of drill-down info after each
2005 main entry. This can help explain the difference between Total
2006 and Inline. Specific to the ls instrumenting profiler. (de‐
2007 fault: 0)
2008 showmin
2010 Minimum fraction of samples an entry must have for it to be dis‐
2012 played. Can be specified as a float between 0.0 and 1.0 or can
2013 have a % afterwards to allow values up to 100. e.g. 5%.
2014 Only used by the stat profiler.
2016 For the hotpath format, default is 0.05. For the chrome format,
2018 default is 0.005.
2019 The option is unused on other formats.
2021 showmax
2023 Maximum fraction of samples an entry can have before it is ig‐
2025 nored in display. Values format is the same as showmin.
2026 Only used by the stat profiler.
2028 For the chrome format, default is 0.999.
2030 The option is unused on other formats.
2032 showtime
2034 Show time taken as absolute durations, in addition to percent‐
2036 ages. Only used by the hotpath format. (default: true)
2037 progress
2039 Mercurial commands can draw progress bars that are as informative as
2040 possible. Some progress bars only offer indeterminate information,
2041 while others have a definite end point.
2042 debug
2044 Whether to print debug info when updating the progress bar. (de‐
2046 fault: False)
2047 delay
2049 Number of seconds (float) before showing the progress bar. (de‐
2051 fault: 3)
2052 changedelay
2054 Minimum delay before showing a new topic. When set to less than
2056 3 * refresh, that value will be used instead. (default: 1)
2057 estimateinterval
2059 Maximum sampling interval in seconds for speed and estimated
2061 time calculation. (default: 60)
2062 refresh
2064 Time in seconds between refreshes of the progress bar. (default:
2066 0.1)
2067 format
2069 Format of the progress bar.
2071 Valid entries for the format field are topic, bar, number, unit,
2073 estimate, speed, and item. item defaults to the last 20 charac‐
2074 ters of the item, but this can be changed by adding either
2075 -<num> which would take the last num characters, or +<num> for
2076 the first num characters.
2077 (default: topic bar number estimate)
2079 width
2081 If set, the maximum width of the progress information (that is,
2083 min(width, term width) will be used).
2084 clear-complete
2086 Clear the progress bar after it's done. (default: True)
2088 disable
2090 If true, don't show a progress bar.
2092 assume-tty
2094 If true, ALWAYS show a progress bar, unless disable is given.
2096 rebase
2098 evolution.allowdivergence
2099 Default to False, when True allow creating divergence when per‐
2101 forming rebase of obsolete changesets.
2102 revsetalias
2104 Alias definitions for revsets. See hg help revsets for details.
2105 rewrite
2107 backup-bundle
2108 Whether to save stripped changesets to a bundle file. (default:
2110 True)
2111 update-timestamp
2113 If true, updates the date and time of the changeset to current.
2115 It is only applicable for hg amend, hg commit --amend and hg un‐
2116 commit in the current version.
2117 empty-successor
2119 Control what happens with empty successors that are the result of
2121 rewrite operations. If set to skip, the successor is not created. If
2122 set to keep, the empty successor is created and kept.
2123 Currently, only the rebase and absorb commands consider this config‐
2125 uration. (EXPERIMENTAL)
2126 share
2128 safe-mismatch.source-safe
2129 Controls what happens when the shared repository does not use the
2131 share-safe mechanism but its source repository does.
2132 Possible values are abort (default), allow, upgrade-abort and up‐
2134 grade-abort.
2135 abort Disallows running any command and aborts allow Respects the
2137 feature presence in the share source upgrade-abort tries to upgrade
2138 the share to use share-safe; if it fails, aborts upgrade-allow tries
2139 to upgrade the share; if it fails, continue by respecting the share
2140 source setting
2141 Check hg help config format.use-share-safe for details about the
2143 share-safe feature.
2144 safe-mismatch.source-safe.warn
2146 Shows a warning on operations if the shared repository does not
2148 use share-safe, but the source repository does. (default: True)
2149 safe-mismatch.source-not-safe
2151 Controls what happens when the shared repository uses the share-safe
2153 mechanism but its source does not.
2154 Possible values are abort (default), allow, downgrade-abort and
2156 downgrade-abort.
2157 abort Disallows running any command and aborts allow Respects the
2159 feature presence in the share source downgrade-abort tries to down‐
2160 grade the share to not use share-safe; if it fails, aborts down‐
2161 grade-allow tries to downgrade the share to not use share-safe; if
2162 it fails, continue by respecting the shared source setting
2163 Check hg help config format.use-share-safe for details about the
2165 share-safe feature.
2166 safe-mismatch.source-not-safe.warn
2168 Shows a warning on operations if the shared repository uses
2170 share-safe, but the source repository does not. (default: True)
2171 storage
2173 Control the strategy Mercurial uses internally to store history. Op‐
2174 tions in this category impact performance and repository size.
2175 revlog.optimize-delta-parent-choice
2177 When storing a merge revision, both parents will be equally con‐
2179 sidered as a possible delta base. This results in better delta
2180 selection and improved revlog compression. This option is en‐
2181 abled by default.
2182 Turning this option off can result in large increase of reposi‐
2184 tory size for repository with many merges.
2185 revlog.persistent-nodemap.mmap
2187 Whether to use the Operating System "memory mapping" feature
2189 (when possible) to access the persistent nodemap data. This im‐
2190 prove performance and reduce memory pressure.
2191 Default to True.
2193 For details on the "persistent-nodemap" feature, see: hg help
2195 config format.use-persistent-nodemap.
2196 revlog.persistent-nodemap.slow-path
2198 Control the behavior of Merucrial when using a repository with
2200 "persistent" nodemap with an installation of Mercurial without a
2201 fast implementation for the feature:
2202 allow: Silently use the slower implementation to access the
2204 repository. warn: Warn, but use the slower implementation to
2205 access the repository. abort: Prevent access to such reposito‐
2206 ries. (This is the default)
2207 For details on the "persistent-nodemap" feature, see: hg help
2209 config format.use-persistent-nodemap.
2210 revlog.reuse-external-delta-parent
2212 Control the order in which delta parents are considered when
2214 adding new revisions from an external source. (typically: apply
2215 bundle from hg pull or hg push).
2216 New revisions are usually provided as a delta against other re‐
2218 visions. By default, Mercurial will try to reuse this delta
2219 first, therefore using the same "delta parent" as the source.
2220 Directly using delta's from the source reduces CPU usage and
2221 usually speeds up operation. However, in some case, the source
2222 might have sub-optimal delta bases and forcing their reevalua‐
2223 tion is useful. For example, pushes from an old client could
2224 have sub-optimal delta's parent that the server want to opti‐
2225 mize. (lack of general delta, bad parents, choice, lack of
2226 sparse-revlog, etc).
2227 This option is enabled by default. Turning it off will ensure
2229 bad delta parent choices from older client do not propagate to
2230 this repository, at the cost of a small increase in CPU consump‐
2231 tion.
2232 Note: this option only control the order in which delta parents
2234 are considered. Even when disabled, the existing delta from the
2235 source will be reused if the same delta parent is selected.
2236 revlog.reuse-external-delta
2238 Control the reuse of delta from external source. (typically:
2240 apply bundle from hg pull or hg push).
2241 New revisions are usually provided as a delta against another
2243 revision. By default, Mercurial will not recompute the same
2244 delta again, trusting externally provided deltas. There have
2245 been rare cases of small adjustment to the diffing algorithm in
2246 the past. So in some rare case, recomputing delta provided by
2247 ancient clients can provides better results. Disabling this op‐
2248 tion means going through a full delta recomputation for all in‐
2249 coming revisions. It means a large increase in CPU usage and
2250 will slow operations down.
2251 This option is enabled by default. When disabled, it also dis‐
2253 ables the related storage.revlog.reuse-external-delta-parent op‐
2254 tion.
2255 revlog.zlib.level
2257 Zlib compression level used when storing data into the reposi‐
2259 tory. Accepted Value range from 1 (lowest compression) to 9
2260 (highest compression). Zlib default value is 6.
2261 revlog.zstd.level
2263 zstd compression level used when storing data into the reposi‐
2265 tory. Accepted Value range from 1 (lowest compression) to 22
2266 (highest compression). (default 3)
2267 server
2269 Controls generic server settings.
2270 bookmarks-pushkey-compat
2272 Trigger pushkey hook when being pushed bookmark updates. This
2274 config exist for compatibility purpose (default to True)
2275 If you use pushkey and pre-pushkey hooks to control bookmark
2277 movement we recommend you migrate them to txnclose-bookmark and
2278 pretxnclose-bookmark.
2279 compressionengines
2281 List of compression engines and their relative priority to ad‐
2283 vertise to clients.
2284 The order of compression engines determines their priority, the
2286 first having the highest priority. If a compression engine is
2287 not listed here, it won't be advertised to clients.
2288 If not set (the default), built-in defaults are used. Run hg de‐
2290 buginstall to list available compression engines and their de‐
2291 fault wire protocol priority.
2292 Older Mercurial clients only support zlib compression and this
2294 setting has no effect for legacy clients.
2295 uncompressed
2297 Whether to allow clients to clone a repository using the uncom‐
2299 pressed streaming protocol. This transfers about 40% more data
2300 than a regular clone, but uses less memory and CPU on both
2301 server and client. Over a LAN (100 Mbps or better) or a very
2302 fast WAN, an uncompressed streaming clone is a lot faster (~10x)
2303 than a regular clone. Over most WAN connections (anything slower
2304 than about 6 Mbps), uncompressed streaming is slower, because of
2305 the extra data transfer overhead. This mode will also temporar‐
2306 ily hold the write lock while determining what data to transfer.
2307 (default: True)
2308 uncompressedallowsecret
2310 Whether to allow stream clones when the repository contains se‐
2312 cret changesets. (default: False)
2313 preferuncompressed
2315 When set, clients will try to use the uncompressed streaming
2317 protocol. (default: False)
2318 disablefullbundle
2320 When set, servers will refuse attempts to do pull-based clones.
2322 If this option is set, preferuncompressed and/or clone bundles
2323 are highly recommended. Partial clones will still be allowed.
2324 (default: False)
2325 streamunbundle
2327 When set, servers will apply data sent from the client directly,
2329 otherwise it will be written to a temporary file first. This op‐
2330 tion effectively prevents concurrent pushes.
2331 pullbundle
2333 When set, the server will check pullbundle.manifest for bundles
2335 covering the requested heads and common nodes. The first match‐
2336 ing entry will be streamed to the client.
2337 For HTTP transport, the stream will still use zlib compression
2339 for older clients.
2340 concurrent-push-mode
2342 Level of allowed race condition between two pushing clients.
2344 • 'strict': push is abort if another client touched the reposi‐
2346 tory while the push was preparing.
2347 • 'check-related': push is only aborted if it affects head that
2349 got also affected while the push was preparing. (default since
2350 5.4)
2351 'check-related' only takes effect for compatible clients (ver‐
2353 sion 4.3 and later). Older clients will use 'strict'.
2354 validate
2356 Whether to validate the completeness of pushed changesets by
2358 checking that all new file revisions specified in manifests are
2359 present. (default: False)
2360 maxhttpheaderlen
2362 Instruct HTTP clients not to send request headers longer than
2364 this many bytes. (default: 1024)
2365 bundle1
2367 Whether to allow clients to push and pull using the legacy bun‐
2369 dle1 exchange format. (default: True)
2370 bundle1gd
2372 Like bundle1 but only used if the repository is using the gener‐
2374 aldelta storage format. (default: True)
2375 bundle1.push
2377 Whether to allow clients to push using the legacy bundle1 ex‐
2379 change format. (default: True)
2380 bundle1gd.push
2382 Like bundle1.push but only used if the repository is using the
2384 generaldelta storage format. (default: True)
2385 bundle1.pull
2387 Whether to allow clients to pull using the legacy bundle1 ex‐
2389 change format. (default: True)
2390 bundle1gd.pull
2392 Like bundle1.pull but only used if the repository is using the
2394 generaldelta storage format. (default: True)
2395 Large repositories using the generaldelta storage format should
2397 consider setting this option because converting generaldelta
2398 repositories to the exchange format required by the bundle1 data
2399 format can consume a lot of CPU.
2400 bundle2.stream
2402 Whether to allow clients to pull using the bundle2 streaming
2404 protocol. (default: True)
2405 zliblevel
2407 Integer between -1 and 9 that controls the zlib compression
2409 level for wire protocol commands that send zlib compressed out‐
2410 put (notably the commands that send repository history data).
2411 The default (-1) uses the default zlib compression level, which
2413 is likely equivalent to 6. 0 means no compression. 9 means maxi‐
2414 mum compression.
2415 Setting this option allows server operators to make trade-offs
2417 between bandwidth and CPU used. Lowering the compression lowers
2418 CPU utilization but sends more bytes to clients.
2419 This option only impacts the HTTP server.
2421 zstdlevel
2423 Integer between 1 and 22 that controls the zstd compression
2425 level for wire protocol commands. 1 is the minimal amount of
2426 compression and 22 is the highest amount of compression.
2427 The default (3) should be significantly faster than zlib while
2429 likely delivering better compression ratios.
2430 This option only impacts the HTTP server.
2432 See also server.zliblevel.
2434 view
2436 Repository filter used when exchanging revisions with the peer.
2438 The default view (served) excludes secret and hidden changesets.
2440 Another useful value is immutable (no draft, secret or hidden
2441 changesets). (EXPERIMENTAL)
2442 smtp
2444 Configuration for extensions that need to send email messages.
2445 host
2447 Host name of mail server, e.g. "mail.example.com".
2449 port
2451 Optional. Port to connect to on mail server. (default: 465 if
2453 tls is smtps; 25 otherwise)
2454 tls
2456 Optional. Method to enable TLS when connecting to mail server:
2458 starttls, smtps or none. (default: none)
2459 username
2461 Optional. User name for authenticating with the SMTP server.
2463 (default: None)
2464 password
2466 Optional. Password for authenticating with the SMTP server. If
2468 not specified, interactive sessions will prompt the user for a
2469 password; non-interactive sessions will fail. (default: None)
2470 local_hostname
2472 Optional. The hostname that the sender can use to identify it‐
2474 self to the MTA.
2475 subpaths
2477 Subrepository source URLs can go stale if a remote server changes name
2478 or becomes temporarily unavailable. This section lets you define re‐
2479 write rules of the form:
2480 <pattern> = <replacement>
2482 where pattern is a regular expression matching a subrepository source
2484 URL and replacement is the replacement string used to rewrite it.
2485 Groups can be matched in pattern and referenced in replacements. For
2486 instance:
2487 http://server/(.*)-hg/ = http://hg.server/\1/
2489 rewrites http://server/foo-hg/ into http://hg.server/foo/.
2491 Relative subrepository paths are first made absolute, and the rewrite
2493 rules are then applied on the full (absolute) path. If pattern doesn't
2494 match the full path, an attempt is made to apply it on the relative
2495 path alone. The rules are applied in definition order.
2496 subrepos
2498 This section contains options that control the behavior of the sub‐
2499 repositories feature. See also hg help subrepos.
2500 Security note: auditing in Mercurial is known to be insufficient to
2502 prevent clone-time code execution with carefully constructed Git subre‐
2503 pos. It is unknown if a similar detect is present in Subversion subre‐
2504 pos. Both Git and Subversion subrepos are disabled by default out of
2505 security concerns. These subrepo types can be enabled using the respec‐
2506 tive options below.
2507 allowed
2509 Whether subrepositories are allowed in the working directory.
2511 When false, commands involving subrepositories (like hg update)
2513 will fail for all subrepository types. (default: true)
2514 hg:allowed
2516 Whether Mercurial subrepositories are allowed in the working di‐
2518 rectory. This option only has an effect if subrepos.allowed is
2519 true. (default: true)
2520 git:allowed
2522 Whether Git subrepositories are allowed in the working direc‐
2524 tory. This option only has an effect if subrepos.allowed is
2525 true.
2526 See the security note above before enabling Git subrepos. (de‐
2528 fault: false)
2529 svn:allowed
2531 Whether Subversion subrepositories are allowed in the working
2533 directory. This option only has an effect if subrepos.allowed is
2534 true.
2535 See the security note above before enabling Subversion subrepos.
2537 (default: false)
2538 templatealias
2540 Alias definitions for templates. See hg help templates for details.
2541 templates
2543 Use the [templates] section to define template strings. See hg help
2544 templates for details.
2545 trusted
2547 Mercurial will not use the settings in the .hg/hgrc file from a reposi‐
2548 tory if it doesn't belong to a trusted user or to a trusted group, as
2549 various hgrc features allow arbitrary commands to be run. This issue is
2550 often encountered when configuring hooks or extensions for shared
2551 repositories or servers. However, the web interface will use some safe
2552 settings from the [web] section.
2553 This section specifies what users and groups are trusted. The current
2555 user is always trusted. To trust everybody, list a user or a group with
2556 name *. These settings must be placed in an already-trusted file to
2557 take effect, such as $HOME/.hgrc of the user or service running Mercu‐
2558 rial.
2559 users
2561 Comma-separated list of trusted users.
2563 groups
2565 Comma-separated list of trusted groups.
2567 ui
2569 User interface controls.
2570 archivemeta
2572 Whether to include the .hg_archival.txt file containing meta
2574 data (hashes for the repository base and for tip) in archives
2575 created by the hg archive command or downloaded via hgweb. (de‐
2576 fault: True)
2577 askusername
2579 Whether to prompt for a username when committing. If True, and
2581 neither $HGUSER nor $EMAIL has been specified, then the user
2582 will be prompted to enter a username. If no username is entered,
2583 the default USER@HOST is used instead. (default: False)
2584 clonebundles
2586 Whether the "clone bundles" feature is enabled.
2588 When enabled, hg clone may download and apply a server-adver‐
2590 tised bundle file from a URL instead of using the normal ex‐
2591 change mechanism.
2592 This can likely result in faster and more reliable clones.
2594 (default: True)
2596 clonebundlefallback
2598 Whether failure to apply an advertised "clone bundle" from a
2600 server should result in fallback to a regular clone.
2601 This is disabled by default because servers advertising "clone
2603 bundles" often do so to reduce server load. If advertised bun‐
2604 dles start mass failing and clients automatically fall back to a
2605 regular clone, this would add significant and unexpected load to
2606 the server since the server is expecting clone operations to be
2607 offloaded to pre-generated bundles. Failing fast (the default
2608 behavior) ensures clients don't overwhelm the server when "clone
2609 bundle" application fails.
2610 (default: False)
2612 clonebundleprefers
2614 Defines preferences for which "clone bundles" to use.
2616 Servers advertising "clone bundles" may advertise multiple
2618 available bundles. Each bundle may have different attributes,
2619 such as the bundle type and compression format. This option is
2620 used to prefer a particular bundle over another.
2621 The following keys are defined by Mercurial:
2623 BUNDLESPEC
2625 A bundle type specifier. These are strings passed to hg
2626 bundle -t. e.g. gzip-v2 or bzip2-v1.
2627 COMPRESSION
2629 The compression format of the bundle. e.g. gzip and
2630 bzip2.
2631 Server operators may define custom keys.
2633 Example values: COMPRESSION=bzip2, BUNDLESPEC=gzip-v2, COMPRES‐
2635 SION=gzip.
2636 By default, the first bundle advertised by the server is used.
2638 color
2640 When to colorize output. Possible value are Boolean ("yes" or
2642 "no"), or "debug", or "always". (default: "yes"). "yes" will use
2643 color whenever it seems possible. See hg help color for details.
2644 commitsubrepos
2646 Whether to commit modified subrepositories when committing the
2648 parent repository. If False and one subrepository has uncommit‐
2649 ted changes, abort the commit. (default: False)
2650 debug
2652 Print debugging information. (default: False)
2654 editor
2656 The editor to use during a commit. (default: $EDITOR or vi)
2658 fallbackencoding
2660 Encoding to try if it's not possible to decode the changelog us‐
2662 ing UTF-8. (default: ISO-8859-1)
2663 graphnodetemplate
2665 (DEPRECATED) Use command-templates.graphnode instead.
2667 ignore
2669 A file to read per-user ignore patterns from. This file should
2671 be in the same format as a repository-wide .hgignore file. File‐
2672 names are relative to the repository root. This option supports
2673 hook syntax, so if you want to specify multiple ignore files,
2674 you can do so by setting something like ignore.other = ~/.hgig‐
2675 nore2. For details of the ignore file format, see the hgig‐
2676 nore(5) man page.
2677 interactive
2679 Allow to prompt the user. (default: True)
2681 interface
2683 Select the default interface for interactive features (default:
2685 text). Possible values are 'text' and 'curses'.
2686 interface.chunkselector
2688 Select the interface for change recording (e.g. hg commit -i).
2690 Possible values are 'text' and 'curses'. This config overrides
2691 the interface specified by ui.interface.
2692 large-file-limit
2694 Largest file size that gives no memory use warning. Possible
2696 values are integers or 0 to disable the check. (default:
2697 10000000)
2698 logtemplate
2700 (DEPRECATED) Use command-templates.log instead.
2702 merge
2704 The conflict resolution program to use during a manual merge.
2706 For more information on merge tools see hg help merge-tools.
2707 For configuring merge tools see the [merge-tools] section.
2708 mergemarkers
2710 Sets the merge conflict marker label styling. The detailed style
2712 uses the command-templates.mergemarker setting to style the la‐
2713 bels. The basic style just uses 'local' and 'other' as the
2714 marker label. One of basic or detailed. (default: basic)
2715 mergemarkertemplate
2717 (DEPRECATED) Use command-templates.mergemarker instead.
2719 message-output
2721 Where to write status and error messages. (default: stdio)
2723 channel
2725 Use separate channel for structured output. (Com‐
2727 mand-server only)
2728 stderr
2730 Everything to stderr.
2732 stdio
2734 Status to stdout, and error to stderr.
2736 origbackuppath
2738 The path to a directory used to store generated .orig files. If
2740 the path is not a directory, one will be created. If set, files
2741 stored in this directory have the same name as the original file
2742 and do not have a .orig suffix.
2743 paginate
2745 Control the pagination of command output (default: True). See hg
2747 help pager for details.
2748 patch
2750 An optional external tool that hg import and some extensions
2752 will use for applying patches. By default Mercurial uses an in‐
2753 ternal patch utility. The external tool must work as the common
2754 Unix patch program. In particular, it must accept a -p argument
2755 to strip patch headers, a -d argument to specify the current di‐
2756 rectory, a file name to patch, and a patch file to take from
2757 stdin.
2758 It is possible to specify a patch tool together with extra argu‐
2760 ments. For example, setting this option to patch --merge will
2761 use the patch program with its 2-way merge option.
2762 portablefilenames
2764 Check for portable filenames. Can be warn, ignore or abort.
2766 (default: warn)
2767 warn
2769 Print a warning message on POSIX platforms, if a file
2771 with a non-portable filename is added (e.g. a file with a
2772 name that can't be created on Windows because it contains
2773 reserved parts like AUX, reserved characters like :, or
2774 would cause a case collision with an existing file).
2775 ignore
2777 Don't print a warning.
2779 abort
2781 The command is aborted.
2783 true
2785 Alias for warn.
2787 false
2789 Alias for ignore.
2791 On Windows, this configuration option is ignored and the command
2793 aborted.
2794 pre-merge-tool-output-template
2796 (DEPRECATED) Use command-template.pre-merge-tool-output instead.
2798 quiet
2800 Reduce the amount of output printed. (default: False)
2802 relative-paths
2804 Prefer relative paths in the UI.
2806 remotecmd
2808 Remote command to use for clone/push/pull operations. (default:
2810 hg)
2811 report_untrusted
2813 Warn if a .hg/hgrc file is ignored due to not being owned by a
2815 trusted user or group. (default: True)
2816 slash
2818 (Deprecated. Use slashpath template filter instead.)
2820 Display paths using a slash (/) as the path separator. This only
2822 makes a difference on systems where the default path separator
2823 is not the slash character (e.g. Windows uses the backslash
2824 character (\)). (default: False)
2825 statuscopies
2827 Display copies in the status command.
2829 ssh
2831 Command to use for SSH connections. (default: ssh)
2833 ssherrorhint
2835 A hint shown to the user in the case of SSH error (e.g. Please
2837 see http://company/internalwiki/ssh.html)
2838 strict
2840 Require exact command names, instead of allowing unambiguous ab‐
2842 breviations. (default: False)
2843 style
2845 Name of style to use for command output.
2847 supportcontact
2849 A URL where users should report a Mercurial traceback. Use this
2851 if you are a large organisation with its own Mercurial deploy‐
2852 ment process and crash reports should be addressed to your in‐
2853 ternal support.
2854 textwidth
2856 Maximum width of help text. A longer line generated by hg help
2858 or hg subcommand --help will be broken after white space to get
2859 this width or the terminal width, whichever comes first. A
2860 non-positive value will disable this and the terminal width will
2861 be used. (default: 78)
2862 timeout
2864 The timeout used when a lock is held (in seconds), a negative
2866 value means no timeout. (default: 600)
2867 timeout.warn
2869 Time (in seconds) before a warning is printed about held lock. A
2871 negative value means no warning. (default: 0)
2872 traceback
2874 Mercurial always prints a traceback when an unknown exception
2876 occurs. Setting this to True will make Mercurial print a trace‐
2877 back on all exceptions, even those recognized by Mercurial (such
2878 as IOError or MemoryError). (default: False)
2879 tweakdefaults
2881 By default Mercurial's behavior changes very little from release to
2883 release, but over time the recommended config settings shift. Enable
2884 this config to opt in to get automatic tweaks to Mercurial's behav‐
2885 ior over time. This config setting will have no effect if HGPLAIN is
2886 set or HGPLAINEXCEPT is set and does not include tweakdefaults. (de‐
2887 fault: False)
2888 It currently means:
2890 [ui]
2892 # The rollback command is dangerous. As a rule, don't use it.
2893 rollback = False
2894 # Make `hg status` report copy information
2895 statuscopies = yes
2896 # Prefer curses UIs when available. Revert to plain-text with `text`.
2897 interface = curses
2898 # Make compatible commands emit cwd-relative paths by default.
2899 relative-paths = yes
2900 [commands]
2902 # Grep working directory by default.
2903 grep.all-files = True
2904 # Refuse to perform an `hg update` that would cause a file content merge
2905 update.check = noconflict
2906 # Show conflicts information in `hg status`
2907 status.verbose = True
2908 # Make `hg resolve` with no action (like `-m`) fail instead of re-merging.
2909 resolve.explicit-re-merge = True
2910 [diff]
2912 git = 1
2913 showfunc = 1
2914 word-diff = 1
2915 username
2917 The committer of a changeset created when running "commit".
2919 Typically a person's name and email address, e.g. Fred Widget
2920 <fred@example.com>. Environment variables in the username are
2921 expanded.
2922 (default: $EMAIL or username@hostname. If the username in hgrc
2924 is empty, e.g. if the system admin set username = in the system
2925 hgrc, it has to be specified manually or in a different hgrc
2926 file)
2927 verbose
2929 Increase the amount of output printed. (default: False)
2931 command-templates
2933 Templates used for customizing the output of commands.
2934 graphnode
2936 The template used to print changeset nodes in an ASCII revision
2938 graph. (default: {graphnode})
2939 log
2941 Template string for commands that print changesets.
2943 mergemarker
2945 The template used to print the commit description next to each
2947 conflict marker during merge conflicts. See hg help templates
2948 for the template format.
2949 Defaults to showing the hash, tags, branches, bookmarks, author,
2951 and the first line of the commit description.
2952 If you use non-ASCII characters in names for tags, branches,
2954 bookmarks, authors, and/or commit descriptions, you must pay at‐
2955 tention to encodings of managed files. At template expansion,
2956 non-ASCII characters use the encoding specified by the --encod‐
2957 ing global option, HGENCODING or other environment variables
2958 that govern your locale. If the encoding of the merge markers is
2959 different from the encoding of the merged files, serious prob‐
2960 lems may occur.
2961 Can be overridden per-merge-tool, see the [merge-tools] section.
2963 oneline-summary
2965 A template used by hg rebase and other commands for showing a
2967 one-line summary of a commit. If the template configured here is
2968 longer than one line, then only the first line is used.
2969 The template can be overridden per command by defining a tem‐
2971 plate in oneline-summary.<command>, where <command> can be e.g.
2972 "rebase".
2973 pre-merge-tool-output
2975 A template that is printed before executing an external merge
2977 tool. This can be used to print out additional context that
2978 might be useful to have during the conflict resolution, such as
2979 the description of the various commits involved or book‐
2980 marks/tags.
2981 Additional information is available in the local`, ``base, and
2983 other dicts. For example: {local.label}, {base.name}, or
2984 {other.islink}.
2985 web
2987 Web interface configuration. The settings in this section apply to both
2988 the builtin webserver (started by hg serve) and the script you run
2989 through a webserver (hgweb.cgi and the derivatives for FastCGI and
2990 WSGI).
2991 The Mercurial webserver does no authentication (it does not prompt for
2993 usernames and passwords to validate who users are), but it does do au‐
2994 thorization (it grants or denies access for authenticated users based
2995 on settings in this section). You must either configure your webserver
2996 to do authentication for you, or disable the authorization checks.
2997 For a quick setup in a trusted environment, e.g., a private LAN, where
2999 you want it to accept pushes from anybody, you can use the following
3000 command line:
3001 $ hg --config web.allow-push=* --config web.push_ssl=False serve
3003 Note that this will allow anybody to push anything to the server and
3005 that this should not be used for public servers.
3006 The full set of options is:
3008 accesslog
3010 Where to output the access log. (default: stdout)
3012 address
3014 Interface address to bind to. (default: all)
3016 allow-archive
3018 List of archive format (bz2, gz, zip) allowed for downloading.
3020 (default: empty)
3021 allowbz2
3023 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
3025 revisions. (default: False)
3026 allowgz
3028 (DEPRECATED) Whether to allow .tar.gz downloading of repository
3030 revisions. (default: False)
3031 allow-pull
3033 Whether to allow pulling from the repository. (default: True)
3035 allow-push
3037 Whether to allow pushing to the repository. If empty or not set,
3039 pushing is not allowed. If the special value *, any remote user
3040 can push, including unauthenticated users. Otherwise, the remote
3041 user must have been authenticated, and the authenticated user
3042 name must be present in this list. The contents of the al‐
3043 low-push list are examined after the deny_push list.
3044 allow_read
3046 If the user has not already been denied repository access due to
3048 the contents of deny_read, this list determines whether to grant
3049 repository access to the user. If this list is not empty, and
3050 the user is unauthenticated or not present in the list, then ac‐
3051 cess is denied for the user. If the list is empty or not set,
3052 then access is permitted to all users by default. Setting al‐
3053 low_read to the special value * is equivalent to it not being
3054 set (i.e. access is permitted to all users). The contents of the
3055 allow_read list are examined after the deny_read list.
3056 allowzip
3058 (DEPRECATED) Whether to allow .zip downloading of repository re‐
3060 visions. This feature creates temporary files. (default: False)
3061 archivesubrepos
3063 Whether to recurse into subrepositories when archiving. (de‐
3065 fault: False)
3066 baseurl
3068 Base URL to use when publishing URLs in other locations, so
3070 third-party tools like email notification hooks can construct
3071 URLs. Example: http://hgserver/repos/.
3072 cacerts
3074 Path to file containing a list of PEM encoded certificate au‐
3076 thority certificates. Environment variables and ~user constructs
3077 are expanded in the filename. If specified on the client, then
3078 it will verify the identity of remote HTTPS servers with these
3079 certificates.
3080 To disable SSL verification temporarily, specify --insecure from
3082 command line.
3083 You can use OpenSSL's CA certificate file if your platform has
3085 one. On most Linux systems this will be /etc/ssl/certs/ca-cer‐
3086 tificates.crt. Otherwise you will have to generate this file
3087 manually. The form must be as follows:
3088 -----BEGIN CERTIFICATE-----
3090 ... (certificate in base64 PEM encoding) ...
3091 -----END CERTIFICATE-----
3092 -----BEGIN CERTIFICATE-----
3093 ... (certificate in base64 PEM encoding) ...
3094 -----END CERTIFICATE-----
3095 cache
3097 Whether to support caching in hgweb. (default: True)
3099 certificate
3101 Certificate to use when running hg serve.
3103 collapse
3105 With descend enabled, repositories in subdirectories are shown
3107 at a single level alongside repositories in the current path.
3108 With collapse also enabled, repositories residing at a deeper
3109 level than the current path are grouped behind navigable direc‐
3110 tory entries that lead to the locations of these repositories.
3111 In effect, this setting collapses each collection of reposito‐
3112 ries found within a subdirectory into a single entry for that
3113 subdirectory. (default: False)
3114 comparisoncontext
3116 Number of lines of context to show in side-by-side file compari‐
3118 son. If negative or the value full, whole files are shown. (de‐
3119 fault: 5)
3120 This setting can be overridden by a context request parameter to
3122 the comparison command, taking the same values.
3123 contact
3125 Name or email address of the person in charge of the repository.
3127 (default: ui.username or $EMAIL or "unknown" if unset or empty)
3128 csp
3130 Send a Content-Security-Policy HTTP header with this value.
3132 The value may contain a special string %nonce%, which will be
3134 replaced by a randomly-generated one-time use value. If the
3135 value contains %nonce%, web.cache will be disabled, as caching
3136 undermines the one-time property of the nonce. This nonce will
3137 also be inserted into <script> elements containing inline Java‐
3138 Script.
3139 Note: lots of HTML content sent by the server is derived from
3141 repository data. Please consider the potential for malicious
3142 repository data to "inject" itself into generated HTML content
3143 as part of your security threat model.
3144 deny_push
3146 Whether to deny pushing to the repository. If empty or not set,
3148 push is not denied. If the special value *, all remote users are
3149 denied push. Otherwise, unauthenticated users are all denied,
3150 and any authenticated user name present in this list is also de‐
3151 nied. The contents of the deny_push list are examined before the
3152 allow-push list.
3153 deny_read
3155 Whether to deny reading/viewing of the repository. If this list
3157 is not empty, unauthenticated users are all denied, and any au‐
3158 thenticated user name present in this list is also denied access
3159 to the repository. If set to the special value *, all remote
3160 users are denied access (rarely needed ;). If deny_read is empty
3161 or not set, the determination of repository access depends on
3162 the presence and content of the allow_read list (see descrip‐
3163 tion). If both deny_read and allow_read are empty or not set,
3164 then access is permitted to all users by default. If the reposi‐
3165 tory is being served via hgwebdir, denied users will not be able
3166 to see it in the list of repositories. The contents of the
3167 deny_read list have priority over (are examined before) the con‐
3168 tents of the allow_read list.
3169 descend
3171 hgwebdir indexes will not descend into subdirectories. Only
3173 repositories directly in the current path will be shown (other
3174 repositories are still available from the index corresponding to
3175 their containing path).
3176 description
3178 Textual description of the repository's purpose or contents.
3180 (default: "unknown")
3181 encoding
3183 Character encoding name. (default: the current locale charset)
3185 Example: "UTF-8".
3186 errorlog
3188 Where to output the error log. (default: stderr)
3190 guessmime
3192 Control MIME types for raw download of file content. Set to
3194 True to let hgweb guess the content type from the file exten‐
3195 sion. This will serve HTML files as text/html and might allow
3196 cross-site scripting attacks when serving untrusted reposito‐
3197 ries. (default: False)
3198 hidden
3200 Whether to hide the repository in the hgwebdir index. (default:
3202 False)
3203 ipv6
3205 Whether to use IPv6. (default: False)
3207 labels
3209 List of string labels associated with the repository.
3211 Labels are exposed as a template keyword and can be used to cus‐
3213 tomize output. e.g. the index template can group or filter
3214 repositories by labels and the summary template can display ad‐
3215 ditional content if a specific label is present.
3216 logoimg
3218 File name of the logo image that some templates display on each
3220 page. The file name is relative to staticurl. That is, the full
3221 path to the logo image is "staticurl/logoimg". If unset, hgl‐
3222 ogo.png will be used.
3223 logourl
3225 Base URL to use for logos. If unset, https://mercurial-scm.org/
3227 will be used.
3228 maxchanges
3230 Maximum number of changes to list on the changelog. (default:
3232 10)
3233 maxfiles
3235 Maximum number of files to list per changeset. (default: 10)
3237 maxshortchanges
3239 Maximum number of changes to list on the shortlog, graph or
3241 filelog pages. (default: 60)
3242 name
3244 Repository name to use in the web interface. (default: current
3246 working directory)
3247 port
3249 Port to listen on. (default: 8000)
3251 prefix
3253 Prefix path to serve from. (default: '' (server root))
3255 push_ssl
3257 Whether to require that inbound pushes be transported over SSL
3259 to prevent password sniffing. (default: True)
3260 refreshinterval
3262 How frequently directory listings re-scan the filesystem for new
3264 repositories, in seconds. This is relevant when wildcards are
3265 used to define paths. Depending on how much filesystem traversal
3266 is required, refreshing may negatively impact performance.
3267 Values less than or equal to 0 always refresh. (default: 20)
3269 server-header
3271 Value for HTTP Server response header.
3273 static
3275 Directory where static files are served from.
3277 staticurl
3279 Base URL to use for static files. If unset, static files (e.g.
3281 the hgicon.png favicon) will be served by the CGI script itself.
3282 Use this setting to serve them directly with the HTTP server.
3283 Example: http://hgserver/static/.
3284 stripes
3286 How many lines a "zebra stripe" should span in multi-line out‐
3288 put. Set to 0 to disable. (default: 1)
3289 style
3291 Which template map style to use. The available options are the
3293 names of subdirectories in the HTML templates path. (default:
3294 paper) Example: monoblue.
3295 templates
3297 Where to find the HTML templates. The default path to the HTML
3299 templates can be obtained from hg debuginstall.
3300 websub
3302 Web substitution filter definition. You can use this section to define
3303 a set of regular expression substitution patterns which let you auto‐
3304 matically modify the hgweb server output.
3305 The default hgweb templates only apply these substitution patterns on
3307 the revision description fields. You can apply them anywhere you want
3308 when you create your own templates by adding calls to the "websub" fil‐
3309 ter (usually after calling the "escape" filter).
3310 This can be used, for example, to convert issue references to links to
3312 your issue tracker, or to convert "markdown-like" syntax into HTML (see
3313 the examples below).
3314 Each entry in this section names a substitution filter. The value of
3316 each entry defines the substitution expression itself. The websub ex‐
3317 pressions follow the old interhg extension syntax, which in turn imi‐
3318 tates the Unix sed replacement syntax:
3319 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
3321 You can use any separator other than "/". The final "i" is optional and
3323 indicates that the search must be case insensitive.
3324 Examples:
3326 [websub]
3328 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
3329 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
3330 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
3331 worker
3333 Parallel master/worker configuration. We currently perform working di‐
3334 rectory updates in parallel on Unix-like systems, which greatly helps
3335 performance.
3336 enabled
3338 Whether to enable workers code to be used. (default: true)
3340 numcpus
3342 Number of CPUs to use for parallel operations. A zero or nega‐
3344 tive value is treated as use the default. (default: 4 or the
3345 number of CPUs on the system, whichever is larger)
3346 backgroundclose
3348 Whether to enable closing file handles on background threads
3350 during certain operations. Some platforms aren't very efficient
3351 at closing file handles that have been written or appended to.
3352 By performing file closing on background threads, file write
3353 rate can increase substantially. (default: true on Windows,
3354 false elsewhere)
3355 backgroundcloseminfilecount
3357 Minimum number of files required to trigger background file
3359 closing. Operations not writing this many files won't start
3360 background close threads. (default: 2048)
3361 backgroundclosemaxqueue
3363 The maximum number of opened file handles waiting to be closed
3365 in the background. This option only has an effect if background‐
3366 close is enabled. (default: 384)
3367 backgroundclosethreadcount
3369 Number of threads to process background file closes. Only rele‐
3371 vant if backgroundclose is enabled. (default: 4)
3372
3374 Bryan O'Sullivan <bos@serpentine.com>.
3375 Mercurial was written by Matt Mackall <mpm@selenic.com>.
3377
3379 hg(1), hgignore(5)
3380
3382 This manual page is copyright 2005 Bryan O'Sullivan. Mercurial is
3383 copyright 2005-2021 Matt Mackall. Free use of this software is granted
3384 under the terms of the GNU General Public License version 2 or any
3385 later version.
3386
3388 Bryan O'Sullivan <bos@serpentine.com>
3389 Organization: Mercurial
3391 HGRC(5)