Show More
@@ -1,478 +1,478 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 | (Windows) $HOME\Mercurial.ini:: |
|
40 | (Windows) $HOME\Mercurial.ini:: | |
41 | Per-user configuration file, for the user running Mercurial. |
|
41 | Per-user configuration file, for the user running Mercurial. | |
42 | Options in this file apply to all Mercurial commands executed by |
|
42 | Options in this file apply to all Mercurial commands executed by | |
43 | any user in any directory. Options in this file override |
|
43 | any user in any directory. Options in this file override | |
44 | per-installation and per-system options. |
|
44 | per-installation and per-system options. | |
45 | On Windows system, one of these is chosen exclusively according |
|
45 | On Windows system, one of these is chosen exclusively according | |
46 | to definition of HOME environment variable. |
|
46 | to definition of HOME environment variable. | |
47 |
|
47 | |||
48 | (Unix, Windows) <repo>/.hg/hgrc:: |
|
48 | (Unix, Windows) <repo>/.hg/hgrc:: | |
49 | Per-repository configuration options that only apply in a |
|
49 | Per-repository configuration options that only apply in a | |
50 | particular repository. This file is not version-controlled, and |
|
50 | particular repository. This file is not version-controlled, and | |
51 | will not get transferred during a "clone" operation. Options in |
|
51 | will not get transferred during a "clone" operation. Options in | |
52 | this file override options in all other configuration files. |
|
52 | this file override options in all other configuration files. | |
53 |
|
53 | |||
54 | SYNTAX |
|
54 | SYNTAX | |
55 | ------ |
|
55 | ------ | |
56 |
|
56 | |||
57 | A configuration file consists of sections, led by a "[section]" header |
|
57 | A configuration file consists of sections, led by a "[section]" header | |
58 | and followed by "name: value" entries; "name=value" is also accepted. |
|
58 | and followed by "name: value" entries; "name=value" is also accepted. | |
59 |
|
59 | |||
60 | [spam] |
|
60 | [spam] | |
61 | eggs=ham |
|
61 | eggs=ham | |
62 | green= |
|
62 | green= | |
63 | eggs |
|
63 | eggs | |
64 |
|
64 | |||
65 | Each line contains one entry. If the lines that follow are indented, |
|
65 | Each line contains one entry. If the lines that follow are indented, | |
66 | they are treated as continuations of that entry. |
|
66 | they are treated as continuations of that entry. | |
67 |
|
67 | |||
68 | Leading whitespace is removed from values. Empty lines are skipped. |
|
68 | Leading whitespace is removed from values. Empty lines are skipped. | |
69 |
|
69 | |||
70 | The optional values can contain format strings which refer to other |
|
70 | The optional values can contain format strings which refer to other | |
71 | values in the same section, or values in a special DEFAULT section. |
|
71 | values in the same section, or values in a special DEFAULT section. | |
72 |
|
72 | |||
73 | Lines beginning with "#" or ";" are ignored and may be used to provide |
|
73 | Lines beginning with "#" or ";" are ignored and may be used to provide | |
74 | comments. |
|
74 | comments. | |
75 |
|
75 | |||
76 | SECTIONS |
|
76 | SECTIONS | |
77 | -------- |
|
77 | -------- | |
78 |
|
78 | |||
79 | This section describes the different sections that may appear in a |
|
79 | This section describes the different sections that may appear in a | |
80 | Mercurial "hgrc" file, the purpose of each section, its possible |
|
80 | Mercurial "hgrc" file, the purpose of each section, its possible | |
81 | keys, and their possible values. |
|
81 | keys, and their possible values. | |
82 |
|
82 | |||
83 | decode/encode:: |
|
83 | decode/encode:: | |
84 | Filters for transforming files on checkout/checkin. This would |
|
84 | Filters for transforming files on checkout/checkin. This would | |
85 | typically be used for newline processing or other |
|
85 | typically be used for newline processing or other | |
86 | localization/canonicalization of files. |
|
86 | localization/canonicalization of files. | |
87 |
|
87 | |||
88 | Filters consist of a filter pattern followed by a filter command. |
|
88 | Filters consist of a filter pattern followed by a filter command. | |
89 | Filter patterns are globs by default, rooted at the repository |
|
89 | Filter patterns are globs by default, rooted at the repository | |
90 | root. For example, to match any file ending in ".txt" in the root |
|
90 | root. For example, to match any file ending in ".txt" in the root | |
91 | directory only, use the pattern "*.txt". To match any file ending |
|
91 | directory only, use the pattern "*.txt". To match any file ending | |
92 | in ".c" anywhere in the repository, use the pattern "**.c". |
|
92 | in ".c" anywhere in the repository, use the pattern "**.c". | |
93 |
|
93 | |||
94 | The filter command can start with a specifier, either "pipe:" or |
|
94 | The filter command can start with a specifier, either "pipe:" or | |
95 | "tempfile:". If no specifier is given, "pipe:" is used by default. |
|
95 | "tempfile:". If no specifier is given, "pipe:" is used by default. | |
96 |
|
96 | |||
97 | A "pipe:" command must accept data on stdin and return the |
|
97 | A "pipe:" command must accept data on stdin and return the | |
98 | transformed data on stdout. |
|
98 | transformed data on stdout. | |
99 |
|
99 | |||
100 | Pipe example: |
|
100 | Pipe example: | |
101 |
|
101 | |||
102 | [encode] |
|
102 | [encode] | |
103 | # uncompress gzip files on checkin to improve delta compression |
|
103 | # uncompress gzip files on checkin to improve delta compression | |
104 | # note: not necessarily a good idea, just an example |
|
104 | # note: not necessarily a good idea, just an example | |
105 | *.gz = pipe: gunzip |
|
105 | *.gz = pipe: gunzip | |
106 |
|
106 | |||
107 | [decode] |
|
107 | [decode] | |
108 | # recompress gzip files when writing them to the working dir (we |
|
108 | # recompress gzip files when writing them to the working dir (we | |
109 | # can safely omit "pipe:", because it's the default) |
|
109 | # can safely omit "pipe:", because it's the default) | |
110 | *.gz = gzip |
|
110 | *.gz = gzip | |
111 |
|
111 | |||
112 | A "tempfile:" command is a template. The string INFILE is replaced |
|
112 | A "tempfile:" command is a template. The string INFILE is replaced | |
113 | with the name of a temporary file that contains the data to be |
|
113 | with the name of a temporary file that contains the data to be | |
114 | filtered by the command. The string OUTFILE is replaced with the |
|
114 | filtered by the command. The string OUTFILE is replaced with the | |
115 | name of an empty temporary file, where the filtered data must be |
|
115 | name of an empty temporary file, where the filtered data must be | |
116 | written by the command. |
|
116 | written by the command. | |
117 |
|
117 | |||
118 | NOTE: the tempfile mechanism is recommended for Windows systems, |
|
118 | NOTE: the tempfile mechanism is recommended for Windows systems, | |
119 | where the standard shell I/O redirection operators often have |
|
119 | where the standard shell I/O redirection operators often have | |
120 | strange effects. In particular, if you are doing line ending |
|
120 | strange effects. In particular, if you are doing line ending | |
121 | conversion on Windows using the popular dos2unix and unix2dos |
|
121 | conversion on Windows using the popular dos2unix and unix2dos | |
122 | programs, you *must* use the tempfile mechanism, as using pipes will |
|
122 | programs, you *must* use the tempfile mechanism, as using pipes will | |
123 | corrupt the contents of your files. |
|
123 | corrupt the contents of your files. | |
124 |
|
124 | |||
125 | Tempfile example: |
|
125 | Tempfile example: | |
126 |
|
126 | |||
127 | [encode] |
|
127 | [encode] | |
128 | # convert files to unix line ending conventions on checkin |
|
128 | # convert files to unix line ending conventions on checkin | |
129 | **.txt = tempfile: dos2unix -n INFILE OUTFILE |
|
129 | **.txt = tempfile: dos2unix -n INFILE OUTFILE | |
130 |
|
130 | |||
131 | [decode] |
|
131 | [decode] | |
132 | # convert files to windows line ending conventions when writing |
|
132 | # convert files to windows line ending conventions when writing | |
133 | # them to the working dir |
|
133 | # them to the working dir | |
134 | **.txt = tempfile: unix2dos -n INFILE OUTFILE |
|
134 | **.txt = tempfile: unix2dos -n INFILE OUTFILE | |
135 |
|
135 | |||
136 | email:: |
|
136 | email:: | |
137 | Settings for extensions that send email messages. |
|
137 | Settings for extensions that send email messages. | |
138 | from;; |
|
138 | from;; | |
139 | Optional. Email address to use in "From" header and SMTP envelope |
|
139 | Optional. Email address to use in "From" header and SMTP envelope | |
140 | of outgoing messages. |
|
140 | of outgoing messages. | |
141 | to;; |
|
141 | to;; | |
142 | Optional. Comma-separated list of recipients' email addresses. |
|
142 | Optional. Comma-separated list of recipients' email addresses. | |
143 | cc;; |
|
143 | cc;; | |
144 | Optional. Comma-separated list of carbon copy recipients' |
|
144 | Optional. Comma-separated list of carbon copy recipients' | |
145 | email addresses. |
|
145 | email addresses. | |
146 | bcc;; |
|
146 | bcc;; | |
147 | Optional. Comma-separated list of blind carbon copy |
|
147 | Optional. Comma-separated list of blind carbon copy | |
148 | recipients' email addresses. Cannot be set interactively. |
|
148 | recipients' email addresses. Cannot be set interactively. | |
149 | method;; |
|
149 | method;; | |
150 | Optional. Method to use to send email messages. If value is |
|
150 | Optional. Method to use to send email messages. If value is | |
151 | "smtp" (default), use SMTP (see section "[smtp]" for |
|
151 | "smtp" (default), use SMTP (see section "[smtp]" for | |
152 | configuration). Otherwise, use as name of program to run that |
|
152 | configuration). Otherwise, use as name of program to run that | |
153 | acts like sendmail (takes "-f" option for sender, list of |
|
153 | acts like sendmail (takes "-f" option for sender, list of | |
154 | recipients on command line, message on stdin). Normally, setting |
|
154 | recipients on command line, message on stdin). Normally, setting | |
155 | this to "sendmail" or "/usr/sbin/sendmail" is enough to use |
|
155 | this to "sendmail" or "/usr/sbin/sendmail" is enough to use | |
156 | sendmail to send messages. |
|
156 | sendmail to send messages. | |
157 |
|
157 | |||
158 | Email example: |
|
158 | Email example: | |
159 |
|
159 | |||
160 | [email] |
|
160 | [email] | |
161 | from = Joseph User <joe.user@example.com> |
|
161 | from = Joseph User <joe.user@example.com> | |
162 | method = /usr/sbin/sendmail |
|
162 | method = /usr/sbin/sendmail | |
163 |
|
163 | |||
164 | extensions:: |
|
164 | extensions:: | |
165 | Mercurial has an extension mechanism for adding new features. To |
|
165 | Mercurial has an extension mechanism for adding new features. To | |
166 | enable an extension, create an entry for it in this section. |
|
166 | enable an extension, create an entry for it in this section. | |
167 |
|
167 | |||
168 | If you know that the extension is already in Python's search path, |
|
168 | If you know that the extension is already in Python's search path, | |
169 | you can give the name of the module, followed by "=", with nothing |
|
169 | you can give the name of the module, followed by "=", with nothing | |
170 | after the "=". |
|
170 | after the "=". | |
171 |
|
171 | |||
172 | Otherwise, give a name that you choose, followed by "=", followed by |
|
172 | Otherwise, give a name that you choose, followed by "=", followed by | |
173 | the path to the ".py" file (including the file name extension) that |
|
173 | the path to the ".py" file (including the file name extension) that | |
174 | defines the extension. |
|
174 | defines the extension. | |
175 |
|
175 | |||
176 | Example for ~/.hgrc: |
|
176 | Example for ~/.hgrc: | |
177 |
|
177 | |||
178 | [extensions] |
|
178 | [extensions] | |
179 | # (the mq extension will get loaded from mercurial's path) |
|
179 | # (the mq extension will get loaded from mercurial's path) | |
180 | hgext.mq = |
|
180 | hgext.mq = | |
181 | # (this extension will get loaded from the file specified) |
|
181 | # (this extension will get loaded from the file specified) | |
182 | myfeature = ~/.hgext/myfeature.py |
|
182 | myfeature = ~/.hgext/myfeature.py | |
183 |
|
183 | |||
184 | hooks:: |
|
184 | hooks:: | |
185 | Commands or Python functions that get automatically executed by |
|
185 | Commands or Python functions that get automatically executed by | |
186 | various actions such as starting or finishing a commit. Multiple |
|
186 | various actions such as starting or finishing a commit. Multiple | |
187 | hooks can be run for the same action by appending a suffix to the |
|
187 | hooks can be run for the same action by appending a suffix to the | |
188 | action. Overriding a site-wide hook can be done by changing its |
|
188 | action. Overriding a site-wide hook can be done by changing its | |
189 | value or setting it to an empty string. |
|
189 | value or setting it to an empty string. | |
190 |
|
190 | |||
191 | Example .hg/hgrc: |
|
191 | Example .hg/hgrc: | |
192 |
|
192 | |||
193 | [hooks] |
|
193 | [hooks] | |
194 | # do not use the site-wide hook |
|
194 | # do not use the site-wide hook | |
195 | incoming = |
|
195 | incoming = | |
196 | incoming.email = /my/email/hook |
|
196 | incoming.email = /my/email/hook | |
197 | incoming.autobuild = /my/build/hook |
|
197 | incoming.autobuild = /my/build/hook | |
198 |
|
198 | |||
199 | Most hooks are run with environment variables set that give added |
|
199 | Most hooks are run with environment variables set that give added | |
200 | useful information. For each hook below, the environment variables |
|
200 | useful information. For each hook below, the environment variables | |
201 | it is passed are listed with names of the form "$HG_foo". |
|
201 | it is passed are listed with names of the form "$HG_foo". | |
202 |
|
202 | |||
203 | changegroup;; |
|
203 | changegroup;; | |
204 | Run after a changegroup has been added via push, pull or |
|
204 | Run after a changegroup has been added via push, pull or | |
205 | unbundle. ID of the first new changeset is in $HG_NODE. URL from |
|
205 | unbundle. ID of the first new changeset is in $HG_NODE. URL from | |
206 | which changes came is in $HG_URL. |
|
206 | which changes came is in $HG_URL. | |
207 | commit;; |
|
207 | commit;; | |
208 | Run after a changeset has been created in the local repository. |
|
208 | Run after a changeset has been created in the local repository. | |
209 | ID of the newly created changeset is in $HG_NODE. Parent |
|
209 | ID of the newly created changeset is in $HG_NODE. Parent | |
210 | changeset IDs are in $HG_PARENT1 and $HG_PARENT2. |
|
210 | changeset IDs are in $HG_PARENT1 and $HG_PARENT2. | |
211 | incoming;; |
|
211 | incoming;; | |
212 | Run after a changeset has been pulled, pushed, or unbundled into |
|
212 | Run after a changeset has been pulled, pushed, or unbundled into | |
213 | the local repository. The ID of the newly arrived changeset is in |
|
213 | the local repository. The ID of the newly arrived changeset is in | |
214 | $HG_NODE. URL that was source of changes came is in $HG_URL. |
|
214 | $HG_NODE. URL that was source of changes came is in $HG_URL. | |
215 | outgoing;; |
|
215 | outgoing;; | |
216 | Run after sending changes from local repository to another. ID of |
|
216 | Run after sending changes from local repository to another. ID of | |
217 | first changeset sent is in $HG_NODE. Source of operation is in |
|
217 | first changeset sent is in $HG_NODE. Source of operation is in | |
218 | $HG_SOURCE; see "preoutgoing" hook for description. |
|
218 | $HG_SOURCE; see "preoutgoing" hook for description. | |
219 | prechangegroup;; |
|
219 | prechangegroup;; | |
220 | Run before a changegroup is added via push, pull or unbundle. |
|
220 | Run before a changegroup is added via push, pull or unbundle. | |
221 | Exit status 0 allows the changegroup to proceed. Non-zero status |
|
221 | Exit status 0 allows the changegroup to proceed. Non-zero status | |
222 | will cause the push, pull or unbundle to fail. URL from which |
|
222 | will cause the push, pull or unbundle to fail. URL from which | |
223 | changes will come is in $HG_URL. |
|
223 | changes will come is in $HG_URL. | |
224 | precommit;; |
|
224 | precommit;; | |
225 | Run before starting a local commit. Exit status 0 allows the |
|
225 | Run before starting a local commit. Exit status 0 allows the | |
226 | commit to proceed. Non-zero status will cause the commit to fail. |
|
226 | commit to proceed. Non-zero status will cause the commit to fail. | |
227 | Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2. |
|
227 | Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2. | |
228 | preoutgoing;; |
|
228 | preoutgoing;; | |
229 | Run before computing changes to send from the local repository to |
|
229 | Run before computing changes to send from the local repository to | |
230 | another. Non-zero status will cause failure. This lets you |
|
230 | another. Non-zero status will cause failure. This lets you | |
231 | prevent pull over http or ssh. Also prevents against local pull, |
|
231 | prevent pull over http or ssh. Also prevents against local pull, | |
232 | push (outbound) or bundle commands, but not effective, since you |
|
232 | push (outbound) or bundle commands, but not effective, since you | |
233 | can just copy files instead then. Source of operation is in |
|
233 | can just copy files instead then. Source of operation is in | |
234 | $HG_SOURCE. If "serve", operation is happening on behalf of |
|
234 | $HG_SOURCE. If "serve", operation is happening on behalf of | |
235 | remote ssh or http repository. If "push", "pull" or "bundle", |
|
235 | remote ssh or http repository. If "push", "pull" or "bundle", | |
236 | operation is happening on behalf of repository on same system. |
|
236 | operation is happening on behalf of repository on same system. | |
237 | pretag;; |
|
237 | pretag;; | |
238 | Run before creating a tag. Exit status 0 allows the tag to be |
|
238 | Run before creating a tag. Exit status 0 allows the tag to be | |
239 | created. Non-zero status will cause the tag to fail. ID of |
|
239 | created. Non-zero status will cause the tag to fail. ID of | |
240 | changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag |
|
240 | changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag | |
241 | is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0. |
|
241 | is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0. | |
242 | pretxnchangegroup;; |
|
242 | pretxnchangegroup;; | |
243 | Run after a changegroup has been added via push, pull or unbundle, |
|
243 | Run after a changegroup has been added via push, pull or unbundle, | |
244 | but before the transaction has been committed. Changegroup is |
|
244 | but before the transaction has been committed. Changegroup is | |
245 | visible to hook program. This lets you validate incoming changes |
|
245 | visible to hook program. This lets you validate incoming changes | |
246 | before accepting them. Passed the ID of the first new changeset |
|
246 | before accepting them. Passed the ID of the first new changeset | |
247 | in $HG_NODE. Exit status 0 allows the transaction to commit. |
|
247 | in $HG_NODE. Exit status 0 allows the transaction to commit. | |
248 | Non-zero status will cause the transaction to be rolled back and |
|
248 | Non-zero status will cause the transaction to be rolled back and | |
249 | the push, pull or unbundle will fail. URL that was source of |
|
249 | the push, pull or unbundle will fail. URL that was source of | |
250 | changes is in $HG_URL. |
|
250 | changes is in $HG_URL. | |
251 | pretxncommit;; |
|
251 | pretxncommit;; | |
252 | Run after a changeset has been created but the transaction not yet |
|
252 | Run after a changeset has been created but the transaction not yet | |
253 | committed. Changeset is visible to hook program. This lets you |
|
253 | committed. Changeset is visible to hook program. This lets you | |
254 | validate commit message and changes. Exit status 0 allows the |
|
254 | validate commit message and changes. Exit status 0 allows the | |
255 | commit to proceed. Non-zero status will cause the transaction to |
|
255 | commit to proceed. Non-zero status will cause the transaction to | |
256 | be rolled back. ID of changeset is in $HG_NODE. Parent changeset |
|
256 | be rolled back. ID of changeset is in $HG_NODE. Parent changeset | |
257 | IDs are in $HG_PARENT1 and $HG_PARENT2. |
|
257 | IDs are in $HG_PARENT1 and $HG_PARENT2. | |
258 | preupdate;; |
|
258 | preupdate;; | |
259 | Run before updating the working directory. Exit status 0 allows |
|
259 | Run before updating the working directory. Exit status 0 allows | |
260 | the update to proceed. Non-zero status will prevent the update. |
|
260 | the update to proceed. Non-zero status will prevent the update. | |
261 | Changeset ID of first new parent is in $HG_PARENT1. If merge, ID |
|
261 | Changeset ID of first new parent is in $HG_PARENT1. If merge, ID | |
262 | of second new parent is in $HG_PARENT2. |
|
262 | of second new parent is in $HG_PARENT2. | |
263 | tag;; |
|
263 | tag;; | |
264 | Run after a tag is created. ID of tagged changeset is in |
|
264 | Run after a tag is created. ID of tagged changeset is in | |
265 | $HG_NODE. Name of tag is in $HG_TAG. Tag is local if |
|
265 | $HG_NODE. Name of tag is in $HG_TAG. Tag is local if | |
266 | $HG_LOCAL=1, in repo if $HG_LOCAL=0. |
|
266 | $HG_LOCAL=1, in repo if $HG_LOCAL=0. | |
267 | update;; |
|
267 | update;; | |
268 | Run after updating the working directory. Changeset ID of first |
|
268 | Run after updating the working directory. Changeset ID of first | |
269 | new parent is in $HG_PARENT1. If merge, ID of second new parent |
|
269 | new parent is in $HG_PARENT1. If merge, ID of second new parent | |
270 | is in $HG_PARENT2. If update succeeded, $HG_ERROR=0. If update |
|
270 | is in $HG_PARENT2. If update succeeded, $HG_ERROR=0. If update | |
271 | failed (e.g. because conflicts not resolved), $HG_ERROR=1. |
|
271 | failed (e.g. because conflicts not resolved), $HG_ERROR=1. | |
272 |
|
272 | |||
273 | Note: In earlier releases, the names of hook environment variables |
|
273 | Note: In earlier releases, the names of hook environment variables | |
274 | did not have a "HG_" prefix. The old unprefixed names are no longer |
|
274 | did not have a "HG_" prefix. The old unprefixed names are no longer | |
275 | provided in the environment. |
|
275 | provided in the environment. | |
276 |
|
276 | |||
277 | The syntax for Python hooks is as follows: |
|
277 | The syntax for Python hooks is as follows: | |
278 |
|
278 | |||
279 | hookname = python:modulename.submodule.callable |
|
279 | hookname = python:modulename.submodule.callable | |
280 |
|
280 | |||
281 | Python hooks are run within the Mercurial process. Each hook is |
|
281 | Python hooks are run within the Mercurial process. Each hook is | |
282 | called with at least three keyword arguments: a ui object (keyword |
|
282 | called with at least three keyword arguments: a ui object (keyword | |
283 | "ui"), a repository object (keyword "repo"), and a "hooktype" |
|
283 | "ui"), a repository object (keyword "repo"), and a "hooktype" | |
284 | keyword that tells what kind of hook is used. Arguments listed as |
|
284 | keyword that tells what kind of hook is used. Arguments listed as | |
285 | environment variables above are passed as keyword arguments, with no |
|
285 | environment variables above are passed as keyword arguments, with no | |
286 | "HG_" prefix, and names in lower case. |
|
286 | "HG_" prefix, and names in lower case. | |
287 |
|
287 | |||
288 | A Python hook must return a "true" value to succeed. Returning a |
|
288 | A Python hook must return a "true" value to succeed. Returning a | |
289 | "false" value or raising an exception is treated as failure of the |
|
289 | "false" value or raising an exception is treated as failure of the | |
290 | hook. |
|
290 | hook. | |
291 |
|
291 | |||
292 | http_proxy:: |
|
292 | http_proxy:: | |
293 | Used to access web-based Mercurial repositories through a HTTP |
|
293 | Used to access web-based Mercurial repositories through a HTTP | |
294 | proxy. |
|
294 | proxy. | |
295 | host;; |
|
295 | host;; | |
296 | Host name and (optional) port of the proxy server, for example |
|
296 | Host name and (optional) port of the proxy server, for example | |
297 | "myproxy:8000". |
|
297 | "myproxy:8000". | |
298 | no;; |
|
298 | no;; | |
299 | Optional. Comma-separated list of host names that should bypass |
|
299 | Optional. Comma-separated list of host names that should bypass | |
300 | the proxy. |
|
300 | the proxy. | |
301 | passwd;; |
|
301 | passwd;; | |
302 | Optional. Password to authenticate with at the proxy server. |
|
302 | Optional. Password to authenticate with at the proxy server. | |
303 | user;; |
|
303 | user;; | |
304 | Optional. User name to authenticate with at the proxy server. |
|
304 | Optional. User name to authenticate with at the proxy server. | |
305 |
|
305 | |||
306 | smtp:: |
|
306 | smtp:: | |
307 | Configuration for extensions that need to send email messages. |
|
307 | Configuration for extensions that need to send email messages. | |
308 | host;; |
|
308 | host;; | |
309 |
|
|
309 | Host name of mail server, e.g. "mail.example.com". | |
310 | port;; |
|
310 | port;; | |
311 | Optional. Port to connect to on mail server. Default: 25. |
|
311 | Optional. Port to connect to on mail server. Default: 25. | |
312 | tls;; |
|
312 | tls;; | |
313 | Optional. Whether to connect to mail server using TLS. True or |
|
313 | Optional. Whether to connect to mail server using TLS. True or | |
314 | False. Default: False. |
|
314 | False. Default: False. | |
315 | username;; |
|
315 | username;; | |
316 | Optional. User name to authenticate to SMTP server with. |
|
316 | Optional. User name to authenticate to SMTP server with. | |
317 | If username is specified, password must also be specified. |
|
317 | If username is specified, password must also be specified. | |
318 | Default: none. |
|
318 | Default: none. | |
319 | password;; |
|
319 | password;; | |
320 | Optional. Password to authenticate to SMTP server with. |
|
320 | Optional. Password to authenticate to SMTP server with. | |
321 | If username is specified, password must also be specified. |
|
321 | If username is specified, password must also be specified. | |
322 | Default: none. |
|
322 | Default: none. | |
323 | local_hostname;; |
|
323 | local_hostname;; | |
324 | Optional. It's the hostname that the sender can use to identify itself |
|
324 | Optional. It's the hostname that the sender can use to identify itself | |
325 | to the MTA. |
|
325 | to the MTA. | |
326 |
|
326 | |||
327 | paths:: |
|
327 | paths:: | |
328 | Assigns symbolic names to repositories. The left side is the |
|
328 | Assigns symbolic names to repositories. The left side is the | |
329 | symbolic name, and the right gives the directory or URL that is the |
|
329 | symbolic name, and the right gives the directory or URL that is the | |
330 | location of the repository. Default paths can be declared by |
|
330 | location of the repository. Default paths can be declared by | |
331 | setting the following entries. |
|
331 | setting the following entries. | |
332 | default;; |
|
332 | default;; | |
333 | Directory or URL to use when pulling if no source is specified. |
|
333 | Directory or URL to use when pulling if no source is specified. | |
334 | Default is set to repository from which the current repository |
|
334 | Default is set to repository from which the current repository | |
335 | was cloned. |
|
335 | was cloned. | |
336 | default-push;; |
|
336 | default-push;; | |
337 | Optional. Directory or URL to use when pushing if no destination |
|
337 | Optional. Directory or URL to use when pushing if no destination | |
338 | is specified. |
|
338 | is specified. | |
339 |
|
339 | |||
340 | server:: |
|
340 | server:: | |
341 | Controls generic server settings. |
|
341 | Controls generic server settings. | |
342 | uncompressed;; |
|
342 | uncompressed;; | |
343 | Whether to allow clients to clone a repo using the uncompressed |
|
343 | Whether to allow clients to clone a repo using the uncompressed | |
344 | streaming protocol. This transfers about 40% more data than a |
|
344 | streaming protocol. This transfers about 40% more data than a | |
345 | regular clone, but uses less memory and CPU on both server and |
|
345 | regular clone, but uses less memory and CPU on both server and | |
346 | client. Over a LAN (100Mbps or better) or a very fast WAN, an |
|
346 | client. Over a LAN (100Mbps or better) or a very fast WAN, an | |
347 | uncompressed streaming clone is a lot faster (~10x) than a regular |
|
347 | uncompressed streaming clone is a lot faster (~10x) than a regular | |
348 | clone. Over most WAN connections (anything slower than about |
|
348 | clone. Over most WAN connections (anything slower than about | |
349 | 6Mbps), uncompressed streaming is slower, because of the extra |
|
349 | 6Mbps), uncompressed streaming is slower, because of the extra | |
350 | data transfer overhead. Default is False. |
|
350 | data transfer overhead. Default is False. | |
351 |
|
351 | |||
352 | ui:: |
|
352 | ui:: | |
353 | User interface controls. |
|
353 | User interface controls. | |
354 | debug;; |
|
354 | debug;; | |
355 | Print debugging information. True or False. Default is False. |
|
355 | Print debugging information. True or False. Default is False. | |
356 | editor;; |
|
356 | editor;; | |
357 | The editor to use during a commit. Default is $EDITOR or "vi". |
|
357 | The editor to use during a commit. Default is $EDITOR or "vi". | |
358 | ignore;; |
|
358 | ignore;; | |
359 | A file to read per-user ignore patterns from. This file should be in |
|
359 | A file to read per-user ignore patterns from. This file should be in | |
360 | the same format as a repository-wide .hgignore file. This option |
|
360 | the same format as a repository-wide .hgignore file. This option | |
361 | supports hook syntax, so if you want to specify multiple ignore |
|
361 | supports hook syntax, so if you want to specify multiple ignore | |
362 | files, you can do so by setting something like |
|
362 | files, you can do so by setting something like | |
363 | "ignore.other = ~/.hgignore2". For details of the ignore file |
|
363 | "ignore.other = ~/.hgignore2". For details of the ignore file | |
364 | format, see the hgignore(5) man page. |
|
364 | format, see the hgignore(5) man page. | |
365 | interactive;; |
|
365 | interactive;; | |
366 | Allow to prompt the user. True or False. Default is True. |
|
366 | Allow to prompt the user. True or False. Default is True. | |
367 | logtemplate;; |
|
367 | logtemplate;; | |
368 | Template string for commands that print changesets. |
|
368 | Template string for commands that print changesets. | |
369 | style;; |
|
369 | style;; | |
370 | Name of style to use for command output. |
|
370 | Name of style to use for command output. | |
371 | merge;; |
|
371 | merge;; | |
372 | The conflict resolution program to use during a manual merge. |
|
372 | The conflict resolution program to use during a manual merge. | |
373 | Default is "hgmerge". |
|
373 | Default is "hgmerge". | |
374 | quiet;; |
|
374 | quiet;; | |
375 | Reduce the amount of output printed. True or False. Default is False. |
|
375 | Reduce the amount of output printed. True or False. Default is False. | |
376 | remotecmd;; |
|
376 | remotecmd;; | |
377 | remote command to use for clone/push/pull operations. Default is 'hg'. |
|
377 | remote command to use for clone/push/pull operations. Default is 'hg'. | |
378 | ssh;; |
|
378 | ssh;; | |
379 | command to use for SSH connections. Default is 'ssh'. |
|
379 | command to use for SSH connections. Default is 'ssh'. | |
380 | timeout;; |
|
380 | timeout;; | |
381 | The timeout used when a lock is held (in seconds), a negative value |
|
381 | The timeout used when a lock is held (in seconds), a negative value | |
382 | means no timeout. Default is 600. |
|
382 | means no timeout. Default is 600. | |
383 | username;; |
|
383 | username;; | |
384 | The committer of a changeset created when running "commit". |
|
384 | The committer of a changeset created when running "commit". | |
385 | Typically a person's name and email address, e.g. "Fred Widget |
|
385 | Typically a person's name and email address, e.g. "Fred Widget | |
386 | <fred@example.com>". Default is $EMAIL or username@hostname, unless |
|
386 | <fred@example.com>". Default is $EMAIL or username@hostname, unless | |
387 | username is set to an empty string, which enforces specifying the |
|
387 | username is set to an empty string, which enforces specifying the | |
388 | username manually. |
|
388 | username manually. | |
389 | verbose;; |
|
389 | verbose;; | |
390 | Increase the amount of output printed. True or False. Default is False. |
|
390 | Increase the amount of output printed. True or False. Default is False. | |
391 |
|
391 | |||
392 |
|
392 | |||
393 | web:: |
|
393 | web:: | |
394 | Web interface configuration. |
|
394 | Web interface configuration. | |
395 | accesslog;; |
|
395 | accesslog;; | |
396 | Where to output the access log. Default is stdout. |
|
396 | Where to output the access log. Default is stdout. | |
397 | address;; |
|
397 | address;; | |
398 | Interface address to bind to. Default is all. |
|
398 | Interface address to bind to. Default is all. | |
399 | allow_archive;; |
|
399 | allow_archive;; | |
400 | List of archive format (bz2, gz, zip) allowed for downloading. |
|
400 | List of archive format (bz2, gz, zip) allowed for downloading. | |
401 | Default is empty. |
|
401 | Default is empty. | |
402 | allowbz2;; |
|
402 | allowbz2;; | |
403 | (DEPRECATED) Whether to allow .tar.bz2 downloading of repo revisions. |
|
403 | (DEPRECATED) Whether to allow .tar.bz2 downloading of repo revisions. | |
404 | Default is false. |
|
404 | Default is false. | |
405 | allowgz;; |
|
405 | allowgz;; | |
406 | (DEPRECATED) Whether to allow .tar.gz downloading of repo revisions. |
|
406 | (DEPRECATED) Whether to allow .tar.gz downloading of repo revisions. | |
407 | Default is false. |
|
407 | Default is false. | |
408 | allowpull;; |
|
408 | allowpull;; | |
409 | Whether to allow pulling from the repository. Default is true. |
|
409 | Whether to allow pulling from the repository. Default is true. | |
410 | allow_push;; |
|
410 | allow_push;; | |
411 | Whether to allow pushing to the repository. If empty or not set, |
|
411 | Whether to allow pushing to the repository. If empty or not set, | |
412 | push is not allowed. If the special value "*", any remote user |
|
412 | push is not allowed. If the special value "*", any remote user | |
413 | can push, including unauthenticated users. Otherwise, the remote |
|
413 | can push, including unauthenticated users. Otherwise, the remote | |
414 | user must have been authenticated, and the authenticated user name |
|
414 | user must have been authenticated, and the authenticated user name | |
415 | must be present in this list (separated by whitespace or ","). |
|
415 | must be present in this list (separated by whitespace or ","). | |
416 | The contents of the allow_push list are examined after the |
|
416 | The contents of the allow_push list are examined after the | |
417 | deny_push list. |
|
417 | deny_push list. | |
418 | allowzip;; |
|
418 | allowzip;; | |
419 | (DEPRECATED) Whether to allow .zip downloading of repo revisions. |
|
419 | (DEPRECATED) Whether to allow .zip downloading of repo revisions. | |
420 | Default is false. This feature creates temporary files. |
|
420 | Default is false. This feature creates temporary files. | |
421 | baseurl;; |
|
421 | baseurl;; | |
422 | Base URL to use when publishing URLs in other locations, so |
|
422 | Base URL to use when publishing URLs in other locations, so | |
423 | third-party tools like email notification hooks can construct URLs. |
|
423 | third-party tools like email notification hooks can construct URLs. | |
424 | Example: "http://hgserver/repos/" |
|
424 | Example: "http://hgserver/repos/" | |
425 | contact;; |
|
425 | contact;; | |
426 | Name or email address of the person in charge of the repository. |
|
426 | Name or email address of the person in charge of the repository. | |
427 | Default is "unknown". |
|
427 | Default is "unknown". | |
428 | deny_push;; |
|
428 | deny_push;; | |
429 | Whether to deny pushing to the repository. If empty or not set, |
|
429 | Whether to deny pushing to the repository. If empty or not set, | |
430 | push is not denied. If the special value "*", all remote users |
|
430 | push is not denied. If the special value "*", all remote users | |
431 | are denied push. Otherwise, unauthenticated users are all denied, |
|
431 | are denied push. Otherwise, unauthenticated users are all denied, | |
432 | and any authenticated user name present in this list (separated by |
|
432 | and any authenticated user name present in this list (separated by | |
433 | whitespace or ",") is also denied. The contents of the deny_push |
|
433 | whitespace or ",") is also denied. The contents of the deny_push | |
434 | list are examined before the allow_push list. |
|
434 | list are examined before the allow_push list. | |
435 | description;; |
|
435 | description;; | |
436 | Textual description of the repository's purpose or contents. |
|
436 | Textual description of the repository's purpose or contents. | |
437 | Default is "unknown". |
|
437 | Default is "unknown". | |
438 | errorlog;; |
|
438 | errorlog;; | |
439 | Where to output the error log. Default is stderr. |
|
439 | Where to output the error log. Default is stderr. | |
440 | ipv6;; |
|
440 | ipv6;; | |
441 | Whether to use IPv6. Default is false. |
|
441 | Whether to use IPv6. Default is false. | |
442 | name;; |
|
442 | name;; | |
443 | Repository name to use in the web interface. Default is current |
|
443 | Repository name to use in the web interface. Default is current | |
444 | working directory. |
|
444 | working directory. | |
445 | maxchanges;; |
|
445 | maxchanges;; | |
446 | Maximum number of changes to list on the changelog. Default is 10. |
|
446 | Maximum number of changes to list on the changelog. Default is 10. | |
447 | maxfiles;; |
|
447 | maxfiles;; | |
448 | Maximum number of files to list per changeset. Default is 10. |
|
448 | Maximum number of files to list per changeset. Default is 10. | |
449 | port;; |
|
449 | port;; | |
450 | Port to listen on. Default is 8000. |
|
450 | Port to listen on. Default is 8000. | |
451 | push_ssl;; |
|
451 | push_ssl;; | |
452 | Whether to require that inbound pushes be transported over SSL to |
|
452 | Whether to require that inbound pushes be transported over SSL to | |
453 | prevent password sniffing. Default is true. |
|
453 | prevent password sniffing. Default is true. | |
454 | stripes;; |
|
454 | stripes;; | |
455 | How many lines a "zebra stripe" should span in multiline output. |
|
455 | How many lines a "zebra stripe" should span in multiline output. | |
456 | Default is 1; set to 0 to disable. |
|
456 | Default is 1; set to 0 to disable. | |
457 | style;; |
|
457 | style;; | |
458 | Which template map style to use. |
|
458 | Which template map style to use. | |
459 | templates;; |
|
459 | templates;; | |
460 | Where to find the HTML templates. Default is install path. |
|
460 | Where to find the HTML templates. Default is install path. | |
461 |
|
461 | |||
462 |
|
462 | |||
463 | AUTHOR |
|
463 | AUTHOR | |
464 | ------ |
|
464 | ------ | |
465 | Bryan O'Sullivan <bos@serpentine.com>. |
|
465 | Bryan O'Sullivan <bos@serpentine.com>. | |
466 |
|
466 | |||
467 | Mercurial was written by Matt Mackall <mpm@selenic.com>. |
|
467 | Mercurial was written by Matt Mackall <mpm@selenic.com>. | |
468 |
|
468 | |||
469 | SEE ALSO |
|
469 | SEE ALSO | |
470 | -------- |
|
470 | -------- | |
471 | hg(1), hgignore(5) |
|
471 | hg(1), hgignore(5) | |
472 |
|
472 | |||
473 | COPYING |
|
473 | COPYING | |
474 | ------- |
|
474 | ------- | |
475 | This manual page is copyright 2005 Bryan O'Sullivan. |
|
475 | This manual page is copyright 2005 Bryan O'Sullivan. | |
476 | Mercurial is copyright 2005, 2006 Matt Mackall. |
|
476 | Mercurial is copyright 2005, 2006 Matt Mackall. | |
477 | Free use of this software is granted under the terms of the GNU General |
|
477 | Free use of this software is granted under the terms of the GNU General | |
478 | Public License (GPL). |
|
478 | Public License (GPL). |
General Comments 0
You need to be logged in to leave comments.
Login now