hgrc.5.txt
231 lines
| 7.4 KiB
| text/plain
|
TextLexer
/ doc / hgrc.5.txt
|
r671 | HGRC(5) | ||
======= | ||||
Bryan O'Sullivan <bos@serpentine.com> | ||||
NAME | ||||
---- | ||||
hgrc - configuration files for Mercurial | ||||
SYNOPSIS | ||||
-------- | ||||
The Mercurial system uses a set of configuration files to control | ||||
aspects of its behaviour. | ||||
FILES | ||||
----- | ||||
|
r1304 | Mercurial reads configuration data from up to three files, if they | ||
exist. The names of these files depend on the system on which | ||||
Mercurial is installed. | ||||
|
r951 | |||
|
r1304 | (Unix) /etc/mercurial/hgrc:: | ||
(Windows) C:\Mercurial\Mercurial.ini:: | ||||
|
r951 | Options in this global configuration file apply to all Mercurial | ||
commands executed by any user in any directory. | ||||
|
r671 | |||
|
r1304 | (Unix) $HOME/.hgrc:: | ||
(Windows) C:\Documents and Settings\USERNAME\Mercurial.ini | ||||
|
r951 | Per-user configuration options that apply to all Mercurial commands, | ||
no matter from which directory they are run. Values in this file | ||||
override global settings. | ||||
|
r671 | |||
|
r1304 | (Unix, Windows) <repo>/.hg/hgrc:: | ||
|
r671 | Per-repository configuration options that only apply in a | ||
particular repository. This file is not version-controlled, and | ||||
will not get transferred during a "clone" operation. Values in | ||||
|
r951 | this file override global and per-user settings. | ||
|
r671 | |||
SYNTAX | ||||
------ | ||||
A configuration file consists of sections, led by a "[section]" header | ||||
and followed by "name: value" entries; "name=value" is also accepted. | ||||
[spam] | ||||
eggs=ham | ||||
green= | ||||
eggs | ||||
Each line contains one entry. If the lines that follow are indented, | ||||
they are treated as continuations of that entry. | ||||
Leading whitespace is removed from values. Empty lines are skipped. | ||||
The optional values can contain format strings which refer to other | ||||
values in the same section, or values in a special DEFAULT section. | ||||
Lines beginning with "#" or ";" are ignored and may be used to provide | ||||
comments. | ||||
SECTIONS | ||||
-------- | ||||
This section describes the different sections that may appear in a | ||||
Mercurial "hgrc" file, the purpose of each section, its possible | ||||
keys, and their possible values. | ||||
|
r1308 | decode/encode:: | ||
|
r1258 | Filters for transforming files on checkout/checkin. This would | ||
typically be used for newline processing or other | ||||
localization/canonicalization of files. | ||||
Filters consist of a filter pattern followed by a filter command. | ||||
|
r1293 | Filter patterns are globs by default, rooted at the repository | ||
root. For example, to match any file ending in ".txt" in the root | ||||
directory only, use the pattern "*.txt". To match any file ending | ||||
in ".c" anywhere in the repository, use the pattern "**.c". | ||||
|
r1258 | |||
|
r1293 | The filter command can start with a specifier, either "pipe:" or | ||
"tempfile:". If no specifier is given, "pipe:" is used by default. | ||||
A "pipe:" command must accept data on stdin and return the | ||||
transformed data on stdout. | ||||
Pipe example: | ||||
|
r1258 | |||
[encode] | ||||
# uncompress gzip files on checkin to improve delta compression | ||||
# note: not necessarily a good idea, just an example | ||||
|
r1293 | *.gz = pipe: gunzip | ||
|
r1258 | |||
[decode] | ||||
|
r1293 | # recompress gzip files when writing them to the working dir (we | ||
# can safely omit "pipe:", because it's the default) | ||||
|
r1258 | *.gz = gzip | ||
|
r1293 | A "tempfile:" command is a template. The string INFILE is replaced | ||
with the name of a temporary file that contains the data to be | ||||
filtered by the command. The string OUTFILE is replaced with the | ||||
name of an empty temporary file, where the filtered data must be | ||||
written by the command. | ||||
NOTE: the tempfile mechanism is recommended for Windows systems, | ||||
where the standard shell I/O redirection operators often have | ||||
strange effects. In particular, if you are doing line ending | ||||
conversion on Windows using the popular dos2unix and unix2dos | ||||
programs, you *must* use the tempfile mechanism, as using pipes will | ||||
corrupt the contents of your files. | ||||
Tempfile example: | ||||
[encode] | ||||
# convert files to unix line ending conventions on checkin | ||||
**.txt = tempfile: dos2unix -n INFILE OUTFILE | ||||
[decode] | ||||
# convert files to windows line ending conventions when writing | ||||
# them to the working dir | ||||
**.txt = tempfile: unix2dos -n INFILE OUTFILE | ||||
|
r671 | hooks:: | ||
Commands that get automatically executed by various actions such as | ||||
starting or finishing a commit. | ||||
|
r1171 | changegroup;; | ||
|
r1316 | Run after a changegroup has been added via push or pull. Passed | ||
the ID of the first new changeset in $NODE. | ||||
|
r1171 | commit;; | ||
|
r1316 | Run after a changeset has been created or for each changeset | ||
pulled. Passed the ID of the newly created changeset in | ||||
environment variable $NODE. | ||||
|
r671 | precommit;; | ||
Run before starting a commit. Exit status 0 allows the commit to | ||||
proceed. Non-zero status will cause the commit to fail. | ||||
http_proxy:: | ||||
Used to access web-based Mercurial repositories through a HTTP | ||||
proxy. | ||||
host;; | ||||
Host name and (optional) port of the proxy server, for example | ||||
"myproxy:8000". | ||||
no;; | ||||
Optional. Comma-separated list of host names that should bypass | ||||
the proxy. | ||||
|
r1171 | passwd;; | ||
Optional. Password to authenticate with at the proxy server. | ||||
user;; | ||||
Optional. User name to authenticate with at the proxy server. | ||||
|
r671 | |||
paths:: | ||||
Assigns symbolic names to repositories. The left side is the | ||||
symbolic name, and the right gives the directory or URL that is the | ||||
location of the repository. | ||||
ui:: | ||||
User interface controls. | ||||
debug;; | ||||
|
r702 | Print debugging information. True or False. Default is False. | ||
|
r671 | editor;; | ||
|
r702 | The editor to use during a commit. Default is $EDITOR or "vi". | ||
interactive;; | ||||
Allow to prompt the user. True or False. Default is True. | ||||
|
r671 | merge;; | ||
The conflict resolution program to use during a manual merge. | ||||
|
r702 | Default is "hgmerge". | ||
|
r671 | quiet;; | ||
|
r702 | Reduce the amount of output printed. True or False. Default is False. | ||
|
r1171 | remotecmd;; | ||
remote command to use for clone/push/pull operations. Default is 'hg'. | ||||
ssh;; | ||||
command to use for SSH connections. Default is 'ssh'. | ||||
|
r671 | username;; | ||
The committer of a changeset created when running "commit". | ||||
Typically a person's name and email address, e.g. "Fred Widget | ||||
|
r702 | <fred@example.com>". Default is $EMAIL or username@hostname. | ||
|
r671 | verbose;; | ||
|
r702 | Increase the amount of output printed. True or False. Default is False. | ||
|
r962 | |||
|
r671 | |||
|
r938 | web:: | ||
Web interface configuration. | ||||
accesslog;; | ||||
Where to output the access log. Default is stdout. | ||||
|
r1171 | address;; | ||
Interface address to bind to. Default is all. | ||||
allowbz2;; | ||||
Whether to allow .tar.bz2 downloading of repo revisions. Default is false. | ||||
allowgz;; | ||||
Whether to allow .tar.gz downloading of repo revisions. Default is false. | ||||
|
r964 | allowpull;; | ||
Whether to allow pulling from the repository. Default is true. | ||||
|
r1079 | allowzip;; | ||
Whether to allow .zip downloading of repo revisions. Default is false. | ||||
This feature creates temporary files. | ||||
|
r1171 | description;; | ||
Textual description of the repository's purpose or contents. | ||||
Default is "unknown". | ||||
errorlog;; | ||||
Where to output the error log. Default is stderr. | ||||
ipv6;; | ||||
Whether to use IPv6. Default is false. | ||||
name;; | ||||
Repository name to use in the web interface. Default is current | ||||
working directory. | ||||
maxchanges;; | ||||
Maximum number of changes to list on the changelog. Default is 10. | ||||
maxfiles;; | ||||
Maximum number of files to list per changeset. Default is 10. | ||||
port;; | ||||
Port to listen on. Default is 8000. | ||||
style;; | ||||
Which template map style to use. | ||||
templates;; | ||||
Where to find the HTML templates. Default is install path. | ||||
|
r1079 | |||
|
r938 | |||
|
r671 | AUTHOR | ||
------ | ||||
Bryan O'Sullivan <bos@serpentine.com>. | ||||
Mercurial was written by Matt Mackall <mpm@selenic.com>. | ||||
SEE ALSO | ||||
-------- | ||||
hg(1) | ||||
COPYING | ||||
------- | ||||
This manual page is copyright 2005 Bryan O'Sullivan. | ||||
Mercurial is copyright 2005 Matt Mackall. | ||||
Free use of this software is granted under the terms of the GNU General | ||||
Public License (GPL). | ||||