HG(1)

=====

Matt Mackall <mpm@selenic.com>

v0.6, 24 Jun 2005

NAME

----

hg - Mercurial source code management system

SYNOPSIS

--------

'hg' [-v -d -q -y] <command> [command options] [files]

DESCRIPTION

-----------

The hg(1) command provides a command line interface to the Mercurial system.

OPTIONS

-------

--debug, -d::

    enable debugging output

--quiet, -q::

    suppress output

--verbose, -v::

    enable additional output

--noninteractive, -y::

    do not prompt, assume 'yes' for any required answers

COMMAND ELEMENTS

----------------

files ...::

    indicates one or more filename or relative path filenames

path::

    indicates a path on the local machine

revision::

    indicates a changeset which can be specified as a changeset revision

    number, a tag, or a unique substring of the changeset hash value

repository path::

    is either the pathname of a local repository of the URI of a remote

    repository.  There are two available URI protocols, http:// which is

    fast and the old-http:// protocol which is much slower but does not

    require a special server on the web host.

COMMANDS

--------

add [files ...]::

addremove::

annotate [-r <rev> -u -n -c] [files ...]::

    options:

    -r, --revision <rev>  annotate the specified revision

    -u, --user            list the author

    -c, --changeset       list the changeset

    -n, --number          list the revision number (default)

cat <file> [revision]::

clone [-U] <source> [dest]::

    If the specified source is on the same filesystem, the repository

    will be copied via hardlinks. This is the fastest and most

    space-efficient mode of operation.

    If the destination directory is not specified, it defaults to the

    current directory.

    If the destination is specified, but does not exist, it is created.

    The source is added to .hg/hgrc in the new copy as the default for

    future pulls.

    options:

    -U, --no-update   do not update the new working directory

init::

    Initialize a new repository in the current directory.

log <file>::

    Print the revision history of the specified file.

manifest [revision]::

parents::

    Print the working directory's parent revisions.

pull <repository path>::

    options:

    -u, --update   update the working directory to tip after pull

push <destination>::

    The other currently available push method is SSH. This requires an

    accessible shell account on the destination machine and a copy of

    hg in the remote path. Destinations are specified in the following

    form:

      ssh://[user@]host[:port]/path

rawcommit [-p -d -u -F -t -l]::

recover::

remove [files ...]::

    aliases: rm

root::

    Print the root directory of the current repository.

serve [-a addr -n name -p port -t templatedir]::

    Start a local HTTP repository browser and pull server.

    options:

    -a, --address <addr> address to use

    -p, --port <n>       port to use (default: 8000)

    -n, --name <name>    name to show in web pages (default: working dir)

    -t, --templatedir <path> web templates to use

status::

    Show changed files in the working directory.

    C = changed

    A = added

    R = removed

    ? = not tracked

tag [-t <text> -d <datecode> -u <user>] <name> [revision]::

    options:

    -t, --text <text>     message for tag commit log entry

    -d, --date <datecode> datecode for commit

    -u, --user <user>     user for commit

tags::

    List the repository tags.

tip::

    Show the tip revision.

undo::

    Undo the last commit or pull transaction.

update [-m -C] [revision]::

    options:

    -m, --merge       allow merging of branches

    -C, --clean       overwrite locally modified files

    aliases: up checkout co

verify::

    Verify the integrity of the current repository.

    This will perform an extensive check of the repository's

    integrity, validating the hashes and checksums of each entry in

    the changelog, manifest, and tracked files, as well as the

    integrity of their crosslinks and indices.

ENVIRONMENT VARIABLES

---------------------

HGEDITOR::

    This is the name of the editor to use when committing. Defaults to the

    value of EDITOR.

HGMERGE::

    An executable to use for resolving merge conflicts. The program ,

    will be executed with three arguments: local file, remote file,

    ancestor file.

    The default program is "hgmerge", which is a shell script provided

    by Mercurial with some sensible defaults.

HGUSER::

    This is the string used for the author of a commit.

EMAIL::

    If HGUSER is not set, this will be used as the author for a commit.

LOGNAME::

    If neither HGUSER nor EMAIL is set, LOGNAME will be used (with

    '@hostname' appended) as the author value for a commit.

EDITOR::

    This is the name of the editor used in the hgmerge script. It will be

    used for commit messages, too, if HGEDITOR isn't set. Defaults to 'vi'.

PYTHONPATH::

    This is used by Python to find imported modules and may need to be set

    appropriately if Mercurial is not installed system-wide.

FILES

-----

 .hgignore::

    This file contains regular expressions (one per line) that describe file

    names that should be ignored by hg.

 .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.

 $HOME/.hgrc, .hg/hgrc::

    This file contains defaults and configuration. Values in .hg/hgrc

    override those in .hgrc.

NAMED REPOSITORIES

------------------

To give symbolic names to a repository, create a section in .hgrc

or .hg/hgrc containing assignments of names to paths. Example:

-----------------

[paths]

hg = http://selenic.com/hg

tah = http://hg.intevation.org/mercurial-tah/

-----------------

HOOKS

-----

Mercurial supports a set of 'hook', commands that get automatically

executed by various actions such as starting or finishing a commit. To

specify a hook, simply create an hgrc section like the following:

-----------------

[hooks]

precommit = echo "this hook gets executed immediately before a commit"

commit = hg export $NODE | mail -s "new commit $NODE" commit-list

-----------------

NON_TRANSPARENT PROXY SUPPORT

-----------------------------

To access a Mercurial repository through a proxy, create a file

$HOME/.hgrc in the following format:

--------------

[http_proxy]

host=myproxy:8080

user=<username>

passwd=<password>

no=<localhost1>,<localhost2>,<localhost3>,...

--------------

"user","passwd" fields are used for authenticating proxies, "no" is a

comma-separated list of local host names for which proxy must be

bypassed.

BUGS

----

Probably lots, please post them to the mailing list (See Resources below)

when you find them.

AUTHOR

------

Written by Matt Mackall <mpm@selenic.com>

RESOURCES

---------

http://selenic.com/mercurial[Main Web Site]

http://selenic.com/hg[Source code repository]

http://selenic.com/mailman/listinfo/mercurial[Mailing list]

COPYING

-------

Copyright (C) 2005 Matt Mackall.

Free use of this software is granted under the terms of the GNU General

Public License (GPL).