Mercurial > hg
comparison doc/hgrc.5.txt @ 8773:bf8ff9e8a506
hgrc.5: spell check
author | Martin Geisler <mg@lazybytes.net> |
---|---|
date | Wed, 10 Jun 2009 00:55:57 +0200 |
parents | 593d772434f7 |
children | face0d0540e6 |
comparison
equal
deleted
inserted
replaced
8772:593d772434f7 | 8773:bf8ff9e8a506 |
---|---|
10 | 10 |
11 SYNOPSIS | 11 SYNOPSIS |
12 -------- | 12 -------- |
13 | 13 |
14 The Mercurial system uses a set of configuration files to control | 14 The Mercurial system uses a set of configuration files to control |
15 aspects of its behaviour. | 15 aspects of its behavior. |
16 | 16 |
17 FILES | 17 FILES |
18 ----- | 18 ----- |
19 | 19 |
20 Mercurial reads configuration data from several files, if they exist. | 20 Mercurial reads configuration data from several files, if they exist. |
57 (Windows) `%USERPROFILE%\Mercurial.ini`:: | 57 (Windows) `%USERPROFILE%\Mercurial.ini`:: |
58 (Windows) `%USERPROFILE%\.hgrc`:: | 58 (Windows) `%USERPROFILE%\.hgrc`:: |
59 Per-user configuration file(s), for the user running Mercurial. On | 59 Per-user configuration file(s), for the user running Mercurial. On |
60 Windows 9x, `%HOME%` is replaced by `%APPDATA%`. | 60 Windows 9x, `%HOME%` is replaced by `%APPDATA%`. |
61 Options in these files apply to all Mercurial commands executed by | 61 Options in these files apply to all Mercurial commands executed by |
62 this user in any directory. Options in thes files override | 62 this user in any directory. Options in these files override |
63 per-installation and per-system options. | 63 per-installation and per-system options. |
64 | 64 |
65 (Unix, Windows) `<repo>/.hg/hgrc`:: | 65 (Unix, Windows) `<repo>/.hg/hgrc`:: |
66 Per-repository configuration options that only apply in a | 66 Per-repository configuration options that only apply in a |
67 particular repository. This file is not version-controlled, and | 67 particular repository. This file is not version-controlled, and |
206 NOTE: the tempfile mechanism is recommended for Windows systems, | 206 NOTE: the tempfile mechanism is recommended for Windows systems, |
207 where the standard shell I/O redirection operators often have | 207 where the standard shell I/O redirection operators often have |
208 strange effects and may corrupt the contents of your files. | 208 strange effects and may corrupt the contents of your files. |
209 | 209 |
210 The most common usage is for LF <-> CRLF translation on Windows. For | 210 The most common usage is for LF <-> CRLF translation on Windows. For |
211 this, use the "smart" convertors which check for binary files: | 211 this, use the "smart" converters which check for binary files: |
212 | 212 |
213 [extensions] | 213 [extensions] |
214 hgext.win32text = | 214 hgext.win32text = |
215 [encode] | 215 [encode] |
216 ** = cleverencode: | 216 ** = cleverencode: |
245 to the aliases of the commands defined. | 245 to the aliases of the commands defined. |
246 -- | 246 -- |
247 | 247 |
248 [[diff]] | 248 [[diff]] |
249 diff:: | 249 diff:: |
250 Settings used when displaying diffs. They are all boolean and | 250 Settings used when displaying diffs. They are all Boolean and |
251 defaults to False. | 251 defaults to False. |
252 git;; | 252 git;; |
253 Use git extended diff format. | 253 Use git extended diff format. |
254 nodates;; | 254 nodates;; |
255 Don't include dates in diff headers. | 255 Don't include dates in diff headers. |
282 Otherwise, use as name of program to run that acts like sendmail | 282 Otherwise, use as name of program to run that acts like sendmail |
283 (takes "-f" option for sender, list of recipients on command line, | 283 (takes "-f" option for sender, list of recipients on command line, |
284 message on stdin). Normally, setting this to "sendmail" or | 284 message on stdin). Normally, setting this to "sendmail" or |
285 "/usr/sbin/sendmail" is enough to use sendmail to send messages. | 285 "/usr/sbin/sendmail" is enough to use sendmail to send messages. |
286 charsets;; | 286 charsets;; |
287 Optional. Comma-separated list of charsets considered convenient | 287 Optional. Comma-separated list of character sets considered |
288 for recipients. Addresses, headers, and parts not containing | 288 convenient for recipients. Addresses, headers, and parts not |
289 patches of outgoing messages will be encoded in the first charset | 289 containing patches of outgoing messages will be encoded in the |
290 to which conversion from local encoding (`$HGENCODING`, | 290 first character set to which conversion from local encoding |
291 `ui.fallbackencoding`) succeeds. If correct conversion fails, the | 291 (`$HGENCODING`, `ui.fallbackencoding`) succeeds. If correct |
292 text in question is sent as is. Defaults to empty (explicit) list. | 292 conversion fails, the text in question is sent as is. Defaults to |
293 + | 293 empty (explicit) list. |
294 -- | 294 + |
295 Order of outgoing email charsets: | 295 -- |
296 Order of outgoing email character sets: | |
296 | 297 |
297 us-ascii always first, regardless of settings | 298 us-ascii always first, regardless of settings |
298 email.charsets in order given by user | 299 email.charsets in order given by user |
299 ui.fallbackencoding if not in email.charsets | 300 ui.fallbackencoding if not in email.charsets |
300 $HGENCODING if not in email.charsets | 301 $HGENCODING if not in email.charsets |
303 Email example: | 304 Email example: |
304 | 305 |
305 [email] | 306 [email] |
306 from = Joseph User <joe.user@example.com> | 307 from = Joseph User <joe.user@example.com> |
307 method = /usr/sbin/sendmail | 308 method = /usr/sbin/sendmail |
308 # charsets for western europeans | 309 # charsets for western Europeans |
309 # us-ascii, utf-8 omitted, as they are tried first and last | 310 # us-ascii, utf-8 omitted, as they are tried first and last |
310 charsets = iso-8859-1, iso-8859-15, windows-1252 | 311 charsets = iso-8859-1, iso-8859-15, windows-1252 |
311 -- | 312 -- |
312 | 313 |
313 [[extensions]] | 314 [[extensions]] |
330 supplied. | 331 supplied. |
331 | 332 |
332 Example for `~/.hgrc`: | 333 Example for `~/.hgrc`: |
333 | 334 |
334 [extensions] | 335 [extensions] |
335 # (the mq extension will get loaded from mercurial's path) | 336 # (the mq extension will get loaded from Mercurial's path) |
336 hgext.mq = | 337 hgext.mq = |
337 # (this extension will get loaded from the file specified) | 338 # (this extension will get loaded from the file specified) |
338 myfeature = ~/.hgext/myfeature.py | 339 myfeature = ~/.hgext/myfeature.py |
339 -- | 340 -- |
340 | 341 |
497 commit to proceed. Non-zero status will cause the commit to fail. | 498 commit to proceed. Non-zero status will cause the commit to fail. |
498 Parent changeset IDs are in `$HG_PARENT1` and `$HG_PARENT2`. | 499 Parent changeset IDs are in `$HG_PARENT1` and `$HG_PARENT2`. |
499 preoutgoing;; | 500 preoutgoing;; |
500 Run before collecting changes to send from the local repository to | 501 Run before collecting changes to send from the local repository to |
501 another. Non-zero status will cause failure. This lets you prevent | 502 another. Non-zero status will cause failure. This lets you prevent |
502 pull over http or ssh. Also prevents against local pull, push | 503 pull over HTTP or SSH. Also prevents against local pull, push |
503 (outbound) or bundle commands, but not effective, since you can | 504 (outbound) or bundle commands, but not effective, since you can |
504 just copy files instead then. Source of operation is in | 505 just copy files instead then. Source of operation is in |
505 `$HG_SOURCE`. If "serve", operation is happening on behalf of remote | 506 `$HG_SOURCE`. If "serve", operation is happening on behalf of remote |
506 ssh or http repository. If "push", "pull" or "bundle", operation | 507 SSH or HTTP repository. If "push", "pull" or "bundle", operation |
507 is happening on behalf of repository on same system. | 508 is happening on behalf of repository on same system. |
508 pretag;; | 509 pretag;; |
509 Run before creating a tag. Exit status 0 allows the tag to be | 510 Run before creating a tag. Exit status 0 allows the tag to be |
510 created. Non-zero status will cause the tag to fail. ID of | 511 created. Non-zero status will cause the tag to fail. ID of |
511 changeset to tag is in `$HG_NODE`. Name of tag is in `$HG_TAG`. Tag is | 512 changeset to tag is in `$HG_NODE`. Name of tag is in `$HG_TAG`. Tag is |
512 local if `$HG_LOCAL=1`, in repo if `$HG_LOCAL=0`. | 513 local if `$HG_LOCAL=1`, in repository if `$HG_LOCAL=0`. |
513 pretxnchangegroup;; | 514 pretxnchangegroup;; |
514 Run after a changegroup has been added via push, pull or unbundle, | 515 Run after a changegroup has been added via push, pull or unbundle, |
515 but before the transaction has been committed. Changegroup is | 516 but before the transaction has been committed. Changegroup is |
516 visible to hook program. This lets you validate incoming changes | 517 visible to hook program. This lets you validate incoming changes |
517 before accepting them. Passed the ID of the first new changeset in | 518 before accepting them. Passed the ID of the first new changeset in |
531 the update to proceed. Non-zero status will prevent the update. | 532 the update to proceed. Non-zero status will prevent the update. |
532 Changeset ID of first new parent is in `$HG_PARENT1`. If merge, ID | 533 Changeset ID of first new parent is in `$HG_PARENT1`. If merge, ID |
533 of second new parent is in `$HG_PARENT2`. | 534 of second new parent is in `$HG_PARENT2`. |
534 tag;; | 535 tag;; |
535 Run after a tag is created. ID of tagged changeset is in `$HG_NODE`. | 536 Run after a tag is created. ID of tagged changeset is in `$HG_NODE`. |
536 Name of tag is in `$HG_TAG`. Tag is local if `$HG_LOCAL=1`, in repo if | 537 Name of tag is in `$HG_TAG`. Tag is local if `$HG_LOCAL=1`, in |
537 `$HG_LOCAL=0`. | 538 repository if `$HG_LOCAL=0`. |
538 update;; | 539 update;; |
539 Run after updating the working directory. Changeset ID of first | 540 Run after updating the working directory. Changeset ID of first |
540 new parent is in `$HG_PARENT1`. If merge, ID of second new parent is | 541 new parent is in `$HG_PARENT1`. If merge, ID of second new parent is |
541 in `$HG_PARENT2`. If the update succeeded, `$HG_ERROR=0`. If the | 542 in `$HG_PARENT2`. If the update succeeded, `$HG_ERROR=0`. If the |
542 update failed (e.g. because conflicts not resolved), `$HG_ERROR=1`. | 543 update failed (e.g. because conflicts not resolved), `$HG_ERROR=1`. |
644 | 645 |
645 [[server]] | 646 [[server]] |
646 server:: | 647 server:: |
647 Controls generic server settings. | 648 Controls generic server settings. |
648 uncompressed;; | 649 uncompressed;; |
649 Whether to allow clients to clone a repo using the uncompressed | 650 Whether to allow clients to clone a repository using the |
650 streaming protocol. This transfers about 40% more data than a | 651 uncompressed streaming protocol. This transfers about 40% more |
651 regular clone, but uses less memory and CPU on both server and | 652 data than a regular clone, but uses less memory and CPU on both |
652 client. Over a LAN (100Mbps or better) or a very fast WAN, an | 653 server and client. Over a LAN (100 Mbps or better) or a very fast |
653 uncompressed streaming clone is a lot faster (~10x) than a regular | 654 WAN, an uncompressed streaming clone is a lot faster (~10x) than a |
654 clone. Over most WAN connections (anything slower than about | 655 regular clone. Over most WAN connections (anything slower than |
655 6Mbps), uncompressed streaming is slower, because of the extra | 656 about 6 Mbps), uncompressed streaming is slower, because of the |
656 data transfer overhead. Default is False. | 657 extra data transfer overhead. Default is False. |
657 | 658 |
658 [[trusted]] | 659 [[trusted]] |
659 trusted:: | 660 trusted:: |
660 For security reasons, Mercurial will not use the settings in the | 661 For security reasons, Mercurial will not use the settings in the |
661 `.hg/hgrc` file from a repository if it doesn't belong to a trusted | 662 `.hg/hgrc` file from a repository if it doesn't belong to a trusted |
678 ui:: | 679 ui:: |
679 User interface controls. | 680 User interface controls. |
680 + | 681 + |
681 -- | 682 -- |
682 archivemeta;; | 683 archivemeta;; |
683 Whether to include the .hg_archival.txt file containing metadata | 684 Whether to include the .hg_archival.txt file containing meta data |
684 (hashes for the repository base and for tip) in archives created | 685 (hashes for the repository base and for tip) in archives created |
685 by the hg archive command or downloaded via hgweb. | 686 by the hg archive command or downloaded via hgweb. |
686 Default is true. | 687 Default is true. |
687 askusername;; | 688 askusername;; |
688 Whether to prompt for a username when committing. If True, and | 689 Whether to prompt for a username when committing. If True, and |
770 Interface address to bind to. Default is all. | 771 Interface address to bind to. Default is all. |
771 allow_archive;; | 772 allow_archive;; |
772 List of archive format (bz2, gz, zip) allowed for downloading. | 773 List of archive format (bz2, gz, zip) allowed for downloading. |
773 Default is empty. | 774 Default is empty. |
774 allowbz2;; | 775 allowbz2;; |
775 (DEPRECATED) Whether to allow .tar.bz2 downloading of repo revisions. | 776 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository |
777 revisions. | |
776 Default is false. | 778 Default is false. |
777 allowgz;; | 779 allowgz;; |
778 (DEPRECATED) Whether to allow .tar.gz downloading of repo revisions. | 780 (DEPRECATED) Whether to allow .tar.gz downloading of repository |
781 revisions. | |
779 Default is false. | 782 Default is false. |
780 allowpull;; | 783 allowpull;; |
781 Whether to allow pulling from the repository. Default is true. | 784 Whether to allow pulling from the repository. Default is true. |
782 allow_push;; | 785 allow_push;; |
783 Whether to allow pushing to the repository. If empty or not set, | 786 Whether to allow pushing to the repository. If empty or not set, |
797 default. Setting allow_read to the special value "*" is equivalent | 800 default. Setting allow_read to the special value "*" is equivalent |
798 to it not being set (i.e. access is permitted to all users). The | 801 to it not being set (i.e. access is permitted to all users). The |
799 contents of the allow_read list are examined after the deny_read | 802 contents of the allow_read list are examined after the deny_read |
800 list. | 803 list. |
801 allowzip;; | 804 allowzip;; |
802 (DEPRECATED) Whether to allow .zip downloading of repo revisions. | 805 (DEPRECATED) Whether to allow .zip downloading of repository |
803 Default is false. This feature creates temporary files. | 806 revisions. Default is false. This feature creates temporary files. |
804 baseurl;; | 807 baseurl;; |
805 Base URL to use when publishing URLs in other locations, so | 808 Base URL to use when publishing URLs in other locations, so |
806 third-party tools like email notification hooks can construct | 809 third-party tools like email notification hooks can construct |
807 URLs. Example: "http://hgserver/repos/" | 810 URLs. Example: "http://hgserver/repos/" |
808 contact;; | 811 contact;; |