hgrc.5.txt
701 lines
| 26.0 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 | ||||
----- | ||||
|
r1583 | Mercurial reads configuration data from several files, if they exist. | ||
The names of these files depend on the system on which Mercurial is | ||||
|
r6446 | installed. *.rc files from a single directory are read in | ||
alphabetical order, later ones overriding earlier ones. Where | ||||
|
r6310 | multiple paths are given below, settings from later paths override | ||
earlier ones. | ||||
|
r951 | |||
|
r6310 | (Unix) <install-root>/etc/mercurial/hgrc.d/*.rc:: | ||
(Unix) <install-root>/etc/mercurial/hgrc:: | ||||
|
r1583 | Per-installation configuration files, searched for in the | ||
|
r6446 | directory where Mercurial is installed. <install-root> is the | ||
|
r6310 | parent directory of the hg executable (or symlink) being run. | ||
For example, if installed in /shared/tools/bin/hg, Mercurial will | ||||
|
r6446 | look in /shared/tools/etc/mercurial/hgrc. Options in these files | ||
|
r6310 | apply to all Mercurial commands executed by any user in any | ||
directory. | ||||
|
r1583 | |||
|
r6310 | (Unix) /etc/mercurial/hgrc.d/*.rc:: | ||
(Unix) /etc/mercurial/hgrc:: | ||||
|
r1583 | Per-system configuration files, for the system on which Mercurial | ||
|
r6446 | is running. Options in these files apply to all Mercurial | ||
commands executed by any user in any directory. Options in these | ||||
|
r1583 | files override per-installation options. | ||
|
r671 | |||
|
r6310 | (Windows) <install-dir>\Mercurial.ini:: | ||
or else:: | ||||
(Windows) HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial:: | ||||
or else:: | ||||
(Windows) C:\Mercurial\Mercurial.ini:: | ||||
Per-installation/system configuration files, for the system on | ||||
|
r6446 | which Mercurial is running. Options in these files apply to all | ||
|
r6310 | Mercurial commands executed by any user in any directory. | ||
Registry keys contain PATH-like strings, every part of which must | ||||
reference a Mercurial.ini file or be a directory where *.rc files | ||||
will be read. | ||||
(Unix) $HOME/.hgrc:: | ||||
(Windows) %HOME%\Mercurial.ini:: | ||||
(Windows) %HOME%\.hgrc:: | ||||
(Windows) %USERPROFILE%\Mercurial.ini:: | ||||
(Windows) %USERPROFILE%\.hgrc:: | ||||
Per-user configuration file(s), for the user running Mercurial. | ||||
On Windows 9x, %HOME% is replaced by %APPDATA%. | ||||
Options in these files apply to all Mercurial commands executed | ||||
|
r6446 | by this user in any directory. Options in thes files override | ||
|
r1583 | per-installation and per-system options. | ||
|
r671 | |||
|
r1304 | (Unix, Windows) <repo>/.hg/hgrc:: | ||
|
r671 | Per-repository configuration options that only apply in a | ||
|
r6446 | particular repository. This file is not version-controlled, and | ||
will not get transferred during a "clone" operation. Options in | ||||
|
r1583 | this file override options in all other configuration files. | ||
|
r3552 | On Unix, most of this file will be ignored if it doesn't belong | ||
|
r6446 | to a trusted user or to a trusted group. See the documentation | ||
|
r3552 | for the trusted section below for more details. | ||
|
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 | ||||
|
r6446 | Each line contains one entry. If the lines that follow are indented, | ||
|
r671 | they are treated as continuations of that entry. | ||
|
r6446 | Leading whitespace is removed from values. Empty lines are skipped. | ||
|
r671 | |||
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 | ||
|
r6446 | root. For example, to match any file ending in ".txt" in the root | ||
directory only, use the pattern "*.txt". To match any file ending | ||||
|
r1293 | in ".c" anywhere in the repository, use the pattern "**.c". | ||
|
r1258 | |||
|
r1293 | The filter command can start with a specifier, either "pipe:" or | ||
|
r6446 | "tempfile:". If no specifier is given, "pipe:" is used by default. | ||
|
r1293 | |||
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 | ||
|
r6446 | A "tempfile:" command is a template. The string INFILE is replaced | ||
|
r1293 | with the name of a temporary file that contains the data to be | ||
|
r6446 | filtered by the command. The string OUTFILE is replaced with the | ||
|
r1293 | 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 | ||||
|
r5678 | strange effects and may corrupt the contents of your files. | ||
|
r1293 | |||
|
r5678 | The most common usage is for LF <-> CRLF translation on Windows. | ||
For this, use the "smart" convertors which check for binary files: | ||||
|
r1293 | |||
|
r5678 | [extensions] | ||
hgext.win32text = | ||||
|
r1293 | [encode] | ||
|
r5678 | ** = cleverencode: | ||
|
r1293 | [decode] | ||
|
r5678 | ** = cleverdecode: | ||
or if you only want to translate certain files: | ||||
[extensions] | ||||
hgext.win32text = | ||||
[encode] | ||||
**.txt = dumbencode: | ||||
[decode] | ||||
**.txt = dumbdecode: | ||||
|
r1293 | |||
|
r3039 | defaults:: | ||
|
r5081 | Use the [defaults] section to define command defaults, i.e. the | ||
|
r3039 | default options/arguments to pass to the specified commands. | ||
|
r5081 | |||
|
r3039 | The following example makes 'hg log' run in verbose mode, and | ||
'hg status' show only the modified files, by default. | ||||
|
r5081 | |||
|
r3039 | [defaults] | ||
log = -v | ||||
status = -m | ||||
|
r5081 | |||
The actual commands, instead of their aliases, must be used when | ||||
|
r3039 | defining command defaults. The command defaults will also be | ||
applied to the aliases of the commands defined. | ||||
|
r4011 | diff:: | ||
Settings used when displaying diffs. They are all boolean and | ||||
defaults to False. | ||||
git;; | ||||
Use git extended diff format. | ||||
nodates;; | ||||
Don't include dates in diff headers. | ||||
showfunc;; | ||||
Show which function each change is in. | ||||
ignorews;; | ||||
Ignore white space when comparing lines. | ||||
ignorewsamount;; | ||||
Ignore changes in the amount of white space. | ||||
ignoreblanklines;; | ||||
Ignore changes whose lines are all blank. | ||||
|
r2200 | email:: | ||
Settings for extensions that send email messages. | ||||
from;; | ||||
|
r6446 | Optional. Email address to use in "From" header and SMTP envelope | ||
|
r2200 | of outgoing messages. | ||
|
r2680 | to;; | ||
|
r6446 | Optional. Comma-separated list of recipients' email addresses. | ||
|
r2680 | cc;; | ||
|
r6446 | Optional. Comma-separated list of carbon copy recipients' | ||
|
r2691 | email addresses. | ||
|
r2680 | bcc;; | ||
|
r6446 | Optional. Comma-separated list of blind carbon copy | ||
recipients' email addresses. Cannot be set interactively. | ||||
|
r2292 | method;; | ||
|
r6446 | Optional. Method to use to send email messages. If value is | ||
|
r2678 | "smtp" (default), use SMTP (see section "[smtp]" for | ||
|
r6446 | configuration). Otherwise, use as name of program to run that | ||
|
r2292 | acts like sendmail (takes "-f" option for sender, list of | ||
|
r6446 | recipients on command line, message on stdin). Normally, setting | ||
|
r2292 | this to "sendmail" or "/usr/sbin/sendmail" is enough to use | ||
sendmail to send messages. | ||||
Email example: | ||||
[email] | ||||
from = Joseph User <joe.user@example.com> | ||||
method = /usr/sbin/sendmail | ||||
|
r2200 | |||
|
r2211 | extensions:: | ||
Mercurial has an extension mechanism for adding new features. To | ||||
enable an extension, create an entry for it in this section. | ||||
If you know that the extension is already in Python's search path, | ||||
you can give the name of the module, followed by "=", with nothing | ||||
after the "=". | ||||
Otherwise, give a name that you choose, followed by "=", followed by | ||||
the path to the ".py" file (including the file name extension) that | ||||
defines the extension. | ||||
|
r6175 | To explicitly disable an extension that is enabled in an hgrc of | ||
|
r6210 | broader scope, prepend its path with '!', as in | ||
|
r6175 | 'hgext.foo = !/ext/path' or 'hgext.foo = !' when no path is supplied. | ||
|
r2387 | Example for ~/.hgrc: | ||
[extensions] | ||||
# (the mq extension will get loaded from mercurial's path) | ||||
hgext.mq = | ||||
# (this extension will get loaded from the file specified) | ||||
myfeature = ~/.hgext/myfeature.py | ||||
|
r4163 | format:: | ||
usestore;; | ||||
Enable or disable the "store" repository format which improves | ||||
compatibility with systems that fold case or otherwise mangle | ||||
filenames. Enabled by default. Disabling this option will allow | ||||
you to store longer filenames in some situations at the expense of | ||||
compatibility. | ||||
|
r6010 | merge-patterns:: | ||
This section specifies merge tools to associate with particular file | ||||
patterns. Tools matched here will take precedence over the default | ||||
merge tool. Patterns are globs by default, rooted at the repository root. | ||||
Example: | ||||
[merge-patterns] | ||||
**.c = kdiff3 | ||||
**.jpg = myimgmerge | ||||
merge-tools:: | ||||
This section configures external merge tools to use for file-level | ||||
merges. | ||||
Example ~/.hgrc: | ||||
[merge-tools] | ||||
# Override stock tool location | ||||
kdiff3.executable = ~/bin/kdiff3 | ||||
# Specify command line | ||||
kdiff3.args = $base $local $other -o $output | ||||
# Give higher priority | ||||
kdiff3.priority = 1 | ||||
# Define new tool | ||||
myHtmlTool.args = -m $local $other $base $output | ||||
myHtmlTool.regkey = Software\FooSoftware\HtmlMerge | ||||
myHtmlTool.priority = 1 | ||||
Supported arguments: | ||||
|
r6445 | |||
|
r6010 | priority;; | ||
The priority in which to evaluate this tool. | ||||
Default: 0. | ||||
executable;; | ||||
Either just the name of the executable or its pathname. | ||||
Default: the tool name. | ||||
args;; | ||||
The arguments to pass to the tool executable. You can refer to the files | ||||
being merged as well as the output file through these variables: $base, | ||||
$local, $other, $output. | ||||
Default: $local $base $other | ||||
premerge;; | ||||
Attempt to run internal non-interactive 3-way merge tool before | ||||
launching external tool. | ||||
Default: True | ||||
binary;; | ||||
|
r6446 | This tool can merge binary files. Defaults to False, unless tool | ||
|
r6010 | was selected by file pattern match. | ||
symlink;; | ||||
|
r6446 | This tool can merge symlinks. Defaults to False, even if tool was | ||
|
r6010 | selected by file pattern match. | ||
checkconflicts;; | ||||
Check whether there are conflicts even though the tool reported | ||||
success. | ||||
Default: False | ||||
|
r6075 | checkchanged;; | ||
Check whether outputs were written even though the tool reported | ||||
success. | ||||
Default: False | ||||
|
r6010 | fixeol;; | ||
Attempt to fix up EOL changes caused by the merge tool. | ||||
Default: False | ||||
|
r6445 | gui;; | ||
|
r6010 | This tool requires a graphical interface to run. Default: False | ||
regkey;; | ||||
Windows registry key which describes install location of this tool. | ||||
Mercurial will search for this key first under HKEY_CURRENT_USER and | ||||
|
r6446 | then under HKEY_LOCAL_MACHINE. Default: None | ||
|
r6010 | regname;; | ||
|
r6446 | Name of value to read from specified registry key. Defaults to the | ||
|
r6010 | unnamed (default) value. | ||
regappend;; | ||||
String to append to the value read from the registry, typically the | ||||
|
r6446 | executable name of the tool. Default: None | ||
|
r6010 | |||
|
r671 | hooks:: | ||
|
r2155 | Commands or Python functions that get automatically executed by | ||
various actions such as starting or finishing a commit. Multiple | ||||
hooks can be run for the same action by appending a suffix to the | ||||
action. Overriding a site-wide hook can be done by changing its | ||||
value or setting it to an empty string. | ||||
|
r1485 | |||
Example .hg/hgrc: | ||||
[hooks] | ||||
# do not use the site-wide hook | ||||
|
r1714 | incoming = | ||
incoming.email = /my/email/hook | ||||
incoming.autobuild = /my/build/hook | ||||
|
r1485 | |||
|
r1727 | Most hooks are run with environment variables set that give added | ||
|
r6446 | useful information. For each hook below, the environment variables | ||
|
r1727 | it is passed are listed with names of the form "$HG_foo". | ||
|
r1171 | changegroup;; | ||
|
r1730 | Run after a changegroup has been added via push, pull or | ||
|
r6446 | unbundle. ID of the first new changeset is in $HG_NODE. URL from | ||
|
r2673 | which changes came is in $HG_URL. | ||
|
r1171 | commit;; | ||
|
r1714 | Run after a changeset has been created in the local repository. | ||
|
r6446 | ID of the newly created changeset is in $HG_NODE. Parent | ||
|
r1727 | changeset IDs are in $HG_PARENT1 and $HG_PARENT2. | ||
|
r1714 | incoming;; | ||
Run after a changeset has been pulled, pushed, or unbundled into | ||||
|
r6446 | the local repository. The ID of the newly arrived changeset is in | ||
$HG_NODE. URL that was source of changes came is in $HG_URL. | ||||
|
r1736 | outgoing;; | ||
|
r6446 | Run after sending changes from local repository to another. ID of | ||
first changeset sent is in $HG_NODE. Source of operation is in | ||||
|
r1736 | $HG_SOURCE; see "preoutgoing" hook for description. | ||
|
r4715 | post-<command>;; | ||
Run after successful invocations of the associated command. The | ||||
contents of the command line are passed as $HG_ARGS and the result | ||||
code in $HG_RESULT. Hook failure is ignored. | ||||
pre-<command>;; | ||||
Run before executing the associated command. The contents of the | ||||
command line are passed as $HG_ARGS. If the hook returns failure, | ||||
the command doesn't execute and Mercurial returns the failure code. | ||||
|
r1730 | prechangegroup;; | ||
Run before a changegroup is added via push, pull or unbundle. | ||||
|
r6446 | Exit status 0 allows the changegroup to proceed. Non-zero status | ||
will cause the push, pull or unbundle to fail. URL from which | ||||
|
r2673 | changes will come is in $HG_URL. | ||
|
r671 | precommit;; | ||
|
r6446 | Run before starting a local commit. Exit status 0 allows the | ||
commit to proceed. Non-zero status will cause the commit to fail. | ||||
|
r1727 | Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2. | ||
|
r1736 | preoutgoing;; | ||
|
r5634 | Run before collecting changes to send from the local repository to | ||
|
r6446 | another. Non-zero status will cause failure. This lets you | ||
prevent pull over http or ssh. Also prevents against local pull, | ||||
|
r1736 | push (outbound) or bundle commands, but not effective, since you | ||
|
r6446 | can just copy files instead then. Source of operation is in | ||
$HG_SOURCE. If "serve", operation is happening on behalf of | ||||
remote ssh or http repository. If "push", "pull" or "bundle", | ||||
|
r1736 | operation is happening on behalf of repository on same system. | ||
|
r1720 | pretag;; | ||
|
r6446 | Run before creating a tag. Exit status 0 allows the tag to be | ||
created. Non-zero status will cause the tag to fail. ID of | ||||
changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag | ||||
|
r1727 | is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0. | ||
|
r1730 | pretxnchangegroup;; | ||
Run after a changegroup has been added via push, pull or unbundle, | ||||
|
r6446 | but before the transaction has been committed. Changegroup is | ||
visible to hook program. This lets you validate incoming changes | ||||
before accepting them. Passed the ID of the first new changeset | ||||
in $HG_NODE. Exit status 0 allows the transaction to commit. | ||||
|
r1730 | Non-zero status will cause the transaction to be rolled back and | ||
|
r6446 | the push, pull or unbundle will fail. URL that was source of | ||
|
r2673 | changes is in $HG_URL. | ||
|
r1721 | pretxncommit;; | ||
Run after a changeset has been created but the transaction not yet | ||||
|
r6446 | committed. Changeset is visible to hook program. This lets you | ||
validate commit message and changes. Exit status 0 allows the | ||||
commit to proceed. Non-zero status will cause the transaction to | ||||
be rolled back. ID of changeset is in $HG_NODE. Parent changeset | ||||
|
r1727 | IDs are in $HG_PARENT1 and $HG_PARENT2. | ||
|
r2266 | preupdate;; | ||
|
r6446 | Run before updating the working directory. Exit status 0 allows | ||
the update to proceed. Non-zero status will prevent the update. | ||||
Changeset ID of first new parent is in $HG_PARENT1. If merge, ID | ||||
|
r2266 | of second new parent is in $HG_PARENT2. | ||
|
r1720 | tag;; | ||
|
r6446 | Run after a tag is created. ID of tagged changeset is in | ||
$HG_NODE. Name of tag is in $HG_TAG. Tag is local if | ||||
|
r1727 | $HG_LOCAL=1, in repo if $HG_LOCAL=0. | ||
|
r2266 | update;; | ||
|
r6446 | Run after updating the working directory. Changeset ID of first | ||
new parent is in $HG_PARENT1. If merge, ID of second new parent | ||||
is in $HG_PARENT2. If update succeeded, $HG_ERROR=0. If update | ||||
|
r2266 | failed (e.g. because conflicts not resolved), $HG_ERROR=1. | ||
|
r1726 | |||
|
r4630 | Note: it is generally better to use standard hooks rather than the | ||
generic pre- and post- command hooks as they are guaranteed to be | ||||
called in the appropriate contexts for influencing transactions. | ||||
Also, hooks like "commit" will be called in all contexts that | ||||
generate a commit (eg. tag) and not just the commit command. | ||||
|
r671 | |||
|
r4661 | Note2: Environment variables with empty values may not be passed to | ||
hooks on platforms like Windows. For instance, $HG_PARENT2 will | ||||
not be available under Windows for non-merge changesets while being | ||||
set to an empty value under Unix-like systems. | ||||
|
r4641 | |||
|
r2155 | The syntax for Python hooks is as follows: | ||
hookname = python:modulename.submodule.callable | ||||
|
r6446 | Python hooks are run within the Mercurial process. Each hook is | ||
|
r2155 | called with at least three keyword arguments: a ui object (keyword | ||
"ui"), a repository object (keyword "repo"), and a "hooktype" | ||||
|
r6446 | keyword that tells what kind of hook is used. Arguments listed as | ||
|
r2155 | environment variables above are passed as keyword arguments, with no | ||
"HG_" prefix, and names in lower case. | ||||
|
r3616 | If a Python hook returns a "true" value or raises an exception, this | ||
is treated as failure of the hook. | ||||
|
r2155 | |||
|
r671 | 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;; | ||||
|
r6446 | Optional. Comma-separated list of host names that should bypass | ||
|
r671 | the proxy. | ||
|
r1171 | passwd;; | ||
|
r6446 | Optional. Password to authenticate with at the proxy server. | ||
|
r1171 | user;; | ||
|
r6446 | Optional. User name to authenticate with at the proxy server. | ||
|
r671 | |||
|
r2200 | smtp:: | ||
Configuration for extensions that need to send email messages. | ||||
host;; | ||||
|
r2853 | Host name of mail server, e.g. "mail.example.com". | ||
|
r2200 | port;; | ||
|
r6446 | Optional. Port to connect to on mail server. Default: 25. | ||
|
r2200 | tls;; | ||
|
r6446 | Optional. Whether to connect to mail server using TLS. True or | ||
False. Default: False. | ||||
|
r2200 | username;; | ||
|
r6446 | Optional. User name to authenticate to SMTP server with. | ||
|
r2200 | If username is specified, password must also be specified. | ||
Default: none. | ||||
password;; | ||||
|
r6446 | Optional. Password to authenticate to SMTP server with. | ||
|
r2200 | If username is specified, password must also be specified. | ||
Default: none. | ||||
|
r2583 | local_hostname;; | ||
|
r6446 | Optional. It's the hostname that the sender can use to identify itself | ||
|
r2583 | to the MTA. | ||
|
r2200 | |||
|
r671 | paths:: | ||
|
r6446 | Assigns symbolic names to repositories. The left side is the | ||
|
r671 | symbolic name, and the right gives the directory or URL that is the | ||
|
r6446 | location of the repository. Default paths can be declared by | ||
|
r2621 | setting the following entries. | ||
|
r2277 | default;; | ||
Directory or URL to use when pulling if no source is specified. | ||||
Default is set to repository from which the current repository | ||||
was cloned. | ||||
default-push;; | ||||
|
r6446 | Optional. Directory or URL to use when pushing if no destination | ||
|
r2277 | is specified. | ||
|
r671 | |||
|
r2621 | server:: | ||
Controls generic server settings. | ||||
|
r2622 | uncompressed;; | ||
|
r2621 | Whether to allow clients to clone a repo using the uncompressed | ||
|
r6446 | streaming protocol. This transfers about 40% more data than a | ||
|
r2621 | regular clone, but uses less memory and CPU on both server and | ||
|
r6446 | client. Over a LAN (100Mbps or better) or a very fast WAN, an | ||
|
r2621 | uncompressed streaming clone is a lot faster (~10x) than a regular | ||
|
r6446 | clone. Over most WAN connections (anything slower than about | ||
|
r2621 | 6Mbps), uncompressed streaming is slower, because of the extra | ||
|
r6446 | data transfer overhead. Default is False. | ||
|
r2621 | |||
|
r3551 | trusted:: | ||
|
r3552 | For security reasons, Mercurial will not use the settings in | ||
the .hg/hgrc file from a repository if it doesn't belong to a | ||||
|
r6446 | trusted user or to a trusted group. The main exception is the | ||
|
r3552 | web interface, which automatically uses some safe settings, since | ||
it's common to serve repositories from different users. | ||||
|
r6446 | This section specifies what users and groups are trusted. The | ||
current user is always trusted. To trust everybody, list a user | ||||
|
r3552 | or a group with name "*". | ||
|
r3551 | users;; | ||
Comma-separated list of trusted users. | ||||
groups;; | ||||
Comma-separated list of trusted groups. | ||||
|
r671 | ui:: | ||
User interface controls. | ||||
|
r6183 | archivemeta;; | ||
Whether to include the .hg_archival.txt file containing metadata | ||||
(hashes for the repository base and for tip) in archives created by | ||||
the hg archive command or downloaded via hgweb. | ||||
Default is true. | ||||
|
r671 | debug;; | ||
|
r6446 | Print debugging information. True or False. Default is False. | ||
|
r671 | editor;; | ||
|
r6446 | The editor to use during a commit. Default is $EDITOR or "vi". | ||
|
r3835 | fallbackencoding;; | ||
Encoding to try if it's not possible to decode the changelog using | ||||
|
r6446 | UTF-8. Default is ISO-8859-1. | ||
|
r2003 | ignore;; | ||
A file to read per-user ignore patterns from. This file should be in | ||||
the same format as a repository-wide .hgignore file. This option | ||||
supports hook syntax, so if you want to specify multiple ignore | ||||
files, you can do so by setting something like | ||||
|
r2209 | "ignore.other = ~/.hgignore2". For details of the ignore file | ||
format, see the hgignore(5) man page. | ||||
|
r702 | interactive;; | ||
|
r6446 | Allow to prompt the user. True or False. Default is True. | ||
|
r1907 | logtemplate;; | ||
Template string for commands that print changesets. | ||||
|
r671 | merge;; | ||
The conflict resolution program to use during a manual merge. | ||||
|
r6010 | There are some internal tools available: | ||
internal:local;; | ||||
keep the local version | ||||
internal:other;; | ||||
use the other version | ||||
internal:merge;; | ||||
use the internal non-interactive merge tool | ||||
internal:fail;; | ||||
fail to merge | ||||
See the merge-tools section for more information on configuring tools. | ||||
|
r6445 | |||
|
r4435 | patch;; | ||
command to use to apply patches. Look for 'gpatch' or 'patch' in PATH if | ||||
unset. | ||||
|
r671 | quiet;; | ||
|
r6446 | 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'. | ||||
|
r4717 | report_untrusted;; | ||
Warn if a .hg/hgrc file is ignored due to not being owned by a | ||||
|
r6446 | trusted user or group. True or False. Default is True. | ||
|
r4527 | slash;; | ||
|
r6446 | Display paths using a slash ("/") as the path separator. This only | ||
|
r4527 | makes a difference on systems where the default path separator is not | ||
the slash character (e.g. Windows uses the backslash character ("\")). | ||||
Default is False. | ||||
|
r1171 | ssh;; | ||
command to use for SSH connections. Default is 'ssh'. | ||||
|
r2988 | strict;; | ||
Require exact command names, instead of allowing unambiguous | ||||
|
r6446 | abbreviations. True or False. Default is False. | ||
|
r4715 | style;; | ||
Name of style to use for command output. | ||||
|
r1787 | timeout;; | ||
The timeout used when a lock is held (in seconds), a negative value | ||||
|
r1788 | means no timeout. Default is 600. | ||
|
r671 | username;; | ||
The committer of a changeset created when running "commit". | ||||
Typically a person's name and email address, e.g. "Fred Widget | ||||
|
r6446 | <fred@example.com>". Default is $EMAIL or username@hostname. | ||
|
r4052 | If the username in hgrc is empty, it has to be specified manually or | ||
in a different hgrc file (e.g. $HOME/.hgrc, if the admin set "username =" | ||||
in the system hgrc). | ||||
|
r671 | verbose;; | ||
|
r6446 | 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. | ||||
|
r2358 | allow_archive;; | ||
List of archive format (bz2, gz, zip) allowed for downloading. | ||||
Default is empty. | ||||
|
r1171 | allowbz2;; | ||
|
r2358 | (DEPRECATED) Whether to allow .tar.bz2 downloading of repo revisions. | ||
Default is false. | ||||
|
r1171 | allowgz;; | ||
|
r2358 | (DEPRECATED) Whether to allow .tar.gz downloading of repo revisions. | ||
Default is false. | ||||
|
r964 | allowpull;; | ||
Whether to allow pulling from the repository. Default is true. | ||||
|
r2466 | allow_push;; | ||
|
r6446 | Whether to allow pushing to the repository. If empty or not set, | ||
push is not allowed. If the special value "*", any remote user | ||||
can push, including unauthenticated users. Otherwise, the remote | ||||
|
r2466 | user must have been authenticated, and the authenticated user name | ||
must be present in this list (separated by whitespace or ","). | ||||
The contents of the allow_push list are examined after the | ||||
deny_push list. | ||||
|
r1079 | allowzip;; | ||
|
r2358 | (DEPRECATED) Whether to allow .zip downloading of repo revisions. | ||
Default is false. This feature creates temporary files. | ||||
|
r2197 | baseurl;; | ||
Base URL to use when publishing URLs in other locations, so | ||||
third-party tools like email notification hooks can construct URLs. | ||||
Example: "http://hgserver/repos/" | ||||
|
r2430 | contact;; | ||
Name or email address of the person in charge of the repository. | ||||
|
r5779 | Defaults to ui.username or $EMAIL or "unknown" if unset or empty. | ||
|
r2466 | deny_push;; | ||
|
r6446 | Whether to deny pushing to the repository. If empty or not set, | ||
push is not denied. If the special value "*", all remote users | ||||
are denied push. Otherwise, unauthenticated users are all denied, | ||||
|
r2466 | and any authenticated user name present in this list (separated by | ||
|
r6446 | whitespace or ",") is also denied. The contents of the deny_push | ||
|
r2466 | list are examined before the allow_push list. | ||
|
r1171 | description;; | ||
Textual description of the repository's purpose or contents. | ||||
Default is "unknown". | ||||
|
r4715 | encoding;; | ||
Character encoding name. | ||||
Example: "UTF-8" | ||||
|
r1171 | errorlog;; | ||
Where to output the error log. Default is stderr. | ||||
|
r4709 | hidden;; | ||
Whether to hide the repository in the hgwebdir index. Default is false. | ||||
|
r1171 | 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. | ||||
|
r5972 | prefix;; | ||
Prefix path to serve from. Default is '' (server root). | ||||
|
r2466 | push_ssl;; | ||
Whether to require that inbound pushes be transported over SSL to | ||||
|
r6446 | prevent password sniffing. Default is true. | ||
|
r4084 | staticurl;; | ||
Base URL to use for static files. If unset, static files (e.g. | ||||
the hgicon.png favicon) will be served by the CGI script itself. | ||||
Use this setting to serve them directly with the HTTP server. | ||||
Example: "http://hgserver/static/" | ||||
|
r2666 | stripes;; | ||
How many lines a "zebra stripe" should span in multiline output. | ||||
Default is 1; set to 0 to disable. | ||||
|
r1171 | 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 | ||||
-------- | ||||
|
r2209 | hg(1), hgignore(5) | ||
|
r671 | |||
COPYING | ||||
------- | ||||
This manual page is copyright 2005 Bryan O'Sullivan. | ||||
|
r4635 | Mercurial is copyright 2005-2007 Matt Mackall. | ||
|
r671 | Free use of this software is granted under the terms of the GNU General | ||
Public License (GPL). | ||||