doc/hg.1.txt
author mpm@selenic.com
Wed, 24 Aug 2005 14:24:20 -0700
changeset 1036 7c00f5f2c967
parent 1016 836667830fee
child 1045 b35d5b86e240
permissions -rw-r--r--
Update hg log docs
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 ...::
724
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
    36
    indicates one or more filename or relative path filenames; see
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
    37
    "FILE NAME PATTERNS" for information on pattern matching
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    38
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    39
path::
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    40
    indicates a path on the local machine
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    41
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
    42
revision::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    43
    indicates a changeset which can be specified as a changeset revision
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    44
    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
    45
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    46
repository path::
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
    47
    either the pathname of a local repository or the URI of a remote
181
038e4d8602bd updated for .hgpaths and http/old-http protocol name change
jake@edge2.net
parents: 177
diff changeset
    48
    repository.  There are two available URI protocols, http:// which is
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
    49
    fast and the old-http:// protocol which is much slower but does not
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    50
    require a special server on the web host.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    51
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    52
COMMANDS
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    53
--------
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    54
724
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
    55
add [options] [files ...]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    56
    Schedule files to be version controlled and added to the repository.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    57
    
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
    58
    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
    59
724
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
    60
    If no names are given, add all files in the current directory and
728
f6588fd14272 Fix typo.
Bryan O'Sullivan <bos@serpentine.com>
parents: 725
diff changeset
    61
    its subdirectories.
724
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
    62
766
b444a7e053f1 Get addremove to use new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 761
diff changeset
    63
addremove [options] [files ...]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    64
    Add all new files and remove all missing files from the repository.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    65
    
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    66
    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
    67
    with add, these changes take effect at the next commit.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    68
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    69
annotate [-r <rev> -u -n -c] [files ...]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    70
    List changes in files, showing the revision id responsible for each line
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    71
    
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    72
    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
    73
    place.
1016
836667830fee Teach annotate about binary files
mpm@selenic.com
parents: 1015
diff changeset
    74
836667830fee Teach annotate about binary files
mpm@selenic.com
parents: 1015
diff changeset
    75
    Without the -a option, annotate will avoid processing files it
836667830fee Teach annotate about binary files
mpm@selenic.com
parents: 1015
diff changeset
    76
    detects as binary. With -a, annotate will generate an annotation
836667830fee Teach annotate about binary files
mpm@selenic.com
parents: 1015
diff changeset
    77
    anyway, probably with undesirable results.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    78
    
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    79
    options:
1016
836667830fee Teach annotate about binary files
mpm@selenic.com
parents: 1015
diff changeset
    80
    -a, --text            treat all files as text
811
fa9aaf3bbdd7 Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents: 810
diff changeset
    81
    -I, --include <pat>   include names matching the given patterns
fa9aaf3bbdd7 Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents: 810
diff changeset
    82
    -X, --exclude <pat>   exclude names matching the given patterns
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    83
    -r, --revision <rev>  annotate the specified revision
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    84
    -u, --user            list the author
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    85
    -c, --changeset       list the changeset
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    86
    -n, --number          list the revision number (default)
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    87
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
    88
cat <file> [revision]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    89
    Output to stdout the given revision for the specified file.
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
    If no revision is given then the tip is used.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    92
485
c5705ab9cebd [PATCH] add clone command
mpm@selenic.com
parents: 484
diff changeset
    93
clone [-U] <source> [dest]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    94
    Create a copy of an existing repository in a new directory.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    95
523
003df62ae39f [PATCH] Force "hg clone" to always create a new directory
mpm@selenic.com
parents: 509
diff changeset
    96
    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
    97
    basename of the source.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
    98
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
    99
    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
   100
    future pulls.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   101
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   102
    For efficiency, hardlinks are used for cloning whenever the
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   103
    source and destination are on the same filesystem.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   104
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   105
    options:
505
dc1f735dfaac [PATCH] Fix "no-update" option to clone
mpm@selenic.com
parents: 498
diff changeset
   106
    -U, --noupdate   do not update the new working directory
963
84355e3e4493 Add -e and --remotecmd for clone and pull too
mpm@selenic.com
parents: 962
diff changeset
   107
    -e, --ssh        specify ssh command to use
