--- a/doc/hgrc.5.txt Mon Jun 08 00:13:58 2009 +0200
+++ b/doc/hgrc.5.txt Mon Jun 08 00:14:24 2009 +0200
@@ -17,27 +17,25 @@
Mercurial reads configuration data from several files, if they exist.
The names of these files depend on the system on which Mercurial is
-installed. *.rc files from a single directory are read in
-alphabetical order, later ones overriding earlier ones. Where
-multiple paths are given below, settings from later paths override
-earlier ones.
+installed. *.rc files from a single directory are read in alphabetical
+order, later ones overriding earlier ones. Where multiple paths are
+given below, settings from later paths override earlier ones.
(Unix) <install-root>/etc/mercurial/hgrc.d/*.rc::
(Unix) <install-root>/etc/mercurial/hgrc::
Per-installation configuration files, searched for in the
directory where Mercurial is installed. <install-root> is the
- parent directory of the hg executable (or symlink) being run.
- For example, if installed in /shared/tools/bin/hg, Mercurial will
- look in /shared/tools/etc/mercurial/hgrc. Options in these files
- apply to all Mercurial commands executed by any user in any
- directory.
+ parent directory of the hg executable (or symlink) being run. For
+ example, if installed in /shared/tools/bin/hg, Mercurial will look
+ in /shared/tools/etc/mercurial/hgrc. Options in these files apply
+ to all Mercurial commands executed by any user in any directory.
(Unix) /etc/mercurial/hgrc.d/*.rc::
(Unix) /etc/mercurial/hgrc::
Per-system configuration files, for the system on which Mercurial
- is running. Options in these files apply to all Mercurial
- commands executed by any user in any directory. Options in these
- files override per-installation options.
+ is running. Options in these files apply to all Mercurial commands
+ executed by any user in any directory. Options in these files
+ override per-installation options.
(Windows) <install-dir>\Mercurial.ini::
or else::
@@ -46,30 +44,30 @@
(Windows) C:\Mercurial\Mercurial.ini::
Per-installation/system configuration files, for the system on
which Mercurial is running. Options in these files apply to all
- 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.
+ 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
- by this user in any directory. Options in thes files override
+ 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 by
+ this user in any directory. Options in thes files override
per-installation and per-system options.
(Unix, Windows) <repo>/.hg/hgrc::
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. Options in
- this file override options in all other configuration files.
- On Unix, most of this file will be ignored if it doesn't belong
- to a trusted user or to a trusted group. See the documentation
- for the trusted section below for more details.
+ this file override options in all other configuration files. On
+ Unix, most of this file will be ignored if it doesn't belong to a
+ trusted user or to a trusted group. See the documentation for the
+ trusted section below for more details.
SYNTAX
------
@@ -97,8 +95,8 @@
--------
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.
+Mercurial "hgrc" file, the purpose of each section, its possible keys,
+and their possible values.
[[alias]]
alias::
@@ -120,18 +118,17 @@
stable5 = latest -b stable
+
*Note*: It is possible to create aliases with the same names as
-existing commands, which will then override the original
-definitions. This is almost always a bad idea!
+existing commands, which will then override the original definitions.
+This is almost always a bad idea!
[[auth]]
auth::
- Authentication credentials for HTTP authentication.
- Each line has the following format:
+ Authentication credentials for HTTP authentication. Each line has
+ the following format:
<name>.<argument> = <value>
- where <name> is used to group arguments into authentication
- entries.
+ where <name> is used to group arguments into authentication entries.
Example:
foo.prefix = hg.intevation.org/mercurial
@@ -145,23 +142,23 @@
Either '*' or a URI prefix with or without the scheme part. The
authentication entry with the longest matching prefix is used
(where '*' matches everything and counts as a match of length 1).
- If the prefix doesn't include a scheme, the match is performed against
- the URI with its scheme stripped as well, and the schemes argument,
- q.v., is then subsequently consulted.
+ If the prefix doesn't include a scheme, the match is performed
+ against the URI with its scheme stripped as well, and the schemes
+ argument, q.v., is then subsequently consulted.
username;;
Username to authenticate with.
password;;
- Optional. Password to authenticate with. If not given the user will be
- prompted for it.
+ Optional. Password to authenticate with. If not given the user
+ will be prompted for it.
schemes;;
- Optional. Space separated list of URI schemes to use this authentication
- entry with. Only used if the prefix doesn't include a scheme. Supported
- schemes are http and https. They will match static-http and static-https
- respectively, as well.
+ Optional. Space separated list of URI schemes to use this
+ authentication entry with. Only used if the prefix doesn't include
+ a scheme. Supported schemes are http and https. They will match
+ static-http and static-https respectively, as well.
Default: https.
- If no suitable authentication entry is found, the user is
- prompted for credentials as usual if required by the remote.
+ If no suitable authentication entry is found, the user is prompted
+ for credentials as usual if required by the remote.
[[decode]]
decode/encode::
@@ -170,14 +167,13 @@
localization/canonicalization of files.
Filters consist of a filter pattern followed by a filter command.
- 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".
+ 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".
The filter command can start with a specifier, either "pipe:" or
- "tempfile:". If no specifier is given, "pipe:" is used by
- default.
+ "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.
@@ -194,19 +190,18 @@
# can safely omit "pipe:", because it's the default)
*.gz = gzip
- 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.
+ 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 and may corrupt the contents of your files.
- The most common usage is for LF <-> CRLF translation on Windows.
- For this, use the "smart" convertors which check for binary
- files:
+ The most common usage is for LF <-> CRLF translation on Windows. For
+ this, use the "smart" convertors which check for binary files:
[extensions]
hgext.win32text =
@@ -229,16 +224,16 @@
Use the [defaults] section to define command defaults, i.e. the
default options/arguments to pass to the specified commands.
- The following example makes 'hg log' run in verbose mode, and
- 'hg status' show only the modified files, by default.
+ The following example makes 'hg log' run in verbose mode, and 'hg
+ status' show only the modified files, by default.
[defaults]
log = -v
status = -m
The actual commands, instead of their aliases, must be used when
- defining command defaults. The command defaults will also be
- applied to the aliases of the commands defined.
+ defining command defaults. The command defaults will also be applied
+ to the aliases of the commands defined.
[[diff]]
diff::
@@ -269,24 +264,22 @@
Optional. Comma-separated list of carbon copy recipients'
email addresses.
bcc;;
- Optional. Comma-separated list of blind carbon copy
- recipients' email addresses. Cannot be set interactively.
+ Optional. Comma-separated list of blind carbon copy recipients'
+ email addresses. Cannot be set interactively.
method;;
- Optional. Method to use to send email messages. If value is
- "smtp" (default), use SMTP (see section "[smtp]" for
- configuration). Otherwise, use as name of program to run that
- acts like sendmail (takes "-f" option for sender, list of
- recipients on command line, message on stdin). Normally, setting
- this to "sendmail" or "/usr/sbin/sendmail" is enough to use
- sendmail to send messages.
+ Optional. Method to use to send email messages. If value is "smtp"
+ (default), use SMTP (see section "[smtp]" for configuration).
+ Otherwise, use as name of program to run that acts like sendmail
+ (takes "-f" option for sender, list of recipients on command line,
+ message on stdin). Normally, setting this to "sendmail" or
+ "/usr/sbin/sendmail" is enough to use sendmail to send messages.
charsets;;
- Optional. Comma-separated list of charsets considered
- convenient for recipients. Addresses, headers, and parts not
- containing patches of outgoing messages will be encoded in
- the first charset to which conversion from local encoding
- ($HGENCODING, ui.fallbackencoding) succeeds. If correct
- conversion fails, the text in question is sent as is.
- Defaults to empty (explicit) list.
+ Optional. Comma-separated list of charsets considered convenient
+ for recipients. Addresses, headers, and parts not containing
+ patches of outgoing messages will be encoded in the first charset
+ to which conversion from local encoding ($HGENCODING,
+ ui.fallbackencoding) succeeds. If correct conversion fails, the
+ text in question is sent as is. Defaults to empty (explicit) list.
Order of outgoing email charsets:
@@ -310,13 +303,13 @@
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 "=".
+ 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.
+ 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.
To explicitly disable an extension that is enabled in an hgrc of
broader scope, prepend its path with '!', as in
@@ -345,16 +338,17 @@
usefncache;;
Enable or disable the "fncache" repository format which enhances
the "store" repository format (which has to be enabled to use
- fncache) to allow longer filenames and avoids using Windows reserved
- names, e.g. "nul". Enabled by default. Disabling this option ensures
- that the on-disk format of newly created repositories will be
- compatible with Mercurial before version 1.1.
+ fncache) to allow longer filenames and avoids using Windows
+ reserved names, e.g. "nul". Enabled by default. Disabling this
+ option ensures that the on-disk format of newly created
+ repositories will be compatible with Mercurial before version 1.1.
[[merge-patterns]]
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.
+ merge tool. Patterns are globs by default, rooted at the repository
+ root.
Example:
@@ -391,9 +385,9 @@
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.
+ 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
@@ -419,15 +413,17 @@
gui;;
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
- then under HKEY_LOCAL_MACHINE. Default: None
+ Windows registry key which describes install location of this
+ tool. Mercurial will search for this key first under
+ HKEY_CURRENT_USER and then under HKEY_LOCAL_MACHINE.
+ Default: None
regname;;
Name of value to read from specified registry key. Defaults to the
unnamed (default) value.
regappend;;
- String to append to the value read from the registry, typically the
- executable name of the tool. Default: None
+ String to append to the value read from the registry, typically
+ the executable name of the tool.
+ Default: None
[[hooks]]
hooks::
@@ -450,13 +446,13 @@
variables it is passed are listed with names of the form "$HG_foo".
changegroup;;
- Run after a changegroup has been added via push, pull or
- unbundle. ID of the first new changeset is in $HG_NODE. URL from
- which changes came is in $HG_URL.
+ Run after a changegroup has been added via push, pull or unbundle.
+ ID of the first new changeset is in $HG_NODE. URL from which
+ changes came is in $HG_URL.
commit;;
- Run after a changeset has been created in the local repository.
- ID of the newly created changeset is in $HG_NODE. Parent
- changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
+ Run after a changeset has been created in the local repository. ID
+ of the newly created changeset is in $HG_NODE. Parent changeset
+ IDs are in $HG_PARENT1 and $HG_PARENT2.
incoming;;
Run after a changeset has been pulled, pushed, or unbundled into
the local repository. The ID of the newly arrived changeset is in
@@ -472,39 +468,40 @@
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.
+ the command doesn't execute and Mercurial returns the failure
+ code.
prechangegroup;;
- Run before a changegroup is added via push, pull or unbundle.
- Exit status 0 allows the changegroup to proceed. Non-zero status
- will cause the push, pull or unbundle to fail. URL from which
- changes will come is in $HG_URL.
+ Run before a changegroup is added via push, pull or unbundle. Exit
+ status 0 allows the changegroup to proceed. Non-zero status will
+ cause the push, pull or unbundle to fail. URL from which changes
+ will come is in $HG_URL.
precommit;;
Run before starting a local commit. Exit status 0 allows the
commit to proceed. Non-zero status will cause the commit to fail.
Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
preoutgoing;;
Run before collecting changes to send from the local repository to
- another. Non-zero status will cause failure. This lets you
- prevent pull over http or ssh. Also prevents against local pull,
- push (outbound) or bundle commands, but not effective, since you
- 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",
- operation is happening on behalf of repository on same system.
+ another. Non-zero status will cause failure. This lets you prevent
+ pull over http or ssh. Also prevents against local pull, push
+ (outbound) or bundle commands, but not effective, since you 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", operation
+ is happening on behalf of repository on same system.
pretag;;
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
- is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0.
+ changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag is
+ local if $HG_LOCAL=1, in repo if $HG_LOCAL=0.
pretxnchangegroup;;
Run after a changegroup has been added via push, pull or unbundle,
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.
- Non-zero status will cause the transaction to be rolled back and
- the push, pull or unbundle will fail. URL that was source of
- changes is in $HG_URL.
+ before accepting them. Passed the ID of the first new changeset in
+ $HG_NODE. Exit status 0 allows the transaction to commit. Non-zero
+ status will cause the transaction to be rolled back and the push,
+ pull or unbundle will fail. URL that was source of changes is in
+ $HG_URL.
pretxncommit;;
Run after a changeset has been created but the transaction not yet
committed. Changeset is visible to hook program. This lets you
@@ -518,43 +515,40 @@
Changeset ID of first new parent is in $HG_PARENT1. If merge, ID
of second new parent is in $HG_PARENT2.
tag;;
- 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
- $HG_LOCAL=1, in repo if $HG_LOCAL=0.
+ 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 $HG_LOCAL=1, in repo if
+ $HG_LOCAL=0.
update;;
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 the update succeeded, $HG_ERROR=0. If the
+ new parent is in $HG_PARENT1. If merge, ID of second new parent is
+ in $HG_PARENT2. If the update succeeded, $HG_ERROR=0. If the
update failed (e.g. because conflicts not resolved), $HG_ERROR=1.
- 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 (e.g. tag) and
- not just the commit command.
+ 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 (e.g. tag) and not just the commit command.
- Note2: Environment variables with empty values may not be
- passed to hooks on platforms such as Windows. As an
- example, $HG_PARENT2 will have an empty value under
- Unix-like platforms for non-merge changesets, while it
- will not be available at all under Windows.
+ Note2: Environment variables with empty values may not be passed to
+ hooks on platforms such as Windows. As an example, $HG_PARENT2 will
+ have an empty value under Unix-like platforms for non-merge
+ changesets, while it will not be available at all under Windows.
The syntax for Python hooks is as follows:
hookname = python:modulename.submodule.callable
hookname = python:/path/to/python/module.py:callable
- Python hooks are run within the Mercurial process. Each hook
- is called with at least three keyword arguments: a ui object
- (keyword "ui"), a repository object (keyword "repo"), and a
- "hooktype" keyword that tells what kind of hook is used.
- Arguments listed as environment variables above are passed as
- keyword arguments, with no "HG_" prefix, and names in lower
- case.
+ Python hooks are run within the Mercurial process. Each hook is
+ called with at least three keyword arguments: a ui object (keyword
+ "ui"), a repository object (keyword "repo"), and a "hooktype"
+ keyword that tells what kind of hook is used. Arguments listed as
+ environment variables above are passed as keyword arguments, with no
+ "HG_" prefix, and names in lower case.
- If a Python hook returns a "true" value or raises an
- exception, this is treated as a failure.
+ If a Python hook returns a "true" value or raises an exception, this
+ is treated as a failure.
[[http_proxy]]
http_proxy::
@@ -582,53 +576,53 @@
Optional. Whether to connect to mail server using TLS. True or
False. Default: False.
username;;
- Optional. User name to authenticate to SMTP server with.
- If username is specified, password must also be specified.
+ Optional. User name to authenticate to SMTP server with. If
+ username is specified, password must also be specified.
Default: none.
password;;
- Optional. Password to authenticate to SMTP server with.
- If username is specified, password must also be specified.
+ Optional. Password to authenticate to SMTP server with. If
+ username is specified, password must also be specified.
Default: none.
local_hostname;;
- Optional. It's the hostname that the sender can use to identify itself
- to the MTA.
+ Optional. It's the hostname that the sender can use to identify
+ itself to the MTA.
[[paths]]
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. Default paths can be declared by
- setting the following entries.
+ location of the repository. Default paths can be declared by setting
+ the following entries.
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 is set to repository from which the current repository was
+ cloned.
default-push;;
Optional. Directory or URL to use when pushing if no destination
is specified.
[[profiling]]
profiling::
- Specifies profiling format and file output.
- In this section description, 'profiling data' stands for the raw data
- collected during profiling, while 'profiling report' stands for a
- statistical text report generated from the profiling data.
- The profiling is done using lsprof.
+ Specifies profiling format and file output. In this section
+ description, 'profiling data' stands for the raw data collected
+ during profiling, while 'profiling report' stands for a statistical
+ text report generated from the profiling data. The profiling is done
+ using lsprof.
format;;
Profiling format.
Default: text.
text;;
- Generate a profiling report.
- When saving to a file, it should be noted that only the report is saved,
- and the profiling data is not kept.
+ Generate a profiling report. When saving to a file, it should be
+ noted that only the report is saved, and the profiling data is
+ not kept.
kcachegrind;;
- Format profiling data for kcachegrind use:
- when saving to a file, the generated file can directly be loaded
- into kcachegrind.
+ Format profiling data for kcachegrind use: when saving to a
+ file, the generated file can directly be loaded into
+ kcachegrind.
output;;
- File path where profiling data or report should be saved.
- If the file exists, it is replaced.
- Default: None, data is printed on stderr
+ File path where profiling data or report should be saved. If the
+ file exists, it is replaced. Default: None, data is printed on
+ stderr
[[server]]
server::
@@ -645,15 +639,15 @@
[[trusted]]
trusted::
- For security reasons, Mercurial will not use the settings in
- the .hg/hgrc file from a repository if it doesn't belong to a
- trusted user or to a trusted group. The main exception is the
- web interface, which automatically uses some safe settings, since
- it's common to serve repositories from different users.
+ For security reasons, Mercurial will not use the settings in the
+ .hg/hgrc file from a repository if it doesn't belong to a trusted
+ user or to a trusted group. The main exception is the web interface,
+ which automatically uses some safe settings, since it's common to
+ serve repositories from different users.
This section specifies what users and groups are trusted. The
- current user is always trusted. To trust everybody, list a user
- or a group with name "*".
+ current user is always trusted. To trust everybody, list a user or a
+ group with name "*".
users;;
Comma-separated list of trusted users.
@@ -665,13 +659,13 @@
User interface controls.
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.
+ (hashes for the repository base and for tip) in archives created
+ by the hg archive command or downloaded via hgweb.
Default is true.
askusername;;
Whether to prompt for a username when committing. If True, and
neither $HGUSER nor $EMAIL has been specified, then the user will
- be prompted to enter a username. If no username is entered, the
+ be prompted to enter a username. If no username is entered, the
default USER@HOST is used instead.
Default is False.
debug;;
@@ -682,10 +676,10 @@
Encoding to try if it's not possible to decode the changelog using
UTF-8. Default is ISO-8859-1.
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
+ 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
"ignore.other = ~/.hgignore2". For details of the ignore file
format, see the hgignore(5) man page.
interactive;;
@@ -709,8 +703,8 @@
merge-tools section.
patch;;
- command to use to apply patches. Look for 'gpatch' or 'patch' in PATH if
- unset.
+ command to use to apply patches. Look for 'gpatch' or 'patch' in
+ PATH if unset.
quiet;;
Reduce the amount of output printed. True or False. Default is False.
remotecmd;;
@@ -720,8 +714,9 @@
trusted user or group. True or False. Default is True.
slash;;
Display paths using a slash ("/") as the path separator. This only
- makes a difference on systems where the default path separator is not
- the slash character (e.g. Windows uses the backslash character ("\")).
+ 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.
ssh;;
command to use for SSH connections. Default is 'ssh'.
@@ -736,10 +731,10 @@
username;;
The committer of a changeset created when running "commit".
Typically a person's name and email address, e.g. "Fred Widget
- <fred@example.com>". Default is $EMAIL or username@hostname.
- 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).
+ <fred@example.com>". Default is $EMAIL or username@hostname. 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).
verbose;;
Increase the amount of output printed. True or False. Default is False.
@@ -764,51 +759,55 @@
Whether to allow pulling from the repository. Default is true.
allow_push;;
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
- 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.
+ push is not allowed. If the special value "*", any remote user can
+ push, including unauthenticated users. Otherwise, the remote 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.
allow_read;;
- If the user has not already been denied repository access due to the
- contents of deny_read, this list determines whether to grant repository
- access to the user. If this list is not empty, and the user is
- unauthenticated or not present in the list (separated by whitespace or ","),
- then access is denied for the user. If the list is empty or not set, then
- access is permitted to all users by default. Setting allow_read to the
- special value "*" is equivalent to it not being set (i.e. access is
- permitted to all users). The contents of the allow_read list are examined
- after the deny_read list.
+ If the user has not already been denied repository access due to
+ the contents of deny_read, this list determines whether to grant
+ repository access to the user. If this list is not empty, and the
+ user is unauthenticated or not present in the list (separated by
+ whitespace or ","), then access is denied for the user. If the
+ list is empty or not set, then access is permitted to all users by
+ default. Setting allow_read to the special value "*" is equivalent
+ to it not being set (i.e. access is permitted to all users). The
+ contents of the allow_read list are examined after the deny_read
+ list.
allowzip;;
(DEPRECATED) Whether to allow .zip downloading of repo revisions.
Default is false. This feature creates temporary files.
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/"
+ third-party tools like email notification hooks can construct
+ URLs. Example: "http://hgserver/repos/"
contact;;
Name or email address of the person in charge of the repository.
Defaults to ui.username or $EMAIL or "unknown" if unset or empty.
deny_push;;
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,
- and any authenticated user name present in this list (separated by
+ push is not denied. If the special value "*", all remote users are
+ denied push. Otherwise, unauthenticated users are all denied, and
+ any authenticated user name present in this list (separated by
whitespace or ",") is also denied. The contents of the deny_push
list are examined before the allow_push list.
deny_read;;
- Whether to deny reading/viewing of the repository. If this list is not
- empty, unauthenticated users are all denied, and any authenticated user name
- present in this list (separated by whitespace or ",") is also denied access
- to the repository. If set to the special value "*", all remote users are
- denied access (rarely needed ;). If deny_read is empty or not set, the
- determination of repository access depends on the presence and content of
- the allow_read list (see description). If both deny_read and allow_read are
- empty or not set, then access is permitted to all users by default. If the
- repository is being served via hgwebdir, denied users will not be able to
- see it in the list of repositories. The contents of the deny_read list have
- priority over (are examined before) the contents of the allow_read list.
+ Whether to deny reading/viewing of the repository. If this list is
+ not empty, unauthenticated users are all denied, and any
+ authenticated user name present in this list (separated by
+ whitespace or ",") is also denied access to the repository. If set
+ to the special value "*", all remote users are denied access
+ (rarely needed ;). If deny_read is empty or not set, the
+ determination of repository access depends on the presence and
+ content of the allow_read list (see description). If both
+ deny_read and allow_read are empty or not set, then access is
+ permitted to all users by default. If the repository is being
+ served via hgwebdir, denied users will not be able to see it in
+ the list of repositories. The contents of the deny_read list have
+ priority over (are examined before) the contents of the allow_read
+ list.
description;;
Textual description of the repository's purpose or contents.
Default is "unknown".
@@ -818,7 +817,8 @@
errorlog;;
Where to output the error log. Default is stderr.
hidden;;
- Whether to hide the repository in the hgwebdir index. Default is false.
+ Whether to hide the repository in the hgwebdir index.
+ Default is false.
ipv6;;
Whether to use IPv6. Default is false.
name;;
@@ -836,9 +836,9 @@
Whether to require that inbound pushes be transported over SSL to
prevent password sniffing. Default is true.
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.
+ 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/"
stripes;;
How many lines a "zebra stripe" should span in multiline output.