Show More
@@ -1,255 +1,259 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 | hooks:: |
|
133 | hooks:: | |
134 | Commands that get automatically executed by various actions such as |
|
134 | Commands that get automatically executed by various actions such as | |
135 | starting or finishing a commit. Multiple commands can be run for |
|
135 | starting or finishing a commit. Multiple commands can be run for | |
136 | the same action by appending a suffix to the action. Overriding a |
|
136 | the same action by appending a suffix to the action. Overriding a | |
137 | site-wide hook can be done by changing its value or setting it to |
|
137 | site-wide hook can be done by changing its value or setting it to | |
138 | an empty string. |
|
138 | an empty string. | |
139 |
|
139 | |||
140 | Example .hg/hgrc: |
|
140 | Example .hg/hgrc: | |
141 |
|
141 | |||
142 | [hooks] |
|
142 | [hooks] | |
143 | # do not use the site-wide hook |
|
143 | # do not use the site-wide hook | |
144 |
|
|
144 | incoming = | |
145 |
|
|
145 | incoming.email = /my/email/hook | |
146 |
|
|
146 | incoming.autobuild = /my/build/hook | |
147 |
|
147 | |||
148 | changegroup;; |
|
148 | changegroup;; | |
149 | Run after a changegroup has been added via push or pull. Passed |
|
149 | Run after a changegroup has been added via push or pull. Passed | |
150 | the ID of the first new changeset in $NODE. |
|
150 | the ID of the first new changeset in $NODE. | |
151 | commit;; |
|
151 | commit;; | |
152 |
Run after a changeset has been created |
|
152 | Run after a changeset has been created in the local repository. | |
153 |
|
|
153 | Passed the ID of the newly created changeset in environment | |
154 |
|
|
154 | variable $NODE. | |
|
155 | incoming;; | |||
|
156 | Run after a changeset has been pulled, pushed, or unbundled into | |||
|
157 | the local repository. Passed the ID of the newly arrived | |||
|
158 | changeset in environment variable $NODE. | |||
155 | precommit;; |
|
159 | precommit;; | |
156 | Run before starting a commit. Exit status 0 allows the commit to |
|
160 | Run before starting a commit. Exit status 0 allows the commit to | |
157 | proceed. Non-zero status will cause the commit to fail. |
|
161 | proceed. Non-zero status will cause the commit to fail. | |
158 |
|
162 | |||
159 | http_proxy:: |
|
163 | http_proxy:: | |
160 | Used to access web-based Mercurial repositories through a HTTP |
|
164 | Used to access web-based Mercurial repositories through a HTTP | |
161 | proxy. |
|
165 | proxy. | |
162 | host;; |
|
166 | host;; | |
163 | Host name and (optional) port of the proxy server, for example |
|
167 | Host name and (optional) port of the proxy server, for example | |
164 | "myproxy:8000". |
|
168 | "myproxy:8000". | |
165 | no;; |
|
169 | no;; | |
166 | Optional. Comma-separated list of host names that should bypass |
|
170 | Optional. Comma-separated list of host names that should bypass | |
167 | the proxy. |
|
171 | the proxy. | |
168 | passwd;; |
|
172 | passwd;; | |
169 | Optional. Password to authenticate with at the proxy server. |
|
173 | Optional. Password to authenticate with at the proxy server. | |
170 | user;; |
|
174 | user;; | |
171 | Optional. User name to authenticate with at the proxy server. |
|
175 | Optional. User name to authenticate with at the proxy server. | |
172 |
|
176 | |||
173 | paths:: |
|
177 | paths:: | |
174 | Assigns symbolic names to repositories. The left side is the |
|
178 | Assigns symbolic names to repositories. The left side is the | |
175 | symbolic name, and the right gives the directory or URL that is the |
|
179 | symbolic name, and the right gives the directory or URL that is the | |
176 | location of the repository. |
|
180 | location of the repository. | |
177 |
|
181 | |||
178 | ui:: |
|
182 | ui:: | |
179 | User interface controls. |
|
183 | User interface controls. | |
180 | debug;; |
|
184 | debug;; | |
181 | Print debugging information. True or False. Default is False. |
|
185 | Print debugging information. True or False. Default is False. | |
182 | editor;; |
|
186 | editor;; | |
183 | The editor to use during a commit. Default is $EDITOR or "vi". |
|
187 | The editor to use during a commit. Default is $EDITOR or "vi". | |
184 | interactive;; |
|
188 | interactive;; | |
185 | Allow to prompt the user. True or False. Default is True. |
|
189 | Allow to prompt the user. True or False. Default is True. | |
186 | merge;; |
|
190 | merge;; | |
187 | The conflict resolution program to use during a manual merge. |
|
191 | The conflict resolution program to use during a manual merge. | |
188 | Default is "hgmerge". |
|
192 | Default is "hgmerge". | |
189 | quiet;; |
|
193 | quiet;; | |
190 | Reduce the amount of output printed. True or False. Default is False. |
|
194 | Reduce the amount of output printed. True or False. Default is False. | |
191 | remotecmd;; |
|
195 | remotecmd;; | |
192 | remote command to use for clone/push/pull operations. Default is 'hg'. |
|
196 | remote command to use for clone/push/pull operations. Default is 'hg'. | |
193 | ssh;; |
|
197 | ssh;; | |
194 | command to use for SSH connections. Default is 'ssh'. |
|
198 | command to use for SSH connections. Default is 'ssh'. | |
195 | username;; |
|
199 | username;; | |
196 | The committer of a changeset created when running "commit". |
|
200 | The committer of a changeset created when running "commit". | |
197 | Typically a person's name and email address, e.g. "Fred Widget |
|
201 | Typically a person's name and email address, e.g. "Fred Widget | |
198 | <fred@example.com>". Default is $EMAIL or username@hostname. |
|
202 | <fred@example.com>". Default is $EMAIL or username@hostname. | |
199 | verbose;; |
|
203 | verbose;; | |
200 | Increase the amount of output printed. True or False. Default is False. |
|
204 | Increase the amount of output printed. True or False. Default is False. | |
201 |
|
205 | |||
202 |
|
206 | |||
203 | web:: |
|
207 | web:: | |
204 | Web interface configuration. |
|
208 | Web interface configuration. | |
205 | accesslog;; |
|
209 | accesslog;; | |
206 | Where to output the access log. Default is stdout. |
|
210 | Where to output the access log. Default is stdout. | |
207 | address;; |
|
211 | address;; | |
208 | Interface address to bind to. Default is all. |
|
212 | Interface address to bind to. Default is all. | |
209 | allowbz2;; |
|
213 | allowbz2;; | |
210 | Whether to allow .tar.bz2 downloading of repo revisions. Default is false. |
|
214 | Whether to allow .tar.bz2 downloading of repo revisions. Default is false. | |
211 | allowgz;; |
|
215 | allowgz;; | |
212 | Whether to allow .tar.gz downloading of repo revisions. Default is false. |
|
216 | Whether to allow .tar.gz downloading of repo revisions. Default is false. | |
213 | allowpull;; |
|
217 | allowpull;; | |
214 | Whether to allow pulling from the repository. Default is true. |
|
218 | Whether to allow pulling from the repository. Default is true. | |
215 | allowzip;; |
|
219 | allowzip;; | |
216 | Whether to allow .zip downloading of repo revisions. Default is false. |
|
220 | Whether to allow .zip downloading of repo revisions. Default is false. | |
217 | This feature creates temporary files. |
|
221 | This feature creates temporary files. | |
218 | description;; |
|
222 | description;; | |
219 | Textual description of the repository's purpose or contents. |
|
223 | Textual description of the repository's purpose or contents. | |
220 | Default is "unknown". |
|
224 | Default is "unknown". | |
221 | errorlog;; |
|
225 | errorlog;; | |
222 | Where to output the error log. Default is stderr. |
|
226 | Where to output the error log. Default is stderr. | |
223 | ipv6;; |
|
227 | ipv6;; | |
224 | Whether to use IPv6. Default is false. |
|
228 | Whether to use IPv6. Default is false. | |
225 | name;; |
|
229 | name;; | |
226 | Repository name to use in the web interface. Default is current |
|
230 | Repository name to use in the web interface. Default is current | |
227 | working directory. |
|
231 | working directory. | |
228 | maxchanges;; |
|
232 | maxchanges;; | |
229 | Maximum number of changes to list on the changelog. Default is 10. |
|
233 | Maximum number of changes to list on the changelog. Default is 10. | |
230 | maxfiles;; |
|
234 | maxfiles;; | |
231 | Maximum number of files to list per changeset. Default is 10. |
|
235 | Maximum number of files to list per changeset. Default is 10. | |
232 | port;; |
|
236 | port;; | |
233 | Port to listen on. Default is 8000. |
|
237 | Port to listen on. Default is 8000. | |
234 | style;; |
|
238 | style;; | |
235 | Which template map style to use. |
|
239 | Which template map style to use. | |
236 | templates;; |
|
240 | templates;; | |
237 | Where to find the HTML templates. Default is install path. |
|
241 | Where to find the HTML templates. Default is install path. | |
238 |
|
242 | |||
239 |
|
243 | |||
240 | AUTHOR |
|
244 | AUTHOR | |
241 | ------ |
|
245 | ------ | |
242 | Bryan O'Sullivan <bos@serpentine.com>. |
|
246 | Bryan O'Sullivan <bos@serpentine.com>. | |
243 |
|
247 | |||
244 | Mercurial was written by Matt Mackall <mpm@selenic.com>. |
|
248 | Mercurial was written by Matt Mackall <mpm@selenic.com>. | |
245 |
|
249 | |||
246 | SEE ALSO |
|
250 | SEE ALSO | |
247 | -------- |
|
251 | -------- | |
248 | hg(1) |
|
252 | hg(1) | |
249 |
|
253 | |||
250 | COPYING |
|
254 | COPYING | |
251 | ------- |
|
255 | ------- | |
252 | This manual page is copyright 2005 Bryan O'Sullivan. |
|
256 | This manual page is copyright 2005 Bryan O'Sullivan. | |
253 | Mercurial is copyright 2005 Matt Mackall. |
|
257 | Mercurial is copyright 2005 Matt Mackall. | |
254 | Free use of this software is granted under the terms of the GNU General |
|
258 | Free use of this software is granted under the terms of the GNU General | |
255 | Public License (GPL). |
|
259 | Public License (GPL). |
General Comments 0
You need to be logged in to leave comments.
Login now