Mercurial > hg > mercurial-crew-with-dirclash

comparison doc/hgrc.5.txt @ 671:efa4a7e2f322

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 7369ec5d93f2ffd490a43970edd9adf8d2bbe269 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.
author Bryan O'Sullivan <bos@serpentine.com>
date Sun, 10 Jul 2005 16:14:06 -0800
parents
children a1099c50a622 574869103985
comparison
equal deleted inserted replaced
670:4efb9b109292 671:efa4a7e2f322
1 HGRC(5)
2 =======
3 Bryan O'Sullivan <bos@serpentine.com>
4
5 NAME
6 ----
7 hgrc - configuration files for Mercurial
8
9 SYNOPSIS
10 --------
11
12 The Mercurial system uses a set of configuration files to control
13 aspects of its behaviour.
14
15 FILES
16 -----
17
18 Mercurial reads configuration data from two files:
19
20 $HOME/.hgrc::
21 Global configuration options that apply to all Mercurial commands,
22 no matter where they are run.
23
24 <repo>/.hg/hgrc::
25 Per-repository configuration options that only apply in a
26 particular repository. This file is not version-controlled, and
27 will not get transferred during a "clone" operation. Values in
28 this file override global values.
29
30 SYNTAX
31 ------
32
33 A configuration file consists of sections, led by a "[section]" header
34 and followed by "name: value" entries; "name=value" is also accepted.
35
36 [spam]
37 eggs=ham
38 green=
39 eggs
40
41 Each line contains one entry. If the lines that follow are indented,
42 they are treated as continuations of that entry.
43
44 Leading whitespace is removed from values. Empty lines are skipped.
45
46 The optional values can contain format strings which refer to other
47 values in the same section, or values in a special DEFAULT section.
48
49 Lines beginning with "#" or ";" are ignored and may be used to provide
50 comments.
51
52 SECTIONS
53 --------
54
55 This section describes the different sections that may appear in a
56 Mercurial "hgrc" file, the purpose of each section, its possible
57 keys, and their possible values.
58
59 hooks::
60 Commands that get automatically executed by various actions such as
61 starting or finishing a commit.
62 precommit;;
63 Run before starting a commit. Exit status 0 allows the commit to
64 proceed. Non-zero status will cause the commit to fail.
65 commit;;
66 Run after a changeset has been created. Passed the ID of the newly
67 created changeset.
68
69 http_proxy::
70 Used to access web-based Mercurial repositories through a HTTP
71 proxy.
72 host;;
73 Host name and (optional) port of the proxy server, for example
74 "myproxy:8000".
75 user;;
76 Optional. User name to authenticate with at the proxy server.
77 passwd;;
78 Optional. Password to authenticate with at the proxy server.
79 no;;
80 Optional. Comma-separated list of host names that should bypass
81 the proxy.
82
83 paths::
84 Assigns symbolic names to repositories. The left side is the
85 symbolic name, and the right gives the directory or URL that is the
86 location of the repository.
87
88 tags::
89 Tags that are local to a repository and not distributed or version
90 controlled. The left side is the tag name, and the right is the
91 ID of the changeset to identify.
92
93 ui::
94 User interface controls.
95 debug;;
96 Print debugging information. True or False. Default is True.
97 editor;;
98 The editor to use during a commit. Default is "vi".
99 merge;;
100 The conflict resolution program to use during a manual merge.
101 Default is "hgeditor".
102 quiet;;
103 Reduce the amount of output printed. True or False. Default is
104 False.
105 username;;
106 The committer of a changeset created when running "commit".
107 Typically a person's name and email address, e.g. "Fred Widget
108 <fred@example.com>". Default is username@hostname.
109 verbose;;
110 Increase the amount of output printed. True or False. Default is
111 False.
112
113 AUTHOR
114 ------
115 Bryan O'Sullivan <bos@serpentine.com>.
116
117 Mercurial was written by Matt Mackall <mpm@selenic.com>.
118
119 SEE ALSO
120 --------
121 hg(1)
122
123 COPYING
124 -------
125 This manual page is copyright 2005 Bryan O'Sullivan.
126 Mercurial is copyright 2005 Matt Mackall.
127 Free use of this software is granted under the terms of the GNU General
128 Public License (GPL).