84355e3e4493 Add -e and --remotecmd for clone and pull too
mpm@selenic.com
parents: 962
diff changeset
   108
    --remotecmd      specify hg command to run on the remote side
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   109
813
80fd2958235a Adapt commit to use file matching code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 811
diff changeset
   110
commit [options] [files...]::
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   111
    Commit changes to the given files into the repository.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   112
    
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   113
    If a list of files is omitted, all changes reported by "hg status"
813
80fd2958235a Adapt commit to use file matching code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 811
diff changeset
   114
    from the root of the repository will be commited.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   115
    
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   116
    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
   117
    editor to add a commit comment.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   118
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   119
    Options:
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   120
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   121
    -A, --addremove       run addremove during commit
813
80fd2958235a Adapt commit to use file matching code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 811
diff changeset
   122
    -I, --include <pat>   include names matching the given patterns
80fd2958235a Adapt commit to use file matching code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 811
diff changeset
   123
    -X, --exclude <pat>   exclude names matching the given patterns
761
0fb498458905 Change all references to -t --text commit message to -m and --message.
Andrew Thompson <andrewkt@aktzero.com>
parents: 750
diff changeset
   124
    -m, --message <text>  use <text> as commit message
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   125
    -l, --logfile <file>  show the commit message for the given file
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   126
    -d, --date <datecode> record datecode as commit date
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   127
    -u, --user <user>     record user as commiter
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   128
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   129
    aliases: ci
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   130
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   131
copy <source> <dest>::
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   132
    Mark <dest> file as a copy or rename of a <source> one
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   133
    
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   134
    This command takes effect for the next commit.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   135
1015
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   136
diff [-a] [-r revision] [-r revision] [files ...]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   137
    Show differences between revisions for the specified files.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   138
    
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   139
    Differences between files are shown using the unified diff format.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   140
    
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   141
    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
   142
    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
   143
    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
   144
    revisions are specified, the working directory files are compared
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   145
    to its parent.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   146
1015
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   147
    Without the -a option, diff will avoid generating diffs of files
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   148
    it detects as binary. With -a, diff will generate a diff anyway,
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   149
    probably with undesirable results.
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   150
734
d4e161d60f61 Update docs for annotate and diff.
Bryan O'Sullivan <bos@serpentine.com>
parents: 731
diff changeset
   151
    options:
1015
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   152
    -a, --text           treat all files as text
811
fa9aaf3bbdd7 Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents: 810
diff changeset
   153
    -I, --include <pat>  include names matching the given patterns
fa9aaf3bbdd7 Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents: 810
diff changeset
   154
    -X, --exclude <pat>  exclude names matching the given patterns
734
d4e161d60f61 Update docs for annotate and diff.
Bryan O'Sullivan <bos@serpentine.com>
parents: 731
diff changeset
   155
580
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   156
export [-o filespec] [revision] ...::
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   157
    Print the changeset header and diffs for one or more revisions.
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   158
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   159
    The information shown in the changeset header is: author,
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   160
    changeset hash, parent and commit comment.
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   161
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   162
    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
   163
    given using a format string.  The formatting rules are as follows:
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   164
580
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   165
    %%   literal "%" character
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   166
    %H   changeset hash (40 bytes of hexadecimal)
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   167
    %N   number of patches being generated
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   168
    %R   changeset revision number
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   169
    %b   basename of the exporting repository
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   170
    %h   short-form changeset hash (12 bytes of hexadecimal)
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   171
    %n   zero-padded sequence number, starting at 1
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   172
    %r   zero-padded changeset revision number
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   173
1015
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   174
    Without the -a option, export will avoid generating diffs of files
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   175
    it detects as binary. With -a, export will generate a diff anyway,
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   176
    probably with undesirable results.
580
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   177
1015
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   178
    options:
22571b8d35d3 Add automatic binary file detection to diff and export
mpm@selenic.com
parents: 981
diff changeset
   179
    -a, --text                treat all files as text
580
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   180
    -o, --output <filespec>   print output to file with formatted named
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   181
810
790a0ff306f2 Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 766
diff changeset
   182
forget [options] [files]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   183
    Undo an 'hg add' scheduled for the next commit.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   184
810
790a0ff306f2 Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 766
diff changeset
   185
    options:
811
fa9aaf3bbdd7 Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents: 810
diff changeset
   186
    -I, --include <pat>  include names matching the given patterns
