Mercurial > hg

annotate doc/hg.1.txt @ 9086:f459f09b4214

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
convert: fixed typo in docstring
author Martin Geisler <mg@lazybytes.net>
date Wed, 08 Jul 2009 23:12:40 +0200
parents 1de6e7e1bb9f
children d6eecafaf12f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
1 HG(1)
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
2 =====
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
3 Matt Mackall <mpm@selenic.com>
8772
593d772434f7 man pages: add meta data
Martin Geisler <mg@lazybytes.net>
parents: 8771
diff changeset
4 :man source: Mercurial
593d772434f7 man pages: add meta data
Martin Geisler <mg@lazybytes.net>
parents: 8771
diff changeset
5 :man manual: Mercurial Manual
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
6
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
7 NAME
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
8 ----
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
9 hg - Mercurial source code management system
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
10
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
11 SYNOPSIS
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
12 --------
8774
dbb258564651 hg.1: simplify synopsis
Martin Geisler <mg@lazybytes.net>
parents: 8772
diff changeset
13 *hg* 'command' ['option']... ['argument']...
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
14
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
15 DESCRIPTION
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
16 -----------
8775
8e15f4afdf06 hg.1: highlight references to commands and man pages
Martin Geisler <mg@lazybytes.net>
parents: 8774
diff changeset
17 The *hg* command provides a command line interface to the Mercurial
8728
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
18 system.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
19
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
20 COMMAND ELEMENTS
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
21 ----------------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
22
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
23 files ...::
724
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
24 indicates one or more filename or relative path filenames; see
1c0c413cccdd Get add and locate to use new repo and dirstate walk code.
Bryan O'Sullivan <bos@serpentine.com>
parents: 671
diff changeset
25 "FILE NAME PATTERNS" for information on pattern matching
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
26
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
27 path::
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
28 indicates a path on the local machine
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
29
478
f1804f2e7f35 Update of doc/hg.1.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 438
diff changeset
30 revision::
8728
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
31 indicates a changeset which can be specified as a changeset
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
32 revision number, a tag, or a unique substring of the changeset
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
33 hash value
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
34
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
35 repository path::
498
8cf3999b3d03 Various doc clean-ups and spelling fixes
mpm@selenic.com
parents: 497
diff changeset
36 either the pathname of a local repository or the URI of a remote
7211
25c0dee16ee0 Autodetect static-http
Matt Mackall <mpm@selenic.com>
parents: 6655
diff changeset
37 repository.
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
38
1814
7956893e8458 generate hg manpage from commands.py docstring
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 1758
diff changeset
39 include::hg.1.gendoc.txt[]
438
b38deaf7873e Update docs
mpm@selenic.com
parents: 330
diff changeset
40
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
41 FILES
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
42 -----
8766
b2059435f176 man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents: 8728
diff changeset
43 `.hgignore`::
8728
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
44 This file contains regular expressions (one per line) that
8775
8e15f4afdf06 hg.1: highlight references to commands and man pages
Martin Geisler <mg@lazybytes.net>
parents: 8774
diff changeset
45 describe file names that should be ignored by *hg*. For details,
8e15f4afdf06 hg.1: highlight references to commands and man pages
Martin Geisler <mg@lazybytes.net>
parents: 8774
diff changeset
46 see *hgignore(5)*.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
47
8766
b2059435f176 man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents: 8728
diff changeset
48 `.hgtags`::
8728
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
49 This file contains changeset hash values and text tag names (one
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
50 of each separated by spaces) that correspond to tagged versions of
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
51 the repository contents.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
52
8766
b2059435f176 man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents: 8728
diff changeset
53 `/etc/mercurial/hgrc`, `$HOME/.hgrc`, `.hg/hgrc`::
b2059435f176 man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents: 8728
diff changeset
54 This file contains defaults and configuration. Values in `.hg/hgrc`
b2059435f176 man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents: 8728
diff changeset
55 override those in `$HOME/.hgrc`, and these override settings made in
8775
8e15f4afdf06 hg.1: highlight references to commands and man pages
Martin Geisler <mg@lazybytes.net>
parents: 8774
diff changeset
56 the global `/etc/mercurial/hgrc` configuration. See *hgrc(5)* for
8728
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
57 details of the contents and format of these files.
321
73b8a8a059ec Transparent proxy support
mpm@selenic.com
parents: 196
diff changeset
58
8766
b2059435f176 man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents: 8728
diff changeset
59 Some commands (e.g. revert) produce backup files ending in `.orig`, if
b2059435f176 man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents: 8728
diff changeset
60 the `.orig` file already exists and is not tracked by Mercurial, it will
8728
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
61 be overwritten.
3021
b9dbbcf8a488 Document the fact that revert might overwrite .orig files
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 2859
diff changeset
62
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
63 BUGS
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
64 ----
8728
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
65 Probably lots, please post them to the mailing list (See Resources
9d67706ee8d5 hg.1: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents: 7211
diff changeset
66 below) when you find them.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
67
671
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
68 SEE ALSO
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
69 --------
8775
8e15f4afdf06 hg.1: highlight references to commands and man pages
Martin Geisler <mg@lazybytes.net>
parents: 8774
diff changeset
70 *hgignore(5)*, *hgrc(5)*
671
efa4a7e2f322 Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents: 631
diff changeset
71
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
72 AUTHOR
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
73 ------
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
74 Written by Matt Mackall <mpm@selenic.com>
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
75
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
76 RESOURCES
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
77 ---------
8936
1de6e7e1bb9f change wiki/bts URLs to point to new hostname
Dirkjan Ochtman <dirkjan@ochtman.nl>
parents: 8775
diff changeset
78 http://mercurial.selenic.com/[Main Web Site]
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
79
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
80 http://selenic.com/hg[Source code repository]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
81
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
82 http://selenic.com/mailman/listinfo/mercurial[Mailing list]
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
83
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
84 COPYING
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
85 -------
8771
a2871de50f50 man pages: updated copyright years
Martin Geisler <mg@lazybytes.net>
parents: 8766
diff changeset
86 Copyright \(C) 2005-2009 Matt Mackall.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
87 Free use of this software is granted under the terms of the GNU General
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
88 Public License (GPL).