##// END OF EJS Templates
make hgrc man page tell about ~/.hgrc on Windows
Peter Arrenbrecht -
r6310:1a13a5bb default
parent child Browse files
Show More
@@ -1,692 +1,705 b''
1 1 HGRC(5)
2 2 =======
3 3 Bryan O'Sullivan <bos@serpentine.com>
4 4
5 5 NAME
6 6 ----
7 7 hgrc - configuration files for Mercurial
8 8
9 9 SYNOPSIS
10 10 --------
11 11
12 12 The Mercurial system uses a set of configuration files to control
13 13 aspects of its behaviour.
14 14
15 15 FILES
16 16 -----
17 17
18 18 Mercurial reads configuration data from several files, if they exist.
19 19 The names of these files depend on the system on which Mercurial is
20 installed. Windows registry keys contain PATH-like strings, every
21 part must reference a Mercurial.ini file or be a directory where *.rc
22 files will be read.
20 installed. *.rc files from a single directory are read in
21 alphabetical order, later ones overriding earlier ones. Where
22 multiple paths are given below, settings from later paths override
23 earlier ones.
23 24
24 25 (Unix) <install-root>/etc/mercurial/hgrc.d/*.rc::
25 26 (Unix) <install-root>/etc/mercurial/hgrc::
26 27 Per-installation configuration files, searched for in the
27 directory where Mercurial is installed. For example, if installed
28 in /shared/tools, Mercurial will look in
29 /shared/tools/etc/mercurial/hgrc. Options in these files apply to
30 all Mercurial commands executed by any user in any directory.
28 directory where Mercurial is installed. <install-root> is the
29 parent directory of the hg executable (or symlink) being run.
30 For example, if installed in /shared/tools/bin/hg, Mercurial will
31 look in /shared/tools/etc/mercurial/hgrc. Options in these files
32 apply to all Mercurial commands executed by any user in any
33 directory.
31 34
32 35 (Unix) /etc/mercurial/hgrc.d/*.rc::
33 36 (Unix) /etc/mercurial/hgrc::
34 (Windows) HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial::
35 or::
36 (Windows) C:\Mercurial\Mercurial.ini::
37 37 Per-system configuration files, for the system on which Mercurial
38 38 is running. Options in these files apply to all Mercurial
39 39 commands executed by any user in any directory. Options in these
40 40 files override per-installation options.
41 41
42 (Windows) <install-dir>\Mercurial.ini::
43 or else::
44 (Windows) HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial::
45 or else::
46 (Windows) C:\Mercurial\Mercurial.ini::
47 Per-installation/system configuration files, for the system on
48 which Mercurial is running. Options in these files apply to all
49 Mercurial commands executed by any user in any directory.
50 Registry keys contain PATH-like strings, every part of which must
51 reference a Mercurial.ini file or be a directory where *.rc files
52 will be read.
53
42 54 (Unix) $HOME/.hgrc::
43 (Windows) C:\Documents and Settings\USERNAME\Mercurial.ini::
44 (Windows) $HOME\Mercurial.ini::
45 Per-user configuration file, for the user running Mercurial.
46 Options in this file apply to all Mercurial commands executed by
47 any user in any directory. Options in this file override
55 (Windows) %HOME%\Mercurial.ini::
56 (Windows) %HOME%\.hgrc::
57 (Windows) %USERPROFILE%\Mercurial.ini::
58 (Windows) %USERPROFILE%\.hgrc::
59 Per-user configuration file(s), for the user running Mercurial.
60 On Windows 9x, %HOME% is replaced by %APPDATA%.
61 Options in these files apply to all Mercurial commands executed
62 by this user in any directory. Options in thes files override
48 63 per-installation and per-system options.
49 On Windows system, one of these is chosen exclusively according
50 to definition of HOME environment variable.
51 64
52 65 (Unix, Windows) <repo>/.hg/hgrc::
53 66 Per-repository configuration options that only apply in a
54 67 particular repository. This file is not version-controlled, and
55 68 will not get transferred during a "clone" operation. Options in
56 69 this file override options in all other configuration files.
57 70 On Unix, most of this file will be ignored if it doesn't belong
58 71 to a trusted user or to a trusted group. See the documentation
59 72 for the trusted section below for more details.
60 73
61 74 SYNTAX
62 75 ------
63 76
64 77 A configuration file consists of sections, led by a "[section]" header
65 78 and followed by "name: value" entries; "name=value" is also accepted.
66 79
67 80 [spam]
68 81 eggs=ham
69 82 green=
70 83 eggs
71 84
72 85 Each line contains one entry. If the lines that follow are indented,
73 86 they are treated as continuations of that entry.
74 87
75 88 Leading whitespace is removed from values. Empty lines are skipped.
76 89
77 90 The optional values can contain format strings which refer to other
78 91 values in the same section, or values in a special DEFAULT section.
79 92
80 93 Lines beginning with "#" or ";" are ignored and may be used to provide
81 94 comments.
82 95
83 96 SECTIONS
84 97 --------
85 98
86 99 This section describes the different sections that may appear in a
87 100 Mercurial "hgrc" file, the purpose of each section, its possible
88 101 keys, and their possible values.
89 102
90 103 decode/encode::
91 104 Filters for transforming files on checkout/checkin. This would
92 105 typically be used for newline processing or other
93 106 localization/canonicalization of files.
94 107
95 108 Filters consist of a filter pattern followed by a filter command.
96 109 Filter patterns are globs by default, rooted at the repository
97 110 root. For example, to match any file ending in ".txt" in the root
98 111 directory only, use the pattern "*.txt". To match any file ending
99 112 in ".c" anywhere in the repository, use the pattern "**.c".
100 113
101 114 The filter command can start with a specifier, either "pipe:" or
102 115 "tempfile:". If no specifier is given, "pipe:" is used by default.
103 116
104 117 A "pipe:" command must accept data on stdin and return the
105 118 transformed data on stdout.
106 119
107 120 Pipe example:
108 121
109 122 [encode]
110 123 # uncompress gzip files on checkin to improve delta compression
111 124 # note: not necessarily a good idea, just an example
112 125 *.gz = pipe: gunzip
113 126
114 127 [decode]
115 128 # recompress gzip files when writing them to the working dir (we
116 129 # can safely omit "pipe:", because it's the default)
117 130 *.gz = gzip
118 131
119 132 A "tempfile:" command is a template. The string INFILE is replaced
120 133 with the name of a temporary file that contains the data to be
121 134 filtered by the command. The string OUTFILE is replaced with the
122 135 name of an empty temporary file, where the filtered data must be
123 136 written by the command.
124 137
125 138 NOTE: the tempfile mechanism is recommended for Windows systems,
126 139 where the standard shell I/O redirection operators often have
127 140 strange effects and may corrupt the contents of your files.
128 141
129 142 The most common usage is for LF <-> CRLF translation on Windows.
130 143 For this, use the "smart" convertors which check for binary files:
131 144
132 145 [extensions]
133 146 hgext.win32text =
134 147 [encode]
135 148 ** = cleverencode:
136 149 [decode]
137 150 ** = cleverdecode:
138 151
139 152 or if you only want to translate certain files:
140 153
141 154 [extensions]
142 155 hgext.win32text =
143 156 [encode]
144 157 **.txt = dumbencode:
145 158 [decode]
146 159 **.txt = dumbdecode:
147 160
148 161 defaults::
149 162 Use the [defaults] section to define command defaults, i.e. the
150 163 default options/arguments to pass to the specified commands.
151 164
152 165 The following example makes 'hg log' run in verbose mode, and
153 166 'hg status' show only the modified files, by default.
154 167
155 168 [defaults]
156 169 log = -v
157 170 status = -m
158 171
159 172 The actual commands, instead of their aliases, must be used when
160 173 defining command defaults. The command defaults will also be
161 174 applied to the aliases of the commands defined.
162 175
163 176 diff::
164 177 Settings used when displaying diffs. They are all boolean and
165 178 defaults to False.
166 179 git;;
167 180 Use git extended diff format.
168 181 nodates;;
169 182 Don't include dates in diff headers.
170 183 showfunc;;
171 184 Show which function each change is in.
172 185 ignorews;;
173 186 Ignore white space when comparing lines.
174 187 ignorewsamount;;
175 188 Ignore changes in the amount of white space.
176 189 ignoreblanklines;;
177 190 Ignore changes whose lines are all blank.
178 191
179 192 email::
180 193 Settings for extensions that send email messages.
181 194 from;;
182 195 Optional. Email address to use in "From" header and SMTP envelope
183 196 of outgoing messages.
184 197 to;;
185 198 Optional. Comma-separated list of recipients' email addresses.
186 199 cc;;
187 200 Optional. Comma-separated list of carbon copy recipients'
188 201 email addresses.
189 202 bcc;;
190 203 Optional. Comma-separated list of blind carbon copy
191 204 recipients' email addresses. Cannot be set interactively.
192 205 method;;
193 206 Optional. Method to use to send email messages. If value is
194 207 "smtp" (default), use SMTP (see section "[smtp]" for
195 208 configuration). Otherwise, use as name of program to run that
196 209 acts like sendmail (takes "-f" option for sender, list of
197 210 recipients on command line, message on stdin). Normally, setting
198 211 this to "sendmail" or "/usr/sbin/sendmail" is enough to use
199 212 sendmail to send messages.
200 213
201 214 Email example:
202 215
203 216 [email]
204 217 from = Joseph User <joe.user@example.com>
205 218 method = /usr/sbin/sendmail
206 219
207 220 extensions::
208 221 Mercurial has an extension mechanism for adding new features. To
209 222 enable an extension, create an entry for it in this section.
210 223
211 224 If you know that the extension is already in Python's search path,
212 225 you can give the name of the module, followed by "=", with nothing
213 226 after the "=".
214 227
215 228 Otherwise, give a name that you choose, followed by "=", followed by
216 229 the path to the ".py" file (including the file name extension) that
217 230 defines the extension.
218 231
219 232 To explicitly disable an extension that is enabled in an hgrc of
220 233 broader scope, prepend its path with '!', as in
221 234 'hgext.foo = !/ext/path' or 'hgext.foo = !' when no path is supplied.
222 235
223 236 Example for ~/.hgrc:
224 237
225 238 [extensions]
226 239 # (the mq extension will get loaded from mercurial's path)
227 240 hgext.mq =
228 241 # (this extension will get loaded from the file specified)
229 242 myfeature = ~/.hgext/myfeature.py
230 243
231 244 format::
232 245
233 246 usestore;;
234 247 Enable or disable the "store" repository format which improves
235 248 compatibility with systems that fold case or otherwise mangle
236 249 filenames. Enabled by default. Disabling this option will allow
237 250 you to store longer filenames in some situations at the expense of
238 251 compatibility.
239 252
240 253 merge-patterns::
241 254 This section specifies merge tools to associate with particular file
242 255 patterns. Tools matched here will take precedence over the default
243 256 merge tool. Patterns are globs by default, rooted at the repository root.
244 257
245 258 Example:
246 259
247 260 [merge-patterns]
248 261 **.c = kdiff3
249 262 **.jpg = myimgmerge
250 263
251 264 merge-tools::
252 265 This section configures external merge tools to use for file-level
253 266 merges.
254 267
255 268 Example ~/.hgrc:
256 269
257 270 [merge-tools]
258 271 # Override stock tool location
259 272 kdiff3.executable = ~/bin/kdiff3
260 273 # Specify command line
261 274 kdiff3.args = $base $local $other -o $output
262 275 # Give higher priority
263 276 kdiff3.priority = 1
264 277
265 278 # Define new tool
266 279 myHtmlTool.args = -m $local $other $base $output
267 280 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
268 281 myHtmlTool.priority = 1
269 282
270 283 Supported arguments:
271 284 priority;;
272 285 The priority in which to evaluate this tool.
273 286 Default: 0.
274 287 executable;;
275 288 Either just the name of the executable or its pathname.
276 289 Default: the tool name.
277 290 args;;
278 291 The arguments to pass to the tool executable. You can refer to the files
279 292 being merged as well as the output file through these variables: $base,
280 293 $local, $other, $output.
281 294 Default: $local $base $other
282 295 premerge;;
283 296 Attempt to run internal non-interactive 3-way merge tool before
284 297 launching external tool.
285 298 Default: True
286 299 binary;;
287 300 This tool can merge binary files. Defaults to False, unless tool
288 301 was selected by file pattern match.
289 302 symlink;;
290 303 This tool can merge symlinks. Defaults to False, even if tool was
291 304 selected by file pattern match.
292 305 checkconflicts;;
293 306 Check whether there are conflicts even though the tool reported
294 307 success.
295 308 Default: False
296 309 checkchanged;;
297 310 Check whether outputs were written even though the tool reported
298 311 success.
299 312 Default: False
300 313 fixeol;;
301 314 Attempt to fix up EOL changes caused by the merge tool.
302 315 Default: False
303 316 gui:;
304 317 This tool requires a graphical interface to run. Default: False
305 318 regkey;;
306 319 Windows registry key which describes install location of this tool.
307 320 Mercurial will search for this key first under HKEY_CURRENT_USER and
308 321 then under HKEY_LOCAL_MACHINE. Default: None
309 322 regname;;
310 323 Name of value to read from specified registry key. Defaults to the
311 324 unnamed (default) value.
312 325 regappend;;
313 326 String to append to the value read from the registry, typically the
314 327 executable name of the tool. Default: None
315 328
316 329 hooks::
317 330 Commands or Python functions that get automatically executed by
318 331 various actions such as starting or finishing a commit. Multiple
319 332 hooks can be run for the same action by appending a suffix to the
320 333 action. Overriding a site-wide hook can be done by changing its
321 334 value or setting it to an empty string.
322 335
323 336 Example .hg/hgrc:
324 337
325 338 [hooks]
326 339 # do not use the site-wide hook
327 340 incoming =
328 341 incoming.email = /my/email/hook
329 342 incoming.autobuild = /my/build/hook
330 343
331 344 Most hooks are run with environment variables set that give added
332 345 useful information. For each hook below, the environment variables
333 346 it is passed are listed with names of the form "$HG_foo".
334 347
335 348 changegroup;;
336 349 Run after a changegroup has been added via push, pull or
337 350 unbundle. ID of the first new changeset is in $HG_NODE. URL from
338 351 which changes came is in $HG_URL.
339 352 commit;;
340 353 Run after a changeset has been created in the local repository.
341 354 ID of the newly created changeset is in $HG_NODE. Parent
342 355 changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
343 356 incoming;;
344 357 Run after a changeset has been pulled, pushed, or unbundled into
345 358 the local repository. The ID of the newly arrived changeset is in
346 359 $HG_NODE. URL that was source of changes came is in $HG_URL.
347 360 outgoing;;
348 361 Run after sending changes from local repository to another. ID of
349 362 first changeset sent is in $HG_NODE. Source of operation is in
350 363 $HG_SOURCE; see "preoutgoing" hook for description.
351 364 post-<command>;;
352 365 Run after successful invocations of the associated command. The
353 366 contents of the command line are passed as $HG_ARGS and the result
354 367 code in $HG_RESULT. Hook failure is ignored.
355 368 pre-<command>;;
356 369 Run before executing the associated command. The contents of the
357 370 command line are passed as $HG_ARGS. If the hook returns failure,
358 371 the command doesn't execute and Mercurial returns the failure code.
359 372 prechangegroup;;
360 373 Run before a changegroup is added via push, pull or unbundle.
361 374 Exit status 0 allows the changegroup to proceed. Non-zero status
362 375 will cause the push, pull or unbundle to fail. URL from which
363 376 changes will come is in $HG_URL.
364 377 precommit;;
365 378 Run before starting a local commit. Exit status 0 allows the
366 379 commit to proceed. Non-zero status will cause the commit to fail.
367 380 Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
368 381 preoutgoing;;
369 382 Run before collecting changes to send from the local repository to
370 383 another. Non-zero status will cause failure. This lets you
371 384 prevent pull over http or ssh. Also prevents against local pull,
372 385 push (outbound) or bundle commands, but not effective, since you
373 386 can just copy files instead then. Source of operation is in
374 387 $HG_SOURCE. If "serve", operation is happening on behalf of
375 388 remote ssh or http repository. If "push", "pull" or "bundle",
376 389 operation is happening on behalf of repository on same system.
377 390 pretag;;
378 391 Run before creating a tag. Exit status 0 allows the tag to be
379 392 created. Non-zero status will cause the tag to fail. ID of
380 393 changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag
381 394 is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0.
382 395 pretxnchangegroup;;
383 396 Run after a changegroup has been added via push, pull or unbundle,
384 397 but before the transaction has been committed. Changegroup is
385 398 visible to hook program. This lets you validate incoming changes
386 399 before accepting them. Passed the ID of the first new changeset
387 400 in $HG_NODE. Exit status 0 allows the transaction to commit.
388 401 Non-zero status will cause the transaction to be rolled back and
389 402 the push, pull or unbundle will fail. URL that was source of
390 403 changes is in $HG_URL.
391 404 pretxncommit;;
392 405 Run after a changeset has been created but the transaction not yet
393 406 committed. Changeset is visible to hook program. This lets you
394 407 validate commit message and changes. Exit status 0 allows the
395 408 commit to proceed. Non-zero status will cause the transaction to
396 409 be rolled back. ID of changeset is in $HG_NODE. Parent changeset
397 410 IDs are in $HG_PARENT1 and $HG_PARENT2.
398 411 preupdate;;
399 412 Run before updating the working directory. Exit status 0 allows
400 413 the update to proceed. Non-zero status will prevent the update.
401 414 Changeset ID of first new parent is in $HG_PARENT1. If merge, ID
402 415 of second new parent is in $HG_PARENT2.
403 416 tag;;
404 417 Run after a tag is created. ID of tagged changeset is in
405 418 $HG_NODE. Name of tag is in $HG_TAG. Tag is local if
406 419 $HG_LOCAL=1, in repo if $HG_LOCAL=0.
407 420 update;;
408 421 Run after updating the working directory. Changeset ID of first
409 422 new parent is in $HG_PARENT1. If merge, ID of second new parent
410 423 is in $HG_PARENT2. If update succeeded, $HG_ERROR=0. If update
411 424 failed (e.g. because conflicts not resolved), $HG_ERROR=1.
412 425
413 426 Note: it is generally better to use standard hooks rather than the
414 427 generic pre- and post- command hooks as they are guaranteed to be
415 428 called in the appropriate contexts for influencing transactions.
416 429 Also, hooks like "commit" will be called in all contexts that
417 430 generate a commit (eg. tag) and not just the commit command.
418 431
419 432 Note2: Environment variables with empty values may not be passed to
420 433 hooks on platforms like Windows. For instance, $HG_PARENT2 will
421 434 not be available under Windows for non-merge changesets while being
422 435 set to an empty value under Unix-like systems.
423 436
424 437 The syntax for Python hooks is as follows:
425 438
426 439 hookname = python:modulename.submodule.callable
427 440
428 441 Python hooks are run within the Mercurial process. Each hook is
429 442 called with at least three keyword arguments: a ui object (keyword
430 443 "ui"), a repository object (keyword "repo"), and a "hooktype"
431 444 keyword that tells what kind of hook is used. Arguments listed as
432 445 environment variables above are passed as keyword arguments, with no
433 446 "HG_" prefix, and names in lower case.
434 447
435 448 If a Python hook returns a "true" value or raises an exception, this
436 449 is treated as failure of the hook.
437 450
438 451 http_proxy::
439 452 Used to access web-based Mercurial repositories through a HTTP
440 453 proxy.
441 454 host;;
442 455 Host name and (optional) port of the proxy server, for example
443 456 "myproxy:8000".
444 457 no;;
445 458 Optional. Comma-separated list of host names that should bypass
446 459 the proxy.
447 460 passwd;;
448 461 Optional. Password to authenticate with at the proxy server.
449 462 user;;
450 463 Optional. User name to authenticate with at the proxy server.
451 464
452 465 smtp::
453 466 Configuration for extensions that need to send email messages.
454 467 host;;
455 468 Host name of mail server, e.g. "mail.example.com".
456 469 port;;
457 470 Optional. Port to connect to on mail server. Default: 25.
458 471 tls;;
459 472 Optional. Whether to connect to mail server using TLS. True or
460 473 False. Default: False.
461 474 username;;
462 475 Optional. User name to authenticate to SMTP server with.
463 476 If username is specified, password must also be specified.
464 477 Default: none.
465 478 password;;
466 479 Optional. Password to authenticate to SMTP server with.
467 480 If username is specified, password must also be specified.
468 481 Default: none.
469 482 local_hostname;;
470 483 Optional. It's the hostname that the sender can use to identify itself
471 484 to the MTA.
472 485
473 486 paths::
474 487 Assigns symbolic names to repositories. The left side is the
475 488 symbolic name, and the right gives the directory or URL that is the
476 489 location of the repository. Default paths can be declared by
477 490 setting the following entries.
478 491 default;;
479 492 Directory or URL to use when pulling if no source is specified.
480 493 Default is set to repository from which the current repository
481 494 was cloned.
482 495 default-push;;
483 496 Optional. Directory or URL to use when pushing if no destination
484 497 is specified.
485 498
486 499 server::
487 500 Controls generic server settings.
488 501 uncompressed;;
489 502 Whether to allow clients to clone a repo using the uncompressed
490 503 streaming protocol. This transfers about 40% more data than a
491 504 regular clone, but uses less memory and CPU on both server and
492 505 client. Over a LAN (100Mbps or better) or a very fast WAN, an
493 506 uncompressed streaming clone is a lot faster (~10x) than a regular
494 507 clone. Over most WAN connections (anything slower than about
495 508 6Mbps), uncompressed streaming is slower, because of the extra
496 509 data transfer overhead. Default is False.
497 510
498 511 trusted::
499 512 For security reasons, Mercurial will not use the settings in
500 513 the .hg/hgrc file from a repository if it doesn't belong to a
501 514 trusted user or to a trusted group. The main exception is the
502 515 web interface, which automatically uses some safe settings, since
503 516 it's common to serve repositories from different users.
504 517
505 518 This section specifies what users and groups are trusted. The
506 519 current user is always trusted. To trust everybody, list a user
507 520 or a group with name "*".
508 521
509 522 users;;
510 523 Comma-separated list of trusted users.
511 524 groups;;
512 525 Comma-separated list of trusted groups.
513 526
514 527 ui::
515 528 User interface controls.
516 529 archivemeta;;
517 530 Whether to include the .hg_archival.txt file containing metadata
518 531 (hashes for the repository base and for tip) in archives created by
519 532 the hg archive command or downloaded via hgweb.
520 533 Default is true.
521 534 debug;;
522 535 Print debugging information. True or False. Default is False.
523 536 editor;;
524 537 The editor to use during a commit. Default is $EDITOR or "vi".
525 538 pager;;
526 539 The pager that is used when displaying long output.
527 540 Default is $PAGER. If not set, the output is written to the
528 541 stdandard output.
529 542 usepager;;
530 543 If set to true, the system pager is used. True or False. Default is False.
531 544 fallbackencoding;;
532 545 Encoding to try if it's not possible to decode the changelog using
533 546 UTF-8. Default is ISO-8859-1.
534 547 ignore;;
535 548 A file to read per-user ignore patterns from. This file should be in
536 549 the same format as a repository-wide .hgignore file. This option
537 550 supports hook syntax, so if you want to specify multiple ignore
538 551 files, you can do so by setting something like
539 552 "ignore.other = ~/.hgignore2". For details of the ignore file
540 553 format, see the hgignore(5) man page.
541 554 interactive;;
542 555 Allow to prompt the user. True or False. Default is True.
543 556 logtemplate;;
544 557 Template string for commands that print changesets.
545 558 merge;;
546 559 The conflict resolution program to use during a manual merge.
547 560 There are some internal tools available:
548 561
549 562 internal:local;;
550 563 keep the local version
551 564 internal:other;;
552 565 use the other version
553 566 internal:merge;;
554 567 use the internal non-interactive merge tool
555 568 internal:fail;;
556 569 fail to merge
557 570
558 571 See the merge-tools section for more information on configuring tools.
559 572 patch;;
560 573 command to use to apply patches. Look for 'gpatch' or 'patch' in PATH if
561 574 unset.
562 575 quiet;;
563 576 Reduce the amount of output printed. True or False. Default is False.
564 577 remotecmd;;
565 578 remote command to use for clone/push/pull operations. Default is 'hg'.
566 579 report_untrusted;;
567 580 Warn if a .hg/hgrc file is ignored due to not being owned by a
568 581 trusted user or group. True or False. Default is True.
569 582 slash;;
570 583 Display paths using a slash ("/") as the path separator. This only
571 584 makes a difference on systems where the default path separator is not
572 585 the slash character (e.g. Windows uses the backslash character ("\")).
573 586 Default is False.
574 587 ssh;;
575 588 command to use for SSH connections. Default is 'ssh'.
576 589 strict;;
577 590 Require exact command names, instead of allowing unambiguous
578 591 abbreviations. True or False. Default is False.
579 592 style;;
580 593 Name of style to use for command output.
581 594 timeout;;
582 595 The timeout used when a lock is held (in seconds), a negative value
583 596 means no timeout. Default is 600.
584 597 username;;
585 598 The committer of a changeset created when running "commit".
586 599 Typically a person's name and email address, e.g. "Fred Widget
587 600 <fred@example.com>". Default is $EMAIL or username@hostname.
588 601 If the username in hgrc is empty, it has to be specified manually or
589 602 in a different hgrc file (e.g. $HOME/.hgrc, if the admin set "username ="
590 603 in the system hgrc).
591 604 verbose;;
592 605 Increase the amount of output printed. True or False. Default is False.
593 606
594 607
595 608 web::
596 609 Web interface configuration.
597 610 accesslog;;
598 611 Where to output the access log. Default is stdout.
599 612 address;;
600 613 Interface address to bind to. Default is all.
601 614 allow_archive;;
602 615 List of archive format (bz2, gz, zip) allowed for downloading.
603 616 Default is empty.
604 617 allowbz2;;
605 618 (DEPRECATED) Whether to allow .tar.bz2 downloading of repo revisions.
606 619 Default is false.
607 620 allowgz;;
608 621 (DEPRECATED) Whether to allow .tar.gz downloading of repo revisions.
609 622 Default is false.
610 623 allowpull;;
611 624 Whether to allow pulling from the repository. Default is true.
612 625 allow_push;;
613 626 Whether to allow pushing to the repository. If empty or not set,
614 627 push is not allowed. If the special value "*", any remote user
615 628 can push, including unauthenticated users. Otherwise, the remote
616 629 user must have been authenticated, and the authenticated user name
617 630 must be present in this list (separated by whitespace or ",").
618 631 The contents of the allow_push list are examined after the
619 632 deny_push list.
620 633 allowzip;;
621 634 (DEPRECATED) Whether to allow .zip downloading of repo revisions.
622 635 Default is false. This feature creates temporary files.
623 636 baseurl;;
624 637 Base URL to use when publishing URLs in other locations, so
625 638 third-party tools like email notification hooks can construct URLs.
626 639 Example: "http://hgserver/repos/"
627 640 contact;;
628 641 Name or email address of the person in charge of the repository.
629 642 Defaults to ui.username or $EMAIL or "unknown" if unset or empty.
630 643 deny_push;;
631 644 Whether to deny pushing to the repository. If empty or not set,
632 645 push is not denied. If the special value "*", all remote users
633 646 are denied push. Otherwise, unauthenticated users are all denied,
634 647 and any authenticated user name present in this list (separated by
635 648 whitespace or ",") is also denied. The contents of the deny_push
636 649 list are examined before the allow_push list.
637 650 description;;
638 651 Textual description of the repository's purpose or contents.
639 652 Default is "unknown".
640 653 encoding;;
641 654 Character encoding name.
642 655 Example: "UTF-8"
643 656 errorlog;;
644 657 Where to output the error log. Default is stderr.
645 658 hidden;;
646 659 Whether to hide the repository in the hgwebdir index. Default is false.
647 660 ipv6;;
648 661 Whether to use IPv6. Default is false.
649 662 name;;
650 663 Repository name to use in the web interface. Default is current
651 664 working directory.
652 665 maxchanges;;
653 666 Maximum number of changes to list on the changelog. Default is 10.
654 667 maxfiles;;
655 668 Maximum number of files to list per changeset. Default is 10.
656 669 port;;
657 670 Port to listen on. Default is 8000.
658 671 prefix;;
659 672 Prefix path to serve from. Default is '' (server root).
660 673 push_ssl;;
661 674 Whether to require that inbound pushes be transported over SSL to
662 675 prevent password sniffing. Default is true.
663 676 staticurl;;
664 677 Base URL to use for static files. If unset, static files (e.g.
665 678 the hgicon.png favicon) will be served by the CGI script itself.
666 679 Use this setting to serve them directly with the HTTP server.
667 680 Example: "http://hgserver/static/"
668 681 stripes;;
669 682 How many lines a "zebra stripe" should span in multiline output.
670 683 Default is 1; set to 0 to disable.
671 684 style;;
672 685 Which template map style to use.
673 686 templates;;
674 687 Where to find the HTML templates. Default is install path.
675 688
676 689
677 690 AUTHOR
678 691 ------
679 692 Bryan O'Sullivan <bos@serpentine.com>.
680 693
681 694 Mercurial was written by Matt Mackall <mpm@selenic.com>.
682 695
683 696 SEE ALSO
684 697 --------
685 698 hg(1), hgignore(5)
686 699
687 700 COPYING
688 701 -------
689 702 This manual page is copyright 2005 Bryan O'Sullivan.
690 703 Mercurial is copyright 2005-2007 Matt Mackall.
691 704 Free use of this software is granted under the terms of the GNU General
692 705 Public License (GPL).
General Comments 0
You need to be logged in to leave comments. Login now