mercurial/help/config.txt
changeset 27761 bf8b0796af2e
parent 27760 df4894651532
child 27762 70e7bfebba46
equal deleted inserted replaced
27760:df4894651532 27761:bf8b0796af2e
    93 
    93 
    94   On Plan 9 and Unix, most of this file will be ignored if it doesn't
    94   On Plan 9 and Unix, most of this file will be ignored if it doesn't
    95   belong to a trusted user or to a trusted group. See
    95   belong to a trusted user or to a trusted group. See
    96   :hg:`help config.trusted` for more details.
    96   :hg:`help config.trusted` for more details.
    97 
    97 
    98 Per-user configuration file(s) are for the user running Mercurial. On
    98 Per-user configuration file(s) are for the user running Mercurial.
    99 Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these
    99 
   100 files apply to all Mercurial commands executed by this user in any
   100 .. container:: windows
   101 directory. Options in these files override per-system and per-installation
   101 
   102 options.
   102   On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in
       
   103   these files apply to all Mercurial commands executed by this user in
       
   104   any directory. Options in these files override per-system and
       
   105   per-installation options.
   103 
   106 
   104 Per-installation configuration files are searched for in the
   107 Per-installation configuration files are searched for in the
   105 directory where Mercurial is installed. ``<install-root>`` is the
   108 directory where Mercurial is installed. ``<install-root>`` is the
   106 parent directory of the **hg** executable (or symlink) being run.
   109 parent directory of the **hg** executable (or symlink) being run.
   107 
   110 
   521 with the name of a temporary file that contains the data to be
   524 with the name of a temporary file that contains the data to be
   522 filtered by the command. The string ``OUTFILE`` is replaced with the name
   525 filtered by the command. The string ``OUTFILE`` is replaced with the name
   523 of an empty temporary file, where the filtered data must be written by
   526 of an empty temporary file, where the filtered data must be written by
   524 the command.
   527 the command.
   525 
   528 
   526 .. note::
   529 .. container:: windows
   527 
   530 
   528    The tempfile mechanism is recommended for Windows systems,
   531    .. note::
   529    where the standard shell I/O redirection operators often have
   532 
   530    strange effects and may corrupt the contents of your files.
   533      The tempfile mechanism is recommended for Windows systems,
       
   534      where the standard shell I/O redirection operators often have
       
   535      strange effects and may corrupt the contents of your files.
   531 
   536 
   532 This filter mechanism is used internally by the ``eol`` extension to
   537 This filter mechanism is used internally by the ``eol`` extension to
   533 translate line ending characters between Windows (CRLF) and Unix (LF)
   538 translate line ending characters between Windows (CRLF) and Unix (LF)
   534 format. We suggest you use the ``eol`` extension for convenience.
   539 format. We suggest you use the ``eol`` extension for convenience.
   535 
   540 
  1059 ``priority``
  1064 ``priority``
  1060   The priority in which to evaluate this tool.
  1065   The priority in which to evaluate this tool.
  1061   (default: 0)
  1066   (default: 0)
  1062 
  1067 
  1063 ``executable``
  1068 ``executable``
  1064   Either just the name of the executable or its pathname.  On Windows,
  1069   Either just the name of the executable or its pathname.
  1065   the path can use environment variables with ${ProgramFiles} syntax.
  1070 
       
  1071   .. container:: windows
       
  1072 
       
  1073     On Windows, the path can use environment variables with ${ProgramFiles}
       
  1074     syntax.
       
  1075 
  1066   (default: the tool name)
  1076   (default: the tool name)
  1067 
  1077 
  1068 ``args``
  1078 ``args``
  1069   The arguments to pass to the tool executable. You can refer to the
  1079   The arguments to pass to the tool executable. You can refer to the
  1070   files being merged as well as the output file through these
  1080   files being merged as well as the output file through these
  1108   (default: False)
  1118   (default: False)
  1109 
  1119 
  1110 ``gui``
  1120 ``gui``
  1111   This tool requires a graphical interface to run. (default: False)
  1121   This tool requires a graphical interface to run. (default: False)
  1112 
  1122 
  1113 ``regkey``
  1123 .. container:: windows
  1114   Windows registry key which describes install location of this
  1124 
  1115   tool. Mercurial will search for this key first under
  1125   ``regkey``
  1116   ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
  1126     Windows registry key which describes install location of this
  1117   (default: None)
  1127     tool. Mercurial will search for this key first under
  1118 
  1128     ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
  1119 ``regkeyalt``
  1129     (default: None)
  1120   An alternate Windows registry key to try if the first key is not
  1130 
  1121   found.  The alternate key uses the same ``regname`` and ``regappend``
  1131   ``regkeyalt``
  1122   semantics of the primary key.  The most common use for this key
  1132     An alternate Windows registry key to try if the first key is not
  1123   is to search for 32bit applications on 64bit operating systems.
  1133     found.  The alternate key uses the same ``regname`` and ``regappend``
  1124   (default: None)
  1134     semantics of the primary key.  The most common use for this key
  1125 
  1135     is to search for 32bit applications on 64bit operating systems.
  1126 ``regname``
  1136     (default: None)
  1127   Name of value to read from specified registry key.
  1137 
  1128   (default: the unnamed (default) value)
  1138   ``regname``
  1129 
  1139     Name of value to read from specified registry key.
  1130 ``regappend``
  1140     (default: the unnamed (default) value)
  1131   String to append to the value read from the registry, typically
  1141 
  1132   the executable name of the tool.
  1142   ``regappend``
  1133   (default: None)
  1143     String to append to the value read from the registry, typically
       
  1144     the executable name of the tool.
       
  1145     (default: None)
  1134 
  1146 
  1135 
  1147 
  1136 ``patch``
  1148 ``patch``
  1137 ---------
  1149 ---------
  1138 
  1150 
  1654       Alias for ``warn``.
  1666       Alias for ``warn``.
  1655 
  1667 
  1656     ``false``
  1668     ``false``
  1657       Alias for ``ignore``.
  1669       Alias for ``ignore``.
  1658 
  1670 
  1659     .. container::
  1671     .. container:: windows
  1660 
  1672 
  1661       On Windows, this configuration option is ignored and the command aborted.
  1673       On Windows, this configuration option is ignored and the command aborted.
  1662 
  1674 
  1663 ``quiet``
  1675 ``quiet``
  1664     Reduce the amount of output printed.
  1676     Reduce the amount of output printed.