Mercurial > hg > mercurial-crew-with-dirclash
annotate doc/hg.1.txt @ 594:0a2ffc5c906b
Update CONTRIBUTORS
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Update CONTRIBUTORS
manifest hash: 71ba14cae4b50532d09de7ca49bc67375a69161d
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.0 (GNU/Linux)
iD8DBQFCyD9kywK+sNU5EO8RAqbuAKCeP12TfqkADk+xAKy04U78TmHJKgCfeZIg
qPwEtFA8Qd0l96fjJmL+peM=
=f6lv
-----END PGP SIGNATURE-----
author | mpm@selenic.com |
---|---|
date | Sun, 03 Jul 2005 11:41:24 -0800 |
parents | 0c3bae18403b |
children | c2c2c6d617bd |
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 ...:: | |
36 indicates one or more filename or relative path filenames | |
37 | |
38 path:: | |
39 indicates a path on the local machine | |
40 | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
41 revision:: |
438 | 42 indicates a changeset which can be specified as a changeset revision |
43 number, a tag, or a unique substring of the changeset hash value | |
177 | 44 |
45 repository path:: | |
498 | 46 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
|
47 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
|
48 fast and the old-http:// protocol which is much slower but does not |
438 | 49 require a special server on the web host. |
177 | 50 |
51 COMMANDS | |
52 -------- | |
438 | 53 |
177 | 54 add [files ...]:: |
497 | 55 Schedule files to be version controlled and added to the repository. |
56 | |
498 | 57 The files will be added to the repository at the next commit. |
177 | 58 |
59 addremove:: | |
497 | 60 Add all new files and remove all missing files from the repository. |
61 | |
62 New files are ignored if they match any of the patterns in .hgignore. As | |
498 | 63 with add, these changes take effect at the next commit. |
177 | 64 |
438 | 65 annotate [-r <rev> -u -n -c] [files ...]:: |
497 | 66 List changes in files, showing the revision id responsible for each line |
67 | |
68 This command is useful to discover who did a change or when a change took | |
69 place. | |
70 | |
438 | 71 options: |
72 -r, --revision <rev> annotate the specified revision | |
73 -u, --user list the author | |
74 -c, --changeset list the changeset | |
75 -n, --number list the revision number (default) | |
177 | 76 |
438 | 77 cat <file> [revision]:: |
497 | 78 Output to stdout the given revision for the specified file. |
79 | |
498 | 80 If no revision is given then the tip is used. |
177 | 81 |
485 | 82 clone [-U] <source> [dest]:: |
497 | 83 Create a copy of an existing repository in a new directory. |
84 | |
523
003df62ae39f
[PATCH] Force "hg clone" to always create a new directory
mpm@selenic.com
parents:
509
diff
changeset
|
85 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
|
86 basename of the source. |
497 | 87 |
498 | 88 The source is added to the new repository's .hg/hgrc file to be used in |
497 | 89 future pulls. |
90 | |
498 | 91 For efficiency, hardlinks are used for cloning whenever the |
92 source and destination are on the same filesystem. | |
497 | 93 |
94 options: | |
505 | 95 -U, --noupdate do not update the new working directory |
497 | 96 |
97 commit [-A -t -l <file> -t <text> -u <user> -d <datecode>] [files...]:: | |
498 | 98 Commit changes to the given files into the repository. |
497 | 99 |
498 | 100 If a list of files is omitted, all changes reported by "hg status" |
101 will be commited. | |
497 | 102 |
498 | 103 The HGEDITOR or EDITOR environment variables are used to start an |
104 editor to add a commit comment. | |
497 | 105 |
106 Options: | |
107 | |
108 -A, --addremove run addremove during commit | |
109 -t, --text <text> use <text> as commit message | |
110 -l, --logfile <file> show the commit message for the given file | |
111 -d, --date <datecode> record datecode as commit date | |
112 -u, --user <user> record user as commiter | |
113 | |
114 aliases: ci | |
115 | |
116 copy <source> <dest>:: | |
117 Mark <dest> file as a copy or rename of a <source> one | |
118 | |
119 This command takes effect for the next commit. | |
120 | |
121 diff [-r revision] [-r revision] [files ...]:: | |
122 Show differences between revisions for the specified files. | |
123 | |
124 Differences between files are shown using the unified diff format. | |
125 | |
498 | 126 When two revision arguments are given, then changes are shown |
127 between those revisions. If only one revision is specified then | |
128 that revision is compared to the working directory, and, when no | |
129 revisions are specified, the working directory files are compared | |
130 to its parent. | |
497 | 131 |
580 | 132 export [-o filespec] [revision] ...:: |
133 Print the changeset header and diffs for one or more revisions. | |
134 | |
135 The information shown in the changeset header is: author, | |
136 changeset hash, parent and commit comment. | |
137 | |
138 Output may be to a file, in which case the name of the file is | |
139 given using a format string. The formatting rules are as follows: | |
497 | 140 |
580 | 141 %% literal "%" character |
142 %H changeset hash (40 bytes of hexadecimal) | |
143 %N number of patches being generated | |
144 %R changeset revision number | |
145 %b basename of the exporting repository | |
146 %h short-form changeset hash (12 bytes of hexadecimal) | |
147 %n zero-padded sequence number, starting at 1 | |
148 %r zero-padded changeset revision number | |
149 | |
150 Options: | |
151 | |
152 -o, --output <filespec> print output to file with formatted named | |
497 | 153 |
154 forget [files]:: | |
155 Undo an 'hg add' scheduled for the next commit. | |
156 | |
157 heads:: | |
158 Show all repository head changesets. | |
159 | |
498 | 160 Repository "heads" are changesets that don't have children |
161 changesets. They are where development generally takes place and | |
162 are the usual targets for update and merge operations. | |
497 | 163 |
164 identify:: | |
165 Print a short summary of the current state of the repo. | |
166 | |
167 This summary identifies the repository state using one or two parent | |
168 hash identifiers, followed by a "+" if there are uncommitted changes | |
169 in the working directory, followed by a list of tags for this revision. | |
170 | |
171 aliases: id | |
172 | |
173 import [-p <n> -b <base> -q] <patches>:: | |
174 Import a list of patches and commit them individually. | |
175 | |
176 options: | |
177 -p, --strip <n> directory strip option for patch. This has the same | |
178 meaning as the correnponding patch option | |
179 -b <path> base directory to read patches from | |
180 | |
181 aliases: patch | |
182 | |
496 | 183 init:: |
184 Initialize a new repository in the current directory. | |
177 | 185 |
552
2204311609a0
Allow specifying revisions in 'hg log' like with 'hg diff'.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
523
diff
changeset
|
186 log [-r revision ...] [file]:: |
509 | 187 Print the revision history of the specified file or the entire project. |
177 | 188 |
509 | 189 By default this command outputs: changeset id and hash, tags, |
190 parents, user, date and time, and a summary for each commit. The | |
191 -v switch adds some more detail, such as changed files, manifest | |
192 hashes or message signatures. | |
193 | |
552
2204311609a0
Allow specifying revisions in 'hg log' like with 'hg diff'.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
523
diff
changeset
|
194 When a revision argument is given, only this file or changelog revision |
2204311609a0
Allow specifying revisions in 'hg log' like with 'hg diff'.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
523
diff
changeset
|
195 is displayed. With two revision arguments all revisions in this range |
2204311609a0
Allow specifying revisions in 'hg log' like with 'hg diff'.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
523
diff
changeset
|
196 are listed. Additional revision arguments may be given repeating the above |
2204311609a0
Allow specifying revisions in 'hg log' like with 'hg diff'.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
523
diff
changeset
|
197 cycle. |
2204311609a0
Allow specifying revisions in 'hg log' like with 'hg diff'.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
523
diff
changeset
|
198 |
509 | 199 aliases: history |
497 | 200 |
438 | 201 manifest [revision]:: |
497 | 202 Print a list of version controlled files for the given revision. |
203 | |
204 The manifest is the list of files being version controlled. If no revision | |
205 is given then the tip is used. | |
438 | 206 |
207 parents:: | |
208 Print the working directory's parent revisions. | |
209 | |
210 pull <repository path>:: | |
498 | 211 Pull changes from a remote repository to a local one. |
497 | 212 |
498 | 213 This finds all changes from the repository at the specified path |
214 or URL and adds them to the local repository. By default, this | |
215 does not update the copy of the project in the working directory. | |
438 | 216 |
217 options: | |
218 -u, --update update the working directory to tip after pull | |
219 | |
220 push <destination>:: | |
497 | 221 Push changes from the local repository to the given destination. |
222 | |
498 | 223 This is the symmetrical operation for pull. It helps to move |
224 changes from the current repository to a different one. If the | |
225 destination is local this is identical to a pull in that directory | |
226 from the current one. | |
438 | 227 |
228 The other currently available push method is SSH. This requires an | |
229 accessible shell account on the destination machine and a copy of | |
230 hg in the remote path. Destinations are specified in the following | |
231 form: | |
232 | |
233 ssh://[user@]host[:port]/path | |
234 | |
235 rawcommit [-p -d -u -F -t -l]:: | |
497 | 236 Lowlevel commit, for use in helper scripts. |
237 | |
238 This command is not intended to be used by normal users, as it is | |
239 primarily useful for importing from other SCMs. | |
177 | 240 |
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
241 recover:: |
497 | 242 Recover from an interrupted commit or pull. |
243 | |
244 This command tries to fix the repository status after an interrupted | |
245 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
|
246 |
177 | 247 remove [files ...]:: |
497 | 248 Schedule the indicated files for removal from the repository. |
249 | |
498 | 250 This command shedules the files to be removed at the next commit. |
251 This only removes files from the current branch, not from the | |
252 entire project history. | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
253 |
438 | 254 aliases: rm |
177 | 255 |
588 | 256 revert [names ...]:: |
257 Revert any uncommitted modifications made to the named files or | |
258 directories. This restores the contents of the affected files to | |
259 an unmodified state. | |
260 | |
261 If a file has been deleted, it is recreated. If the executable | |
262 mode of a file was changed, it is reset. | |
263 | |
264 If a directory is given, all files in that directory and its | |
265 subdirectories are reverted. | |
266 | |
267 If no arguments are given, all files in the current directory and | |
268 its subdirectories are reverted. | |
269 | |
270 options: | |
271 -r, --rev <rev> revision to revert to | |
272 -n, --nonrecursive do not recurse into subdirectories | |
273 | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
274 root:: |
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
275 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
|
276 |
177 | 277 serve [-a addr -n name -p port -t templatedir]:: |
438 | 278 Start a local HTTP repository browser and pull server. |
279 | |
280 options: | |
281 -a, --address <addr> address to use | |
282 -p, --port <n> port to use (default: 8000) | |
283 -n, --name <name> name to show in web pages (default: working dir) | |
284 -t, --templatedir <path> web templates to use | |
177 | 285 |
286 status:: | |
438 | 287 Show changed files in the working directory. |
288 | |
497 | 289 The codes used to show the status of files are: |
290 | |
438 | 291 C = changed |
292 A = added | |
293 R = removed | |
294 ? = not tracked | |
295 | |
296 tag [-t <text> -d <datecode> -u <user>] <name> [revision]:: | |
497 | 297 Name a particular revision using <name>. |
298 | |
299 Tags are used to name particular revisions of the repository and are | |
300 very useful to compare different revision, to go back to significant | |
498 | 301 earlier versions or to mark branch points as releases, etc. |
497 | 302 |
498 | 303 If no revision is given, the tip is used. |
438 | 304 |
498 | 305 To facilitate version control, distribution, and merging of tags, |
306 they are stored as a file named ".hgtags" which is managed | |
307 similarly to other project files and can be hand-edited if | |
308 necessary. | |
309 | |
438 | 310 options: |
311 -t, --text <text> message for tag commit log entry | |
312 -d, --date <datecode> datecode for commit | |
313 -u, --user <user> user for commit | |
177 | 314 |
498 | 315 Note: Mercurial also has support for "local tags" that are not |
316 version-controlled or distributed which are stored in the .hg/hgrc | |
317 file. | |
318 | |
177 | 319 tags:: |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
320 List the repository tags. |
438 | 321 |
498 | 322 This lists both regular and local tags. |
497 | 323 |
438 | 324 tip:: |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
325 Show the tip revision. |
177 | 326 |
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
327 undo:: |
438 | 328 Undo the last commit or pull transaction. |
329 | |
330 update [-m -C] [revision]:: | |
498 | 331 Update the working directory to the specified revision. |
438 | 332 |
498 | 333 By default, update will refuse to run if doing so would require |
334 merging or discarding local changes. | |
335 | |
336 With the -m option, a merge will be performed. | |
337 | |
338 With the -C option, local changes will be lost. | |
497 | 339 |
438 | 340 options: |
341 -m, --merge allow merging of branches | |
342 -C, --clean overwrite locally modified files | |
343 | |
344 aliases: up checkout co | |
345 | |
346 verify:: | |
347 Verify the integrity of the current repository. | |
348 | |
349 This will perform an extensive check of the repository's | |
350 integrity, validating the hashes and checksums of each entry in | |
351 the changelog, manifest, and tracked files, as well as the | |
352 integrity of their crosslinks and indices. | |
353 | |
580 | 354 SPECIFYING SINGLE REVISIONS |
355 --------------------------- | |
356 | |
357 Mercurial accepts several notations for identifying individual | |
358 revisions. | |
359 | |
360 A plain integer is treated as a revision number. Negative | |
361 integers are treated as offsets from the tip, with -1 denoting the | |
362 tip. | |
363 | |
364 A 40-digit hexadecimal string is treated as a unique revision | |
365 identifier. | |
366 | |
367 A hexadecimal string less than 40 characters long is treated as a | |
368 unique revision identifier, and referred to as a short-form | |
369 identifier. A short-form identifier is only valid if it is the | |
370 prefix of one full-length identifier. | |
371 | |
372 Any other string is treated as a tag name, which is a symbolic | |
373 name associated with a revision identifier. Tag names may not | |
374 contain the ":" character. | |
375 | |
376 The reserved name "tip" is a special tag that always identifies | |
377 the most recent revision. | |
378 | |
379 SPECIFYING MULTIPLE REVISIONS | |
380 ----------------------------- | |
381 | |
382 When Mercurial accepts more than one revision, they may be | |
383 specified individually, or provided as a continuous range, | |
384 separated by the ":" character. | |
385 | |
386 The syntax of range notation is [BEGIN]:[END], where BEGIN and END | |
387 are revision identifiers. Both BEGIN and END are optional. If | |
388 BEGIN is not specified, it defaults to revision number 0. If END | |
389 is not specified, it defaults to the tip. The range ":" thus | |
390 means "all revisions". | |
391 | |
392 If BEGIN is greater than END, revisions are treated in reverse | |
393 order. | |
394 | |
395 A range acts as an open interval. This means that a range of 3:5 | |
396 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
|
397 |
177 | 398 ENVIRONMENT VARIABLES |
399 --------------------- | |
438 | 400 |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
401 HGEDITOR:: |
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
402 This is the name of the editor to use when committing. Defaults to the |
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
403 value of EDITOR. |
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
404 |
177 | 405 HGMERGE:: |
498 | 406 An executable to use for resolving merge conflicts. The program |
438 | 407 will be executed with three arguments: local file, remote file, |
408 ancestor file. | |
409 | |
410 The default program is "hgmerge", which is a shell script provided | |
411 by Mercurial with some sensible defaults. | |
177 | 412 |
413 HGUSER:: | |
438 | 414 This is the string used for the author of a commit. |
177 | 415 |
416 EMAIL:: | |
438 | 417 If HGUSER is not set, this will be used as the author for a commit. |
177 | 418 |
419 LOGNAME:: | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
420 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with |
438 | 421 '@hostname' appended) as the author value for a commit. |
177 | 422 |
423 EDITOR:: | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
424 This is the name of the editor used in the hgmerge script. It will be |
498 | 425 used for commit messages if HGEDITOR isn't set. Defaults to 'vi'. |
438 | 426 |
427 PYTHONPATH:: | |
428 This is used by Python to find imported modules and may need to be set | |
429 appropriately if Mercurial is not installed system-wide. | |
177 | 430 |
431 FILES | |
432 ----- | |
433 .hgignore:: | |
438 | 434 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
|
435 names that should be ignored by hg. |
177 | 436 |
437 .hgtags:: | |
438 | 438 This file contains changeset hash values and text tag names (one of each |
177 | 439 seperated by spaces) that correspond to tagged versions of the repository |
440 contents. | |
441 | |
438 | 442 $HOME/.hgrc, .hg/hgrc:: |
443 This file contains defaults and configuration. Values in .hg/hgrc | |
444 override those in .hgrc. | |
445 | |
446 NAMED REPOSITORIES | |
447 ------------------ | |
448 | |
487 | 449 To give symbolic names to a repository, create a section in .hgrc |
450 or .hg/hgrc containing assignments of names to paths. Example: | |
438 | 451 |
487 | 452 ----------------- |
438 | 453 [paths] |
454 hg = http://selenic.com/hg | |
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
455 tah = http://hg.intevation.org/mercurial-tah/ |
487 | 456 ----------------- |
457 | |
458 | |
498 | 459 LOCAL TAGS |
460 ---------- | |
461 | |
462 To create tags that are local to the repository and not distributed or | |
463 version-controlled, create an hgrc section like the following: | |
464 | |
465 ---------------- | |
466 [tags] | |
467 working = 2dcced388cab3677a8f543c3c47a0ad34ac9d435 | |
468 tested = 12e0fdbc57a0be78f0e817fd1d170a3615cd35da | |
469 ---------------- | |
470 | |
471 | |
487 | 472 HOOKS |
473 ----- | |
474 | |
475 Mercurial supports a set of 'hook', commands that get automatically | |
476 executed by various actions such as starting or finishing a commit. To | |
477 specify a hook, simply create an hgrc section like the following: | |
478 | |
479 ----------------- | |
480 [hooks] | |
481 precommit = echo "this hook gets executed immediately before a commit" | |
482 commit = hg export $NODE | mail -s "new commit $NODE" commit-list | |
483 ----------------- | |
484 | |
181
038e4d8602bd
updated for .hgpaths and http/old-http protocol name change
jake@edge2.net
parents:
177
diff
changeset
|
485 |
321 | 486 NON_TRANSPARENT PROXY SUPPORT |
438 | 487 ----------------------------- |
321 | 488 |
487 | 489 To access a Mercurial repository through a proxy, create a file |
490 $HOME/.hgrc in the following format: | |
321 | 491 |
487 | 492 -------------- |
321 | 493 [http_proxy] |
494 host=myproxy:8080 | |
495 user=<username> | |
496 passwd=<password> | |
497 no=<localhost1>,<localhost2>,<localhost3>,... | |
487 | 498 -------------- |
321 | 499 |
498 | 500 "user" and "passwd" fields are used for authenticating proxies, "no" is a |
501 comma-separated list of local host names to not proxy. | |
321 | 502 |
177 | 503 BUGS |
504 ---- | |
505 Probably lots, please post them to the mailing list (See Resources below) | |
506 when you find them. | |
507 | |
508 AUTHOR | |
509 ------ | |
510 Written by Matt Mackall <mpm@selenic.com> | |
511 | |
512 RESOURCES | |
513 --------- | |
514 http://selenic.com/mercurial[Main Web Site] | |
515 | |
516 http://selenic.com/hg[Source code repository] | |
517 | |
518 http://selenic.com/mailman/listinfo/mercurial[Mailing list] | |
519 | |
520 COPYING | |
521 ------- | |
522 Copyright (C) 2005 Matt Mackall. | |
523 Free use of this software is granted under the terms of the GNU General | |
524 Public License (GPL). |