Mercurial > hg > mercurial-crew-with-dirclash
annotate doc/hg.1.txt @ 924:ab681ea2857e
updated help text and added manpage section for hg paths
Index: hg/doc/hg.1.txt
===================================================================
author | TK Soh <teekaysoh@yahoo.com> |
---|---|
date | Tue, 16 Aug 2005 17:30:41 -0800 |
parents | 891b6a262c4b |
children | 6f2c3bcbfaaf |
rev | line source |
---|---|
177 | 1 HG(1) |
2 ===== | |
3 Matt Mackall <mpm@selenic.com> | |
4 | |
5 NAME | |
6 ---- | |
438 | 7 hg - Mercurial source code management system |
177 | 8 |
9 SYNOPSIS | |
10 -------- | |
11 'hg' [-v -d -q -y] <command> [command options] [files] | |
12 | |
13 DESCRIPTION | |
14 ----------- | |
15 The hg(1) command provides a command line interface to the Mercurial system. | |
16 | |
17 OPTIONS | |
18 ------- | |
438 | 19 |
177 | 20 --debug, -d:: |
21 enable debugging output | |
22 | |
23 --quiet, -q:: | |
24 suppress output | |
25 | |
26 --verbose, -v:: | |
27 enable additional output | |
28 | |
29 --noninteractive, -y:: | |
30 do not prompt, assume 'yes' for any required answers | |
31 | |
32 COMMAND ELEMENTS | |
33 ---------------- | |
34 | |
35 files ...:: | |
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
36 indicates one or more filename or relative path filenames; see |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
37 "FILE NAME PATTERNS" for information on pattern matching |
177 | 38 |
39 path:: | |
40 indicates a path on the local machine | |
41 | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
42 revision:: |
438 | 43 indicates a changeset which can be specified as a changeset revision |
44 number, a tag, or a unique substring of the changeset hash value | |
177 | 45 |
46 repository path:: | |
498 | 47 either the pathname of a local repository or the URI of a remote |
181
038e4d8602bd
updated for .hgpaths and http/old-http protocol name change
jake@edge2.net
parents:
177
diff
changeset
|
48 repository. There are two available URI protocols, http:// which is |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
49 fast and the old-http:// protocol which is much slower but does not |
438 | 50 require a special server on the web host. |
177 | 51 |
52 COMMANDS | |
53 -------- | |
438 | 54 |
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
55 add [options] [files ...]:: |
497 | 56 Schedule files to be version controlled and added to the repository. |
57 | |
498 | 58 The files will be added to the repository at the next commit. |
177 | 59 |
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
60 If no names are given, add all files in the current directory and |
728 | 61 its subdirectories. |
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
62 |
766
b444a7e053f1
Get addremove to use new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
761
diff
changeset
|
63 addremove [options] [files ...]:: |
497 | 64 Add all new files and remove all missing files from the repository. |
65 | |
66 New files are ignored if they match any of the patterns in .hgignore. As | |
498 | 67 with add, these changes take effect at the next commit. |
177 | 68 |
438 | 69 annotate [-r <rev> -u -n -c] [files ...]:: |
497 | 70 List changes in files, showing the revision id responsible for each line |
71 | |
72 This command is useful to discover who did a change or when a change took | |
73 place. | |
74 | |
438 | 75 options: |
811
fa9aaf3bbdd7
Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents:
810
diff
changeset
|
76 -I, --include <pat> include names matching the given patterns |
fa9aaf3bbdd7
Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents:
810
diff
changeset
|
77 -X, --exclude <pat> exclude names matching the given patterns |
438 | 78 -r, --revision <rev> annotate the specified revision |
79 -u, --user list the author | |
80 -c, --changeset list the changeset | |
81 -n, --number list the revision number (default) | |
177 | 82 |
438 | 83 cat <file> [revision]:: |
497 | 84 Output to stdout the given revision for the specified file. |
85 | |
498 | 86 If no revision is given then the tip is used. |
177 | 87 |
485 | 88 clone [-U] <source> [dest]:: |
497 | 89 Create a copy of an existing repository in a new directory. |
90 | |
523
003df62ae39f
[PATCH] Force "hg clone" to always create a new directory
mpm@selenic.com
parents:
509
diff
changeset
|
91 If no destination directory name is specified, it defaults to the |
003df62ae39f
[PATCH] Force "hg clone" to always create a new directory
mpm@selenic.com
parents:
509
diff
changeset
|
92 basename of the source. |
497 | 93 |
498 | 94 The source is added to the new repository's .hg/hgrc file to be used in |
497 | 95 future pulls. |
96 | |
498 | 97 For efficiency, hardlinks are used for cloning whenever the |
98 source and destination are on the same filesystem. | |
497 | 99 |
100 options: | |
505 | 101 -U, --noupdate do not update the new working directory |
497 | 102 |
813
80fd2958235a
Adapt commit to use file matching code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
811
diff
changeset
|
103 commit [options] [files...]:: |
498 | 104 Commit changes to the given files into the repository. |
497 | 105 |
498 | 106 If a list of files is omitted, all changes reported by "hg status" |
813
80fd2958235a
Adapt commit to use file matching code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
811
diff
changeset
|
107 from the root of the repository will be commited. |
497 | 108 |
498 | 109 The HGEDITOR or EDITOR environment variables are used to start an |
110 editor to add a commit comment. | |
497 | 111 |
112 Options: | |
113 | |
114 -A, --addremove run addremove during commit | |
813
80fd2958235a
Adapt commit to use file matching code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
811
diff
changeset
|
115 -I, --include <pat> include names matching the given patterns |
80fd2958235a
Adapt commit to use file matching code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
811
diff
changeset
|
116 -X, --exclude <pat> exclude names matching the given patterns |
761
0fb498458905
Change all references to -t --text commit message to -m and --message.
Andrew Thompson <andrewkt@aktzero.com>
parents:
750
diff
changeset
|
117 -m, --message <text> use <text> as commit message |
497 | 118 -l, --logfile <file> show the commit message for the given file |
119 -d, --date <datecode> record datecode as commit date | |
120 -u, --user <user> record user as commiter | |
121 | |
122 aliases: ci | |
123 | |
124 copy <source> <dest>:: | |
125 Mark <dest> file as a copy or rename of a <source> one | |
126 | |
127 This command takes effect for the next commit. | |
128 | |
129 diff [-r revision] [-r revision] [files ...]:: | |
130 Show differences between revisions for the specified files. | |
131 | |
132 Differences between files are shown using the unified diff format. | |
133 | |
498 | 134 When two revision arguments are given, then changes are shown |
135 between those revisions. If only one revision is specified then | |
136 that revision is compared to the working directory, and, when no | |
137 revisions are specified, the working directory files are compared | |
138 to its parent. | |
497 | 139 |
734
d4e161d60f61
Update docs for annotate and diff.
Bryan O'Sullivan <bos@serpentine.com>
parents:
731
diff
changeset
|
140 options: |
811
fa9aaf3bbdd7
Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents:
810
diff
changeset
|
141 -I, --include <pat> include names matching the given patterns |
fa9aaf3bbdd7
Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents:
810
diff
changeset
|
142 -X, --exclude <pat> exclude names matching the given patterns |
734
d4e161d60f61
Update docs for annotate and diff.
Bryan O'Sullivan <bos@serpentine.com>
parents:
731
diff
changeset
|
143 |
580 | 144 export [-o filespec] [revision] ...:: |
145 Print the changeset header and diffs for one or more revisions. | |
146 | |
147 The information shown in the changeset header is: author, | |
148 changeset hash, parent and commit comment. | |
149 | |
150 Output may be to a file, in which case the name of the file is | |
151 given using a format string. The formatting rules are as follows: | |
497 | 152 |
580 | 153 %% literal "%" character |
154 %H changeset hash (40 bytes of hexadecimal) | |
155 %N number of patches being generated | |
156 %R changeset revision number | |
157 %b basename of the exporting repository | |
158 %h short-form changeset hash (12 bytes of hexadecimal) | |
159 %n zero-padded sequence number, starting at 1 | |
160 %r zero-padded changeset revision number | |
161 | |
162 Options: | |
163 | |
164 -o, --output <filespec> print output to file with formatted named | |
497 | 165 |
810
790a0ff306f2
Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
766
diff
changeset
|
166 forget [options] [files]:: |
497 | 167 Undo an 'hg add' scheduled for the next commit. |
168 | |
810
790a0ff306f2
Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
766
diff
changeset
|
169 options: |
811
fa9aaf3bbdd7
Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents:
810
diff
changeset
|
170 -I, --include <pat> include names matching the given patterns |
fa9aaf3bbdd7
Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents:
810
diff
changeset
|
171 -X, --exclude <pat> exclude names matching the given patterns |
810
790a0ff306f2
Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
766
diff
changeset
|
172 |
497 | 173 heads:: |
174 Show all repository head changesets. | |
175 | |
498 | 176 Repository "heads" are changesets that don't have children |
177 changesets. They are where development generally takes place and | |
178 are the usual targets for update and merge operations. | |
497 | 179 |
180 identify:: | |
181 Print a short summary of the current state of the repo. | |
182 | |
183 This summary identifies the repository state using one or two parent | |
184 hash identifiers, followed by a "+" if there are uncommitted changes | |
185 in the working directory, followed by a list of tags for this revision. | |
186 | |
187 aliases: id | |
188 | |
189 import [-p <n> -b <base> -q] <patches>:: | |
190 Import a list of patches and commit them individually. | |
191 | |
192 options: | |
193 -p, --strip <n> directory strip option for patch. This has the same | |
194 meaning as the correnponding patch option | |
195 -b <path> base directory to read patches from | |
196 | |
197 aliases: patch | |
198 | |
907
652507dc9fce
Modify init command to take an optional directory to set up.
Bryan O'Sullivan <bos@serpentine.com>
parents:
896
diff
changeset
|
199 init [dest]:: |
652507dc9fce
Modify init command to take an optional directory to set up.
Bryan O'Sullivan <bos@serpentine.com>
parents:
896
diff
changeset
|
200 Initialize a new repository in the given directory. If the given |
652507dc9fce
Modify init command to take an optional directory to set up.
Bryan O'Sullivan <bos@serpentine.com>
parents:
896
diff
changeset
|
201 directory does not exist, it is created. |
652507dc9fce
Modify init command to take an optional directory to set up.
Bryan O'Sullivan <bos@serpentine.com>
parents:
896
diff
changeset
|
202 |
652507dc9fce
Modify init command to take an optional directory to set up.
Bryan O'Sullivan <bos@serpentine.com>
parents:
896
diff
changeset
|
203 If no directory is given, the current directory is used. |
177 | 204 |
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
205 locate [options] [files]:: |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
206 Print all files under Mercurial control whose names match the |
629
2fdf3b1659b9
Clarify man page entry for locate a little.
Bryan O'Sullivan <bos@serpentine.com>
parents:
627
diff
changeset
|
207 given patterns. |
627 | 208 |
209 This command searches the current directory and its | |
210 subdirectories. To search an entire repository, move to the root | |
211 of the repository. | |
212 | |
213 If no patterns are given to match, this command prints all file | |
214 names. | |
215 | |
216 If you want to feed the output of this command into the "xargs" | |
217 command, use the "-0" option to both this command and "xargs". | |
218 This will avoid the problem of "xargs" treating single filenames | |
219 that contain white space as multiple file names. | |
220 | |
221 options: | |
222 | |
223 -0, --print0 end filenames with NUL, for use with xargs | |
224 -f, --fullpath print complete paths from the filesystem root | |
811
fa9aaf3bbdd7
Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents:
810
diff
changeset
|
225 -I, --include <pat> include names matching the given patterns |
627 | 226 -r, --rev <rev> search the repository as it stood at rev |
811
fa9aaf3bbdd7
Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents:
810
diff
changeset
|
227 -X, --exclude <pat> exclude names matching the given patterns |
627 | 228 |
612
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
229 log [-r revision ...] [-p] [file]:: |
509 | 230 Print the revision history of the specified file or the entire project. |
177 | 231 |
509 | 232 By default this command outputs: changeset id and hash, tags, |
233 parents, user, date and time, and a summary for each commit. The | |
234 -v switch adds some more detail, such as changed files, manifest | |
235 hashes or message signatures. | |
236 | |
612
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
237 options: |
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
238 -r, --rev <A>, ... When a revision argument is given, only this file or |
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
239 changelog revision is displayed. With two revision |
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
240 arguments all revisions in this range are listed. |
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
241 Additional revision arguments may be given repeating |
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
242 the above cycle. |
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
243 -p, --patch show patch |
552
2204311609a0
Allow specifying revisions in 'hg log' like with 'hg diff'.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
523
diff
changeset
|
244 |
509 | 245 aliases: history |
497 | 246 |
438 | 247 manifest [revision]:: |
497 | 248 Print a list of version controlled files for the given revision. |
249 | |
250 The manifest is the list of files being version controlled. If no revision | |
251 is given then the tip is used. | |
438 | 252 |
253 parents:: | |
254 Print the working directory's parent revisions. | |
255 | |
924
ab681ea2857e
updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents:
910
diff
changeset
|
256 paths [NAME]:: |
ab681ea2857e
updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents:
910
diff
changeset
|
257 Show definition of symbolic path name NAME. If no name is given, show |
ab681ea2857e
updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents:
910
diff
changeset
|
258 definition of available names. |
ab681ea2857e
updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents:
910
diff
changeset
|
259 |
ab681ea2857e
updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents:
910
diff
changeset
|
260 Path names are defined in the [paths] section of the $HOME/.hgrc and |
ab681ea2857e
updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents:
910
diff
changeset
|
261 <repo>/.hg/hgrc configuration files. If run outside a repo, 'paths' |
ab681ea2857e
updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents:
910
diff
changeset
|
262 queries only $HOME/.hgrc. |
ab681ea2857e
updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents:
910
diff
changeset
|
263 |
438 | 264 pull <repository path>:: |
498 | 265 Pull changes from a remote repository to a local one. |
497 | 266 |
498 | 267 This finds all changes from the repository at the specified path |
268 or URL and adds them to the local repository. By default, this | |
269 does not update the copy of the project in the working directory. | |
438 | 270 |
271 options: | |
272 -u, --update update the working directory to tip after pull | |
273 | |
274 push <destination>:: | |
497 | 275 Push changes from the local repository to the given destination. |
276 | |
498 | 277 This is the symmetrical operation for pull. It helps to move |
278 changes from the current repository to a different one. If the | |
279 destination is local this is identical to a pull in that directory | |
280 from the current one. | |
438 | 281 |
282 The other currently available push method is SSH. This requires an | |
283 accessible shell account on the destination machine and a copy of | |
284 hg in the remote path. Destinations are specified in the following | |
285 form: | |
286 | |
287 ssh://[user@]host[:port]/path | |
288 | |
747 | 289 rawcommit [-p -d -u -F -m -l]:: |
497 | 290 Lowlevel commit, for use in helper scripts. |
291 | |
292 This command is not intended to be used by normal users, as it is | |
293 primarily useful for importing from other SCMs. | |
177 | 294 |
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
295 recover:: |
497 | 296 Recover from an interrupted commit or pull. |
297 | |
298 This command tries to fix the repository status after an interrupted | |
299 operation. It should only be necessary when Mercurial suggests it. | |
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
300 |
177 | 301 remove [files ...]:: |
497 | 302 Schedule the indicated files for removal from the repository. |
303 | |
498 | 304 This command shedules the files to be removed at the next commit. |
305 This only removes files from the current branch, not from the | |
306 entire project history. | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
307 |
438 | 308 aliases: rm |
177 | 309 |
588 | 310 revert [names ...]:: |
311 Revert any uncommitted modifications made to the named files or | |
312 directories. This restores the contents of the affected files to | |
313 an unmodified state. | |
314 | |
315 If a file has been deleted, it is recreated. If the executable | |
316 mode of a file was changed, it is reset. | |
317 | |
318 If a directory is given, all files in that directory and its | |
319 subdirectories are reverted. | |
320 | |
321 If no arguments are given, all files in the current directory and | |
322 its subdirectories are reverted. | |
323 | |
324 options: | |
325 -r, --rev <rev> revision to revert to | |
326 -n, --nonrecursive do not recurse into subdirectories | |
327 | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
328 root:: |
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
329 Print the root directory of the current repository. |
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
330 |
606
ea4526f9b1a5
[PATCH] Fix thinko in "serve" man page entry.
mpm@selenic.com
parents:
605
diff
changeset
|
331 serve [options]:: |
438 | 332 Start a local HTTP repository browser and pull server. |
333 | |
605
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
334 By default, the server logs accesses to stdout and errors to |
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
335 stderr. Use the "-A" and "-E" options to log to files. |
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
336 |
438 | 337 options: |
605
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
338 -A, --accesslog <file> name of access log file to write to |
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
339 -E, --errorlog <file> name of error log file to write to |
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
340 -a, --address <addr> address to use |
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
341 -p, --port <n> port to use (default: 8000) |
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
342 -n, --name <name> name to show in web pages (default: working dir) |
438 | 343 -t, --templatedir <path> web templates to use |
825
0108c602feb9
Add an option to hg serve to serve file using IPv6
Samuel Tardieu <sam@rfc1149.net>
parents:
814
diff
changeset
|
344 -6, --ipv6 use IPv6 in addition to IPv4 |
177 | 345 |
731
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
346 status [options] [files]:: |
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
347 Show changed files in the working directory. If no names are |
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
348 given, all files are shown. Otherwise, only files matching the |
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
349 given names are shown. |
438 | 350 |
497 | 351 The codes used to show the status of files are: |
352 | |
746 | 353 M = changed |
438 | 354 A = added |
355 R = removed | |
356 ? = not tracked | |
357 | |
731
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
358 options: |
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
359 |
840
141744605b51
hg status: added options to select files by status.
tksoh@users.sourceforge.net
parents:
839
diff
changeset
|
360 -m, --modified show only modified files |
141744605b51
hg status: added options to select files by status.
tksoh@users.sourceforge.net
parents:
839
diff
changeset
|
361 -a, --added show only added files |
141744605b51
hg status: added options to select files by status.
tksoh@users.sourceforge.net
parents:
839
diff
changeset
|
362 -r, --removed show only removed files |
141744605b51
hg status: added options to select files by status.
tksoh@users.sourceforge.net
parents:
839
diff
changeset
|
363 -u, --unknown show only unknown (not tracked) files |
811
fa9aaf3bbdd7
Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents:
810
diff
changeset
|
364 -I, --include <pat> include names matching the given patterns |
fa9aaf3bbdd7
Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents:
810
diff
changeset
|
365 -X, --exclude <pat> exclude names matching the given patterns |
731
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
366 |
750 | 367 tag [-l -m <text> -d <datecode> -u <user>] <name> [revision]:: |
497 | 368 Name a particular revision using <name>. |
369 | |
370 Tags are used to name particular revisions of the repository and are | |
371 very useful to compare different revision, to go back to significant | |
498 | 372 earlier versions or to mark branch points as releases, etc. |
497 | 373 |
498 | 374 If no revision is given, the tip is used. |
438 | 375 |
498 | 376 To facilitate version control, distribution, and merging of tags, |
377 they are stored as a file named ".hgtags" which is managed | |
378 similarly to other project files and can be hand-edited if | |
379 necessary. | |
380 | |
438 | 381 options: |
631
a287f6cd9c6b
Update documentation of hg tag
Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
parents:
629
diff
changeset
|
382 -l, --local make the tag local |
761
0fb498458905
Change all references to -t --text commit message to -m and --message.
Andrew Thompson <andrewkt@aktzero.com>
parents:
750
diff
changeset
|
383 -m, --message <text> message for tag commit log entry |
438 | 384 -d, --date <datecode> datecode for commit |
385 -u, --user <user> user for commit | |
177 | 386 |
631
a287f6cd9c6b
Update documentation of hg tag
Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
parents:
629
diff
changeset
|
387 Note: Local tags are not version-controlled or distributed and are |
a287f6cd9c6b
Update documentation of hg tag
Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
parents:
629
diff
changeset
|
388 stored in the .hg/localtags file. If there exists a local tag and |
a287f6cd9c6b
Update documentation of hg tag
Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
parents:
629
diff
changeset
|
389 a public tag with the same name, local tag is used. |
498 | 390 |
177 | 391 tags:: |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
392 List the repository tags. |
438 | 393 |
498 | 394 This lists both regular and local tags. |
497 | 395 |
438 | 396 tip:: |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
397 Show the tip revision. |
177 | 398 |
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
399 undo:: |
438 | 400 Undo the last commit or pull transaction. |
401 | |
595 | 402 Roll back the last pull or commit transaction on the |
403 repository, restoring the project to its earlier state. | |
404 | |
405 This command should be used with care. There is only one level of | |
406 undo and there is no redo. | |
407 | |
408 This command is not intended for use on public repositories. Once | |
409 a change is visible for pull by other users, undoing it locally is | |
410 ineffective. | |
411 | |
438 | 412 update [-m -C] [revision]:: |
498 | 413 Update the working directory to the specified revision. |
438 | 414 |
498 | 415 By default, update will refuse to run if doing so would require |
416 merging or discarding local changes. | |
417 | |
418 With the -m option, a merge will be performed. | |
419 | |
420 With the -C option, local changes will be lost. | |
497 | 421 |
438 | 422 options: |
423 -m, --merge allow merging of branches | |
424 -C, --clean overwrite locally modified files | |
425 | |
426 aliases: up checkout co | |
427 | |
428 verify:: | |
429 Verify the integrity of the current repository. | |
430 | |
431 This will perform an extensive check of the repository's | |
432 integrity, validating the hashes and checksums of each entry in | |
433 the changelog, manifest, and tracked files, as well as the | |
434 integrity of their crosslinks and indices. | |
435 | |
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
436 FILE NAME PATTERNS |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
437 ------------------ |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
438 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
439 Mercurial accepts several notations for identifying one or more |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
440 file at a time. |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
441 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
442 By default, Mercurial treats file names as shell-style extended |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
443 glob patterns. |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
444 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
445 Alternate pattern notations must be specified explicitly. |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
446 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
447 To use a plain path name without any pattern matching, start a |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
448 name with "path:". These path names must match completely, from |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
449 the root of the current repository. |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
450 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
451 To use an extended glob, start a name with "glob:". Globs are |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
452 rooted at the current directory; a glob such as "*.c" will match |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
453 files ending in ".c" in the current directory only. |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
454 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
455 The supported glob syntax extensions are "**" to match any string |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
456 across path separators, and "{a,b}" to mean "a or b". |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
457 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
458 To use a Perl/Python regular expression, start a name with "re:". |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
459 Regexp pattern matching is anchored at the root of the repository. |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
460 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
461 Plain examples: |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
462 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
463 path:foo/bar a name bar in a directory named foo in the root of |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
464 the repository |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
465 path:path:name a file or directory named "path:name" |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
466 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
467 Glob examples: |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
468 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
469 glob:*.c any name ending in ".c" in the current directory |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
470 *.c any name ending in ".c" in the current directory |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
471 **.c any name ending in ".c" in the current directory, or |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
472 any subdirectory |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
473 foo/*.c any name ending in ".c" in the directory foo |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
474 foo/**.c any name ending in ".c" in the directory foo, or any |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
475 subdirectory |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
476 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
477 Regexp examples: |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
478 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
479 re:.*\.c$ any name ending in ".c", anywhere in the repsitory |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
480 |
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
481 |
580 | 482 SPECIFYING SINGLE REVISIONS |
483 --------------------------- | |
484 | |
485 Mercurial accepts several notations for identifying individual | |
486 revisions. | |
487 | |
488 A plain integer is treated as a revision number. Negative | |
489 integers are treated as offsets from the tip, with -1 denoting the | |
490 tip. | |
491 | |
492 A 40-digit hexadecimal string is treated as a unique revision | |
493 identifier. | |
494 | |
495 A hexadecimal string less than 40 characters long is treated as a | |
496 unique revision identifier, and referred to as a short-form | |
497 identifier. A short-form identifier is only valid if it is the | |
498 prefix of one full-length identifier. | |
499 | |
500 Any other string is treated as a tag name, which is a symbolic | |
501 name associated with a revision identifier. Tag names may not | |
502 contain the ":" character. | |
503 | |
504 The reserved name "tip" is a special tag that always identifies | |
505 the most recent revision. | |
506 | |
507 SPECIFYING MULTIPLE REVISIONS | |
508 ----------------------------- | |
509 | |
510 When Mercurial accepts more than one revision, they may be | |
511 specified individually, or provided as a continuous range, | |
512 separated by the ":" character. | |
513 | |
514 The syntax of range notation is [BEGIN]:[END], where BEGIN and END | |
515 are revision identifiers. Both BEGIN and END are optional. If | |
516 BEGIN is not specified, it defaults to revision number 0. If END | |
517 is not specified, it defaults to the tip. The range ":" thus | |
518 means "all revisions". | |
519 | |
520 If BEGIN is greater than END, revisions are treated in reverse | |
521 order. | |
522 | |
860
8ccbac05cf59
Use correct term "closed interval" for ranges.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
840
diff
changeset
|
523 A range acts as a closed interval. This means that a range of 3:5 |
580 | 524 gives 3, 4 and 5. Similarly, a range of 4:2 gives 4, 3, and 2. |
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
525 |
177 | 526 ENVIRONMENT VARIABLES |
527 --------------------- | |
438 | 528 |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
529 HGEDITOR:: |
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
530 This is the name of the editor to use when committing. Defaults to the |
608
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
531 value of EDITOR. |
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
532 |
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
533 (deprecated, use .hgrc) |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
534 |
177 | 535 HGMERGE:: |
498 | 536 An executable to use for resolving merge conflicts. The program |
438 | 537 will be executed with three arguments: local file, remote file, |
538 ancestor file. | |
539 | |
540 The default program is "hgmerge", which is a shell script provided | |
541 by Mercurial with some sensible defaults. | |
177 | 542 |
608
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
543 (deprecated, use .hgrc) |
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
544 |
177 | 545 HGUSER:: |
438 | 546 This is the string used for the author of a commit. |
177 | 547 |
608
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
548 (deprecated, use .hgrc) |
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
549 |
177 | 550 EMAIL:: |
438 | 551 If HGUSER is not set, this will be used as the author for a commit. |
177 | 552 |
553 LOGNAME:: | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
554 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with |
438 | 555 '@hostname' appended) as the author value for a commit. |
177 | 556 |
557 EDITOR:: | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
558 This is the name of the editor used in the hgmerge script. It will be |
498 | 559 used for commit messages if HGEDITOR isn't set. Defaults to 'vi'. |
438 | 560 |
561 PYTHONPATH:: | |
562 This is used by Python to find imported modules and may need to be set | |
563 appropriately if Mercurial is not installed system-wide. | |
177 | 564 |
565 FILES | |
566 ----- | |
567 .hgignore:: | |
438 | 568 This file contains regular expressions (one per line) that describe file |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
569 names that should be ignored by hg. |
177 | 570 |
571 .hgtags:: | |
438 | 572 This file contains changeset hash values and text tag names (one of each |
177 | 573 seperated by spaces) that correspond to tagged versions of the repository |
574 contents. | |
575 | |
438 | 576 $HOME/.hgrc, .hg/hgrc:: |
577 This file contains defaults and configuration. Values in .hg/hgrc | |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
578 override those in .hgrc. See hgrc(5) for details of the contents |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
579 and format of these files. |
321 | 580 |
177 | 581 BUGS |
582 ---- | |
583 Probably lots, please post them to the mailing list (See Resources below) | |
584 when you find them. | |
585 | |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
586 SEE ALSO |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
587 -------- |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
588 hgrc(5) |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
589 |
177 | 590 AUTHOR |
591 ------ | |
592 Written by Matt Mackall <mpm@selenic.com> | |
593 | |
594 RESOURCES | |
595 --------- | |
596 http://selenic.com/mercurial[Main Web Site] | |
597 | |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
598 http://www.serpentine.com/mercurial[Wiki site] |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
599 |
177 | 600 http://selenic.com/hg[Source code repository] |
601 | |
602 http://selenic.com/mailman/listinfo/mercurial[Mailing list] | |
603 | |
604 COPYING | |
605 ------- | |
606 Copyright (C) 2005 Matt Mackall. | |
607 Free use of this software is granted under the terms of the GNU General | |
608 Public License (GPL). |