11 |
11 |
12 The above entries will be referred to as ``ui.username`` and |
12 The above entries will be referred to as ``ui.username`` and |
13 ``ui.verbose``, respectively. See the Syntax section below. |
13 ``ui.verbose``, respectively. See the Syntax section below. |
14 |
14 |
15 Files |
15 Files |
16 ----- |
16 ===== |
17 |
17 |
18 Mercurial reads configuration data from several files, if they exist. |
18 Mercurial reads configuration data from several files, if they exist. |
19 These files do not exist by default and you will have to create the |
19 These files do not exist by default and you will have to create the |
20 appropriate configuration files yourself: global configuration like |
20 appropriate configuration files yourself: global configuration like |
21 the username setting is typically put into |
21 the username setting is typically put into |
84 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will |
84 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will |
85 be read. Mercurial checks each of these locations in the specified |
85 be read. Mercurial checks each of these locations in the specified |
86 order until one or more configuration files are detected. |
86 order until one or more configuration files are detected. |
87 |
87 |
88 Syntax |
88 Syntax |
89 ------ |
89 ====== |
90 |
90 |
91 A configuration file consists of sections, led by a ``[section]`` header |
91 A configuration file consists of sections, led by a ``[section]`` header |
92 and followed by ``name = value`` entries (sometimes called |
92 and followed by ``name = value`` entries (sometimes called |
93 ``configuration keys``):: |
93 ``configuration keys``):: |
94 |
94 |
169 Quotation marks can be escaped by prefixing them with a backslash. Only |
169 Quotation marks can be escaped by prefixing them with a backslash. Only |
170 quotation marks at the beginning of a word is counted as a quotation |
170 quotation marks at the beginning of a word is counted as a quotation |
171 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``). |
171 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``). |
172 |
172 |
173 Sections |
173 Sections |
174 -------- |
174 ======== |
175 |
175 |
176 This section describes the different sections that may appear in a |
176 This section describes the different sections that may appear in a |
177 Mercurial configuration file, the purpose of each section, its possible |
177 Mercurial configuration file, the purpose of each section, its possible |
178 keys, and their possible values. |
178 keys, and their possible values. |
179 |
179 |
180 ``alias`` |
180 ``alias`` |
181 """"""""" |
181 --------- |
182 |
182 |
183 Defines command aliases. |
183 Defines command aliases. |
184 Aliases allow you to define your own commands in terms of other |
184 Aliases allow you to define your own commands in terms of other |
185 commands (or aliases), optionally including arguments. Positional |
185 commands (or aliases), optionally including arguments. Positional |
186 arguments in the form of ``$1``, ``$2``, etc in the alias definition |
186 arguments in the form of ``$1``, ``$2``, etc in the alias definition |
253 ``ignoreblanklines`` |
253 ``ignoreblanklines`` |
254 Ignore changes whose lines are all blank. |
254 Ignore changes whose lines are all blank. |
255 |
255 |
256 |
256 |
257 ``auth`` |
257 ``auth`` |
258 """""""" |
258 -------- |
259 |
259 |
260 Authentication credentials for HTTP authentication. This section |
260 Authentication credentials for HTTP authentication. This section |
261 allows you to store usernames and passwords for use when logging |
261 allows you to store usernames and passwords for use when logging |
262 *into* HTTP servers. See the ``[web]`` configuration section if |
262 *into* HTTP servers. See the ``[web]`` configuration section if |
263 you want to configure *who* can login to your HTTP server. |
263 you want to configure *who* can login to your HTTP server. |
320 If no suitable authentication entry is found, the user is prompted |
320 If no suitable authentication entry is found, the user is prompted |
321 for credentials as usual if required by the remote. |
321 for credentials as usual if required by the remote. |
322 |
322 |
323 |
323 |
324 ``decode/encode`` |
324 ``decode/encode`` |
325 """"""""""""""""" |
325 ----------------- |
326 |
326 |
327 Filters for transforming files on checkout/checkin. This would |
327 Filters for transforming files on checkout/checkin. This would |
328 typically be used for newline processing or other |
328 typically be used for newline processing or other |
329 localization/canonicalization of files. |
329 localization/canonicalization of files. |
330 |
330 |
367 translate line ending characters between Windows (CRLF) and Unix (LF) |
367 translate line ending characters between Windows (CRLF) and Unix (LF) |
368 format. We suggest you use the ``eol`` extension for convenience. |
368 format. We suggest you use the ``eol`` extension for convenience. |
369 |
369 |
370 |
370 |
371 ``defaults`` |
371 ``defaults`` |
372 """""""""""" |
372 ------------ |
373 |
373 |
374 (defaults are deprecated. Don't use them. Use aliases instead) |
374 (defaults are deprecated. Don't use them. Use aliases instead) |
375 |
375 |
376 Use the ``[defaults]`` section to define command defaults, i.e. the |
376 Use the ``[defaults]`` section to define command defaults, i.e. the |
377 default options/arguments to pass to the specified commands. |
377 default options/arguments to pass to the specified commands. |
387 defining command defaults. The command defaults will also be applied |
387 defining command defaults. The command defaults will also be applied |
388 to the aliases of the commands defined. |
388 to the aliases of the commands defined. |
389 |
389 |
390 |
390 |
391 ``diff`` |
391 ``diff`` |
392 """""""" |
392 -------- |
393 |
393 |
394 Settings used when displaying diffs. Everything except for ``unified`` |
394 Settings used when displaying diffs. Everything except for ``unified`` |
395 is a Boolean and defaults to False. See ``annotate`` section for |
395 is a Boolean and defaults to False. See ``annotate`` section for |
396 related options for the annotate command. |
396 related options for the annotate command. |
397 |
397 |
470 # us-ascii, utf-8 omitted, as they are tried first and last |
470 # us-ascii, utf-8 omitted, as they are tried first and last |
471 charsets = iso-8859-1, iso-8859-15, windows-1252 |
471 charsets = iso-8859-1, iso-8859-15, windows-1252 |
472 |
472 |
473 |
473 |
474 ``extensions`` |
474 ``extensions`` |
475 """""""""""""" |
475 -------------- |
476 |
476 |
477 Mercurial has an extension mechanism for adding new features. To |
477 Mercurial has an extension mechanism for adding new features. To |
478 enable an extension, create an entry for it in this section. |
478 enable an extension, create an entry for it in this section. |
479 |
479 |
480 If you know that the extension is already in Python's search path, |
480 If you know that the extension is already in Python's search path, |
497 # (this extension will get loaded from the file specified) |
497 # (this extension will get loaded from the file specified) |
498 myfeature = ~/.hgext/myfeature.py |
498 myfeature = ~/.hgext/myfeature.py |
499 |
499 |
500 |
500 |
501 ``format`` |
501 ``format`` |
502 """""""""" |
502 ---------- |
503 |
503 |
504 ``usestore`` |
504 ``usestore`` |
505 Enable or disable the "store" repository format which improves |
505 Enable or disable the "store" repository format which improves |
506 compatibility with systems that fold case or otherwise mangle |
506 compatibility with systems that fold case or otherwise mangle |
507 filenames. Enabled by default. Disabling this option will allow |
507 filenames. Enabled by default. Disabling this option will allow |
524 Mac OS X and spaces on Windows. Enabled by default. Disabling this |
524 Mac OS X and spaces on Windows. Enabled by default. Disabling this |
525 option ensures that the on-disk format of newly created |
525 option ensures that the on-disk format of newly created |
526 repositories will be compatible with Mercurial before version 1.7. |
526 repositories will be compatible with Mercurial before version 1.7. |
527 |
527 |
528 ``graph`` |
528 ``graph`` |
529 """"""""" |
529 --------- |
530 |
530 |
531 Web graph view configuration. This section let you change graph |
531 Web graph view configuration. This section let you change graph |
532 elements display properties by branches, for instance to make the |
532 elements display properties by branches, for instance to make the |
533 ``default`` branch stand out. |
533 ``default`` branch stand out. |
534 |
534 |
552 |
552 |
553 ``color`` |
553 ``color`` |
554 Set branch edges color in hexadecimal RGB notation. |
554 Set branch edges color in hexadecimal RGB notation. |
555 |
555 |
556 ``hooks`` |
556 ``hooks`` |
557 """"""""" |
557 --------- |
558 |
558 |
559 Commands or Python functions that get automatically executed by |
559 Commands or Python functions that get automatically executed by |
560 various actions such as starting or finishing a commit. Multiple |
560 various actions such as starting or finishing a commit. Multiple |
561 hooks can be run for the same action by appending a suffix to the |
561 hooks can be run for the same action by appending a suffix to the |
562 action. Overriding a site-wide hook can be done by changing its |
562 action. Overriding a site-wide hook can be done by changing its |
731 If a Python hook returns a "true" value or raises an exception, this |
731 If a Python hook returns a "true" value or raises an exception, this |
732 is treated as a failure. |
732 is treated as a failure. |
733 |
733 |
734 |
734 |
735 ``hostfingerprints`` |
735 ``hostfingerprints`` |
736 """""""""""""""""""" |
736 -------------------- |
737 |
737 |
738 Fingerprints of the certificates of known HTTPS servers. |
738 Fingerprints of the certificates of known HTTPS servers. |
739 A HTTPS connection to a server with a fingerprint configured here will |
739 A HTTPS connection to a server with a fingerprint configured here will |
740 only succeed if the servers certificate matches the fingerprint. |
740 only succeed if the servers certificate matches the fingerprint. |
741 This is very similar to how ssh known hosts works. |
741 This is very similar to how ssh known hosts works. |
773 ``always`` |
773 ``always`` |
774 Optional. Always use the proxy, even for localhost and any entries |
774 Optional. Always use the proxy, even for localhost and any entries |
775 in ``http_proxy.no``. True or False. Default: False. |
775 in ``http_proxy.no``. True or False. Default: False. |
776 |
776 |
777 ``merge-patterns`` |
777 ``merge-patterns`` |
778 """""""""""""""""" |
778 ------------------ |
779 |
779 |
780 This section specifies merge tools to associate with particular file |
780 This section specifies merge tools to associate with particular file |
781 patterns. Tools matched here will take precedence over the default |
781 patterns. Tools matched here will take precedence over the default |
782 merge tool. Patterns are globs by default, rooted at the repository |
782 merge tool. Patterns are globs by default, rooted at the repository |
783 root. |
783 root. |
905 of line, patch line endings are preserved. |
905 of line, patch line endings are preserved. |
906 Default: strict. |
906 Default: strict. |
907 |
907 |
908 |
908 |
909 ``paths`` |
909 ``paths`` |
910 """"""""" |
910 --------- |
911 |
911 |
912 Assigns symbolic names to repositories. The left side is the |
912 Assigns symbolic names to repositories. The left side is the |
913 symbolic name, and the right gives the directory or URL that is the |
913 symbolic name, and the right gives the directory or URL that is the |
914 location of the repository. Default paths can be declared by setting |
914 location of the repository. Default paths can be declared by setting |
915 the following entries. |
915 the following entries. |
938 ``new-commit`` |
938 ``new-commit`` |
939 Phase of newly-created commits. |
939 Phase of newly-created commits. |
940 Default: draft |
940 Default: draft |
941 |
941 |
942 ``profiling`` |
942 ``profiling`` |
943 """"""""""""" |
943 ------------- |
944 |
944 |
945 Specifies profiling type, format, and file output. Two profilers are |
945 Specifies profiling type, format, and file output. Two profilers are |
946 supported: an instrumenting profiler (named ``ls``), and a sampling |
946 supported: an instrumenting profiler (named ``ls``), and a sampling |
947 profiler (named ``stat``). |
947 profiler (named ``stat``). |
948 |
948 |
986 File path where profiling data or report should be saved. If the |
986 File path where profiling data or report should be saved. If the |
987 file exists, it is replaced. Default: None, data is printed on |
987 file exists, it is replaced. Default: None, data is printed on |
988 stderr |
988 stderr |
989 |
989 |
990 ``revsetalias`` |
990 ``revsetalias`` |
991 """"""""""""""" |
991 --------------- |
992 |
992 |
993 Alias definitions for revsets. See :hg:`help revsets` for details. |
993 Alias definitions for revsets. See :hg:`help revsets` for details. |
994 |
994 |
995 ``server`` |
995 ``server`` |
996 """""""""" |
996 ---------- |
997 |
997 |
998 Controls generic server settings. |
998 Controls generic server settings. |
999 |
999 |
1000 ``uncompressed`` |
1000 ``uncompressed`` |
1001 Whether to allow clients to clone a repository using the |
1001 Whether to allow clients to clone a repository using the |
1017 Whether to validate the completeness of pushed changesets by |
1017 Whether to validate the completeness of pushed changesets by |
1018 checking that all new file revisions specified in manifests are |
1018 checking that all new file revisions specified in manifests are |
1019 present. Default is False. |
1019 present. Default is False. |
1020 |
1020 |
1021 ``smtp`` |
1021 ``smtp`` |
1022 """""""" |
1022 -------- |
1023 |
1023 |
1024 Configuration for extensions that need to send email messages. |
1024 Configuration for extensions that need to send email messages. |
1025 |
1025 |
1026 ``host`` |
1026 ``host`` |
1027 Host name of mail server, e.g. "mail.example.com". |
1027 Host name of mail server, e.g. "mail.example.com". |
1068 Relative subrepository paths are first made absolute, and the |
1068 Relative subrepository paths are first made absolute, and the |
1069 rewrite rules are then applied on the full (absolute) path. The rules |
1069 rewrite rules are then applied on the full (absolute) path. The rules |
1070 are applied in definition order. |
1070 are applied in definition order. |
1071 |
1071 |
1072 ``trusted`` |
1072 ``trusted`` |
1073 """"""""""" |
1073 ----------- |
1074 |
1074 |
1075 Mercurial will not use the settings in the |
1075 Mercurial will not use the settings in the |
1076 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted |
1076 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted |
1077 user or to a trusted group, as various hgrc features allow arbitrary |
1077 user or to a trusted group, as various hgrc features allow arbitrary |
1078 commands to be run. This issue is often encountered when configuring |
1078 commands to be run. This issue is often encountered when configuring |