fa9aaf3bbdd7 Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents: 810
diff changeset
   187
    -X, --exclude <pat>  exclude names matching the given patterns
810
790a0ff306f2 Move commands.forget over to using new walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 766
diff changeset
   188
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   189
heads::
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   190
    Show all repository head changesets.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   191
    
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   192
    Repository "heads" are changesets that don't have children
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   193
    changesets. They are where development generally takes place and
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   194
    are the usual targets for update and merge operations.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   195
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   196
identify::
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   197
    Print a short summary of the current state of the repo.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   198
    
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   199
    This summary identifies the repository state using one or two parent
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   200
    hash identifiers, followed by a "+" if there are uncommitted changes
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   201
    in the working directory, followed by a list of tags for this revision.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   202
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   203
    aliases: id
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   204
966
022bcc738389 hg import: abort with uncommitted changes, override with --force
mpm@selenic.com
parents: 963
diff changeset
   205
import [-p <n> -b <base> -f] <patches>::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   206
    Import a list of patches and commit them individually.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   207
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   208
    options:
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   209
    -p, --strip <n>   directory strip option for patch. This has the same
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   210
                      meaning as the correnponding patch option
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   211
    -b <path>         base directory to read patches from
966
022bcc738389 hg import: abort with uncommitted changes, override with --force
mpm@selenic.com
parents: 963
diff changeset
   212
    -f, --force	      skip check for outstanding uncommitted changes
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   213
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   214
    aliases: patch
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   215
928
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   216
incoming [source]::
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   217
    Show new changesets found in the specified repo or the default
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   218
    pull repo. These are the changesets that would be pulled if a pull
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   219
    was requested.
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   220
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   221
    Currently only local repositories are supported.
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   222
940
1300271ba8de Add in and out aliases
mpm@selenic.com
parents: 928
diff changeset
   223
    aliases: in
1300271ba8de Add in and out aliases
mpm@selenic.com
parents: 928
diff changeset
   224
907
652507dc9fce Modify init command to take an optional directory to set up.
Bryan O'Sullivan <bos@serpentine.com>
parents: 896
diff changeset
   225
init [dest]::
652507dc9fce Modify init command to take an optional directory to set up.
Bryan O'Sullivan <bos@serpentine.com>
parents: 896
diff changeset
   226
    Initialize a new repository in the given directory.  If the given
652507dc9fce Modify init command to take an optional directory to set up.
Bryan O'Sullivan <bos@serpentine.com>
parents: 896
diff changeset
   227
    directory does not exist, it is created.
652507dc9fce Modify init command to take an optional directory to set up.
Bryan O'Sullivan <bos@serpentine.com>
parents: 896
diff changeset
   228
652507dc9fce Modify init command to take an optional directory to set up.
Bryan O'Sullivan <bos@serpentine.com>
parents: 896
diff changeset
   229
    If no directory is given, the current directory is used.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   230
724
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   231
locate [options] [files]::
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   232
    Print all files under Mercurial control whose names match the
629
2fdf3b1659b9 Clarify man page entry for locate a little.
Bryan O'Sullivan <bos@serpentine.com>
parents: 627
diff changeset
   233
    given patterns.
627
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   234
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   235
    This command searches the current directory and its
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   236
    subdirectories.  To search an entire repository, move to the root
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   237
    of the repository.
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   238
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   239
    If no patterns are given to match, this command prints all file
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   240
    names.
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   241
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   242
    If you want to feed the output of this command into the "xargs"
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   243
    command, use the "-0" option to both this command and "xargs".
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   244
    This will avoid the problem of "xargs" treating single filenames
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   245
    that contain white space as multiple file names.
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   246
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   247
    options:
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   248
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   249
    -0, --print0         end filenames with NUL, for use with xargs
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   250
    -f, --fullpath       print complete paths from the filesystem root
811
fa9aaf3bbdd7 Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents: 810
diff changeset
   251
    -I, --include <pat>  include names matching the given patterns
627
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   252
    -r, --rev <rev>      search the repository as it stood at rev
811
fa9aaf3bbdd7 Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents: 810
diff changeset
   253
    -X, --exclude <pat>  exclude names matching the given patterns
627
b6c42714d900 Add locate command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 612
diff changeset
   254
