Mercurial > hg
comparison mercurial/help/config.txt @ 26182:6832ba528d1a
help/config: make defaults consistent
author | timeless@mozdev.org |
---|---|
date | Wed, 02 Sep 2015 13:39:46 -0400 |
parents | c16f071f048e |
children | e257df7a9974 |
comparison
equal
deleted
inserted
replaced
26181:c16f071f048e | 26182:6832ba528d1a |
---|---|
346 ``schemes`` | 346 ``schemes`` |
347 Optional. Space separated list of URI schemes to use this | 347 Optional. Space separated list of URI schemes to use this |
348 authentication entry with. Only used if the prefix doesn't include | 348 authentication entry with. Only used if the prefix doesn't include |
349 a scheme. Supported schemes are http and https. They will match | 349 a scheme. Supported schemes are http and https. They will match |
350 static-http and static-https respectively, as well. | 350 static-http and static-https respectively, as well. |
351 Default: https. | 351 (default: https) |
352 | 352 |
353 If no suitable authentication entry is found, the user is prompted | 353 If no suitable authentication entry is found, the user is prompted |
354 for credentials as usual if required by the remote. | 354 for credentials as usual if required by the remote. |
355 | 355 |
356 | 356 |
599 Optional. Comma-separated list of character sets considered | 599 Optional. Comma-separated list of character sets considered |
600 convenient for recipients. Addresses, headers, and parts not | 600 convenient for recipients. Addresses, headers, and parts not |
601 containing patches of outgoing messages will be encoded in the | 601 containing patches of outgoing messages will be encoded in the |
602 first character set to which conversion from local encoding | 602 first character set to which conversion from local encoding |
603 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct | 603 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct |
604 conversion fails, the text in question is sent as is. Defaults to | 604 conversion fails, the text in question is sent as is. |
605 empty (explicit) list. | 605 (default: '') |
606 | 606 |
607 Order of outgoing email character sets: | 607 Order of outgoing email character sets: |
608 | 608 |
609 1. ``us-ascii``: always first, regardless of settings | 609 1. ``us-ascii``: always first, regardless of settings |
610 2. ``email.charsets``: in order given by user | 610 2. ``email.charsets``: in order given by user |
953 ``user`` | 953 ``user`` |
954 Optional. User name to authenticate with at the proxy server. | 954 Optional. User name to authenticate with at the proxy server. |
955 | 955 |
956 ``always`` | 956 ``always`` |
957 Optional. Always use the proxy, even for localhost and any entries | 957 Optional. Always use the proxy, even for localhost and any entries |
958 in ``http_proxy.no``. True or False. Default: False. | 958 in ``http_proxy.no``. True or False. (default: False) |
959 | 959 |
960 ``merge-patterns`` | 960 ``merge-patterns`` |
961 ------------------ | 961 ------------------ |
962 | 962 |
963 This section specifies merge tools to associate with particular file | 963 This section specifies merge tools to associate with particular file |
999 | 999 |
1000 Supported arguments: | 1000 Supported arguments: |
1001 | 1001 |
1002 ``priority`` | 1002 ``priority`` |
1003 The priority in which to evaluate this tool. | 1003 The priority in which to evaluate this tool. |
1004 Default: 0. | 1004 (default: 0) |
1005 | 1005 |
1006 ``executable`` | 1006 ``executable`` |
1007 Either just the name of the executable or its pathname. On Windows, | 1007 Either just the name of the executable or its pathname. On Windows, |
1008 the path can use environment variables with ${ProgramFiles} syntax. | 1008 the path can use environment variables with ${ProgramFiles} syntax. |
1009 Default: the tool name. | 1009 (default: the tool name) |
1010 | 1010 |
1011 ``args`` | 1011 ``args`` |
1012 The arguments to pass to the tool executable. You can refer to the | 1012 The arguments to pass to the tool executable. You can refer to the |
1013 files being merged as well as the output file through these | 1013 files being merged as well as the output file through these |
1014 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning | 1014 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning |
1016 performed. During and update or merge, ``$local`` represents the original | 1016 performed. During and update or merge, ``$local`` represents the original |
1017 state of the file, while ``$other`` represents the commit you are updating | 1017 state of the file, while ``$other`` represents the commit you are updating |
1018 to or the commit you are merging with. During a rebase ``$local`` | 1018 to or the commit you are merging with. During a rebase ``$local`` |
1019 represents the destination of the rebase, and ``$other`` represents the | 1019 represents the destination of the rebase, and ``$other`` represents the |
1020 commit being rebased. | 1020 commit being rebased. |
1021 Default: ``$local $base $other`` | 1021 (default: ``$local $base $other``) |
1022 | 1022 |
1023 ``premerge`` | 1023 ``premerge`` |
1024 Attempt to run internal non-interactive 3-way merge tool before | 1024 Attempt to run internal non-interactive 3-way merge tool before |
1025 launching external tool. Options are ``true``, ``false``, ``keep`` or | 1025 launching external tool. Options are ``true``, ``false``, ``keep`` or |
1026 ``keep-merge3``. The ``keep`` option will leave markers in the file if the | 1026 ``keep-merge3``. The ``keep`` option will leave markers in the file if the |
1027 premerge fails. The ``keep-merge3`` will do the same but include information | 1027 premerge fails. The ``keep-merge3`` will do the same but include information |
1028 about the base of the merge in the marker (see internal :merge3 in | 1028 about the base of the merge in the marker (see internal :merge3 in |
1029 :hg:`help merge-tools`). | 1029 :hg:`help merge-tools`). |
1030 Default: True | 1030 (default: True) |
1031 | 1031 |
1032 ``binary`` | 1032 ``binary`` |
1033 This tool can merge binary files. Defaults to False, unless tool | 1033 This tool can merge binary files. (default: False, unless tool |
1034 was selected by file pattern match. | 1034 was selected by file pattern match) |
1035 | 1035 |
1036 ``symlink`` | 1036 ``symlink`` |
1037 This tool can merge symlinks. Defaults to False, even if tool was | 1037 This tool can merge symlinks. (default: False) |
1038 selected by file pattern match. | |
1039 | 1038 |
1040 ``check`` | 1039 ``check`` |
1041 A list of merge success-checking options:: | 1040 A list of merge success-checking options:: |
1042 | 1041 |
1043 ``changed`` | 1042 ``changed`` |
1047 ``prompt`` | 1046 ``prompt`` |
1048 Always prompt for merge success, regardless of success reported by tool. | 1047 Always prompt for merge success, regardless of success reported by tool. |
1049 | 1048 |
1050 ``fixeol`` | 1049 ``fixeol`` |
1051 Attempt to fix up EOL changes caused by the merge tool. | 1050 Attempt to fix up EOL changes caused by the merge tool. |
1052 Default: False | 1051 (default: False) |
1053 | 1052 |
1054 ``gui`` | 1053 ``gui`` |
1055 This tool requires a graphical interface to run. Default: False | 1054 This tool requires a graphical interface to run. (default: False) |
1056 | 1055 |
1057 ``regkey`` | 1056 ``regkey`` |
1058 Windows registry key which describes install location of this | 1057 Windows registry key which describes install location of this |
1059 tool. Mercurial will search for this key first under | 1058 tool. Mercurial will search for this key first under |
1060 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. | 1059 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. |
1061 Default: None | 1060 (default: None) |
1062 | 1061 |
1063 ``regkeyalt`` | 1062 ``regkeyalt`` |
1064 An alternate Windows registry key to try if the first key is not | 1063 An alternate Windows registry key to try if the first key is not |
1065 found. The alternate key uses the same ``regname`` and ``regappend`` | 1064 found. The alternate key uses the same ``regname`` and ``regappend`` |
1066 semantics of the primary key. The most common use for this key | 1065 semantics of the primary key. The most common use for this key |
1067 is to search for 32bit applications on 64bit operating systems. | 1066 is to search for 32bit applications on 64bit operating systems. |
1068 Default: None | 1067 (default: None) |
1069 | 1068 |
1070 ``regname`` | 1069 ``regname`` |
1071 Name of value to read from specified registry key. Defaults to the | 1070 Name of value to read from specified registry key. |
1072 unnamed (default) value. | 1071 (default: the unnamed (default) value) |
1073 | 1072 |
1074 ``regappend`` | 1073 ``regappend`` |
1075 String to append to the value read from the registry, typically | 1074 String to append to the value read from the registry, typically |
1076 the executable name of the tool. | 1075 the executable name of the tool. |
1077 Default: None | 1076 (default: None) |
1078 | 1077 |
1079 | 1078 |
1080 ``patch`` | 1079 ``patch`` |
1081 --------- | 1080 --------- |
1082 | 1081 |
1090 normalized to either LF (Unix) or CRLF (Windows). When set to | 1089 normalized to either LF (Unix) or CRLF (Windows). When set to |
1091 ``auto``, end of lines are again ignored while patching but line | 1090 ``auto``, end of lines are again ignored while patching but line |
1092 endings in patched files are normalized to their original setting | 1091 endings in patched files are normalized to their original setting |
1093 on a per-file basis. If target file does not exist or has no end | 1092 on a per-file basis. If target file does not exist or has no end |
1094 of line, patch line endings are preserved. | 1093 of line, patch line endings are preserved. |
1095 Default: strict. | 1094 (default: strict) |
1096 | 1095 |
1097 ``fuzz`` | 1096 ``fuzz`` |
1098 The number of lines of 'fuzz' to allow when applying patches. This | 1097 The number of lines of 'fuzz' to allow when applying patches. This |
1099 controls how much context the patcher is allowed to ignore when | 1098 controls how much context the patcher is allowed to ignore when |
1100 trying to apply a patch. | 1099 trying to apply a patch. |
1101 Default: 2 | 1100 (default: 2) |
1102 | 1101 |
1103 ``paths`` | 1102 ``paths`` |
1104 --------- | 1103 --------- |
1105 | 1104 |
1106 Assigns symbolic names to repositories. The left side is the | 1105 Assigns symbolic names to repositories. The left side is the |
1108 location of the repository. Default paths can be declared by setting | 1107 location of the repository. Default paths can be declared by setting |
1109 the following entries. | 1108 the following entries. |
1110 | 1109 |
1111 ``default`` | 1110 ``default`` |
1112 Directory or URL to use when pulling if no source is specified. | 1111 Directory or URL to use when pulling if no source is specified. |
1113 Default is set to repository from which the current repository was | 1112 (default: repository from which the current repository was cloned) |
1114 cloned. | |
1115 | 1113 |
1116 ``default-push`` | 1114 ``default-push`` |
1117 Optional. Directory or URL to use when pushing if no destination | 1115 Optional. Directory or URL to use when pushing if no destination |
1118 is specified. | 1116 is specified. |
1119 | 1117 |
1136 | 1134 |
1137 ``publish`` | 1135 ``publish`` |
1138 Controls draft phase behavior when working as a server. When true, | 1136 Controls draft phase behavior when working as a server. When true, |
1139 pushed changesets are set to public in both client and server and | 1137 pushed changesets are set to public in both client and server and |
1140 pulled or cloned changesets are set to public in the client. | 1138 pulled or cloned changesets are set to public in the client. |
1141 Default: True | 1139 (default: True) |
1142 | 1140 |
1143 ``new-commit`` | 1141 ``new-commit`` |
1144 Phase of newly-created commits. | 1142 Phase of newly-created commits. |
1145 Default: draft | 1143 (default: draft) |
1146 | 1144 |
1147 ``checksubrepos`` | 1145 ``checksubrepos`` |
1148 Check the phase of the current revision of each subrepository. Allowed | 1146 Check the phase of the current revision of each subrepository. Allowed |
1149 values are "ignore", "follow" and "abort". For settings other than | 1147 values are "ignore", "follow" and "abort". For settings other than |
1150 "ignore", the phase of the current revision of each subrepository is | 1148 "ignore", the phase of the current revision of each subrepository is |
1151 checked before committing the parent repository. If any of those phases is | 1149 checked before committing the parent repository. If any of those phases is |
1152 greater than the phase of the parent repository (e.g. if a subrepo is in a | 1150 greater than the phase of the parent repository (e.g. if a subrepo is in a |
1153 "secret" phase while the parent repo is in "draft" phase), the commit is | 1151 "secret" phase while the parent repo is in "draft" phase), the commit is |
1154 either aborted (if checksubrepos is set to "abort") or the higher phase is | 1152 either aborted (if checksubrepos is set to "abort") or the higher phase is |
1155 used for the parent repository commit (if set to "follow"). | 1153 used for the parent repository commit (if set to "follow"). |
1156 Default: "follow" | 1154 (default: follow) |
1157 | 1155 |
1158 | 1156 |
1159 ``profiling`` | 1157 ``profiling`` |
1160 ------------- | 1158 ------------- |
1161 | 1159 |
1168 statistical text report generated from the profiling data. The | 1166 statistical text report generated from the profiling data. The |
1169 profiling is done using lsprof. | 1167 profiling is done using lsprof. |
1170 | 1168 |
1171 ``type`` | 1169 ``type`` |
1172 The type of profiler to use. | 1170 The type of profiler to use. |
1173 Default: ls. | 1171 (default: ls) |
1174 | 1172 |
1175 ``ls`` | 1173 ``ls`` |
1176 Use Python's built-in instrumenting profiler. This profiler | 1174 Use Python's built-in instrumenting profiler. This profiler |
1177 works on all platforms, but each line number it reports is the | 1175 works on all platforms, but each line number it reports is the |
1178 first line of a function. This restriction makes it difficult to | 1176 first line of a function. This restriction makes it difficult to |
1182 currently runs only on Unix systems, and is most useful for | 1180 currently runs only on Unix systems, and is most useful for |
1183 profiling commands that run for longer than about 0.1 seconds. | 1181 profiling commands that run for longer than about 0.1 seconds. |
1184 | 1182 |
1185 ``format`` | 1183 ``format`` |
1186 Profiling format. Specific to the ``ls`` instrumenting profiler. | 1184 Profiling format. Specific to the ``ls`` instrumenting profiler. |
1187 Default: text. | 1185 (default: text) |
1188 | 1186 |
1189 ``text`` | 1187 ``text`` |
1190 Generate a profiling report. When saving to a file, it should be | 1188 Generate a profiling report. When saving to a file, it should be |
1191 noted that only the report is saved, and the profiling data is | 1189 noted that only the report is saved, and the profiling data is |
1192 not kept. | 1190 not kept. |
1195 file, the generated file can directly be loaded into | 1193 file, the generated file can directly be loaded into |
1196 kcachegrind. | 1194 kcachegrind. |
1197 | 1195 |
1198 ``frequency`` | 1196 ``frequency`` |
1199 Sampling frequency. Specific to the ``stat`` sampling profiler. | 1197 Sampling frequency. Specific to the ``stat`` sampling profiler. |
1200 Default: 1000. | 1198 (default: 1000) |
1201 | 1199 |
1202 ``output`` | 1200 ``output`` |
1203 File path where profiling data or report should be saved. If the | 1201 File path where profiling data or report should be saved. If the |
1204 file exists, it is replaced. Default: None, data is printed on | 1202 file exists, it is replaced. (default: None, data is printed on |
1205 stderr | 1203 stderr) |
1206 | 1204 |
1207 ``sort`` | 1205 ``sort`` |
1208 Sort field. Specific to the ``ls`` instrumenting profiler. | 1206 Sort field. Specific to the ``ls`` instrumenting profiler. |
1209 One of ``callcount``, ``reccallcount``, ``totaltime`` and | 1207 One of ``callcount``, ``reccallcount``, ``totaltime`` and |
1210 ``inlinetime``. | 1208 ``inlinetime``. |
1211 Default: inlinetime. | 1209 (default: inlinetime) |
1212 | 1210 |
1213 ``limit`` | 1211 ``limit`` |
1214 Number of lines to show. Specific to the ``ls`` instrumenting profiler. | 1212 Number of lines to show. Specific to the ``ls`` instrumenting profiler. |
1215 Default: 30. | 1213 (default: 30) |
1216 | 1214 |
1217 ``nested`` | 1215 ``nested`` |
1218 Show at most this number of lines of drill-down info after each main entry. | 1216 Show at most this number of lines of drill-down info after each main entry. |
1219 This can help explain the difference between Total and Inline. | 1217 This can help explain the difference between Total and Inline. |
1220 Specific to the ``ls`` instrumenting profiler. | 1218 Specific to the ``ls`` instrumenting profiler. |
1221 Default: 5. | 1219 (default: 5) |
1222 | 1220 |
1223 ``progress`` | 1221 ``progress`` |
1224 ------------ | 1222 ------------ |
1225 | 1223 |
1226 Mercurial commands can draw progress bars that are as informative as | 1224 Mercurial commands can draw progress bars that are as informative as |
1251 ``width`` | 1249 ``width`` |
1252 If set, the maximum width of the progress information (that is, min(width, | 1250 If set, the maximum width of the progress information (that is, min(width, |
1253 term width) will be used). | 1251 term width) will be used). |
1254 | 1252 |
1255 ``clear-complete`` | 1253 ``clear-complete`` |
1256 clear the progress bar after it's done (default to True) | 1254 clear the progress bar after it's done. (default: True) |
1257 | 1255 |
1258 ``disable`` | 1256 ``disable`` |
1259 If true, don't show a progress bar. | 1257 If true, don't show a progress bar. |
1260 | 1258 |
1261 ``assume-tty`` | 1259 ``assume-tty`` |
1279 WAN, an uncompressed streaming clone is a lot faster (~10x) than a | 1277 WAN, an uncompressed streaming clone is a lot faster (~10x) than a |
1280 regular clone. Over most WAN connections (anything slower than | 1278 regular clone. Over most WAN connections (anything slower than |
1281 about 6 Mbps), uncompressed streaming is slower, because of the | 1279 about 6 Mbps), uncompressed streaming is slower, because of the |
1282 extra data transfer overhead. This mode will also temporarily hold | 1280 extra data transfer overhead. This mode will also temporarily hold |
1283 the write lock while determining what data to transfer. | 1281 the write lock while determining what data to transfer. |
1284 Default is True. | 1282 (default: True) |
1285 | 1283 |
1286 ``preferuncompressed`` | 1284 ``preferuncompressed`` |
1287 When set, clients will try to use the uncompressed streaming | 1285 When set, clients will try to use the uncompressed streaming |
1288 protocol. Default is False. | 1286 protocol. (default: False) |
1289 | 1287 |
1290 ``validate`` | 1288 ``validate`` |
1291 Whether to validate the completeness of pushed changesets by | 1289 Whether to validate the completeness of pushed changesets by |
1292 checking that all new file revisions specified in manifests are | 1290 checking that all new file revisions specified in manifests are |
1293 present. Default is False. | 1291 present. (default: False) |
1294 | 1292 |
1295 ``maxhttpheaderlen`` | 1293 ``maxhttpheaderlen`` |
1296 Instruct HTTP clients not to send request headers longer than this | 1294 Instruct HTTP clients not to send request headers longer than this |
1297 many bytes. Default is 1024. | 1295 many bytes. (default: 1024) |
1298 | 1296 |
1299 ``smtp`` | 1297 ``smtp`` |
1300 -------- | 1298 -------- |
1301 | 1299 |
1302 Configuration for extensions that need to send email messages. | 1300 Configuration for extensions that need to send email messages. |
1303 | 1301 |
1304 ``host`` | 1302 ``host`` |
1305 Host name of mail server, e.g. "mail.example.com". | 1303 Host name of mail server, e.g. "mail.example.com". |
1306 | 1304 |
1307 ``port`` | 1305 ``port`` |
1308 Optional. Port to connect to on mail server. Default: 465 (if | 1306 Optional. Port to connect to on mail server. (default: 465 if |
1309 ``tls`` is smtps) or 25 (otherwise). | 1307 ``tls`` is smtps; 25 otherwise) |
1310 | 1308 |
1311 ``tls`` | 1309 ``tls`` |
1312 Optional. Method to enable TLS when connecting to mail server: starttls, | 1310 Optional. Method to enable TLS when connecting to mail server: starttls, |
1313 smtps or none. Default: none. | 1311 smtps or none. (default: none) |
1314 | 1312 |
1315 ``verifycert`` | 1313 ``verifycert`` |
1316 Optional. Verification for the certificate of mail server, when | 1314 Optional. Verification for the certificate of mail server, when |
1317 ``tls`` is starttls or smtps. "strict", "loose" or False. For | 1315 ``tls`` is starttls or smtps. "strict", "loose" or False. For |
1318 "strict" or "loose", the certificate is verified as same as the | 1316 "strict" or "loose", the certificate is verified as same as the |
1319 verification for HTTPS connections (see ``[hostfingerprints]`` and | 1317 verification for HTTPS connections (see ``[hostfingerprints]`` and |
1320 ``[web] cacerts`` also). For "strict", sending email is also | 1318 ``[web] cacerts`` also). For "strict", sending email is also |
1321 aborted, if there is no configuration for mail server in | 1319 aborted, if there is no configuration for mail server in |
1322 ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for | 1320 ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for |
1323 :hg:`email` overwrites this as "loose". Default: "strict". | 1321 :hg:`email` overwrites this as "loose". (default: strict) |
1324 | 1322 |
1325 ``username`` | 1323 ``username`` |
1326 Optional. User name for authenticating with the SMTP server. | 1324 Optional. User name for authenticating with the SMTP server. |
1327 Default: none. | 1325 (default: None) |
1328 | 1326 |
1329 ``password`` | 1327 ``password`` |
1330 Optional. Password for authenticating with the SMTP server. If not | 1328 Optional. Password for authenticating with the SMTP server. If not |
1331 specified, interactive sessions will prompt the user for a | 1329 specified, interactive sessions will prompt the user for a |
1332 password; non-interactive sessions will fail. Default: none. | 1330 password; non-interactive sessions will fail. (default: None) |
1333 | 1331 |
1334 ``local_hostname`` | 1332 ``local_hostname`` |
1335 Optional. The hostname that the sender can use to identify | 1333 Optional. The hostname that the sender can use to identify |
1336 itself to the MTA. | 1334 itself to the MTA. |
1337 | 1335 |
1389 | 1387 |
1390 ``archivemeta`` | 1388 ``archivemeta`` |
1391 Whether to include the .hg_archival.txt file containing meta data | 1389 Whether to include the .hg_archival.txt file containing meta data |
1392 (hashes for the repository base and for tip) in archives created | 1390 (hashes for the repository base and for tip) in archives created |
1393 by the :hg:`archive` command or downloaded via hgweb. | 1391 by the :hg:`archive` command or downloaded via hgweb. |
1394 Default is True. | 1392 (default: True) |
1395 | 1393 |
1396 ``askusername`` | 1394 ``askusername`` |
1397 Whether to prompt for a username when committing. If True, and | 1395 Whether to prompt for a username when committing. If True, and |
1398 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will | 1396 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will |
1399 be prompted to enter a username. If no username is entered, the | 1397 be prompted to enter a username. If no username is entered, the |
1400 default ``USER@HOST`` is used instead. | 1398 default ``USER@HOST`` is used instead. |
1401 Default is False. | 1399 (default: False) |
1402 | 1400 |
1403 ``commitsubrepos`` | 1401 ``commitsubrepos`` |
1404 Whether to commit modified subrepositories when committing the | 1402 Whether to commit modified subrepositories when committing the |
1405 parent repository. If False and one subrepository has uncommitted | 1403 parent repository. If False and one subrepository has uncommitted |
1406 changes, abort the commit. | 1404 changes, abort the commit. |
1407 Default is False. | 1405 (default: False) |
1408 | 1406 |
1409 ``debug`` | 1407 ``debug`` |
1410 Print debugging information. True or False. Default is False. | 1408 Print debugging information. True or False. (default: False) |
1411 | 1409 |
1412 ``editor`` | 1410 ``editor`` |
1413 The editor to use during a commit. Default is ``$EDITOR`` or ``vi``. | 1411 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``) |
1414 | 1412 |
1415 ``fallbackencoding`` | 1413 ``fallbackencoding`` |
1416 Encoding to try if it's not possible to decode the changelog using | 1414 Encoding to try if it's not possible to decode the changelog using |
1417 UTF-8. Default is ISO-8859-1. | 1415 UTF-8. (default: ISO-8859-1) |
1418 | 1416 |
1419 ``ignore`` | 1417 ``ignore`` |
1420 A file to read per-user ignore patterns from. This file should be | 1418 A file to read per-user ignore patterns from. This file should be |
1421 in the same format as a repository-wide .hgignore file. Filenames | 1419 in the same format as a repository-wide .hgignore file. Filenames |
1422 are relative to the repository root. This option supports hook syntax, | 1420 are relative to the repository root. This option supports hook syntax, |
1423 so if you want to specify multiple ignore files, you can do so by | 1421 so if you want to specify multiple ignore files, you can do so by |
1424 setting something like ``ignore.other = ~/.hgignore2``. For details | 1422 setting something like ``ignore.other = ~/.hgignore2``. For details |
1425 of the ignore file format, see the ``hgignore(5)`` man page. | 1423 of the ignore file format, see the ``hgignore(5)`` man page. |
1426 | 1424 |
1427 ``interactive`` | 1425 ``interactive`` |
1428 Allow to prompt the user. True or False. Default is True. | 1426 Allow to prompt the user. True or False. (default: True) |
1429 | 1427 |
1430 ``logtemplate`` | 1428 ``logtemplate`` |
1431 Template string for commands that print changesets. | 1429 Template string for commands that print changesets. |
1432 | 1430 |
1433 ``merge`` | 1431 ``merge`` |
1438 ``mergemarkers`` | 1436 ``mergemarkers`` |
1439 Sets the merge conflict marker label styling. The ``detailed`` | 1437 Sets the merge conflict marker label styling. The ``detailed`` |
1440 style uses the ``mergemarkertemplate`` setting to style the labels. | 1438 style uses the ``mergemarkertemplate`` setting to style the labels. |
1441 The ``basic`` style just uses 'local' and 'other' as the marker label. | 1439 The ``basic`` style just uses 'local' and 'other' as the marker label. |
1442 One of ``basic`` or ``detailed``. | 1440 One of ``basic`` or ``detailed``. |
1443 Default is ``basic``. | 1441 (default: ``basic``) |
1444 | 1442 |
1445 ``mergemarkertemplate`` | 1443 ``mergemarkertemplate`` |
1446 The template used to print the commit description next to each conflict | 1444 The template used to print the commit description next to each conflict |
1447 marker during merge conflicts. See :hg:`help templates` for the template | 1445 marker during merge conflicts. See :hg:`help templates` for the template |
1448 format. | 1446 format. |
1471 arguments. For example, setting this option to ``patch --merge`` | 1469 arguments. For example, setting this option to ``patch --merge`` |
1472 will use the ``patch`` program with its 2-way merge option. | 1470 will use the ``patch`` program with its 2-way merge option. |
1473 | 1471 |
1474 ``portablefilenames`` | 1472 ``portablefilenames`` |
1475 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``. | 1473 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``. |
1476 Default is ``warn``. | 1474 (default: ``warn``) |
1477 If set to ``warn`` (or ``true``), a warning message is printed on POSIX | 1475 If set to ``warn`` (or ``true``), a warning message is printed on POSIX |
1478 platforms, if a file with a non-portable filename is added (e.g. a file | 1476 platforms, if a file with a non-portable filename is added (e.g. a file |
1479 with a name that can't be created on Windows because it contains reserved | 1477 with a name that can't be created on Windows because it contains reserved |
1480 parts like ``AUX``, reserved characters like ``:``, or would cause a case | 1478 parts like ``AUX``, reserved characters like ``:``, or would cause a case |
1481 collision with an existing file). | 1479 collision with an existing file). |
1482 If set to ``ignore`` (or ``false``), no warning is printed. | 1480 If set to ``ignore`` (or ``false``), no warning is printed. |
1483 If set to ``abort``, the command is aborted. | 1481 If set to ``abort``, the command is aborted. |
1484 On Windows, this configuration option is ignored and the command aborted. | 1482 On Windows, this configuration option is ignored and the command aborted. |
1485 | 1483 |
1486 ``quiet`` | 1484 ``quiet`` |
1487 Reduce the amount of output printed. True or False. Default is False. | 1485 Reduce the amount of output printed. True or False. (default: False) |
1488 | 1486 |
1489 ``remotecmd`` | 1487 ``remotecmd`` |
1490 remote command to use for clone/push/pull operations. Default is ``hg``. | 1488 remote command to use for clone/push/pull operations. (default: ``hg``) |
1491 | 1489 |
1492 ``report_untrusted`` | 1490 ``report_untrusted`` |
1493 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a | 1491 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a |
1494 trusted user or group. True or False. Default is True. | 1492 trusted user or group. True or False. (default: True) |
1495 | 1493 |
1496 ``slash`` | 1494 ``slash`` |
1497 Display paths using a slash (``/``) as the path separator. This | 1495 Display paths using a slash (``/``) as the path separator. This |
1498 only makes a difference on systems where the default path | 1496 only makes a difference on systems where the default path |
1499 separator is not the slash character (e.g. Windows uses the | 1497 separator is not the slash character (e.g. Windows uses the |
1500 backslash character (``\``)). | 1498 backslash character (``\``)). |
1501 Default is False. | 1499 (default: False) |
1502 | 1500 |
1503 ``statuscopies`` | 1501 ``statuscopies`` |
1504 Display copies in the status command. | 1502 Display copies in the status command. |
1505 | 1503 |
1506 ``ssh`` | 1504 ``ssh`` |
1507 command to use for SSH connections. Default is ``ssh``. | 1505 command to use for SSH connections. (default: ``ssh``) |
1508 | 1506 |
1509 ``strict`` | 1507 ``strict`` |
1510 Require exact command names, instead of allowing unambiguous | 1508 Require exact command names, instead of allowing unambiguous |
1511 abbreviations. True or False. Default is False. | 1509 abbreviations. True or False. (default: False) |
1512 | 1510 |
1513 ``style`` | 1511 ``style`` |
1514 Name of style to use for command output. | 1512 Name of style to use for command output. |
1515 | 1513 |
1516 ``timeout`` | 1514 ``timeout`` |
1517 The timeout used when a lock is held (in seconds), a negative value | 1515 The timeout used when a lock is held (in seconds), a negative value |
1518 means no timeout. Default is 600. | 1516 means no timeout. (default: 600) |
1519 | 1517 |
1520 ``traceback`` | 1518 ``traceback`` |
1521 Mercurial always prints a traceback when an unknown exception | 1519 Mercurial always prints a traceback when an unknown exception |
1522 occurs. Setting this to True will make Mercurial print a traceback | 1520 occurs. Setting this to True will make Mercurial print a traceback |
1523 on all exceptions, even those recognized by Mercurial (such as | 1521 on all exceptions, even those recognized by Mercurial (such as |
1524 IOError or MemoryError). Default is False. | 1522 IOError or MemoryError). (default: False) |
1525 | 1523 |
1526 ``username`` | 1524 ``username`` |
1527 The committer of a changeset created when running "commit". | 1525 The committer of a changeset created when running "commit". |
1528 Typically a person's name and email address, e.g. ``Fred Widget | 1526 Typically a person's name and email address, e.g. ``Fred Widget |
1529 <fred@example.com>``. Default is ``$EMAIL`` or ``username@hostname``. If | 1527 <fred@example.com>``. Environment variables in the |
1530 the username in hgrc is empty, it has to be specified manually or | |
1531 in a different hgrc file (e.g. ``$HOME/.hgrc``, if the admin set | |
1532 ``username =`` in the system hgrc). Environment variables in the | |
1533 username are expanded. | 1528 username are expanded. |
1534 | 1529 |
1530 (default: ``$EMAIL`` or ``username@hostname``. If the username in | |
1531 hgrc is empty, e.g. if the system admin set ``username =`` in the | |
1532 system hgrc, it has to be specified manually or in a different | |
1533 hgrc file) | |
1534 | |
1535 ``verbose`` | 1535 ``verbose`` |
1536 Increase the amount of output printed. True or False. Default is False. | 1536 Increase the amount of output printed. True or False. (default: False) |
1537 | 1537 |
1538 | 1538 |
1539 ``web`` | 1539 ``web`` |
1540 ------- | 1540 ------- |
1541 | 1541 |
1561 that this should not be used for public servers. | 1561 that this should not be used for public servers. |
1562 | 1562 |
1563 The full set of options is: | 1563 The full set of options is: |
1564 | 1564 |
1565 ``accesslog`` | 1565 ``accesslog`` |
1566 Where to output the access log. Default is stdout. | 1566 Where to output the access log. (default: stdout) |
1567 | 1567 |
1568 ``address`` | 1568 ``address`` |
1569 Interface address to bind to. Default is all. | 1569 Interface address to bind to. (default: all) |
1570 | 1570 |
1571 ``allow_archive`` | 1571 ``allow_archive`` |
1572 List of archive format (bz2, gz, zip) allowed for downloading. | 1572 List of archive format (bz2, gz, zip) allowed for downloading. |
1573 Default is empty. | 1573 (default: empty) |
1574 | 1574 |
1575 ``allowbz2`` | 1575 ``allowbz2`` |
1576 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository | 1576 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository |
1577 revisions. | 1577 revisions. |
1578 Default is False. | 1578 (default: False) |
1579 | 1579 |
1580 ``allowgz`` | 1580 ``allowgz`` |
1581 (DEPRECATED) Whether to allow .tar.gz downloading of repository | 1581 (DEPRECATED) Whether to allow .tar.gz downloading of repository |
1582 revisions. | 1582 revisions. |
1583 Default is False. | 1583 (default: False) |
1584 | 1584 |
1585 ``allowpull`` | 1585 ``allowpull`` |
1586 Whether to allow pulling from the repository. Default is True. | 1586 Whether to allow pulling from the repository. (default: True) |
1587 | 1587 |
1588 ``allow_push`` | 1588 ``allow_push`` |
1589 Whether to allow pushing to the repository. If empty or not set, | 1589 Whether to allow pushing to the repository. If empty or not set, |
1590 pushing is not allowed. If the special value ``*``, any remote | 1590 pushing is not allowed. If the special value ``*``, any remote |
1591 user can push, including unauthenticated users. Otherwise, the | 1591 user can push, including unauthenticated users. Otherwise, the |
1604 is permitted to all users). The contents of the allow_read list are | 1604 is permitted to all users). The contents of the allow_read list are |
1605 examined after the deny_read list. | 1605 examined after the deny_read list. |
1606 | 1606 |
1607 ``allowzip`` | 1607 ``allowzip`` |
1608 (DEPRECATED) Whether to allow .zip downloading of repository | 1608 (DEPRECATED) Whether to allow .zip downloading of repository |
1609 revisions. Default is False. This feature creates temporary files. | 1609 revisions. This feature creates temporary files. |
1610 (default: False) | |
1610 | 1611 |
1611 ``archivesubrepos`` | 1612 ``archivesubrepos`` |
1612 Whether to recurse into subrepositories when archiving. Default is | 1613 Whether to recurse into subrepositories when archiving. |
1613 False. | 1614 (default: False) |
1614 | 1615 |
1615 ``baseurl`` | 1616 ``baseurl`` |
1616 Base URL to use when publishing URLs in other locations, so | 1617 Base URL to use when publishing URLs in other locations, so |
1617 third-party tools like email notification hooks can construct | 1618 third-party tools like email notification hooks can construct |
1618 URLs. Example: ``http://hgserver/repos/``. | 1619 URLs. Example: ``http://hgserver/repos/``. |
1643 -----BEGIN CERTIFICATE----- | 1644 -----BEGIN CERTIFICATE----- |
1644 ... (certificate in base64 PEM encoding) ... | 1645 ... (certificate in base64 PEM encoding) ... |
1645 -----END CERTIFICATE----- | 1646 -----END CERTIFICATE----- |
1646 | 1647 |
1647 ``cache`` | 1648 ``cache`` |
1648 Whether to support caching in hgweb. Defaults to True. | 1649 Whether to support caching in hgweb. (default: True) |
1649 | 1650 |
1650 ``certificate`` | 1651 ``certificate`` |
1651 Certificate to use when running :hg:`serve`. | 1652 Certificate to use when running :hg:`serve`. |
1652 | 1653 |
1653 ``collapse`` | 1654 ``collapse`` |
1655 a single level alongside repositories in the current path. With | 1656 a single level alongside repositories in the current path. With |
1656 ``collapse`` also enabled, repositories residing at a deeper level than | 1657 ``collapse`` also enabled, repositories residing at a deeper level than |
1657 the current path are grouped behind navigable directory entries that | 1658 the current path are grouped behind navigable directory entries that |
1658 lead to the locations of these repositories. In effect, this setting | 1659 lead to the locations of these repositories. In effect, this setting |
1659 collapses each collection of repositories found within a subdirectory | 1660 collapses each collection of repositories found within a subdirectory |
1660 into a single entry for that subdirectory. Default is False. | 1661 into a single entry for that subdirectory. (default: False) |
1661 | 1662 |
1662 ``comparisoncontext`` | 1663 ``comparisoncontext`` |
1663 Number of lines of context to show in side-by-side file comparison. If | 1664 Number of lines of context to show in side-by-side file comparison. If |
1664 negative or the value ``full``, whole files are shown. Default is 5. | 1665 negative or the value ``full``, whole files are shown. (default: 5) |
1666 | |
1665 This setting can be overridden by a ``context`` request parameter to the | 1667 This setting can be overridden by a ``context`` request parameter to the |
1666 ``comparison`` command, taking the same values. | 1668 ``comparison`` command, taking the same values. |
1667 | 1669 |
1668 ``contact`` | 1670 ``contact`` |
1669 Name or email address of the person in charge of the repository. | 1671 Name or email address of the person in charge of the repository. |
1670 Defaults to ui.username or ``$EMAIL`` or "unknown" if unset or empty. | 1672 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty) |
1671 | 1673 |
1672 ``deny_push`` | 1674 ``deny_push`` |
1673 Whether to deny pushing to the repository. If empty or not set, | 1675 Whether to deny pushing to the repository. If empty or not set, |
1674 push is not denied. If the special value ``*``, all remote users are | 1676 push is not denied. If the special value ``*``, all remote users are |
1675 denied push. Otherwise, unauthenticated users are all denied, and | 1677 denied push. Otherwise, unauthenticated users are all denied, and |
1696 directly in the current path will be shown (other repositories are still | 1698 directly in the current path will be shown (other repositories are still |
1697 available from the index corresponding to their containing path). | 1699 available from the index corresponding to their containing path). |
1698 | 1700 |
1699 ``description`` | 1701 ``description`` |
1700 Textual description of the repository's purpose or contents. | 1702 Textual description of the repository's purpose or contents. |
1701 Default is "unknown". | 1703 (default: "unknown") |
1702 | 1704 |
1703 ``encoding`` | 1705 ``encoding`` |
1704 Character encoding name. Default is the current locale charset. | 1706 Character encoding name. (default: the current locale charset) |
1705 Example: "UTF-8". | 1707 Example: "UTF-8". |
1706 | 1708 |
1707 ``errorlog`` | 1709 ``errorlog`` |
1708 Where to output the error log. Default is stderr. | 1710 Where to output the error log. (default: stderr) |
1709 | 1711 |
1710 ``guessmime`` | 1712 ``guessmime`` |
1711 Control MIME types for raw download of file content. | 1713 Control MIME types for raw download of file content. |
1712 Set to True to let hgweb guess the content type from the file | 1714 Set to True to let hgweb guess the content type from the file |
1713 extension. This will serve HTML files as ``text/html`` and might | 1715 extension. This will serve HTML files as ``text/html`` and might |
1714 allow cross-site scripting attacks when serving untrusted | 1716 allow cross-site scripting attacks when serving untrusted |
1715 repositories. Default is False. | 1717 repositories. (default: False) |
1716 | 1718 |
1717 ``hidden`` | 1719 ``hidden`` |
1718 Whether to hide the repository in the hgwebdir index. | 1720 Whether to hide the repository in the hgwebdir index. |
1719 Default is False. | 1721 (default: False) |
1720 | 1722 |
1721 ``ipv6`` | 1723 ``ipv6`` |
1722 Whether to use IPv6. Default is False. | 1724 Whether to use IPv6. (default: False) |
1723 | 1725 |
1724 ``logoimg`` | 1726 ``logoimg`` |
1725 File name of the logo image that some templates display on each page. | 1727 File name of the logo image that some templates display on each page. |
1726 The file name is relative to ``staticurl``. That is, the full path to | 1728 The file name is relative to ``staticurl``. That is, the full path to |
1727 the logo image is "staticurl/logoimg". | 1729 the logo image is "staticurl/logoimg". |
1730 ``logourl`` | 1732 ``logourl`` |
1731 Base URL to use for logos. If unset, ``http://mercurial.selenic.com/`` | 1733 Base URL to use for logos. If unset, ``http://mercurial.selenic.com/`` |
1732 will be used. | 1734 will be used. |
1733 | 1735 |
1734 ``maxchanges`` | 1736 ``maxchanges`` |
1735 Maximum number of changes to list on the changelog. Default is 10. | 1737 Maximum number of changes to list on the changelog. (default: 10) |
1736 | 1738 |
1737 ``maxfiles`` | 1739 ``maxfiles`` |
1738 Maximum number of files to list per changeset. Default is 10. | 1740 Maximum number of files to list per changeset. (default: 10) |
1739 | 1741 |
1740 ``maxshortchanges`` | 1742 ``maxshortchanges`` |
1741 Maximum number of changes to list on the shortlog, graph or filelog | 1743 Maximum number of changes to list on the shortlog, graph or filelog |
1742 pages. Default is 60. | 1744 pages. (default: 60) |
1743 | 1745 |
1744 ``name`` | 1746 ``name`` |
1745 Repository name to use in the web interface. Default is current | 1747 Repository name to use in the web interface. |
1746 working directory. | 1748 (default: current working directory) |
1747 | 1749 |
1748 ``port`` | 1750 ``port`` |
1749 Port to listen on. Default is 8000. | 1751 Port to listen on. (default: 8000) |
1750 | 1752 |
1751 ``prefix`` | 1753 ``prefix`` |
1752 Prefix path to serve from. Default is '' (server root). | 1754 Prefix path to serve from. (default: '' (server root)) |
1753 | 1755 |
1754 ``push_ssl`` | 1756 ``push_ssl`` |
1755 Whether to require that inbound pushes be transported over SSL to | 1757 Whether to require that inbound pushes be transported over SSL to |
1756 prevent password sniffing. Default is True. | 1758 prevent password sniffing. (default: True) |
1757 | 1759 |
1758 ``refreshinterval`` | 1760 ``refreshinterval`` |
1759 How frequently directory listings re-scan the filesystem for new | 1761 How frequently directory listings re-scan the filesystem for new |
1760 repositories, in seconds. This is relevant when wildcards are used | 1762 repositories, in seconds. This is relevant when wildcards are used |
1761 to define paths. Depending on how much filesystem traversal is | 1763 to define paths. Depending on how much filesystem traversal is |
1762 required, refreshing may negatively impact performance. | 1764 required, refreshing may negatively impact performance. |
1763 | 1765 |
1764 Default is 20. Values less than or equal to 0 always refresh. | 1766 Values less than or equal to 0 always refresh. |
1767 (default: 20) | |
1765 | 1768 |
1766 ``staticurl`` | 1769 ``staticurl`` |
1767 Base URL to use for static files. If unset, static files (e.g. the | 1770 Base URL to use for static files. If unset, static files (e.g. the |
1768 hgicon.png favicon) will be served by the CGI script itself. Use | 1771 hgicon.png favicon) will be served by the CGI script itself. Use |
1769 this setting to serve them directly with the HTTP server. | 1772 this setting to serve them directly with the HTTP server. |
1770 Example: ``http://hgserver/static/``. | 1773 Example: ``http://hgserver/static/``. |
1771 | 1774 |
1772 ``stripes`` | 1775 ``stripes`` |
1773 How many lines a "zebra stripe" should span in multi-line output. | 1776 How many lines a "zebra stripe" should span in multi-line output. |
1774 Default is 1; set to 0 to disable. | 1777 Set to 0 to disable. (default: 1) |
1775 | 1778 |
1776 ``style`` | 1779 ``style`` |
1777 Which template map style to use. The available options are the names of | 1780 Which template map style to use. The available options are the names of |
1778 subdirectories in the HTML templates path. Default is ``paper``. | 1781 subdirectories in the HTML templates path. (default: ``paper``) |
1779 Example: ``monoblue`` | 1782 Example: ``monoblue``. |
1780 | 1783 |
1781 ``templates`` | 1784 ``templates`` |
1782 Where to find the HTML templates. The default path to the HTML templates | 1785 Where to find the HTML templates. The default path to the HTML templates |
1783 can be obtained from ``hg debuginstall``. | 1786 can be obtained from ``hg debuginstall``. |
1784 | 1787 |
1821 Parallel master/worker configuration. We currently perform working | 1824 Parallel master/worker configuration. We currently perform working |
1822 directory updates in parallel on Unix-like systems, which greatly | 1825 directory updates in parallel on Unix-like systems, which greatly |
1823 helps performance. | 1826 helps performance. |
1824 | 1827 |
1825 ``numcpus`` | 1828 ``numcpus`` |
1826 Number of CPUs to use for parallel operations. Default is 4 or the | 1829 Number of CPUs to use for parallel operations. A zero or |
1827 number of CPUs on the system, whichever is larger. A zero or | |
1828 negative value is treated as ``use the default``. | 1830 negative value is treated as ``use the default``. |
1831 (default: 4 or the number of CPUs on the system, whichever is larger) |