Mercurial > hg-stable
changeset 8766:b2059435f176
man pages: mark filenames and env vars as fixed text
| author | Martin Geisler <mg@lazybytes.net> |
|---|---|
| date | Tue, 09 Jun 2009 23:08:55 +0200 |
| parents | 9c75f16f577c |
| children | b03859265cc4 |
| files | doc/hg.1.txt doc/hgignore.5.txt doc/hgrc.5.txt |
| diffstat | 3 files changed, 71 insertions(+), 71 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/hg.1.txt Tue Jun 09 21:50:42 2009 +0200 +++ b/doc/hg.1.txt Tue Jun 09 23:08:55 2009 +0200 @@ -38,24 +38,24 @@ FILES ----- - .hgignore:: + `.hgignore`:: This file contains regular expressions (one per line) that describe file names that should be ignored by hg. For details, see hgignore(5). - .hgtags:: + `.hgtags`:: This file contains changeset hash values and text tag names (one of each separated by spaces) that correspond to tagged versions of the repository contents. - /etc/mercurial/hgrc, $HOME/.hgrc, .hg/hgrc:: - This file contains defaults and configuration. Values in .hg/hgrc - override those in $HOME/.hgrc, and these override settings made in - the global /etc/mercurial/hgrc configuration. See hgrc(5) for + `/etc/mercurial/hgrc`, `$HOME/.hgrc`, `.hg/hgrc`:: + This file contains defaults and configuration. Values in `.hg/hgrc` + override those in `$HOME/.hgrc`, and these override settings made in + the global `/etc/mercurial/hgrc` configuration. See hgrc(5) for details of the contents and format of these files. -Some commands (e.g. revert) produce backup files ending in .orig, if -the .orig file already exists and is not tracked by Mercurial, it will +Some commands (e.g. revert) produce backup files ending in `.orig`, if +the `.orig` file already exists and is not tracked by Mercurial, it will be overwritten. BUGS
--- a/doc/hgignore.5.txt Tue Jun 09 21:50:42 2009 +0200 +++ b/doc/hgignore.5.txt Tue Jun 09 23:08:55 2009 +0200 @@ -9,7 +9,7 @@ SYNOPSIS -------- -The Mercurial system uses a file called .hgignore in the root +The Mercurial system uses a file called `.hgignore` in the root directory of a repository to control its behavior when it finds files that it is not currently managing.
--- a/doc/hgrc.5.txt Tue Jun 09 21:50:42 2009 +0200 +++ b/doc/hgrc.5.txt Tue Jun 09 23:08:55 2009 +0200 @@ -17,50 +17,50 @@ 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 +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:: +(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 apply + 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:: +(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. -(Windows) <install-dir>\Mercurial.ini:: +(Windows) `<install-dir>\Mercurial.ini`:: or else:: -(Windows) HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial:: +(Windows) `HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`:: or else:: -(Windows) C:\Mercurial\Mercurial.ini:: +(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 + 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:: +(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%. + 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:: +(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 @@ -277,8 +277,8 @@ 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 + 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: @@ -316,7 +316,7 @@ 'hgext.foo = !/ext/path' or 'hgext.foo = !' when path is not supplied. - Example for ~/.hgrc: + Example for `~/.hgrc`: [extensions] # (the mq extension will get loaded from mercurial's path) @@ -361,7 +361,7 @@ This section configures external merge tools to use for file-level merges. - Example ~/.hgrc: + Example `~/.hgrc`: [merge-tools] # Override stock tool location @@ -387,8 +387,8 @@ 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 + variables: `$base`, `$local`, `$other`, `$output`. + Default: `$local $base $other` premerge;; Attempt to run internal non-interactive 3-way merge tool before launching external tool. @@ -415,7 +415,7 @@ 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. + `HKEY_CURRENT_USER` and then under `HKEY_LOCAL_MACHINE`. Default: None regname;; Name of value to read from specified registry key. Defaults to the @@ -433,7 +433,7 @@ action. Overriding a site-wide hook can be done by changing its value or setting it to an empty string. - Example .hg/hgrc: + Example `.hg/hgrc`: [hooks] # do not use the site-wide hook @@ -447,82 +447,82 @@ 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. + 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. + 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 - $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 - first changeset sent is in $HG_NODE. Source of operation is in - $HG_SOURCE; see "preoutgoing" hook for description. + 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. + 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, + 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 will cause the push, pull or unbundle to fail. URL from which changes - will come is in $HG_URL. + 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. + 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 + `$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 + `$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. + `$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 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 - IDs are in $HG_PARENT1 and $HG_PARENT2. + 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 the update to proceed. Non-zero status will prevent the update. - Changeset ID of first new parent is in $HG_PARENT1. If merge, ID - of second new parent is in $HG_PARENT2. + 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 - update failed (e.g. because conflicts not resolved), $HG_ERROR=1. + 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 @@ -531,7 +531,7 @@ 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 + 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. @@ -640,7 +640,7 @@ [[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 + `.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. @@ -664,14 +664,14 @@ 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 + neither `$HGUSER` nor `$EMAIL` has been specified, then the user will be prompted to enter a username. If no username is entered, the default USER@HOST is used instead. Default is False. debug;; 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. @@ -710,7 +710,7 @@ 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 + 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. slash;; Display paths using a slash ("/") as the path separator. This only @@ -731,9 +731,9 @@ 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 + <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 + 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. @@ -785,7 +785,7 @@ 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. + 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