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