Mercurial > hg
comparison doc/hg.1.txt @ 1216:1639fc7c2ccf
Cleanup of tabs and trailing spaces in documentation.
author | Thomas Arendsen Hein <thomas@intevation.de> |
---|---|
date | Thu, 08 Sep 2005 09:11:17 +0200 |
parents | ccb6201e3f28 |
children | cde6818e082a |
comparison
equal
deleted
inserted
replaced
1215:8b4435aae40a | 1216:1639fc7c2ccf |
---|---|
17 OPTIONS | 17 OPTIONS |
18 ------- | 18 ------- |
19 | 19 |
20 -R, --repository:: | 20 -R, --repository:: |
21 repository root directory | 21 repository root directory |
22 | 22 |
23 --cwd:: | 23 --cwd:: |
24 change working directory | 24 change working directory |
25 | 25 |
26 -y, --noninteractive:: | 26 -y, --noninteractive:: |
27 do not prompt, assume 'yes' for any required answers | 27 do not prompt, assume 'yes' for any required answers |
73 COMMANDS | 73 COMMANDS |
74 -------- | 74 -------- |
75 | 75 |
76 add [options] [files ...]:: | 76 add [options] [files ...]:: |
77 Schedule files to be version controlled and added to the repository. | 77 Schedule files to be version controlled and added to the repository. |
78 | 78 |
79 The files will be added to the repository at the next commit. | 79 The files will be added to the repository at the next commit. |
80 | 80 |
81 If no names are given, add all files in the current directory and | 81 If no names are given, add all files in the current directory and |
82 its subdirectories. | 82 its subdirectories. |
83 | 83 |
84 addremove [options] [files ...]:: | 84 addremove [options] [files ...]:: |
85 Add all new files and remove all missing files from the repository. | 85 Add all new files and remove all missing files from the repository. |
86 | 86 |
87 New files are ignored if they match any of the patterns in .hgignore. As | 87 New files are ignored if they match any of the patterns in .hgignore. As |
88 with add, these changes take effect at the next commit. | 88 with add, these changes take effect at the next commit. |
89 | 89 |
90 annotate [-r <rev> -u -n -c] [files ...]:: | 90 annotate [-r <rev> -u -n -c] [files ...]:: |
91 List changes in files, showing the revision id responsible for each line | 91 List changes in files, showing the revision id responsible for each line |
92 | 92 |
93 This command is useful to discover who did a change or when a change took | 93 This command is useful to discover who did a change or when a change took |
94 place. | 94 place. |
95 | 95 |
96 Without the -a option, annotate will avoid processing files it | 96 Without the -a option, annotate will avoid processing files it |
97 detects as binary. With -a, annotate will generate an annotation | 97 detects as binary. With -a, annotate will generate an annotation |
98 anyway, probably with undesirable results. | 98 anyway, probably with undesirable results. |
99 | 99 |
100 options: | 100 options: |
101 -a, --text treat all files as text | 101 -a, --text treat all files as text |
102 -I, --include <pat> include names matching the given patterns | 102 -I, --include <pat> include names matching the given patterns |
103 -X, --exclude <pat> exclude names matching the given patterns | 103 -X, --exclude <pat> exclude names matching the given patterns |
104 -r, --revision <rev> annotate the specified revision | 104 -r, --revision <rev> annotate the specified revision |
128 -e, --ssh specify ssh command to use | 128 -e, --ssh specify ssh command to use |
129 --remotecmd specify hg command to run on the remote side | 129 --remotecmd specify hg command to run on the remote side |
130 | 130 |
131 commit [options] [files...]:: | 131 commit [options] [files...]:: |
132 Commit changes to the given files into the repository. | 132 Commit changes to the given files into the repository. |
133 | 133 |
134 If a list of files is omitted, all changes reported by "hg status" | 134 If a list of files is omitted, all changes reported by "hg status" |
135 from the root of the repository will be commited. | 135 from the root of the repository will be commited. |
136 | 136 |
137 The HGEDITOR or EDITOR environment variables are used to start an | 137 The HGEDITOR or EDITOR environment variables are used to start an |
138 editor to add a commit comment. | 138 editor to add a commit comment. |
139 | 139 |
140 Options: | 140 Options: |
141 | 141 |
149 | 149 |
150 aliases: ci | 150 aliases: ci |
151 | 151 |
152 copy <source> <dest>:: | 152 copy <source> <dest>:: |
153 Mark <dest> file as a copy or rename of a <source> one | 153 Mark <dest> file as a copy or rename of a <source> one |
154 | 154 |
155 This command takes effect for the next commit. | 155 This command takes effect for the next commit. |
156 | 156 |
157 diff [-a] [-r revision] [-r revision] [files ...]:: | 157 diff [-a] [-r revision] [-r revision] [files ...]:: |
158 Show differences between revisions for the specified files. | 158 Show differences between revisions for the specified files. |
159 | 159 |
160 Differences between files are shown using the unified diff format. | 160 Differences between files are shown using the unified diff format. |
161 | 161 |
162 When two revision arguments are given, then changes are shown | 162 When two revision arguments are given, then changes are shown |
163 between those revisions. If only one revision is specified then | 163 between those revisions. If only one revision is specified then |
164 that revision is compared to the working directory, and, when no | 164 that revision is compared to the working directory, and, when no |
165 revisions are specified, the working directory files are compared | 165 revisions are specified, the working directory files are compared |
166 to its parent. | 166 to its parent. |
232 -r <rev>, --rev <rev> search in given revision range | 232 -r <rev>, --rev <rev> search in given revision range |
233 -u, --user print user who committed change | 233 -u, --user print user who committed change |
234 | 234 |
235 heads:: | 235 heads:: |
236 Show all repository head changesets. | 236 Show all repository head changesets. |
237 | 237 |
238 Repository "heads" are changesets that don't have children | 238 Repository "heads" are changesets that don't have children |
239 changesets. They are where development generally takes place and | 239 changesets. They are where development generally takes place and |
240 are the usual targets for update and merge operations. | 240 are the usual targets for update and merge operations. |
241 | 241 |
242 identify:: | 242 identify:: |
243 Print a short summary of the current state of the repo. | 243 Print a short summary of the current state of the repo. |
244 | 244 |
245 This summary identifies the repository state using one or two parent | 245 This summary identifies the repository state using one or two parent |
246 hash identifiers, followed by a "+" if there are uncommitted changes | 246 hash identifiers, followed by a "+" if there are uncommitted changes |
247 in the working directory, followed by a list of tags for this revision. | 247 in the working directory, followed by a list of tags for this revision. |
248 | 248 |
249 aliases: id | 249 aliases: id |
262 | 262 |
263 options: | 263 options: |
264 -p, --strip <n> directory strip option for patch. This has the same | 264 -p, --strip <n> directory strip option for patch. This has the same |
265 meaning as the corresponding patch option | 265 meaning as the corresponding patch option |
266 -b <path> base directory to read patches from | 266 -b <path> base directory to read patches from |
267 -f, --force skip check for outstanding uncommitted changes | 267 -f, --force skip check for outstanding uncommitted changes |
268 | 268 |
269 aliases: patch | 269 aliases: patch |
270 | 270 |
271 incoming [-p] [source]:: | 271 incoming [-p] [source]:: |
272 Show new changesets found in the specified repo or the default | 272 Show new changesets found in the specified repo or the default |
330 Print a list of version controlled files for the given revision. | 330 Print a list of version controlled files for the given revision. |
331 | 331 |
332 The manifest is the list of files being version controlled. If no revision | 332 The manifest is the list of files being version controlled. If no revision |
333 is given then the tip is used. | 333 is given then the tip is used. |
334 | 334 |
335 outgoing [-p] [dest]:: | 335 outgoing [-p] [dest]:: |
336 Show changesets not found in the specified destination repo or the | 336 Show changesets not found in the specified destination repo or the |
337 default push repo. These are the changesets that would be pushed | 337 default push repo. These are the changesets that would be pushed |
338 if a push was requested. | 338 if a push was requested. |
339 | 339 |
340 options: | 340 options: |
366 https://[user@]host[:port][/path] | 366 https://[user@]host[:port][/path] |
367 ssh://[user@]host[:port][/path] | 367 ssh://[user@]host[:port][/path] |
368 | 368 |
369 SSH requires an accessible shell account on the destination | 369 SSH requires an accessible shell account on the destination |
370 machine and a copy of hg in the remote path. | 370 machine and a copy of hg in the remote path. |
371 | 371 |
372 options: | 372 options: |
373 -u, --update update the working directory to tip after pull | 373 -u, --update update the working directory to tip after pull |
374 -e, --ssh specify ssh command to use | 374 -e, --ssh specify ssh command to use |
375 --remotecmd specify hg command to run on the remote side | 375 --remotecmd specify hg command to run on the remote side |
376 | 376 |
377 push <destination>:: | 377 push <destination>:: |
378 Push changes from the local repository to the given destination. | 378 Push changes from the local repository to the given destination. |
379 | 379 |
380 This is the symmetrical operation for pull. It helps to move | 380 This is the symmetrical operation for pull. It helps to move |
381 changes from the current repository to a different one. If the | 381 changes from the current repository to a different one. If the |
382 destination is local this is identical to a pull in that directory | 382 destination is local this is identical to a pull in that directory |
383 from the current one. | 383 from the current one. |
384 | 384 |
388 | 388 |
389 Valid URLs are of the form: | 389 Valid URLs are of the form: |
390 | 390 |
391 local/filesystem/path | 391 local/filesystem/path |
392 ssh://[user@]host[:port][/path] | 392 ssh://[user@]host[:port][/path] |
393 | 393 |
394 SSH requires an accessible shell account on the destination | 394 SSH requires an accessible shell account on the destination |
395 machine and a copy of hg in the remote path. | 395 machine and a copy of hg in the remote path. |
396 | 396 |
397 options: | 397 options: |
398 | 398 |
400 -e, --ssh specify ssh command to use | 400 -e, --ssh specify ssh command to use |
401 --remotecmd specify hg command to run on the remote side | 401 --remotecmd specify hg command to run on the remote side |
402 | 402 |
403 rawcommit [-p -d -u -F -m -l]:: | 403 rawcommit [-p -d -u -F -m -l]:: |
404 Lowlevel commit, for use in helper scripts. | 404 Lowlevel commit, for use in helper scripts. |
405 | 405 |
406 This command is not intended to be used by normal users, as it is | 406 This command is not intended to be used by normal users, as it is |
407 primarily useful for importing from other SCMs. | 407 primarily useful for importing from other SCMs. |
408 | 408 |
409 recover:: | 409 recover:: |
410 Recover from an interrupted commit or pull. | 410 Recover from an interrupted commit or pull. |
411 | 411 |
412 This command tries to fix the repository status after an interrupted | 412 This command tries to fix the repository status after an interrupted |
413 operation. It should only be necessary when Mercurial suggests it. | 413 operation. It should only be necessary when Mercurial suggests it. |
414 | 414 |
415 remove [options] [files ...]:: | 415 remove [options] [files ...]:: |
416 Schedule the indicated files for removal from the repository. | 416 Schedule the indicated files for removal from the repository. |
417 | 417 |
418 This command schedules the files to be removed at the next commit. | 418 This command schedules the files to be removed at the next commit. |
419 This only removes files from the current branch, not from the | 419 This only removes files from the current branch, not from the |
420 entire project history. | 420 entire project history. |
421 | 421 |
422 aliases: rm | 422 aliases: rm |
461 Show changed files in the working directory. If no names are | 461 Show changed files in the working directory. If no names are |
462 given, all files are shown. Otherwise, only files matching the | 462 given, all files are shown. Otherwise, only files matching the |
463 given names are shown. | 463 given names are shown. |
464 | 464 |
465 The codes used to show the status of files are: | 465 The codes used to show the status of files are: |
466 | 466 |
467 M = changed | 467 M = changed |
468 A = added | 468 A = added |
469 R = removed | 469 R = removed |
470 ? = not tracked | 470 ? = not tracked |
471 | 471 |
480 -I, --include <pat> include names matching the given patterns | 480 -I, --include <pat> include names matching the given patterns |
481 -X, --exclude <pat> exclude names matching the given patterns | 481 -X, --exclude <pat> exclude names matching the given patterns |
482 | 482 |
483 tag [-l -m <text> -d <datecode> -u <user>] <name> [revision]:: | 483 tag [-l -m <text> -d <datecode> -u <user>] <name> [revision]:: |
484 Name a particular revision using <name>. | 484 Name a particular revision using <name>. |
485 | 485 |
486 Tags are used to name particular revisions of the repository and are | 486 Tags are used to name particular revisions of the repository and are |
487 very useful to compare different revision, to go back to significant | 487 very useful to compare different revision, to go back to significant |
488 earlier versions or to mark branch points as releases, etc. | 488 earlier versions or to mark branch points as releases, etc. |
489 | 489 |
490 If no revision is given, the tip is used. | 490 If no revision is given, the tip is used. |
491 | 491 |
492 To facilitate version control, distribution, and merging of tags, | 492 To facilitate version control, distribution, and merging of tags, |
493 they are stored as a file named ".hgtags" which is managed | 493 they are stored as a file named ".hgtags" which is managed |
494 similarly to other project files and can be hand-edited if | 494 similarly to other project files and can be hand-edited if |
532 merging or discarding local changes. | 532 merging or discarding local changes. |
533 | 533 |
534 With the -m option, a merge will be performed. | 534 With the -m option, a merge will be performed. |
535 | 535 |
536 With the -C option, local changes will be lost. | 536 With the -C option, local changes will be lost. |
537 | 537 |
538 options: | 538 options: |
539 -m, --merge allow merging of branches | 539 -m, --merge allow merging of branches |
540 -C, --clean overwrite locally modified files | 540 -C, --clean overwrite locally modified files |
541 | 541 |
542 aliases: up checkout co | 542 aliases: up checkout co |
642 ENVIRONMENT VARIABLES | 642 ENVIRONMENT VARIABLES |
643 --------------------- | 643 --------------------- |
644 | 644 |
645 HGEDITOR:: | 645 HGEDITOR:: |
646 This is the name of the editor to use when committing. Defaults to the | 646 This is the name of the editor to use when committing. Defaults to the |
647 value of EDITOR. | 647 value of EDITOR. |
648 | 648 |
649 (deprecated, use .hgrc) | 649 (deprecated, use .hgrc) |
650 | 650 |
651 HGMERGE:: | 651 HGMERGE:: |
652 An executable to use for resolving merge conflicts. The program | 652 An executable to use for resolving merge conflicts. The program |