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