1036
7c00f5f2c967 Update hg log docs
mpm@selenic.com
parents: 1016
diff changeset
   255
log [-r revision ...] [-p] [files]::
7c00f5f2c967 Update hg log docs
mpm@selenic.com
parents: 1016
diff changeset
   256
    Print the revision history of the specified files or the entire project.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   257
509
98a2935c3d6c [PATCH] replace history with log
mpm@selenic.com
parents: 505
diff changeset
   258
    By default this command outputs: changeset id and hash, tags,
98a2935c3d6c [PATCH] replace history with log
mpm@selenic.com
parents: 505
diff changeset
   259
    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
   260
    -v switch adds some more detail, such as changed files, manifest
98a2935c3d6c [PATCH] replace history with log
mpm@selenic.com
parents: 505
diff changeset
   261
    hashes or message signatures.
98a2935c3d6c [PATCH] replace history with log
mpm@selenic.com
parents: 505
diff changeset
   262
612
9cd745437269 On Sat, Jul 02, 2005 at 02:11:34PM -0700, Matt Mackall wrote:
Alecs King <alecsk@gmail.com>
parents: 608
diff changeset
   263
    options:
1036
7c00f5f2c967 Update hg log docs
mpm@selenic.com
parents: 1016
diff changeset
   264
    -I, --include <pat>   include names matching the given patterns
7c00f5f2c967 Update hg log docs
mpm@selenic.com
parents: 1016
diff changeset
   265
    -X, --exclude <pat>   exclude names matching the given patterns
7c00f5f2c967 Update hg log docs
mpm@selenic.com
parents: 1016
diff changeset
   266
    -r, --rev <A>         show the specified revision or range
7c00f5f2c967 Update hg log docs
mpm@selenic.com
parents: 1016
diff changeset
   267
    -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
   268
509
98a2935c3d6c [PATCH] replace history with log
mpm@selenic.com
parents: 505
diff changeset
   269
    aliases: history
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   270
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   271
manifest [revision]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   272
    Print a list of version controlled files for the given revision.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   273
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   274
    The manifest is the list of files being version controlled. If no revision
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   275
    is given then the tip is used.
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   276
928
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   277
outgoing [dest]:: 
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   278
    Show changesets not found in the specified destination repo or the
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   279
    default push repo. These are the changesets that would be pushed
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   280
    if a push was requested.
6f2c3bcbfaaf hg incoming/outgoing: fix tests and update man page
mpm@selenic.com
parents: 924
diff changeset
   281
940
1300271ba8de Add in and out aliases
mpm@selenic.com
parents: 928
diff changeset
   282
    aliases: out
1300271ba8de Add in and out aliases
mpm@selenic.com
parents: 928
diff changeset
   283
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   284
parents::
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   285
    Print the working directory's parent revisions.
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   286
924
ab681ea2857e updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents: 910
diff changeset
   287
paths [NAME]::
ab681ea2857e updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents: 910
diff changeset
   288
    Show definition of symbolic path name NAME. If no name is given, show
ab681ea2857e updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents: 910
diff changeset
   289
    definition of available names.
ab681ea2857e updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents: 910
diff changeset
   290
951
859de3ebc041 Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 940
diff changeset
   291
    Path names are defined in the [paths] section of /etc/mercurial/hgrc
859de3ebc041 Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 940
diff changeset
   292
    and $HOME/.hgrc.  If run inside a repository, .hg/hgrc is used, too.
924
ab681ea2857e updated help text and added manpage section for hg paths
TK Soh <teekaysoh@yahoo.com>
parents: 910
diff changeset
   293
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   294
pull <repository path>::
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   295
    Pull changes from a remote repository to a local one.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   296
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   297
    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
   298
    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
   299
    does not update the copy of the project in the working directory.
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   300
962
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   301
    Valid URLs are of the form:
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   302
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   303
      local/filesystem/path
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   304
      http://[user@]host[:port][/path]
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   305
      https://[user@]host[:port][/path]
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   306
      ssh://[user@]host[:port][/path]
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   307
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   308
    SSH requires an accessible shell account on the destination
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   309
    machine and a copy of hg in the remote path.
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   310
      
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   311
    options:
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   312
    -u, --update   update the working directory to tip after pull
