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