##// END OF EJS Templates
fix reference to "smtp" section...
Christian Ebert -
r2678:a781df9b default
parent child Browse files
Show More
@@ -1,470 +1,470 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 method;;
141 method;;
142 Optional. Method to use to send email messages. If value is
142 Optional. Method to use to send email messages. If value is
143 "smtp" (default), use SMTP (see section "[mail]" for
143 "smtp" (default), use SMTP (see section "[smtp]" for
144 configuration). Otherwise, use as name of program to run that
144 configuration). Otherwise, use as name of program to run that
145 acts like sendmail (takes "-f" option for sender, list of
145 acts like sendmail (takes "-f" option for sender, list of
146 recipients on command line, message on stdin). Normally, setting
146 recipients on command line, message on stdin). Normally, setting
147 this to "sendmail" or "/usr/sbin/sendmail" is enough to use
147 this to "sendmail" or "/usr/sbin/sendmail" is enough to use
148 sendmail to send messages.
148 sendmail to send messages.
149
149
150 Email example:
150 Email example:
151
151
152 [email]
152 [email]
153 from = Joseph User <joe.user@example.com>
153 from = Joseph User <joe.user@example.com>
154 method = /usr/sbin/sendmail
154 method = /usr/sbin/sendmail
155
155
156 extensions::
156 extensions::
157 Mercurial has an extension mechanism for adding new features. To
157 Mercurial has an extension mechanism for adding new features. To
158 enable an extension, create an entry for it in this section.
158 enable an extension, create an entry for it in this section.
159
159
160 If you know that the extension is already in Python's search path,
160 If you know that the extension is already in Python's search path,
161 you can give the name of the module, followed by "=", with nothing
161 you can give the name of the module, followed by "=", with nothing
162 after the "=".
162 after the "=".
163
163
164 Otherwise, give a name that you choose, followed by "=", followed by
164 Otherwise, give a name that you choose, followed by "=", followed by
165 the path to the ".py" file (including the file name extension) that
165 the path to the ".py" file (including the file name extension) that
166 defines the extension.
166 defines the extension.
167
167
168 Example for ~/.hgrc:
168 Example for ~/.hgrc:
169
169
170 [extensions]
170 [extensions]
171 # (the mq extension will get loaded from mercurial's path)
171 # (the mq extension will get loaded from mercurial's path)
172 hgext.mq =
172 hgext.mq =
173 # (this extension will get loaded from the file specified)
173 # (this extension will get loaded from the file specified)
174 myfeature = ~/.hgext/myfeature.py
174 myfeature = ~/.hgext/myfeature.py
175
175
176 hooks::
176 hooks::
177 Commands or Python functions that get automatically executed by
177 Commands or Python functions that get automatically executed by
178 various actions such as starting or finishing a commit. Multiple
178 various actions such as starting or finishing a commit. Multiple
179 hooks can be run for the same action by appending a suffix to the
179 hooks can be run for the same action by appending a suffix to the
180 action. Overriding a site-wide hook can be done by changing its
180 action. Overriding a site-wide hook can be done by changing its
181 value or setting it to an empty string.
181 value or setting it to an empty string.
182
182
183 Example .hg/hgrc:
183 Example .hg/hgrc:
184
184
185 [hooks]
185 [hooks]
186 # do not use the site-wide hook
186 # do not use the site-wide hook
187 incoming =
187 incoming =
188 incoming.email = /my/email/hook
188 incoming.email = /my/email/hook
189 incoming.autobuild = /my/build/hook
189 incoming.autobuild = /my/build/hook
190
190
191 Most hooks are run with environment variables set that give added
191 Most hooks are run with environment variables set that give added
192 useful information. For each hook below, the environment variables
192 useful information. For each hook below, the environment variables
193 it is passed are listed with names of the form "$HG_foo".
193 it is passed are listed with names of the form "$HG_foo".
194
194
195 changegroup;;
195 changegroup;;
196 Run after a changegroup has been added via push, pull or
196 Run after a changegroup has been added via push, pull or
197 unbundle. ID of the first new changeset is in $HG_NODE. URL from
197 unbundle. ID of the first new changeset is in $HG_NODE. URL from
198 which changes came is in $HG_URL.
198 which changes came is in $HG_URL.
199 commit;;
199 commit;;
200 Run after a changeset has been created in the local repository.
200 Run after a changeset has been created in the local repository.
201 ID of the newly created changeset is in $HG_NODE. Parent
201 ID of the newly created changeset is in $HG_NODE. Parent
202 changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
202 changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
203 incoming;;
203 incoming;;
204 Run after a changeset has been pulled, pushed, or unbundled into
204 Run after a changeset has been pulled, pushed, or unbundled into
205 the local repository. The ID of the newly arrived changeset is in
205 the local repository. The ID of the newly arrived changeset is in
206 $HG_NODE. URL that was source of changes came is in $HG_URL.
206 $HG_NODE. URL that was source of changes came is in $HG_URL.
207 outgoing;;
207 outgoing;;
208 Run after sending changes from local repository to another. ID of
208 Run after sending changes from local repository to another. ID of
209 first changeset sent is in $HG_NODE. Source of operation is in
209 first changeset sent is in $HG_NODE. Source of operation is in
210 $HG_SOURCE; see "preoutgoing" hook for description.
210 $HG_SOURCE; see "preoutgoing" hook for description.
211 prechangegroup;;
211 prechangegroup;;
212 Run before a changegroup is added via push, pull or unbundle.
212 Run before a changegroup is added via push, pull or unbundle.
213 Exit status 0 allows the changegroup to proceed. Non-zero status
213 Exit status 0 allows the changegroup to proceed. Non-zero status
214 will cause the push, pull or unbundle to fail. URL from which
214 will cause the push, pull or unbundle to fail. URL from which
215 changes will come is in $HG_URL.
215 changes will come is in $HG_URL.
216 precommit;;
216 precommit;;
217 Run before starting a local commit. Exit status 0 allows the
217 Run before starting a local commit. Exit status 0 allows the
218 commit to proceed. Non-zero status will cause the commit to fail.
218 commit to proceed. Non-zero status will cause the commit to fail.
219 Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
219 Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2.
220 preoutgoing;;
220 preoutgoing;;
221 Run before computing changes to send from the local repository to
221 Run before computing changes to send from the local repository to
222 another. Non-zero status will cause failure. This lets you
222 another. Non-zero status will cause failure. This lets you
223 prevent pull over http or ssh. Also prevents against local pull,
223 prevent pull over http or ssh. Also prevents against local pull,
224 push (outbound) or bundle commands, but not effective, since you
224 push (outbound) or bundle commands, but not effective, since you
225 can just copy files instead then. Source of operation is in
225 can just copy files instead then. Source of operation is in
226 $HG_SOURCE. If "serve", operation is happening on behalf of
226 $HG_SOURCE. If "serve", operation is happening on behalf of
227 remote ssh or http repository. If "push", "pull" or "bundle",
227 remote ssh or http repository. If "push", "pull" or "bundle",
228 operation is happening on behalf of repository on same system.
228 operation is happening on behalf of repository on same system.
229 pretag;;
229 pretag;;
230 Run before creating a tag. Exit status 0 allows the tag to be
230 Run before creating a tag. Exit status 0 allows the tag to be
231 created. Non-zero status will cause the tag to fail. ID of
231 created. Non-zero status will cause the tag to fail. ID of
232 changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag
232 changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag
233 is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0.
233 is local if $HG_LOCAL=1, in repo if $HG_LOCAL=0.
234 pretxnchangegroup;;
234 pretxnchangegroup;;
235 Run after a changegroup has been added via push, pull or unbundle,
235 Run after a changegroup has been added via push, pull or unbundle,
236 but before the transaction has been committed. Changegroup is
236 but before the transaction has been committed. Changegroup is
237 visible to hook program. This lets you validate incoming changes
237 visible to hook program. This lets you validate incoming changes
238 before accepting them. Passed the ID of the first new changeset
238 before accepting them. Passed the ID of the first new changeset
239 in $HG_NODE. Exit status 0 allows the transaction to commit.
239 in $HG_NODE. Exit status 0 allows the transaction to commit.
240 Non-zero status will cause the transaction to be rolled back and
240 Non-zero status will cause the transaction to be rolled back and
241 the push, pull or unbundle will fail. URL that was source of
241 the push, pull or unbundle will fail. URL that was source of
242 changes is in $HG_URL.
242 changes is in $HG_URL.
243 pretxncommit;;
243 pretxncommit;;
244 Run after a changeset has been created but the transaction not yet
244 Run after a changeset has been created but the transaction not yet
245 committed. Changeset is visible to hook program. This lets you
245 committed. Changeset is visible to hook program. This lets you
246 validate commit message and changes. Exit status 0 allows the
246 validate commit message and changes. Exit status 0 allows the
247 commit to proceed. Non-zero status will cause the transaction to
247 commit to proceed. Non-zero status will cause the transaction to
248 be rolled back. ID of changeset is in $HG_NODE. Parent changeset
248 be rolled back. ID of changeset is in $HG_NODE. Parent changeset
249 IDs are in $HG_PARENT1 and $HG_PARENT2.
249 IDs are in $HG_PARENT1 and $HG_PARENT2.
250 preupdate;;
250 preupdate;;
251 Run before updating the working directory. Exit status 0 allows
251 Run before updating the working directory. Exit status 0 allows
252 the update to proceed. Non-zero status will prevent the update.
252 the update to proceed. Non-zero status will prevent the update.
253 Changeset ID of first new parent is in $HG_PARENT1. If merge, ID
253 Changeset ID of first new parent is in $HG_PARENT1. If merge, ID
254 of second new parent is in $HG_PARENT2.
254 of second new parent is in $HG_PARENT2.
255 tag;;
255 tag;;
256 Run after a tag is created. ID of tagged changeset is in
256 Run after a tag is created. ID of tagged changeset is in
257 $HG_NODE. Name of tag is in $HG_TAG. Tag is local if
257 $HG_NODE. Name of tag is in $HG_TAG. Tag is local if
258 $HG_LOCAL=1, in repo if $HG_LOCAL=0.
258 $HG_LOCAL=1, in repo if $HG_LOCAL=0.
259 update;;
259 update;;
260 Run after updating the working directory. Changeset ID of first
260 Run after updating the working directory. Changeset ID of first
261 new parent is in $HG_PARENT1. If merge, ID of second new parent
261 new parent is in $HG_PARENT1. If merge, ID of second new parent
262 is in $HG_PARENT2. If update succeeded, $HG_ERROR=0. If update
262 is in $HG_PARENT2. If update succeeded, $HG_ERROR=0. If update
263 failed (e.g. because conflicts not resolved), $HG_ERROR=1.
263 failed (e.g. because conflicts not resolved), $HG_ERROR=1.
264
264
265 Note: In earlier releases, the names of hook environment variables
265 Note: In earlier releases, the names of hook environment variables
266 did not have a "HG_" prefix. The old unprefixed names are no longer
266 did not have a "HG_" prefix. The old unprefixed names are no longer
267 provided in the environment.
267 provided in the environment.
268
268
269 The syntax for Python hooks is as follows:
269 The syntax for Python hooks is as follows:
270
270
271 hookname = python:modulename.submodule.callable
271 hookname = python:modulename.submodule.callable
272
272
273 Python hooks are run within the Mercurial process. Each hook is
273 Python hooks are run within the Mercurial process. Each hook is
274 called with at least three keyword arguments: a ui object (keyword
274 called with at least three keyword arguments: a ui object (keyword
275 "ui"), a repository object (keyword "repo"), and a "hooktype"
275 "ui"), a repository object (keyword "repo"), and a "hooktype"
276 keyword that tells what kind of hook is used. Arguments listed as
276 keyword that tells what kind of hook is used. Arguments listed as
277 environment variables above are passed as keyword arguments, with no
277 environment variables above are passed as keyword arguments, with no
278 "HG_" prefix, and names in lower case.
278 "HG_" prefix, and names in lower case.
279
279
280 A Python hook must return a "true" value to succeed. Returning a
280 A Python hook must return a "true" value to succeed. Returning a
281 "false" value or raising an exception is treated as failure of the
281 "false" value or raising an exception is treated as failure of the
282 hook.
282 hook.
283
283
284 http_proxy::
284 http_proxy::
285 Used to access web-based Mercurial repositories through a HTTP
285 Used to access web-based Mercurial repositories through a HTTP
286 proxy.
286 proxy.
287 host;;
287 host;;
288 Host name and (optional) port of the proxy server, for example
288 Host name and (optional) port of the proxy server, for example
289 "myproxy:8000".
289 "myproxy:8000".
290 no;;
290 no;;
291 Optional. Comma-separated list of host names that should bypass
291 Optional. Comma-separated list of host names that should bypass
292 the proxy.
292 the proxy.
293 passwd;;
293 passwd;;
294 Optional. Password to authenticate with at the proxy server.
294 Optional. Password to authenticate with at the proxy server.
295 user;;
295 user;;
296 Optional. User name to authenticate with at the proxy server.
296 Optional. User name to authenticate with at the proxy server.
297
297
298 smtp::
298 smtp::
299 Configuration for extensions that need to send email messages.
299 Configuration for extensions that need to send email messages.
300 host;;
300 host;;
301 Optional. Host name of mail server. Default: "mail".
301 Optional. Host name of mail server. Default: "mail".
302 port;;
302 port;;
303 Optional. Port to connect to on mail server. Default: 25.
303 Optional. Port to connect to on mail server. Default: 25.
304 tls;;
304 tls;;
305 Optional. Whether to connect to mail server using TLS. True or
305 Optional. Whether to connect to mail server using TLS. True or
306 False. Default: False.
306 False. Default: False.
307 username;;
307 username;;
308 Optional. User name to authenticate to SMTP server with.
308 Optional. User name to authenticate to SMTP server with.
309 If username is specified, password must also be specified.
309 If username is specified, password must also be specified.
310 Default: none.
310 Default: none.
311 password;;
311 password;;
312 Optional. Password to authenticate to SMTP server with.
312 Optional. Password to authenticate to SMTP server with.
313 If username is specified, password must also be specified.
313 If username is specified, password must also be specified.
314 Default: none.
314 Default: none.
315 local_hostname;;
315 local_hostname;;
316 Optional. It's the hostname that the sender can use to identify itself
316 Optional. It's the hostname that the sender can use to identify itself
317 to the MTA.
317 to the MTA.
318
318
319 paths::
319 paths::
320 Assigns symbolic names to repositories. The left side is the
320 Assigns symbolic names to repositories. The left side is the
321 symbolic name, and the right gives the directory or URL that is the
321 symbolic name, and the right gives the directory or URL that is the
322 location of the repository. Default paths can be declared by
322 location of the repository. Default paths can be declared by
323 setting the following entries.
323 setting the following entries.
324 default;;
324 default;;
325 Directory or URL to use when pulling if no source is specified.
325 Directory or URL to use when pulling if no source is specified.
326 Default is set to repository from which the current repository
326 Default is set to repository from which the current repository
327 was cloned.
327 was cloned.
328 default-push;;
328 default-push;;
329 Optional. Directory or URL to use when pushing if no destination
329 Optional. Directory or URL to use when pushing if no destination
330 is specified.
330 is specified.
331
331
332 server::
332 server::
333 Controls generic server settings.
333 Controls generic server settings.
334 uncompressed;;
334 uncompressed;;
335 Whether to allow clients to clone a repo using the uncompressed
335 Whether to allow clients to clone a repo using the uncompressed
336 streaming protocol. This transfers about 40% more data than a
336 streaming protocol. This transfers about 40% more data than a
337 regular clone, but uses less memory and CPU on both server and
337 regular clone, but uses less memory and CPU on both server and
338 client. Over a LAN (100Mbps or better) or a very fast WAN, an
338 client. Over a LAN (100Mbps or better) or a very fast WAN, an
339 uncompressed streaming clone is a lot faster (~10x) than a regular
339 uncompressed streaming clone is a lot faster (~10x) than a regular
340 clone. Over most WAN connections (anything slower than about
340 clone. Over most WAN connections (anything slower than about
341 6Mbps), uncompressed streaming is slower, because of the extra
341 6Mbps), uncompressed streaming is slower, because of the extra
342 data transfer overhead. Default is False.
342 data transfer overhead. Default is False.
343
343
344 ui::
344 ui::
345 User interface controls.
345 User interface controls.
346 debug;;
346 debug;;
347 Print debugging information. True or False. Default is False.
347 Print debugging information. True or False. Default is False.
348 editor;;
348 editor;;
349 The editor to use during a commit. Default is $EDITOR or "vi".
349 The editor to use during a commit. Default is $EDITOR or "vi".
350 ignore;;
350 ignore;;
351 A file to read per-user ignore patterns from. This file should be in
351 A file to read per-user ignore patterns from. This file should be in
352 the same format as a repository-wide .hgignore file. This option
352 the same format as a repository-wide .hgignore file. This option
353 supports hook syntax, so if you want to specify multiple ignore
353 supports hook syntax, so if you want to specify multiple ignore
354 files, you can do so by setting something like
354 files, you can do so by setting something like
355 "ignore.other = ~/.hgignore2". For details of the ignore file
355 "ignore.other = ~/.hgignore2". For details of the ignore file
356 format, see the hgignore(5) man page.
356 format, see the hgignore(5) man page.
357 interactive;;
357 interactive;;
358 Allow to prompt the user. True or False. Default is True.
358 Allow to prompt the user. True or False. Default is True.
359 logtemplate;;
359 logtemplate;;
360 Template string for commands that print changesets.
360 Template string for commands that print changesets.
361 style;;
361 style;;
362 Name of style to use for command output.
362 Name of style to use for command output.
363 merge;;
363 merge;;
364 The conflict resolution program to use during a manual merge.
364 The conflict resolution program to use during a manual merge.
365 Default is "hgmerge".
365 Default is "hgmerge".
366 quiet;;
366 quiet;;
367 Reduce the amount of output printed. True or False. Default is False.
367 Reduce the amount of output printed. True or False. Default is False.
368 remotecmd;;
368 remotecmd;;
369 remote command to use for clone/push/pull operations. Default is 'hg'.
369 remote command to use for clone/push/pull operations. Default is 'hg'.
370 ssh;;
370 ssh;;
371 command to use for SSH connections. Default is 'ssh'.
371 command to use for SSH connections. Default is 'ssh'.
372 timeout;;
372 timeout;;
373 The timeout used when a lock is held (in seconds), a negative value
373 The timeout used when a lock is held (in seconds), a negative value
374 means no timeout. Default is 600.
374 means no timeout. Default is 600.
375 username;;
375 username;;
376 The committer of a changeset created when running "commit".
376 The committer of a changeset created when running "commit".
377 Typically a person's name and email address, e.g. "Fred Widget
377 Typically a person's name and email address, e.g. "Fred Widget
378 <fred@example.com>". Default is $EMAIL or username@hostname, unless
378 <fred@example.com>". Default is $EMAIL or username@hostname, unless
379 username is set to an empty string, which enforces specifying the
379 username is set to an empty string, which enforces specifying the
380 username manually.
380 username manually.
381 verbose;;
381 verbose;;
382 Increase the amount of output printed. True or False. Default is False.
382 Increase the amount of output printed. True or False. Default is False.
383
383
384
384
385 web::
385 web::
386 Web interface configuration.
386 Web interface configuration.
387 accesslog;;
387 accesslog;;
388 Where to output the access log. Default is stdout.
388 Where to output the access log. Default is stdout.
389 address;;
389 address;;
390 Interface address to bind to. Default is all.
390 Interface address to bind to. Default is all.
391 allow_archive;;
391 allow_archive;;
392 List of archive format (bz2, gz, zip) allowed for downloading.
392 List of archive format (bz2, gz, zip) allowed for downloading.
393 Default is empty.
393 Default is empty.
394 allowbz2;;
394 allowbz2;;
395 (DEPRECATED) Whether to allow .tar.bz2 downloading of repo revisions.
395 (DEPRECATED) Whether to allow .tar.bz2 downloading of repo revisions.
396 Default is false.
396 Default is false.
397 allowgz;;
397 allowgz;;
398 (DEPRECATED) Whether to allow .tar.gz downloading of repo revisions.
398 (DEPRECATED) Whether to allow .tar.gz downloading of repo revisions.
399 Default is false.
399 Default is false.
400 allowpull;;
400 allowpull;;
401 Whether to allow pulling from the repository. Default is true.
401 Whether to allow pulling from the repository. Default is true.
402 allow_push;;
402 allow_push;;
403 Whether to allow pushing to the repository. If empty or not set,
403 Whether to allow pushing to the repository. If empty or not set,
404 push is not allowed. If the special value "*", any remote user
404 push is not allowed. If the special value "*", any remote user
405 can push, including unauthenticated users. Otherwise, the remote
405 can push, including unauthenticated users. Otherwise, the remote
406 user must have been authenticated, and the authenticated user name
406 user must have been authenticated, and the authenticated user name
407 must be present in this list (separated by whitespace or ",").
407 must be present in this list (separated by whitespace or ",").
408 The contents of the allow_push list are examined after the
408 The contents of the allow_push list are examined after the
409 deny_push list.
409 deny_push list.
410 allowzip;;
410 allowzip;;
411 (DEPRECATED) Whether to allow .zip downloading of repo revisions.
411 (DEPRECATED) Whether to allow .zip downloading of repo revisions.
412 Default is false. This feature creates temporary files.
412 Default is false. This feature creates temporary files.
413 baseurl;;
413 baseurl;;
414 Base URL to use when publishing URLs in other locations, so
414 Base URL to use when publishing URLs in other locations, so
415 third-party tools like email notification hooks can construct URLs.
415 third-party tools like email notification hooks can construct URLs.
416 Example: "http://hgserver/repos/"
416 Example: "http://hgserver/repos/"
417 contact;;
417 contact;;
418 Name or email address of the person in charge of the repository.
418 Name or email address of the person in charge of the repository.
419 Default is "unknown".
419 Default is "unknown".
420 deny_push;;
420 deny_push;;
421 Whether to deny pushing to the repository. If empty or not set,
421 Whether to deny pushing to the repository. If empty or not set,
422 push is not denied. If the special value "*", all remote users
422 push is not denied. If the special value "*", all remote users
423 are denied push. Otherwise, unauthenticated users are all denied,
423 are denied push. Otherwise, unauthenticated users are all denied,
424 and any authenticated user name present in this list (separated by
424 and any authenticated user name present in this list (separated by
425 whitespace or ",") is also denied. The contents of the deny_push
425 whitespace or ",") is also denied. The contents of the deny_push
426 list are examined before the allow_push list.
426 list are examined before the allow_push list.
427 description;;
427 description;;
428 Textual description of the repository's purpose or contents.
428 Textual description of the repository's purpose or contents.
429 Default is "unknown".
429 Default is "unknown".
430 errorlog;;
430 errorlog;;
431 Where to output the error log. Default is stderr.
431 Where to output the error log. Default is stderr.
432 ipv6;;
432 ipv6;;
433 Whether to use IPv6. Default is false.
433 Whether to use IPv6. Default is false.
434 name;;
434 name;;
435 Repository name to use in the web interface. Default is current
435 Repository name to use in the web interface. Default is current
436 working directory.
436 working directory.
437 maxchanges;;
437 maxchanges;;
438 Maximum number of changes to list on the changelog. Default is 10.
438 Maximum number of changes to list on the changelog. Default is 10.
439 maxfiles;;
439 maxfiles;;
440 Maximum number of files to list per changeset. Default is 10.
440 Maximum number of files to list per changeset. Default is 10.
441 port;;
441 port;;
442 Port to listen on. Default is 8000.
442 Port to listen on. Default is 8000.
443 push_ssl;;
443 push_ssl;;
444 Whether to require that inbound pushes be transported over SSL to
444 Whether to require that inbound pushes be transported over SSL to
445 prevent password sniffing. Default is true.
445 prevent password sniffing. Default is true.
446 stripes;;
446 stripes;;
447 How many lines a "zebra stripe" should span in multiline output.
447 How many lines a "zebra stripe" should span in multiline output.
448 Default is 1; set to 0 to disable.
448 Default is 1; set to 0 to disable.
449 style;;
449 style;;
450 Which template map style to use.
450 Which template map style to use.
451 templates;;
451 templates;;
452 Where to find the HTML templates. Default is install path.
452 Where to find the HTML templates. Default is install path.
453
453
454
454
455 AUTHOR
455 AUTHOR
456 ------
456 ------
457 Bryan O'Sullivan <bos@serpentine.com>.
457 Bryan O'Sullivan <bos@serpentine.com>.
458
458
459 Mercurial was written by Matt Mackall <mpm@selenic.com>.
459 Mercurial was written by Matt Mackall <mpm@selenic.com>.
460
460
461 SEE ALSO
461 SEE ALSO
462 --------
462 --------
463 hg(1), hgignore(5)
463 hg(1), hgignore(5)
464
464
465 COPYING
465 COPYING
466 -------
466 -------
467 This manual page is copyright 2005 Bryan O'Sullivan.
467 This manual page is copyright 2005 Bryan O'Sullivan.
468 Mercurial is copyright 2005, 2006 Matt Mackall.
468 Mercurial is copyright 2005, 2006 Matt Mackall.
469 Free use of this software is granted under the terms of the GNU General
469 Free use of this software is granted under the terms of the GNU General
470 Public License (GPL).
470 Public License (GPL).
General Comments 0
You need to be logged in to leave comments. Login now