Mercurial: doc/hgrc.5.txt comparison

comparison doc/hgrc.5.txt @ 6446:ee5313bc3c0c

asciidoc: consistently use 1 space after full stop Note: the command doc strings included in hg (1) are still inconsistent wrt to spaces after full stops.

author	Christian Ebert <blacktrash@gmx.net>
date	Tue, 01 Apr 2008 14:35:35 +0200
parents	a1db3d8b9b8a
children	944a292d522a

comparison

equal deleted inserted replaced

-:a1db3d8b9b8a
+:ee5313bc3c0c
 FILES
 -----
 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
+installed. *.rc files from a single directory are read in
-alphabetical order, later ones overriding earlier ones.  Where
+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
+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
+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
+is running. Options in these files apply to all Mercurial
-commands executed by any user in any directory.  Options in these
+commands executed by any user in any directory. Options in these
 files override per-installation options.
 (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
-which Mercurial is running.  Options in these files apply to all
+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.
 (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
+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
+particular repository. This file is not version-controlled, and
-will not get transferred during a "clone" operation.  Options in
+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
+to a trusted user or to a trusted group. See the documentation
 for the trusted section below for more details.
 SYNTAX
 ------
 [spam]
 eggs=ham
 green=
 eggs
-Each line contains one entry.  If the lines that follow are indented,
+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.
+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
 typically be used for newline processing or other
 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
+root. For example, to match any file ending in ".txt" in the root
-directory only, use the pattern "*.txt".  To match any file ending
+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.
 Pipe example:
 [decode]
 # recompress gzip files when writing them to the working dir (we
 # can safely omit "pipe:", because it's the default)
 *.gz = gzip
-A "tempfile:" command is a template.  The string INFILE is replaced
+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
+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
 Ignore changes whose lines are all blank.
 email::
 Settings for extensions that send email messages.
 from;;
-Optional.  Email address to use in "From" header and SMTP envelope
+Optional. Email address to use in "From" header and SMTP envelope
 of outgoing messages.
 to;;
-Optional.  Comma-separated list of recipients' email addresses.
+Optional. Comma-separated list of recipients' email addresses.
 cc;;
-Optional.  Comma-separated list of carbon copy recipients'
+Optional. Comma-separated list of carbon copy recipients'
 email addresses.
 bcc;;
-Optional.  Comma-separated list of blind carbon copy
+Optional. Comma-separated list of blind carbon copy
-recipients' email addresses.  Cannot be set interactively.
+recipients' email addresses. Cannot be set interactively.
 method;;
-Optional.  Method to use to send email messages.  If value is
+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
+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
+recipients on command line, message on stdin). Normally, setting
 this to "sendmail" or "/usr/sbin/sendmail" is enough to use
 sendmail to send messages.
 Email example:
 premerge;;
 Attempt to run internal non-interactive 3-way merge tool before
 launching external tool.
 Default: True
 binary;;
-This tool can merge binary files.  Defaults to False, unless tool
+This tool can merge binary files. Defaults to False, unless tool
 was selected by file pattern match.
 symlink;;
-This tool can merge symlinks.  Defaults to False, even if tool was
+This tool can merge symlinks. Defaults to False, even if tool was
 selected by file pattern match.
 checkconflicts;;
 Check whether there are conflicts even though the tool reported
 success.
 Default: False
 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
+then under HKEY_LOCAL_MACHINE. Default: None
 regname;;
-Name of value to read from specified registry key.  Defaults to the
+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
+executable name of the tool. Default: None
 hooks::
 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
 incoming =
 incoming.email = /my/email/hook
 incoming.autobuild = /my/build/hook
 Most hooks are run with environment variables set that give added
-useful information.  For each hook below, the environment variables
+useful information. For each hook below, the environment 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
+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
+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
+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.
+$HG_NODE. URL that was source of changes came is in $HG_URL.
 outgoing;;
-Run after sending changes from local repository to another.  ID of
+Run after sending changes from local repository to another. ID of
-first changeset sent is in $HG_NODE.  Source of operation is in
+first changeset sent is in $HG_NODE. Source of operation is in
 $HG_SOURCE; see "preoutgoing" hook for description.
 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.
 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.
 prechangegroup;;
 Run before a changegroup is added via push, pull or unbundle.
-Exit status 0 allows the changegroup to proceed.  Non-zero status
+Exit status 0 allows the changegroup to proceed. Non-zero status
-will cause the push, pull or unbundle to fail.  URL from which
+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
+Run before starting a local commit. Exit status 0 allows the
-commit to proceed.  Non-zero status will cause the commit to fail.
+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
+another. Non-zero status will cause failure. This lets you
-prevent pull over http or ssh.  Also prevents against local pull,
+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
+can just copy files instead then. Source of operation is in
-$HG_SOURCE.  If "serve", operation is happening on behalf of
+$HG_SOURCE. If "serve", operation is happening on behalf of
-remote ssh or http repository.  If "push", "pull" or "bundle",
+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
+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
+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
+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
+but before the transaction has been committed. Changegroup is
-visible to hook program.  This lets you validate incoming changes
+visible to hook program. This lets you validate incoming changes
-before accepting them.  Passed the ID of the first new changeset
+before accepting them. Passed the ID of the first new changeset
-in $HG_NODE.  Exit status 0 allows the transaction to commit.
+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
+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
+committed. Changeset is visible to hook program. This lets you
-validate commit message and changes.  Exit status 0 allows the
+validate commit message and changes. Exit status 0 allows the
-commit to proceed.  Non-zero status will cause the transaction to
+commit to proceed. Non-zero status will cause the transaction to
-be rolled back.  ID of changeset is in $HG_NODE.  Parent changeset
+be rolled back. ID of changeset is in $HG_NODE. Parent changeset
 IDs are in $HG_PARENT1 and $HG_PARENT2.
 preupdate;;
-Run before updating the working directory.  Exit status 0 allows
+Run before updating the working directory. Exit status 0 allows
-the update to proceed.  Non-zero status will prevent the update.
+the update to proceed. Non-zero status will prevent the update.
-Changeset ID of first new parent is in $HG_PARENT1.  If merge, ID
+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
+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_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
+Run after updating the working directory. Changeset ID of first
-new parent is in $HG_PARENT1.  If merge, ID of second new parent
+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
+is in $HG_PARENT2. If update succeeded, $HG_ERROR=0. If 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.
 The syntax for Python hooks is as follows:
 hookname = python:modulename.submodule.callable
-Python hooks are run within the Mercurial process.  Each hook is
+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
+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 failure of the hook.
 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
+Optional. Comma-separated list of host names that should bypass
 the proxy.
 passwd;;
-Optional.  Password to authenticate with at the proxy server.
+Optional. Password to authenticate with at the proxy server.
 user;;
-Optional.  User name to authenticate with at the proxy server.
+Optional. User name to authenticate with at the proxy server.
 smtp::
 Configuration for extensions that need to send email messages.
 host;;
 Host name of mail server, e.g. "mail.example.com".
 port;;
-Optional.  Port to connect to on mail server.  Default: 25.
+Optional. Port to connect to on mail server. Default: 25.
 tls;;
-Optional.  Whether to connect to mail server using TLS.  True or
+Optional. Whether to connect to mail server using TLS. True or
-False.  Default: False.
+False. Default: False.
 username;;
-Optional.  User name to authenticate to SMTP server with.
+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.
+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
+Optional. It's the hostname that the sender can use to identify itself
 to the MTA.
 paths::
-Assigns symbolic names to repositories.  The left side is the
+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
+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-push;;
-Optional.  Directory or URL to use when pushing if no destination
+Optional. Directory or URL to use when pushing if no destination
 is specified.
 server::
 Controls generic server settings.
 uncompressed;;
 Whether to allow clients to clone a repo using the uncompressed
-streaming protocol.  This transfers about 40% more data than a
+streaming protocol. This transfers about 40% more data than a
 regular clone, but uses less memory and CPU on both server and
-client.  Over a LAN (100Mbps or better) or a very fast WAN, an
+client. Over a LAN (100Mbps or better) or a very fast WAN, an
 uncompressed streaming clone is a lot faster (~10x) than a regular
-clone.  Over most WAN connections (anything slower than about
+clone. Over most WAN connections (anything slower than about
 6Mbps), uncompressed streaming is slower, because of the extra
-data transfer overhead.  Default is False.
+data transfer overhead. Default is False.
 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
+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
+This section specifies what users and groups are trusted. The
-current user is always trusted.  To trust everybody, list a user
+current user is always trusted. To trust everybody, list a user
 or a group with name "*".
 users;;
 Comma-separated list of trusted users.
 groups;;
 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.
 debug;;
-Print debugging information.  True or False.  Default is False.
+Print debugging information. True or False. Default is False.
 editor;;
-The editor to use during a commit.  Default is $EDITOR or "vi".
+The editor to use during a commit. Default is $EDITOR or "vi".
 fallbackencoding;;
 Encoding to try if it's not possible to decode the changelog using
-UTF-8.  Default is ISO-8859-1.
+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
 "ignore.other = ~/.hgignore2". For details of the ignore file
 format, see the hgignore(5) man page.
 interactive;;
-Allow to prompt the user.  True or False.  Default is True.
+Allow to prompt the user. True or False. Default is True.
 logtemplate;;
 Template string for commands that print changesets.
 merge;;
 The conflict resolution program to use during a manual merge.
 There are some internal tools available:
 patch;;
 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.
+Reduce the amount of output printed. True or False. Default is False.
 remotecmd;;
 remote command to use for clone/push/pull operations. Default is 'hg'.
 report_untrusted;;
 Warn if a .hg/hgrc file is ignored due to not being owned by a
-trusted user or group.  True or False.  Default is True.
+trusted user or group. True or False. Default is True.
 slash;;
-Display paths using a slash ("/") as the path separator.  This only
+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 ("\")).
 Default is False.
 ssh;;
 command to use for SSH connections. Default is 'ssh'.
 strict;;
 Require exact command names, instead of allowing unambiguous
-abbreviations.  True or False.  Default is False.
+abbreviations. True or False. Default is False.
 style;;
 Name of style to use for command output.
 timeout;;
 The timeout used when a lock is held (in seconds), a negative value
 means no timeout. Default is 600.
 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.
+<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.
+Increase the amount of output printed. True or False. Default is False.
 web::
 Web interface configuration.
 accesslog;;
 (DEPRECATED) Whether to allow .tar.gz downloading of repo revisions.
 Default is false.
 allowpull;;
 Whether to allow pulling from the repository. Default is true.
 allow_push;;
-Whether to allow pushing to the repository.  If empty or not set,
+Whether to allow pushing to the repository. If empty or not set,
-push is not allowed.  If the special value "*", any remote user
+push is not allowed. If the special value "*", any remote user
-can push, including unauthenticated users.  Otherwise, the remote
+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.
 allowzip;;
 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,
+Whether to deny pushing to the repository. If empty or not set,
-push is not denied.  If the special value "*", all remote users
+push is not denied. If the special value "*", all remote users
-are denied push.  Otherwise, unauthenticated users are all denied,
+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
+whitespace or ",") is also denied. The contents of the deny_push
 list are examined before the allow_push list.
 description;;
 Textual description of the repository's purpose or contents.
 Default is "unknown".
 encoding;;
 Port to listen on. Default is 8000.
 prefix;;
 Prefix path to serve from. Default is '' (server root).
 push_ssl;;
 Whether to require that inbound pushes be transported over SSL to
-prevent password sniffing.  Default is true.
+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.
 Example: "http://hgserver/static/"

Mercurial > hg

comparison doc/hgrc.5.txt @ 6446:ee5313bc3c0c