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

annotate doc/hgrc.5.txt @ 1714:eabfbd220f39

fix hgrc doc hook descriptions.

author	Vadim Gelfer <vadim.gelfer@gmail.com>
date	Sat, 11 Feb 2006 00:31:52 -0800
parents	32a4e6802864
children	55017891051b

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
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	133 hooks::
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	134 Commands that get automatically executed by various actions such as
1485 625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	135 starting or finishing a commit. Multiple commands can be run for
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	136 the same action by appending a suffix to the action. Overriding a
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	137 site-wide hook can be done by changing its value or setting it to
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	138 an empty string.
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	139
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	140 Example .hg/hgrc:
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	141
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	142 [hooks]
625f3f13d7be mention running multiple hooks in the doc Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 1316 diff changeset	143 # do not use the site-wide hook
1714 eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	144 incoming =
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	145 incoming.email = /my/email/hook
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	146 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	147
1171 a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	148 changegroup;;
1316 b650bfdfc7ee Hook fixups mpm@selenic.com parents: 1312 diff changeset	149 Run after a changegroup has been added via push or pull. Passed
b650bfdfc7ee Hook fixups mpm@selenic.com parents: 1312 diff changeset	150 the ID of the first new changeset in $NODE.
1171 a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	151 commit;;
1714 eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	152 Run after a changeset has been created in the local repository.
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	153 Passed the ID of the newly created changeset in environment
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	154 variable $NODE.
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	155 incoming;;
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	156 Run after a changeset has been pulled, pushed, or unbundled into
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	157 the local repository. Passed the ID of the newly arrived
eabfbd220f39 fix hgrc doc hook descriptions. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1583 diff changeset	158 changeset in environment variable $NODE.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	159 precommit;;
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	160 Run before starting a commit. Exit status 0 allows the commit to
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	161 proceed. Non-zero status will cause the commit to fail.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	162
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	163 http_proxy::
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	164 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	165 proxy.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	166 host;;
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	167 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	168 "myproxy:8000".
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	169 no;;
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	170 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	171 the proxy.
1171 a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	172 passwd;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	173 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	174 user;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	175 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	176
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	177 paths::
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	178 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	179 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	180 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	181
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	182 ui::
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	183 User interface controls.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	184 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	185 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	186 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	187 The editor to use during a commit. Default is $EDITOR or "vi".
a1099c50a622 Fix default values and add interactive setting to [ui] section of hgrc docs. Thomas Arendsen Hein <thomas@intevation.de> parents: 671 diff changeset	188 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	189 Allow to prompt the user. True or False. Default is True.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	190 merge;;
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	191 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	192 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	193 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	194 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	195 remotecmd;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	196 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	197 ssh;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	198 command to use for SSH connections. Default is 'ssh'.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	199 username;;
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	200 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	201 Typically a person's name and email address, e.g. "Fred Widget
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	202 <fred@example.com>". Default is $EMAIL or username@hostname.
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	203 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	204 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	205
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	206
938 54b2a42e501e hgweb: add [web] section to hgrc mpm@selenic.com parents: 705 diff changeset	207 web::
54b2a42e501e hgweb: add [web] section to hgrc mpm@selenic.com parents: 705 diff changeset	208 Web interface configuration.
54b2a42e501e hgweb: add [web] section to hgrc mpm@selenic.com parents: 705 diff changeset	209 accesslog;;
54b2a42e501e hgweb: add [web] section to hgrc mpm@selenic.com parents: 705 diff changeset	210 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	211 address;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	212 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	213 allowbz2;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	214 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	215 allowgz;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	216 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	217 allowpull;;
3f37720e7dc7 hgweb: Make maxfiles, maxchanges, and allowpull proper config options mpm@selenic.com parents: 962 diff changeset	218 Whether to allow pulling from the repository. Default is true.
1079 a37974035f1f Document archive download options mpm@selenic.com parents: 986 diff changeset	219 allowzip;;
a37974035f1f Document archive download options mpm@selenic.com parents: 986 diff changeset	220 Whether to allow .zip downloading of repo revisions. Default is false.
a37974035f1f Document archive download options mpm@selenic.com parents: 986 diff changeset	221 This feature creates temporary files.
1171 a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	222 description;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	223 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	224 Default is "unknown".
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	225 errorlog;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	226 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	227 ipv6;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	228 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	229 name;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	230 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	231 working directory.
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	232 maxchanges;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	233 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	234 maxfiles;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	235 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	236 port;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	237 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	238 style;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	239 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	240 templates;;
a425bb927ede Sort items in each hgrc section. Add web/description. Bryan O'Sullivan <bos@serpentine.com> parents: 1079 diff changeset	241 Where to find the HTML templates. Default is install path.
1079 a37974035f1f Document archive download options mpm@selenic.com parents: 986 diff changeset	242
938 54b2a42e501e hgweb: add [web] section to hgrc mpm@selenic.com parents: 705 diff changeset	243
671 efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	244 AUTHOR
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	245 ------
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	246 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	247
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	248 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	249
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	250 SEE ALSO
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	251 --------
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	252 hg(1)
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	253
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	254 COPYING
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	255 -------
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	256 This manual page is copyright 2005 Bryan O'Sullivan.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	257 Mercurial is copyright 2005 Matt Mackall.
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5). Bryan O'Sullivan <bos@serpentine.com> parents: diff changeset	258 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	259 Public License (GPL).

Mercurial > hg > pyhgsh

annotate doc/hgrc.5.txt @ 1714:eabfbd220f39