963
84355e3e4493 Add -e and --remotecmd for clone and pull too
mpm@selenic.com
parents: 962
diff changeset
   313
    -e, --ssh    specify ssh command to use
84355e3e4493 Add -e and --remotecmd for clone and pull too
mpm@selenic.com
parents: 962
diff changeset
   314
    --remotecmd  specify hg command to run on the remote side
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   315
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   316
push <destination>::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   317
    Push changes from the local repository to the given destination.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   318
    
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   319
    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
   320
    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
   321
    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
   322
    from the current one.
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   323
962
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   324
    By default, push will refuse to run if it detects the result would
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   325
    increase the number of remote heads. This generally indicates the
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   326
    the client has forgotten to sync and merge before pushing.
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   327
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   328
    Valid URLs are of the form:
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   329
962
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   330
      local/filesystem/path
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   331
      ssh://[user@]host[:port][/path]
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   332
      
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   333
    SSH requires an accessible shell account on the destination
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   334
    machine and a copy of hg in the remote path.
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   335
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   336
    options:
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   337
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   338
    -f, --force  force update
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   339
    -e, --ssh    specify ssh command to use
5730e90c025b Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents: 953
diff changeset
   340
    --remotecmd  specify hg command to run on the remote side
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   341
747
c3ce3976ae75 Add -m for rawcommit
mpm@selenic.com
parents: 746
diff changeset
   342
rawcommit [-p -d -u -F -m -l]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   343
    Lowlevel commit, for use in helper scripts.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   344
    
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   345
    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
   346
    primarily useful for importing from other SCMs.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   347
196
48827121af7e add export, recover, and undo to the man page
jake@edge2.net
parents: 182
diff changeset
   348
recover::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   349
    Recover from an interrupted commit or pull.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   350
    
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   351
    This command tries to fix the repository status after an interrupted
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   352
    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
   353
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   354
remove [files ...]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   355
    Schedule the indicated files for removal from the repository.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   356
    
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   357
    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
   358
    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
   359
    entire project history.
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
   360
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   361
    aliases: rm
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   362
588
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   363
revert [names ...]::
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   364
    Revert any uncommitted modifications made to the named files or
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   365
    directories.  This restores the contents of the affected files to
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   366
    an unmodified state.
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   367
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   368
    If a file has been deleted, it is recreated.  If the executable
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   369
    mode of a file was changed, it is reset.
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   370
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   371
    If a directory is given, all files in that directory and its
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   372
    subdirectories are reverted.
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   373
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   374
    If no arguments are given, all files in the current directory and
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   375
    its subdirectories are reverted.
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   376
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   377
    options:
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   378
    -r, --rev <rev>       revision to revert to
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   379
    -n, --nonrecursive    do not recurse into subdirectories
0c3bae18403b [PATCH] hg revert
mpm@selenic.com
parents: 580
diff changeset
   380
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
   381
root::
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
   382
    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
   383
606
ea4526f9b1a5 [PATCH] Fix thinko in "serve" man page entry.
mpm@selenic.com
parents: 605
diff changeset
   384
