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