##// END OF EJS Templates
Describe all files related to the standard commands.
Olav Reinert -
r15616:05e522d3 stable
parent child Browse files
Show More
@@ -1,101 +1,119 b''
1 ====
1 ====
2 hg
2 hg
3 ====
3 ====
4
4
5 ---------------------------------------
5 ---------------------------------------
6 Mercurial source code management system
6 Mercurial source code management system
7 ---------------------------------------
7 ---------------------------------------
8
8
9 :Author: Matt Mackall <mpm@selenic.com>
9 :Author: Matt Mackall <mpm@selenic.com>
10 :Organization: Mercurial
10 :Organization: Mercurial
11 :Manual section: 1
11 :Manual section: 1
12 :Manual group: Mercurial Manual
12 :Manual group: Mercurial Manual
13
13
14 .. contents::
14 .. contents::
15 :backlinks: top
15 :backlinks: top
16 :class: htmlonly
16 :class: htmlonly
17 :depth: 1
17 :depth: 1
18
18
19
19
20 Synopsis
20 Synopsis
21 --------
21 --------
22 **hg** *command* [*option*]... [*argument*]...
22 **hg** *command* [*option*]... [*argument*]...
23
23
24 Description
24 Description
25 -----------
25 -----------
26 The **hg** command provides a command line interface to the Mercurial
26 The **hg** command provides a command line interface to the Mercurial
27 system.
27 system.
28
28
29 Command Elements
29 Command Elements
30 ----------------
30 ----------------
31
31
32 files...
32 files...
33 indicates one or more filename or relative path filenames; see
33 indicates one or more filename or relative path filenames; see
34 `File Name Patterns`_ for information on pattern matching
34 `File Name Patterns`_ for information on pattern matching
35
35
36 path
36 path
37 indicates a path on the local machine
37 indicates a path on the local machine
38
38
39 revision
39 revision
40 indicates a changeset which can be specified as a changeset
40 indicates a changeset which can be specified as a changeset
41 revision number, a tag, or a unique substring of the changeset
41 revision number, a tag, or a unique substring of the changeset
42 hash value
42 hash value
43
43
44 repository path
44 repository path
45 either the pathname of a local repository or the URI of a remote
45 either the pathname of a local repository or the URI of a remote
46 repository.
46 repository.
47
47
48 .. include:: hg.1.gendoc.txt
48 .. include:: hg.1.gendoc.txt
49
49
50 Files
50 Files
51 -----
51 -----
52
52
53 ``.hgignore``
54 This file contains regular expressions (one per line) that
55 describe file names that should be ignored by **hg**. For details,
56 see |hgignore(5)|_.
57
58 ``.hgtags``
59 This file contains changeset hash values and text tag names (one
60 of each separated by spaces) that correspond to tagged versions of
61 the repository contents.
62
63 ``/etc/mercurial/hgrc``, ``$HOME/.hgrc``, ``.hg/hgrc``
53 ``/etc/mercurial/hgrc``, ``$HOME/.hgrc``, ``.hg/hgrc``
64 This file contains defaults and configuration. Values in
54 This file contains defaults and configuration. Values in
65 ``.hg/hgrc`` override those in ``$HOME/.hgrc``, and these override
55 ``.hg/hgrc`` override those in ``$HOME/.hgrc``, and these override
66 settings made in the global ``/etc/mercurial/hgrc`` configuration.
56 settings made in the global ``/etc/mercurial/hgrc`` configuration.
67 See |hgrc(5)|_ for details of the contents and format of these
57 See |hgrc(5)|_ for details of the contents and format of these
68 files.
58 files.
69
59
60 ``.hgignore``
61 This file contains regular expressions (one per line) that
62 describe file names that should be ignored by **hg**. For details,
63 see |hgignore(5)|_.
64
65 ``.hgsub``
66 This file defines the locations of all subrepositories, and
67 tells where the subrepository checkouts came from. For details, see
68 :hg:`help subrepos`.
69
70 ``.hgsubstate``
71 This file is where Mercurial stores all nested repository states. *NB: This
72 file should not be edited manually.*
73
74 ``.hgtags``
75 This file contains changeset hash values and text tag names (one
76 of each separated by spaces) that correspond to tagged versions of
77 the repository contents. The file content is encoded using UTF-8.
78
79 ``.hg/last-message.txt``
80 This file is used by :hg:`commit` to store a backup of the commit message
81 in case the commit fails.
82
83 ``.hg/localtags``
84 This file can be used to define local tags which are not shared among
85 repositories. The file format is the same as for ``.hgtags``, but it is
86 encoded using the local system encoding.
87
70 Some commands (e.g. revert) produce backup files ending in ``.orig``,
88 Some commands (e.g. revert) produce backup files ending in ``.orig``,
71 if the ``.orig`` file already exists and is not tracked by Mercurial,
89 if the ``.orig`` file already exists and is not tracked by Mercurial,
72 it will be overwritten.
90 it will be overwritten.
73
91
74 Bugs
92 Bugs
75 ----
93 ----
76 Probably lots, please post them to the mailing list (see Resources_
94 Probably lots, please post them to the mailing list (see Resources_
77 below) when you find them.
95 below) when you find them.
78
96
79 See Also
97 See Also
80 --------
98 --------
81 |hgignore(5)|_, |hgrc(5)|_
99 |hgignore(5)|_, |hgrc(5)|_
82
100
83 Author
101 Author
84 ------
102 ------
85 Written by Matt Mackall <mpm@selenic.com>
103 Written by Matt Mackall <mpm@selenic.com>
86
104
87 Resources
105 Resources
88 ---------
106 ---------
89 Main Web Site: http://mercurial.selenic.com/
107 Main Web Site: http://mercurial.selenic.com/
90
108
91 Source code repository: http://selenic.com/hg
109 Source code repository: http://selenic.com/hg
92
110
93 Mailing list: http://selenic.com/mailman/listinfo/mercurial
111 Mailing list: http://selenic.com/mailman/listinfo/mercurial
94
112
95 Copying
113 Copying
96 -------
114 -------
97 Copyright (C) 2005-2010 Matt Mackall.
115 Copyright (C) 2005-2010 Matt Mackall.
98 Free use of this software is granted under the terms of the GNU General
116 Free use of this software is granted under the terms of the GNU General
99 Public License version 2 or any later version.
117 Public License version 2 or any later version.
100
118
101 .. include:: common.txt
119 .. include:: common.txt
General Comments 0
You need to be logged in to leave comments. Login now