Loading...
Helix SwarmHelix Swarm
Loading...

hgrc.5.html

  • //
  • guest/
  • Doug_Napoleone/
  • mercurial/
  • doc/
  • hgrc.5.html #1
  • View
  • Commits
  • Open Download .zip Download (103 KB) 
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
  7. <title>hgrc</title>
  8. <meta name="author" content="Bryan O'Sullivan &lt;bos&#64;serpentine.com&gt;" />
  9. <meta name="organization" content="Mercurial" />
  10. <link rel="stylesheet" href="style.css" type="text/css" />
  11. </head>
  12. <body>
  13. <div class="document" id="hgrc">
  14. <span id="hgrc-5"></span>
  15. <h1 class="title">hgrc</h1>
  16. <h2 class="subtitle" id="configuration-files-for-mercurial">configuration files for Mercurial</h2>
  17. <table class="docinfo" frame="void" rules="none">
  18. <col class="docinfo-name" />
  19. <col class="docinfo-content" />
  20. <tbody valign="top">
  21. <tr><th class="docinfo-name">Author:</th>
  22. <td>Bryan O'Sullivan &lt;<a class="reference external" href="mailto:bos&#64;serpentine.com">bos&#64;serpentine.com</a>&gt;</td></tr>
  23. <tr><th class="docinfo-name">Organization:</th>
  24. <td>Mercurial</td></tr>
  25. <tr class="field"><th class="docinfo-name">Manual section:</th><td class="field-body">5</td>
  26. </tr>
  27. <tr class="field"><th class="docinfo-name">Manual group:</th><td class="field-body">Mercurial Manual</td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. <div class="contents htmlonly topic" id="contents">
  32. <p class="topic-title first">Contents</p>
  33. <ul class="simple">
  34. <li><a class="reference internal" href="#description" id="id2">Description</a></li>
  35. <li><a class="reference internal" href="#files" id="id3">Files</a></li>
  36. <li><a class="reference internal" href="#syntax" id="id4">Syntax</a></li>
  37. <li><a class="reference internal" href="#sections" id="id5">Sections</a><ul>
  38. <li><a class="reference internal" href="#alias" id="id6"><tt class="docutils literal">alias</tt></a></li>
  39. <li><a class="reference internal" href="#annotate" id="id7"><tt class="docutils literal">annotate</tt></a></li>
  40. <li><a class="reference internal" href="#auth" id="id8"><tt class="docutils literal">auth</tt></a></li>
  41. <li><a class="reference internal" href="#committemplate" id="id9"><tt class="docutils literal">committemplate</tt></a></li>
  42. <li><a class="reference internal" href="#decode-encode" id="id10"><tt class="docutils literal">decode/encode</tt></a></li>
  43. <li><a class="reference internal" href="#defaults" id="id11"><tt class="docutils literal">defaults</tt></a></li>
  44. <li><a class="reference internal" href="#diff" id="id12"><tt class="docutils literal">diff</tt></a></li>
  45. <li><a class="reference internal" href="#email" id="id13"><tt class="docutils literal">email</tt></a></li>
  46. <li><a class="reference internal" href="#extensions" id="id14"><tt class="docutils literal">extensions</tt></a></li>
  47. <li><a class="reference internal" href="#format" id="id15"><tt class="docutils literal">format</tt></a></li>
  48. <li><a class="reference internal" href="#graph" id="id16"><tt class="docutils literal">graph</tt></a></li>
  49. <li><a class="reference internal" href="#hooks" id="id17"><tt class="docutils literal">hooks</tt></a></li>
  50. <li><a class="reference internal" href="#hostfingerprints" id="id18"><tt class="docutils literal">hostfingerprints</tt></a></li>
  51. <li><a class="reference internal" href="#http-proxy" id="id19"><tt class="docutils literal">http_proxy</tt></a></li>
  52. <li><a class="reference internal" href="#merge-patterns" id="id20"><tt class="docutils literal"><span class="pre">merge-patterns</span></tt></a></li>
  53. <li><a class="reference internal" href="#merge-tools" id="id21"><tt class="docutils literal"><span class="pre">merge-tools</span></tt></a></li>
  54. <li><a class="reference internal" href="#patch" id="id22"><tt class="docutils literal">patch</tt></a></li>
  55. <li><a class="reference internal" href="#paths" id="id23"><tt class="docutils literal">paths</tt></a></li>
  56. <li><a class="reference internal" href="#phases" id="id24"><tt class="docutils literal">phases</tt></a></li>
  57. <li><a class="reference internal" href="#profiling" id="id25"><tt class="docutils literal">profiling</tt></a></li>
  58. <li><a class="reference internal" href="#progress" id="id26"><tt class="docutils literal">progress</tt></a></li>
  59. <li><a class="reference internal" href="#revsetalias" id="id27"><tt class="docutils literal">revsetalias</tt></a></li>
  60. <li><a class="reference internal" href="#server" id="id28"><tt class="docutils literal">server</tt></a></li>
  61. <li><a class="reference internal" href="#smtp" id="id29"><tt class="docutils literal">smtp</tt></a></li>
  62. <li><a class="reference internal" href="#subpaths" id="id30"><tt class="docutils literal">subpaths</tt></a></li>
  63. <li><a class="reference internal" href="#trusted" id="id31"><tt class="docutils literal">trusted</tt></a></li>
  64. <li><a class="reference internal" href="#ui" id="id32"><tt class="docutils literal">ui</tt></a></li>
  65. <li><a class="reference internal" href="#web" id="id33"><tt class="docutils literal">web</tt></a></li>
  66. <li><a class="reference internal" href="#websub" id="id34"><tt class="docutils literal">websub</tt></a></li>
  67. <li><a class="reference internal" href="#worker" id="id35"><tt class="docutils literal">worker</tt></a></li>
  68. </ul>
  69. </li>
  70. <li><a class="reference internal" href="#author" id="id36">Author</a></li>
  71. <li><a class="reference internal" href="#see-also" id="id37">See Also</a></li>
  72. <li><a class="reference internal" href="#copying" id="id38">Copying</a></li>
  73. </ul>
  74. </div>
  75. <div class="section" id="description">
  76. <h1><a class="toc-backref" href="#contents">Description</a></h1>
  77. <p id="hgrc-5-gendoc">The Mercurial system uses a set of configuration files to control
  78. aspects of its behavior.</p>
  79. <p>The configuration files use a simple ini-file format. A configuration
  80. file consists of sections, led by a <tt class="docutils literal">[section]</tt> header and followed
  81. by <tt class="docutils literal">name = value</tt> entries:</p>
  82. <pre class="literal-block">
  83. [ui]
  84. username = Firstname Lastname &lt;firstname.lastname&#64;example.net&gt;
  85. verbose = True
  86. </pre>
  87. <p>The above entries will be referred to as <tt class="docutils literal">ui.username</tt> and
  88. <tt class="docutils literal">ui.verbose</tt>, respectively. See the Syntax section below.</p>
  89. </div>
  90. <div class="section" id="files">
  91. <h1><a class="toc-backref" href="#contents">Files</a></h1>
  92. <p>Mercurial reads configuration data from several files, if they exist.
  93. These files do not exist by default and you will have to create the
  94. appropriate configuration files yourself: global configuration like
  95. the username setting is typically put into
  96. <tt class="docutils literal"><span class="pre">%USERPROFILE%\mercurial.ini</span></tt> or <tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt> and local
  97. configuration is put into the per-repository <tt class="docutils literal"><span class="pre">&lt;repo&gt;/.hg/hgrc</span></tt> file.</p>
  98. <p>The names of these files depend on the system on which Mercurial is
  99. installed. <tt class="docutils literal">*.rc</tt> files from a single directory are read in
  100. alphabetical order, later ones overriding earlier ones. Where multiple
  101. paths are given below, settings from earlier paths override later
  102. ones.</p>
  103. <div class="verbose-unix container">
  104. <p>On Unix, the following files are consulted:</p>
  105. <ul class="simple">
  106. <li><tt class="docutils literal"><span class="pre">&lt;repo&gt;/.hg/hgrc</span></tt> (per-repository)</li>
  107. <li><tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt> (per-user)</li>
  108. <li><tt class="docutils literal"><span class="pre">&lt;install-root&gt;/etc/mercurial/hgrc</span></tt> (per-installation)</li>
  109. <li><tt class="docutils literal"><span class="pre">&lt;install-root&gt;/etc/mercurial/hgrc.d/*.rc</span></tt> (per-installation)</li>
  110. <li><tt class="docutils literal">/etc/mercurial/hgrc</tt> (per-system)</li>
  111. <li><tt class="docutils literal"><span class="pre">/etc/mercurial/hgrc.d/*.rc</span></tt> (per-system)</li>
  112. <li><tt class="docutils literal"><span class="pre">&lt;internal&gt;/default.d/*.rc</span></tt> (defaults)</li>
  113. </ul>
  114. </div>
  115. <div class="verbose-windows container">
  116. <p>On Windows, the following files are consulted:</p>
  117. <ul class="simple">
  118. <li><tt class="docutils literal"><span class="pre">&lt;repo&gt;/.hg/hgrc</span></tt> (per-repository)</li>
  119. <li><tt class="docutils literal"><span class="pre">%USERPROFILE%\.hgrc</span></tt> (per-user)</li>
  120. <li><tt class="docutils literal"><span class="pre">%USERPROFILE%\Mercurial.ini</span></tt> (per-user)</li>
  121. <li><tt class="docutils literal"><span class="pre">%HOME%\.hgrc</span></tt> (per-user)</li>
  122. <li><tt class="docutils literal"><span class="pre">%HOME%\Mercurial.ini</span></tt> (per-user)</li>
  123. <li><tt class="docutils literal"><span class="pre">&lt;install-dir&gt;\Mercurial.ini</span></tt> (per-installation)</li>
  124. <li><tt class="docutils literal"><span class="pre">&lt;install-dir&gt;\hgrc.d\*.rc</span></tt> (per-installation)</li>
  125. <li><tt class="docutils literal">HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial</tt> (per-installation)</li>
  126. <li><tt class="docutils literal"><span class="pre">&lt;internal&gt;/default.d/*.rc</span></tt> (defaults)</li>
  127. </ul>
  128. <div class="note">
  129. <p class="first admonition-title">Note</p>
  130. <p class="last">The registry key <tt class="docutils literal">HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial</tt>
  131. is used when running 32-bit Python on 64-bit Windows.</p>
  132. </div>
  133. </div>
  134. <div class="verbose-plan9 container">
  135. <p>On Plan9, the following files are consulted:</p>
  136. <ul class="simple">
  137. <li><tt class="docutils literal"><span class="pre">&lt;repo&gt;/.hg/hgrc</span></tt> (per-repository)</li>
  138. <li><tt class="docutils literal">$home/lib/hgrc</tt> (per-user)</li>
  139. <li><tt class="docutils literal"><span class="pre">&lt;install-root&gt;/lib/mercurial/hgrc</span></tt> (per-installation)</li>
  140. <li><tt class="docutils literal"><span class="pre">&lt;install-root&gt;/lib/mercurial/hgrc.d/*.rc</span></tt> (per-installation)</li>
  141. <li><tt class="docutils literal">/lib/mercurial/hgrc</tt> (per-system)</li>
  142. <li><tt class="docutils literal"><span class="pre">/lib/mercurial/hgrc.d/*.rc</span></tt> (per-system)</li>
  143. <li><tt class="docutils literal"><span class="pre">&lt;internal&gt;/default.d/*.rc</span></tt> (defaults)</li>
  144. </ul>
  145. </div>
  146. <p>Per-repository configuration options only apply in a
  147. particular repository. This file is not version-controlled, and
  148. will not get transferred during a &quot;clone&quot; operation. Options in
  149. this file override options in all other configuration files. On
  150. Plan 9 and Unix, most of this file will be ignored if it doesn't
  151. belong to a trusted user or to a trusted group. See the documentation
  152. for the <tt class="docutils literal">[trusted]</tt> section below for more details.</p>
  153. <p>Per-user configuration file(s) are for the user running Mercurial. On
  154. Windows 9x, <tt class="docutils literal">%HOME%</tt> is replaced by <tt class="docutils literal">%APPDATA%</tt>. Options in these
  155. files apply to all Mercurial commands executed by this user in any
  156. directory. Options in these files override per-system and per-installation
  157. options.</p>
  158. <p>Per-installation configuration files are searched for in the
  159. directory where Mercurial is installed. <tt class="docutils literal"><span class="pre">&lt;install-root&gt;</span></tt> is the
  160. parent directory of the <strong>hg</strong> executable (or symlink) being run. For
  161. example, if installed in <tt class="docutils literal">/shared/tools/bin/hg</tt>, Mercurial will look
  162. in <tt class="docutils literal">/shared/tools/etc/mercurial/hgrc</tt>. Options in these files apply
  163. to all Mercurial commands executed by any user in any directory.</p>
  164. <p>Per-installation configuration files are for the system on
  165. which Mercurial is running. Options in these files apply to all
  166. Mercurial commands executed by any user in any directory. Registry
  167. keys contain PATH-like strings, every part of which must reference
  168. a <tt class="docutils literal">Mercurial.ini</tt> file or be a directory where <tt class="docutils literal">*.rc</tt> files will
  169. be read.  Mercurial checks each of these locations in the specified
  170. order until one or more configuration files are detected.</p>
  171. <p>Per-system configuration files are for the system on which Mercurial
  172. is running. Options in these files apply to all Mercurial commands
  173. executed by any user in any directory. Options in these files
  174. override per-installation options.</p>
  175. <p>Mercurial comes with some default configuration. The default configuration
  176. files are installed with Mercurial and will be overwritten on upgrades. Default
  177. configuration files should never be edited by users or administrators but can
  178. be overridden in other configuration files. So far the directory only contains
  179. merge tool configuration but packagers can also put other default configuration
  180. there.</p>
  181. </div>
  182. <div class="section" id="syntax">
  183. <h1><a class="toc-backref" href="#contents">Syntax</a></h1>
  184. <p>A configuration file consists of sections, led by a <tt class="docutils literal">[section]</tt> header
  185. and followed by <tt class="docutils literal">name = value</tt> entries (sometimes called
  186. <tt class="docutils literal">configuration keys</tt>):</p>
  187. <pre class="literal-block">
  188. [spam]
  189. eggs=ham
  190. green=
  191.    eggs
  192. </pre>
  193. <p>Each line contains one entry. If the lines that follow are indented,
  194. they are treated as continuations of that entry. Leading whitespace is
  195. removed from values. Empty lines are skipped. Lines beginning with
  196. <tt class="docutils literal">#</tt> or <tt class="docutils literal">;</tt> are ignored and may be used to provide comments.</p>
  197. <p>Configuration keys can be set multiple times, in which case Mercurial
  198. will use the value that was configured last. As an example:</p>
  199. <pre class="literal-block">
  200. [spam]
  201. eggs=large
  202. ham=serrano
  203. eggs=small
  204. </pre>
  205. <p>This would set the configuration key named <tt class="docutils literal">eggs</tt> to <tt class="docutils literal">small</tt>.</p>
  206. <p>It is also possible to define a section multiple times. A section can
  207. be redefined on the same and/or on different configuration files. For
  208. example:</p>
  209. <pre class="literal-block">
  210. [foo]
  211. eggs=large
  212. ham=serrano
  213. eggs=small
  214.  
  215. [bar]
  216. eggs=ham
  217. green=
  218.    eggs
  219.  
  220. [foo]
  221. ham=prosciutto
  222. eggs=medium
  223. bread=toasted
  224. </pre>
  225. <p>This would set the <tt class="docutils literal">eggs</tt>, <tt class="docutils literal">ham</tt>, and <tt class="docutils literal">bread</tt> configuration keys
  226. of the <tt class="docutils literal">foo</tt> section to <tt class="docutils literal">medium</tt>, <tt class="docutils literal">prosciutto</tt>, and <tt class="docutils literal">toasted</tt>,
  227. respectively. As you can see there only thing that matters is the last
  228. value that was set for each of the configuration keys.</p>
  229. <p>If a configuration key is set multiple times in different
  230. configuration files the final value will depend on the order in which
  231. the different configuration files are read, with settings from earlier
  232. paths overriding later ones as described on the <tt class="docutils literal">Files</tt> section
  233. above.</p>
  234. <p>A line of the form <tt class="docutils literal">%include file</tt> will include <tt class="docutils literal">file</tt> into the
  235. current configuration file. The inclusion is recursive, which means
  236. that included files can include other files. Filenames are relative to
  237. the configuration file in which the <tt class="docutils literal">%include</tt> directive is found.
  238. Environment variables and <tt class="docutils literal">~user</tt> constructs are expanded in
  239. <tt class="docutils literal">file</tt>. This lets you do something like:</p>
  240. <pre class="literal-block">
  241. %include ~/.hgrc.d/$HOST.rc
  242. </pre>
  243. <p>to include a different configuration file on each computer you use.</p>
  244. <p>A line with <tt class="docutils literal">%unset name</tt> will remove <tt class="docutils literal">name</tt> from the current
  245. section, if it has been set previously.</p>
  246. <p>The values are either free-form text strings, lists of text strings,
  247. or Boolean values. Boolean values can be set to true using any of &quot;1&quot;,
  248. &quot;yes&quot;, &quot;true&quot;, or &quot;on&quot; and to false using &quot;0&quot;, &quot;no&quot;, &quot;false&quot;, or &quot;off&quot;
  249. (all case insensitive).</p>
  250. <p>List values are separated by whitespace or comma, except when values are
  251. placed in double quotation marks:</p>
  252. <pre class="literal-block">
  253. allow_read = &quot;John Doe, PhD&quot;, brian, betty
  254. </pre>
  255. <p>Quotation marks can be escaped by prefixing them with a backslash. Only
  256. quotation marks at the beginning of a word is counted as a quotation
  257. (e.g., <tt class="docutils literal">foo&quot;bar baz</tt> is the list of <tt class="docutils literal">foo&quot;bar</tt> and <tt class="docutils literal">baz</tt>).</p>
  258. </div>
  259. <div class="section" id="sections">
  260. <h1><a class="toc-backref" href="#contents">Sections</a></h1>
  261. <p>This section describes the different sections that may appear in a
  262. Mercurial configuration file, the purpose of each section, its possible
  263. keys, and their possible values.</p>
  264. <div class="section" id="alias">
  265. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">alias</tt></a></h2>
  266. <p>Defines command aliases.
  267. Aliases allow you to define your own commands in terms of other
  268. commands (or aliases), optionally including arguments. Positional
  269. arguments in the form of <tt class="docutils literal">$1</tt>, <tt class="docutils literal">$2</tt>, etc in the alias definition
  270. are expanded by Mercurial before execution. Positional arguments not
  271. already used by <tt class="docutils literal">$N</tt> in the definition are put at the end of the
  272. command to be executed.</p>
  273. <p>Alias definitions consist of lines of the form:</p>
  274. <pre class="literal-block">
  275. &lt;alias&gt; = &lt;command&gt; [&lt;argument&gt;]...
  276. </pre>
  277. <p>For example, this definition:</p>
  278. <pre class="literal-block">
  279. latest = log --limit 5
  280. </pre>
  281. <p>creates a new command <tt class="docutils literal">latest</tt> that shows only the five most recent
  282. changesets. You can define subsequent aliases using earlier ones:</p>
  283. <pre class="literal-block">
  284. stable5 = latest -b stable
  285. </pre>
  286. <div class="note">
  287. <p class="first admonition-title">Note</p>
  288. <p class="last">It is possible to create aliases with the same names as
  289. existing commands, which will then override the original
  290. definitions. This is almost always a bad idea!</p>
  291. </div>
  292. <p>An alias can start with an exclamation point (<tt class="docutils literal">!</tt>) to make it a
  293. shell alias. A shell alias is executed with the shell and will let you
  294. run arbitrary commands. As an example,</p>
  295. <pre class="literal-block">
  296. echo = !echo $&#64;
  297. </pre>
  298. <p>will let you do <tt class="docutils literal">hg echo foo</tt> to have <tt class="docutils literal">foo</tt> printed in your
  299. terminal. A better example might be:</p>
  300. <pre class="literal-block">
  301. purge = !$HG status --no-status --unknown -0 | xargs -0 rm
  302. </pre>
  303. <p>which will make <tt class="docutils literal">hg purge</tt> delete all unknown files in the
  304. repository in the same manner as the purge extension.</p>
  305. <p>Positional arguments like <tt class="docutils literal">$1</tt>, <tt class="docutils literal">$2</tt>, etc. in the alias definition
  306. expand to the command arguments. Unmatched arguments are
  307. removed. <tt class="docutils literal">$0</tt> expands to the alias name and <tt class="docutils literal">$&#64;</tt> expands to all
  308. arguments separated by a space. <tt class="docutils literal"><span class="pre">&quot;$&#64;&quot;</span></tt> (with quotes) expands to all
  309. arguments quoted individually and separated by a space. These expansions
  310. happen before the command is passed to the shell.</p>
  311. <p>Shell aliases are executed in an environment where <tt class="docutils literal">$HG</tt> expands to
  312. the path of the Mercurial that was used to execute the alias. This is
  313. useful when you want to call further Mercurial commands in a shell
  314. alias, as was done above for the purge alias. In addition,
  315. <tt class="docutils literal">$HG_ARGS</tt> expands to the arguments given to Mercurial. In the <tt class="docutils literal">hg
  316. echo foo</tt> call above, <tt class="docutils literal">$HG_ARGS</tt> would expand to <tt class="docutils literal">echo foo</tt>.</p>
  317. <div class="note">
  318. <p class="first admonition-title">Note</p>
  319. <p class="last">Some global configuration options such as <tt class="docutils literal"><span class="pre">-R</span></tt> are
  320. processed before shell aliases and will thus not be passed to
  321. aliases.</p>
  322. </div>
  323. </div>
  324. <div class="section" id="annotate">
  325. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">annotate</tt></a></h2>
  326. <p>Settings used when displaying file annotations. All values are
  327. Booleans and default to False. See <tt class="docutils literal">diff</tt> section for related
  328. options for the diff command.</p>
  329. <dl class="docutils">
  330. <dt><tt class="docutils literal">ignorews</tt></dt>
  331. <dd>Ignore white space when comparing lines.</dd>
  332. <dt><tt class="docutils literal">ignorewsamount</tt></dt>
  333. <dd>Ignore changes in the amount of white space.</dd>
  334. <dt><tt class="docutils literal">ignoreblanklines</tt></dt>
  335. <dd>Ignore changes whose lines are all blank.</dd>
  336. </dl>
  337. </div>
  338. <div class="section" id="auth">
  339. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">auth</tt></a></h2>
  340. <p>Authentication credentials for HTTP authentication. This section
  341. allows you to store usernames and passwords for use when logging
  342. <em>into</em> HTTP servers. See the <tt class="docutils literal">[web]</tt> configuration section if
  343. you want to configure <em>who</em> can login to your HTTP server.</p>
  344. <p>Each line has the following format:</p>
  345. <pre class="literal-block">
  346. &lt;name&gt;.&lt;argument&gt; = &lt;value&gt;
  347. </pre>
  348. <p>where <tt class="docutils literal">&lt;name&gt;</tt> is used to group arguments into authentication
  349. entries. Example:</p>
  350. <pre class="literal-block">
  351. foo.prefix = hg.intevation.org/mercurial
  352. foo.username = foo
  353. foo.password = bar
  354. foo.schemes = http https
  355.  
  356. bar.prefix = secure.example.org
  357. bar.key = path/to/file.key
  358. bar.cert = path/to/file.cert
  359. bar.schemes = https
  360. </pre>
  361. <p>Supported arguments:</p>
  362. <dl class="docutils">
  363. <dt><tt class="docutils literal">prefix</tt></dt>
  364. <dd>Either <tt class="docutils literal">*</tt> or a URI prefix with or without the scheme part.
  365. The authentication entry with the longest matching prefix is used
  366. (where <tt class="docutils literal">*</tt> matches everything and counts as a match of length
  367. 1). If the prefix doesn't include a scheme, the match is performed
  368. against the URI with its scheme stripped as well, and the schemes
  369. argument, q.v., is then subsequently consulted.</dd>
  370. <dt><tt class="docutils literal">username</tt></dt>
  371. <dd>Optional. Username to authenticate with. If not given, and the
  372. remote site requires basic or digest authentication, the user will
  373. be prompted for it. Environment variables are expanded in the
  374. username letting you do <tt class="docutils literal">foo.username = $USER</tt>. If the URI
  375. includes a username, only <tt class="docutils literal">[auth]</tt> entries with a matching
  376. username or without a username will be considered.</dd>
  377. <dt><tt class="docutils literal">password</tt></dt>
  378. <dd>Optional. Password to authenticate with. If not given, and the
  379. remote site requires basic or digest authentication, the user
  380. will be prompted for it.</dd>
  381. <dt><tt class="docutils literal">key</tt></dt>
  382. <dd>Optional. PEM encoded client certificate key file. Environment
  383. variables are expanded in the filename.</dd>
  384. <dt><tt class="docutils literal">cert</tt></dt>
  385. <dd>Optional. PEM encoded client certificate chain file. Environment
  386. variables are expanded in the filename.</dd>
  387. <dt><tt class="docutils literal">schemes</tt></dt>
  388. <dd>Optional. Space separated list of URI schemes to use this
  389. authentication entry with. Only used if the prefix doesn't include
  390. a scheme. Supported schemes are http and https. They will match
  391. static-http and static-https respectively, as well.
  392. Default: https.</dd>
  393. </dl>
  394. <p>If no suitable authentication entry is found, the user is prompted
  395. for credentials as usual if required by the remote.</p>
  396. </div>
  397. <div class="section" id="committemplate">
  398. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">committemplate</tt></a></h2>
  399. <p><tt class="docutils literal">changeset</tt> configuration in this section is used as the template to
  400. customize the text shown in the editor when committing.</p>
  401. <p>In addition to pre-defined template keywords, commit log specific one
  402. below can be used for customization:</p>
  403. <dl class="docutils">
  404. <dt><tt class="docutils literal">extramsg</tt></dt>
  405. <dd>String: Extra message (typically 'Leave message empty to abort
  406. commit.'). This may be changed by some commands or extensions.</dd>
  407. </dl>
  408. <p>For example, the template configuration below shows as same text as
  409. one shown by default:</p>
  410. <pre class="literal-block">
  411. [committemplate]
  412. changeset = {desc}\n\n
  413.     HG: Enter commit message.  Lines beginning with 'HG:' are removed.
  414.     HG: {extramsg}
  415.     HG: --
  416.     HG: user: {author}\n{ifeq(p2rev, &quot;-1&quot;, &quot;&quot;,
  417.    &quot;HG: branch merge\n&quot;)
  418.    }HG: branch '{branch}'\n{if(activebookmark,
  419.    &quot;HG: bookmark '{activebookmark}'\n&quot;)   }{subrepos %
  420.    &quot;HG: subrepo {subrepo}\n&quot;              }{file_adds %
  421.    &quot;HG: added {file}\n&quot;                   }{file_mods %
  422.    &quot;HG: changed {file}\n&quot;                 }{file_dels %
  423.    &quot;HG: removed {file}\n&quot;                 }{if(files, &quot;&quot;,
  424.    &quot;HG: no files changed\n&quot;)}
  425. </pre>
  426. <div class="note">
  427. <p class="first admonition-title">Note</p>
  428. <p>For some problematic encodings (see <a class="reference external" href="hg.1.html#win32mbcs"><tt class="docutils literal">hg help win32mbcs</tt></a> for
  429. detail), this customization should be configured carefully, to
  430. avoid showing broken characters.</p>
  431. <p class="last">For example, if multibyte character ending with backslash (0x5c) is
  432. followed by ASCII character 'n' in the customized template,
  433. sequence of backslash and 'n' is treated as line-feed unexpectedly
  434. (and multibyte character is broken, too).</p>
  435. </div>
  436. <p>Customized template is used for commands below (<tt class="docutils literal"><span class="pre">--edit</span></tt> may be
  437. required):</p>
  438. <ul class="simple">
  439. <li><a class="reference external" href="hg.1.html#backout"><tt class="docutils literal">hg backout</tt></a></li>
  440. <li><a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit</tt></a></li>
  441. <li><a class="reference external" href="hg.1.html#fetch"><tt class="docutils literal">hg fetch</tt></a> (for merge commit only)</li>
  442. <li><a class="reference external" href="hg.1.html#graft"><tt class="docutils literal">hg graft</tt></a></li>
  443. <li><a class="reference external" href="hg.1.html#histedit"><tt class="docutils literal">hg histedit</tt></a></li>
  444. <li><a class="reference external" href="hg.1.html#import"><tt class="docutils literal">hg import</tt></a></li>
  445. <li><a class="reference external" href="hg.1.html#qfold"><tt class="docutils literal">hg qfold</tt></a>, <a class="reference external" href="hg.1.html#qnew"><tt class="docutils literal">hg qnew</tt></a> and <a class="reference external" href="hg.1.html#qrefresh"><tt class="docutils literal">hg qrefresh</tt></a></li>
  446. <li><a class="reference external" href="hg.1.html#rebase"><tt class="docutils literal">hg rebase</tt></a></li>
  447. <li><a class="reference external" href="hg.1.html#shelve"><tt class="docutils literal">hg shelve</tt></a></li>
  448. <li><a class="reference external" href="hg.1.html#sign"><tt class="docutils literal">hg sign</tt></a></li>
  449. <li><a class="reference external" href="hg.1.html#tag"><tt class="docutils literal">hg tag</tt></a></li>
  450. <li><a class="reference external" href="hg.1.html#transplant"><tt class="docutils literal">hg transplant</tt></a></li>
  451. </ul>
  452. <p>Configuring items below instead of <tt class="docutils literal">changeset</tt> allows showing
  453. customized message only for specific actions, or showing different
  454. messages for each action.</p>
  455. <ul class="simple">
  456. <li><tt class="docutils literal">changeset.backout</tt> for <a class="reference external" href="hg.1.html#backout"><tt class="docutils literal">hg backout</tt></a></li>
  457. <li><tt class="docutils literal">changeset.commit.amend.merge</tt> for <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit <span class="pre">--amend</span></tt></a> on merges</li>
  458. <li><tt class="docutils literal">changeset.commit.amend.normal</tt> for <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit <span class="pre">--amend</span></tt></a> on other</li>
  459. <li><tt class="docutils literal">changeset.commit.normal.merge</tt> for <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit</tt></a> on merges</li>
  460. <li><tt class="docutils literal">changeset.commit.normal.normal</tt> for <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit</tt></a> on other</li>
  461. <li><tt class="docutils literal">changeset.fetch</tt> for <a class="reference external" href="hg.1.html#fetch"><tt class="docutils literal">hg fetch</tt></a> (impling merge commit)</li>
  462. <li><tt class="docutils literal">changeset.gpg.sign</tt> for <a class="reference external" href="hg.1.html#sign"><tt class="docutils literal">hg sign</tt></a></li>
  463. <li><tt class="docutils literal">changeset.graft</tt> for <a class="reference external" href="hg.1.html#graft"><tt class="docutils literal">hg graft</tt></a></li>
  464. <li><tt class="docutils literal">changeset.histedit.edit</tt> for <tt class="docutils literal">edit</tt> of <a class="reference external" href="hg.1.html#histedit"><tt class="docutils literal">hg histedit</tt></a></li>
  465. <li><tt class="docutils literal">changeset.histedit.fold</tt> for <tt class="docutils literal">fold</tt> of <a class="reference external" href="hg.1.html#histedit"><tt class="docutils literal">hg histedit</tt></a></li>
  466. <li><tt class="docutils literal">changeset.histedit.mess</tt> for <tt class="docutils literal">mess</tt> of <a class="reference external" href="hg.1.html#histedit"><tt class="docutils literal">hg histedit</tt></a></li>
  467. <li><tt class="docutils literal">changeset.histedit.pick</tt> for <tt class="docutils literal">pick</tt> of <a class="reference external" href="hg.1.html#histedit"><tt class="docutils literal">hg histedit</tt></a></li>
  468. <li><tt class="docutils literal">changeset.import.bypass</tt> for <a class="reference external" href="hg.1.html#import"><tt class="docutils literal">hg import <span class="pre">--bypass</span></tt></a></li>
  469. <li><tt class="docutils literal">changeset.import.normal.merge</tt> for <a class="reference external" href="hg.1.html#import"><tt class="docutils literal">hg import</tt></a> on merges</li>
  470. <li><tt class="docutils literal">changeset.import.normal.normal</tt> for <a class="reference external" href="hg.1.html#import"><tt class="docutils literal">hg import</tt></a> on other</li>
  471. <li><tt class="docutils literal">changeset.mq.qnew</tt> for <a class="reference external" href="hg.1.html#qnew"><tt class="docutils literal">hg qnew</tt></a></li>
  472. <li><tt class="docutils literal">changeset.mq.qfold</tt> for <a class="reference external" href="hg.1.html#qfold"><tt class="docutils literal">hg qfold</tt></a></li>
  473. <li><tt class="docutils literal">changeset.mq.qrefresh</tt> for <a class="reference external" href="hg.1.html#qrefresh"><tt class="docutils literal">hg qrefresh</tt></a></li>
  474. <li><tt class="docutils literal">changeset.rebase.collapse</tt> for <a class="reference external" href="hg.1.html#rebase"><tt class="docutils literal">hg rebase <span class="pre">--collapse</span></tt></a></li>
  475. <li><tt class="docutils literal">changeset.rebase.merge</tt> for <a class="reference external" href="hg.1.html#rebase"><tt class="docutils literal">hg rebase</tt></a> on merges</li>
  476. <li><tt class="docutils literal">changeset.rebase.normal</tt> for <a class="reference external" href="hg.1.html#rebase"><tt class="docutils literal">hg rebase</tt></a> on other</li>
  477. <li><tt class="docutils literal">changeset.shelve.shelve</tt> for <a class="reference external" href="hg.1.html#shelve"><tt class="docutils literal">hg shelve</tt></a></li>
  478. <li><tt class="docutils literal">changeset.tag.add</tt> for <a class="reference external" href="hg.1.html#tag"><tt class="docutils literal">hg tag</tt></a> without <tt class="docutils literal"><span class="pre">--remove</span></tt></li>
  479. <li><tt class="docutils literal">changeset.tag.remove</tt> for <a class="reference external" href="hg.1.html#tag"><tt class="docutils literal">hg tag <span class="pre">--remove</span></tt></a></li>
  480. <li><tt class="docutils literal">changeset.transplant.merge</tt> for <a class="reference external" href="hg.1.html#transplant"><tt class="docutils literal">hg transplant</tt></a> on merges</li>
  481. <li><tt class="docutils literal">changeset.transplant.normal</tt> for <a class="reference external" href="hg.1.html#transplant"><tt class="docutils literal">hg transplant</tt></a> on other</li>
  482. </ul>
  483. <p>These dot-separated lists of names are treated as hierarchical ones.
  484. For example, <tt class="docutils literal">changeset.tag.remove</tt> customizes the commit message
  485. only for <a class="reference external" href="hg.1.html#tag"><tt class="docutils literal">hg tag <span class="pre">--remove</span></tt></a>, but <tt class="docutils literal">changeset.tag</tt> customizes the
  486. commit message for <a class="reference external" href="hg.1.html#tag"><tt class="docutils literal">hg tag</tt></a> regardless of <tt class="docutils literal"><span class="pre">--remove</span></tt> option.</p>
  487. <p>At the external editor invocation for committing, corresponding
  488. dot-separated list of names without <tt class="docutils literal">changeset.</tt> prefix
  489. (e.g. <tt class="docutils literal">commit.normal.normal</tt>) is in <tt class="docutils literal">HGEDITFORM</tt> environment variable.</p>
  490. <p>In this section, items other than <tt class="docutils literal">changeset</tt> can be referred from
  491. others. For example, the configuration to list committed files up
  492. below can be referred as <tt class="docutils literal">{listupfiles}</tt>:</p>
  493. <pre class="literal-block">
  494. [committemplate]
  495. listupfiles = {file_adds %
  496.    &quot;HG: added {file}\n&quot;     }{file_mods %
  497.    &quot;HG: changed {file}\n&quot;   }{file_dels %
  498.    &quot;HG: removed {file}\n&quot;   }{if(files, &quot;&quot;,
  499.    &quot;HG: no files changed\n&quot;)}
  500. </pre>
  501. </div>
  502. <div class="section" id="decode-encode">
  503. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">decode/encode</tt></a></h2>
  504. <p>Filters for transforming files on checkout/checkin. This would
  505. typically be used for newline processing or other
  506. localization/canonicalization of files.</p>
  507. <p>Filters consist of a filter pattern followed by a filter command.
  508. Filter patterns are globs by default, rooted at the repository root.
  509. For example, to match any file ending in <tt class="docutils literal">.txt</tt> in the root
  510. directory only, use the pattern <tt class="docutils literal">*.txt</tt>. To match any file ending
  511. in <tt class="docutils literal">.c</tt> anywhere in the repository, use the pattern <tt class="docutils literal"><span class="pre">**.c</span></tt>.
  512. For each file only the first matching filter applies.</p>
  513. <p>The filter command can start with a specifier, either <tt class="docutils literal">pipe:</tt> or
  514. <tt class="docutils literal">tempfile:</tt>. If no specifier is given, <tt class="docutils literal">pipe:</tt> is used by default.</p>
  515. <p>A <tt class="docutils literal">pipe:</tt> command must accept data on stdin and return the transformed
  516. data on stdout.</p>
  517. <p>Pipe example:</p>
  518. <pre class="literal-block">
  519. [encode]
  520. # uncompress gzip files on checkin to improve delta compression
  521. # note: not necessarily a good idea, just an example
  522. *.gz = pipe: gunzip
  523.  
  524. [decode]
  525. # recompress gzip files when writing them to the working dir (we
  526. # can safely omit &quot;pipe:&quot;, because it's the default)
  527. *.gz = gzip
  528. </pre>
  529. <p>A <tt class="docutils literal">tempfile:</tt> command is a template. The string <tt class="docutils literal">INFILE</tt> is replaced
  530. with the name of a temporary file that contains the data to be
  531. filtered by the command. The string <tt class="docutils literal">OUTFILE</tt> is replaced with the name
  532. of an empty temporary file, where the filtered data must be written by
  533. the command.</p>
  534. <div class="note">
  535. <p class="first admonition-title">Note</p>
  536. <p class="last">The tempfile mechanism is recommended for Windows systems,
  537. where the standard shell I/O redirection operators often have
  538. strange effects and may corrupt the contents of your files.</p>
  539. </div>
  540. <p>This filter mechanism is used internally by the <tt class="docutils literal">eol</tt> extension to
  541. translate line ending characters between Windows (CRLF) and Unix (LF)
  542. format. We suggest you use the <tt class="docutils literal">eol</tt> extension for convenience.</p>
  543. </div>
  544. <div class="section" id="defaults">
  545. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">defaults</tt></a></h2>
  546. <p>(defaults are deprecated. Don't use them. Use aliases instead)</p>
  547. <p>Use the <tt class="docutils literal">[defaults]</tt> section to define command defaults, i.e. the
  548. default options/arguments to pass to the specified commands.</p>
  549. <p>The following example makes <a class="reference external" href="hg.1.html#log"><tt class="docutils literal">hg log</tt></a> run in verbose mode, and
  550. <a class="reference external" href="hg.1.html#status"><tt class="docutils literal">hg status</tt></a> show only the modified files, by default:</p>
  551. <pre class="literal-block">
  552. [defaults]
  553. log = -v
  554. status = -m
  555. </pre>
  556. <p>The actual commands, instead of their aliases, must be used when
  557. defining command defaults. The command defaults will also be applied
  558. to the aliases of the commands defined.</p>
  559. </div>
  560. <div class="section" id="diff">
  561. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">diff</tt></a></h2>
  562. <p>Settings used when displaying diffs. Everything except for <tt class="docutils literal">unified</tt>
  563. is a Boolean and defaults to False. See <tt class="docutils literal">annotate</tt> section for
  564. related options for the annotate command.</p>
  565. <dl class="docutils">
  566. <dt><tt class="docutils literal">git</tt></dt>
  567. <dd>Use git extended diff format.</dd>
  568. <dt><tt class="docutils literal">nobinary</tt></dt>
  569. <dd>Omit git binary patches.</dd>
  570. <dt><tt class="docutils literal">nodates</tt></dt>
  571. <dd>Don't include dates in diff headers.</dd>
  572. <dt><tt class="docutils literal">noprefix</tt></dt>
  573. <dd>Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.</dd>
  574. <dt><tt class="docutils literal">showfunc</tt></dt>
  575. <dd>Show which function each change is in.</dd>
  576. <dt><tt class="docutils literal">ignorews</tt></dt>
  577. <dd>Ignore white space when comparing lines.</dd>
  578. <dt><tt class="docutils literal">ignorewsamount</tt></dt>
  579. <dd>Ignore changes in the amount of white space.</dd>
  580. <dt><tt class="docutils literal">ignoreblanklines</tt></dt>
  581. <dd>Ignore changes whose lines are all blank.</dd>
  582. <dt><tt class="docutils literal">unified</tt></dt>
  583. <dd>Number of lines of context to show.</dd>
  584. </dl>
  585. </div>
  586. <div class="section" id="email">
  587. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">email</tt></a></h2>
  588. <p>Settings for extensions that send email messages.</p>
  589. <dl class="docutils">
  590. <dt><tt class="docutils literal">from</tt></dt>
  591. <dd>Optional. Email address to use in &quot;From&quot; header and SMTP envelope
  592. of outgoing messages.</dd>
  593. <dt><tt class="docutils literal">to</tt></dt>
  594. <dd>Optional. Comma-separated list of recipients' email addresses.</dd>
  595. <dt><tt class="docutils literal">cc</tt></dt>
  596. <dd>Optional. Comma-separated list of carbon copy recipients'
  597. email addresses.</dd>
  598. <dt><tt class="docutils literal">bcc</tt></dt>
  599. <dd>Optional. Comma-separated list of blind carbon copy recipients'
  600. email addresses.</dd>
  601. <dt><tt class="docutils literal">method</tt></dt>
  602. <dd>Optional. Method to use to send email messages. If value is <tt class="docutils literal">smtp</tt>
  603. (default), use SMTP (see the <tt class="docutils literal">[smtp]</tt> section for configuration).
  604. Otherwise, use as name of program to run that acts like sendmail
  605. (takes <tt class="docutils literal"><span class="pre">-f</span></tt> option for sender, list of recipients on command line,
  606. message on stdin). Normally, setting this to <tt class="docutils literal">sendmail</tt> or
  607. <tt class="docutils literal">/usr/sbin/sendmail</tt> is enough to use sendmail to send messages.</dd>
  608. <dt><tt class="docutils literal">charsets</tt></dt>
  609. <dd><p class="first">Optional. Comma-separated list of character sets considered
  610. convenient for recipients. Addresses, headers, and parts not
  611. containing patches of outgoing messages will be encoded in the
  612. first character set to which conversion from local encoding
  613. (<tt class="docutils literal">$HGENCODING</tt>, <tt class="docutils literal">ui.fallbackencoding</tt>) succeeds. If correct
  614. conversion fails, the text in question is sent as is. Defaults to
  615. empty (explicit) list.</p>
  616. <p>Order of outgoing email character sets:</p>
  617. <ol class="last arabic simple">
  618. <li><tt class="docutils literal"><span class="pre">us-ascii</span></tt>: always first, regardless of settings</li>
  619. <li><tt class="docutils literal">email.charsets</tt>: in order given by user</li>
  620. <li><tt class="docutils literal">ui.fallbackencoding</tt>: if not in email.charsets</li>
  621. <li><tt class="docutils literal">$HGENCODING</tt>: if not in email.charsets</li>
  622. <li><tt class="docutils literal"><span class="pre">utf-8</span></tt>: always last, regardless of settings</li>
  623. </ol>
  624. </dd>
  625. </dl>
  626. <p>Email example:</p>
  627. <pre class="literal-block">
  628. [email]
  629. from = Joseph User &lt;joe.user&#64;example.com&gt;
  630. method = /usr/sbin/sendmail
  631. # charsets for western Europeans
  632. # us-ascii, utf-8 omitted, as they are tried first and last
  633. charsets = iso-8859-1, iso-8859-15, windows-1252
  634. </pre>
  635. </div>
  636. <div class="section" id="extensions">
  637. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">extensions</tt></a></h2>
  638. <p>Mercurial has an extension mechanism for adding new features. To
  639. enable an extension, create an entry for it in this section.</p>
  640. <p>If you know that the extension is already in Python's search path,
  641. you can give the name of the module, followed by <tt class="docutils literal">=</tt>, with nothing
  642. after the <tt class="docutils literal">=</tt>.</p>
  643. <p>Otherwise, give a name that you choose, followed by <tt class="docutils literal">=</tt>, followed by
  644. the path to the <tt class="docutils literal">.py</tt> file (including the file name extension) that
  645. defines the extension.</p>
  646. <p>To explicitly disable an extension that is enabled in an hgrc of
  647. broader scope, prepend its path with <tt class="docutils literal">!</tt>, as in <tt class="docutils literal">foo = !/ext/path</tt>
  648. or <tt class="docutils literal">foo = !</tt> when path is not supplied.</p>
  649. <p>Example for <tt class="docutils literal"><span class="pre">~/.hgrc</span></tt>:</p>
  650. <pre class="literal-block">
  651. [extensions]
  652. # (the color extension will get loaded from Mercurial's path)
  653. color =
  654. # (this extension will get loaded from the file specified)
  655. myfeature = ~/.hgext/myfeature.py
  656. </pre>
  657. </div>
  658. <div class="section" id="format">
  659. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">format</tt></a></h2>
  660. <dl class="docutils">
  661. <dt><tt class="docutils literal">usestore</tt></dt>
  662. <dd>Enable or disable the &quot;store&quot; repository format which improves
  663. compatibility with systems that fold case or otherwise mangle
  664. filenames. Enabled by default. Disabling this option will allow
  665. you to store longer filenames in some situations at the expense of
  666. compatibility and ensures that the on-disk format of newly created
  667. repositories will be compatible with Mercurial before version 0.9.4.</dd>
  668. <dt><tt class="docutils literal">usefncache</tt></dt>
  669. <dd>Enable or disable the &quot;fncache&quot; repository format which enhances
  670. the &quot;store&quot; repository format (which has to be enabled to use
  671. fncache) to allow longer filenames and avoids using Windows
  672. reserved names, e.g. &quot;nul&quot;. Enabled by default. Disabling this
  673. option ensures that the on-disk format of newly created
  674. repositories will be compatible with Mercurial before version 1.1.</dd>
  675. <dt><tt class="docutils literal">dotencode</tt></dt>
  676. <dd>Enable or disable the &quot;dotencode&quot; repository format which enhances
  677. the &quot;fncache&quot; repository format (which has to be enabled to use
  678. dotencode) to avoid issues with filenames starting with ._ on
  679. Mac OS X and spaces on Windows. Enabled by default. Disabling this
  680. option ensures that the on-disk format of newly created
  681. repositories will be compatible with Mercurial before version 1.7.</dd>
  682. </dl>
  683. </div>
  684. <div class="section" id="graph">
  685. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">graph</tt></a></h2>
  686. <p>Web graph view configuration. This section let you change graph
  687. elements display properties by branches, for instance to make the
  688. <tt class="docutils literal">default</tt> branch stand out.</p>
  689. <p>Each line has the following format:</p>
  690. <pre class="literal-block">
  691. &lt;branch&gt;.&lt;argument&gt; = &lt;value&gt;
  692. </pre>
  693. <p>where <tt class="docutils literal">&lt;branch&gt;</tt> is the name of the branch being
  694. customized. Example:</p>
  695. <pre class="literal-block">
  696. [graph]
  697. # 2px width
  698. default.width = 2
  699. # red color
  700. default.color = FF0000
  701. </pre>
  702. <p>Supported arguments:</p>
  703. <dl class="docutils">
  704. <dt><tt class="docutils literal">width</tt></dt>
  705. <dd>Set branch edges width in pixels.</dd>
  706. <dt><tt class="docutils literal">color</tt></dt>
  707. <dd>Set branch edges color in hexadecimal RGB notation.</dd>
  708. </dl>
  709. </div>
  710. <div class="section" id="hooks">
  711. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">hooks</tt></a></h2>
  712. <p>Commands or Python functions that get automatically executed by
  713. various actions such as starting or finishing a commit. Multiple
  714. hooks can be run for the same action by appending a suffix to the
  715. action. Overriding a site-wide hook can be done by changing its
  716. value or setting it to an empty string.  Hooks can be prioritized
  717. by adding a prefix of <tt class="docutils literal">priority</tt> to the hook name on a new line
  718. and setting the priority.  The default priority is 0 if
  719. not specified.</p>
  720. <p>Example <tt class="docutils literal">.hg/hgrc</tt>:</p>
  721. <pre class="literal-block">
  722. [hooks]
  723. # update working directory after adding changesets
  724. changegroup.update = hg update
  725. # do not use the site-wide hook
  726. incoming =
  727. incoming.email = /my/email/hook
  728. incoming.autobuild = /my/build/hook
  729. # force autobuild hook to run before other incoming hooks
  730. priority.incoming.autobuild = 1
  731. </pre>
  732. <p>Most hooks are run with environment variables set that give useful
  733. additional information. For each hook below, the environment
  734. variables it is passed are listed with names of the form <tt class="docutils literal">$HG_foo</tt>.</p>
  735. <dl class="docutils">
  736. <dt><tt class="docutils literal">changegroup</tt></dt>
  737. <dd>Run after a changegroup has been added via push, pull or unbundle.
  738. ID of the first new changeset is in <tt class="docutils literal">$HG_NODE</tt>. URL from which
  739. changes came is in <tt class="docutils literal">$HG_URL</tt>.</dd>
  740. <dt><tt class="docutils literal">commit</tt></dt>
  741. <dd>Run after a changeset has been created in the local repository. ID
  742. of the newly created changeset is in <tt class="docutils literal">$HG_NODE</tt>. Parent changeset
  743. IDs are in <tt class="docutils literal">$HG_PARENT1</tt> and <tt class="docutils literal">$HG_PARENT2</tt>.</dd>
  744. <dt><tt class="docutils literal">incoming</tt></dt>
  745. <dd>Run after a changeset has been pulled, pushed, or unbundled into
  746. the local repository. The ID of the newly arrived changeset is in
  747. <tt class="docutils literal">$HG_NODE</tt>. URL that was source of changes came is in <tt class="docutils literal">$HG_URL</tt>.</dd>
  748. <dt><tt class="docutils literal">outgoing</tt></dt>
  749. <dd>Run after sending changes from local repository to another. ID of
  750. first changeset sent is in <tt class="docutils literal">$HG_NODE</tt>. Source of operation is in
  751. <tt class="docutils literal">$HG_SOURCE</tt>; see &quot;preoutgoing&quot; hook for description.</dd>
  752. <dt><tt class="docutils literal"><span class="pre">post-&lt;command&gt;</span></tt></dt>
  753. <dd>Run after successful invocations of the associated command. The
  754. contents of the command line are passed as <tt class="docutils literal">$HG_ARGS</tt> and the result
  755. code in <tt class="docutils literal">$HG_RESULT</tt>. Parsed command line arguments are passed as
  756. <tt class="docutils literal">$HG_PATS</tt> and <tt class="docutils literal">$HG_OPTS</tt>. These contain string representations of
  757. the python data internally passed to &lt;command&gt;. <tt class="docutils literal">$HG_OPTS</tt> is a
  758. dictionary of options (with unspecified options set to their defaults).
  759. <tt class="docutils literal">$HG_PATS</tt> is a list of arguments. Hook failure is ignored.</dd>
  760. <dt><tt class="docutils literal"><span class="pre">pre-&lt;command&gt;</span></tt></dt>
  761. <dd>Run before executing the associated command. The contents of the
  762. command line are passed as <tt class="docutils literal">$HG_ARGS</tt>. Parsed command line arguments
  763. are passed as <tt class="docutils literal">$HG_PATS</tt> and <tt class="docutils literal">$HG_OPTS</tt>. These contain string
  764. representations of the data internally passed to &lt;command&gt;. <tt class="docutils literal">$HG_OPTS</tt>
  765. is a  dictionary of options (with unspecified options set to their
  766. defaults). <tt class="docutils literal">$HG_PATS</tt> is a list of arguments. If the hook returns
  767. failure, the command doesn't execute and Mercurial returns the failure
  768. code.</dd>
  769. <dt><tt class="docutils literal">prechangegroup</tt></dt>
  770. <dd>Run before a changegroup is added via push, pull or unbundle. Exit
  771. status 0 allows the changegroup to proceed. Non-zero status will
  772. cause the push, pull or unbundle to fail. URL from which changes
  773. will come is in <tt class="docutils literal">$HG_URL</tt>.</dd>
  774. <dt><tt class="docutils literal">precommit</tt></dt>
  775. <dd>Run before starting a local commit. Exit status 0 allows the
  776. commit to proceed. Non-zero status will cause the commit to fail.
  777. Parent changeset IDs are in <tt class="docutils literal">$HG_PARENT1</tt> and <tt class="docutils literal">$HG_PARENT2</tt>.</dd>
  778. <dt><tt class="docutils literal">prelistkeys</tt></dt>
  779. <dd>Run before listing pushkeys (like bookmarks) in the
  780. repository. Non-zero status will cause failure. The key namespace is
  781. in <tt class="docutils literal">$HG_NAMESPACE</tt>.</dd>
  782. <dt><tt class="docutils literal">preoutgoing</tt></dt>
  783. <dd>Run before collecting changes to send from the local repository to
  784. another. Non-zero status will cause failure. This lets you prevent
  785. pull over HTTP or SSH. Also prevents against local pull, push
  786. (outbound) or bundle commands, but not effective, since you can
  787. just copy files instead then. Source of operation is in
  788. <tt class="docutils literal">$HG_SOURCE</tt>. If &quot;serve&quot;, operation is happening on behalf of remote
  789. SSH or HTTP repository. If &quot;push&quot;, &quot;pull&quot; or &quot;bundle&quot;, operation
  790. is happening on behalf of repository on same system.</dd>
  791. <dt><tt class="docutils literal">prepushkey</tt></dt>
  792. <dd>Run before a pushkey (like a bookmark) is added to the
  793. repository. Non-zero status will cause the key to be rejected. The
  794. key namespace is in <tt class="docutils literal">$HG_NAMESPACE</tt>, the key is in <tt class="docutils literal">$HG_KEY</tt>,
  795. the old value (if any) is in <tt class="docutils literal">$HG_OLD</tt>, and the new value is in
  796. <tt class="docutils literal">$HG_NEW</tt>.</dd>
  797. <dt><tt class="docutils literal">pretag</tt></dt>
  798. <dd>Run before creating a tag. Exit status 0 allows the tag to be
  799. created. Non-zero status will cause the tag to fail. ID of
  800. changeset to tag is in <tt class="docutils literal">$HG_NODE</tt>. Name of tag is in <tt class="docutils literal">$HG_TAG</tt>. Tag is
  801. local if <tt class="docutils literal">$HG_LOCAL=1</tt>, in repository if <tt class="docutils literal">$HG_LOCAL=0</tt>.</dd>
  802. <dt><tt class="docutils literal">pretxnopen</tt></dt>
  803. <dd>Run before any new repository transaction is open. The reason for the
  804. transaction will be in <tt class="docutils literal">$HG_TXNNAME</tt> and a unique identifier for the
  805. transaction will be in <tt class="docutils literal">HG_TXNID</tt>. A non-zero status will prevent the
  806. transaction from being opened.</dd>
  807. <dt><tt class="docutils literal">pretxnclose</tt></dt>
  808. <dd>Run right before the transaction is actually finalized. Any
  809. repository change will be visible to the hook program. This lets you
  810. validate the transaction content or change it. Exit status 0 allows
  811. the commit to proceed. Non-zero status will cause the transaction to
  812. be rolled back. The reason for the transaction opening will be in
  813. <tt class="docutils literal">$HG_TXNNAME</tt> and a unique identifier for the transaction will be in
  814. <tt class="docutils literal">HG_TXNID</tt>. The rest of the available data will vary according the
  815. transaction type. New changesets will add <tt class="docutils literal">$HG_NODE</tt> (id of the
  816. first added changeset), <tt class="docutils literal">$HG_URL</tt> and <tt class="docutils literal">$HG_SOURCE</tt> variables,
  817. bookmarks and phases changes will set <tt class="docutils literal">HG_BOOKMARK_MOVED</tt> and
  818. <tt class="docutils literal">HG_PHASES_MOVED</tt> to <tt class="docutils literal">1</tt>, etc.</dd>
  819. <dt><tt class="docutils literal">txnclose</tt></dt>
  820. <dd>Run after any repository transaction has been committed. At this
  821. point, the transaction can no longer be rolled back. The hook will run
  822. after the lock is released. See <tt class="docutils literal">pretxnclose</tt> docs for details about
  823. available variables.</dd>
  824. <dt><tt class="docutils literal">txnabort</tt></dt>
  825. <dd>Run when a transaction is aborted. See <tt class="docutils literal">pretxnclose</tt> docs for details about
  826. available variables.</dd>
  827. <dt><tt class="docutils literal">pretxnchangegroup</tt></dt>
  828. <dd>Run after a changegroup has been added via push, pull or unbundle,
  829. but before the transaction has been committed. Changegroup is
  830. visible to hook program. This lets you validate incoming changes
  831. before accepting them. Passed the ID of the first new changeset in
  832. <tt class="docutils literal">$HG_NODE</tt>. Exit status 0 allows the transaction to commit. Non-zero
  833. status will cause the transaction to be rolled back and the push,
  834. pull or unbundle will fail. URL that was source of changes is in
  835. <tt class="docutils literal">$HG_URL</tt>.</dd>
  836. <dt><tt class="docutils literal">pretxncommit</tt></dt>
  837. <dd>Run after a changeset has been created but the transaction not yet
  838. committed. Changeset is visible to hook program. This lets you
  839. validate commit message and changes. Exit status 0 allows the
  840. commit to proceed. Non-zero status will cause the transaction to
  841. be rolled back. ID of changeset is in <tt class="docutils literal">$HG_NODE</tt>. Parent changeset
  842. IDs are in <tt class="docutils literal">$HG_PARENT1</tt> and <tt class="docutils literal">$HG_PARENT2</tt>.</dd>
  843. <dt><tt class="docutils literal">preupdate</tt></dt>
  844. <dd>Run before updating the working directory. Exit status 0 allows
  845. the update to proceed. Non-zero status will prevent the update.
  846. Changeset ID of first new parent is in <tt class="docutils literal">$HG_PARENT1</tt>. If merge, ID
  847. of second new parent is in <tt class="docutils literal">$HG_PARENT2</tt>.</dd>
  848. <dt><tt class="docutils literal">listkeys</tt></dt>
  849. <dd>Run after listing pushkeys (like bookmarks) in the repository. The
  850. key namespace is in <tt class="docutils literal">$HG_NAMESPACE</tt>. <tt class="docutils literal">$HG_VALUES</tt> is a
  851. dictionary containing the keys and values.</dd>
  852. <dt><tt class="docutils literal">pushkey</tt></dt>
  853. <dd>Run after a pushkey (like a bookmark) is added to the
  854. repository. The key namespace is in <tt class="docutils literal">$HG_NAMESPACE</tt>, the key is in
  855. <tt class="docutils literal">$HG_KEY</tt>, the old value (if any) is in <tt class="docutils literal">$HG_OLD</tt>, and the new
  856. value is in <tt class="docutils literal">$HG_NEW</tt>.</dd>
  857. <dt><tt class="docutils literal">tag</tt></dt>
  858. <dd>Run after a tag is created. ID of tagged changeset is in <tt class="docutils literal">$HG_NODE</tt>.
  859. Name of tag is in <tt class="docutils literal">$HG_TAG</tt>. Tag is local if <tt class="docutils literal">$HG_LOCAL=1</tt>, in
  860. repository if <tt class="docutils literal">$HG_LOCAL=0</tt>.</dd>
  861. <dt><tt class="docutils literal">update</tt></dt>
  862. <dd>Run after updating the working directory. Changeset ID of first
  863. new parent is in <tt class="docutils literal">$HG_PARENT1</tt>. If merge, ID of second new parent is
  864. in <tt class="docutils literal">$HG_PARENT2</tt>. If the update succeeded, <tt class="docutils literal">$HG_ERROR=0</tt>. If the
  865. update failed (e.g. because conflicts not resolved), <tt class="docutils literal">$HG_ERROR=1</tt>.</dd>
  866. </dl>
  867. <div class="note">
  868. <p class="first admonition-title">Note</p>
  869. <p class="last">It is generally better to use standard hooks rather than the
  870. generic pre- and post- command hooks as they are guaranteed to be
  871. called in the appropriate contexts for influencing transactions.
  872. Also, hooks like &quot;commit&quot; will be called in all contexts that
  873. generate a commit (e.g. tag) and not just the commit command.</p>
  874. </div>
  875. <div class="note">
  876. <p class="first admonition-title">Note</p>
  877. <p class="last">Environment variables with empty values may not be passed to
  878. hooks on platforms such as Windows. As an example, <tt class="docutils literal">$HG_PARENT2</tt>
  879. will have an empty value under Unix-like platforms for non-merge
  880. changesets, while it will not be available at all under Windows.</p>
  881. </div>
  882. <p>The syntax for Python hooks is as follows:</p>
  883. <pre class="literal-block">
  884. hookname = python:modulename.submodule.callable
  885. hookname = python:/path/to/python/module.py:callable
  886. </pre>
  887. <p>Python hooks are run within the Mercurial process. Each hook is
  888. called with at least three keyword arguments: a ui object (keyword
  889. <tt class="docutils literal">ui</tt>), a repository object (keyword <tt class="docutils literal">repo</tt>), and a <tt class="docutils literal">hooktype</tt>
  890. keyword that tells what kind of hook is used. Arguments listed as
  891. environment variables above are passed as keyword arguments, with no
  892. <tt class="docutils literal">HG_</tt> prefix, and names in lower case.</p>
  893. <p>If a Python hook returns a &quot;true&quot; value or raises an exception, this
  894. is treated as a failure.</p>
  895. </div>
  896. <div class="section" id="hostfingerprints">
  897. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">hostfingerprints</tt></a></h2>
  898. <p>Fingerprints of the certificates of known HTTPS servers.
  899. A HTTPS connection to a server with a fingerprint configured here will
  900. only succeed if the servers certificate matches the fingerprint.
  901. This is very similar to how ssh known hosts works.
  902. The fingerprint is the SHA-1 hash value of the DER encoded certificate.
  903. The CA chain and web.cacerts is not used for servers with a fingerprint.</p>
  904. <p>For example:</p>
  905. <pre class="literal-block">
  906. [hostfingerprints]
  907. hg.intevation.org = fa:1f:d9:48:f1:e7:74:30:38:8d:d8:58:b6:94:b8:58:28:7d:8b:d0
  908. </pre>
  909. <p>This feature is only supported when using Python 2.6 or later.</p>
  910. </div>
  911. <div class="section" id="http-proxy">
  912. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">http_proxy</tt></a></h2>
  913. <p>Used to access web-based Mercurial repositories through a HTTP
  914. proxy.</p>
  915. <dl class="docutils">
  916. <dt><tt class="docutils literal">host</tt></dt>
  917. <dd>Host name and (optional) port of the proxy server, for example
  918. &quot;myproxy:8000&quot;.</dd>
  919. <dt><tt class="docutils literal">no</tt></dt>
  920. <dd>Optional. Comma-separated list of host names that should bypass
  921. the proxy.</dd>
  922. <dt><tt class="docutils literal">passwd</tt></dt>
  923. <dd>Optional. Password to authenticate with at the proxy server.</dd>
  924. <dt><tt class="docutils literal">user</tt></dt>
  925. <dd>Optional. User name to authenticate with at the proxy server.</dd>
  926. <dt><tt class="docutils literal">always</tt></dt>
  927. <dd>Optional. Always use the proxy, even for localhost and any entries
  928. in <tt class="docutils literal">http_proxy.no</tt>. True or False. Default: False.</dd>
  929. </dl>
  930. </div>
  931. <div class="section" id="merge-patterns">
  932. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">merge-patterns</span></tt></a></h2>
  933. <p>This section specifies merge tools to associate with particular file
  934. patterns. Tools matched here will take precedence over the default
  935. merge tool. Patterns are globs by default, rooted at the repository
  936. root.</p>
  937. <p>Example:</p>
  938. <pre class="literal-block">
  939. [merge-patterns]
  940. **.c = kdiff3
  941. **.jpg = myimgmerge
  942. </pre>
  943. </div>
  944. <div class="section" id="merge-tools">
  945. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">merge-tools</span></tt></a></h2>
  946. <p>This section configures external merge tools to use for file-level
  947. merges. This section has likely been preconfigured at install time.
  948. Use <a class="reference external" href="hg.1.html#config"><tt class="docutils literal">hg config <span class="pre">merge-tools</span></tt></a> to check the existing configuration.
  949. Also see <a class="reference external" href="hg.1.html#merge-tools"><tt class="docutils literal">hg help <span class="pre">merge-tools</span></tt></a> for more details.</p>
  950. <p>Example <tt class="docutils literal"><span class="pre">~/.hgrc</span></tt>:</p>
  951. <pre class="literal-block">
  952. [merge-tools]
  953. # Override stock tool location
  954. kdiff3.executable = ~/bin/kdiff3
  955. # Specify command line
  956. kdiff3.args = $base $local $other -o $output
  957. # Give higher priority
  958. kdiff3.priority = 1
  959.  
  960. # Changing the priority of preconfigured tool
  961. vimdiff.priority = 0
  962.  
  963. # Define new tool
  964. myHtmlTool.args = -m $local $other $base $output
  965. myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
  966. myHtmlTool.priority = 1
  967. </pre>
  968. <p>Supported arguments:</p>
  969. <dl class="docutils">
  970. <dt><tt class="docutils literal">priority</tt></dt>
  971. <dd>The priority in which to evaluate this tool.
  972. Default: 0.</dd>
  973. <dt><tt class="docutils literal">executable</tt></dt>
  974. <dd>Either just the name of the executable or its pathname.  On Windows,
  975. the path can use environment variables with ${ProgramFiles} syntax.
  976. Default: the tool name.</dd>
  977. <dt><tt class="docutils literal">args</tt></dt>
  978. <dd>The arguments to pass to the tool executable. You can refer to the
  979. files being merged as well as the output file through these
  980. variables: <tt class="docutils literal">$base</tt>, <tt class="docutils literal">$local</tt>, <tt class="docutils literal">$other</tt>, <tt class="docutils literal">$output</tt>. The meaning
  981. of <tt class="docutils literal">$local</tt> and <tt class="docutils literal">$other</tt> can vary depending on which action is being
  982. performed. During and update or merge, <tt class="docutils literal">$local</tt> represents the original
  983. state of the file, while <tt class="docutils literal">$other</tt> represents the commit you are updating
  984. to or the commit you are merging with. During a rebase <tt class="docutils literal">$local</tt>
  985. represents the destination of the rebase, and <tt class="docutils literal">$other</tt> represents the
  986. commit being rebased.
  987. Default: <tt class="docutils literal">$local $base $other</tt></dd>
  988. <dt><tt class="docutils literal">premerge</tt></dt>
  989. <dd>Attempt to run internal non-interactive 3-way merge tool before
  990. launching external tool.  Options are <tt class="docutils literal">true</tt>, <tt class="docutils literal">false</tt>, <tt class="docutils literal">keep</tt> or
  991. <tt class="docutils literal"><span class="pre">keep-merge3</span></tt>. The <tt class="docutils literal">keep</tt> option will leave markers in the file if the
  992. premerge fails. The <tt class="docutils literal"><span class="pre">keep-merge3</span></tt> will do the same but include information
  993. about the base of the merge in the marker (see internal :merge3 in
  994. <a class="reference external" href="hg.1.html#merge-tools"><tt class="docutils literal">hg help <span class="pre">merge-tools</span></tt></a>).
  995. Default: True</dd>
  996. <dt><tt class="docutils literal">binary</tt></dt>
  997. <dd>This tool can merge binary files. Defaults to False, unless tool
  998. was selected by file pattern match.</dd>
  999. <dt><tt class="docutils literal">symlink</tt></dt>
  1000. <dd>This tool can merge symlinks. Defaults to False, even if tool was
  1001. selected by file pattern match.</dd>
  1002. <dt><tt class="docutils literal">check</tt></dt>
  1003. <dd><p class="first">A list of merge success-checking options:</p>
  1004. <dl class="last docutils">
  1005. <dt><tt class="docutils literal">changed</tt></dt>
  1006. <dd>Ask whether merge was successful when the merged file shows no changes.</dd>
  1007. <dt><tt class="docutils literal">conflicts</tt></dt>
  1008. <dd>Check whether there are conflicts even though the tool reported success.</dd>
  1009. <dt><tt class="docutils literal">prompt</tt></dt>
  1010. <dd>Always prompt for merge success, regardless of success reported by tool.</dd>
  1011. </dl>
  1012. </dd>
  1013. <dt><tt class="docutils literal">fixeol</tt></dt>
  1014. <dd>Attempt to fix up EOL changes caused by the merge tool.
  1015. Default: False</dd>
  1016. <dt><tt class="docutils literal">gui</tt></dt>
  1017. <dd>This tool requires a graphical interface to run. Default: False</dd>
  1018. <dt><tt class="docutils literal">regkey</tt></dt>
  1019. <dd>Windows registry key which describes install location of this
  1020. tool. Mercurial will search for this key first under
  1021. <tt class="docutils literal">HKEY_CURRENT_USER</tt> and then under <tt class="docutils literal">HKEY_LOCAL_MACHINE</tt>.
  1022. Default: None</dd>
  1023. <dt><tt class="docutils literal">regkeyalt</tt></dt>
  1024. <dd>An alternate Windows registry key to try if the first key is not
  1025. found.  The alternate key uses the same <tt class="docutils literal">regname</tt> and <tt class="docutils literal">regappend</tt>
  1026. semantics of the primary key.  The most common use for this key
  1027. is to search for 32bit applications on 64bit operating systems.
  1028. Default: None</dd>
  1029. <dt><tt class="docutils literal">regname</tt></dt>
  1030. <dd>Name of value to read from specified registry key. Defaults to the
  1031. unnamed (default) value.</dd>
  1032. <dt><tt class="docutils literal">regappend</tt></dt>
  1033. <dd>String to append to the value read from the registry, typically
  1034. the executable name of the tool.
  1035. Default: None</dd>
  1036. </dl>
  1037. </div>
  1038. <div class="section" id="patch">
  1039. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">patch</tt></a></h2>
  1040. <p>Settings used when applying patches, for instance through the 'import'
  1041. command or with Mercurial Queues extension.</p>
  1042. <dl class="docutils">
  1043. <dt><tt class="docutils literal">eol</tt></dt>
  1044. <dd>When set to 'strict' patch content and patched files end of lines
  1045. are preserved. When set to <tt class="docutils literal">lf</tt> or <tt class="docutils literal">crlf</tt>, both files end of
  1046. lines are ignored when patching and the result line endings are
  1047. normalized to either LF (Unix) or CRLF (Windows). When set to
  1048. <tt class="docutils literal">auto</tt>, end of lines are again ignored while patching but line
  1049. endings in patched files are normalized to their original setting
  1050. on a per-file basis. If target file does not exist or has no end
  1051. of line, patch line endings are preserved.
  1052. Default: strict.</dd>
  1053. <dt><tt class="docutils literal">fuzz</tt></dt>
  1054. <dd>The number of lines of 'fuzz' to allow when applying patches. This
  1055. controls how much context the patcher is allowed to ignore when
  1056. trying to apply a patch.
  1057. Default: 2</dd>
  1058. </dl>
  1059. </div>
  1060. <div class="section" id="paths">
  1061. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">paths</tt></a></h2>
  1062. <p>Assigns symbolic names to repositories. The left side is the
  1063. symbolic name, and the right gives the directory or URL that is the
  1064. location of the repository. Default paths can be declared by setting
  1065. the following entries.</p>
  1066. <dl class="docutils">
  1067. <dt><tt class="docutils literal">default</tt></dt>
  1068. <dd>Directory or URL to use when pulling if no source is specified.
  1069. Default is set to repository from which the current repository was
  1070. cloned.</dd>
  1071. <dt><tt class="docutils literal"><span class="pre">default-push</span></tt></dt>
  1072. <dd>Optional. Directory or URL to use when pushing if no destination
  1073. is specified.</dd>
  1074. </dl>
  1075. <p>Custom paths can be defined by assigning the path to a name that later can be
  1076. used from the command line. Example:</p>
  1077. <pre class="literal-block">
  1078. [paths]
  1079. my_path = http://example.com/path
  1080. </pre>
  1081. <p>To push to the path defined in <tt class="docutils literal">my_path</tt> run the command:</p>
  1082. <pre class="literal-block">
  1083. hg push my_path
  1084. </pre>
  1085. </div>
  1086. <div class="section" id="phases">
  1087. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">phases</tt></a></h2>
  1088. <p>Specifies default handling of phases. See <a class="reference external" href="hg.1.html#phases"><tt class="docutils literal">hg help phases</tt></a> for more
  1089. information about working with phases.</p>
  1090. <dl class="docutils">
  1091. <dt><tt class="docutils literal">publish</tt></dt>
  1092. <dd>Controls draft phase behavior when working as a server. When true,
  1093. pushed changesets are set to public in both client and server and
  1094. pulled or cloned changesets are set to public in the client.
  1095. Default: True</dd>
  1096. <dt><tt class="docutils literal"><span class="pre">new-commit</span></tt></dt>
  1097. <dd>Phase of newly-created commits.
  1098. Default: draft</dd>
  1099. <dt><tt class="docutils literal">checksubrepos</tt></dt>
  1100. <dd>Check the phase of the current revision of each subrepository. Allowed
  1101. values are &quot;ignore&quot;, &quot;follow&quot; and &quot;abort&quot;. For settings other than
  1102. &quot;ignore&quot;, the phase of the current revision of each subrepository is
  1103. checked before committing the parent repository. If any of those phases is
  1104. greater than the phase of the parent repository (e.g. if a subrepo is in a
  1105. &quot;secret&quot; phase while the parent repo is in &quot;draft&quot; phase), the commit is
  1106. either aborted (if checksubrepos is set to &quot;abort&quot;) or the higher phase is
  1107. used for the parent repository commit (if set to &quot;follow&quot;).
  1108. Default: &quot;follow&quot;</dd>
  1109. </dl>
  1110. </div>
  1111. <div class="section" id="profiling">
  1112. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">profiling</tt></a></h2>
  1113. <p>Specifies profiling type, format, and file output. Two profilers are
  1114. supported: an instrumenting profiler (named <tt class="docutils literal">ls</tt>), and a sampling
  1115. profiler (named <tt class="docutils literal">stat</tt>).</p>
  1116. <p>In this section description, 'profiling data' stands for the raw data
  1117. collected during profiling, while 'profiling report' stands for a
  1118. statistical text report generated from the profiling data. The
  1119. profiling is done using lsprof.</p>
  1120. <dl class="docutils">
  1121. <dt><tt class="docutils literal">type</tt></dt>
  1122. <dd><p class="first">The type of profiler to use.
  1123. Default: ls.</p>
  1124. <dl class="last docutils">
  1125. <dt><tt class="docutils literal">ls</tt></dt>
  1126. <dd>Use Python's built-in instrumenting profiler. This profiler
  1127. works on all platforms, but each line number it reports is the
  1128. first line of a function. This restriction makes it difficult to
  1129. identify the expensive parts of a non-trivial function.</dd>
  1130. <dt><tt class="docutils literal">stat</tt></dt>
  1131. <dd>Use a third-party statistical profiler, statprof. This profiler
  1132. currently runs only on Unix systems, and is most useful for
  1133. profiling commands that run for longer than about 0.1 seconds.</dd>
  1134. </dl>
  1135. </dd>
  1136. <dt><tt class="docutils literal">format</tt></dt>
  1137. <dd><p class="first">Profiling format.  Specific to the <tt class="docutils literal">ls</tt> instrumenting profiler.
  1138. Default: text.</p>
  1139. <dl class="last docutils">
  1140. <dt><tt class="docutils literal">text</tt></dt>
  1141. <dd>Generate a profiling report. When saving to a file, it should be
  1142. noted that only the report is saved, and the profiling data is
  1143. not kept.</dd>
  1144. <dt><tt class="docutils literal">kcachegrind</tt></dt>
  1145. <dd>Format profiling data for kcachegrind use: when saving to a
  1146. file, the generated file can directly be loaded into
  1147. kcachegrind.</dd>
  1148. </dl>
  1149. </dd>
  1150. <dt><tt class="docutils literal">frequency</tt></dt>
  1151. <dd>Sampling frequency.  Specific to the <tt class="docutils literal">stat</tt> sampling profiler.
  1152. Default: 1000.</dd>
  1153. <dt><tt class="docutils literal">output</tt></dt>
  1154. <dd>File path where profiling data or report should be saved. If the
  1155. file exists, it is replaced. Default: None, data is printed on
  1156. stderr</dd>
  1157. <dt><tt class="docutils literal">sort</tt></dt>
  1158. <dd>Sort field.  Specific to the <tt class="docutils literal">ls</tt> instrumenting profiler.
  1159. One of <tt class="docutils literal">callcount</tt>, <tt class="docutils literal">reccallcount</tt>, <tt class="docutils literal">totaltime</tt> and
  1160. <tt class="docutils literal">inlinetime</tt>.
  1161. Default: inlinetime.</dd>
  1162. <dt><tt class="docutils literal">limit</tt></dt>
  1163. <dd>Number of lines to show. Specific to the <tt class="docutils literal">ls</tt> instrumenting profiler.
  1164. Default: 30.</dd>
  1165. <dt><tt class="docutils literal">nested</tt></dt>
  1166. <dd>Show at most this number of lines of drill-down info after each main entry.
  1167. This can help explain the difference between Total and Inline.
  1168. Specific to the <tt class="docutils literal">ls</tt> instrumenting profiler.
  1169. Default: 5.</dd>
  1170. </dl>
  1171. </div>
  1172. <div class="section" id="progress">
  1173. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">progress</tt></a></h2>
  1174. <p>Mercurial commands can draw progress bars that are as informative as
  1175. possible. Some progress bars only offer indeterminate information, while others
  1176. have a definite end point.</p>
  1177. <dl class="docutils">
  1178. <dt><tt class="docutils literal">delay</tt></dt>
  1179. <dd>Number of seconds (float) before showing the progress bar. (default: 3)</dd>
  1180. <dt><tt class="docutils literal">changedelay</tt></dt>
  1181. <dd>Minimum delay before showing a new topic. When set to less than 3 * refresh,
  1182. that value will be used instead. (default: 1)</dd>
  1183. <dt><tt class="docutils literal">refresh</tt></dt>
  1184. <dd>Time in seconds between refreshes of the progress bar. (default: 0.1)</dd>
  1185. <dt><tt class="docutils literal">format</tt></dt>
  1186. <dd><p class="first">Format of the progress bar.</p>
  1187. <p>Valid entries for the format field are <tt class="docutils literal">topic</tt>, <tt class="docutils literal">bar</tt>, <tt class="docutils literal">number</tt>,
  1188. <tt class="docutils literal">unit</tt>, <tt class="docutils literal">estimate</tt>, speed, and item. item defaults to the last 20
  1189. characters of the item, but this can be changed by adding either <tt class="docutils literal"><span class="pre">-&lt;num&gt;</span></tt>
  1190. which would take the last num characters, or <tt class="docutils literal">+&lt;num&gt;</tt> for the first num
  1191. characters.</p>
  1192. <p class="last">(default: Topic bar number estimate)</p>
  1193. </dd>
  1194. <dt><tt class="docutils literal">width</tt></dt>
  1195. <dd>If set, the maximum width of the progress information (that is, min(width,
  1196. term width) will be used)</dd>
  1197. <dt><tt class="docutils literal"><span class="pre">clear-complete</span></tt></dt>
  1198. <dd>clear the progress bar after it's done (default to True)</dd>
  1199. <dt><tt class="docutils literal">disable</tt></dt>
  1200. <dd>If true, don't show a progress bar</dd>
  1201. <dt><tt class="docutils literal"><span class="pre">assume-tty</span></tt></dt>
  1202. <dd>If true, ALWAYS show a progress bar, unless disable is given</dd>
  1203. </dl>
  1204. </div>
  1205. <div class="section" id="revsetalias">
  1206. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">revsetalias</tt></a></h2>
  1207. <p>Alias definitions for revsets. See <a class="reference external" href="hg.1.html#revsets"><tt class="docutils literal">hg help revsets</tt></a> for details.</p>
  1208. </div>
  1209. <div class="section" id="server">
  1210. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">server</tt></a></h2>
  1211. <p>Controls generic server settings.</p>
  1212. <dl class="docutils">
  1213. <dt><tt class="docutils literal">uncompressed</tt></dt>
  1214. <dd>Whether to allow clients to clone a repository using the
  1215. uncompressed streaming protocol. This transfers about 40% more
  1216. data than a regular clone, but uses less memory and CPU on both
  1217. server and client. Over a LAN (100 Mbps or better) or a very fast
  1218. WAN, an uncompressed streaming clone is a lot faster (~10x) than a
  1219. regular clone. Over most WAN connections (anything slower than
  1220. about 6 Mbps), uncompressed streaming is slower, because of the
  1221. extra data transfer overhead. This mode will also temporarily hold
  1222. the write lock while determining what data to transfer.
  1223. Default is True.</dd>
  1224. <dt><tt class="docutils literal">preferuncompressed</tt></dt>
  1225. <dd>When set, clients will try to use the uncompressed streaming
  1226. protocol. Default is False.</dd>
  1227. <dt><tt class="docutils literal">validate</tt></dt>
  1228. <dd>Whether to validate the completeness of pushed changesets by
  1229. checking that all new file revisions specified in manifests are
  1230. present. Default is False.</dd>
  1231. <dt><tt class="docutils literal">maxhttpheaderlen</tt></dt>
  1232. <dd>Instruct HTTP clients not to send request headers longer than this
  1233. many bytes. Default is 1024.</dd>
  1234. </dl>
  1235. </div>
  1236. <div class="section" id="smtp">
  1237. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">smtp</tt></a></h2>
  1238. <p>Configuration for extensions that need to send email messages.</p>
  1239. <dl class="docutils">
  1240. <dt><tt class="docutils literal">host</tt></dt>
  1241. <dd>Host name of mail server, e.g. &quot;mail.example.com&quot;.</dd>
  1242. <dt><tt class="docutils literal">port</tt></dt>
  1243. <dd>Optional. Port to connect to on mail server. Default: 465 (if
  1244. <tt class="docutils literal">tls</tt> is smtps) or 25 (otherwise).</dd>
  1245. <dt><tt class="docutils literal">tls</tt></dt>
  1246. <dd>Optional. Method to enable TLS when connecting to mail server: starttls,
  1247. smtps or none. Default: none.</dd>
  1248. <dt><tt class="docutils literal">verifycert</tt></dt>
  1249. <dd>Optional. Verification for the certificate of mail server, when
  1250. <tt class="docutils literal">tls</tt> is starttls or smtps. &quot;strict&quot;, &quot;loose&quot; or False. For
  1251. &quot;strict&quot; or &quot;loose&quot;, the certificate is verified as same as the
  1252. verification for HTTPS connections (see <tt class="docutils literal">[hostfingerprints]</tt> and
  1253. <tt class="docutils literal">[web] cacerts</tt> also). For &quot;strict&quot;, sending email is also
  1254. aborted, if there is no configuration for mail server in
  1255. <tt class="docutils literal">[hostfingerprints]</tt> and <tt class="docutils literal">[web] cacerts</tt>.  --insecure for
  1256. <a class="reference external" href="hg.1.html#email"><tt class="docutils literal">hg email</tt></a> overwrites this as &quot;loose&quot;. Default: &quot;strict&quot;.</dd>
  1257. <dt><tt class="docutils literal">username</tt></dt>
  1258. <dd>Optional. User name for authenticating with the SMTP server.
  1259. Default: none.</dd>
  1260. <dt><tt class="docutils literal">password</tt></dt>
  1261. <dd>Optional. Password for authenticating with the SMTP server. If not
  1262. specified, interactive sessions will prompt the user for a
  1263. password; non-interactive sessions will fail. Default: none.</dd>
  1264. <dt><tt class="docutils literal">local_hostname</tt></dt>
  1265. <dd>Optional. It's the hostname that the sender can use to identify
  1266. itself to the MTA.</dd>
  1267. </dl>
  1268. </div>
  1269. <div class="section" id="subpaths">
  1270. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">subpaths</tt></a></h2>
  1271. <p>Subrepository source URLs can go stale if a remote server changes name
  1272. or becomes temporarily unavailable. This section lets you define
  1273. rewrite rules of the form:</p>
  1274. <pre class="literal-block">
  1275. &lt;pattern&gt; = &lt;replacement&gt;
  1276. </pre>
  1277. <p>where <tt class="docutils literal">pattern</tt> is a regular expression matching a subrepository
  1278. source URL and <tt class="docutils literal">replacement</tt> is the replacement string used to
  1279. rewrite it. Groups can be matched in <tt class="docutils literal">pattern</tt> and referenced in
  1280. <tt class="docutils literal">replacements</tt>. For instance:</p>
  1281. <pre class="literal-block">
  1282. http://server/(.*)-hg/ = http://hg.server/\1/
  1283. </pre>
  1284. <p>rewrites <tt class="docutils literal"><span class="pre">http://server/foo-hg/</span></tt> into <tt class="docutils literal"><span class="pre">http://hg.server/foo/</span></tt>.</p>
  1285. <p>Relative subrepository paths are first made absolute, and the
  1286. rewrite rules are then applied on the full (absolute) path. The rules
  1287. are applied in definition order.</p>
  1288. </div>
  1289. <div class="section" id="trusted">
  1290. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">trusted</tt></a></h2>
  1291. <p>Mercurial will not use the settings in the
  1292. <tt class="docutils literal">.hg/hgrc</tt> file from a repository if it doesn't belong to a trusted
  1293. user or to a trusted group, as various hgrc features allow arbitrary
  1294. commands to be run. This issue is often encountered when configuring
  1295. hooks or extensions for shared repositories or servers. However,
  1296. the web interface will use some safe settings from the <tt class="docutils literal">[web]</tt>
  1297. section.</p>
  1298. <p>This section specifies what users and groups are trusted. The
  1299. current user is always trusted. To trust everybody, list a user or a
  1300. group with name <tt class="docutils literal">*</tt>. These settings must be placed in an
  1301. <em>already-trusted file</em> to take effect, such as <tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt> of the
  1302. user or service running Mercurial.</p>
  1303. <dl class="docutils">
  1304. <dt><tt class="docutils literal">users</tt></dt>
  1305. <dd>Comma-separated list of trusted users.</dd>
  1306. <dt><tt class="docutils literal">groups</tt></dt>
  1307. <dd>Comma-separated list of trusted groups.</dd>
  1308. </dl>
  1309. </div>
  1310. <div class="section" id="ui">
  1311. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">ui</tt></a></h2>
  1312. <p>User interface controls.</p>
  1313. <dl class="docutils">
  1314. <dt><tt class="docutils literal">archivemeta</tt></dt>
  1315. <dd>Whether to include the .hg_archival.txt file containing meta data
  1316. (hashes for the repository base and for tip) in archives created
  1317. by the <a class="reference external" href="hg.1.html#archive"><tt class="docutils literal">hg archive</tt></a> command or downloaded via hgweb.
  1318. Default is True.</dd>
  1319. <dt><tt class="docutils literal">askusername</tt></dt>
  1320. <dd>Whether to prompt for a username when committing. If True, and
  1321. neither <tt class="docutils literal">$HGUSER</tt> nor <tt class="docutils literal">$EMAIL</tt> has been specified, then the user will
  1322. be prompted to enter a username. If no username is entered, the
  1323. default <tt class="docutils literal">USER&#64;HOST</tt> is used instead.
  1324. Default is False.</dd>
  1325. <dt><tt class="docutils literal">commitsubrepos</tt></dt>
  1326. <dd>Whether to commit modified subrepositories when committing the
  1327. parent repository. If False and one subrepository has uncommitted
  1328. changes, abort the commit.
  1329. Default is False.</dd>
  1330. <dt><tt class="docutils literal">debug</tt></dt>
  1331. <dd>Print debugging information. True or False. Default is False.</dd>
  1332. <dt><tt class="docutils literal">editor</tt></dt>
  1333. <dd>The editor to use during a commit. Default is <tt class="docutils literal">$EDITOR</tt> or <tt class="docutils literal">vi</tt>.</dd>
  1334. <dt><tt class="docutils literal">fallbackencoding</tt></dt>
  1335. <dd>Encoding to try if it's not possible to decode the changelog using
  1336. UTF-8. Default is ISO-8859-1.</dd>
  1337. <dt><tt class="docutils literal">ignore</tt></dt>
  1338. <dd>A file to read per-user ignore patterns from. This file should be
  1339. in the same format as a repository-wide .hgignore file. Filenames
  1340. are relative to the repository root. This option supports hook syntax,
  1341. so if you want to specify multiple ignore files, you can do so by
  1342. setting something like <tt class="docutils literal">ignore.other = <span class="pre">~/.hgignore2</span></tt>. For details
  1343. of the ignore file format, see the <tt class="docutils literal">hgignore(5)</tt> man page.</dd>
  1344. <dt><tt class="docutils literal">interactive</tt></dt>
  1345. <dd>Allow to prompt the user. True or False. Default is True.</dd>
  1346. <dt><tt class="docutils literal">logtemplate</tt></dt>
  1347. <dd>Template string for commands that print changesets.</dd>
  1348. <dt><tt class="docutils literal">merge</tt></dt>
  1349. <dd>The conflict resolution program to use during a manual merge.
  1350. For more information on merge tools see <a class="reference external" href="hg.1.html#merge-tools"><tt class="docutils literal">hg help <span class="pre">merge-tools</span></tt></a>.
  1351. For configuring merge tools see the <tt class="docutils literal"><span class="pre">[merge-tools]</span></tt> section.</dd>
  1352. <dt><tt class="docutils literal">mergemarkers</tt></dt>
  1353. <dd>Sets the merge conflict marker label styling. The <tt class="docutils literal">detailed</tt>
  1354. style uses the <tt class="docutils literal">mergemarkertemplate</tt> setting to style the labels.
  1355. The <tt class="docutils literal">basic</tt> style just uses 'local' and 'other' as the marker label.
  1356. One of <tt class="docutils literal">basic</tt> or <tt class="docutils literal">detailed</tt>.
  1357. Default is <tt class="docutils literal">basic</tt>.</dd>
  1358. <dt><tt class="docutils literal">mergemarkertemplate</tt></dt>
  1359. <dd>The template used to print the commit description next to each conflict
  1360. marker during merge conflicts. See <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a> for the template
  1361. format.
  1362. Defaults to showing the hash, tags, branches, bookmarks, author, and
  1363. the first line of the commit description.
  1364. If you use non-ASCII characters in names for tags, branches, bookmarks,
  1365. authors, and/or commit descriptions, you must pay attention to encodings of
  1366. managed files. At template expansion, non-ASCII characters use the encoding
  1367. specified by the <tt class="docutils literal"><span class="pre">--encoding</span></tt> global option, <tt class="docutils literal">HGENCODING</tt> or other
  1368. environment variables that govern your locale. If the encoding of the merge
  1369. markers is different from the encoding of the merged files,
  1370. serious problems may occur.</dd>
  1371. <dt><tt class="docutils literal">patch</tt></dt>
  1372. <dd><p class="first">An optional external tool that <tt class="docutils literal">hg import</tt> and some extensions
  1373. will use for applying patches. By default Mercurial uses an
  1374. internal patch utility. The external tool must work as the common
  1375. Unix <tt class="docutils literal">patch</tt> program. In particular, it must accept a <tt class="docutils literal"><span class="pre">-p</span></tt>
  1376. argument to strip patch headers, a <tt class="docutils literal"><span class="pre">-d</span></tt> argument to specify the
  1377. current directory, a file name to patch, and a patch file to take
  1378. from stdin.</p>
  1379. <p class="last">It is possible to specify a patch tool together with extra
  1380. arguments. For example, setting this option to <tt class="docutils literal">patch <span class="pre">--merge</span></tt>
  1381. will use the <tt class="docutils literal">patch</tt> program with its 2-way merge option.</p>
  1382. </dd>
  1383. <dt><tt class="docutils literal">portablefilenames</tt></dt>
  1384. <dd>Check for portable filenames. Can be <tt class="docutils literal">warn</tt>, <tt class="docutils literal">ignore</tt> or <tt class="docutils literal">abort</tt>.
  1385. Default is <tt class="docutils literal">warn</tt>.
  1386. If set to <tt class="docutils literal">warn</tt> (or <tt class="docutils literal">true</tt>), a warning message is printed on POSIX
  1387. platforms, if a file with a non-portable filename is added (e.g. a file
  1388. with a name that can't be created on Windows because it contains reserved
  1389. parts like <tt class="docutils literal">AUX</tt>, reserved characters like <tt class="docutils literal">:</tt>, or would cause a case
  1390. collision with an existing file).
  1391. If set to <tt class="docutils literal">ignore</tt> (or <tt class="docutils literal">false</tt>), no warning is printed.
  1392. If set to <tt class="docutils literal">abort</tt>, the command is aborted.
  1393. On Windows, this configuration option is ignored and the command aborted.</dd>
  1394. <dt><tt class="docutils literal">quiet</tt></dt>
  1395. <dd>Reduce the amount of output printed. True or False. Default is False.</dd>
  1396. <dt><tt class="docutils literal">remotecmd</tt></dt>
  1397. <dd>remote command to use for clone/push/pull operations. Default is <tt class="docutils literal">hg</tt>.</dd>
  1398. <dt><tt class="docutils literal">report_untrusted</tt></dt>
  1399. <dd>Warn if a <tt class="docutils literal">.hg/hgrc</tt> file is ignored due to not being owned by a
  1400. trusted user or group. True or False. Default is True.</dd>
  1401. <dt><tt class="docutils literal">slash</tt></dt>
  1402. <dd>Display paths using a slash (<tt class="docutils literal">/</tt>) as the path separator. This
  1403. only makes a difference on systems where the default path
  1404. separator is not the slash character (e.g. Windows uses the
  1405. backslash character (<tt class="docutils literal">\</tt>)).
  1406. Default is False.</dd>
  1407. <dt><tt class="docutils literal">statuscopies</tt></dt>
  1408. <dd>Display copies in the status command.</dd>
  1409. <dt><tt class="docutils literal">ssh</tt></dt>
  1410. <dd>command to use for SSH connections. Default is <tt class="docutils literal">ssh</tt>.</dd>
  1411. <dt><tt class="docutils literal">strict</tt></dt>
  1412. <dd>Require exact command names, instead of allowing unambiguous
  1413. abbreviations. True or False. Default is False.</dd>
  1414. <dt><tt class="docutils literal">style</tt></dt>
  1415. <dd>Name of style to use for command output.</dd>
  1416. <dt><tt class="docutils literal">timeout</tt></dt>
  1417. <dd>The timeout used when a lock is held (in seconds), a negative value
  1418. means no timeout. Default is 600.</dd>
  1419. <dt><tt class="docutils literal">traceback</tt></dt>
  1420. <dd>Mercurial always prints a traceback when an unknown exception
  1421. occurs. Setting this to True will make Mercurial print a traceback
  1422. on all exceptions, even those recognized by Mercurial (such as
  1423. IOError or MemoryError). Default is False.</dd>
  1424. <dt><tt class="docutils literal">username</tt></dt>
  1425. <dd>The committer of a changeset created when running &quot;commit&quot;.
  1426. Typically a person's name and email address, e.g. <tt class="docutils literal">Fred Widget
  1427. &lt;fred&#64;example.com&gt;</tt>. Default is <tt class="docutils literal">$EMAIL</tt> or <tt class="docutils literal">username&#64;hostname</tt>. If
  1428. the username in hgrc is empty, it has to be specified manually or
  1429. in a different hgrc file (e.g. <tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt>, if the admin set
  1430. <tt class="docutils literal">username =</tt>  in the system hgrc). Environment variables in the
  1431. username are expanded.</dd>
  1432. <dt><tt class="docutils literal">verbose</tt></dt>
  1433. <dd>Increase the amount of output printed. True or False. Default is False.</dd>
  1434. </dl>
  1435. </div>
  1436. <div class="section" id="web">
  1437. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">web</tt></a></h2>
  1438. <p>Web interface configuration. The settings in this section apply to
  1439. both the builtin webserver (started by <a class="reference external" href="hg.1.html#serve"><tt class="docutils literal">hg serve</tt></a>) and the script you
  1440. run through a webserver (<tt class="docutils literal">hgweb.cgi</tt> and the derivatives for FastCGI
  1441. and WSGI).</p>
  1442. <p>The Mercurial webserver does no authentication (it does not prompt for
  1443. usernames and passwords to validate <em>who</em> users are), but it does do
  1444. authorization (it grants or denies access for <em>authenticated users</em>
  1445. based on settings in this section). You must either configure your
  1446. webserver to do authentication for you, or disable the authorization
  1447. checks.</p>
  1448. <p>For a quick setup in a trusted environment, e.g., a private LAN, where
  1449. you want it to accept pushes from anybody, you can use the following
  1450. command line:</p>
  1451. <pre class="literal-block">
  1452. $ hg --config web.allow_push=* --config web.push_ssl=False serve
  1453. </pre>
  1454. <p>Note that this will allow anybody to push anything to the server and
  1455. that this should not be used for public servers.</p>
  1456. <p>The full set of options is:</p>
  1457. <dl class="docutils">
  1458. <dt><tt class="docutils literal">accesslog</tt></dt>
  1459. <dd>Where to output the access log. Default is stdout.</dd>
  1460. <dt><tt class="docutils literal">address</tt></dt>
  1461. <dd>Interface address to bind to. Default is all.</dd>
  1462. <dt><tt class="docutils literal">allow_archive</tt></dt>
  1463. <dd>List of archive format (bz2, gz, zip) allowed for downloading.
  1464. Default is empty.</dd>
  1465. <dt><tt class="docutils literal">allowbz2</tt></dt>
  1466. <dd>(DEPRECATED) Whether to allow .tar.bz2 downloading of repository
  1467. revisions.
  1468. Default is False.</dd>
  1469. <dt><tt class="docutils literal">allowgz</tt></dt>
  1470. <dd>(DEPRECATED) Whether to allow .tar.gz downloading of repository
  1471. revisions.
  1472. Default is False.</dd>
  1473. <dt><tt class="docutils literal">allowpull</tt></dt>
  1474. <dd>Whether to allow pulling from the repository. Default is True.</dd>
  1475. <dt><tt class="docutils literal">allow_push</tt></dt>
  1476. <dd>Whether to allow pushing to the repository. If empty or not set,
  1477. push is not allowed. If the special value <tt class="docutils literal">*</tt>, any remote user can
  1478. push, including unauthenticated users. Otherwise, the remote user
  1479. must have been authenticated, and the authenticated user name must
  1480. be present in this list. The contents of the allow_push list are
  1481. examined after the deny_push list.</dd>
  1482. <dt><tt class="docutils literal">allow_read</tt></dt>
  1483. <dd>If the user has not already been denied repository access due to
  1484. the contents of deny_read, this list determines whether to grant
  1485. repository access to the user. If this list is not empty, and the
  1486. user is unauthenticated or not present in the list, then access is
  1487. denied for the user. If the list is empty or not set, then access
  1488. is permitted to all users by default. Setting allow_read to the
  1489. special value <tt class="docutils literal">*</tt> is equivalent to it not being set (i.e. access
  1490. is permitted to all users). The contents of the allow_read list are
  1491. examined after the deny_read list.</dd>
  1492. <dt><tt class="docutils literal">allowzip</tt></dt>
  1493. <dd>(DEPRECATED) Whether to allow .zip downloading of repository
  1494. revisions. Default is False. This feature creates temporary files.</dd>
  1495. <dt><tt class="docutils literal">archivesubrepos</tt></dt>
  1496. <dd>Whether to recurse into subrepositories when archiving. Default is
  1497. False.</dd>
  1498. <dt><tt class="docutils literal">baseurl</tt></dt>
  1499. <dd>Base URL to use when publishing URLs in other locations, so
  1500. third-party tools like email notification hooks can construct
  1501. URLs. Example: <tt class="docutils literal"><span class="pre">http://hgserver/repos/</span></tt>.</dd>
  1502. <dt><tt class="docutils literal">cacerts</tt></dt>
  1503. <dd><p class="first">Path to file containing a list of PEM encoded certificate
  1504. authority certificates. Environment variables and <tt class="docutils literal">~user</tt>
  1505. constructs are expanded in the filename. If specified on the
  1506. client, then it will verify the identity of remote HTTPS servers
  1507. with these certificates.</p>
  1508. <p>This feature is only supported when using Python 2.6 or later. If you wish
  1509. to use it with earlier versions of Python, install the backported
  1510. version of the ssl library that is available from
  1511. <tt class="docutils literal"><span class="pre">http://pypi.python.org</span></tt>.</p>
  1512. <p>To disable SSL verification temporarily, specify <tt class="docutils literal"><span class="pre">--insecure</span></tt> from
  1513. command line.</p>
  1514. <p>You can use OpenSSL's CA certificate file if your platform has
  1515. one. On most Linux systems this will be
  1516. <tt class="docutils literal"><span class="pre">/etc/ssl/certs/ca-certificates.crt</span></tt>. Otherwise you will have to
  1517. generate this file manually. The form must be as follows:</p>
  1518. <pre class="last literal-block">
  1519. -----BEGIN CERTIFICATE-----
  1520. ... (certificate in base64 PEM encoding) ...
  1521. -----END CERTIFICATE-----
  1522. -----BEGIN CERTIFICATE-----
  1523. ... (certificate in base64 PEM encoding) ...
  1524. -----END CERTIFICATE-----
  1525. </pre>
  1526. </dd>
  1527. <dt><tt class="docutils literal">cache</tt></dt>
  1528. <dd>Whether to support caching in hgweb. Defaults to True.</dd>
  1529. <dt><tt class="docutils literal">certificate</tt></dt>
  1530. <dd>Certificate to use when running <a class="reference external" href="hg.1.html#serve"><tt class="docutils literal">hg serve</tt></a>.</dd>
  1531. <dt><tt class="docutils literal">collapse</tt></dt>
  1532. <dd>With <tt class="docutils literal">descend</tt> enabled, repositories in subdirectories are shown at
  1533. a single level alongside repositories in the current path. With
  1534. <tt class="docutils literal">collapse</tt> also enabled, repositories residing at a deeper level than
  1535. the current path are grouped behind navigable directory entries that
  1536. lead to the locations of these repositories. In effect, this setting
  1537. collapses each collection of repositories found within a subdirectory
  1538. into a single entry for that subdirectory. Default is False.</dd>
  1539. <dt><tt class="docutils literal">comparisoncontext</tt></dt>
  1540. <dd>Number of lines of context to show in side-by-side file comparison. If
  1541. negative or the value <tt class="docutils literal">full</tt>, whole files are shown. Default is 5.
  1542. This setting can be overridden by a <tt class="docutils literal">context</tt> request parameter to the
  1543. <tt class="docutils literal">comparison</tt> command, taking the same values.</dd>
  1544. <dt><tt class="docutils literal">contact</tt></dt>
  1545. <dd>Name or email address of the person in charge of the repository.
  1546. Defaults to ui.username or <tt class="docutils literal">$EMAIL</tt> or &quot;unknown&quot; if unset or empty.</dd>
  1547. <dt><tt class="docutils literal">deny_push</tt></dt>
  1548. <dd>Whether to deny pushing to the repository. If empty or not set,
  1549. push is not denied. If the special value <tt class="docutils literal">*</tt>, all remote users are
  1550. denied push. Otherwise, unauthenticated users are all denied, and
  1551. any authenticated user name present in this list is also denied. The
  1552. contents of the deny_push list are examined before the allow_push list.</dd>
  1553. <dt><tt class="docutils literal">deny_read</tt></dt>
  1554. <dd>Whether to deny reading/viewing of the repository. If this list is
  1555. not empty, unauthenticated users are all denied, and any
  1556. authenticated user name present in this list is also denied access to
  1557. the repository. If set to the special value <tt class="docutils literal">*</tt>, all remote users
  1558. are denied access (rarely needed ;). If deny_read is empty or not set,
  1559. the determination of repository access depends on the presence and
  1560. content of the allow_read list (see description). If both
  1561. deny_read and allow_read are empty or not set, then access is
  1562. permitted to all users by default. If the repository is being
  1563. served via hgwebdir, denied users will not be able to see it in
  1564. the list of repositories. The contents of the deny_read list have
  1565. priority over (are examined before) the contents of the allow_read
  1566. list.</dd>
  1567. <dt><tt class="docutils literal">descend</tt></dt>
  1568. <dd>hgwebdir indexes will not descend into subdirectories. Only repositories
  1569. directly in the current path will be shown (other repositories are still
  1570. available from the index corresponding to their containing path).</dd>
  1571. <dt><tt class="docutils literal">description</tt></dt>
  1572. <dd>Textual description of the repository's purpose or contents.
  1573. Default is &quot;unknown&quot;.</dd>
  1574. <dt><tt class="docutils literal">encoding</tt></dt>
  1575. <dd>Character encoding name. Default is the current locale charset.
  1576. Example: &quot;UTF-8&quot;</dd>
  1577. <dt><tt class="docutils literal">errorlog</tt></dt>
  1578. <dd>Where to output the error log. Default is stderr.</dd>
  1579. <dt><tt class="docutils literal">guessmime</tt></dt>
  1580. <dd>Control MIME types for raw download of file content.
  1581. Set to True to let hgweb guess the content type from the file
  1582. extension. This will serve HTML files as <tt class="docutils literal">text/html</tt> and might
  1583. allow cross-site scripting attacks when serving untrusted
  1584. repositories. Default is False.</dd>
  1585. <dt><tt class="docutils literal">hidden</tt></dt>
  1586. <dd>Whether to hide the repository in the hgwebdir index.
  1587. Default is False.</dd>
  1588. <dt><tt class="docutils literal">ipv6</tt></dt>
  1589. <dd>Whether to use IPv6. Default is False.</dd>
  1590. <dt><tt class="docutils literal">logoimg</tt></dt>
  1591. <dd>File name of the logo image that some templates display on each page.
  1592. The file name is relative to <tt class="docutils literal">staticurl</tt>. That is, the full path to
  1593. the logo image is &quot;staticurl/logoimg&quot;.
  1594. If unset, <tt class="docutils literal">hglogo.png</tt> will be used.</dd>
  1595. <dt><tt class="docutils literal">logourl</tt></dt>
  1596. <dd>Base URL to use for logos. If unset, <tt class="docutils literal"><span class="pre">http://mercurial.selenic.com/</span></tt>
  1597. will be used.</dd>
  1598. <dt><tt class="docutils literal">maxchanges</tt></dt>
  1599. <dd>Maximum number of changes to list on the changelog. Default is 10.</dd>
  1600. <dt><tt class="docutils literal">maxfiles</tt></dt>
  1601. <dd>Maximum number of files to list per changeset. Default is 10.</dd>
  1602. <dt><tt class="docutils literal">maxshortchanges</tt></dt>
  1603. <dd>Maximum number of changes to list on the shortlog, graph or filelog
  1604. pages. Default is 60.</dd>
  1605. <dt><tt class="docutils literal">name</tt></dt>
  1606. <dd>Repository name to use in the web interface. Default is current
  1607. working directory.</dd>
  1608. <dt><tt class="docutils literal">port</tt></dt>
  1609. <dd>Port to listen on. Default is 8000.</dd>
  1610. <dt><tt class="docutils literal">prefix</tt></dt>
  1611. <dd>Prefix path to serve from. Default is '' (server root).</dd>
  1612. <dt><tt class="docutils literal">push_ssl</tt></dt>
  1613. <dd>Whether to require that inbound pushes be transported over SSL to
  1614. prevent password sniffing. Default is True.</dd>
  1615. <dt><tt class="docutils literal">staticurl</tt></dt>
  1616. <dd>Base URL to use for static files. If unset, static files (e.g. the
  1617. hgicon.png favicon) will be served by the CGI script itself. Use
  1618. this setting to serve them directly with the HTTP server.
  1619. Example: <tt class="docutils literal"><span class="pre">http://hgserver/static/</span></tt>.</dd>
  1620. <dt><tt class="docutils literal">stripes</tt></dt>
  1621. <dd>How many lines a &quot;zebra stripe&quot; should span in multi-line output.
  1622. Default is 1; set to 0 to disable.</dd>
  1623. <dt><tt class="docutils literal">style</tt></dt>
  1624. <dd>Which template map style to use. The available options are the names of
  1625. subdirectories in the HTML templates path. Default is <tt class="docutils literal">paper</tt>.
  1626. Example: <tt class="docutils literal">monoblue</tt></dd>
  1627. <dt><tt class="docutils literal">templates</tt></dt>
  1628. <dd>Where to find the HTML templates. The default path to the HTML templates
  1629. can be obtained from <tt class="docutils literal">hg debuginstall</tt>.</dd>
  1630. </dl>
  1631. </div>
  1632. <div class="section" id="websub">
  1633. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">websub</tt></a></h2>
  1634. <p>Web substitution filter definition. You can use this section to
  1635. define a set of regular expression substitution patterns which
  1636. let you automatically modify the hgweb server output.</p>
  1637. <p>The default hgweb templates only apply these substitution patterns
  1638. on the revision description fields. You can apply them anywhere
  1639. you want when you create your own templates by adding calls to the
  1640. &quot;websub&quot; filter (usually after calling the &quot;escape&quot; filter).</p>
  1641. <p>This can be used, for example, to convert issue references to links
  1642. to your issue tracker, or to convert &quot;markdown-like&quot; syntax into
  1643. HTML (see the examples below).</p>
  1644. <p>Each entry in this section names a substitution filter.
  1645. The value of each entry defines the substitution expression itself.
  1646. The websub expressions follow the old interhg extension syntax,
  1647. which in turn imitates the Unix sed replacement syntax:</p>
  1648. <pre class="literal-block">
  1649. patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
  1650. </pre>
  1651. <p>You can use any separator other than &quot;/&quot;. The final &quot;i&quot; is optional
  1652. and indicates that the search must be case insensitive.</p>
  1653. <p>Examples:</p>
  1654. <pre class="literal-block">
  1655. [websub]
  1656. issues = s|issue(\d+)|&lt;a href=&quot;http://bts.example.org/issue\1&quot;&gt;issue\1&lt;/a&gt;|i
  1657. italic = s/\b_(\S+)_\b/&lt;i&gt;\1&lt;\/i&gt;/
  1658. bold = s/\*\b(\S+)\b\*/&lt;b&gt;\1&lt;\/b&gt;/
  1659. </pre>
  1660. </div>
  1661. <div class="section" id="worker">
  1662. <h2><a class="toc-backref" href="#contents"><tt class="docutils literal">worker</tt></a></h2>
  1663. <p>Parallel master/worker configuration. We currently perform working
  1664. directory updates in parallel on Unix-like systems, which greatly
  1665. helps performance.</p>
  1666. <dl class="docutils">
  1667. <dt><tt class="docutils literal">numcpus</tt></dt>
  1668. <dd>Number of CPUs to use for parallel operations. Default is 4 or the
  1669. number of CPUs on the system, whichever is larger. A zero or
  1670. negative value is treated as <tt class="docutils literal">use the default</tt>.</dd>
  1671. </dl>
  1672. </div>
  1673. </div>
  1674. <div class="section" id="author">
  1675. <h1><a class="toc-backref" href="#contents">Author</a></h1>
  1676. <p>Bryan O'Sullivan &lt;<a class="reference external" href="mailto:bos&#64;serpentine.com">bos&#64;serpentine.com</a>&gt;.</p>
  1677. <p>Mercurial was written by Matt Mackall &lt;<a class="reference external" href="mailto:mpm&#64;selenic.com">mpm&#64;selenic.com</a>&gt;.</p>
  1678. </div>
  1679. <div class="section" id="see-also">
  1680. <h1><a class="toc-backref" href="#contents">See Also</a></h1>
  1681. <p><a class="reference external" href="hg.1.html"><strong>hg</strong>(1)</a>, <a class="reference external" href="hgignore.5.html"><strong>hgignore</strong>(5)</a></p>
  1682. </div>
  1683. <div class="section" id="copying">
  1684. <h1><a class="toc-backref" href="#contents">Copying</a></h1>
  1685. <p>This manual page is copyright 2005 Bryan O'Sullivan.
  1686. Mercurial is copyright 2005-2015 Matt Mackall.
  1687. Free use of this software is granted under the terms of the GNU General
  1688. Public License version 2 or any later version.</p>
  1689. <span class="target" id="common"></span><!-- Common link and substitution definitions. -->
  1690. </div>
  1691. </div>
  1692. </body>
  1693. </html>
# Change User Description Committed
#1 15913 Doug_Napoleone Initial checkin of the latest stabel mercurial to then integrate the changes from //guest/...sven_erik_knop/mercurial on top of (preserving the new HG code).
The purpose is to get it working with the latest version of HG. «		 10 years ago