facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-07 15:27:13 +03:00
Code Issues Projects Releases Wiki Activity
9cce255bec
sapling/doc/hg.1.txt

101 lines
2.4 KiB
Plaintext
Raw Normal View History

doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
====
hg
====
---------------------------------------
Mercurial source code management system
---------------------------------------
:Author: Matt Mackall <mpm@selenic.com>
:Organization: Mercurial
:Manual section: 1
:Manual group: Mercurial Manual
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: add TOC to hg.1.html and hgrc.5.html
2009-09-05 00:26:57 +04:00
.. contents::
:backlinks: top
:class: htmlonly
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: use titlecase in man page section titles
2009-11-08 13:46:38 +03:00
Synopsis
adding doc directory and files
2005-05-27 18:16:58 +04:00
--------
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
**hg** *command* [*option*]... [*argument*]...
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: use titlecase in man page section titles
2009-11-08 13:46:38 +03:00
Description
adding doc directory and files
2005-05-27 18:16:58 +04:00
-----------
doc: fixup font markup in man pages This exposed a bug in rst2man where it neglects to escape a literal backslash. A patch has been applied upstream, but not yet packaged in, say, Debian unstable. A forward-compatible work-around has therefore been put in place.
2009-07-17 01:25:26 +04:00
The **hg** command provides a command line interface to the Mercurial
hg.1: wrap lines at 70 chars (whitespace cleanup)
2009-06-08 02:13:35 +04:00
system.
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: use titlecase in man page section titles
2009-11-08 13:46:38 +03:00
Command Elements
adding doc directory and files
2005-05-27 18:16:58 +04:00
----------------
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
files...
Get add and locate to use new repo and dirstate walk code. They use a walk function that abstracts out the irritating details, so that there's a higher likelihood of commands behaving uniformly.
2005-07-18 18:54:21 +04:00
indicates one or more filename or relative path filenames; see
doc: add some internal links to man pages
2009-11-02 23:32:42 +03:00
`File Name Patterns`_ for information on pattern matching
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
path
adding doc directory and files
2005-05-27 18:16:58 +04:00
indicates a path on the local machine
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
revision
hg.1: wrap lines at 70 chars (whitespace cleanup)
2009-06-08 02:13:35 +04:00
indicates a changeset which can be specified as a changeset
revision number, a tag, or a unique substring of the changeset
hash value
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
repository path
Various doc clean-ups and spelling fixes -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Various doc clean-ups and spelling fixes manifest hash: 4115506709314aabfb4a66973ef2bc8f22f2225b -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCwQ5YywK+sNU5EO8RAkAlAJoCsXCgEQ1lmS58aSrUyPf+KIK99gCeLY/v Tg9JhygJjwsu5xocc9Nh04Y= =JTG4 -----END PGP SIGNATURE-----
2005-06-28 12:46:16 +04:00
either the pathname of a local repository or the URI of a remote
Autodetect static-http
2008-10-23 00:41:32 +04:00
repository.
Update docs -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Update docs General editing of man page adding new commands, removing old, updating usage Remove generated docs manifest hash: 68e3fa38e8ec38e80debd95854e1374a9d24fbe0 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCule6ywK+sNU5EO8RAm6SAJ0eQwB5eFG1WeswqNMRqUEclmMaNQCeMcYY Y+UCHuN6vQ4PgEUKt91+rEo= =PAAA -----END PGP SIGNATURE-----
2005-06-23 10:33:30 +04:00
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
.. include:: hg.1.gendoc.txt
Update docs -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Update docs General editing of man page adding new commands, removing old, updating usage Remove generated docs manifest hash: 68e3fa38e8ec38e80debd95854e1374a9d24fbe0 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCule6ywK+sNU5EO8RAm6SAJ0eQwB5eFG1WeswqNMRqUEclmMaNQCeMcYY Y+UCHuN6vQ4PgEUKt91+rEo= =PAAA -----END PGP SIGNATURE-----
2005-06-23 10:33:30 +04:00
doc: use titlecase in man page section titles
2009-11-08 13:46:38 +03:00
Files
adding doc directory and files
2005-05-27 18:16:58 +04:00
-----
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
doc: fixup font markup in man pages This exposed a bug in rst2man where it neglects to escape a literal backslash. A patch has been applied upstream, but not yet packaged in, say, Debian unstable. A forward-compatible work-around has therefore been put in place.
2009-07-17 01:25:26 +04:00
``.hgignore``
hg.1: wrap lines at 70 chars (whitespace cleanup)
2009-06-08 02:13:35 +04:00
This file contains regular expressions (one per line) that
doc: fixup font markup in man pages This exposed a bug in rst2man where it neglects to escape a literal backslash. A patch has been applied upstream, but not yet packaged in, say, Debian unstable. A forward-compatible work-around has therefore been put in place.
2009-07-17 01:25:26 +04:00
describe file names that should be ignored by **hg**. For details,
doc: link man pages to one another
2009-07-17 01:25:26 +04:00
see |hgignore(5)|_.
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: fixup font markup in man pages This exposed a bug in rst2man where it neglects to escape a literal backslash. A patch has been applied upstream, but not yet packaged in, say, Debian unstable. A forward-compatible work-around has therefore been put in place.
2009-07-17 01:25:26 +04:00
``.hgtags``
hg.1: wrap lines at 70 chars (whitespace cleanup)
2009-06-08 02:13:35 +04:00
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.
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: fixup font markup in man pages This exposed a bug in rst2man where it neglects to escape a literal backslash. A patch has been applied upstream, but not yet packaged in, say, Debian unstable. A forward-compatible work-around has therefore been put in place.
2009-07-17 01:25:26 +04:00
``/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.
doc: link man pages to one another
2009-07-17 01:25:26 +04:00
See |hgrc(5)|_ for details of the contents and format of these
doc: fixup font markup in man pages This exposed a bug in rst2man where it neglects to escape a literal backslash. A patch has been applied upstream, but not yet packaged in, say, Debian unstable. A forward-compatible work-around has therefore been put in place.
2009-07-17 01:25:26 +04:00
files.
Transparent proxy support -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Transparent proxy support Originally from "Michael S. Tsirkin" <mst@mellanox.co.il> manifest hash: 74cf7456ef35ff8d4c007544f0d1a57c69d3c929 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCrSIUywK+sNU5EO8RAje1AJ41ALW8soF78Mo3UTraV1QQvJoFSQCgrqvc I9ohlI4hzdjOD+wSwRGlERQ= =Ugfi -----END PGP SIGNATURE-----
2005-06-13 10:05:08 +04:00
doc: fixup font markup in man pages This exposed a bug in rst2man where it neglects to escape a literal backslash. A patch has been applied upstream, but not yet packaged in, say, Debian unstable. A forward-compatible work-around has therefore been put in place.
2009-07-17 01:25:26 +04:00
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.
Document the fact that revert might overwrite .orig files
2006-08-29 21:26:58 +04:00
doc: use titlecase in man page section titles
2009-11-08 13:46:38 +03:00
Bugs
adding doc directory and files
2005-05-27 18:16:58 +04:00
----
doc: add some internal links to man pages
2009-11-02 23:32:42 +03:00
Probably lots, please post them to the mailing list (see Resources_
hg.1: wrap lines at 70 chars (whitespace cleanup)
2009-06-08 02:13:35 +04:00
below) when you find them.
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: use titlecase in man page section titles
2009-11-08 13:46:38 +03:00
See Also
Move hgrc documentation out to its own man page, hgrc(5). # HG changeset patch # User Bryan O'Sullivan <bos@serpentine.com> # Node ID 5076cf1fd6a1b8eb410e5e03cb004ca6a52a30f9 # Parent d5198e5dd8087ca487031662f0908a6296512e5d Move hgrc documentation out to its own man page, hgrc(5). The new man page expands on the existing documentation by describing the file format and the purpose of each section and field.
2005-07-11 04:14:06 +04:00
--------
doc: link man pages to one another
2009-07-17 01:25:26 +04:00
|hgignore(5)|_, |hgrc(5)|_
Move hgrc documentation out to its own man page, hgrc(5). # HG changeset patch # User Bryan O'Sullivan <bos@serpentine.com> # Node ID 5076cf1fd6a1b8eb410e5e03cb004ca6a52a30f9 # Parent d5198e5dd8087ca487031662f0908a6296512e5d Move hgrc documentation out to its own man page, hgrc(5). The new man page expands on the existing documentation by describing the file format and the purpose of each section and field.
2005-07-11 04:14:06 +04:00
doc: use titlecase in man page section titles
2009-11-08 13:46:38 +03:00
Author
adding doc directory and files
2005-05-27 18:16:58 +04:00
------
Written by Matt Mackall <mpm@selenic.com>
doc: use titlecase in man page section titles
2009-11-08 13:46:38 +03:00
Resources
adding doc directory and files
2005-05-27 18:16:58 +04:00
---------
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
Main Web Site: http://mercurial.selenic.com/
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
Source code repository: http://selenic.com/hg
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
2009-07-17 01:25:26 +04:00
Mailing list: http://selenic.com/mailman/listinfo/mercurial
adding doc directory and files
2005-05-27 18:16:58 +04:00
doc: use titlecase in man page section titles
2009-11-08 13:46:38 +03:00
Copying
adding doc directory and files
2005-05-27 18:16:58 +04:00
-------
Update copyright year to 2010
2010-01-05 01:45:45 +03:00
Copyright (C) 2005-2010 Matt Mackall.
adding doc directory and files
2005-05-27 18:16:58 +04:00
Free use of this software is granted under the terms of the GNU General
Update license to GPLv2+
2010-01-20 07:20:08 +03:00
Public License version 2 or any later version.
doc: link man pages to one another
2009-07-17 01:25:26 +04:00
.. include:: common.txt
Reference in New Issue Copy Permalink