diff --git a/doc/hg.1 b/doc/hg.1 new file mode 100644 --- /dev/null +++ b/doc/hg.1 @@ -0,0 +1,209 @@ +.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "HG" 1 "" "" "" +.SH NAME +hg \- command line interface to the Mercurial source code management system +.SH "SYNOPSIS" + + +hg [\-v \-d \-q \-y] [command options] [files] + +.SH "DESCRIPTION" + + +The hg(1) command provides a command line interface to the Mercurial system\&. + +.SH "NOTE" + + +Many of the hg commands are not yet subdirectory and/or working directory aware\&. This means that some commands will only work in the top level repository directory or will only accept paths and filenames relative to the top level\&. Merges and commits, in particular, should be done in the top\-level directory\&. + +.SH "OPTIONS" + +.TP +--debug, \-d +enable debugging output + +.TP +--quiet, \-q +suppress output + +.TP +--verbose, \-v +enable additional output + +.TP +--noninteractive, \-y +do not prompt, assume yes for any required answers + +.SH "COMMAND ELEMENTS" + +.TP +files ... +indicates one or more filename or relative path filenames + +.TP +path +indicates a path on the local machine + +.TP +revision +indicates a changeset which can be specified as a changeset id (int), a tag, or a unique substring of the changeset hash value + +.TP +repository path +is either the pathname of a local repository of the URI of a remote repository\&. There are two available URI protocols, hg:// which is fast and the http:// protocol which is much slower but does not require python on the web host\&. + +.SH "COMMANDS" + +.TP +add [files ...] +add the given files to the repository\&. Note that this just schedules the files for addition at the next hg commit time\&. + +.TP +addremove +add all new files and remove all missing files from the repository\&. new files are ignored if they match any of the patterns in \&.hgignore + +.TP +annotate [\-r revision \-u \-n \-c] [files ...] +list the files with each line showing the revision id responsible for that line\&. \-u will add the author to the revision id, \-c will print the changeset hash, and \-n will ... + +.TP +branch +create a new branch of the repository indicated by path in the current directory\&. Note that there should not be a repository already initialized in the current directory + +.TP +checkout [revision] +check out the indicated version of the repository into the working directory\&. Note that currently no merge occurs with changed files in the working dir\&. + +.TP +commit +commit all changed files in the working dir to the repository\&. This uses the EDITOR environment variable to bring up an editor to add a commit comment\&. + +.TP +diff [\-r revision] [\-r revision] [files ...] +generate a unified diff of the indicated files\&. If there are no revisions specified, the working directory file is compared to the tip, one revision specified indicates a comparison between the working directory file and the specified revision, two revisions compares the two versions specified\&. + +.TP +dump [revision] +print the indicated revision of the file + +.TP +dumpmanifest [revision] +print the indicated revision of the manifest (list of version controlled files) + +.TP +history +print the revision history of the repository + +.TP +init +initialize a repository in the current directory + +.TP +log +print the revision history of the specified file + +.TP +merge +pull any changes from the specified repository to the repository in the current directory\&. Use the value of the HGMERGE environment variable as a program to resolve any merge conflicts between the two repositories\&. An implicit commit is done at the end of this process if there were any merge conflicts\&. Note that merge does not yet merge with changed files in the working dir\&. + +.TP +remove [files ...] +schedule the indicated files for removal from the repository at the next commit + +.TP +serve [\-a addr \-n name \-p port \-t templatedir] +this will start an http server, by default on port 8000, that will allow browsing the repository using the hgweb interface and will allow merging from the repository\&. \-a sets the interface address, \-p the port to listen on, \-n the name of the repository and \-t sets the location of the template directory\&. + +.TP +status +list new, changed, and missing files in the working directory + +.TP +tags +list the current tags + +.SH "ENVIRONMENT VARIABLES" + +.TP +HGMERGE +points to an executable to use for resolving merge conflicts, the program will be executed with four arguments: local file, remote file, ancestor file, and original filename\&. + +.TP +HGUSER +this is the string used for the author value of a commit + +.TP +HG_OPTS +this string is used for default arguments to hg + +.TP +PYTHONPATH +this is used by Python to find imported modules and needs to be set appropriately based on where mercurial is installed + +.TP +EMAIL +if HGUSER is not set, this will be used next as the author value for a commit + +.TP +LOGNAME +if neither HGUSER nor EMAIL is set, LOGNAME will be used (with @hostname appended) as the author value for a commit + +.TP +EDITOR +this is the name of the editor to use when committing + +.SH "FILES" + +.TP +\&.hgignore +this file contains regular expressions (one per line) that describe file names that should be ignored by hg + +.TP +\&.hgtags +this file contains changeset hash values and text tag names (one of each seperated by spaces) that correspond to tagged versions of the repository contents\&. + +.SH "BUGS" + + +Probably lots, please post them to the mailing list (See Resources below) when you find them\&. + +.SH "AUTHOR" + + +Written by Matt Mackall + +.SH "RESOURCES" + + +Main Web Site: \fIhttp://selenic.com/mercurial\fR + + +Source code repository: \fIhttp://selenic.com/hg\fR + + +Mailing list: \fIhttp://selenic.com/mailman/listinfo/mercurial\fR + +.SH "COPYING" + + +Copyright (C) 2005 Matt Mackall\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. +