hg/pyhgsh: doc/hgrc.5.txt annotate

annotate doc/hgrc.5.txt @ 2266:3f7692b0ff13

hooks: add preupdate and update hooks. preupdate run before working dir updated. can prevent update. update run after working dir updated.

author	Vadim Gelfer <vadim.gelfer@gmail.com>
date	Thu, 11 May 2006 10:14:48 -0700
parents	b8b7a79a4d88
children	066d0055e430

rev	line source
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	1 HGRC(5)
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	2 =======
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	3 Bryan O'Sullivan <bos@serpentine.com>
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	4
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	5 NAME
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	6 ----
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	7 hgrc - configuration files for Mercurial
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	8
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	9 SYNOPSIS
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	10 --------
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	11
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	12 The Mercurial system uses a set of configuration files to control
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	13 aspects of its behaviour.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	14
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	15 FILES
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	16 -----
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	17
1583 32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	18 Mercurial reads configuration data from several files, if they exist.
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	19 The names of these files depend on the system on which Mercurial is
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	20 installed.
951 859de3ebc041 Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows. Thomas Arendsen Hein <thomas@intevation.de> parents: 938 diff changeset	21
1583 32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	22 (Unix) <install-root>/etc/mercurial/hgrc.d/*.rc::
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	23 (Unix) <install-root>/etc/mercurial/hgrc::
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	24 Per-installation configuration files, searched for in the
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	25 directory where Mercurial is installed. For example, if installed
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	26 in /shared/tools, Mercurial will look in
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	27 /shared/tools/etc/mercurial/hgrc. Options in these files apply to
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	28 all Mercurial commands executed by any user in any directory.
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	29
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	30 (Unix) /etc/mercurial/hgrc.d/*.rc::
1304 a69e5a67685c Update hgrc documentation to refer to Windows paths. Bryan O'Sullivan <bos@serpentine.com> parents: 1293 diff changeset	31 (Unix) /etc/mercurial/hgrc::
a69e5a67685c Update hgrc documentation to refer to Windows paths. Bryan O'Sullivan <bos@serpentine.com> parents: 1293 diff changeset	32 (Windows) C:\Mercurial\Mercurial.ini::
1583 32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	33 Per-system configuration files, for the system on which Mercurial
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	34 is running. Options in these files apply to all Mercurial
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	35 commands executed by any user in any directory. Options in these
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	36 files override per-installation options.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	37
1304 a69e5a67685c Update hgrc documentation to refer to Windows paths. Bryan O'Sullivan <bos@serpentine.com> parents: 1293 diff changeset	38 (Unix) $HOME/.hgrc::
a69e5a67685c Update hgrc documentation to refer to Windows paths. Bryan O'Sullivan <bos@serpentine.com> parents: 1293 diff changeset	39 (Windows) C:\Documents and Settings\USERNAME\Mercurial.ini
1583 32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	40 Per-user configuration file, for the user running Mercurial.
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	41 Options in this file apply to all Mercurial commands executed by
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	42 any user in any directory. Options in this file override
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	43 per-installation and per-system options.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	44
1304 a69e5a67685c Update hgrc documentation to refer to Windows paths. Bryan O'Sullivan <bos@serpentine.com> parents: 1293 diff changeset	45 (Unix, Windows) <repo>/.hg/hgrc::
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	46 Per-repository configuration options that only apply in a
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	47 particular repository. This file is not version-controlled, and
1583 32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	48 will not get transferred during a "clone" operation. Options in
32a4e6802864 make mercurial look in more places for config files. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1485 diff changeset	49 this file override options in all other configuration files.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	50
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	51 SYNTAX
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	52 ------
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	53
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	54 A configuration file consists of sections, led by a "[section]" header
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	55 and followed by "name: value" entries; "name=value" is also accepted.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	56
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	57 [spam]
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	58 eggs=ham
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	59 green=
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	60 eggs
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	61
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	62 Each line contains one entry. If the lines that follow are indented,
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	63 they are treated as continuations of that entry.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	64
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	65 Leading whitespace is removed from values. Empty lines are skipped.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	66
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	67 The optional values can contain format strings which refer to other
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	68 values in the same section, or values in a special DEFAULT section.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	69
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	70 Lines beginning with "#" or ";" are ignored and may be used to provide
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	71 comments.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	72
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	73 SECTIONS
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	74 --------
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	75
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	76 This section describes the different sections that may appear in a
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	77 Mercurial "hgrc" file, the purpose of each section, its possible
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	78 keys, and their possible values.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	79
1308 2073e5a71008 Cleanup of tabs and trailing spaces. Thomas Arendsen Hein <thomas@intevation.de> parents: 1258 diff changeset	80 decode/encode::
1258 1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	81 Filters for transforming files on checkout/checkin. This would
1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	82 typically be used for newline processing or other
1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	83 localization/canonicalization of files.
1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	84
1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	85 Filters consist of a filter pattern followed by a filter command.
1293 a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	86 Filter patterns are globs by default, rooted at the repository
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	87 root. For example, to match any file ending in ".txt" in the root
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	88 directory only, use the pattern "*.txt". To match any file ending
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	89 in ".c" anywhere in the repository, use the pattern "**.c".
1258 1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	90
1293 a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	91 The filter command can start with a specifier, either "pipe:" or
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	92 "tempfile:". If no specifier is given, "pipe:" is used by default.
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	93
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	94 A "pipe:" command must accept data on stdin and return the
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	95 transformed data on stdout.
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	96
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	97 Pipe example:
1258 1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	98
1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	99 [encode]
1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	100 # uncompress gzip files on checkin to improve delta compression
1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	101 # note: not necessarily a good idea, just an example
1293 a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	102 *.gz = pipe: gunzip
1258 1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	103
1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	104 [decode]
1293 a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	105 # recompress gzip files when writing them to the working dir (we
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	106 # can safely omit "pipe:", because it's the default)
1258 1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	107 *.gz = gzip
1945754e466b Add file encoding/decoding support mpm@selenic.com parents: 1171 diff changeset	108
1293 a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	109 A "tempfile:" command is a template. The string INFILE is replaced
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	110 with the name of a temporary file that contains the data to be
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	111 filtered by the command. The string OUTFILE is replaced with the
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	112 name of an empty temporary file, where the filtered data must be
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	113 written by the command.
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	114
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	115 NOTE: the tempfile mechanism is recommended for Windows systems,
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	116 where the standard shell I/O redirection operators often have
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	117 strange effects. In particular, if you are doing line ending
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	118 conversion on Windows using the popular dos2unix and unix2dos
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	119 programs, you must use the tempfile mechanism, as using pipes will
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	120 corrupt the contents of your files.
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	121
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	122 Tempfile example:
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	123
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	124 [encode]
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	125 # convert files to unix line ending conventions on checkin
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	126 **.txt = tempfile: dos2unix -n INFILE OUTFILE
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	127
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	128 [decode]
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	129 # convert files to windows line ending conventions when writing
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	130 # them to the working dir
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	131 **.txt = tempfile: unix2dos -n INFILE OUTFILE
a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1258 diff changeset	132
2200 9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	133 email::
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	134 Settings for extensions that send email messages.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	135 from;;
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	136 Optional. Email address to use in "From" header and SMTP envelope
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	137 of outgoing messages.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	138
2211 b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	139 extensions::
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	140 Mercurial has an extension mechanism for adding new features. To
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	141 enable an extension, create an entry for it in this section.
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	142
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	143 If you know that the extension is already in Python's search path,
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	144 you can give the name of the module, followed by "=", with nothing
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	145 after the "=".
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	146
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	147 Otherwise, give a name that you choose, followed by "=", followed by
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	148 the path to the ".py" file (including the file name extension) that
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	149 defines the extension.
b8b7a79a4d88 document [extensions] in doc/hgrc.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2209 diff changeset	150
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	151 hooks::
2155 ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	152 Commands or Python functions that get automatically executed by
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	153 various actions such as starting or finishing a commit. Multiple
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	154 hooks can be run for the same action by appending a suffix to the
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	155 action. Overriding a site-wide hook can be done by changing its
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	156 value or setting it to an empty string.
1485 625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	157
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	158 Example .hg/hgrc:
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	159
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	160 [hooks]
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	161 # do not use the site-wide hook
1714 eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	162 incoming =
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	163 incoming.email = /my/email/hook
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	164 incoming.autobuild = /my/build/hook
1485 625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	165
1727 019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	166 Most hooks are run with environment variables set that give added
019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	167 useful information. For each hook below, the environment variables
019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	168 it is passed are listed with names of the form "$HG_foo".
019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	169
1171 a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	170 changegroup;;
1730 0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	171 Run after a changegroup has been added via push, pull or
1732 d3e6da334b85 merge with crew. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1727 1730 diff changeset	172 unbundle. ID of the first new changeset is in $HG_NODE.
1171 a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	173 commit;;
1714 eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	174 Run after a changeset has been created in the local repository.
1727 019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	175 ID of the newly created changeset is in $HG_NODE. Parent
019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	176 changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
1714 eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	177 incoming;;
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	178 Run after a changeset has been pulled, pushed, or unbundled into
1727 019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	179 the local repository. The ID of the newly arrived changeset is in
019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	180 $HG_NODE.
1736 50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	181 outgoing;;
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	182 Run after sending changes from local repository to another. ID of
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	183 first changeset sent is in $HG_NODE. Source of operation is in
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	184 $HG_SOURCE; see "preoutgoing" hook for description.
1730 0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	185 prechangegroup;;
0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	186 Run before a changegroup is added via push, pull or unbundle.
0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	187 Exit status 0 allows the changegroup to proceed. Non-zero status
0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	188 will cause the push, pull or unbundle to fail.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	189 precommit;;
1721 801756d0ca84 add pretxncommit hook. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1720 diff changeset	190 Run before starting a local commit. Exit status 0 allows the
1726 56fb048b102c prefix hook env var names with HG_. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	191 commit to proceed. Non-zero status will cause the commit to fail.
1727 019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	192 Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
1736 50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	193 preoutgoing;;
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	194 Run before computing changes to send from the local repository to
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	195 another. Non-zero status will cause failure. This lets you
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	196 prevent pull over http or ssh. Also prevents against local pull,
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	197 push (outbound) or bundle commands, but not effective, since you
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	198 can just copy files instead then. Source of operation is in
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	199 $HG_SOURCE. If "serve", operation is happening on behalf of
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	200 remote ssh or http repository. If "push", "pull" or "bundle",
50de0887bbcd add preoutgoing and outgoing hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1734 diff changeset	201 operation is happening on behalf of repository on same system.
1720 55017891051b add pretag and tag hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1714 diff changeset	202 pretag;;
55017891051b add pretag and tag hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1714 diff changeset	203 Run before creating a tag. Exit status 0 allows the tag to be
55017891051b add pretag and tag hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1714 diff changeset	204 created. Non-zero status will cause the tag to fail. ID of
1727 019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	205 changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag
019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	206 is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0.
1730 0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	207 pretxnchangegroup;;
0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	208 Run after a changegroup has been added via push, pull or unbundle,
0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	209 but before the transaction has been committed. Changegroup is
0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	210 visible to hook program. This lets you validate incoming changes
0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	211 before accepting them. Passed the ID of the first new changeset
1734 9488d53233b5 tests for new hooks. fix things i found when writing tests. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1732 diff changeset	212 in $HG_NODE. Exit status 0 allows the transaction to commit.
1730 0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	213 Non-zero status will cause the transaction to be rolled back and
0f1d2c75db5e add prechangegroup and pretxnchangegroup hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	214 the push, pull or unbundle will fail.
1721 801756d0ca84 add pretxncommit hook. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1720 diff changeset	215 pretxncommit;;
801756d0ca84 add pretxncommit hook. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1720 diff changeset	216 Run after a changeset has been created but the transaction not yet
801756d0ca84 add pretxncommit hook. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1720 diff changeset	217 committed. Changeset is visible to hook program. This lets you
801756d0ca84 add pretxncommit hook. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1720 diff changeset	218 validate commit message and changes. Exit status 0 allows the
801756d0ca84 add pretxncommit hook. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1720 diff changeset	219 commit to proceed. Non-zero status will cause the transaction to
1727 019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	220 be rolled back. ID of changeset is in $HG_NODE. Parent changeset
019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	221 IDs are in $HG_PARENT1 and $HG_PARENT2.
2266 3f7692b0ff13 hooks: add preupdate and update hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2211 diff changeset	222 preupdate;;
3f7692b0ff13 hooks: add preupdate and update hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2211 diff changeset	223 Run before updating the working directory. Exit status 0 allows
3f7692b0ff13 hooks: add preupdate and update hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2211 diff changeset	224 the update to proceed. Non-zero status will prevent the update.
3f7692b0ff13 hooks: add preupdate and update hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2211 diff changeset	225 Changeset ID of first new parent is in $HG_PARENT1. If merge, ID
3f7692b0ff13 hooks: add preupdate and update hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2211 diff changeset	226 of second new parent is in $HG_PARENT2.
1720 55017891051b add pretag and tag hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1714 diff changeset	227 tag;;
1727 019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	228 Run after a tag is created. ID of tagged changeset is in
019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	229 $HG_NODE. Name of tag is in $HG_TAG. Tag is local if
019e6a47a53e fix names of parent changeset ids in hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1726 diff changeset	230 $HG_LOCAL=1, in repo if $HG_LOCAL=0.
2266 3f7692b0ff13 hooks: add preupdate and update hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2211 diff changeset	231 update;;
3f7692b0ff13 hooks: add preupdate and update hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2211 diff changeset	232 Run after updating the working directory. Changeset ID of first
3f7692b0ff13 hooks: add preupdate and update hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2211 diff changeset	233 new parent is in $HG_PARENT1. If merge, ID of second new parent
3f7692b0ff13 hooks: add preupdate and update hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2211 diff changeset	234 is in $HG_PARENT2. If update succeeded, $HG_ERROR=0. If update
3f7692b0ff13 hooks: add preupdate and update hooks. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2211 diff changeset	235 failed (e.g. because conflicts not resolved), $HG_ERROR=1.
1726 56fb048b102c prefix hook env var names with HG_. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	236
56fb048b102c prefix hook env var names with HG_. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	237 In earlier releases, the names of hook environment variables did not
56fb048b102c prefix hook env var names with HG_. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	238 have a "HG_" prefix. These unprefixed names are still provided in
56fb048b102c prefix hook env var names with HG_. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	239 the environment for backwards compatibility, but their use is
56fb048b102c prefix hook env var names with HG_. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1721 diff changeset	240 deprecated, and they will be removed in a future release.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	241
2155 ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	242 The syntax for Python hooks is as follows:
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	243
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	244 hookname = python:modulename.submodule.callable
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	245
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	246 Python hooks are run within the Mercurial process. Each hook is
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	247 called with at least three keyword arguments: a ui object (keyword
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	248 "ui"), a repository object (keyword "repo"), and a "hooktype"
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	249 keyword that tells what kind of hook is used. Arguments listed as
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	250 environment variables above are passed as keyword arguments, with no
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	251 "HG_" prefix, and names in lower case.
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	252
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	253 A Python hook must return a "true" value to succeed. Returning a
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	254 "false" value or raising an exception is treated as failure of the
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	255 hook.
ff255b41b4aa support hooks written in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2003 diff changeset	256
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	257 http_proxy::
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	258 Used to access web-based Mercurial repositories through a HTTP
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	259 proxy.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	260 host;;
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	261 Host name and (optional) port of the proxy server, for example
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	262 "myproxy:8000".
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	263 no;;
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	264 Optional. Comma-separated list of host names that should bypass
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	265 the proxy.
1171 a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	266 passwd;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	267 Optional. Password to authenticate with at the proxy server.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	268 user;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	269 Optional. User name to authenticate with at the proxy server.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	270
2200 9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	271 smtp::
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	272 Configuration for extensions that need to send email messages.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	273 host;;
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	274 Optional. Host name of mail server. Default: "mail".
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	275 port;;
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	276 Optional. Port to connect to on mail server. Default: 25.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	277 tls;;
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	278 Optional. Whether to connect to mail server using TLS. True or
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	279 False. Default: False.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	280 username;;
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	281 Optional. User name to authenticate to SMTP server with.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	282 If username is specified, password must also be specified.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	283 Default: none.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	284 password;;
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	285 Optional. Password to authenticate to SMTP server with.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	286 If username is specified, password must also be specified.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	287 Default: none.
9f43b6e24232 move mail sending code into core, so extensions can share it. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2197 diff changeset	288
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	289 paths::
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	290 Assigns symbolic names to repositories. The left side is the
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	291 symbolic name, and the right gives the directory or URL that is the
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	292 location of the repository.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	293
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	294 ui::
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	295 User interface controls.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	296 debug;;
702 a1099c50a622 Fix default values and add interactive setting to [ui] section of hgrc docs. Thomas Arendsen Hein <thomas@intevation.de> parents: 671 diff changeset	297 Print debugging information. True or False. Default is False.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	298 editor;;
702 a1099c50a622 Fix default values and add interactive setting to [ui] section of hgrc docs. Thomas Arendsen Hein <thomas@intevation.de> parents: 671 diff changeset	299 The editor to use during a commit. Default is $EDITOR or "vi".
2003 62647394e368 Implementation of per-user .hgignore. mcmillen@cs.cmu.edu parents: 1985 diff changeset	300 ignore;;
62647394e368 Implementation of per-user .hgignore. mcmillen@cs.cmu.edu parents: 1985 diff changeset	301 A file to read per-user ignore patterns from. This file should be in
62647394e368 Implementation of per-user .hgignore. mcmillen@cs.cmu.edu parents: 1985 diff changeset	302 the same format as a repository-wide .hgignore file. This option
62647394e368 Implementation of per-user .hgignore. mcmillen@cs.cmu.edu parents: 1985 diff changeset	303 supports hook syntax, so if you want to specify multiple ignore
62647394e368 Implementation of per-user .hgignore. mcmillen@cs.cmu.edu parents: 1985 diff changeset	304 files, you can do so by setting something like
2209 956e329f9e13 document hgignore syntax in new file doc/hgignore.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2200 diff changeset	305 "ignore.other = ~/.hgignore2". For details of the ignore file
956e329f9e13 document hgignore syntax in new file doc/hgignore.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2200 diff changeset	306 format, see the hgignore(5) man page.
702 a1099c50a622 Fix default values and add interactive setting to [ui] section of hgrc docs. Thomas Arendsen Hein <thomas@intevation.de> parents: 671 diff changeset	307 interactive;;
a1099c50a622 Fix default values and add interactive setting to [ui] section of hgrc docs. Thomas Arendsen Hein <thomas@intevation.de> parents: 671 diff changeset	308 Allow to prompt the user. True or False. Default is True.
1907 7718885070b1 let commands that show changesets use templates. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1788 diff changeset	309 logtemplate;;
7718885070b1 let commands that show changesets use templates. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1788 diff changeset	310 Template string for commands that print changesets.
1914 a5bf0030df5f make --style=compact look for map-cmdline.compact. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1907 diff changeset	311 style;;
a5bf0030df5f make --style=compact look for map-cmdline.compact. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1907 diff changeset	312 Name of style to use for command output.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	313 merge;;
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	314 The conflict resolution program to use during a manual merge.
702 a1099c50a622 Fix default values and add interactive setting to [ui] section of hgrc docs. Thomas Arendsen Hein <thomas@intevation.de> parents: 671 diff changeset	315 Default is "hgmerge".
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	316 quiet;;
702 a1099c50a622 Fix default values and add interactive setting to [ui] section of hgrc docs. Thomas Arendsen Hein <thomas@intevation.de> parents: 671 diff changeset	317 Reduce the amount of output printed. True or False. Default is False.
1171 a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	318 remotecmd;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	319 remote command to use for clone/push/pull operations. Default is 'hg'.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	320 ssh;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	321 command to use for SSH connections. Default is 'ssh'.
1787 e431344e604c add a timeout when a lock is held (default 1024 sec) Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1736 diff changeset	322 timeout;;
e431344e604c add a timeout when a lock is held (default 1024 sec) Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1736 diff changeset	323 The timeout used when a lock is held (in seconds), a negative value
1788 750b9cd83965 change the default timeout to 600 seconds Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1787 diff changeset	324 means no timeout. Default is 600.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	325 username;;
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	326 The committer of a changeset created when running "commit".
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	327 Typically a person's name and email address, e.g. "Fred Widget
1985 c577689006fa Adapted behaviour of ui.username() to documentation and mention it explicitly: Thomas Arendsen Hein <thomas@intevation.de> parents: 1914 diff changeset	328 <fred@example.com>". Default is $EMAIL or username@hostname, unless
c577689006fa Adapted behaviour of ui.username() to documentation and mention it explicitly: Thomas Arendsen Hein <thomas@intevation.de> parents: 1914 diff changeset	329 username is set to an empty string, which enforces specifying the
c577689006fa Adapted behaviour of ui.username() to documentation and mention it explicitly: Thomas Arendsen Hein <thomas@intevation.de> parents: 1914 diff changeset	330 username manually.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	331 verbose;;
702 a1099c50a622 Fix default values and add interactive setting to [ui] section of hgrc docs. Thomas Arendsen Hein <thomas@intevation.de> parents: 671 diff changeset	332 Increase the amount of output printed. True or False. Default is False.
962 5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options mpm@selenic.com parents: 953 diff changeset	333
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	334
938 54b2a42e501e hgweb: add [web] section to hgrc mpm@selenic.com parents: 705 diff changeset	335 web::
54b2a42e501e hgweb: add [web] section to hgrc mpm@selenic.com parents: 705 diff changeset	336 Web interface configuration.
54b2a42e501e hgweb: add [web] section to hgrc mpm@selenic.com parents: 705 diff changeset	337 accesslog;;
54b2a42e501e hgweb: add [web] section to hgrc mpm@selenic.com parents: 705 diff changeset	338 Where to output the access log. Default is stdout.
1171 a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	339 address;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	340 Interface address to bind to. Default is all.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	341 allowbz2;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	342 Whether to allow .tar.bz2 downloading of repo revisions. Default is false.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	343 allowgz;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	344 Whether to allow .tar.gz downloading of repo revisions. Default is false.
964 3f37720e7dc7 hgweb: Make maxfiles, maxchanges, and allowpull proper config options mpm@selenic.com parents: 962 diff changeset	345 allowpull;;
3f37720e7dc7 hgweb: Make maxfiles, maxchanges, and allowpull proper config options mpm@selenic.com parents: 962 diff changeset	346 Whether to allow pulling from the repository. Default is true.
1079 a37974035f1f Document archive download options mpm@selenic.com parents: 986 diff changeset	347 allowzip;;
a37974035f1f Document archive download options mpm@selenic.com parents: 986 diff changeset	348 Whether to allow .zip downloading of repo revisions. Default is false.
a37974035f1f Document archive download options mpm@selenic.com parents: 986 diff changeset	349 This feature creates temporary files.
2197 5de8b44f0446 define standard name for base url to use when printing hgweb urls. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2155 diff changeset	350 baseurl;;
5de8b44f0446 define standard name for base url to use when printing hgweb urls. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2155 diff changeset	351 Base URL to use when publishing URLs in other locations, so
5de8b44f0446 define standard name for base url to use when printing hgweb urls. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2155 diff changeset	352 third-party tools like email notification hooks can construct URLs.
5de8b44f0446 define standard name for base url to use when printing hgweb urls. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2155 diff changeset	353 Example: "http://hgserver/repos/"
1171 a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	354 description;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	355 Textual description of the repository's purpose or contents.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	356 Default is "unknown".
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	357 errorlog;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	358 Where to output the error log. Default is stderr.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	359 ipv6;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	360 Whether to use IPv6. Default is false.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	361 name;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	362 Repository name to use in the web interface. Default is current
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	363 working directory.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	364 maxchanges;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	365 Maximum number of changes to list on the changelog. Default is 10.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	366 maxfiles;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	367 Maximum number of files to list per changeset. Default is 10.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	368 port;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	369 Port to listen on. Default is 8000.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	370 style;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	371 Which template map style to use.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	372 templates;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	373 Where to find the HTML templates. Default is install path.
1079 a37974035f1f Document archive download options mpm@selenic.com parents: 986 diff changeset	374
938 54b2a42e501e hgweb: add [web] section to hgrc mpm@selenic.com parents: 705 diff changeset	375
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	376 AUTHOR
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	377 ------
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	378 Bryan O'Sullivan <bos@serpentine.com>.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	379
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	380 Mercurial was written by Matt Mackall <mpm@selenic.com>.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	381
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	382 SEE ALSO
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	383 --------
2209 956e329f9e13 document hgignore syntax in new file doc/hgignore.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2200 diff changeset	384 hg(1), hgignore(5)
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	385
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	386 COPYING
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	387 -------
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	388 This manual page is copyright 2005 Bryan O'Sullivan.
2209 956e329f9e13 document hgignore syntax in new file doc/hgignore.5.txt. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2200 diff changeset	389 Mercurial is copyright 2005, 2006 Matt Mackall.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	390 Free use of this software is granted under the terms of the GNU General
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	391 Public License (GPL).

Mercurial > hg > pyhgsh

annotate doc/hgrc.5.txt @ 2266:3f7692b0ff13