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