##// END OF EJS Templates
profiling: replace '+' markup of nested lines with indentation...
Mads Kiilerich -
r18642:a40d608e default
parent child Browse files
Show More
@@ -1,1477 +1,1476 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 ``fixeol``
853 ``fixeol``
854 Attempt to fix up EOL changes caused by the merge tool.
854 Attempt to fix up EOL changes caused by the merge tool.
855 Default: False
855 Default: False
856
856
857 ``gui``
857 ``gui``
858 This tool requires a graphical interface to run. Default: False
858 This tool requires a graphical interface to run. Default: False
859
859
860 ``regkey``
860 ``regkey``
861 Windows registry key which describes install location of this
861 Windows registry key which describes install location of this
862 tool. Mercurial will search for this key first under
862 tool. Mercurial will search for this key first under
863 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
863 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
864 Default: None
864 Default: None
865
865
866 ``regkeyalt``
866 ``regkeyalt``
867 An alternate Windows registry key to try if the first key is not
867 An alternate Windows registry key to try if the first key is not
868 found. The alternate key uses the same ``regname`` and ``regappend``
868 found. The alternate key uses the same ``regname`` and ``regappend``
869 semantics of the primary key. The most common use for this key
869 semantics of the primary key. The most common use for this key
870 is to search for 32bit applications on 64bit operating systems.
870 is to search for 32bit applications on 64bit operating systems.
871 Default: None
871 Default: None
872
872
873 ``regname``
873 ``regname``
874 Name of value to read from specified registry key. Defaults to the
874 Name of value to read from specified registry key. Defaults to the
875 unnamed (default) value.
875 unnamed (default) value.
876
876
877 ``regappend``
877 ``regappend``
878 String to append to the value read from the registry, typically
878 String to append to the value read from the registry, typically
879 the executable name of the tool.
879 the executable name of the tool.
880 Default: None
880 Default: None
881
881
882
882
883 ``patch``
883 ``patch``
884 ---------
884 ---------
885
885
886 Settings used when applying patches, for instance through the 'import'
886 Settings used when applying patches, for instance through the 'import'
887 command or with Mercurial Queues extension.
887 command or with Mercurial Queues extension.
888
888
889 ``eol``
889 ``eol``
890 When set to 'strict' patch content and patched files end of lines
890 When set to 'strict' patch content and patched files end of lines
891 are preserved. When set to ``lf`` or ``crlf``, both files end of
891 are preserved. When set to ``lf`` or ``crlf``, both files end of
892 lines are ignored when patching and the result line endings are
892 lines are ignored when patching and the result line endings are
893 normalized to either LF (Unix) or CRLF (Windows). When set to
893 normalized to either LF (Unix) or CRLF (Windows). When set to
894 ``auto``, end of lines are again ignored while patching but line
894 ``auto``, end of lines are again ignored while patching but line
895 endings in patched files are normalized to their original setting
895 endings in patched files are normalized to their original setting
896 on a per-file basis. If target file does not exist or has no end
896 on a per-file basis. If target file does not exist or has no end
897 of line, patch line endings are preserved.
897 of line, patch line endings are preserved.
898 Default: strict.
898 Default: strict.
899
899
900
900
901 ``paths``
901 ``paths``
902 ---------
902 ---------
903
903
904 Assigns symbolic names to repositories. The left side is the
904 Assigns symbolic names to repositories. The left side is the
905 symbolic name, and the right gives the directory or URL that is the
905 symbolic name, and the right gives the directory or URL that is the
906 location of the repository. Default paths can be declared by setting
906 location of the repository. Default paths can be declared by setting
907 the following entries.
907 the following entries.
908
908
909 ``default``
909 ``default``
910 Directory or URL to use when pulling if no source is specified.
910 Directory or URL to use when pulling if no source is specified.
911 Default is set to repository from which the current repository was
911 Default is set to repository from which the current repository was
912 cloned.
912 cloned.
913
913
914 ``default-push``
914 ``default-push``
915 Optional. Directory or URL to use when pushing if no destination
915 Optional. Directory or URL to use when pushing if no destination
916 is specified.
916 is specified.
917
917
918 Custom paths can be defined by assigning the path to a name that later can be
918 Custom paths can be defined by assigning the path to a name that later can be
919 used from the command line. Example::
919 used from the command line. Example::
920
920
921 [paths]
921 [paths]
922 my_path = http://example.com/path
922 my_path = http://example.com/path
923
923
924 To push to the path defined in ``my_path`` run the command::
924 To push to the path defined in ``my_path`` run the command::
925
925
926 hg push my_path
926 hg push my_path
927
927
928
928
929 ``phases``
929 ``phases``
930 ----------
930 ----------
931
931
932 Specifies default handling of phases. See :hg:`help phases` for more
932 Specifies default handling of phases. See :hg:`help phases` for more
933 information about working with phases.
933 information about working with phases.
934
934
935 ``publish``
935 ``publish``
936 Controls draft phase behavior when working as a server. When true,
936 Controls draft phase behavior when working as a server. When true,
937 pushed changesets are set to public in both client and server and
937 pushed changesets are set to public in both client and server and
938 pulled or cloned changesets are set to public in the client.
938 pulled or cloned changesets are set to public in the client.
939 Default: True
939 Default: True
940
940
941 ``new-commit``
941 ``new-commit``
942 Phase of newly-created commits.
942 Phase of newly-created commits.
943 Default: draft
943 Default: draft
944
944
945 ``profiling``
945 ``profiling``
946 -------------
946 -------------
947
947
948 Specifies profiling type, format, and file output. Two profilers are
948 Specifies profiling type, format, and file output. Two profilers are
949 supported: an instrumenting profiler (named ``ls``), and a sampling
949 supported: an instrumenting profiler (named ``ls``), and a sampling
950 profiler (named ``stat``).
950 profiler (named ``stat``).
951
951
952 In this section description, 'profiling data' stands for the raw data
952 In this section description, 'profiling data' stands for the raw data
953 collected during profiling, while 'profiling report' stands for a
953 collected during profiling, while 'profiling report' stands for a
954 statistical text report generated from the profiling data. The
954 statistical text report generated from the profiling data. The
955 profiling is done using lsprof.
955 profiling is done using lsprof.
956
956
957 ``type``
957 ``type``
958 The type of profiler to use.
958 The type of profiler to use.
959 Default: ls.
959 Default: ls.
960
960
961 ``ls``
961 ``ls``
962 Use Python's built-in instrumenting profiler. This profiler
962 Use Python's built-in instrumenting profiler. This profiler
963 works on all platforms, but each line number it reports is the
963 works on all platforms, but each line number it reports is the
964 first line of a function. This restriction makes it difficult to
964 first line of a function. This restriction makes it difficult to
965 identify the expensive parts of a non-trivial function.
965 identify the expensive parts of a non-trivial function.
966 ``stat``
966 ``stat``
967 Use a third-party statistical profiler, statprof. This profiler
967 Use a third-party statistical profiler, statprof. This profiler
968 currently runs only on Unix systems, and is most useful for
968 currently runs only on Unix systems, and is most useful for
969 profiling commands that run for longer than about 0.1 seconds.
969 profiling commands that run for longer than about 0.1 seconds.
970
970
971 ``format``
971 ``format``
972 Profiling format. Specific to the ``ls`` instrumenting profiler.
972 Profiling format. Specific to the ``ls`` instrumenting profiler.
973 Default: text.
973 Default: text.
974
974
975 ``text``
975 ``text``
976 Generate a profiling report. When saving to a file, it should be
976 Generate a profiling report. When saving to a file, it should be
977 noted that only the report is saved, and the profiling data is
977 noted that only the report is saved, and the profiling data is
978 not kept.
978 not kept.
979 ``kcachegrind``
979 ``kcachegrind``
980 Format profiling data for kcachegrind use: when saving to a
980 Format profiling data for kcachegrind use: when saving to a
981 file, the generated file can directly be loaded into
981 file, the generated file can directly be loaded into
982 kcachegrind.
982 kcachegrind.
983
983
984 ``frequency``
984 ``frequency``
985 Sampling frequency. Specific to the ``stat`` sampling profiler.
985 Sampling frequency. Specific to the ``stat`` sampling profiler.
986 Default: 1000.
986 Default: 1000.
987
987
988 ``output``
988 ``output``
989 File path where profiling data or report should be saved. If the
989 File path where profiling data or report should be saved. If the
990 file exists, it is replaced. Default: None, data is printed on
990 file exists, it is replaced. Default: None, data is printed on
991 stderr
991 stderr
992
992
993 ``sort``
993 ``sort``
994 Sort field. Specific to the ``ls`` instrumenting profiler.
994 Sort field. Specific to the ``ls`` instrumenting profiler.
995 One of ``callcount``, ``reccallcount``, ``totaltime`` and
995 One of ``callcount``, ``reccallcount``, ``totaltime`` and
996 ``inlinetime``.
996 ``inlinetime``.
997 Default: inlinetime.
997 Default: inlinetime.
998
998
999 ``limit``
999 ``limit``
1000 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1000 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1001 Default: 30.
1001 Default: 30.
1002
1002
1003 ``nested``
1003 ``nested``
1004 Show at most this number of lines of drill-down info in a tree structure
1004 Show at most this number of lines of drill-down info after each main entry.
1005 after each main entry. This can help explain the difference between Total
1005 This can help explain the difference between Total and Inline.
1006 and Inline.
1007 Specific to the ``ls`` instrumenting profiler.
1006 Specific to the ``ls`` instrumenting profiler.
1008 Default: 5.
1007 Default: 5.
1009
1008
1010 ``revsetalias``
1009 ``revsetalias``
1011 ---------------
1010 ---------------
1012
1011
1013 Alias definitions for revsets. See :hg:`help revsets` for details.
1012 Alias definitions for revsets. See :hg:`help revsets` for details.
1014
1013
1015 ``server``
1014 ``server``
1016 ----------
1015 ----------
1017
1016
1018 Controls generic server settings.
1017 Controls generic server settings.
1019
1018
1020 ``uncompressed``
1019 ``uncompressed``
1021 Whether to allow clients to clone a repository using the
1020 Whether to allow clients to clone a repository using the
1022 uncompressed streaming protocol. This transfers about 40% more
1021 uncompressed streaming protocol. This transfers about 40% more
1023 data than a regular clone, but uses less memory and CPU on both
1022 data than a regular clone, but uses less memory and CPU on both
1024 server and client. Over a LAN (100 Mbps or better) or a very fast
1023 server and client. Over a LAN (100 Mbps or better) or a very fast
1025 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1024 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1026 regular clone. Over most WAN connections (anything slower than
1025 regular clone. Over most WAN connections (anything slower than
1027 about 6 Mbps), uncompressed streaming is slower, because of the
1026 about 6 Mbps), uncompressed streaming is slower, because of the
1028 extra data transfer overhead. This mode will also temporarily hold
1027 extra data transfer overhead. This mode will also temporarily hold
1029 the write lock while determining what data to transfer.
1028 the write lock while determining what data to transfer.
1030 Default is True.
1029 Default is True.
1031
1030
1032 ``preferuncompressed``
1031 ``preferuncompressed``
1033 When set, clients will try to use the uncompressed streaming
1032 When set, clients will try to use the uncompressed streaming
1034 protocol. Default is False.
1033 protocol. Default is False.
1035
1034
1036 ``validate``
1035 ``validate``
1037 Whether to validate the completeness of pushed changesets by
1036 Whether to validate the completeness of pushed changesets by
1038 checking that all new file revisions specified in manifests are
1037 checking that all new file revisions specified in manifests are
1039 present. Default is False.
1038 present. Default is False.
1040
1039
1041 ``smtp``
1040 ``smtp``
1042 --------
1041 --------
1043
1042
1044 Configuration for extensions that need to send email messages.
1043 Configuration for extensions that need to send email messages.
1045
1044
1046 ``host``
1045 ``host``
1047 Host name of mail server, e.g. "mail.example.com".
1046 Host name of mail server, e.g. "mail.example.com".
1048
1047
1049 ``port``
1048 ``port``
1050 Optional. Port to connect to on mail server. Default: 25.
1049 Optional. Port to connect to on mail server. Default: 25.
1051
1050
1052 ``tls``
1051 ``tls``
1053 Optional. Method to enable TLS when connecting to mail server: starttls,
1052 Optional. Method to enable TLS when connecting to mail server: starttls,
1054 smtps or none. Default: none.
1053 smtps or none. Default: none.
1055
1054
1056 ``username``
1055 ``username``
1057 Optional. User name for authenticating with the SMTP server.
1056 Optional. User name for authenticating with the SMTP server.
1058 Default: none.
1057 Default: none.
1059
1058
1060 ``password``
1059 ``password``
1061 Optional. Password for authenticating with the SMTP server. If not
1060 Optional. Password for authenticating with the SMTP server. If not
1062 specified, interactive sessions will prompt the user for a
1061 specified, interactive sessions will prompt the user for a
1063 password; non-interactive sessions will fail. Default: none.
1062 password; non-interactive sessions will fail. Default: none.
1064
1063
1065 ``local_hostname``
1064 ``local_hostname``
1066 Optional. It's the hostname that the sender can use to identify
1065 Optional. It's the hostname that the sender can use to identify
1067 itself to the MTA.
1066 itself to the MTA.
1068
1067
1069
1068
1070 ``subpaths``
1069 ``subpaths``
1071 ------------
1070 ------------
1072
1071
1073 Subrepository source URLs can go stale if a remote server changes name
1072 Subrepository source URLs can go stale if a remote server changes name
1074 or becomes temporarily unavailable. This section lets you define
1073 or becomes temporarily unavailable. This section lets you define
1075 rewrite rules of the form::
1074 rewrite rules of the form::
1076
1075
1077 <pattern> = <replacement>
1076 <pattern> = <replacement>
1078
1077
1079 where ``pattern`` is a regular expression matching a subrepository
1078 where ``pattern`` is a regular expression matching a subrepository
1080 source URL and ``replacement`` is the replacement string used to
1079 source URL and ``replacement`` is the replacement string used to
1081 rewrite it. Groups can be matched in ``pattern`` and referenced in
1080 rewrite it. Groups can be matched in ``pattern`` and referenced in
1082 ``replacements``. For instance::
1081 ``replacements``. For instance::
1083
1082
1084 http://server/(.*)-hg/ = http://hg.server/\1/
1083 http://server/(.*)-hg/ = http://hg.server/\1/
1085
1084
1086 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1085 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1087
1086
1088 Relative subrepository paths are first made absolute, and the
1087 Relative subrepository paths are first made absolute, and the
1089 rewrite rules are then applied on the full (absolute) path. The rules
1088 rewrite rules are then applied on the full (absolute) path. The rules
1090 are applied in definition order.
1089 are applied in definition order.
1091
1090
1092 ``trusted``
1091 ``trusted``
1093 -----------
1092 -----------
1094
1093
1095 Mercurial will not use the settings in the
1094 Mercurial will not use the settings in the
1096 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1095 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1097 user or to a trusted group, as various hgrc features allow arbitrary
1096 user or to a trusted group, as various hgrc features allow arbitrary
1098 commands to be run. This issue is often encountered when configuring
1097 commands to be run. This issue is often encountered when configuring
1099 hooks or extensions for shared repositories or servers. However,
1098 hooks or extensions for shared repositories or servers. However,
1100 the web interface will use some safe settings from the ``[web]``
1099 the web interface will use some safe settings from the ``[web]``
1101 section.
1100 section.
1102
1101
1103 This section specifies what users and groups are trusted. The
1102 This section specifies what users and groups are trusted. The
1104 current user is always trusted. To trust everybody, list a user or a
1103 current user is always trusted. To trust everybody, list a user or a
1105 group with name ``*``. These settings must be placed in an
1104 group with name ``*``. These settings must be placed in an
1106 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1105 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1107 user or service running Mercurial.
1106 user or service running Mercurial.
1108
1107
1109 ``users``
1108 ``users``
1110 Comma-separated list of trusted users.
1109 Comma-separated list of trusted users.
1111
1110
1112 ``groups``
1111 ``groups``
1113 Comma-separated list of trusted groups.
1112 Comma-separated list of trusted groups.
1114
1113
1115
1114
1116 ``ui``
1115 ``ui``
1117 ------
1116 ------
1118
1117
1119 User interface controls.
1118 User interface controls.
1120
1119
1121 ``archivemeta``
1120 ``archivemeta``
1122 Whether to include the .hg_archival.txt file containing meta data
1121 Whether to include the .hg_archival.txt file containing meta data
1123 (hashes for the repository base and for tip) in archives created
1122 (hashes for the repository base and for tip) in archives created
1124 by the :hg:`archive` command or downloaded via hgweb.
1123 by the :hg:`archive` command or downloaded via hgweb.
1125 Default is True.
1124 Default is True.
1126
1125
1127 ``askusername``
1126 ``askusername``
1128 Whether to prompt for a username when committing. If True, and
1127 Whether to prompt for a username when committing. If True, and
1129 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1128 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1130 be prompted to enter a username. If no username is entered, the
1129 be prompted to enter a username. If no username is entered, the
1131 default ``USER@HOST`` is used instead.
1130 default ``USER@HOST`` is used instead.
1132 Default is False.
1131 Default is False.
1133
1132
1134 ``commitsubrepos``
1133 ``commitsubrepos``
1135 Whether to commit modified subrepositories when committing the
1134 Whether to commit modified subrepositories when committing the
1136 parent repository. If False and one subrepository has uncommitted
1135 parent repository. If False and one subrepository has uncommitted
1137 changes, abort the commit.
1136 changes, abort the commit.
1138 Default is False.
1137 Default is False.
1139
1138
1140 ``debug``
1139 ``debug``
1141 Print debugging information. True or False. Default is False.
1140 Print debugging information. True or False. Default is False.
1142
1141
1143 ``editor``
1142 ``editor``
1144 The editor to use during a commit. Default is ``$EDITOR`` or ``vi``.
1143 The editor to use during a commit. Default is ``$EDITOR`` or ``vi``.
1145
1144
1146 ``fallbackencoding``
1145 ``fallbackencoding``
1147 Encoding to try if it's not possible to decode the changelog using
1146 Encoding to try if it's not possible to decode the changelog using
1148 UTF-8. Default is ISO-8859-1.
1147 UTF-8. Default is ISO-8859-1.
1149
1148
1150 ``ignore``
1149 ``ignore``
1151 A file to read per-user ignore patterns from. This file should be
1150 A file to read per-user ignore patterns from. This file should be
1152 in the same format as a repository-wide .hgignore file. This
1151 in the same format as a repository-wide .hgignore file. This
1153 option supports hook syntax, so if you want to specify multiple
1152 option supports hook syntax, so if you want to specify multiple
1154 ignore files, you can do so by setting something like
1153 ignore files, you can do so by setting something like
1155 ``ignore.other = ~/.hgignore2``. For details of the ignore file
1154 ``ignore.other = ~/.hgignore2``. For details of the ignore file
1156 format, see the ``hgignore(5)`` man page.
1155 format, see the ``hgignore(5)`` man page.
1157
1156
1158 ``interactive``
1157 ``interactive``
1159 Allow to prompt the user. True or False. Default is True.
1158 Allow to prompt the user. True or False. Default is True.
1160
1159
1161 ``logtemplate``
1160 ``logtemplate``
1162 Template string for commands that print changesets.
1161 Template string for commands that print changesets.
1163
1162
1164 ``merge``
1163 ``merge``
1165 The conflict resolution program to use during a manual merge.
1164 The conflict resolution program to use during a manual merge.
1166 For more information on merge tools see :hg:`help merge-tools`.
1165 For more information on merge tools see :hg:`help merge-tools`.
1167 For configuring merge tools see the ``[merge-tools]`` section.
1166 For configuring merge tools see the ``[merge-tools]`` section.
1168
1167
1169 ``portablefilenames``
1168 ``portablefilenames``
1170 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1169 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1171 Default is ``warn``.
1170 Default is ``warn``.
1172 If set to ``warn`` (or ``true``), a warning message is printed on POSIX
1171 If set to ``warn`` (or ``true``), a warning message is printed on POSIX
1173 platforms, if a file with a non-portable filename is added (e.g. a file
1172 platforms, if a file with a non-portable filename is added (e.g. a file
1174 with a name that can't be created on Windows because it contains reserved
1173 with a name that can't be created on Windows because it contains reserved
1175 parts like ``AUX``, reserved characters like ``:``, or would cause a case
1174 parts like ``AUX``, reserved characters like ``:``, or would cause a case
1176 collision with an existing file).
1175 collision with an existing file).
1177 If set to ``ignore`` (or ``false``), no warning is printed.
1176 If set to ``ignore`` (or ``false``), no warning is printed.
1178 If set to ``abort``, the command is aborted.
1177 If set to ``abort``, the command is aborted.
1179 On Windows, this configuration option is ignored and the command aborted.
1178 On Windows, this configuration option is ignored and the command aborted.
1180
1179
1181 ``quiet``
1180 ``quiet``
1182 Reduce the amount of output printed. True or False. Default is False.
1181 Reduce the amount of output printed. True or False. Default is False.
1183
1182
1184 ``remotecmd``
1183 ``remotecmd``
1185 remote command to use for clone/push/pull operations. Default is ``hg``.
1184 remote command to use for clone/push/pull operations. Default is ``hg``.
1186
1185
1187 ``reportoldssl``
1186 ``reportoldssl``
1188 Warn if an SSL certificate is unable to be due to using Python
1187 Warn if an SSL certificate is unable to be due to using Python
1189 2.5 or earlier. True or False. Default is True.
1188 2.5 or earlier. True or False. Default is True.
1190
1189
1191 ``report_untrusted``
1190 ``report_untrusted``
1192 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1191 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1193 trusted user or group. True or False. Default is True.
1192 trusted user or group. True or False. Default is True.
1194
1193
1195 ``slash``
1194 ``slash``
1196 Display paths using a slash (``/``) as the path separator. This
1195 Display paths using a slash (``/``) as the path separator. This
1197 only makes a difference on systems where the default path
1196 only makes a difference on systems where the default path
1198 separator is not the slash character (e.g. Windows uses the
1197 separator is not the slash character (e.g. Windows uses the
1199 backslash character (``\``)).
1198 backslash character (``\``)).
1200 Default is False.
1199 Default is False.
1201
1200
1202 ``ssh``
1201 ``ssh``
1203 command to use for SSH connections. Default is ``ssh``.
1202 command to use for SSH connections. Default is ``ssh``.
1204
1203
1205 ``strict``
1204 ``strict``
1206 Require exact command names, instead of allowing unambiguous
1205 Require exact command names, instead of allowing unambiguous
1207 abbreviations. True or False. Default is False.
1206 abbreviations. True or False. Default is False.
1208
1207
1209 ``style``
1208 ``style``
1210 Name of style to use for command output.
1209 Name of style to use for command output.
1211
1210
1212 ``timeout``
1211 ``timeout``
1213 The timeout used when a lock is held (in seconds), a negative value
1212 The timeout used when a lock is held (in seconds), a negative value
1214 means no timeout. Default is 600.
1213 means no timeout. Default is 600.
1215
1214
1216 ``traceback``
1215 ``traceback``
1217 Mercurial always prints a traceback when an unknown exception
1216 Mercurial always prints a traceback when an unknown exception
1218 occurs. Setting this to True will make Mercurial print a traceback
1217 occurs. Setting this to True will make Mercurial print a traceback
1219 on all exceptions, even those recognized by Mercurial (such as
1218 on all exceptions, even those recognized by Mercurial (such as
1220 IOError or MemoryError). Default is False.
1219 IOError or MemoryError). Default is False.
1221
1220
1222 ``username``
1221 ``username``
1223 The committer of a changeset created when running "commit".
1222 The committer of a changeset created when running "commit".
1224 Typically a person's name and email address, e.g. ``Fred Widget
1223 Typically a person's name and email address, e.g. ``Fred Widget
1225 <fred@example.com>``. Default is ``$EMAIL`` or ``username@hostname``. If
1224 <fred@example.com>``. Default is ``$EMAIL`` or ``username@hostname``. If
1226 the username in hgrc is empty, it has to be specified manually or
1225 the username in hgrc is empty, it has to be specified manually or
1227 in a different hgrc file (e.g. ``$HOME/.hgrc``, if the admin set
1226 in a different hgrc file (e.g. ``$HOME/.hgrc``, if the admin set
1228 ``username =`` in the system hgrc). Environment variables in the
1227 ``username =`` in the system hgrc). Environment variables in the
1229 username are expanded.
1228 username are expanded.
1230
1229
1231 ``verbose``
1230 ``verbose``
1232 Increase the amount of output printed. True or False. Default is False.
1231 Increase the amount of output printed. True or False. Default is False.
1233
1232
1234
1233
1235 ``web``
1234 ``web``
1236 -------
1235 -------
1237
1236
1238 Web interface configuration. The settings in this section apply to
1237 Web interface configuration. The settings in this section apply to
1239 both the builtin webserver (started by :hg:`serve`) and the script you
1238 both the builtin webserver (started by :hg:`serve`) and the script you
1240 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1239 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1241 and WSGI).
1240 and WSGI).
1242
1241
1243 The Mercurial webserver does no authentication (it does not prompt for
1242 The Mercurial webserver does no authentication (it does not prompt for
1244 usernames and passwords to validate *who* users are), but it does do
1243 usernames and passwords to validate *who* users are), but it does do
1245 authorization (it grants or denies access for *authenticated users*
1244 authorization (it grants or denies access for *authenticated users*
1246 based on settings in this section). You must either configure your
1245 based on settings in this section). You must either configure your
1247 webserver to do authentication for you, or disable the authorization
1246 webserver to do authentication for you, or disable the authorization
1248 checks.
1247 checks.
1249
1248
1250 For a quick setup in a trusted environment, e.g., a private LAN, where
1249 For a quick setup in a trusted environment, e.g., a private LAN, where
1251 you want it to accept pushes from anybody, you can use the following
1250 you want it to accept pushes from anybody, you can use the following
1252 command line::
1251 command line::
1253
1252
1254 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1253 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1255
1254
1256 Note that this will allow anybody to push anything to the server and
1255 Note that this will allow anybody to push anything to the server and
1257 that this should not be used for public servers.
1256 that this should not be used for public servers.
1258
1257
1259 The full set of options is:
1258 The full set of options is:
1260
1259
1261 ``accesslog``
1260 ``accesslog``
1262 Where to output the access log. Default is stdout.
1261 Where to output the access log. Default is stdout.
1263
1262
1264 ``address``
1263 ``address``
1265 Interface address to bind to. Default is all.
1264 Interface address to bind to. Default is all.
1266
1265
1267 ``allow_archive``
1266 ``allow_archive``
1268 List of archive format (bz2, gz, zip) allowed for downloading.
1267 List of archive format (bz2, gz, zip) allowed for downloading.
1269 Default is empty.
1268 Default is empty.
1270
1269
1271 ``allowbz2``
1270 ``allowbz2``
1272 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1271 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1273 revisions.
1272 revisions.
1274 Default is False.
1273 Default is False.
1275
1274
1276 ``allowgz``
1275 ``allowgz``
1277 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1276 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1278 revisions.
1277 revisions.
1279 Default is False.
1278 Default is False.
1280
1279
1281 ``allowpull``
1280 ``allowpull``
1282 Whether to allow pulling from the repository. Default is True.
1281 Whether to allow pulling from the repository. Default is True.
1283
1282
1284 ``allow_push``
1283 ``allow_push``
1285 Whether to allow pushing to the repository. If empty or not set,
1284 Whether to allow pushing to the repository. If empty or not set,
1286 push is not allowed. If the special value ``*``, any remote user can
1285 push is not allowed. If the special value ``*``, any remote user can
1287 push, including unauthenticated users. Otherwise, the remote user
1286 push, including unauthenticated users. Otherwise, the remote user
1288 must have been authenticated, and the authenticated user name must
1287 must have been authenticated, and the authenticated user name must
1289 be present in this list. The contents of the allow_push list are
1288 be present in this list. The contents of the allow_push list are
1290 examined after the deny_push list.
1289 examined after the deny_push list.
1291
1290
1292 ``allow_read``
1291 ``allow_read``
1293 If the user has not already been denied repository access due to
1292 If the user has not already been denied repository access due to
1294 the contents of deny_read, this list determines whether to grant
1293 the contents of deny_read, this list determines whether to grant
1295 repository access to the user. If this list is not empty, and the
1294 repository access to the user. If this list is not empty, and the
1296 user is unauthenticated or not present in the list, then access is
1295 user is unauthenticated or not present in the list, then access is
1297 denied for the user. If the list is empty or not set, then access
1296 denied for the user. If the list is empty or not set, then access
1298 is permitted to all users by default. Setting allow_read to the
1297 is permitted to all users by default. Setting allow_read to the
1299 special value ``*`` is equivalent to it not being set (i.e. access
1298 special value ``*`` is equivalent to it not being set (i.e. access
1300 is permitted to all users). The contents of the allow_read list are
1299 is permitted to all users). The contents of the allow_read list are
1301 examined after the deny_read list.
1300 examined after the deny_read list.
1302
1301
1303 ``allowzip``
1302 ``allowzip``
1304 (DEPRECATED) Whether to allow .zip downloading of repository
1303 (DEPRECATED) Whether to allow .zip downloading of repository
1305 revisions. Default is False. This feature creates temporary files.
1304 revisions. Default is False. This feature creates temporary files.
1306
1305
1307 ``archivesubrepos``
1306 ``archivesubrepos``
1308 Whether to recurse into subrepositories when archiving. Default is
1307 Whether to recurse into subrepositories when archiving. Default is
1309 False.
1308 False.
1310
1309
1311 ``baseurl``
1310 ``baseurl``
1312 Base URL to use when publishing URLs in other locations, so
1311 Base URL to use when publishing URLs in other locations, so
1313 third-party tools like email notification hooks can construct
1312 third-party tools like email notification hooks can construct
1314 URLs. Example: ``http://hgserver/repos/``.
1313 URLs. Example: ``http://hgserver/repos/``.
1315
1314
1316 ``cacerts``
1315 ``cacerts``
1317 Path to file containing a list of PEM encoded certificate
1316 Path to file containing a list of PEM encoded certificate
1318 authority certificates. Environment variables and ``~user``
1317 authority certificates. Environment variables and ``~user``
1319 constructs are expanded in the filename. If specified on the
1318 constructs are expanded in the filename. If specified on the
1320 client, then it will verify the identity of remote HTTPS servers
1319 client, then it will verify the identity of remote HTTPS servers
1321 with these certificates.
1320 with these certificates.
1322
1321
1323 This feature is only supported when using Python 2.6 or later. If you wish
1322 This feature is only supported when using Python 2.6 or later. If you wish
1324 to use it with earlier versions of Python, install the backported
1323 to use it with earlier versions of Python, install the backported
1325 version of the ssl library that is available from
1324 version of the ssl library that is available from
1326 ``http://pypi.python.org``.
1325 ``http://pypi.python.org``.
1327
1326
1328 To disable SSL verification temporarily, specify ``--insecure`` from
1327 To disable SSL verification temporarily, specify ``--insecure`` from
1329 command line.
1328 command line.
1330
1329
1331 You can use OpenSSL's CA certificate file if your platform has
1330 You can use OpenSSL's CA certificate file if your platform has
1332 one. On most Linux systems this will be
1331 one. On most Linux systems this will be
1333 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
1332 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
1334 generate this file manually. The form must be as follows::
1333 generate this file manually. The form must be as follows::
1335
1334
1336 -----BEGIN CERTIFICATE-----
1335 -----BEGIN CERTIFICATE-----
1337 ... (certificate in base64 PEM encoding) ...
1336 ... (certificate in base64 PEM encoding) ...
1338 -----END CERTIFICATE-----
1337 -----END CERTIFICATE-----
1339 -----BEGIN CERTIFICATE-----
1338 -----BEGIN CERTIFICATE-----
1340 ... (certificate in base64 PEM encoding) ...
1339 ... (certificate in base64 PEM encoding) ...
1341 -----END CERTIFICATE-----
1340 -----END CERTIFICATE-----
1342
1341
1343 ``cache``
1342 ``cache``
1344 Whether to support caching in hgweb. Defaults to True.
1343 Whether to support caching in hgweb. Defaults to True.
1345
1344
1346 ``collapse``
1345 ``collapse``
1347 With ``descend`` enabled, repositories in subdirectories are shown at
1346 With ``descend`` enabled, repositories in subdirectories are shown at
1348 a single level alongside repositories in the current path. With
1347 a single level alongside repositories in the current path. With
1349 ``collapse`` also enabled, repositories residing at a deeper level than
1348 ``collapse`` also enabled, repositories residing at a deeper level than
1350 the current path are grouped behind navigable directory entries that
1349 the current path are grouped behind navigable directory entries that
1351 lead to the locations of these repositories. In effect, this setting
1350 lead to the locations of these repositories. In effect, this setting
1352 collapses each collection of repositories found within a subdirectory
1351 collapses each collection of repositories found within a subdirectory
1353 into a single entry for that subdirectory. Default is False.
1352 into a single entry for that subdirectory. Default is False.
1354
1353
1355 ``comparisoncontext``
1354 ``comparisoncontext``
1356 Number of lines of context to show in side-by-side file comparison. If
1355 Number of lines of context to show in side-by-side file comparison. If
1357 negative or the value ``full``, whole files are shown. Default is 5.
1356 negative or the value ``full``, whole files are shown. Default is 5.
1358 This setting can be overridden by a ``context`` request parameter to the
1357 This setting can be overridden by a ``context`` request parameter to the
1359 ``comparison`` command, taking the same values.
1358 ``comparison`` command, taking the same values.
1360
1359
1361 ``contact``
1360 ``contact``
1362 Name or email address of the person in charge of the repository.
1361 Name or email address of the person in charge of the repository.
1363 Defaults to ui.username or ``$EMAIL`` or "unknown" if unset or empty.
1362 Defaults to ui.username or ``$EMAIL`` or "unknown" if unset or empty.
1364
1363
1365 ``deny_push``
1364 ``deny_push``
1366 Whether to deny pushing to the repository. If empty or not set,
1365 Whether to deny pushing to the repository. If empty or not set,
1367 push is not denied. If the special value ``*``, all remote users are
1366 push is not denied. If the special value ``*``, all remote users are
1368 denied push. Otherwise, unauthenticated users are all denied, and
1367 denied push. Otherwise, unauthenticated users are all denied, and
1369 any authenticated user name present in this list is also denied. The
1368 any authenticated user name present in this list is also denied. The
1370 contents of the deny_push list are examined before the allow_push list.
1369 contents of the deny_push list are examined before the allow_push list.
1371
1370
1372 ``deny_read``
1371 ``deny_read``
1373 Whether to deny reading/viewing of the repository. If this list is
1372 Whether to deny reading/viewing of the repository. If this list is
1374 not empty, unauthenticated users are all denied, and any
1373 not empty, unauthenticated users are all denied, and any
1375 authenticated user name present in this list is also denied access to
1374 authenticated user name present in this list is also denied access to
1376 the repository. If set to the special value ``*``, all remote users
1375 the repository. If set to the special value ``*``, all remote users
1377 are denied access (rarely needed ;). If deny_read is empty or not set,
1376 are denied access (rarely needed ;). If deny_read is empty or not set,
1378 the determination of repository access depends on the presence and
1377 the determination of repository access depends on the presence and
1379 content of the allow_read list (see description). If both
1378 content of the allow_read list (see description). If both
1380 deny_read and allow_read are empty or not set, then access is
1379 deny_read and allow_read are empty or not set, then access is
1381 permitted to all users by default. If the repository is being
1380 permitted to all users by default. If the repository is being
1382 served via hgwebdir, denied users will not be able to see it in
1381 served via hgwebdir, denied users will not be able to see it in
1383 the list of repositories. The contents of the deny_read list have
1382 the list of repositories. The contents of the deny_read list have
1384 priority over (are examined before) the contents of the allow_read
1383 priority over (are examined before) the contents of the allow_read
1385 list.
1384 list.
1386
1385
1387 ``descend``
1386 ``descend``
1388 hgwebdir indexes will not descend into subdirectories. Only repositories
1387 hgwebdir indexes will not descend into subdirectories. Only repositories
1389 directly in the current path will be shown (other repositories are still
1388 directly in the current path will be shown (other repositories are still
1390 available from the index corresponding to their containing path).
1389 available from the index corresponding to their containing path).
1391
1390
1392 ``description``
1391 ``description``
1393 Textual description of the repository's purpose or contents.
1392 Textual description of the repository's purpose or contents.
1394 Default is "unknown".
1393 Default is "unknown".
1395
1394
1396 ``encoding``
1395 ``encoding``
1397 Character encoding name. Default is the current locale charset.
1396 Character encoding name. Default is the current locale charset.
1398 Example: "UTF-8"
1397 Example: "UTF-8"
1399
1398
1400 ``errorlog``
1399 ``errorlog``
1401 Where to output the error log. Default is stderr.
1400 Where to output the error log. Default is stderr.
1402
1401
1403 ``guessmime``
1402 ``guessmime``
1404 Control MIME types for raw download of file content.
1403 Control MIME types for raw download of file content.
1405 Set to True to let hgweb guess the content type from the file
1404 Set to True to let hgweb guess the content type from the file
1406 extension. This will serve HTML files as ``text/html`` and might
1405 extension. This will serve HTML files as ``text/html`` and might
1407 allow cross-site scripting attacks when serving untrusted
1406 allow cross-site scripting attacks when serving untrusted
1408 repositories. Default is False.
1407 repositories. Default is False.
1409
1408
1410 ``hidden``
1409 ``hidden``
1411 Whether to hide the repository in the hgwebdir index.
1410 Whether to hide the repository in the hgwebdir index.
1412 Default is False.
1411 Default is False.
1413
1412
1414 ``ipv6``
1413 ``ipv6``
1415 Whether to use IPv6. Default is False.
1414 Whether to use IPv6. Default is False.
1416
1415
1417 ``logoimg``
1416 ``logoimg``
1418 File name of the logo image that some templates display on each page.
1417 File name of the logo image that some templates display on each page.
1419 The file name is relative to ``staticurl``. That is, the full path to
1418 The file name is relative to ``staticurl``. That is, the full path to
1420 the logo image is "staticurl/logoimg".
1419 the logo image is "staticurl/logoimg".
1421 If unset, ``hglogo.png`` will be used.
1420 If unset, ``hglogo.png`` will be used.
1422
1421
1423 ``logourl``
1422 ``logourl``
1424 Base URL to use for logos. If unset, ``http://mercurial.selenic.com/``
1423 Base URL to use for logos. If unset, ``http://mercurial.selenic.com/``
1425 will be used.
1424 will be used.
1426
1425
1427 ``maxchanges``
1426 ``maxchanges``
1428 Maximum number of changes to list on the changelog. Default is 10.
1427 Maximum number of changes to list on the changelog. Default is 10.
1429
1428
1430 ``maxfiles``
1429 ``maxfiles``
1431 Maximum number of files to list per changeset. Default is 10.
1430 Maximum number of files to list per changeset. Default is 10.
1432
1431
1433 ``maxshortchanges``
1432 ``maxshortchanges``
1434 Maximum number of changes to list on the shortlog, graph or filelog
1433 Maximum number of changes to list on the shortlog, graph or filelog
1435 pages. Default is 60.
1434 pages. Default is 60.
1436
1435
1437 ``name``
1436 ``name``
1438 Repository name to use in the web interface. Default is current
1437 Repository name to use in the web interface. Default is current
1439 working directory.
1438 working directory.
1440
1439
1441 ``port``
1440 ``port``
1442 Port to listen on. Default is 8000.
1441 Port to listen on. Default is 8000.
1443
1442
1444 ``prefix``
1443 ``prefix``
1445 Prefix path to serve from. Default is '' (server root).
1444 Prefix path to serve from. Default is '' (server root).
1446
1445
1447 ``push_ssl``
1446 ``push_ssl``
1448 Whether to require that inbound pushes be transported over SSL to
1447 Whether to require that inbound pushes be transported over SSL to
1449 prevent password sniffing. Default is True.
1448 prevent password sniffing. Default is True.
1450
1449
1451 ``staticurl``
1450 ``staticurl``
1452 Base URL to use for static files. If unset, static files (e.g. the
1451 Base URL to use for static files. If unset, static files (e.g. the
1453 hgicon.png favicon) will be served by the CGI script itself. Use
1452 hgicon.png favicon) will be served by the CGI script itself. Use
1454 this setting to serve them directly with the HTTP server.
1453 this setting to serve them directly with the HTTP server.
1455 Example: ``http://hgserver/static/``.
1454 Example: ``http://hgserver/static/``.
1456
1455
1457 ``stripes``
1456 ``stripes``
1458 How many lines a "zebra stripe" should span in multi-line output.
1457 How many lines a "zebra stripe" should span in multi-line output.
1459 Default is 1; set to 0 to disable.
1458 Default is 1; set to 0 to disable.
1460
1459
1461 ``style``
1460 ``style``
1462 Which template map style to use.
1461 Which template map style to use.
1463
1462
1464 ``templates``
1463 ``templates``
1465 Where to find the HTML templates. Default is install path.
1464 Where to find the HTML templates. Default is install path.
1466
1465
1467 ``worker``
1466 ``worker``
1468 ----------
1467 ----------
1469
1468
1470 Parallel master/worker configuration. We currently perform working
1469 Parallel master/worker configuration. We currently perform working
1471 directory updates in parallel on Unix-like systems, which greatly
1470 directory updates in parallel on Unix-like systems, which greatly
1472 helps performance.
1471 helps performance.
1473
1472
1474 ``numcpus``
1473 ``numcpus``
1475 Number of CPUs to use for parallel operations. Default is 4 or the
1474 Number of CPUs to use for parallel operations. Default is 4 or the
1476 number of CPUs on the system, whichever is larger. A zero or
1475 number of CPUs on the system, whichever is larger. A zero or
1477 negative value is treated as ``use the default``.
1476 negative value is treated as ``use the default``.
@@ -1,109 +1,109 b''
1 import sys
1 import sys
2 from _lsprof import Profiler, profiler_entry
2 from _lsprof import Profiler, profiler_entry
3
3
4 __all__ = ['profile', 'Stats']
4 __all__ = ['profile', 'Stats']
5
5
6 def profile(f, *args, **kwds):
6 def profile(f, *args, **kwds):
7 """XXX docstring"""
7 """XXX docstring"""
8 p = Profiler()
8 p = Profiler()
9 p.enable(subcalls=True, builtins=True)
9 p.enable(subcalls=True, builtins=True)
10 try:
10 try:
11 f(*args, **kwds)
11 f(*args, **kwds)
12 finally:
12 finally:
13 p.disable()
13 p.disable()
14 return Stats(p.getstats())
14 return Stats(p.getstats())
15
15
16
16
17 class Stats(object):
17 class Stats(object):
18 """XXX docstring"""
18 """XXX docstring"""
19
19
20 def __init__(self, data):
20 def __init__(self, data):
21 self.data = data
21 self.data = data
22
22
23 def sort(self, crit="inlinetime"):
23 def sort(self, crit="inlinetime"):
24 """XXX docstring"""
24 """XXX docstring"""
25 if crit not in profiler_entry.__dict__:
25 if crit not in profiler_entry.__dict__:
26 raise ValueError("Can't sort by %s" % crit)
26 raise ValueError("Can't sort by %s" % crit)
27 self.data.sort(key=lambda x: getattr(x, crit), reverse=True)
27 self.data.sort(key=lambda x: getattr(x, crit), reverse=True)
28 for e in self.data:
28 for e in self.data:
29 if e.calls:
29 if e.calls:
30 e.calls.sort(key=lambda x: getattr(x, crit), reverse=True)
30 e.calls.sort(key=lambda x: getattr(x, crit), reverse=True)
31
31
32 def pprint(self, top=None, file=None, limit=None, climit=None):
32 def pprint(self, top=None, file=None, limit=None, climit=None):
33 """XXX docstring"""
33 """XXX docstring"""
34 if file is None:
34 if file is None:
35 file = sys.stdout
35 file = sys.stdout
36 d = self.data
36 d = self.data
37 if top is not None:
37 if top is not None:
38 d = d[:top]
38 d = d[:top]
39 cols = "% 12s %12s %11.4f %11.4f %s\n"
39 cols = "% 12s %12s %11.4f %11.4f %s\n"
40 hcols = "% 12s %12s %12s %12s %s\n"
40 hcols = "% 12s %12s %12s %12s %s\n"
41 file.write(hcols % ("CallCount", "Recursive", "Total(s)",
41 file.write(hcols % ("CallCount", "Recursive", "Total(s)",
42 "Inline(s)", "module:lineno(function)"))
42 "Inline(s)", "module:lineno(function)"))
43 count = 0
43 count = 0
44 for e in d:
44 for e in d:
45 file.write(cols % (e.callcount, e.reccallcount, e.totaltime,
45 file.write(cols % (e.callcount, e.reccallcount, e.totaltime,
46 e.inlinetime, label(e.code)))
46 e.inlinetime, label(e.code)))
47 count += 1
47 count += 1
48 if limit is not None and count == limit:
48 if limit is not None and count == limit:
49 return
49 return
50 ccount = 0
50 ccount = 0
51 if climit and e.calls:
51 if climit and e.calls:
52 for se in e.calls:
52 for se in e.calls:
53 file.write(cols % ("+%s" % se.callcount, se.reccallcount,
53 file.write(cols % (se.callcount, se.reccallcount,
54 se.totaltime, se.inlinetime,
54 se.totaltime, se.inlinetime,
55 "+%s" % label(se.code)))
55 " %s" % label(se.code)))
56 count += 1
56 count += 1
57 ccount += 1
57 ccount += 1
58 if limit is not None and count == limit:
58 if limit is not None and count == limit:
59 return
59 return
60 if climit is not None and ccount == climit:
60 if climit is not None and ccount == climit:
61 break
61 break
62
62
63 def freeze(self):
63 def freeze(self):
64 """Replace all references to code objects with string
64 """Replace all references to code objects with string
65 descriptions; this makes it possible to pickle the instance."""
65 descriptions; this makes it possible to pickle the instance."""
66
66
67 # this code is probably rather ickier than it needs to be!
67 # this code is probably rather ickier than it needs to be!
68 for i in range(len(self.data)):
68 for i in range(len(self.data)):
69 e = self.data[i]
69 e = self.data[i]
70 if not isinstance(e.code, str):
70 if not isinstance(e.code, str):
71 self.data[i] = type(e)((label(e.code),) + e[1:])
71 self.data[i] = type(e)((label(e.code),) + e[1:])
72 if e.calls:
72 if e.calls:
73 for j in range(len(e.calls)):
73 for j in range(len(e.calls)):
74 se = e.calls[j]
74 se = e.calls[j]
75 if not isinstance(se.code, str):
75 if not isinstance(se.code, str):
76 e.calls[j] = type(se)((label(se.code),) + se[1:])
76 e.calls[j] = type(se)((label(se.code),) + se[1:])
77
77
78 _fn2mod = {}
78 _fn2mod = {}
79
79
80 def label(code):
80 def label(code):
81 if isinstance(code, str):
81 if isinstance(code, str):
82 return code
82 return code
83 try:
83 try:
84 mname = _fn2mod[code.co_filename]
84 mname = _fn2mod[code.co_filename]
85 except KeyError:
85 except KeyError:
86 for k, v in list(sys.modules.iteritems()):
86 for k, v in list(sys.modules.iteritems()):
87 if v is None:
87 if v is None:
88 continue
88 continue
89 if not isinstance(getattr(v, '__file__', None), str):
89 if not isinstance(getattr(v, '__file__', None), str):
90 continue
90 continue
91 if v.__file__.startswith(code.co_filename):
91 if v.__file__.startswith(code.co_filename):
92 mname = _fn2mod[code.co_filename] = k
92 mname = _fn2mod[code.co_filename] = k
93 break
93 break
94 else:
94 else:
95 mname = _fn2mod[code.co_filename] = '<%s>' % code.co_filename
95 mname = _fn2mod[code.co_filename] = '<%s>' % code.co_filename
96
96
97 return '%s:%d(%s)' % (mname, code.co_firstlineno, code.co_name)
97 return '%s:%d(%s)' % (mname, code.co_firstlineno, code.co_name)
98
98
99
99
100 if __name__ == '__main__':
100 if __name__ == '__main__':
101 import os
101 import os
102 sys.argv = sys.argv[1:]
102 sys.argv = sys.argv[1:]
103 if not sys.argv:
103 if not sys.argv:
104 print >> sys.stderr, "usage: lsprof.py <script> <arguments...>"
104 print >> sys.stderr, "usage: lsprof.py <script> <arguments...>"
105 sys.exit(2)
105 sys.exit(2)
106 sys.path.insert(0, os.path.abspath(os.path.dirname(sys.argv[0])))
106 sys.path.insert(0, os.path.abspath(os.path.dirname(sys.argv[0])))
107 stats = profile(execfile, sys.argv[0], globals(), locals())
107 stats = profile(execfile, sys.argv[0], globals(), locals())
108 stats.sort()
108 stats.sort()
109 stats.pprint()
109 stats.pprint()
General Comments 0
You need to be logged in to leave comments. Login now