Show More
@@ -1,369 +1,381 b'' | |||||
1 | HGRC(5) |
|
1 | HGRC(5) | |
2 | ======= |
|
2 | ======= | |
3 | Bryan O'Sullivan <bos@serpentine.com> |
|
3 | Bryan O'Sullivan <bos@serpentine.com> | |
4 |
|
4 | |||
5 | NAME |
|
5 | NAME | |
6 | ---- |
|
6 | ---- | |
7 | hgrc - configuration files for Mercurial |
|
7 | hgrc - configuration files for Mercurial | |
8 |
|
8 | |||
9 | SYNOPSIS |
|
9 | SYNOPSIS | |
10 | -------- |
|
10 | -------- | |
11 |
|
11 | |||
12 | The Mercurial system uses a set of configuration files to control |
|
12 | The Mercurial system uses a set of configuration files to control | |
13 | aspects of its behaviour. |
|
13 | aspects of its behaviour. | |
14 |
|
14 | |||
15 | FILES |
|
15 | FILES | |
16 | ----- |
|
16 | ----- | |
17 |
|
17 | |||
18 | Mercurial reads configuration data from several files, if they exist. |
|
18 | Mercurial reads configuration data from several files, if they exist. | |
19 | The names of these files depend on the system on which Mercurial is |
|
19 | The names of these files depend on the system on which Mercurial is | |
20 | installed. |
|
20 | installed. | |
21 |
|
21 | |||
22 | (Unix) <install-root>/etc/mercurial/hgrc.d/*.rc:: |
|
22 | (Unix) <install-root>/etc/mercurial/hgrc.d/*.rc:: | |
23 | (Unix) <install-root>/etc/mercurial/hgrc:: |
|
23 | (Unix) <install-root>/etc/mercurial/hgrc:: | |
24 | Per-installation configuration files, searched for in the |
|
24 | Per-installation configuration files, searched for in the | |
25 | directory where Mercurial is installed. For example, if installed |
|
25 | directory where Mercurial is installed. For example, if installed | |
26 | in /shared/tools, Mercurial will look in |
|
26 | in /shared/tools, Mercurial will look in | |
27 | /shared/tools/etc/mercurial/hgrc. Options in these files apply to |
|
27 | /shared/tools/etc/mercurial/hgrc. Options in these files apply to | |
28 | all Mercurial commands executed by any user in any directory. |
|
28 | all Mercurial commands executed by any user in any directory. | |
29 |
|
29 | |||
30 | (Unix) /etc/mercurial/hgrc.d/*.rc:: |
|
30 | (Unix) /etc/mercurial/hgrc.d/*.rc:: | |
31 | (Unix) /etc/mercurial/hgrc:: |
|
31 | (Unix) /etc/mercurial/hgrc:: | |
32 | (Windows) C:\Mercurial\Mercurial.ini:: |
|
32 | (Windows) C:\Mercurial\Mercurial.ini:: | |
33 | Per-system configuration files, for the system on which Mercurial |
|
33 | Per-system configuration files, for the system on which Mercurial | |
34 | is running. Options in these files apply to all Mercurial |
|
34 | is running. Options in these files apply to all Mercurial | |
35 | commands executed by any user in any directory. Options in these |
|
35 | commands executed by any user in any directory. Options in these | |
36 | files override per-installation options. |
|
36 | files override per-installation options. | |
37 |
|
37 | |||
38 | (Unix) $HOME/.hgrc:: |
|
38 | (Unix) $HOME/.hgrc:: | |
39 | (Windows) C:\Documents and Settings\USERNAME\Mercurial.ini |
|
39 | (Windows) C:\Documents and Settings\USERNAME\Mercurial.ini | |
40 | Per-user configuration file, for the user running Mercurial. |
|
40 | Per-user configuration file, for the user running Mercurial. | |
41 | Options in this file apply to all Mercurial commands executed by |
|
41 | Options in this file apply to all Mercurial commands executed by | |
42 | any user in any directory. Options in this file override |
|
42 | any user in any directory. Options in this file override | |
43 | per-installation and per-system options. |
|
43 | per-installation and per-system options. | |
44 |
|
44 | |||
45 | (Unix, Windows) <repo>/.hg/hgrc:: |
|
45 | (Unix, Windows) <repo>/.hg/hgrc:: | |
46 | Per-repository configuration options that only apply in a |
|
46 | Per-repository configuration options that only apply in a | |
47 | particular repository. This file is not version-controlled, and |
|
47 | particular repository. This file is not version-controlled, and | |
48 | will not get transferred during a "clone" operation. Options in |
|
48 | will not get transferred during a "clone" operation. Options in | |
49 | this file override options in all other configuration files. |
|
49 | this file override options in all other configuration files. | |
50 |
|
50 | |||
51 | SYNTAX |
|
51 | SYNTAX | |
52 | ------ |
|
52 | ------ | |
53 |
|
53 | |||
54 | A configuration file consists of sections, led by a "[section]" header |
|
54 | A configuration file consists of sections, led by a "[section]" header | |
55 | and followed by "name: value" entries; "name=value" is also accepted. |
|
55 | and followed by "name: value" entries; "name=value" is also accepted. | |
56 |
|
56 | |||
57 | [spam] |
|
57 | [spam] | |
58 | eggs=ham |
|
58 | eggs=ham | |
59 | green= |
|
59 | green= | |
60 | eggs |
|
60 | eggs | |
61 |
|
61 | |||
62 | Each line contains one entry. If the lines that follow are indented, |
|
62 | Each line contains one entry. If the lines that follow are indented, | |
63 | they are treated as continuations of that entry. |
|
63 | they are treated as continuations of that entry. | |
64 |
|
64 | |||
65 | Leading whitespace is removed from values. Empty lines are skipped. |
|
65 | Leading whitespace is removed from values. Empty lines are skipped. | |
66 |
|
66 | |||
67 | The optional values can contain format strings which refer to other |
|
67 | The optional values can contain format strings which refer to other | |
68 | values in the same section, or values in a special DEFAULT section. |
|
68 | values in the same section, or values in a special DEFAULT section. | |
69 |
|
69 | |||
70 | Lines beginning with "#" or ";" are ignored and may be used to provide |
|
70 | Lines beginning with "#" or ";" are ignored and may be used to provide | |
71 | comments. |
|
71 | comments. | |
72 |
|
72 | |||
73 | SECTIONS |
|
73 | SECTIONS | |
74 | -------- |
|
74 | -------- | |
75 |
|
75 | |||
76 | This section describes the different sections that may appear in a |
|
76 | This section describes the different sections that may appear in a | |
77 | Mercurial "hgrc" file, the purpose of each section, its possible |
|
77 | Mercurial "hgrc" file, the purpose of each section, its possible | |
78 | keys, and their possible values. |
|
78 | keys, and their possible values. | |
79 |
|
79 | |||
80 | decode/encode:: |
|
80 | decode/encode:: | |
81 | Filters for transforming files on checkout/checkin. This would |
|
81 | Filters for transforming files on checkout/checkin. This would | |
82 | typically be used for newline processing or other |
|
82 | typically be used for newline processing or other | |
83 | localization/canonicalization of files. |
|
83 | localization/canonicalization of files. | |
84 |
|
84 | |||
85 | Filters consist of a filter pattern followed by a filter command. |
|
85 | Filters consist of a filter pattern followed by a filter command. | |
86 | Filter patterns are globs by default, rooted at the repository |
|
86 | Filter patterns are globs by default, rooted at the repository | |
87 | root. For example, to match any file ending in ".txt" in the root |
|
87 | root. For example, to match any file ending in ".txt" in the root | |
88 | directory only, use the pattern "*.txt". To match any file ending |
|
88 | directory only, use the pattern "*.txt". To match any file ending | |
89 | in ".c" anywhere in the repository, use the pattern "**.c". |
|
89 | in ".c" anywhere in the repository, use the pattern "**.c". | |
90 |
|
90 | |||
91 | The filter command can start with a specifier, either "pipe:" or |
|
91 | The filter command can start with a specifier, either "pipe:" or | |
92 | "tempfile:". If no specifier is given, "pipe:" is used by default. |
|
92 | "tempfile:". If no specifier is given, "pipe:" is used by default. | |
93 |
|
93 | |||
94 | A "pipe:" command must accept data on stdin and return the |
|
94 | A "pipe:" command must accept data on stdin and return the | |
95 | transformed data on stdout. |
|
95 | transformed data on stdout. | |
96 |
|
96 | |||
97 | Pipe example: |
|
97 | Pipe example: | |
98 |
|
98 | |||
99 | [encode] |
|
99 | [encode] | |
100 | # uncompress gzip files on checkin to improve delta compression |
|
100 | # uncompress gzip files on checkin to improve delta compression | |
101 | # note: not necessarily a good idea, just an example |
|
101 | # note: not necessarily a good idea, just an example | |
102 | *.gz = pipe: gunzip |
|
102 | *.gz = pipe: gunzip | |
103 |
|
103 | |||
104 | [decode] |
|
104 | [decode] | |
105 | # recompress gzip files when writing them to the working dir (we |
|
105 | # recompress gzip files when writing them to the working dir (we | |
106 | # can safely omit "pipe:", because it's the default) |
|
106 | # can safely omit "pipe:", because it's the default) | |
107 | *.gz = gzip |
|
107 | *.gz = gzip | |
108 |
|
108 | |||
109 | A "tempfile:" command is a template. The string INFILE is replaced |
|
109 | A "tempfile:" command is a template. The string INFILE is replaced | |
110 | with the name of a temporary file that contains the data to be |
|
110 | with the name of a temporary file that contains the data to be | |
111 | filtered by the command. The string OUTFILE is replaced with the |
|
111 | filtered by the command. The string OUTFILE is replaced with the | |
112 | name of an empty temporary file, where the filtered data must be |
|
112 | name of an empty temporary file, where the filtered data must be | |
113 | written by the command. |
|
113 | written by the command. | |
114 |
|
114 | |||
115 | NOTE: the tempfile mechanism is recommended for Windows systems, |
|
115 | NOTE: the tempfile mechanism is recommended for Windows systems, | |
116 | where the standard shell I/O redirection operators often have |
|
116 | where the standard shell I/O redirection operators often have | |
117 | strange effects. In particular, if you are doing line ending |
|
117 | strange effects. In particular, if you are doing line ending | |
118 | conversion on Windows using the popular dos2unix and unix2dos |
|
118 | conversion on Windows using the popular dos2unix and unix2dos | |
119 | programs, you *must* use the tempfile mechanism, as using pipes will |
|
119 | programs, you *must* use the tempfile mechanism, as using pipes will | |
120 | corrupt the contents of your files. |
|
120 | corrupt the contents of your files. | |
121 |
|
121 | |||
122 | Tempfile example: |
|
122 | Tempfile example: | |
123 |
|
123 | |||
124 | [encode] |
|
124 | [encode] | |
125 | # convert files to unix line ending conventions on checkin |
|
125 | # convert files to unix line ending conventions on checkin | |
126 | **.txt = tempfile: dos2unix -n INFILE OUTFILE |
|
126 | **.txt = tempfile: dos2unix -n INFILE OUTFILE | |
127 |
|
127 | |||
128 | [decode] |
|
128 | [decode] | |
129 | # convert files to windows line ending conventions when writing |
|
129 | # convert files to windows line ending conventions when writing | |
130 | # them to the working dir |
|
130 | # them to the working dir | |
131 | **.txt = tempfile: unix2dos -n INFILE OUTFILE |
|
131 | **.txt = tempfile: unix2dos -n INFILE OUTFILE | |
132 |
|
132 | |||
133 | email:: |
|
133 | email:: | |
134 | Settings for extensions that send email messages. |
|
134 | Settings for extensions that send email messages. | |
135 | from;; |
|
135 | from;; | |
136 | Optional. Email address to use in "From" header and SMTP envelope |
|
136 | Optional. Email address to use in "From" header and SMTP envelope | |
137 | of outgoing messages. |
|
137 | of outgoing messages. | |
138 |
|
138 | |||
|
139 | extensions:: | |||
|
140 | Mercurial has an extension mechanism for adding new features. To | |||
|
141 | enable an extension, create an entry for it in this section. | |||
|
142 | ||||
|
143 | If you know that the extension is already in Python's search path, | |||
|
144 | you can give the name of the module, followed by "=", with nothing | |||
|
145 | after the "=". | |||
|
146 | ||||
|
147 | Otherwise, give a name that you choose, followed by "=", followed by | |||
|
148 | the path to the ".py" file (including the file name extension) that | |||
|
149 | defines the extension. | |||
|
150 | ||||
139 | hooks:: |
|
151 | hooks:: | |
140 | Commands or Python functions that get automatically executed by |
|
152 | Commands or Python functions that get automatically executed by | |
141 | various actions such as starting or finishing a commit. Multiple |
|
153 | various actions such as starting or finishing a commit. Multiple | |
142 | hooks can be run for the same action by appending a suffix to the |
|
154 | hooks can be run for the same action by appending a suffix to the | |
143 | action. Overriding a site-wide hook can be done by changing its |
|
155 | action. Overriding a site-wide hook can be done by changing its | |
144 | value or setting it to an empty string. |
|
156 | value or setting it to an empty string. | |
145 |
|
157 | |||
146 | Example .hg/hgrc: |
|
158 | Example .hg/hgrc: | |
147 |
|
159 | |||
148 | [hooks] |
|
160 | [hooks] | |
149 | # do not use the site-wide hook |
|
161 | # do not use the site-wide hook | |
150 | incoming = |
|
162 | incoming = | |
151 | incoming.email = /my/email/hook |
|
163 | incoming.email = /my/email/hook | |
152 | incoming.autobuild = /my/build/hook |
|
164 | incoming.autobuild = /my/build/hook | |
153 |
|
165 | |||
154 | Most hooks are run with environment variables set that give added |
|
166 | Most hooks are run with environment variables set that give added | |
155 | useful information. For each hook below, the environment variables |
|
167 | useful information. For each hook below, the environment variables | |
156 | it is passed are listed with names of the form "$HG_foo". |
|
168 | it is passed are listed with names of the form "$HG_foo". | |
157 |
|
169 | |||
158 | changegroup;; |
|
170 | changegroup;; | |
159 | Run after a changegroup has been added via push, pull or |
|
171 | Run after a changegroup has been added via push, pull or | |
160 | unbundle. ID of the first new changeset is in $HG_NODE. |
|
172 | unbundle. ID of the first new changeset is in $HG_NODE. | |
161 | commit;; |
|
173 | commit;; | |
162 | Run after a changeset has been created in the local repository. |
|
174 | Run after a changeset has been created in the local repository. | |
163 | ID of the newly created changeset is in $HG_NODE. Parent |
|
175 | ID of the newly created changeset is in $HG_NODE. Parent | |
164 | changeset IDs are in $HG_PARENT1 and $HG_PARENT2. |
|
176 | changeset IDs are in $HG_PARENT1 and $HG_PARENT2. | |
165 | incoming;; |
|
177 | incoming;; | |
166 | Run after a changeset has been pulled, pushed, or unbundled into |
|
178 | Run after a changeset has been pulled, pushed, or unbundled into | |
167 | the local repository. The ID of the newly arrived changeset is in |
|
179 | the local repository. The ID of the newly arrived changeset is in | |
168 | $HG_NODE. |
|
180 | $HG_NODE. | |
169 | outgoing;; |
|
181 | outgoing;; | |
170 | Run after sending changes from local repository to another. ID of |
|
182 | Run after sending changes from local repository to another. ID of | |
171 | first changeset sent is in $HG_NODE. Source of operation is in |
|
183 | first changeset sent is in $HG_NODE. Source of operation is in | |
172 | $HG_SOURCE; see "preoutgoing" hook for description. |
|
184 | $HG_SOURCE; see "preoutgoing" hook for description. | |
173 | prechangegroup;; |
|
185 | prechangegroup;; | |
174 | Run before a changegroup is added via push, pull or unbundle. |
|
186 | Run before a changegroup is added via push, pull or unbundle. | |
175 | Exit status 0 allows the changegroup to proceed. Non-zero status |
|
187 | Exit status 0 allows the changegroup to proceed. Non-zero status | |
176 | will cause the push, pull or unbundle to fail. |
|
188 | will cause the push, pull or unbundle to fail. | |
177 | precommit;; |
|
189 | precommit;; | |
178 | Run before starting a local commit. Exit status 0 allows the |
|
190 | Run before starting a local commit. Exit status 0 allows the | |
179 | commit to proceed. Non-zero status will cause the commit to fail. |
|
191 | commit to proceed. Non-zero status will cause the commit to fail. | |
180 | Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2. |
|
192 | Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2. | |
181 | preoutgoing;; |
|
193 | preoutgoing;; | |
182 | Run before computing changes to send from the local repository to |
|
194 | Run before computing changes to send from the local repository to | |
183 | another. Non-zero status will cause failure. This lets you |
|
195 | another. Non-zero status will cause failure. This lets you | |
184 | prevent pull over http or ssh. Also prevents against local pull, |
|
196 | prevent pull over http or ssh. Also prevents against local pull, | |
185 | push (outbound) or bundle commands, but not effective, since you |
|
197 | push (outbound) or bundle commands, but not effective, since you | |
186 | can just copy files instead then. Source of operation is in |
|
198 | can just copy files instead then. Source of operation is in | |
187 | $HG_SOURCE. If "serve", operation is happening on behalf of |
|
199 | $HG_SOURCE. If "serve", operation is happening on behalf of | |
188 | remote ssh or http repository. If "push", "pull" or "bundle", |
|
200 | remote ssh or http repository. If "push", "pull" or "bundle", | |
189 | operation is happening on behalf of repository on same system. |
|
201 | operation is happening on behalf of repository on same system. | |
190 | pretag;; |
|
202 | pretag;; | |
191 | Run before creating a tag. Exit status 0 allows the tag to be |
|
203 | Run before creating a tag. Exit status 0 allows the tag to be | |
192 | created. Non-zero status will cause the tag to fail. ID of |
|
204 | created. Non-zero status will cause the tag to fail. ID of | |
193 | changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag |
|
205 | changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag | |
194 | is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0. |
|
206 | is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0. | |
195 | pretxnchangegroup;; |
|
207 | pretxnchangegroup;; | |
196 | Run after a changegroup has been added via push, pull or unbundle, |
|
208 | Run after a changegroup has been added via push, pull or unbundle, | |
197 | but before the transaction has been committed. Changegroup is |
|
209 | but before the transaction has been committed. Changegroup is | |
198 | visible to hook program. This lets you validate incoming changes |
|
210 | visible to hook program. This lets you validate incoming changes | |
199 | before accepting them. Passed the ID of the first new changeset |
|
211 | before accepting them. Passed the ID of the first new changeset | |
200 | in $HG_NODE. Exit status 0 allows the transaction to commit. |
|
212 | in $HG_NODE. Exit status 0 allows the transaction to commit. | |
201 | Non-zero status will cause the transaction to be rolled back and |
|
213 | Non-zero status will cause the transaction to be rolled back and | |
202 | the push, pull or unbundle will fail. |
|
214 | the push, pull or unbundle will fail. | |
203 | pretxncommit;; |
|
215 | pretxncommit;; | |
204 | Run after a changeset has been created but the transaction not yet |
|
216 | Run after a changeset has been created but the transaction not yet | |
205 | committed. Changeset is visible to hook program. This lets you |
|
217 | committed. Changeset is visible to hook program. This lets you | |
206 | validate commit message and changes. Exit status 0 allows the |
|
218 | validate commit message and changes. Exit status 0 allows the | |
207 | commit to proceed. Non-zero status will cause the transaction to |
|
219 | commit to proceed. Non-zero status will cause the transaction to | |
208 | be rolled back. ID of changeset is in $HG_NODE. Parent changeset |
|
220 | be rolled back. ID of changeset is in $HG_NODE. Parent changeset | |
209 | IDs are in $HG_PARENT1 and $HG_PARENT2. |
|
221 | IDs are in $HG_PARENT1 and $HG_PARENT2. | |
210 | tag;; |
|
222 | tag;; | |
211 | Run after a tag is created. ID of tagged changeset is in |
|
223 | Run after a tag is created. ID of tagged changeset is in | |
212 | $HG_NODE. Name of tag is in $HG_TAG. Tag is local if |
|
224 | $HG_NODE. Name of tag is in $HG_TAG. Tag is local if | |
213 | $HG_LOCAL=1, in repo if $HG_LOCAL=0. |
|
225 | $HG_LOCAL=1, in repo if $HG_LOCAL=0. | |
214 |
|
226 | |||
215 | In earlier releases, the names of hook environment variables did not |
|
227 | In earlier releases, the names of hook environment variables did not | |
216 | have a "HG_" prefix. These unprefixed names are still provided in |
|
228 | have a "HG_" prefix. These unprefixed names are still provided in | |
217 | the environment for backwards compatibility, but their use is |
|
229 | the environment for backwards compatibility, but their use is | |
218 | deprecated, and they will be removed in a future release. |
|
230 | deprecated, and they will be removed in a future release. | |
219 |
|
231 | |||
220 | The syntax for Python hooks is as follows: |
|
232 | The syntax for Python hooks is as follows: | |
221 |
|
233 | |||
222 | hookname = python:modulename.submodule.callable |
|
234 | hookname = python:modulename.submodule.callable | |
223 |
|
235 | |||
224 | Python hooks are run within the Mercurial process. Each hook is |
|
236 | Python hooks are run within the Mercurial process. Each hook is | |
225 | called with at least three keyword arguments: a ui object (keyword |
|
237 | called with at least three keyword arguments: a ui object (keyword | |
226 | "ui"), a repository object (keyword "repo"), and a "hooktype" |
|
238 | "ui"), a repository object (keyword "repo"), and a "hooktype" | |
227 | keyword that tells what kind of hook is used. Arguments listed as |
|
239 | keyword that tells what kind of hook is used. Arguments listed as | |
228 | environment variables above are passed as keyword arguments, with no |
|
240 | environment variables above are passed as keyword arguments, with no | |
229 | "HG_" prefix, and names in lower case. |
|
241 | "HG_" prefix, and names in lower case. | |
230 |
|
242 | |||
231 | A Python hook must return a "true" value to succeed. Returning a |
|
243 | A Python hook must return a "true" value to succeed. Returning a | |
232 | "false" value or raising an exception is treated as failure of the |
|
244 | "false" value or raising an exception is treated as failure of the | |
233 | hook. |
|
245 | hook. | |
234 |
|
246 | |||
235 | http_proxy:: |
|
247 | http_proxy:: | |
236 | Used to access web-based Mercurial repositories through a HTTP |
|
248 | Used to access web-based Mercurial repositories through a HTTP | |
237 | proxy. |
|
249 | proxy. | |
238 | host;; |
|
250 | host;; | |
239 | Host name and (optional) port of the proxy server, for example |
|
251 | Host name and (optional) port of the proxy server, for example | |
240 | "myproxy:8000". |
|
252 | "myproxy:8000". | |
241 | no;; |
|
253 | no;; | |
242 | Optional. Comma-separated list of host names that should bypass |
|
254 | Optional. Comma-separated list of host names that should bypass | |
243 | the proxy. |
|
255 | the proxy. | |
244 | passwd;; |
|
256 | passwd;; | |
245 | Optional. Password to authenticate with at the proxy server. |
|
257 | Optional. Password to authenticate with at the proxy server. | |
246 | user;; |
|
258 | user;; | |
247 | Optional. User name to authenticate with at the proxy server. |
|
259 | Optional. User name to authenticate with at the proxy server. | |
248 |
|
260 | |||
249 | smtp:: |
|
261 | smtp:: | |
250 | Configuration for extensions that need to send email messages. |
|
262 | Configuration for extensions that need to send email messages. | |
251 | host;; |
|
263 | host;; | |
252 | Optional. Host name of mail server. Default: "mail". |
|
264 | Optional. Host name of mail server. Default: "mail". | |
253 | port;; |
|
265 | port;; | |
254 | Optional. Port to connect to on mail server. Default: 25. |
|
266 | Optional. Port to connect to on mail server. Default: 25. | |
255 | tls;; |
|
267 | tls;; | |
256 | Optional. Whether to connect to mail server using TLS. True or |
|
268 | Optional. Whether to connect to mail server using TLS. True or | |
257 | False. Default: False. |
|
269 | False. Default: False. | |
258 | username;; |
|
270 | username;; | |
259 | Optional. User name to authenticate to SMTP server with. |
|
271 | Optional. User name to authenticate to SMTP server with. | |
260 | If username is specified, password must also be specified. |
|
272 | If username is specified, password must also be specified. | |
261 | Default: none. |
|
273 | Default: none. | |
262 | password;; |
|
274 | password;; | |
263 | Optional. Password to authenticate to SMTP server with. |
|
275 | Optional. Password to authenticate to SMTP server with. | |
264 | If username is specified, password must also be specified. |
|
276 | If username is specified, password must also be specified. | |
265 | Default: none. |
|
277 | Default: none. | |
266 |
|
278 | |||
267 | paths:: |
|
279 | paths:: | |
268 | Assigns symbolic names to repositories. The left side is the |
|
280 | Assigns symbolic names to repositories. The left side is the | |
269 | symbolic name, and the right gives the directory or URL that is the |
|
281 | symbolic name, and the right gives the directory or URL that is the | |
270 | location of the repository. |
|
282 | location of the repository. | |
271 |
|
283 | |||
272 | ui:: |
|
284 | ui:: | |
273 | User interface controls. |
|
285 | User interface controls. | |
274 | debug;; |
|
286 | debug;; | |
275 | Print debugging information. True or False. Default is False. |
|
287 | Print debugging information. True or False. Default is False. | |
276 | editor;; |
|
288 | editor;; | |
277 | The editor to use during a commit. Default is $EDITOR or "vi". |
|
289 | The editor to use during a commit. Default is $EDITOR or "vi". | |
278 | ignore;; |
|
290 | ignore;; | |
279 | A file to read per-user ignore patterns from. This file should be in |
|
291 | A file to read per-user ignore patterns from. This file should be in | |
280 | the same format as a repository-wide .hgignore file. This option |
|
292 | the same format as a repository-wide .hgignore file. This option | |
281 | supports hook syntax, so if you want to specify multiple ignore |
|
293 | supports hook syntax, so if you want to specify multiple ignore | |
282 | files, you can do so by setting something like |
|
294 | files, you can do so by setting something like | |
283 | "ignore.other = ~/.hgignore2". For details of the ignore file |
|
295 | "ignore.other = ~/.hgignore2". For details of the ignore file | |
284 | format, see the hgignore(5) man page. |
|
296 | format, see the hgignore(5) man page. | |
285 | interactive;; |
|
297 | interactive;; | |
286 | Allow to prompt the user. True or False. Default is True. |
|
298 | Allow to prompt the user. True or False. Default is True. | |
287 | logtemplate;; |
|
299 | logtemplate;; | |
288 | Template string for commands that print changesets. |
|
300 | Template string for commands that print changesets. | |
289 | style;; |
|
301 | style;; | |
290 | Name of style to use for command output. |
|
302 | Name of style to use for command output. | |
291 | merge;; |
|
303 | merge;; | |
292 | The conflict resolution program to use during a manual merge. |
|
304 | The conflict resolution program to use during a manual merge. | |
293 | Default is "hgmerge". |
|
305 | Default is "hgmerge". | |
294 | quiet;; |
|
306 | quiet;; | |
295 | Reduce the amount of output printed. True or False. Default is False. |
|
307 | Reduce the amount of output printed. True or False. Default is False. | |
296 | remotecmd;; |
|
308 | remotecmd;; | |
297 | remote command to use for clone/push/pull operations. Default is 'hg'. |
|
309 | remote command to use for clone/push/pull operations. Default is 'hg'. | |
298 | ssh;; |
|
310 | ssh;; | |
299 | command to use for SSH connections. Default is 'ssh'. |
|
311 | command to use for SSH connections. Default is 'ssh'. | |
300 | timeout;; |
|
312 | timeout;; | |
301 | The timeout used when a lock is held (in seconds), a negative value |
|
313 | The timeout used when a lock is held (in seconds), a negative value | |
302 | means no timeout. Default is 600. |
|
314 | means no timeout. Default is 600. | |
303 | username;; |
|
315 | username;; | |
304 | The committer of a changeset created when running "commit". |
|
316 | The committer of a changeset created when running "commit". | |
305 | Typically a person's name and email address, e.g. "Fred Widget |
|
317 | Typically a person's name and email address, e.g. "Fred Widget | |
306 | <fred@example.com>". Default is $EMAIL or username@hostname, unless |
|
318 | <fred@example.com>". Default is $EMAIL or username@hostname, unless | |
307 | username is set to an empty string, which enforces specifying the |
|
319 | username is set to an empty string, which enforces specifying the | |
308 | username manually. |
|
320 | username manually. | |
309 | verbose;; |
|
321 | verbose;; | |
310 | Increase the amount of output printed. True or False. Default is False. |
|
322 | Increase the amount of output printed. True or False. Default is False. | |
311 |
|
323 | |||
312 |
|
324 | |||
313 | web:: |
|
325 | web:: | |
314 | Web interface configuration. |
|
326 | Web interface configuration. | |
315 | accesslog;; |
|
327 | accesslog;; | |
316 | Where to output the access log. Default is stdout. |
|
328 | Where to output the access log. Default is stdout. | |
317 | address;; |
|
329 | address;; | |
318 | Interface address to bind to. Default is all. |
|
330 | Interface address to bind to. Default is all. | |
319 | allowbz2;; |
|
331 | allowbz2;; | |
320 | Whether to allow .tar.bz2 downloading of repo revisions. Default is false. |
|
332 | Whether to allow .tar.bz2 downloading of repo revisions. Default is false. | |
321 | allowgz;; |
|
333 | allowgz;; | |
322 | Whether to allow .tar.gz downloading of repo revisions. Default is false. |
|
334 | Whether to allow .tar.gz downloading of repo revisions. Default is false. | |
323 | allowpull;; |
|
335 | allowpull;; | |
324 | Whether to allow pulling from the repository. Default is true. |
|
336 | Whether to allow pulling from the repository. Default is true. | |
325 | allowzip;; |
|
337 | allowzip;; | |
326 | Whether to allow .zip downloading of repo revisions. Default is false. |
|
338 | Whether to allow .zip downloading of repo revisions. Default is false. | |
327 | This feature creates temporary files. |
|
339 | This feature creates temporary files. | |
328 | baseurl;; |
|
340 | baseurl;; | |
329 | Base URL to use when publishing URLs in other locations, so |
|
341 | Base URL to use when publishing URLs in other locations, so | |
330 | third-party tools like email notification hooks can construct URLs. |
|
342 | third-party tools like email notification hooks can construct URLs. | |
331 | Example: "http://hgserver/repos/" |
|
343 | Example: "http://hgserver/repos/" | |
332 | description;; |
|
344 | description;; | |
333 | Textual description of the repository's purpose or contents. |
|
345 | Textual description of the repository's purpose or contents. | |
334 | Default is "unknown". |
|
346 | Default is "unknown". | |
335 | errorlog;; |
|
347 | errorlog;; | |
336 | Where to output the error log. Default is stderr. |
|
348 | Where to output the error log. Default is stderr. | |
337 | ipv6;; |
|
349 | ipv6;; | |
338 | Whether to use IPv6. Default is false. |
|
350 | Whether to use IPv6. Default is false. | |
339 | name;; |
|
351 | name;; | |
340 | Repository name to use in the web interface. Default is current |
|
352 | Repository name to use in the web interface. Default is current | |
341 | working directory. |
|
353 | working directory. | |
342 | maxchanges;; |
|
354 | maxchanges;; | |
343 | Maximum number of changes to list on the changelog. Default is 10. |
|
355 | Maximum number of changes to list on the changelog. Default is 10. | |
344 | maxfiles;; |
|
356 | maxfiles;; | |
345 | Maximum number of files to list per changeset. Default is 10. |
|
357 | Maximum number of files to list per changeset. Default is 10. | |
346 | port;; |
|
358 | port;; | |
347 | Port to listen on. Default is 8000. |
|
359 | Port to listen on. Default is 8000. | |
348 | style;; |
|
360 | style;; | |
349 | Which template map style to use. |
|
361 | Which template map style to use. | |
350 | templates;; |
|
362 | templates;; | |
351 | Where to find the HTML templates. Default is install path. |
|
363 | Where to find the HTML templates. Default is install path. | |
352 |
|
364 | |||
353 |
|
365 | |||
354 | AUTHOR |
|
366 | AUTHOR | |
355 | ------ |
|
367 | ------ | |
356 | Bryan O'Sullivan <bos@serpentine.com>. |
|
368 | Bryan O'Sullivan <bos@serpentine.com>. | |
357 |
|
369 | |||
358 | Mercurial was written by Matt Mackall <mpm@selenic.com>. |
|
370 | Mercurial was written by Matt Mackall <mpm@selenic.com>. | |
359 |
|
371 | |||
360 | SEE ALSO |
|
372 | SEE ALSO | |
361 | -------- |
|
373 | -------- | |
362 | hg(1), hgignore(5) |
|
374 | hg(1), hgignore(5) | |
363 |
|
375 | |||
364 | COPYING |
|
376 | COPYING | |
365 | ------- |
|
377 | ------- | |
366 | This manual page is copyright 2005 Bryan O'Sullivan. |
|
378 | This manual page is copyright 2005 Bryan O'Sullivan. | |
367 | Mercurial is copyright 2005, 2006 Matt Mackall. |
|
379 | Mercurial is copyright 2005, 2006 Matt Mackall. | |
368 | Free use of this software is granted under the terms of the GNU General |
|
380 | Free use of this software is granted under the terms of the GNU General | |
369 | Public License (GPL). |
|
381 | Public License (GPL). |
General Comments 0
You need to be logged in to leave comments.
Login now