Mercurial > hg

comparison doc/hg.1.txt @ 9158:d6eecafaf12f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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.
author Martin Geisler <mg@lazybytes.net>
date Thu, 16 Jul 2009 23:25:26 +0200
parents 1de6e7e1bb9f
children e8b653a4b8da
comparison
equal deleted inserted replaced
9157:9261667e9b82 9158:d6eecafaf12f
1 HG(1) 1 ====
2 ===== 2 hg
3 Matt Mackall <mpm@selenic.com> 3 ====
4 :man source: Mercurial
5 :man manual: Mercurial Manual
6 4
7 NAME 5 ---------------------------------------
8 ---- 6 Mercurial source code management system
9 hg - Mercurial source code management system 7 ---------------------------------------
8
9 :Author: Matt Mackall <mpm@selenic.com>
10 :Organization: Mercurial
11 :Manual section: 1
12 :Manual group: Mercurial Manual
13
10 14
11 SYNOPSIS 15 SYNOPSIS
12 -------- 16 --------
13 *hg* 'command' ['option']... ['argument']... 17 **hg** *command* [*option*]... [*argument*]...
14 18
15 DESCRIPTION 19 DESCRIPTION
16 ----------- 20 -----------
17 The *hg* command provides a command line interface to the Mercurial 21 The *hg* command provides a command line interface to the Mercurial
18 system. 22 system.
19 23
20 COMMAND ELEMENTS 24 COMMAND ELEMENTS
21 ---------------- 25 ----------------
22 26
23 files ...:: 27 files...
24 indicates one or more filename or relative path filenames; see 28 indicates one or more filename or relative path filenames; see
25 "FILE NAME PATTERNS" for information on pattern matching 29 "FILE NAME PATTERNS" for information on pattern matching
26 30
27 path:: 31 path
28 indicates a path on the local machine 32 indicates a path on the local machine
29 33
30 revision:: 34 revision
31 indicates a changeset which can be specified as a changeset 35 indicates a changeset which can be specified as a changeset
32 revision number, a tag, or a unique substring of the changeset 36 revision number, a tag, or a unique substring of the changeset
33 hash value 37 hash value
34 38
35 repository path:: 39 repository path
36 either the pathname of a local repository or the URI of a remote 40 either the pathname of a local repository or the URI of a remote
37 repository. 41 repository.
38 42
39 include::hg.1.gendoc.txt[] 43 .. include:: hg.1.gendoc.txt
40 44
41 FILES 45 FILES
42 ----- 46 -----
43 `.hgignore`:: 47
48 `.hgignore`
44 This file contains regular expressions (one per line) that 49 This file contains regular expressions (one per line) that
45 describe file names that should be ignored by *hg*. For details, 50 describe file names that should be ignored by *hg*. For details,
46 see *hgignore(5)*. 51 see *hgignore(5)*.
47 52
48 `.hgtags`:: 53 `.hgtags`
49 This file contains changeset hash values and text tag names (one 54 This file contains changeset hash values and text tag names (one
50 of each separated by spaces) that correspond to tagged versions of 55 of each separated by spaces) that correspond to tagged versions of
51 the repository contents. 56 the repository contents.
52 57
53 `/etc/mercurial/hgrc`, `$HOME/.hgrc`, `.hg/hgrc`:: 58 `/etc/mercurial/hgrc`, `$HOME/.hgrc`, `.hg/hgrc`
54 This file contains defaults and configuration. Values in `.hg/hgrc` 59 This file contains defaults and configuration. Values in `.hg/hgrc`
55 override those in `$HOME/.hgrc`, and these override settings made in 60 override those in `$HOME/.hgrc`, and these override settings made in
56 the global `/etc/mercurial/hgrc` configuration. See *hgrc(5)* for 61 the global `/etc/mercurial/hgrc` configuration. See *hgrc(5)* for
57 details of the contents and format of these files. 62 details of the contents and format of these files.
58 63
73 ------ 78 ------
74 Written by Matt Mackall <mpm@selenic.com> 79 Written by Matt Mackall <mpm@selenic.com>
75 80
76 RESOURCES 81 RESOURCES
77 --------- 82 ---------
78 http://mercurial.selenic.com/[Main Web Site] 83 Main Web Site: http://mercurial.selenic.com/
79 84
80 http://selenic.com/hg[Source code repository] 85 Source code repository: http://selenic.com/hg
81 86
82 http://selenic.com/mailman/listinfo/mercurial[Mailing list] 87 Mailing list: http://selenic.com/mailman/listinfo/mercurial
83 88
84 COPYING 89 COPYING
85 ------- 90 -------
86 Copyright \(C) 2005-2009 Matt Mackall. 91 Copyright \(C) 2005-2009 Matt Mackall.
87 Free use of this software is granted under the terms of the GNU General 92 Free use of this software is granted under the terms of the GNU General