Mercurial > hg > mercurial-crew-with-dirclash
annotate mercurial/help.py @ 3801:6f0c42d50394
move environment topic
| author | Matt Mackall <mpm@selenic.com> |
|---|---|
| date | Tue, 05 Dec 2006 16:31:08 -0600 |
| parents | 17a11f4ff260 |
| children | eb66d76c7746 |
| rev | line source |
|---|---|
|
3798
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1 # help.py - help data for mercurial |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
2 # |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
3 # Copyright 2006 Matt Mackall <mpm@selenic.com> |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
4 # |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
5 # This software may be used and distributed according to the terms |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
6 # of the GNU General Public License, incorporated herein by reference. |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
7 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
8 helptable = { |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
9 "dates|Date Formats": |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
10 r''' |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
11 Some commands (backout, commit, tag) allow the user to specify a date. |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
12 Possible formats for dates are: |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
13 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
14 YYYY-mm-dd \HH:MM[:SS] [(+|-)NNNN]:: |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
15 This is a subset of ISO 8601, allowing just the recommended notations |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
16 for date and time. The last part represents the timezone; if omitted, |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
17 local time is assumed. Examples: |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
18 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
19 "2005-08-22 03:27 -0700" |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
20 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
21 "2006-04-19 21:39:51" |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
22 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
23 aaa bbb dd HH:MM:SS YYYY [(+|-)NNNN]:: |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
24 This is the date format used by the C library. Here, aaa stands for |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
25 abbreviated weekday name and bbb for abbreviated month name. The last |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
26 part represents the timezone; if omitted, local time is assumed. |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
27 Examples: |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
28 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
29 "Mon Aug 22 03:27:00 2005 -0700" |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
30 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
31 "Wed Apr 19 21:39:51 2006" |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
32 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
33 unixtime offset:: |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
34 This is the internal representation format for dates. unixtime is |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
35 the number of seconds since the epoch (1970-01-01 00:00 UTC). offset |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
36 is the offset of the local timezone, in seconds west of UTC (negative |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
37 if the timezone is east of UTC). |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
38 Examples: |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
39 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
40 "1124706420 25200" (2005-08-22 03:27:00 -0700) |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
41 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
42 "1145475591 -7200" (2006-04-19 21:39:51 +0200) |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
43 ''', |
| 3801 | 44 'environment|env|Environment Variables': |
| 45 r''' | |
| 46 HGEDITOR:: | |
| 47 This is the name of the editor to use when committing. Defaults to the | |
| 48 value of EDITOR. | |
| 49 | |
| 50 (deprecated, use .hgrc) | |
| 51 | |
| 52 HGENCODING:: | |
| 53 This overrides the default locale setting detected by Mercurial. | |
| 54 This setting is used to convert data including usernames, | |
| 55 changeset descriptions, tag names, and branches. This setting can | |
| 56 be overridden with the --encoding command-line option. | |
| 57 | |
| 58 HGENCODINGMODE:: | |
| 59 This sets Mercurial's behavior for handling unknown characters | |
| 60 while transcoding user inputs. The default is "strict", which | |
| 61 causes Mercurial to abort if it can't translate a character. Other | |
| 62 settings include "replace", which replaces unknown characters, and | |
| 63 "ignore", which drops them. This setting can be overridden with | |
| 64 the --encodingmode command-line option. | |
| 65 | |
| 66 HGMERGE:: | |
| 67 An executable to use for resolving merge conflicts. The program | |
| 68 will be executed with three arguments: local file, remote file, | |
| 69 ancestor file. | |
| 70 | |
| 71 The default program is "hgmerge", which is a shell script provided | |
| 72 by Mercurial with some sensible defaults. | |
| 73 | |
| 74 (deprecated, use .hgrc) | |
| 75 | |
| 76 HGRCPATH:: | |
| 77 A list of files or directories to search for hgrc files. Item | |
| 78 separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set, | |
| 79 platform default search path is used. If empty, only .hg/hgrc of | |
| 80 current repository is read. | |
| 81 | |
| 82 For each element in path, if a directory, all entries in directory | |
| 83 ending with ".rc" are added to path. Else, element itself is | |
| 84 added to path. | |
| 85 | |
| 86 HGUSER:: | |
| 87 This is the string used for the author of a commit. | |
| 88 | |
| 89 (deprecated, use .hgrc) | |
| 90 | |
| 91 EMAIL:: | |
| 92 If HGUSER is not set, this will be used as the author for a commit. | |
| 93 | |
| 94 LOGNAME:: | |
| 95 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with | |
| 96 '@hostname' appended) as the author value for a commit. | |
| 97 | |
| 98 EDITOR:: | |
| 99 This is the name of the editor used in the hgmerge script. It will be | |
| 100 used for commit messages if HGEDITOR isn't set. Defaults to 'vi'. | |
| 101 | |
| 102 PYTHONPATH:: | |
| 103 This is used by Python to find imported modules and may need to be set | |
| 104 appropriately if Mercurial is not installed system-wide. | |
| 105 ''' | |
|
3798
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
106 } |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
107 |