Mercurial > hg
annotate mercurial/help.py @ 6034:83633602e2c5
qinit -c: add ^\.hg and ^\.mq to .hgignore
author | Alexis S. L. Carvalho <alexis@cecm.usp.br> |
---|---|
date | Fri, 08 Feb 2008 18:07:55 -0200 |
parents | 3d35c8cb5eb4 |
children | 3c80ecdc1bcd |
rev | line source |
---|---|
3795
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. |
3811 | 12 Many date formats are acceptible. Here are some examples: |
3795
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
13 |
3811 | 14 "Wed Dec 6 13:18:29 2006" (local timezone assumed) |
15 "Dec 6 13:18 -0600" (year assumed, time offset provided) | |
16 "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000) | |
17 "Dec 6" (midnight) | |
18 "13:18" (today assumed) | |
19 "3:39" (3:39AM assumed) | |
20 "3:39pm" (15:39) | |
21 "2006-12-6 13:18:29" (ISO 8601 format) | |
22 "2006-12-6 13:18" | |
23 "2006-12-6" | |
24 "12-6" | |
25 "12/6" | |
26 "12/6/6" (Dec 6 2006) | |
3795
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
27 |
3811 | 28 Lastly, there is Mercurial's internal format: |
3795
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
29 |
3811 | 30 "1165432709 0" (Wed Dec 6 13:18:29 2006 UTC) |
3795
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
31 |
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
32 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
|
33 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
|
34 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
|
35 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
|
36 ''', |
3799 | 37 |
3798 | 38 'environment|env|Environment Variables': |
39 r''' | |
4686
849f011dbf79
Remember path to 'hg' executable and pass to external tools and hooks as $HG.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
3913
diff
changeset
|
40 HG:: |
5062
3d35c8cb5eb4
Simplify/correct finding the hg executable (fixes issue644)
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4686
diff
changeset
|
41 Path to the 'hg' executable, automatically passed when running hooks, |
3d35c8cb5eb4
Simplify/correct finding the hg executable (fixes issue644)
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4686
diff
changeset
|
42 extensions or external tools. If unset or empty, an executable named |
3d35c8cb5eb4
Simplify/correct finding the hg executable (fixes issue644)
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4686
diff
changeset
|
43 'hg' (with com/exe/bat/cmd extension on Windows) is searched. |
4686
849f011dbf79
Remember path to 'hg' executable and pass to external tools and hooks as $HG.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
3913
diff
changeset
|
44 |
3798 | 45 HGEDITOR:: |
46 This is the name of the editor to use when committing. Defaults to the | |
47 value of EDITOR. | |
48 | |
49 (deprecated, use .hgrc) | |
50 | |
51 HGENCODING:: | |
52 This overrides the default locale setting detected by Mercurial. | |
53 This setting is used to convert data including usernames, | |
54 changeset descriptions, tag names, and branches. This setting can | |
55 be overridden with the --encoding command-line option. | |
56 | |
57 HGENCODINGMODE:: | |
58 This sets Mercurial's behavior for handling unknown characters | |
59 while transcoding user inputs. The default is "strict", which | |
60 causes Mercurial to abort if it can't translate a character. Other | |
61 settings include "replace", which replaces unknown characters, and | |
62 "ignore", which drops them. This setting can be overridden with | |
63 the --encodingmode command-line option. | |
64 | |
65 HGMERGE:: | |
66 An executable to use for resolving merge conflicts. The program | |
67 will be executed with three arguments: local file, remote file, | |
68 ancestor file. | |
69 | |
70 The default program is "hgmerge", which is a shell script provided | |
71 by Mercurial with some sensible defaults. | |
72 | |
73 (deprecated, use .hgrc) | |
74 | |
75 HGRCPATH:: | |
76 A list of files or directories to search for hgrc files. Item | |
77 separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set, | |
78 platform default search path is used. If empty, only .hg/hgrc of | |
79 current repository is read. | |
80 | |
81 For each element in path, if a directory, all entries in directory | |
82 ending with ".rc" are added to path. Else, element itself is | |
83 added to path. | |
84 | |
85 HGUSER:: | |
86 This is the string used for the author of a commit. | |
87 | |
88 (deprecated, use .hgrc) | |
89 | |
90 EMAIL:: | |
91 If HGUSER is not set, this will be used as the author for a commit. | |
92 | |
93 LOGNAME:: | |
94 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with | |
95 '@hostname' appended) as the author value for a commit. | |
96 | |
97 EDITOR:: | |
98 This is the name of the editor used in the hgmerge script. It will be | |
99 used for commit messages if HGEDITOR isn't set. Defaults to 'vi'. | |
100 | |
101 PYTHONPATH:: | |
102 This is used by Python to find imported modules and may need to be set | |
103 appropriately if Mercurial is not installed system-wide. | |
3799 | 104 ''', |
105 | |
106 "patterns|File Name Patterns": r''' | |
107 Mercurial accepts several notations for identifying one or more | |
108 files at a time. | |
109 | |
110 By default, Mercurial treats filenames as shell-style extended | |
111 glob patterns. | |
112 | |
113 Alternate pattern notations must be specified explicitly. | |
114 | |
115 To use a plain path name without any pattern matching, start a | |
116 name with "path:". These path names must match completely, from | |
117 the root of the current repository. | |
118 | |
119 To use an extended glob, start a name with "glob:". Globs are | |
120 rooted at the current directory; a glob such as "*.c" will match | |
121 files ending in ".c" in the current directory only. | |
122 | |
123 The supported glob syntax extensions are "**" to match any string | |
124 across path separators, and "{a,b}" to mean "a or b". | |
125 | |
126 To use a Perl/Python regular expression, start a name with "re:". | |
127 Regexp pattern matching is anchored at the root of the repository. | |
128 | |
129 Plain examples: | |
130 | |
131 path:foo/bar a name bar in a directory named foo in the root of | |
132 the repository | |
133 path:path:name a file or directory named "path:name" | |
134 | |
135 Glob examples: | |
136 | |
137 glob:*.c any name ending in ".c" in the current directory | |
138 *.c any name ending in ".c" in the current directory | |
139 **.c any name ending in ".c" in the current directory, or | |
140 any subdirectory | |
141 foo/*.c any name ending in ".c" in the directory foo | |
142 foo/**.c any name ending in ".c" in the directory foo, or any | |
143 subdirectory | |
144 | |
145 Regexp examples: | |
146 | |
147 re:.*\.c$ any name ending in ".c", anywhere in the repository | |
148 | |
149 ''', | |
3795
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
150 } |
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
151 |