Mercurial > hg > pyhgsh
annotate doc/hg.1.txt @ 509:98a2935c3d6c
[PATCH] replace history with log
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
[PATCH] replace history with log
From: Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
Merge hg history into hg log leaving the first as an alias
(tweaked by mpm: update docs, tests, use existing alias mechanism)
manifest hash: f85001a4373b8b823a6221ba5c506628059d6779
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.0 (GNU/Linux)
iD8DBQFCwSr1ywK+sNU5EO8RAmbAAJ9HlFkf8/qLOAQUtj8CWxGRPEyzVgCgtXwP
SdnAg1a2q4693+TBiOjrimY=
=w9rf
-----END PGP SIGNATURE-----
| author | mpm@selenic.com |
|---|---|
| date | Tue, 28 Jun 2005 02:48:21 -0800 |
| parents | dc1f735dfaac |
| children | 003df62ae39f |
| 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 | |
| 498 | 85 If the destination directory is specified but doesn't exist, it is |
| 497 | 86 created. If no destination directory is specified, it defaults to the |
| 87 current directory. | |
| 88 | |
| 498 | 89 The source is added to the new repository's .hg/hgrc file to be used in |
| 497 | 90 future pulls. |
| 91 | |
| 498 | 92 For efficiency, hardlinks are used for cloning whenever the |
| 93 source and destination are on the same filesystem. | |
| 497 | 94 |
| 95 options: | |
| 505 | 96 -U, --noupdate do not update the new working directory |
| 497 | 97 |
| 98 commit [-A -t -l <file> -t <text> -u <user> -d <datecode>] [files...]:: | |
| 498 | 99 Commit changes to the given files into the repository. |
| 497 | 100 |
| 498 | 101 If a list of files is omitted, all changes reported by "hg status" |
| 102 will be commited. | |
| 497 | 103 |
| 498 | 104 The HGEDITOR or EDITOR environment variables are used to start an |
| 105 editor to add a commit comment. | |
| 497 | 106 |
| 107 Options: | |
| 108 | |
| 109 -A, --addremove run addremove during commit | |
| 110 -t, --text <text> use <text> as commit message | |
| 111 -l, --logfile <file> show the commit message for the given file | |
| 112 -d, --date <datecode> record datecode as commit date | |
| 113 -u, --user <user> record user as commiter | |
| 114 | |
| 115 aliases: ci | |
| 116 | |
| 117 copy <source> <dest>:: | |
| 118 Mark <dest> file as a copy or rename of a <source> one | |
| 119 | |
| 120 This command takes effect for the next commit. | |
| 121 | |
| 122 diff [-r revision] [-r revision] [files ...]:: | |
| 123 Show differences between revisions for the specified files. | |
| 124 | |
| 125 Differences between files are shown using the unified diff format. | |
| 126 | |
| 498 | 127 When two revision arguments are given, then changes are shown |
| 128 between those revisions. If only one revision is specified then | |
| 129 that revision is compared to the working directory, and, when no | |
| 130 revisions are specified, the working directory files are compared | |
| 131 to its parent. | |
| 497 | 132 |
| 133 export [revision]:: | |
| 134 Print the changeset header and diffs for a particular revision. | |
| 135 | |
| 136 The information shown in the changeset header is: author, changeset hash, | |
| 137 parent and commit comment. | |
| 138 | |
| 139 forget [files]:: | |
| 140 Undo an 'hg add' scheduled for the next commit. | |
| 141 | |
| 142 heads:: | |
| 143 Show all repository head changesets. | |
| 144 | |
| 498 | 145 Repository "heads" are changesets that don't have children |
| 146 changesets. They are where development generally takes place and | |
| 147 are the usual targets for update and merge operations. | |
| 497 | 148 |
| 149 identify:: | |
| 150 Print a short summary of the current state of the repo. | |
| 151 | |
| 152 This summary identifies the repository state using one or two parent | |
| 153 hash identifiers, followed by a "+" if there are uncommitted changes | |
| 154 in the working directory, followed by a list of tags for this revision. | |
| 155 | |
| 156 aliases: id | |
| 157 | |
| 158 import [-p <n> -b <base> -q] <patches>:: | |
| 159 Import a list of patches and commit them individually. | |
| 160 | |
| 161 options: | |
| 162 -p, --strip <n> directory strip option for patch. This has the same | |
| 163 meaning as the correnponding patch option | |
| 164 -b <path> base directory to read patches from | |
| 165 | |
| 166 aliases: patch | |
| 167 | |
| 496 | 168 init:: |
| 169 Initialize a new repository in the current directory. | |
| 177 | 170 |
| 509 | 171 log [file]:: |
| 172 Print the revision history of the specified file or the entire project. | |
| 177 | 173 |
| 509 | 174 By default this command outputs: changeset id and hash, tags, |
| 175 parents, user, date and time, and a summary for each commit. The | |
| 176 -v switch adds some more detail, such as changed files, manifest | |
| 177 hashes or message signatures. | |
| 178 | |
| 179 aliases: history | |
| 497 | 180 |
| 438 | 181 manifest [revision]:: |
| 497 | 182 Print a list of version controlled files for the given revision. |
| 183 | |
| 184 The manifest is the list of files being version controlled. If no revision | |
| 185 is given then the tip is used. | |
| 438 | 186 |
| 187 parents:: | |
| 188 Print the working directory's parent revisions. | |
| 189 | |
| 190 pull <repository path>:: | |
| 498 | 191 Pull changes from a remote repository to a local one. |
| 497 | 192 |
| 498 | 193 This finds all changes from the repository at the specified path |
| 194 or URL and adds them to the local repository. By default, this | |
| 195 does not update the copy of the project in the working directory. | |
| 438 | 196 |
| 197 options: | |
| 198 -u, --update update the working directory to tip after pull | |
| 199 | |
| 200 push <destination>:: | |
| 497 | 201 Push changes from the local repository to the given destination. |
| 202 | |
| 498 | 203 This is the symmetrical operation for pull. It helps to move |
| 204 changes from the current repository to a different one. If the | |
| 205 destination is local this is identical to a pull in that directory | |
| 206 from the current one. | |
| 438 | 207 |
| 208 The other currently available push method is SSH. This requires an | |
| 209 accessible shell account on the destination machine and a copy of | |
| 210 hg in the remote path. Destinations are specified in the following | |
| 211 form: | |
| 212 | |
| 213 ssh://[user@]host[:port]/path | |
| 214 | |
| 215 rawcommit [-p -d -u -F -t -l]:: | |
| 497 | 216 Lowlevel commit, for use in helper scripts. |
| 217 | |
| 218 This command is not intended to be used by normal users, as it is | |
| 219 primarily useful for importing from other SCMs. | |
| 177 | 220 |
|
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
221 recover:: |
| 497 | 222 Recover from an interrupted commit or pull. |
| 223 | |
| 224 This command tries to fix the repository status after an interrupted | |
| 225 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
|
226 |
| 177 | 227 remove [files ...]:: |
| 497 | 228 Schedule the indicated files for removal from the repository. |
| 229 | |
| 498 | 230 This command shedules the files to be removed at the next commit. |
| 231 This only removes files from the current branch, not from the | |
| 232 entire project history. | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
233 |
| 438 | 234 aliases: rm |
| 177 | 235 |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
236 root:: |
|
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
237 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
|
238 |
| 177 | 239 serve [-a addr -n name -p port -t templatedir]:: |
| 438 | 240 Start a local HTTP repository browser and pull server. |
| 241 | |
| 242 options: | |
| 243 -a, --address <addr> address to use | |
| 244 -p, --port <n> port to use (default: 8000) | |
| 245 -n, --name <name> name to show in web pages (default: working dir) | |
| 246 -t, --templatedir <path> web templates to use | |
| 177 | 247 |
| 248 status:: | |
| 438 | 249 Show changed files in the working directory. |
| 250 | |
| 497 | 251 The codes used to show the status of files are: |
| 252 | |
| 438 | 253 C = changed |
| 254 A = added | |
| 255 R = removed | |
| 256 ? = not tracked | |
| 257 | |
| 258 tag [-t <text> -d <datecode> -u <user>] <name> [revision]:: | |
| 497 | 259 Name a particular revision using <name>. |
| 260 | |
| 261 Tags are used to name particular revisions of the repository and are | |
| 262 very useful to compare different revision, to go back to significant | |
| 498 | 263 earlier versions or to mark branch points as releases, etc. |
| 497 | 264 |
| 498 | 265 If no revision is given, the tip is used. |
| 438 | 266 |
| 498 | 267 To facilitate version control, distribution, and merging of tags, |
| 268 they are stored as a file named ".hgtags" which is managed | |
| 269 similarly to other project files and can be hand-edited if | |
| 270 necessary. | |
| 271 | |
| 438 | 272 options: |
| 273 -t, --text <text> message for tag commit log entry | |
| 274 -d, --date <datecode> datecode for commit | |
| 275 -u, --user <user> user for commit | |
| 177 | 276 |
| 498 | 277 Note: Mercurial also has support for "local tags" that are not |
| 278 version-controlled or distributed which are stored in the .hg/hgrc | |
| 279 file. | |
| 280 | |
| 177 | 281 tags:: |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
282 List the repository tags. |
| 438 | 283 |
| 498 | 284 This lists both regular and local tags. |
| 497 | 285 |
| 438 | 286 tip:: |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
287 Show the tip revision. |
| 177 | 288 |
|
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
289 undo:: |
| 438 | 290 Undo the last commit or pull transaction. |
| 291 | |
| 292 update [-m -C] [revision]:: | |
| 498 | 293 Update the working directory to the specified revision. |
| 438 | 294 |
| 498 | 295 By default, update will refuse to run if doing so would require |
| 296 merging or discarding local changes. | |
| 297 | |
| 298 With the -m option, a merge will be performed. | |
| 299 | |
| 300 With the -C option, local changes will be lost. | |
| 497 | 301 |
| 438 | 302 options: |
| 303 -m, --merge allow merging of branches | |
| 304 -C, --clean overwrite locally modified files | |
| 305 | |
| 306 aliases: up checkout co | |
| 307 | |
| 308 verify:: | |
| 309 Verify the integrity of the current repository. | |
| 310 | |
| 311 This will perform an extensive check of the repository's | |
| 312 integrity, validating the hashes and checksums of each entry in | |
| 313 the changelog, manifest, and tracked files, as well as the | |
| 314 integrity of their crosslinks and indices. | |
| 315 | |
|
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
316 |
| 177 | 317 ENVIRONMENT VARIABLES |
| 318 --------------------- | |
| 438 | 319 |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
320 HGEDITOR:: |
|
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
321 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
|
322 value of EDITOR. |
|
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
323 |
| 177 | 324 HGMERGE:: |
| 498 | 325 An executable to use for resolving merge conflicts. The program |
| 438 | 326 will be executed with three arguments: local file, remote file, |
| 327 ancestor file. | |
| 328 | |
| 329 The default program is "hgmerge", which is a shell script provided | |
| 330 by Mercurial with some sensible defaults. | |
| 177 | 331 |
| 332 HGUSER:: | |
| 438 | 333 This is the string used for the author of a commit. |
| 177 | 334 |
| 335 EMAIL:: | |
| 438 | 336 If HGUSER is not set, this will be used as the author for a commit. |
| 177 | 337 |
| 338 LOGNAME:: | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
339 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with |
| 438 | 340 '@hostname' appended) as the author value for a commit. |
| 177 | 341 |
| 342 EDITOR:: | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
343 This is the name of the editor used in the hgmerge script. It will be |
| 498 | 344 used for commit messages if HGEDITOR isn't set. Defaults to 'vi'. |
| 438 | 345 |
| 346 PYTHONPATH:: | |
| 347 This is used by Python to find imported modules and may need to be set | |
| 348 appropriately if Mercurial is not installed system-wide. | |
| 177 | 349 |
| 350 FILES | |
| 351 ----- | |
| 352 .hgignore:: | |
| 438 | 353 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
|
354 names that should be ignored by hg. |
| 177 | 355 |
| 356 .hgtags:: | |
| 438 | 357 This file contains changeset hash values and text tag names (one of each |
| 177 | 358 seperated by spaces) that correspond to tagged versions of the repository |
| 359 contents. | |
| 360 | |
| 438 | 361 $HOME/.hgrc, .hg/hgrc:: |
| 362 This file contains defaults and configuration. Values in .hg/hgrc | |
| 363 override those in .hgrc. | |
| 364 | |
| 365 NAMED REPOSITORIES | |
| 366 ------------------ | |
| 367 | |
| 487 | 368 To give symbolic names to a repository, create a section in .hgrc |
| 369 or .hg/hgrc containing assignments of names to paths. Example: | |
| 438 | 370 |
| 487 | 371 ----------------- |
| 438 | 372 [paths] |
| 373 hg = http://selenic.com/hg | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
374 tah = http://hg.intevation.org/mercurial-tah/ |
| 487 | 375 ----------------- |
| 376 | |
| 377 | |
| 498 | 378 LOCAL TAGS |
| 379 ---------- | |
| 380 | |
| 381 To create tags that are local to the repository and not distributed or | |
| 382 version-controlled, create an hgrc section like the following: | |
| 383 | |
| 384 ---------------- | |
| 385 [tags] | |
| 386 working = 2dcced388cab3677a8f543c3c47a0ad34ac9d435 | |
| 387 tested = 12e0fdbc57a0be78f0e817fd1d170a3615cd35da | |
| 388 ---------------- | |
| 389 | |
| 390 | |
| 487 | 391 HOOKS |
| 392 ----- | |
| 393 | |
| 394 Mercurial supports a set of 'hook', commands that get automatically | |
| 395 executed by various actions such as starting or finishing a commit. To | |
| 396 specify a hook, simply create an hgrc section like the following: | |
| 397 | |
| 398 ----------------- | |
| 399 [hooks] | |
| 400 precommit = echo "this hook gets executed immediately before a commit" | |
| 401 commit = hg export $NODE | mail -s "new commit $NODE" commit-list | |
| 402 ----------------- | |
| 403 | |
|
181
038e4d8602bd
updated for .hgpaths and http/old-http protocol name change
jake@edge2.net
parents:
177
diff
changeset
|
404 |
| 321 | 405 NON_TRANSPARENT PROXY SUPPORT |
| 438 | 406 ----------------------------- |
| 321 | 407 |
| 487 | 408 To access a Mercurial repository through a proxy, create a file |
| 409 $HOME/.hgrc in the following format: | |
| 321 | 410 |
| 487 | 411 -------------- |
| 321 | 412 [http_proxy] |
| 413 host=myproxy:8080 | |
| 414 user=<username> | |
| 415 passwd=<password> | |
| 416 no=<localhost1>,<localhost2>,<localhost3>,... | |
| 487 | 417 -------------- |
| 321 | 418 |
| 498 | 419 "user" and "passwd" fields are used for authenticating proxies, "no" is a |
| 420 comma-separated list of local host names to not proxy. | |
| 321 | 421 |
| 177 | 422 BUGS |
| 423 ---- | |
| 424 Probably lots, please post them to the mailing list (See Resources below) | |
| 425 when you find them. | |
| 426 | |
| 427 AUTHOR | |
| 428 ------ | |
| 429 Written by Matt Mackall <mpm@selenic.com> | |
| 430 | |
| 431 RESOURCES | |
| 432 --------- | |
| 433 http://selenic.com/mercurial[Main Web Site] | |
| 434 | |
| 435 http://selenic.com/hg[Source code repository] | |
| 436 | |
| 437 http://selenic.com/mailman/listinfo/mercurial[Mailing list] | |
| 438 | |
| 439 COPYING | |
| 440 ------- | |
| 441 Copyright (C) 2005 Matt Mackall. | |
| 442 Free use of this software is granted under the terms of the GNU General | |
| 443 Public License (GPL). |