Mercurial > hg > pyhgsh
annotate doc/hg.1.txt @ 810:790a0ff306f2
Move commands.forget over to using new walk code.
With no names, it now recursively forgets everything, as is the default
behaviour of other commands. And prints the names of all files it
hasn't specifically been told to forget.
| author | Bryan O'Sullivan <bos@serpentine.com> |
|---|---|
| date | Fri, 29 Jul 2005 08:49:01 -0800 |
| parents | b444a7e053f1 |
| children | fa9aaf3bbdd7 |
| 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: |
|
734
d4e161d60f61
Update docs for annotate and diff.
Bryan O'Sullivan <bos@serpentine.com>
parents:
731
diff
changeset
|
76 -I, --include <pat> include directories matching the given patterns |
|
d4e161d60f61
Update docs for annotate and diff.
Bryan O'Sullivan <bos@serpentine.com>
parents:
731
diff
changeset
|
77 -X, --exclude <pat> exclude directories 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 |
| 745 | 103 commit [-A -t -l <file> -m <text> -u <user> -d <datecode>] [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" |
| 107 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 | |
|
761
0fb498458905
Change all references to -t --text commit message to -m and --message.
Andrew Thompson <andrewkt@aktzero.com>
parents:
750
diff
changeset
|
115 -m, --message <text> use <text> as commit message |
| 497 | 116 -l, --logfile <file> show the commit message for the given file |
| 117 -d, --date <datecode> record datecode as commit date | |
| 118 -u, --user <user> record user as commiter | |
| 119 | |
| 120 aliases: ci | |
| 121 | |
| 122 copy <source> <dest>:: | |
| 123 Mark <dest> file as a copy or rename of a <source> one | |
| 124 | |
| 125 This command takes effect for the next commit. | |
| 126 | |
| 127 diff [-r revision] [-r revision] [files ...]:: | |
| 128 Show differences between revisions for the specified files. | |
| 129 | |
| 130 Differences between files are shown using the unified diff format. | |
| 131 | |
| 498 | 132 When two revision arguments are given, then changes are shown |
| 133 between those revisions. If only one revision is specified then | |
| 134 that revision is compared to the working directory, and, when no | |
| 135 revisions are specified, the working directory files are compared | |
| 136 to its parent. | |
| 497 | 137 |
|
734
d4e161d60f61
Update docs for annotate and diff.
Bryan O'Sullivan <bos@serpentine.com>
parents:
731
diff
changeset
|
138 options: |
|
d4e161d60f61
Update docs for annotate and diff.
Bryan O'Sullivan <bos@serpentine.com>
parents:
731
diff
changeset
|
139 -I, --include <pat> include directories matching the given patterns |
|
d4e161d60f61
Update docs for annotate and diff.
Bryan O'Sullivan <bos@serpentine.com>
parents:
731
diff
changeset
|
140 -X, --exclude <pat> exclude directories matching the given patterns |
|
d4e161d60f61
Update docs for annotate and diff.
Bryan O'Sullivan <bos@serpentine.com>
parents:
731
diff
changeset
|
141 |
| 580 | 142 export [-o filespec] [revision] ...:: |
| 143 Print the changeset header and diffs for one or more revisions. | |
| 144 | |
| 145 The information shown in the changeset header is: author, | |
| 146 changeset hash, parent and commit comment. | |
| 147 | |
| 148 Output may be to a file, in which case the name of the file is | |
| 149 given using a format string. The formatting rules are as follows: | |
| 497 | 150 |
| 580 | 151 %% literal "%" character |
| 152 %H changeset hash (40 bytes of hexadecimal) | |
| 153 %N number of patches being generated | |
| 154 %R changeset revision number | |
| 155 %b basename of the exporting repository | |
| 156 %h short-form changeset hash (12 bytes of hexadecimal) | |
| 157 %n zero-padded sequence number, starting at 1 | |
| 158 %r zero-padded changeset revision number | |
| 159 | |
| 160 Options: | |
| 161 | |
| 162 -o, --output <filespec> print output to file with formatted named | |
| 497 | 163 |
|
810
790a0ff306f2
Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
766
diff
changeset
|
164 forget [options] [files]:: |
| 497 | 165 Undo an 'hg add' scheduled for the next commit. |
| 166 | |
|
810
790a0ff306f2
Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
766
diff
changeset
|
167 options: |
|
790a0ff306f2
Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
766
diff
changeset
|
168 -I, --include <pat> include directories matching the given patterns |
|
790a0ff306f2
Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
766
diff
changeset
|
169 -X, --exclude <pat> exclude directories matching the given patterns |
|
790a0ff306f2
Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
766
diff
changeset
|
170 |
| 497 | 171 heads:: |
| 172 Show all repository head changesets. | |
| 173 | |
| 498 | 174 Repository "heads" are changesets that don't have children |
| 175 changesets. They are where development generally takes place and | |
| 176 are the usual targets for update and merge operations. | |
| 497 | 177 |
| 178 identify:: | |
| 179 Print a short summary of the current state of the repo. | |
| 180 | |
| 181 This summary identifies the repository state using one or two parent | |
| 182 hash identifiers, followed by a "+" if there are uncommitted changes | |
| 183 in the working directory, followed by a list of tags for this revision. | |
| 184 | |
| 185 aliases: id | |
| 186 | |
| 187 import [-p <n> -b <base> -q] <patches>:: | |
| 188 Import a list of patches and commit them individually. | |
| 189 | |
| 190 options: | |
| 191 -p, --strip <n> directory strip option for patch. This has the same | |
| 192 meaning as the correnponding patch option | |
| 193 -b <path> base directory to read patches from | |
| 194 | |
| 195 aliases: patch | |
| 196 | |
| 496 | 197 init:: |
| 198 Initialize a new repository in the current directory. | |
| 177 | 199 |
|
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
200 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
|
201 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
|
202 given patterns. |
| 627 | 203 |
| 204 This command searches the current directory and its | |
| 205 subdirectories. To search an entire repository, move to the root | |
| 206 of the repository. | |
| 207 | |
| 208 If no patterns are given to match, this command prints all file | |
| 209 names. | |
| 210 | |
| 211 If you want to feed the output of this command into the "xargs" | |
| 212 command, use the "-0" option to both this command and "xargs". | |
| 213 This will avoid the problem of "xargs" treating single filenames | |
| 214 that contain white space as multiple file names. | |
| 215 | |
| 216 options: | |
| 217 | |
| 218 -0, --print0 end filenames with NUL, for use with xargs | |
| 219 -f, --fullpath print complete paths from the filesystem root | |
|
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
220 -I, --include <pat> include directories matching the given patterns |
| 627 | 221 -r, --rev <rev> search the repository as it stood at rev |
|
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
222 -X, --exclude <pat> exclude directories matching the given patterns |
| 627 | 223 |
|
612
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
224 log [-r revision ...] [-p] [file]:: |
| 509 | 225 Print the revision history of the specified file or the entire project. |
| 177 | 226 |
| 509 | 227 By default this command outputs: changeset id and hash, tags, |
| 228 parents, user, date and time, and a summary for each commit. The | |
| 229 -v switch adds some more detail, such as changed files, manifest | |
| 230 hashes or message signatures. | |
| 231 | |
|
612
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
232 options: |
|
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
233 -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
|
234 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
|
235 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
|
236 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
|
237 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
|
238 -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
|
239 |
| 509 | 240 aliases: history |
| 497 | 241 |
| 438 | 242 manifest [revision]:: |
| 497 | 243 Print a list of version controlled files for the given revision. |
| 244 | |
| 245 The manifest is the list of files being version controlled. If no revision | |
| 246 is given then the tip is used. | |
| 438 | 247 |
| 248 parents:: | |
| 249 Print the working directory's parent revisions. | |
| 250 | |
| 251 pull <repository path>:: | |
| 498 | 252 Pull changes from a remote repository to a local one. |
| 497 | 253 |
| 498 | 254 This finds all changes from the repository at the specified path |
| 255 or URL and adds them to the local repository. By default, this | |
| 256 does not update the copy of the project in the working directory. | |
| 438 | 257 |
| 258 options: | |
| 259 -u, --update update the working directory to tip after pull | |
| 260 | |
| 261 push <destination>:: | |
| 497 | 262 Push changes from the local repository to the given destination. |
| 263 | |
| 498 | 264 This is the symmetrical operation for pull. It helps to move |
| 265 changes from the current repository to a different one. If the | |
| 266 destination is local this is identical to a pull in that directory | |
| 267 from the current one. | |
| 438 | 268 |
| 269 The other currently available push method is SSH. This requires an | |
| 270 accessible shell account on the destination machine and a copy of | |
| 271 hg in the remote path. Destinations are specified in the following | |
| 272 form: | |
| 273 | |
| 274 ssh://[user@]host[:port]/path | |
| 275 | |
| 747 | 276 rawcommit [-p -d -u -F -m -l]:: |
| 497 | 277 Lowlevel commit, for use in helper scripts. |
| 278 | |
| 279 This command is not intended to be used by normal users, as it is | |
| 280 primarily useful for importing from other SCMs. | |
| 177 | 281 |
|
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
282 recover:: |
| 497 | 283 Recover from an interrupted commit or pull. |
| 284 | |
| 285 This command tries to fix the repository status after an interrupted | |
| 286 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
|
287 |
| 177 | 288 remove [files ...]:: |
| 497 | 289 Schedule the indicated files for removal from the repository. |
| 290 | |
| 498 | 291 This command shedules the files to be removed at the next commit. |
| 292 This only removes files from the current branch, not from the | |
| 293 entire project history. | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
294 |
| 438 | 295 aliases: rm |
| 177 | 296 |
| 588 | 297 revert [names ...]:: |
| 298 Revert any uncommitted modifications made to the named files or | |
| 299 directories. This restores the contents of the affected files to | |
| 300 an unmodified state. | |
| 301 | |
| 302 If a file has been deleted, it is recreated. If the executable | |
| 303 mode of a file was changed, it is reset. | |
| 304 | |
| 305 If a directory is given, all files in that directory and its | |
| 306 subdirectories are reverted. | |
| 307 | |
| 308 If no arguments are given, all files in the current directory and | |
| 309 its subdirectories are reverted. | |
| 310 | |
| 311 options: | |
| 312 -r, --rev <rev> revision to revert to | |
| 313 -n, --nonrecursive do not recurse into subdirectories | |
| 314 | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
315 root:: |
|
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
316 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
|
317 |
|
606
ea4526f9b1a5
[PATCH] Fix thinko in "serve" man page entry.
mpm@selenic.com
parents:
605
diff
changeset
|
318 serve [options]:: |
| 438 | 319 Start a local HTTP repository browser and pull server. |
| 320 | |
|
605
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
321 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
|
322 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
|
323 |
| 438 | 324 options: |
|
605
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
325 -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
|
326 -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
|
327 -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
|
328 -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
|
329 -n, --name <name> name to show in web pages (default: working dir) |
| 438 | 330 -t, --templatedir <path> web templates to use |
| 177 | 331 |
|
731
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
332 status [options] [files]:: |
|
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
333 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
|
334 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
|
335 given names are shown. |
| 438 | 336 |
| 497 | 337 The codes used to show the status of files are: |
| 338 | |
| 746 | 339 M = changed |
| 438 | 340 A = added |
| 341 R = removed | |
| 342 ? = not tracked | |
| 343 | |
|
731
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
344 options: |
|
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
345 |
|
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
346 -I, --include <pat> include directories matching the given patterns |
|
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
347 -X, --exclude <pat> exclude directories matching the given patterns |
|
91ca3afab8e8
Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
728
diff
changeset
|
348 |
| 750 | 349 tag [-l -m <text> -d <datecode> -u <user>] <name> [revision]:: |
| 497 | 350 Name a particular revision using <name>. |
| 351 | |
| 352 Tags are used to name particular revisions of the repository and are | |
| 353 very useful to compare different revision, to go back to significant | |
| 498 | 354 earlier versions or to mark branch points as releases, etc. |
| 497 | 355 |
| 498 | 356 If no revision is given, the tip is used. |
| 438 | 357 |
| 498 | 358 To facilitate version control, distribution, and merging of tags, |
| 359 they are stored as a file named ".hgtags" which is managed | |
| 360 similarly to other project files and can be hand-edited if | |
| 361 necessary. | |
| 362 | |
| 438 | 363 options: |
|
631
a287f6cd9c6b
Update documentation of hg tag
Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
parents:
629
diff
changeset
|
364 -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
|
365 -m, --message <text> message for tag commit log entry |
| 438 | 366 -d, --date <datecode> datecode for commit |
| 367 -u, --user <user> user for commit | |
| 177 | 368 |
|
631
a287f6cd9c6b
Update documentation of hg tag
Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
parents:
629
diff
changeset
|
369 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
|
370 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
|
371 a public tag with the same name, local tag is used. |
| 498 | 372 |
| 177 | 373 tags:: |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
374 List the repository tags. |
| 438 | 375 |
| 498 | 376 This lists both regular and local tags. |
| 497 | 377 |
| 438 | 378 tip:: |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
379 Show the tip revision. |
| 177 | 380 |
|
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
381 undo:: |
| 438 | 382 Undo the last commit or pull transaction. |
| 383 | |
| 595 | 384 Roll back the last pull or commit transaction on the |
| 385 repository, restoring the project to its earlier state. | |
| 386 | |
| 387 This command should be used with care. There is only one level of | |
| 388 undo and there is no redo. | |
| 389 | |
| 390 This command is not intended for use on public repositories. Once | |
| 391 a change is visible for pull by other users, undoing it locally is | |
| 392 ineffective. | |
| 393 | |
| 438 | 394 update [-m -C] [revision]:: |
| 498 | 395 Update the working directory to the specified revision. |
| 438 | 396 |
| 498 | 397 By default, update will refuse to run if doing so would require |
| 398 merging or discarding local changes. | |
| 399 | |
| 400 With the -m option, a merge will be performed. | |
| 401 | |
| 402 With the -C option, local changes will be lost. | |
| 497 | 403 |
| 438 | 404 options: |
| 405 -m, --merge allow merging of branches | |
| 406 -C, --clean overwrite locally modified files | |
| 407 | |
| 408 aliases: up checkout co | |
| 409 | |
| 410 verify:: | |
| 411 Verify the integrity of the current repository. | |
| 412 | |
| 413 This will perform an extensive check of the repository's | |
| 414 integrity, validating the hashes and checksums of each entry in | |
| 415 the changelog, manifest, and tracked files, as well as the | |
| 416 integrity of their crosslinks and indices. | |
| 417 | |
|
724
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
418 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
|
419 ------------------ |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
420 |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
421 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
|
422 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
|
423 |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
424 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
|
425 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
|
426 |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
427 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
|
428 |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
429 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
|
430 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
|
431 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
|
432 |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
433 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
|
434 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
|
435 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
|
436 |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
437 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
|
438 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
|
439 |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
440 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
|
441 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
|
442 |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
443 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
|
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 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
|
446 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
|
447 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
|
448 |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
449 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
|
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 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
|
452 *.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
|
453 **.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
|
454 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
|
455 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
|
456 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
|
457 subdirectory |
|
1c0c413cccdd
Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents:
671
diff
changeset
|
458 |
|
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 examples: |
|
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 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
|
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 |
| 580 | 464 SPECIFYING SINGLE REVISIONS |
| 465 --------------------------- | |
| 466 | |
| 467 Mercurial accepts several notations for identifying individual | |
| 468 revisions. | |
| 469 | |
| 470 A plain integer is treated as a revision number. Negative | |
| 471 integers are treated as offsets from the tip, with -1 denoting the | |
| 472 tip. | |
| 473 | |
| 474 A 40-digit hexadecimal string is treated as a unique revision | |
| 475 identifier. | |
| 476 | |
| 477 A hexadecimal string less than 40 characters long is treated as a | |
| 478 unique revision identifier, and referred to as a short-form | |
| 479 identifier. A short-form identifier is only valid if it is the | |
| 480 prefix of one full-length identifier. | |
| 481 | |
| 482 Any other string is treated as a tag name, which is a symbolic | |
| 483 name associated with a revision identifier. Tag names may not | |
| 484 contain the ":" character. | |
| 485 | |
| 486 The reserved name "tip" is a special tag that always identifies | |
| 487 the most recent revision. | |
| 488 | |
| 489 SPECIFYING MULTIPLE REVISIONS | |
| 490 ----------------------------- | |
| 491 | |
| 492 When Mercurial accepts more than one revision, they may be | |
| 493 specified individually, or provided as a continuous range, | |
| 494 separated by the ":" character. | |
| 495 | |
| 496 The syntax of range notation is [BEGIN]:[END], where BEGIN and END | |
| 497 are revision identifiers. Both BEGIN and END are optional. If | |
| 498 BEGIN is not specified, it defaults to revision number 0. If END | |
| 499 is not specified, it defaults to the tip. The range ":" thus | |
| 500 means "all revisions". | |
| 501 | |
| 502 If BEGIN is greater than END, revisions are treated in reverse | |
| 503 order. | |
| 504 | |
| 505 A range acts as an open interval. This means that a range of 3:5 | |
| 506 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
|
507 |
| 177 | 508 ENVIRONMENT VARIABLES |
| 509 --------------------- | |
| 438 | 510 |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
511 HGEDITOR:: |
|
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
512 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
|
513 value of EDITOR. |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
514 |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
515 (deprecated, use .hgrc) |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
516 |
| 177 | 517 HGMERGE:: |
| 498 | 518 An executable to use for resolving merge conflicts. The program |
| 438 | 519 will be executed with three arguments: local file, remote file, |
| 520 ancestor file. | |
| 521 | |
| 522 The default program is "hgmerge", which is a shell script provided | |
| 523 by Mercurial with some sensible defaults. | |
| 177 | 524 |
|
608
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
525 (deprecated, use .hgrc) |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
526 |
| 177 | 527 HGUSER:: |
| 438 | 528 This is the string used for the author of a commit. |
| 177 | 529 |
|
608
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
530 (deprecated, use .hgrc) |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
531 |
| 177 | 532 EMAIL:: |
| 438 | 533 If HGUSER is not set, this will be used as the author for a commit. |
| 177 | 534 |
| 535 LOGNAME:: | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
536 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with |
| 438 | 537 '@hostname' appended) as the author value for a commit. |
| 177 | 538 |
| 539 EDITOR:: | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
540 This is the name of the editor used in the hgmerge script. It will be |
| 498 | 541 used for commit messages if HGEDITOR isn't set. Defaults to 'vi'. |
| 438 | 542 |
| 543 PYTHONPATH:: | |
| 544 This is used by Python to find imported modules and may need to be set | |
| 545 appropriately if Mercurial is not installed system-wide. | |
| 177 | 546 |
| 547 FILES | |
| 548 ----- | |
| 549 .hgignore:: | |
| 438 | 550 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
|
551 names that should be ignored by hg. |
| 177 | 552 |
| 553 .hgtags:: | |
| 438 | 554 This file contains changeset hash values and text tag names (one of each |
| 177 | 555 seperated by spaces) that correspond to tagged versions of the repository |
| 556 contents. | |
| 557 | |
| 438 | 558 $HOME/.hgrc, .hg/hgrc:: |
| 559 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
|
560 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
|
561 and format of these files. |
| 321 | 562 |
| 177 | 563 BUGS |
| 564 ---- | |
| 565 Probably lots, please post them to the mailing list (See Resources below) | |
| 566 when you find them. | |
| 567 | |
|
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
568 SEE ALSO |
|
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
569 -------- |
|
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
570 hgrc(5) |
|
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
571 |
| 177 | 572 AUTHOR |
| 573 ------ | |
| 574 Written by Matt Mackall <mpm@selenic.com> | |
| 575 | |
| 576 RESOURCES | |
| 577 --------- | |
| 578 http://selenic.com/mercurial[Main Web Site] | |
| 579 | |
|
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
631
diff
changeset
|
580 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
|
581 |
| 177 | 582 http://selenic.com/hg[Source code repository] |
| 583 | |
| 584 http://selenic.com/mailman/listinfo/mercurial[Mailing list] | |
| 585 | |
| 586 COPYING | |
| 587 ------- | |
| 588 Copyright (C) 2005 Matt Mackall. | |
| 589 Free use of this software is granted under the terms of the GNU General | |
| 590 Public License (GPL). |