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