Mercurial > hg > pyhgsh
annotate doc/hg.1.txt @ 627:b6c42714d900
Add locate command.
# HG changeset patch
# User Bryan O'Sullivan <bos@serpentine.com>
# Node ID ebf5eba347a17a5c09000b3342caf350cd060a1b
# Parent d2994b5298fb20f87dc1d4747635b280db3c0526
Add locate command.
Used for finding files with names that match specific patterns,
such as "*.c".
This patch also introduces localrepository.getcwd, which returns the
current directory relative to the repository root.
| author | Bryan O'Sullivan <bos@serpentine.com> |
|---|---|
| date | Tue, 05 Jul 2005 18:19:01 -0800 |
| parents | 9cd745437269 |
| children | 2fdf3b1659b9 |
| 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 |
| 627 | 186 locate [options] [patterns]:: |
| 187 Print all files under Mercurial control whose names or paths match | |
| 188 the given patterns. | |
| 189 | |
| 190 Patterns are shell-style globs. To restrict searches to specific | |
| 191 directories, use the "-i <pat>" option. To eliminate particular | |
| 192 directories from searching, use the "-x <pat>" option. | |
| 193 | |
| 194 This command searches the current directory and its | |
| 195 subdirectories. To search an entire repository, move to the root | |
| 196 of the repository. | |
| 197 | |
| 198 If no patterns are given to match, this command prints all file | |
| 199 names. | |
| 200 | |
| 201 If you want to feed the output of this command into the "xargs" | |
| 202 command, use the "-0" option to both this command and "xargs". | |
| 203 This will avoid the problem of "xargs" treating single filenames | |
| 204 that contain white space as multiple file names. | |
| 205 | |
| 206 options: | |
| 207 | |
| 208 -0, --print0 end filenames with NUL, for use with xargs | |
| 209 -f, --fullpath print complete paths from the filesystem root | |
| 210 -i, --include <pat> include directories matching the given globs | |
| 211 -r, --rev <rev> search the repository as it stood at rev | |
| 212 -x, --exclude <pat> exclude directories matching the given globs | |
| 213 | |
|
612
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
214 log [-r revision ...] [-p] [file]:: |
| 509 | 215 Print the revision history of the specified file or the entire project. |
| 177 | 216 |
| 509 | 217 By default this command outputs: changeset id and hash, tags, |
| 218 parents, user, date and time, and a summary for each commit. The | |
| 219 -v switch adds some more detail, such as changed files, manifest | |
| 220 hashes or message signatures. | |
| 221 | |
|
612
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
222 options: |
|
9cd745437269
On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents:
608
diff
changeset
|
223 -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
|
224 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
|
225 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
|
226 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
|
227 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
|
228 -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
|
229 |
| 509 | 230 aliases: history |
| 497 | 231 |
| 438 | 232 manifest [revision]:: |
| 497 | 233 Print a list of version controlled files for the given revision. |
| 234 | |
| 235 The manifest is the list of files being version controlled. If no revision | |
| 236 is given then the tip is used. | |
| 438 | 237 |
| 238 parents:: | |
| 239 Print the working directory's parent revisions. | |
| 240 | |
| 241 pull <repository path>:: | |
| 498 | 242 Pull changes from a remote repository to a local one. |
| 497 | 243 |
| 498 | 244 This finds all changes from the repository at the specified path |
| 245 or URL and adds them to the local repository. By default, this | |
| 246 does not update the copy of the project in the working directory. | |
| 438 | 247 |
| 248 options: | |
| 249 -u, --update update the working directory to tip after pull | |
| 250 | |
| 251 push <destination>:: | |
| 497 | 252 Push changes from the local repository to the given destination. |
| 253 | |
| 498 | 254 This is the symmetrical operation for pull. It helps to move |
| 255 changes from the current repository to a different one. If the | |
| 256 destination is local this is identical to a pull in that directory | |
| 257 from the current one. | |
| 438 | 258 |
| 259 The other currently available push method is SSH. This requires an | |
| 260 accessible shell account on the destination machine and a copy of | |
| 261 hg in the remote path. Destinations are specified in the following | |
| 262 form: | |
| 263 | |
| 264 ssh://[user@]host[:port]/path | |
| 265 | |
| 266 rawcommit [-p -d -u -F -t -l]:: | |
| 497 | 267 Lowlevel commit, for use in helper scripts. |
| 268 | |
| 269 This command is not intended to be used by normal users, as it is | |
| 270 primarily useful for importing from other SCMs. | |
| 177 | 271 |
|
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
272 recover:: |
| 497 | 273 Recover from an interrupted commit or pull. |
| 274 | |
| 275 This command tries to fix the repository status after an interrupted | |
| 276 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
|
277 |
| 177 | 278 remove [files ...]:: |
| 497 | 279 Schedule the indicated files for removal from the repository. |
| 280 | |
| 498 | 281 This command shedules the files to be removed at the next commit. |
| 282 This only removes files from the current branch, not from the | |
| 283 entire project history. | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
284 |
| 438 | 285 aliases: rm |
| 177 | 286 |
| 588 | 287 revert [names ...]:: |
| 288 Revert any uncommitted modifications made to the named files or | |
| 289 directories. This restores the contents of the affected files to | |
| 290 an unmodified state. | |
| 291 | |
| 292 If a file has been deleted, it is recreated. If the executable | |
| 293 mode of a file was changed, it is reset. | |
| 294 | |
| 295 If a directory is given, all files in that directory and its | |
| 296 subdirectories are reverted. | |
| 297 | |
| 298 If no arguments are given, all files in the current directory and | |
| 299 its subdirectories are reverted. | |
| 300 | |
| 301 options: | |
| 302 -r, --rev <rev> revision to revert to | |
| 303 -n, --nonrecursive do not recurse into subdirectories | |
| 304 | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
305 root:: |
|
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
306 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
|
307 |
|
606
ea4526f9b1a5
[PATCH] Fix thinko in "serve" man page entry.
mpm@selenic.com
parents:
605
diff
changeset
|
308 serve [options]:: |
| 438 | 309 Start a local HTTP repository browser and pull server. |
| 310 | |
|
605
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
311 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
|
312 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
|
313 |
| 438 | 314 options: |
|
605
8e82fd763be2
[PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents:
595
diff
changeset
|
315 -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
|
316 -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
|
317 -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
|
318 -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
|
319 -n, --name <name> name to show in web pages (default: working dir) |
| 438 | 320 -t, --templatedir <path> web templates to use |
| 177 | 321 |
| 322 status:: | |
| 438 | 323 Show changed files in the working directory. |
| 324 | |
| 497 | 325 The codes used to show the status of files are: |
| 326 | |
| 438 | 327 C = changed |
| 328 A = added | |
| 329 R = removed | |
| 330 ? = not tracked | |
| 331 | |
| 332 tag [-t <text> -d <datecode> -u <user>] <name> [revision]:: | |
| 497 | 333 Name a particular revision using <name>. |
| 334 | |
| 335 Tags are used to name particular revisions of the repository and are | |
| 336 very useful to compare different revision, to go back to significant | |
| 498 | 337 earlier versions or to mark branch points as releases, etc. |
| 497 | 338 |
| 498 | 339 If no revision is given, the tip is used. |
| 438 | 340 |
| 498 | 341 To facilitate version control, distribution, and merging of tags, |
| 342 they are stored as a file named ".hgtags" which is managed | |
| 343 similarly to other project files and can be hand-edited if | |
| 344 necessary. | |
| 345 | |
| 438 | 346 options: |
| 347 -t, --text <text> message for tag commit log entry | |
| 348 -d, --date <datecode> datecode for commit | |
| 349 -u, --user <user> user for commit | |
| 177 | 350 |
| 498 | 351 Note: Mercurial also has support for "local tags" that are not |
| 352 version-controlled or distributed which are stored in the .hg/hgrc | |
| 353 file. | |
| 354 | |
| 177 | 355 tags:: |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
356 List the repository tags. |
| 438 | 357 |
| 498 | 358 This lists both regular and local tags. |
| 497 | 359 |
| 438 | 360 tip:: |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
361 Show the tip revision. |
| 177 | 362 |
|
196
48827121af7e
add export, recover, and undo to the man page
jake@edge2.net
parents:
182
diff
changeset
|
363 undo:: |
| 438 | 364 Undo the last commit or pull transaction. |
| 365 | |
| 595 | 366 Roll back the last pull or commit transaction on the |
| 367 repository, restoring the project to its earlier state. | |
| 368 | |
| 369 This command should be used with care. There is only one level of | |
| 370 undo and there is no redo. | |
| 371 | |
| 372 This command is not intended for use on public repositories. Once | |
| 373 a change is visible for pull by other users, undoing it locally is | |
| 374 ineffective. | |
| 375 | |
| 438 | 376 update [-m -C] [revision]:: |
| 498 | 377 Update the working directory to the specified revision. |
| 438 | 378 |
| 498 | 379 By default, update will refuse to run if doing so would require |
| 380 merging or discarding local changes. | |
| 381 | |
| 382 With the -m option, a merge will be performed. | |
| 383 | |
| 384 With the -C option, local changes will be lost. | |
| 497 | 385 |
| 438 | 386 options: |
| 387 -m, --merge allow merging of branches | |
| 388 -C, --clean overwrite locally modified files | |
| 389 | |
| 390 aliases: up checkout co | |
| 391 | |
| 392 verify:: | |
| 393 Verify the integrity of the current repository. | |
| 394 | |
| 395 This will perform an extensive check of the repository's | |
| 396 integrity, validating the hashes and checksums of each entry in | |
| 397 the changelog, manifest, and tracked files, as well as the | |
| 398 integrity of their crosslinks and indices. | |
| 399 | |
| 580 | 400 SPECIFYING SINGLE REVISIONS |
| 401 --------------------------- | |
| 402 | |
| 403 Mercurial accepts several notations for identifying individual | |
| 404 revisions. | |
| 405 | |
| 406 A plain integer is treated as a revision number. Negative | |
| 407 integers are treated as offsets from the tip, with -1 denoting the | |
| 408 tip. | |
| 409 | |
| 410 A 40-digit hexadecimal string is treated as a unique revision | |
| 411 identifier. | |
| 412 | |
| 413 A hexadecimal string less than 40 characters long is treated as a | |
| 414 unique revision identifier, and referred to as a short-form | |
| 415 identifier. A short-form identifier is only valid if it is the | |
| 416 prefix of one full-length identifier. | |
| 417 | |
| 418 Any other string is treated as a tag name, which is a symbolic | |
| 419 name associated with a revision identifier. Tag names may not | |
| 420 contain the ":" character. | |
| 421 | |
| 422 The reserved name "tip" is a special tag that always identifies | |
| 423 the most recent revision. | |
| 424 | |
| 425 SPECIFYING MULTIPLE REVISIONS | |
| 426 ----------------------------- | |
| 427 | |
| 428 When Mercurial accepts more than one revision, they may be | |
| 429 specified individually, or provided as a continuous range, | |
| 430 separated by the ":" character. | |
| 431 | |
| 432 The syntax of range notation is [BEGIN]:[END], where BEGIN and END | |
| 433 are revision identifiers. Both BEGIN and END are optional. If | |
| 434 BEGIN is not specified, it defaults to revision number 0. If END | |
| 435 is not specified, it defaults to the tip. The range ":" thus | |
| 436 means "all revisions". | |
| 437 | |
| 438 If BEGIN is greater than END, revisions are treated in reverse | |
| 439 order. | |
| 440 | |
| 441 A range acts as an open interval. This means that a range of 3:5 | |
| 442 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
|
443 |
| 177 | 444 ENVIRONMENT VARIABLES |
| 445 --------------------- | |
| 438 | 446 |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
447 HGEDITOR:: |
|
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
448 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
|
449 value of EDITOR. |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
450 |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
451 (deprecated, use .hgrc) |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
452 |
| 177 | 453 HGMERGE:: |
| 498 | 454 An executable to use for resolving merge conflicts. The program |
| 438 | 455 will be executed with three arguments: local file, remote file, |
| 456 ancestor file. | |
| 457 | |
| 458 The default program is "hgmerge", which is a shell script provided | |
| 459 by Mercurial with some sensible defaults. | |
| 177 | 460 |
|
608
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
461 (deprecated, use .hgrc) |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
462 |
| 177 | 463 HGUSER:: |
| 438 | 464 This is the string used for the author of a commit. |
| 177 | 465 |
|
608
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
466 (deprecated, use .hgrc) |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
467 |
| 177 | 468 EMAIL:: |
| 438 | 469 If HGUSER is not set, this will be used as the author for a commit. |
| 177 | 470 |
| 471 LOGNAME:: | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
472 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with |
| 438 | 473 '@hostname' appended) as the author value for a commit. |
| 177 | 474 |
| 475 EDITOR:: | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
476 This is the name of the editor used in the hgmerge script. It will be |
| 498 | 477 used for commit messages if HGEDITOR isn't set. Defaults to 'vi'. |
| 438 | 478 |
| 479 PYTHONPATH:: | |
| 480 This is used by Python to find imported modules and may need to be set | |
| 481 appropriately if Mercurial is not installed system-wide. | |
| 177 | 482 |
| 483 FILES | |
| 484 ----- | |
| 485 .hgignore:: | |
| 438 | 486 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
|
487 names that should be ignored by hg. |
| 177 | 488 |
| 489 .hgtags:: | |
| 438 | 490 This file contains changeset hash values and text tag names (one of each |
| 177 | 491 seperated by spaces) that correspond to tagged versions of the repository |
| 492 contents. | |
| 493 | |
| 438 | 494 $HOME/.hgrc, .hg/hgrc:: |
| 495 This file contains defaults and configuration. Values in .hg/hgrc | |
| 496 override those in .hgrc. | |
| 497 | |
|
608
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
498 |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
499 UI OPTIONS |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
500 ---------- |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
501 |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
502 Various configuration options can be set in .hgrc: |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
503 |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
504 ------------- |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
505 [ui] |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
506 verbose = 0 |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
507 username = Matt Mackall <mpm@selenic.com> |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
508 editor = hgeditor |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
509 merge = hgmerge |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
510 ------------- |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
511 |
|
d2994b5298fb
Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents:
606
diff
changeset
|
512 |
| 438 | 513 NAMED REPOSITORIES |
| 514 ------------------ | |
| 515 | |
| 487 | 516 To give symbolic names to a repository, create a section in .hgrc |
| 517 or .hg/hgrc containing assignments of names to paths. Example: | |
| 438 | 518 |
| 487 | 519 ----------------- |
| 438 | 520 [paths] |
| 521 hg = http://selenic.com/hg | |
|
478
f1804f2e7f35
Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents:
438
diff
changeset
|
522 tah = http://hg.intevation.org/mercurial-tah/ |
| 487 | 523 ----------------- |
| 524 | |
| 525 | |
| 498 | 526 LOCAL TAGS |
| 527 ---------- | |
| 528 | |
| 529 To create tags that are local to the repository and not distributed or | |
| 530 version-controlled, create an hgrc section like the following: | |
| 531 | |
| 532 ---------------- | |
| 533 [tags] | |
| 534 working = 2dcced388cab3677a8f543c3c47a0ad34ac9d435 | |
| 535 tested = 12e0fdbc57a0be78f0e817fd1d170a3615cd35da | |
| 536 ---------------- | |
| 537 | |
| 538 | |
| 487 | 539 HOOKS |
| 540 ----- | |
| 541 | |
| 542 Mercurial supports a set of 'hook', commands that get automatically | |
| 543 executed by various actions such as starting or finishing a commit. To | |
| 544 specify a hook, simply create an hgrc section like the following: | |
| 545 | |
| 546 ----------------- | |
| 547 [hooks] | |
| 548 precommit = echo "this hook gets executed immediately before a commit" | |
| 549 commit = hg export $NODE | mail -s "new commit $NODE" commit-list | |
| 550 ----------------- | |
| 551 | |
|
181
038e4d8602bd
updated for .hgpaths and http/old-http protocol name change
jake@edge2.net
parents:
177
diff
changeset
|
552 |
| 321 | 553 NON_TRANSPARENT PROXY SUPPORT |
| 438 | 554 ----------------------------- |
| 321 | 555 |
| 487 | 556 To access a Mercurial repository through a proxy, create a file |
| 557 $HOME/.hgrc in the following format: | |
| 321 | 558 |
| 487 | 559 -------------- |
| 321 | 560 [http_proxy] |
| 561 host=myproxy:8080 | |
| 562 user=<username> | |
| 563 passwd=<password> | |
| 564 no=<localhost1>,<localhost2>,<localhost3>,... | |
| 487 | 565 -------------- |
| 321 | 566 |
| 498 | 567 "user" and "passwd" fields are used for authenticating proxies, "no" is a |
| 568 comma-separated list of local host names to not proxy. | |
| 321 | 569 |
| 177 | 570 BUGS |
| 571 ---- | |
| 572 Probably lots, please post them to the mailing list (See Resources below) | |
| 573 when you find them. | |
| 574 | |
| 575 AUTHOR | |
| 576 ------ | |
| 577 Written by Matt Mackall <mpm@selenic.com> | |
| 578 | |
| 579 RESOURCES | |
| 580 --------- | |
| 581 http://selenic.com/mercurial[Main Web Site] | |
| 582 | |
| 583 http://selenic.com/hg[Source code repository] | |
| 584 | |
| 585 http://selenic.com/mailman/listinfo/mercurial[Mailing list] | |
| 586 | |
| 587 COPYING | |
| 588 ------- | |
| 589 Copyright (C) 2005 Matt Mackall. | |
| 590 Free use of this software is granted under the terms of the GNU General | |
| 591 Public License (GPL). |