doc/hg.1.txt
changeset 484 934279f3ca53
parent 438 b38deaf7873e
parent 478 f1804f2e7f35
child 485 c5705ab9cebd
equal deleted inserted replaced
474:b2ae8283d1a6 484:934279f3ca53
     1 HG(1)
     1 HG(1)
     2 =====
     2 =====
     3 Matt Mackall <mpm@selenic.com>
     3 Matt Mackall <mpm@selenic.com>
     4 v0.6, 27 May 2005
     4 v0.6, 24 Jun 2005
     5 
     5 
     6 NAME
     6 NAME
     7 ----
     7 ----
     8 hg - Mercurial source code management system
     8 hg - Mercurial source code management system
     9 
     9 
    37     indicates one or more filename or relative path filenames
    37     indicates one or more filename or relative path filenames
    38 
    38 
    39 path::
    39 path::
    40     indicates a path on the local machine
    40     indicates a path on the local machine
    41 
    41 
    42 revision:: 
    42 revision::
    43     indicates a changeset which can be specified as a changeset revision
    43     indicates a changeset which can be specified as a changeset revision
    44     number, a tag, or a unique substring of the changeset hash value
    44     number, a tag, or a unique substring of the changeset hash value
    45 
    45 
    46 repository path::
    46 repository path::
    47     is either the pathname of a local repository of the URI of a remote
    47     is either the pathname of a local repository of the URI of a remote
    48     repository.  There are two available URI protocols, http:// which is
    48     repository.  There are two available URI protocols, http:// which is
    49     fast and the old-http:// protocol which is much slower but does not 
    49     fast and the old-http:// protocol which is much slower but does not
    50     require a special server on the web host.
    50     require a special server on the web host.
    51 
    51 
    52 COMMANDS
    52 COMMANDS
    53 --------
    53 --------
    54 
    54 
    59 addremove::
    59 addremove::
    60     Add all new files and remove all missing files from the repository.  New
    60     Add all new files and remove all missing files from the repository.  New
    61     files are ignored if they match any of the patterns in .hgignore
    61     files are ignored if they match any of the patterns in .hgignore
    62 
    62 
    63 annotate [-r <rev> -u -n -c] [files ...]::
    63 annotate [-r <rev> -u -n -c] [files ...]::
    64     List the files with each line showing the revision id responsible 
    64     List the files with each line showing the revision id responsible
    65     for that line. 
    65     for that line.
    66 
    66 
    67     options:
    67     options:
    68     -r, --revision <rev>  annotate the specified revision
    68     -r, --revision <rev>  annotate the specified revision
    69     -u, --user            list the author
    69     -u, --user            list the author
    70     -c, --changeset       list the changeset
    70     -c, --changeset       list the changeset
    72 
    72 
    73 cat <file> [revision]::
    73 cat <file> [revision]::
    74     Output the given revision or tip of the specified file to stdout.
    74     Output the given revision or tip of the specified file to stdout.
    75 
    75 
    76 commit [-A -t -l <file> -t <text> -u <user> -d <datecode>] [files...]::
    76 commit [-A -t -l <file> -t <text> -u <user> -d <datecode>] [files...]::
    77     commit all changed files in the working dir to the repository.  This uses
    77     Commit all changed files in the working dir to the repository.  This uses
    78     the EDITOR environment variable to bring up an editor to add a commit
    78     the EDITOR environment variable to bring up an editor to add a commit
    79     comment.
    79     comment.
    80 
    80 
    81     Options:
    81     Options:
    82     
    82 
    83     -A, --addremove       run addremove during commit
    83     -A, --addremove       run addremove during commit
    84     -t, --text <text>     use <text> as commit message
    84     -t, --text <text>     use <text> as commit message
    85     -l, --logfile <file>  read the commit message from the specified
    85     -l, --logfile <file>  read the commit message from the specified
    86                           file
    86                           file
    87     -d, --date <datecode> use the specified date code
    87     -d, --date <datecode> use the specified date code
    91 
    91 
    92 copy <source> <dest>::
    92 copy <source> <dest>::
    93     Mark a file as copied or renamed for the next commit.
    93     Mark a file as copied or renamed for the next commit.
    94 
    94 
    95 diff [-r revision] [-r revision] [files ...]::
    95 diff [-r revision] [-r revision] [files ...]::
    96     Generate a unified diff of the indicated files. If there are no 
    96     Generate a unified diff of the indicated files. If there are no
    97     revisions specified, the working directory file is compared to 
    97     revisions specified, the working directory file is compared to
    98     the tip, one revision specified indicates a comparison between the 
    98     the tip, one revision specified indicates a comparison between the
    99     working directory file and the specified revision, and two revisions 
    99     working directory file and the specified revision, and two revisions
   100     compares the two versions specified.
   100     compares the two versions specified.
   101 
   101 
   102 export [revision]::
   102 export [revision]::
   103     Print the changeset header (author, changeset hash, parent, and commit
   103     Print the changeset header (author, changeset hash, parent, and commit
   104     comment) and the diffs for a particular revision.
   104     comment) and the diffs for a particular revision.
   116 
   116 
   117 identify::
   117 identify::
   118     Print a short identifier of the current state of the repo. This
   118     Print a short identifier of the current state of the repo. This
   119     includes one or two parent hash identifiers, followed by
   119     includes one or two parent hash identifiers, followed by
   120     a "+" if there are uncommitted changes in the working directory,
   120     a "+" if there are uncommitted changes in the working directory,
   121     followed by a list of tags for this revision
   121     followed by a list of tags for this revision.
   122 
   122 
   123     aliases: id
   123     aliases: id
   124 
   124 
   125 import [-p <n> -b <base> -q] <patches>::
   125 import [-p <n> -b <base> -q] <patches>::
   126     Import the listed patches and commit them individually.
   126     Import the listed patches and commit them individually.
   148 log <file>::
   148 log <file>::
   149     Print the revision history of the specified file.
   149     Print the revision history of the specified file.
   150 
   150 
   151 manifest [revision]::
   151 manifest [revision]::
   152     Print the indicated revision of the manifest (list of version controlled
   152     Print the indicated revision of the manifest (list of version controlled
   153     files)
   153     files).
   154 
   154 
   155 parents::
   155 parents::
   156     Print the working directory's parent revisions.
   156     Print the working directory's parent revisions.
   157 
   157 
   158 pull <repository path>::
   158 pull <repository path>::
   159     pull any changes from the specified repository to the repository in the
   159     Pull any changes from the specified repository to the repository in the
   160     current directory.
   160     current directory.
   161 
   161 
   162     options:
   162     options:
   163     -u, --update   update the working directory to tip after pull
   163     -u, --update   update the working directory to tip after pull
   164 
   164 
   173     form:
   173     form:
   174 
   174 
   175       ssh://[user@]host[:port]/path
   175       ssh://[user@]host[:port]/path
   176 
   176 
   177 rawcommit [-p -d -u -F -t -l]::
   177 rawcommit [-p -d -u -F -t -l]::
   178     Primarily useful for importing from other SCMs. 
   178     Primarily useful for importing from other SCMs.
   179 
   179 
   180 recover::
   180 recover::
   181     Recover from an interrupted commit or pull. This should only be
   181     Recover from an interrupted commit or pull. This should only be
   182     necessary when Mercurial suggests it.
   182     necessary when Mercurial suggests it.
   183 
   183 
   184 remove [files ...]::
   184 remove [files ...]::
   185     schedule the indicated files for removal from the repository at the next
   185     Schedule the indicated files for removal from the repository at the next
   186     commit
   186     commit.
   187  
   187 
   188     aliases: rm
   188     aliases: rm
       
   189 
       
   190 root::
       
   191     Print the root directory of the current repository.
   189 
   192 
   190 serve [-a addr -n name -p port -t templatedir]::
   193 serve [-a addr -n name -p port -t templatedir]::
   191     Start a local HTTP repository browser and pull server.
   194     Start a local HTTP repository browser and pull server.
   192 
   195 
   193     options:
   196     options:
   211     -t, --text <text>     message for tag commit log entry
   214     -t, --text <text>     message for tag commit log entry
   212     -d, --date <datecode> datecode for commit
   215     -d, --date <datecode> datecode for commit
   213     -u, --user <user>     user for commit
   216     -u, --user <user>     user for commit
   214 
   217 
   215 tags::
   218 tags::
   216     List the current tags.
   219     List the repository tags.
   217 
   220 
   218 tip::
   221 tip::
   219     Show the tip revision
   222     Show the tip revision.
   220 
   223 
   221 undo::
   224 undo::
   222     Undo the last commit or pull transaction.
   225     Undo the last commit or pull transaction.
   223 
   226 
   224 update [-m -C] [revision]::
   227 update [-m -C] [revision]::
   254 
   257 
   255 
   258 
   256 ENVIRONMENT VARIABLES
   259 ENVIRONMENT VARIABLES
   257 ---------------------
   260 ---------------------
   258 
   261 
       
   262 HGEDITOR::
       
   263     This is the name of the editor to use when committing. Defaults to the
       
   264     value of EDITOR.
       
   265 
   259 HGMERGE::
   266 HGMERGE::
   260     An executable to use for resolving merge conflicts. The program ,
   267     An executable to use for resolving merge conflicts. The program ,
   261     will be executed with three arguments: local file, remote file,
   268     will be executed with three arguments: local file, remote file,
   262     ancestor file.
   269     ancestor file.
   263 
   270 
   269 
   276 
   270 EMAIL::
   277 EMAIL::
   271     If HGUSER is not set, this will be used as the author for a commit.
   278     If HGUSER is not set, this will be used as the author for a commit.
   272 
   279 
   273 LOGNAME::
   280 LOGNAME::
   274     if neither HGUSER nor EMAIL is set, LOGNAME will be used (with
   281     If neither HGUSER nor EMAIL is set, LOGNAME will be used (with
   275     '@hostname' appended) as the author value for a commit.
   282     '@hostname' appended) as the author value for a commit.
   276 
   283 
   277 EDITOR::
   284 EDITOR::
   278     This is the name of the editor to use when committing. Defaults to 'vi'.
   285     This is the name of the editor used in the hgmerge script. It will be
       
   286     used for commit messages, too, if HGEDITOR isn't set. Defaults to 'vi'.
   279 
   287 
   280 PYTHONPATH::
   288 PYTHONPATH::
   281     This is used by Python to find imported modules and may need to be set
   289     This is used by Python to find imported modules and may need to be set
   282     appropriately if Mercurial is not installed system-wide.
   290     appropriately if Mercurial is not installed system-wide.
   283 
   291 
   284 FILES
   292 FILES
   285 -----
   293 -----
   286  .hgignore::
   294  .hgignore::
   287     This file contains regular expressions (one per line) that describe file
   295     This file contains regular expressions (one per line) that describe file
   288     names that should be ignored by hg
   296     names that should be ignored by hg.
   289 
   297 
   290  .hgtags::
   298  .hgtags::
   291     This file contains changeset hash values and text tag names (one of each
   299     This file contains changeset hash values and text tag names (one of each
   292     seperated by spaces) that correspond to tagged versions of the repository
   300     seperated by spaces) that correspond to tagged versions of the repository
   293     contents.
   301     contents.
   304 
   312 
   305     Example:
   313     Example:
   306 
   314 
   307 [paths]
   315 [paths]
   308 hg = http://selenic.com/hg
   316 hg = http://selenic.com/hg
       
   317 tah = http://hg.intevation.org/mercurial-tah/
   309 
   318 
   310 NON_TRANSPARENT PROXY SUPPORT
   319 NON_TRANSPARENT PROXY SUPPORT
   311 -----------------------------
   320 -----------------------------
   312 
   321 
   313     To access a Mercurial repository through a proxy,
   322     To access a Mercurial repository through a proxy,