serve [options]::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   385
    Start a local HTTP repository browser and pull server.
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   386
605
8e82fd763be2 [PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents: 595
diff changeset
   387
    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
   388
    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
   389
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   390
    options:
605
8e82fd763be2 [PATCH] Get "hg serve" to optionally log accesses and errors to files
mpm@selenic.com
parents: 595
diff changeset
   391
    -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
   392
    -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
   393
    -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
   394
    -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
   395
    -n, --name <name>        name to show in web pages (default: working dir)
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   396
    -t, --templatedir <path> web templates to use
825
0108c602feb9 Add an option to hg serve to serve file using IPv6
Samuel Tardieu <sam@rfc1149.net>
parents: 814
diff changeset
   397
    -6, --ipv6               use IPv6 in addition to IPv4
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   398
731
91ca3afab8e8 Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 728
diff changeset
   399
status [options] [files]::
91ca3afab8e8 Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 728
diff changeset
   400
    Show changed files in the working directory.  If no names are
91ca3afab8e8 Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 728
diff changeset
   401
    given, all files are shown.  Otherwise, only files matching the
91ca3afab8e8 Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 728
diff changeset
   402
    given names are shown.
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   403
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   404
    The codes used to show the status of files are:
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   405
    
746
9095e3456ea7 Change C to M in status
mpm@selenic.com
parents: 745
diff changeset
   406
    M = changed
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   407
    A = added
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   408
    R = removed
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   409
    ? = not tracked
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   410
731
91ca3afab8e8 Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 728
diff changeset
   411
    options:
91ca3afab8e8 Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 728
diff changeset
   412
840
141744605b51 hg status: added options to select files by status.
tksoh@users.sourceforge.net
parents: 839
diff changeset
   413
    -m, --modified       show only modified files
141744605b51 hg status: added options to select files by status.
tksoh@users.sourceforge.net
parents: 839
diff changeset
   414
    -a, --added          show only added files
141744605b51 hg status: added options to select files by status.
tksoh@users.sourceforge.net
parents: 839
diff changeset
   415
    -r, --removed        show only removed files
141744605b51 hg status: added options to select files by status.
tksoh@users.sourceforge.net
parents: 839
diff changeset
   416
    -u, --unknown        show only unknown (not tracked) files
811
fa9aaf3bbdd7 Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents: 810
diff changeset
   417
    -I, --include <pat>  include names matching the given patterns
fa9aaf3bbdd7 Fix documentation of -I and -X options.
Bryan O'Sullivan <bos@serpentine.com>
parents: 810
diff changeset
   418
    -X, --exclude <pat>  exclude names matching the given patterns
731
91ca3afab8e8 Add name matching to status command.
Bryan O'Sullivan <bos@serpentine.com>
parents: 728
diff changeset
   419
750
25986be9a1aa Add tag -t, deprecate tag -m
mpm@selenic.com
parents: 747
diff changeset
   420
tag [-l -m <text> -d <datecode> -u <user>] <name> [revision]::
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   421
    Name a particular revision using <name>.
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   422
    
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   423
    Tags are used to name particular revisions of the repository and are
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   424
    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
   425
    earlier versions or to mark branch points as releases, etc.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   426
    
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   427
    If no revision is given, the tip is used.
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   428
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   429
    To facilitate version control, distribution, and merging of tags,
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   430
    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
   431
    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
   432
    necessary.
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   433
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   434
    options:
631
a287f6cd9c6b Update documentation of hg tag
Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
parents: 629
diff changeset
   435
    -l, --local           make the tag local
761
0fb498458905 Change all references to -t --text commit message to -m and --message.
Andrew Thompson <andrewkt@aktzero.com>
parents: 750
diff changeset
   436
    -m, --message <text>  message for tag commit log entry
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   437
    -d, --date <datecode> datecode for commit
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   438
    -u, --user <user>     user for commit
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   439
631
a287f6cd9c6b Update documentation of hg tag
Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
parents: 629
diff changeset
   440
    Note: Local tags are not version-controlled or distributed and are
a287f6cd9c6b Update documentation of hg tag
Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
parents: 629
diff changeset
   441
    stored in the .hg/localtags file. If there exists a local tag and
a287f6cd9c6b Update documentation of hg tag
Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
parents: 629
diff changeset
   442
    a public tag with the same name, local tag is used.
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   443
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   444
tags::
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
   445
    List the repository tags.
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   446
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   447
    This lists both regular and local tags.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   448
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   449
tip::
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
   450
    Show the tip revision.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   451
196
48827121af7e add export, recover, and undo to the man page
jake@edge2.net
parents: 182
diff changeset
   452
undo::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   453
    Undo the last commit or pull transaction.
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   454
595
c2c2c6d617bd Expand undo docs
mpm@selenic.com
parents: 588
diff changeset
   455
    Roll back the last pull or commit transaction on the
c2c2c6d617bd Expand undo docs
mpm@selenic.com
parents: 588
diff changeset
   456
    repository, restoring the project to its earlier state.
c2c2c6d617bd Expand undo docs
mpm@selenic.com
parents: 588
diff changeset
   457
c2c2c6d617bd Expand undo docs
mpm@selenic.com
parents: 588
diff changeset
   458
    This command should be used with care. There is only one level of
c2c2c6d617bd Expand undo docs
mpm@selenic.com
parents: 588
diff changeset
   459
    undo and there is no redo.
c2c2c6d617bd Expand undo docs
mpm@selenic.com
parents: 588
diff changeset
   460
c2c2c6d617bd Expand undo docs
mpm@selenic.com
parents: 588
diff changeset
   461
    This command is not intended for use on public repositories. Once
c2c2c6d617bd Expand undo docs
mpm@selenic.com
parents: 588
diff changeset
   462
    a change is visible for pull by other users, undoing it locally is
c2c2c6d617bd Expand undo docs
mpm@selenic.com
parents: 588
diff changeset
   463
    ineffective.
c2c2c6d617bd Expand undo docs
mpm@selenic.com
parents: 588
diff changeset
   464
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   465
update [-m -C] [revision]::
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   466
    Update the working directory to the specified revision.
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   467
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   468
    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
   469
    merging or discarding local changes.
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
    With the -m option, a merge will be performed.
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   472
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   473
    With the -C option, local changes will be lost.
497
2dcced388cab [PATCH] doc cleanups
mpm@selenic.com
parents: 496
diff changeset
   474
    
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   475
    options:
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   476
    -m, --merge       allow merging of branches
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   477
    -C, --clean       overwrite locally modified files
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   478
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   479
    aliases: up checkout co
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   480
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   481
verify::
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   482
    Verify the integrity of the current repository.
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   483
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   484
    This will perform an extensive check of the repository's
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   485
    integrity, validating the hashes and checksums of each entry in
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   486
    the changelog, manifest, and tracked files, as well as the
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   487
    integrity of their crosslinks and indices.
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   488
724
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   489
FILE NAME PATTERNS
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   490
------------------
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   491
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   492
    Mercurial accepts several notations for identifying one or more
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   493
    file at a time.
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   494
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   495
    By default, Mercurial treats file names as shell-style extended
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   496
    glob patterns.
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   497
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   498
    Alternate pattern notations must be specified explicitly.
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   499
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   500
    To use a plain path name without any pattern matching, start a
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   501
    name with "path:".  These path names must match completely, from
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   502
    the root of the current repository.
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   503
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   504
    To use an extended glob, start a name with "glob:".  Globs are
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   505
    rooted at the current directory; a glob such as "*.c" will match
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   506
    files ending in ".c" in the current directory only.
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   507
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   508
    The supported glob syntax extensions are "**" to match any string
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   509
    across path separators, and "{a,b}" to mean "a or b".
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   510
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   511
    To use a Perl/Python regular expression, start a name with "re:".
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   512
    Regexp pattern matching is anchored at the root of the repository.
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   513
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   514
    Plain examples:
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   515
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   516
    path:foo/bar   a name bar in a directory named foo in the root of
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   517
                   the repository
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   518
    path:path:name a file or directory named "path:name"
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   519
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   520
    Glob examples:
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   521
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   522
    glob:*.c       any name ending in ".c" in the current directory
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   523
    *.c            any name ending in ".c" in the current directory
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   524
    **.c           any name ending in ".c" in the current directory, or
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   525
                   any subdirectory
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   526
    foo/*.c        any name ending in ".c" in the directory foo
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   527
    foo/**.c       any name ending in ".c" in the directory foo, or any
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   528
                   subdirectory
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   529
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   530
    Regexp examples:
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   531
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   532
    re:.*\.c$      any name ending in ".c", anywhere in the repsitory
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   533
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
   534
580
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   535
SPECIFYING SINGLE REVISIONS
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   536
---------------------------
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   537
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   538
    Mercurial accepts several notations for identifying individual
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   539
    revisions.
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   540
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   541
    A plain integer is treated as a revision number.  Negative
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   542
    integers are treated as offsets from the tip, with -1 denoting the
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   543
    tip.
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   544
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   545
    A 40-digit hexadecimal string is treated as a unique revision
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   546
    identifier.
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   547
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   548
    A hexadecimal string less than 40 characters long is treated as a
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   549
    unique revision identifier, and referred to as a short-form
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   550
    identifier.  A short-form identifier is only valid if it is the
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   551
    prefix of one full-length identifier.
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   552
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   553
    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
   554
    name associated with a revision identifier.  Tag names may not
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   555
    contain the ":" character.
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   556
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   557
    The reserved name "tip" is a special tag that always identifies
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   558
    the most recent revision.
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   559
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   560
SPECIFYING MULTIPLE REVISIONS
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   561
-----------------------------
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   562
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   563
    When Mercurial accepts more than one revision, they may be
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   564
    specified individually, or provided as a continuous range,
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   565
    separated by the ":" character.
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   566
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   567
    The syntax of range notation is [BEGIN]:[END], where BEGIN and END
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   568
    are revision identifiers.  Both BEGIN and END are optional.  If
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   569
    BEGIN is not specified, it defaults to revision number 0.  If END
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   570
    is not specified, it defaults to the tip.  The range ":" thus
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   571
    means "all revisions".
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   572
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   573
    If BEGIN is greater than END, revisions are treated in reverse
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   574
    order.
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   575
860
8ccbac05cf59 Use correct term "closed interval" for ranges.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 840
diff changeset
   576
    A range acts as a closed interval.  This means that a range of 3:5
580
353a2ce50423 [PATCH] New export patch
mpm@selenic.com
parents: 553
diff changeset
   577
    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
   578
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   579
ENVIRONMENT VARIABLES
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   580
---------------------
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   581
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
   582
HGEDITOR::
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
   583
    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
   584
    value of EDITOR. 
d2994b5298fb Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents: 606
diff changeset
   585
d2994b5298fb Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents: 606
diff changeset
   586
    (deprecated, use .hgrc)
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
   587
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   588
HGMERGE::
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
   589
    An executable to use for resolving merge conflicts. The program
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   590
    will be executed with three arguments: local file, remote file,
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   591
    ancestor file.
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   592
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   593
    The default program is "hgmerge", which is a shell script provided
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   594
    by Mercurial with some sensible defaults.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   595
608
d2994b5298fb Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents: 606
diff changeset
   596
    (deprecated, use .hgrc)
d2994b5298fb Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents: 606
diff changeset
   597
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   598
HGUSER::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   599
    This is the string used for the author of a commit.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   600
608
d2994b5298fb Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents: 606
diff changeset
   601
    (deprecated, use .hgrc)
d2994b5298fb Add username/merge/editor to .hgrc
Matt Mackall <mpm@selenic.com>
parents: 606
diff changeset
   602
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   603
EMAIL::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   604
    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
   605
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   606
LOGNAME::
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
   607
    If neither HGUSER nor EMAIL is set, LOGNAME will be used (with
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   608
    '@hostname' appended) as the author value for a commit.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   609
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   610
EDITOR::
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
   611
    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
   612
    used for commit messages if HGEDITOR isn't set. Defaults to 'vi'.
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   613
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   614
PYTHONPATH::
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   615
    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
   616
    appropriately if Mercurial is not installed system-wide.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   617
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   618
FILES
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   619
-----
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   620
 .hgignore::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   621
    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
   622
    names that should be ignored by hg.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   623
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   624
 .hgtags::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   625
    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
   626
    seperated by spaces) that correspond to tagged versions of the repository
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   627
    contents.
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   628
951
859de3ebc041 Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 940
diff changeset
   629
 /etc/mercurial/hgrc, $HOME/.hgrc, .hg/hgrc::
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
   630
    This file contains defaults and configuration. Values in .hg/hgrc
951
859de3ebc041 Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 940
diff changeset
   631
    override those in $HOME/.hgrc, and these override settings made in the
859de3ebc041 Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 940
diff changeset
   632
    global /etc/mercurial/hgrc configuration.  See hgrc(5) for details of
859de3ebc041 Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 940
diff changeset
   633
    the contents and format of these files.
321
73b8a8a059ec Transparent proxy support
mpm@selenic.com
parents: 196
diff changeset
   634
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   635
BUGS
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   636
----
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   637
Probably lots, please post them to the mailing list (See Resources below)
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   638
when you find them.
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   639
671
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
   640
SEE ALSO
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
   641
--------
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
   642
hgrc(5)
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
   643
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   644
AUTHOR
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   645
------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   646
Written by Matt Mackall <mpm@selenic.com>
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   647
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   648
RESOURCES
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   649
---------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   650
http://selenic.com/mercurial[Main Web Site]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   651
671
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
   652
http://www.serpentine.com/mercurial[Wiki site]
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
   653
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   654
http://selenic.com/hg[Source code repository]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   655
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   656
http://selenic.com/mailman/listinfo/mercurial[Mailing list]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   657
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   658
COPYING
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   659
-------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   660
Copyright (C) 2005 Matt Mackall.
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
   661
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
   662
Public License (GPL).