2302N/ARewrite some sections of the documentation to match what we deliver on
2302N/ASolaris, or remove sections that are of no relevance to Solaris.
2302N/A hgk consists of two parts: a Tcl script that does the displaying and
2302N/A querying of information, and an extension to Mercurial named
hgk.py,
2302N/A-which provides hooks for hgk to get information. hgk can be found in
2302N/A-the contrib directory, and the extension is shipped in the hgext
2302N/A-repository, and needs to be enabled.
2302N/A+which provides hooks for hgk to get information.
2302N/A-The :hg:`view` command will launch the hgk Tcl script. For this command
2302N/A-to work, hgk must be in your search path. Alternately, you can specify
2302N/A-the path to hgk in your configuration file::
2302N/A+The :hg:`view` command will launch the hgk Tcl script. The script is
2302N/A+it. You can specify the path to an alternate hgk in your configuration
2302N/A repositories. The file format is the same as for ``.hgtags``, but it is
2302N/A encoded using the local system encoding.
2302N/A+ This directory contains assorted files which are part of the Mercurial
2302N/A+ distribution, but not core to its functionality. They will generally
2302N/A+ need to be copied elsewhere to be of use.
2302N/A Some commands (
e.g. revert) produce backup files ending in ``.orig``,
2302N/A if the ``.orig`` file already exists and is not tracked by Mercurial,
2302N/A Mercurial reads configuration data from several files, if they exist.
2302N/A These files do not exist by default and you will have to create the
2302N/A appropriate configuration files yourself: global configuration like
2302N/A-the username setting is typically put into
2302N/A+the username setting is typically put into ``$HOME/.hgrc`` and local
2302N/A configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
2302N/A The names of these files depend on the system on which Mercurial is
3596N/A- On Unix, the following files are consulted:
3596N/A+ The following files are consulted:
3596N/A - ``<repo>/.hg/hgrc`` (per-repository)
3596N/A - ``$HOME/.hgrc`` (per-user)
3596N/A- On Windows, the following files are consulted:
3596N/A- - ``<repo>/.hg/hgrc`` (per-repository)
3596N/A- - ``%USERPROFILE%\.hgrc`` (per-user)
3596N/A- - ``%HOME%\.hgrc`` (per-user)
3596N/A- - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
3596N/A- The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
3596N/A- is used when running 32-bit Python on 64-bit Windows.
3596N/A- On Plan9, the following files are consulted:
3596N/A- - ``<repo>/.hg/hgrc`` (per-repository)
4261N/A Per-repository configuration options only apply in a
4261N/A particular repository. This file is not version-controlled, and
4261N/A will not get transferred during a "clone" operation. Options in
3596N/A-this file override options in all other configuration files. On
3596N/A-Plan 9 and Unix, most of this file will be ignored if it doesn't
4261N/A+this file override options in all other configuration files.
4261N/A+Most of this file will be ignored if it doesn't
4261N/A belong to a trusted user or to a trusted group. See the documentation
4261N/A for the ``[trusted]`` section below for more details.
3596N/A-Per-user configuration file(s) are for the user running Mercurial. On
3596N/A-Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these
4261N/A+Per-user configuration file(s) are for the user running Mercurial.
4261N/A files apply to all Mercurial commands executed by this user in any
4261N/A directory. Options in these files override per-system and per-installation
4261N/A Per-installation configuration files are for the system on
4261N/A which Mercurial is running. Options in these files apply to all
4261N/A-Mercurial commands executed by any user in any directory. Registry
4261N/A-keys contain PATH-like strings, every part of which must reference
4261N/A-be read. Mercurial checks each of these locations in the specified
4261N/A+Mercurial commands executed by any user in any directory.
4261N/A+Mercurial checks each of these locations in the specified
4261N/A order until one or more configuration files are detected.
4261N/A Per-system configuration files are for the system on which Mercurial
2302N/A of an empty temporary file, where the filtered data must be written by
2951N/A- The tempfile mechanism is recommended for Windows systems,
2302N/A- where the standard shell I/O redirection operators often have
2302N/A- strange effects and may corrupt the contents of your files.
2302N/A This filter mechanism is used internally by the ``eol`` extension to
2302N/A translate line ending characters between Windows (CRLF) and Unix (LF)
2302N/A format. We suggest you use the ``eol`` extension for convenience.
2302N/A Also, hooks like "commit" will be called in all contexts that
2302N/A generate a commit (
e.g. tag) and not just the commit command.
2951N/A- Environment variables with empty values may not be passed to
2302N/A- hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
2302N/A- will have an empty value under Unix-like platforms for non-merge
2302N/A- changesets, while it will not be available at all under Windows.
2302N/A The syntax for Python hooks is as follows::
2302N/A- Either just the name of the executable or its pathname. On Windows,
2302N/A- the path can use environment variables with ${ProgramFiles} syntax.
2302N/A+ Either just the name of the executable or its pathname. Default: the tool name.
2302N/A The arguments to pass to the tool executable. You can refer to the
2302N/A This tool requires a graphical interface to run. Default: False
2302N/A- Windows registry key which describes install location of this
2302N/A- tool. Mercurial will search for this key first under
2302N/A- ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
2302N/A- An alternate Windows registry key to try if the first key is not
2302N/A- found. The alternate key uses the same ``regname`` and ``regappend``
2302N/A- semantics of the primary key. The most common use for this key
2302N/A- is to search for 32bit applications on 64bit operating systems.
2302N/A- Name of value to read from specified registry key. Defaults to the
2302N/A- String to append to the value read from the registry, typically
2302N/A- the executable name of the tool.