annotate doc/hg.1.txt @ 9419:3516a4e877c1

doc/README: simplify instructions

====
 hg
====

---------------------------------------
Mercurial source code management system
---------------------------------------

:Author:         Matt Mackall <[e-mail]>
:Organization:   Mercurial
:Manual section: 1
:Manual group:   Mercurial Manual


SYNOPSIS
--------
**hg** *command* [*option*]... [*argument*]...

DESCRIPTION
-----------
The **hg** command provides a command line interface to the Mercurial
system.

COMMAND ELEMENTS
----------------

files...
    indicates one or more filename or relative path filenames; see
    "FILE NAME PATTERNS" for information on pattern matching

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
    either the pathname of a local repository or the URI of a remote
    repository.

.. include:: hg.1.gendoc.txt

FILES
-----

``.hgignore``
    This file contains regular expressions (one per line) that
    describe file names that should be ignored by **hg**. For details,
    see |hgignore(5)|_.

``.hgtags``
    This file contains changeset hash values and text tag names (one
    of each separated by spaces) that correspond to tagged versions of
    the repository contents.

``/etc/mercurial/hgrc``, ``$HOME/.hgrc``, ``.hg/hgrc``
    This file contains defaults and configuration. Values in
    ``.hg/hgrc`` override those in ``$HOME/.hgrc``, and these override
    settings made in the global ``/etc/mercurial/hgrc`` configuration.
    See |hgrc(5)|_ for details of the contents and format of these
    files.

Some commands (e.g. revert) produce backup files ending in ``.orig``,
if the ``.orig`` file already exists and is not tracked by Mercurial,
it will be overwritten.

BUGS
----
Probably lots, please post them to the mailing list (See Resources
below) when you find them.

SEE ALSO
--------
|hgignore(5)|_, |hgrc(5)|_

AUTHOR
------
Written by Matt Mackall <[e-mail]>

RESOURCES
---------
Main Web Site: http://mercurial.selenic.com/

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

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

COPYING
-------
Copyright \(C) 2005-2009 Matt Mackall.
Free use of this software is granted under the terms of the GNU General
Public License (GPL).

.. include:: common.txt