doc/hg.1.txt
author Brodie Rao <brodie@bitheap.org>
Fri, 02 Apr 2010 15:22:00 -0500
changeset 10815 32b213b9b22c
parent 10263 25e572394f5c
child 12776 4f4eddee254d
permissions -rw-r--r--
ui: add ui.write() output labeling API This adds output labeling support with the following methods: - ui.write(..., label='topic.name topic2.name2 ...') - ui.write_err(.., label=...) - ui.popbuffer(labeled=False) - ui.label(msg, label) By adding an API to label output directly, the color extension can forgo parsing command output and instead override the above methods to insert ANSI color codes. GUI tools can also override the above methods and use the labels to do GUI-specific styling. popbuffer gains a labeled argument that, when set to True, returns its buffered output with labels handled. In the case of the color extension, this would return output with color codes embedded. For existing users that use this method to capture and parse output, labels are discarded and output returned as normal when labeled is False (the default). Existing wrappers of ui.write() and ui.write_err() should make sure to accept its new **opts argument.

====
 hg
====

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

:Author:         Matt Mackall <mpm@selenic.com>
:Organization:   Mercurial
:Manual section: 1
:Manual group:   Mercurial Manual

.. contents::
   :backlinks: top
   :class: htmlonly


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 <mpm@selenic.com>

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-2010 Matt Mackall.
Free use of this software is granted under the terms of the GNU General
Public License version 2 or any later version.

.. include:: common.txt