Mercurial > hg
comparison doc/hgrc.5.txt @ 8782:d19ab9a56bf4
doc: wrap man pages after fixing quoting
author | Martin Geisler <mg@lazybytes.net> |
---|---|
date | Thu, 11 Jun 2009 17:29:14 +0200 |
parents | 385a2d94885e |
children | ac92775b3b80 |
comparison
equal
deleted
inserted
replaced
8781:385a2d94885e | 8782:d19ab9a56bf4 |
---|---|
17 FILES | 17 FILES |
18 ----- | 18 ----- |
19 | 19 |
20 Mercurial reads configuration data from several files, if they exist. | 20 Mercurial reads configuration data from several files, if they exist. |
21 The names of these files depend on the system on which Mercurial is | 21 The names of these files depend on the system on which Mercurial is |
22 installed. `*.rc` files from a single directory are read in alphabetical | 22 installed. `*.rc` files from a single directory are read in |
23 order, later ones overriding earlier ones. Where multiple paths are | 23 alphabetical order, later ones overriding earlier ones. Where multiple |
24 given below, settings from later paths override earlier ones. | 24 paths are given below, settings from later paths override earlier |
25 ones. | |
25 | 26 |
26 (Unix) `<install-root>/etc/mercurial/hgrc.d/*.rc`:: | 27 (Unix) `<install-root>/etc/mercurial/hgrc.d/*.rc`:: |
27 (Unix) `<install-root>/etc/mercurial/hgrc`:: | 28 (Unix) `<install-root>/etc/mercurial/hgrc`:: |
28 Per-installation configuration files, searched for in the | 29 Per-installation configuration files, searched for in the |
29 directory where Mercurial is installed. `<install-root>` is the | 30 directory where Mercurial is installed. `<install-root>` is the |
46 (Windows) `C:\Mercurial\Mercurial.ini`:: | 47 (Windows) `C:\Mercurial\Mercurial.ini`:: |
47 Per-installation/system configuration files, for the system on | 48 Per-installation/system configuration files, for the system on |
48 which Mercurial is running. Options in these files apply to all | 49 which Mercurial is running. Options in these files apply to all |
49 Mercurial commands executed by any user in any directory. Registry | 50 Mercurial commands executed by any user in any directory. Registry |
50 keys contain PATH-like strings, every part of which must reference | 51 keys contain PATH-like strings, every part of which must reference |
51 a `Mercurial.ini` file or be a directory where `*.rc` files will be | 52 a `Mercurial.ini` file or be a directory where `*.rc` files will |
52 read. | 53 be read. |
53 | 54 |
54 (Unix) `$HOME/.hgrc`:: | 55 (Unix) `$HOME/.hgrc`:: |
55 (Windows) `%HOME%\Mercurial.ini`:: | 56 (Windows) `%HOME%\Mercurial.ini`:: |
56 (Windows) `%HOME%\.hgrc`:: | 57 (Windows) `%HOME%\.hgrc`:: |
57 (Windows) `%USERPROFILE%\Mercurial.ini`:: | 58 (Windows) `%USERPROFILE%\Mercurial.ini`:: |
58 (Windows) `%USERPROFILE%\.hgrc`:: | 59 (Windows) `%USERPROFILE%\.hgrc`:: |
59 Per-user configuration file(s), for the user running Mercurial. On | 60 Per-user configuration file(s), for the user running Mercurial. On |
60 Windows 9x, `%HOME%` is replaced by `%APPDATA%`. | 61 Windows 9x, `%HOME%` is replaced by `%APPDATA%`. Options in these |
61 Options in these files apply to all Mercurial commands executed by | 62 files apply to all Mercurial commands executed by this user in any |
62 this user in any directory. Options in these files override | 63 directory. Options in these files override per-installation and |
63 per-installation and per-system options. | 64 per-system options. |
64 | 65 |
65 (Unix, Windows) `<repo>/.hg/hgrc`:: | 66 (Unix, Windows) `<repo>/.hg/hgrc`:: |
66 Per-repository configuration options that only apply in a | 67 Per-repository configuration options that only apply in a |
67 particular repository. This file is not version-controlled, and | 68 particular repository. This file is not version-controlled, and |
68 will not get transferred during a "clone" operation. Options in | 69 will not get transferred during a "clone" operation. Options in |
118 creates a new command `latest` that shows only the five most recent | 119 creates a new command `latest` that shows only the five most recent |
119 changesets. You can define subsequent aliases using earlier ones: | 120 changesets. You can define subsequent aliases using earlier ones: |
120 | 121 |
121 stable5 = latest -b stable | 122 stable5 = latest -b stable |
122 | 123 |
123 NOTE: It is possible to create aliases with the same names as | 124 NOTE: It is possible to create aliases with the same names as existing |
124 existing commands, which will then override the original definitions. | 125 commands, which will then override the original definitions. This is |
125 This is almost always a bad idea! | 126 almost always a bad idea! |
126 -- | 127 -- |
127 | 128 |
128 [[auth]] | 129 [[auth]] |
129 auth:: | 130 auth:: |
130 Authentication credentials for HTTP authentication. Each line has | 131 Authentication credentials for HTTP authentication. Each line has |
142 foo.schemes = http https | 143 foo.schemes = http https |
143 | 144 |
144 Supported arguments: | 145 Supported arguments: |
145 | 146 |
146 prefix;; | 147 prefix;; |
147 Either "++\*++" or a URI prefix with or without the scheme part. The | 148 Either "++\*++" or a URI prefix with or without the scheme part. |
148 authentication entry with the longest matching prefix is used | 149 The authentication entry with the longest matching prefix is used |
149 (where "++*++" matches everything and counts as a match of length 1). | 150 (where "++*++" matches everything and counts as a match of length |
150 If the prefix doesn't include a scheme, the match is performed | 151 1). If the prefix doesn't include a scheme, the match is performed |
151 against the URI with its scheme stripped as well, and the schemes | 152 against the URI with its scheme stripped as well, and the schemes |
152 argument, q.v., is then subsequently consulted. | 153 argument, q.v., is then subsequently consulted. |
153 username;; | 154 username;; |
154 Username to authenticate with. | 155 Username to authenticate with. |
155 password;; | 156 password;; |
174 + | 175 + |
175 -- | 176 -- |
176 Filters consist of a filter pattern followed by a filter command. | 177 Filters consist of a filter pattern followed by a filter command. |
177 Filter patterns are globs by default, rooted at the repository root. | 178 Filter patterns are globs by default, rooted at the repository root. |
178 For example, to match any file ending in "`.txt`" in the root | 179 For example, to match any file ending in "`.txt`" in the root |
179 directory only, use the pattern "++\*.txt++". To match any file ending in | 180 directory only, use the pattern "++\*.txt++". To match any file ending |
180 "`.c`" anywhere in the repository, use the pattern "++**.c++". | 181 in "`.c`" anywhere in the repository, use the pattern "++**.c++". |
181 | 182 |
182 The filter command can start with a specifier, either "pipe:" or | 183 The filter command can start with a specifier, either "pipe:" or |
183 "tempfile:". If no specifier is given, "pipe:" is used by default. | 184 "tempfile:". If no specifier is given, "pipe:" is used by default. |
184 | 185 |
185 A "pipe:" command must accept data on stdin and return the | 186 A "pipe:" command must accept data on stdin and return the transformed |
186 transformed data on stdout. | 187 data on stdout. |
187 | 188 |
188 Pipe example: | 189 Pipe example: |
189 | 190 |
190 [encode] | 191 [encode] |
191 # uncompress gzip files on checkin to improve delta compression | 192 # uncompress gzip files on checkin to improve delta compression |
197 # can safely omit "pipe:", because it's the default) | 198 # can safely omit "pipe:", because it's the default) |
198 *.gz = gzip | 199 *.gz = gzip |
199 | 200 |
200 A "tempfile:" command is a template. The string INFILE is replaced | 201 A "tempfile:" command is a template. The string INFILE is replaced |
201 with the name of a temporary file that contains the data to be | 202 with the name of a temporary file that contains the data to be |
202 filtered by the command. The string OUTFILE is replaced with the | 203 filtered by the command. The string OUTFILE is replaced with the name |
203 name of an empty temporary file, where the filtered data must be | 204 of an empty temporary file, where the filtered data must be written by |
204 written by the command. | 205 the command. |
205 | 206 |
206 NOTE: the tempfile mechanism is recommended for Windows systems, | 207 NOTE: the tempfile mechanism is recommended for Windows systems, where |
207 where the standard shell I/O redirection operators often have | 208 the standard shell I/O redirection operators often have strange |
208 strange effects and may corrupt the contents of your files. | 209 effects and may corrupt the contents of your files. |
209 | 210 |
210 The most common usage is for LF <-> CRLF translation on Windows. For | 211 The most common usage is for LF <-> CRLF translation on Windows. For |
211 this, use the "smart" converters which check for binary files: | 212 this, use the "smart" converters which check for binary files: |
212 | 213 |
213 [extensions] | 214 [extensions] |
734 remote command to use for clone/push/pull operations. Default is 'hg'. | 735 remote command to use for clone/push/pull operations. Default is 'hg'. |
735 report_untrusted;; | 736 report_untrusted;; |
736 Warn if a `.hg/hgrc` file is ignored due to not being owned by a | 737 Warn if a `.hg/hgrc` file is ignored due to not being owned by a |
737 trusted user or group. True or False. Default is True. | 738 trusted user or group. True or False. Default is True. |
738 slash;; | 739 slash;; |
739 Display paths using a slash ("++/++") as the path separator. This only | 740 Display paths using a slash ("++/++") as the path separator. This |
740 makes a difference on systems where the default path separator is | 741 only makes a difference on systems where the default path |
741 not the slash character (e.g. Windows uses the backslash character | 742 separator is not the slash character (e.g. Windows uses the |
742 ("++\++")). | 743 backslash character ("++\++")). |
743 Default is False. | 744 Default is False. |
744 ssh;; | 745 ssh;; |
745 command to use for SSH connections. Default is 'ssh'. | 746 command to use for SSH connections. Default is 'ssh'. |
746 strict;; | 747 strict;; |
747 Require exact command names, instead of allowing unambiguous | 748 Require exact command names, instead of allowing unambiguous |