Mercurial > hg
annotate doc/hgrc.5.txt @ 8766:b2059435f176
man pages: mark filenames and env vars as fixed text
author | Martin Geisler <mg@lazybytes.net> |
---|---|
date | Tue, 09 Jun 2009 23:08:55 +0200 |
parents | 01f0ddb90342 |
children | b03859265cc4 |
rev | line source |
---|---|
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
1 HGRC(5) |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
2 ======= |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
3 Bryan O'Sullivan <bos@serpentine.com> |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
4 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
5 NAME |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
6 ---- |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
7 hgrc - configuration files for Mercurial |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
8 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
9 SYNOPSIS |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
10 -------- |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
11 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
12 The Mercurial system uses a set of configuration files to control |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
13 aspects of its behaviour. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
14 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
15 FILES |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
16 ----- |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
17 |
1583
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
18 Mercurial reads configuration data from several files, if they exist. |
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
19 The names of these files depend on the system on which Mercurial is |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
20 installed. `*.rc` files from a single directory are read in alphabetical |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
21 order, later ones overriding earlier ones. Where multiple paths are |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
22 given below, settings from later paths override earlier ones. |
951
859de3ebc041
Read global config file /etc/mercurial/hgrc and fix reading hgrc on Windows.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
938
diff
changeset
|
23 |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
24 (Unix) `<install-root>/etc/mercurial/hgrc.d/*.rc`:: |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
25 (Unix) `<install-root>/etc/mercurial/hgrc`:: |
1583
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
26 Per-installation configuration files, searched for in the |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
27 directory where Mercurial is installed. `<install-root>` is the |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
28 parent directory of the hg executable (or symlink) being run. For |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
29 example, if installed in `/shared/tools/bin/hg`, Mercurial will look |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
30 in `/shared/tools/etc/mercurial/hgrc`. Options in these files apply |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
31 to all Mercurial commands executed by any user in any directory. |
1583
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
32 |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
33 (Unix) `/etc/mercurial/hgrc.d/*.rc`:: |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
34 (Unix) `/etc/mercurial/hgrc`:: |
1583
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
35 Per-system configuration files, for the system on which Mercurial |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
36 is running. Options in these files apply to all Mercurial commands |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
37 executed by any user in any directory. Options in these files |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
38 override per-installation options. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
39 |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
40 (Windows) `<install-dir>\Mercurial.ini`:: |
6310
1a13a5bbbbc1
make hgrc man page tell about ~/.hgrc on Windows
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
6302
diff
changeset
|
41 or else:: |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
42 (Windows) `HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`:: |
6310
1a13a5bbbbc1
make hgrc man page tell about ~/.hgrc on Windows
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
6302
diff
changeset
|
43 or else:: |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
44 (Windows) `C:\Mercurial\Mercurial.ini`:: |
6310
1a13a5bbbbc1
make hgrc man page tell about ~/.hgrc on Windows
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
6302
diff
changeset
|
45 Per-installation/system configuration files, for the system on |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
46 which Mercurial is running. Options in these files apply to all |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
47 Mercurial commands executed by any user in any directory. Registry |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
48 keys contain PATH-like strings, every part of which must reference |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
49 a `Mercurial.ini` file or be a directory where `*.rc` files will be |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
50 read. |
6310
1a13a5bbbbc1
make hgrc man page tell about ~/.hgrc on Windows
Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
parents:
6302
diff
changeset
|
51 |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
52 (Unix) `$HOME/.hgrc`:: |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
53 (Windows) `%HOME%\Mercurial.ini`:: |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
54 (Windows) `%HOME%\.hgrc`:: |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
55 (Windows) `%USERPROFILE%\Mercurial.ini`:: |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
56 (Windows) `%USERPROFILE%\.hgrc`:: |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
57 Per-user configuration file(s), for the user running Mercurial. On |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
58 Windows 9x, `%HOME%` is replaced by `%APPDATA%`. |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
59 Options in these files apply to all Mercurial commands executed by |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
60 this user in any directory. Options in thes files override |
1583
32a4e6802864
make mercurial look in more places for config files.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1485
diff
changeset
|
61 per-installation and per-system options. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
62 |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
63 (Unix, Windows) `<repo>/.hg/hgrc`:: |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
64 Per-repository configuration options that only apply in a |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
65 particular repository. This file is not version-controlled, and |
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
66 will not get transferred during a "clone" operation. Options in |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
67 this file override options in all other configuration files. On |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
68 Unix, most of this file will be ignored if it doesn't belong to a |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
69 trusted user or to a trusted group. See the documentation for the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
70 trusted section below for more details. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
71 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
72 SYNTAX |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
73 ------ |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
74 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
75 A configuration file consists of sections, led by a "[section]" header |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
76 and followed by "name: value" entries; "name=value" is also accepted. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
77 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
78 [spam] |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
79 eggs=ham |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
80 green= |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
81 eggs |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
82 |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
83 Each line contains one entry. If the lines that follow are indented, |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
84 they are treated as continuations of that entry. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
85 |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
86 Leading whitespace is removed from values. Empty lines are skipped. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
87 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
88 The optional values can contain format strings which refer to other |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
89 values in the same section, or values in a special DEFAULT section. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
90 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
91 Lines beginning with "#" or ";" are ignored and may be used to provide |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
92 comments. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
93 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
94 SECTIONS |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
95 -------- |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
96 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
97 This section describes the different sections that may appear in a |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
98 Mercurial "hgrc" file, the purpose of each section, its possible keys, |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
99 and their possible values. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
100 |
8655 | 101 [[alias]] |
102 alias:: | |
103 Defines command aliases. | |
104 Aliases allow you to define your own commands in terms of other | |
105 commands (or aliases), optionally including arguments. | |
106 + | |
107 Alias definitions consist of lines of the form: | |
108 + | |
109 <alias> = <command> [<argument]... | |
110 + | |
111 For example, this definition: | |
112 + | |
113 latest = log --limit 5 | |
114 + | |
115 creates a new command `latest` that shows only the five most recent | |
116 changesets. You can define subsequent aliases using earlier ones: | |
117 + | |
118 stable5 = latest -b stable | |
119 + | |
120 *Note*: It is possible to create aliases with the same names as | |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
121 existing commands, which will then override the original definitions. |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
122 This is almost always a bad idea! |
8655 | 123 |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
124 [[auth]] |
8341 | 125 auth:: |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
126 Authentication credentials for HTTP authentication. Each line has |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
127 the following format: |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
128 |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
129 <name>.<argument> = <value> |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
130 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
131 where <name> is used to group arguments into authentication entries. |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
132 Example: |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
133 |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
134 foo.prefix = hg.intevation.org/mercurial |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
135 foo.username = foo |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
136 foo.password = bar |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
137 foo.schemes = http https |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
138 |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
139 Supported arguments: |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
140 |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
141 prefix;; |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
142 Either '*' or a URI prefix with or without the scheme part. The |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
143 authentication entry with the longest matching prefix is used |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
144 (where '*' matches everything and counts as a match of length 1). |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
145 If the prefix doesn't include a scheme, the match is performed |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
146 against the URI with its scheme stripped as well, and the schemes |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
147 argument, q.v., is then subsequently consulted. |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
148 username;; |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
149 Username to authenticate with. |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
150 password;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
151 Optional. Password to authenticate with. If not given the user |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
152 will be prompted for it. |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
153 schemes;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
154 Optional. Space separated list of URI schemes to use this |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
155 authentication entry with. Only used if the prefix doesn't include |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
156 a scheme. Supported schemes are http and https. They will match |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
157 static-http and static-https respectively, as well. |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
158 Default: https. |
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
159 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
160 If no suitable authentication entry is found, the user is prompted |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
161 for credentials as usual if required by the remote. |
8333
89c80c3dc584
allow http authentication information to be specified in the configuration
Sune Foldager <cryo@cyanite.org>
parents:
8024
diff
changeset
|
162 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
163 [[decode]] |
1308
2073e5a71008
Cleanup of tabs and trailing spaces.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
1258
diff
changeset
|
164 decode/encode:: |
1258 | 165 Filters for transforming files on checkout/checkin. This would |
166 typically be used for newline processing or other | |
167 localization/canonicalization of files. | |
168 | |
169 Filters consist of a filter pattern followed by a filter command. | |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
170 Filter patterns are globs by default, rooted at the repository root. |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
171 For example, to match any file ending in ".txt" in the root |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
172 directory only, use the pattern "*.txt". To match any file ending in |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
173 ".c" anywhere in the repository, use the pattern "**.c". |
1258 | 174 |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
175 The filter command can start with a specifier, either "pipe:" or |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
176 "tempfile:". If no specifier is given, "pipe:" is used by default. |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
177 |
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
178 A "pipe:" command must accept data on stdin and return the |
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
179 transformed data on stdout. |
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
180 |
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
181 Pipe example: |
1258 | 182 |
183 [encode] | |
184 # uncompress gzip files on checkin to improve delta compression | |
185 # note: not necessarily a good idea, just an example | |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
186 *.gz = pipe: gunzip |
1258 | 187 |
188 [decode] | |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
189 # recompress gzip files when writing them to the working dir (we |
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
190 # can safely omit "pipe:", because it's the default) |
1258 | 191 *.gz = gzip |
192 | |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
193 A "tempfile:" command is a template. The string INFILE is replaced |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
194 with the name of a temporary file that contains the data to be |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
195 filtered by the command. The string OUTFILE is replaced with the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
196 name of an empty temporary file, where the filtered data must be |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
197 written by the command. |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
198 |
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
199 NOTE: the tempfile mechanism is recommended for Windows systems, |
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
200 where the standard shell I/O redirection operators often have |
5678
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
201 strange effects and may corrupt the contents of your files. |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
202 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
203 The most common usage is for LF <-> CRLF translation on Windows. For |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
204 this, use the "smart" convertors which check for binary files: |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
205 |
5678
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
206 [extensions] |
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
207 hgext.win32text = |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
208 [encode] |
5678
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
209 ** = cleverencode: |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
210 [decode] |
5678
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
211 ** = cleverdecode: |
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
212 |
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
213 or if you only want to translate certain files: |
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
214 |
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
215 [extensions] |
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
216 hgext.win32text = |
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
217 [encode] |
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
218 **.txt = dumbencode: |
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
219 [decode] |
d3909674fcea
man 5 hgrc implied you need to use external tools to do CRLF translation.
Jesse Glick <jesse.glick@sun.com>
parents:
5634
diff
changeset
|
220 **.txt = dumbdecode: |
1293
a6ffcebd3315
Enhance the file filtering capabilities.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1258
diff
changeset
|
221 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
222 [[defaults]] |
3039
77637938d43d
add document on command defaults
TK Soh <teekaysoh@yahoo.com>
parents:
3021
diff
changeset
|
223 defaults:: |
5081
ea7b982b6c08
Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4717
diff
changeset
|
224 Use the [defaults] section to define command defaults, i.e. the |
3039
77637938d43d
add document on command defaults
TK Soh <teekaysoh@yahoo.com>
parents:
3021
diff
changeset
|
225 default options/arguments to pass to the specified commands. |
5081
ea7b982b6c08
Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4717
diff
changeset
|
226 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
227 The following example makes 'hg log' run in verbose mode, and 'hg |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
228 status' show only the modified files, by default. |
5081
ea7b982b6c08
Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4717
diff
changeset
|
229 |
3039
77637938d43d
add document on command defaults
TK Soh <teekaysoh@yahoo.com>
parents:
3021
diff
changeset
|
230 [defaults] |
77637938d43d
add document on command defaults
TK Soh <teekaysoh@yahoo.com>
parents:
3021
diff
changeset
|
231 log = -v |
77637938d43d
add document on command defaults
TK Soh <teekaysoh@yahoo.com>
parents:
3021
diff
changeset
|
232 status = -m |
5081
ea7b982b6c08
Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4717
diff
changeset
|
233 |
ea7b982b6c08
Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4717
diff
changeset
|
234 The actual commands, instead of their aliases, must be used when |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
235 defining command defaults. The command defaults will also be applied |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
236 to the aliases of the commands defined. |
3039
77637938d43d
add document on command defaults
TK Soh <teekaysoh@yahoo.com>
parents:
3021
diff
changeset
|
237 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
238 [[diff]] |
4011
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
239 diff:: |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
240 Settings used when displaying diffs. They are all boolean and |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
241 defaults to False. |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
242 git;; |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
243 Use git extended diff format. |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
244 nodates;; |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
245 Don't include dates in diff headers. |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
246 showfunc;; |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
247 Show which function each change is in. |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
248 ignorews;; |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
249 Ignore white space when comparing lines. |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
250 ignorewsamount;; |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
251 Ignore changes in the amount of white space. |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
252 ignoreblanklines;; |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
253 Ignore changes whose lines are all blank. |
15955d84bc68
add [diff] section to hgrc documentation
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
3835
diff
changeset
|
254 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
255 [[email]] |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
256 email:: |
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
257 Settings for extensions that send email messages. |
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
258 from;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
259 Optional. Email address to use in "From" header and SMTP envelope |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
260 of outgoing messages. |
2680
d071a9cc2f94
added documentation for to, cc, and bcc addressing
Christian Ebert <blacktrash@gmx.net>
parents:
2678
diff
changeset
|
261 to;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
262 Optional. Comma-separated list of recipients' email addresses. |
2680
d071a9cc2f94
added documentation for to, cc, and bcc addressing
Christian Ebert <blacktrash@gmx.net>
parents:
2678
diff
changeset
|
263 cc;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
264 Optional. Comma-separated list of carbon copy recipients' |
2691
accadcb4e4b5
email: reflect that recipients are specified as comma-separated list
Christian Ebert <blacktrash@gmx.net>
parents:
2680
diff
changeset
|
265 email addresses. |
2680
d071a9cc2f94
added documentation for to, cc, and bcc addressing
Christian Ebert <blacktrash@gmx.net>
parents:
2678
diff
changeset
|
266 bcc;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
267 Optional. Comma-separated list of blind carbon copy recipients' |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
268 email addresses. Cannot be set interactively. |
2292
903ab41ac7eb
allow to send email using sendmail.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2288
diff
changeset
|
269 method;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
270 Optional. Method to use to send email messages. If value is "smtp" |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
271 (default), use SMTP (see section "[smtp]" for configuration). |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
272 Otherwise, use as name of program to run that acts like sendmail |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
273 (takes "-f" option for sender, list of recipients on command line, |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
274 message on stdin). Normally, setting this to "sendmail" or |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
275 "/usr/sbin/sendmail" is enough to use sendmail to send messages. |
7117
ceb8aef03aa7
Document email.charsets in hgrc.5
Christian Ebert <blacktrash@gmx.net>
parents:
6862
diff
changeset
|
276 charsets;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
277 Optional. Comma-separated list of charsets considered convenient |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
278 for recipients. Addresses, headers, and parts not containing |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
279 patches of outgoing messages will be encoded in the first charset |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
280 to which conversion from local encoding (`$HGENCODING`, |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
281 `ui.fallbackencoding`) succeeds. If correct conversion fails, the |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
282 text in question is sent as is. Defaults to empty (explicit) list. |
7241
421f4cbddd68
hgrc.5: explain order of mail.charsets
Christian Ebert <blacktrash@gmx.net>
parents:
7235
diff
changeset
|
283 |
421f4cbddd68
hgrc.5: explain order of mail.charsets
Christian Ebert <blacktrash@gmx.net>
parents:
7235
diff
changeset
|
284 Order of outgoing email charsets: |
421f4cbddd68
hgrc.5: explain order of mail.charsets
Christian Ebert <blacktrash@gmx.net>
parents:
7235
diff
changeset
|
285 |
421f4cbddd68
hgrc.5: explain order of mail.charsets
Christian Ebert <blacktrash@gmx.net>
parents:
7235
diff
changeset
|
286 us-ascii always first, regardless of settings |
421f4cbddd68
hgrc.5: explain order of mail.charsets
Christian Ebert <blacktrash@gmx.net>
parents:
7235
diff
changeset
|
287 email.charsets in order given by user |
421f4cbddd68
hgrc.5: explain order of mail.charsets
Christian Ebert <blacktrash@gmx.net>
parents:
7235
diff
changeset
|
288 ui.fallbackencoding if not in email.charsets |
7499
613f3c88a388
hgrc 5: fix email.charsets documentation
Christian Ebert <blacktrash@gmx.net>
parents:
7336
diff
changeset
|
289 $HGENCODING if not in email.charsets |
7241
421f4cbddd68
hgrc.5: explain order of mail.charsets
Christian Ebert <blacktrash@gmx.net>
parents:
7235
diff
changeset
|
290 utf-8 always last, regardless of settings |
2292
903ab41ac7eb
allow to send email using sendmail.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2288
diff
changeset
|
291 |
903ab41ac7eb
allow to send email using sendmail.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2288
diff
changeset
|
292 Email example: |
903ab41ac7eb
allow to send email using sendmail.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2288
diff
changeset
|
293 |
903ab41ac7eb
allow to send email using sendmail.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2288
diff
changeset
|
294 [email] |
903ab41ac7eb
allow to send email using sendmail.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2288
diff
changeset
|
295 from = Joseph User <joe.user@example.com> |
903ab41ac7eb
allow to send email using sendmail.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2288
diff
changeset
|
296 method = /usr/sbin/sendmail |
7117
ceb8aef03aa7
Document email.charsets in hgrc.5
Christian Ebert <blacktrash@gmx.net>
parents:
6862
diff
changeset
|
297 # charsets for western europeans |
ceb8aef03aa7
Document email.charsets in hgrc.5
Christian Ebert <blacktrash@gmx.net>
parents:
6862
diff
changeset
|
298 # us-ascii, utf-8 omitted, as they are tried first and last |
ceb8aef03aa7
Document email.charsets in hgrc.5
Christian Ebert <blacktrash@gmx.net>
parents:
6862
diff
changeset
|
299 charsets = iso-8859-1, iso-8859-15, windows-1252 |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
300 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
301 [[extensions]] |
2211
b8b7a79a4d88
document [extensions] in doc/hgrc.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2209
diff
changeset
|
302 extensions:: |
b8b7a79a4d88
document [extensions] in doc/hgrc.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2209
diff
changeset
|
303 Mercurial has an extension mechanism for adding new features. To |
b8b7a79a4d88
document [extensions] in doc/hgrc.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2209
diff
changeset
|
304 enable an extension, create an entry for it in this section. |
b8b7a79a4d88
document [extensions] in doc/hgrc.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2209
diff
changeset
|
305 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
306 If you know that the extension is already in Python's search path, |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
307 you can give the name of the module, followed by "=", with nothing |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
308 after the "=". |
2211
b8b7a79a4d88
document [extensions] in doc/hgrc.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2209
diff
changeset
|
309 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
310 Otherwise, give a name that you choose, followed by "=", followed by |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
311 the path to the ".py" file (including the file name extension) that |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
312 defines the extension. |
2211
b8b7a79a4d88
document [extensions] in doc/hgrc.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2209
diff
changeset
|
313 |
6175
7f9f3233a2c6
add explicit extension disabling syntax to hgrc.5
Steve Borho <steve@borho.org>
parents:
6142
diff
changeset
|
314 To explicitly disable an extension that is enabled in an hgrc of |
6210
942287cb1f57
Removed trailing spaces from everything except test output
Thomas Arendsen Hein <thomas@intevation.de>
parents:
6183
diff
changeset
|
315 broader scope, prepend its path with '!', as in |
8727 | 316 'hgext.foo = !/ext/path' or 'hgext.foo = !' when path is not |
8726
72b95e3a0cc9
hgrc.5: wrap manpage at 80 chars
Christian Ebert <blacktrash@gmx.net>
parents:
8655
diff
changeset
|
317 supplied. |
6175
7f9f3233a2c6
add explicit extension disabling syntax to hgrc.5
Steve Borho <steve@borho.org>
parents:
6142
diff
changeset
|
318 |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
319 Example for `~/.hgrc`: |
2387
62ce297f214f
Expand '~' in path to extensions.
Markus F.X.J. Oberhumer <markus@oberhumer.com>
parents:
2358
diff
changeset
|
320 |
62ce297f214f
Expand '~' in path to extensions.
Markus F.X.J. Oberhumer <markus@oberhumer.com>
parents:
2358
diff
changeset
|
321 [extensions] |
62ce297f214f
Expand '~' in path to extensions.
Markus F.X.J. Oberhumer <markus@oberhumer.com>
parents:
2358
diff
changeset
|
322 # (the mq extension will get loaded from mercurial's path) |
62ce297f214f
Expand '~' in path to extensions.
Markus F.X.J. Oberhumer <markus@oberhumer.com>
parents:
2358
diff
changeset
|
323 hgext.mq = |
62ce297f214f
Expand '~' in path to extensions.
Markus F.X.J. Oberhumer <markus@oberhumer.com>
parents:
2358
diff
changeset
|
324 # (this extension will get loaded from the file specified) |
62ce297f214f
Expand '~' in path to extensions.
Markus F.X.J. Oberhumer <markus@oberhumer.com>
parents:
2358
diff
changeset
|
325 myfeature = ~/.hgext/myfeature.py |
62ce297f214f
Expand '~' in path to extensions.
Markus F.X.J. Oberhumer <markus@oberhumer.com>
parents:
2358
diff
changeset
|
326 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
327 [[format]] |
4163
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
328 format:: |
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
329 |
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
330 usestore;; |
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
331 Enable or disable the "store" repository format which improves |
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
332 compatibility with systems that fold case or otherwise mangle |
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
333 filenames. Enabled by default. Disabling this option will allow |
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
334 you to store longer filenames in some situations at the expense of |
7235
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
335 compatibility and ensures that the on-disk format of newly created |
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
336 repositories will be compatible with Mercurial before version 0.9.4. |
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
337 |
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
338 usefncache;; |
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
339 Enable or disable the "fncache" repository format which enhances |
7488a1f14e3c
Document config option format.usefncache and improve format.usestore docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
7117
diff
changeset
|
340 the "store" repository format (which has to be enabled to use |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
341 fncache) to allow longer filenames and avoids using Windows |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
342 reserved names, e.g. "nul". Enabled by default. Disabling this |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
343 option ensures that the on-disk format of newly created |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
344 repositories will be compatible with Mercurial before version 1.1. |
4163
fe41d9a186ab
Allow disabling store format to work with absurdly long filenames
Matt Mackall <mpm@selenic.com>
parents:
4084
diff
changeset
|
345 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
346 [[merge-patterns]] |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
347 merge-patterns:: |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
348 This section specifies merge tools to associate with particular file |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
349 patterns. Tools matched here will take precedence over the default |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
350 merge tool. Patterns are globs by default, rooted at the repository |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
351 root. |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
352 |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
353 Example: |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
354 |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
355 [merge-patterns] |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
356 **.c = kdiff3 |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
357 **.jpg = myimgmerge |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
358 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
359 [[merge-tools]] |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
360 merge-tools:: |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
361 This section configures external merge tools to use for file-level |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
362 merges. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
363 |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
364 Example `~/.hgrc`: |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
365 |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
366 [merge-tools] |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
367 # Override stock tool location |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
368 kdiff3.executable = ~/bin/kdiff3 |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
369 # Specify command line |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
370 kdiff3.args = $base $local $other -o $output |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
371 # Give higher priority |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
372 kdiff3.priority = 1 |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
373 |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
374 # Define new tool |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
375 myHtmlTool.args = -m $local $other $base $output |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
376 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
377 myHtmlTool.priority = 1 |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
378 |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
379 Supported arguments: |
6445
a1db3d8b9b8a
hgrc.5: fix subsection formatting
Christian Ebert <blacktrash@gmx.net>
parents:
6325
diff
changeset
|
380 |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
381 priority;; |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
382 The priority in which to evaluate this tool. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
383 Default: 0. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
384 executable;; |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
385 Either just the name of the executable or its pathname. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
386 Default: the tool name. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
387 args;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
388 The arguments to pass to the tool executable. You can refer to the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
389 files being merged as well as the output file through these |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
390 variables: `$base`, `$local`, `$other`, `$output`. |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
391 Default: `$local $base $other` |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
392 premerge;; |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
393 Attempt to run internal non-interactive 3-way merge tool before |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
394 launching external tool. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
395 Default: True |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
396 binary;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
397 This tool can merge binary files. Defaults to False, unless tool |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
398 was selected by file pattern match. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
399 symlink;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
400 This tool can merge symlinks. Defaults to False, even if tool was |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
401 selected by file pattern match. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
402 checkconflicts;; |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
403 Check whether there are conflicts even though the tool reported |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
404 success. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
405 Default: False |
6075
63e0e57ab157
filemerge: add 'checkchanged' merge tool property
Steve Borho <steve@borho.org>
parents:
6010
diff
changeset
|
406 checkchanged;; |
63e0e57ab157
filemerge: add 'checkchanged' merge tool property
Steve Borho <steve@borho.org>
parents:
6010
diff
changeset
|
407 Check whether outputs were written even though the tool reported |
63e0e57ab157
filemerge: add 'checkchanged' merge tool property
Steve Borho <steve@borho.org>
parents:
6010
diff
changeset
|
408 success. |
63e0e57ab157
filemerge: add 'checkchanged' merge tool property
Steve Borho <steve@borho.org>
parents:
6010
diff
changeset
|
409 Default: False |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
410 fixeol;; |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
411 Attempt to fix up EOL changes caused by the merge tool. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
412 Default: False |
6445
a1db3d8b9b8a
hgrc.5: fix subsection formatting
Christian Ebert <blacktrash@gmx.net>
parents:
6325
diff
changeset
|
413 gui;; |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
414 This tool requires a graphical interface to run. Default: False |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
415 regkey;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
416 Windows registry key which describes install location of this |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
417 tool. Mercurial will search for this key first under |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
418 `HKEY_CURRENT_USER` and then under `HKEY_LOCAL_MACHINE`. |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
419 Default: None |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
420 regname;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
421 Name of value to read from specified registry key. Defaults to the |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
422 unnamed (default) value. |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
423 regappend;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
424 String to append to the value read from the registry, typically |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
425 the executable name of the tool. |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
426 Default: None |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
427 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
428 [[hooks]] |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
429 hooks:: |
2155
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
430 Commands or Python functions that get automatically executed by |
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
431 various actions such as starting or finishing a commit. Multiple |
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
432 hooks can be run for the same action by appending a suffix to the |
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
433 action. Overriding a site-wide hook can be done by changing its |
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
434 value or setting it to an empty string. |
1485
625f3f13d7be
mention running multiple hooks in the doc
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1316
diff
changeset
|
435 |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
436 Example `.hg/hgrc`: |
1485
625f3f13d7be
mention running multiple hooks in the doc
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1316
diff
changeset
|
437 |
625f3f13d7be
mention running multiple hooks in the doc
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1316
diff
changeset
|
438 [hooks] |
625f3f13d7be
mention running multiple hooks in the doc
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1316
diff
changeset
|
439 # do not use the site-wide hook |
1714
eabfbd220f39
fix hgrc doc hook descriptions.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1583
diff
changeset
|
440 incoming = |
eabfbd220f39
fix hgrc doc hook descriptions.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1583
diff
changeset
|
441 incoming.email = /my/email/hook |
eabfbd220f39
fix hgrc doc hook descriptions.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1583
diff
changeset
|
442 incoming.autobuild = /my/build/hook |
1485
625f3f13d7be
mention running multiple hooks in the doc
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1316
diff
changeset
|
443 |
8727 | 444 Most hooks are run with environment variables set that give useful |
445 additional information. For each hook below, the environment | |
446 variables it is passed are listed with names of the form "$HG_foo". | |
1727
019e6a47a53e
fix names of parent changeset ids in hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1726
diff
changeset
|
447 |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
448 changegroup;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
449 Run after a changegroup has been added via push, pull or unbundle. |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
450 ID of the first new changeset is in `$HG_NODE`. URL from which |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
451 changes came is in `$HG_URL`. |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
452 commit;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
453 Run after a changeset has been created in the local repository. ID |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
454 of the newly created changeset is in `$HG_NODE`. Parent changeset |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
455 IDs are in `$HG_PARENT1` and `$HG_PARENT2`. |
1714
eabfbd220f39
fix hgrc doc hook descriptions.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1583
diff
changeset
|
456 incoming;; |
eabfbd220f39
fix hgrc doc hook descriptions.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1583
diff
changeset
|
457 Run after a changeset has been pulled, pushed, or unbundled into |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
458 the local repository. The ID of the newly arrived changeset is in |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
459 `$HG_NODE`. URL that was source of changes came is in `$HG_URL`. |
1736
50de0887bbcd
add preoutgoing and outgoing hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1734
diff
changeset
|
460 outgoing;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
461 Run after sending changes from local repository to another. ID of |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
462 first changeset sent is in `$HG_NODE`. Source of operation is in |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
463 `$HG_SOURCE`; see "preoutgoing" hook for description. |
4715
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
464 post-<command>;; |
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
465 Run after successful invocations of the associated command. The |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
466 contents of the command line are passed as `$HG_ARGS` and the result |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
467 code in `$HG_RESULT`. Hook failure is ignored. |
4715
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
468 pre-<command>;; |
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
469 Run before executing the associated command. The contents of the |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
470 command line are passed as `$HG_ARGS`. If the hook returns failure, |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
471 the command doesn't execute and Mercurial returns the failure |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
472 code. |
1730
0f1d2c75db5e
add prechangegroup and pretxnchangegroup hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1721
diff
changeset
|
473 prechangegroup;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
474 Run before a changegroup is added via push, pull or unbundle. Exit |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
475 status 0 allows the changegroup to proceed. Non-zero status will |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
476 cause the push, pull or unbundle to fail. URL from which changes |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
477 will come is in `$HG_URL`. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
478 precommit;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
479 Run before starting a local commit. Exit status 0 allows the |
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
480 commit to proceed. Non-zero status will cause the commit to fail. |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
481 Parent changeset IDs are in `$HG_PARENT1` and `$HG_PARENT2`. |
1736
50de0887bbcd
add preoutgoing and outgoing hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1734
diff
changeset
|
482 preoutgoing;; |
5634
2f74cfa29e8c
doc: correct preoutgoing description
Matt Mackall <mpm@selenic.com>
parents:
5583
diff
changeset
|
483 Run before collecting changes to send from the local repository to |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
484 another. Non-zero status will cause failure. This lets you prevent |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
485 pull over http or ssh. Also prevents against local pull, push |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
486 (outbound) or bundle commands, but not effective, since you can |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
487 just copy files instead then. Source of operation is in |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
488 `$HG_SOURCE`. If "serve", operation is happening on behalf of remote |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
489 ssh or http repository. If "push", "pull" or "bundle", operation |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
490 is happening on behalf of repository on same system. |
1720
55017891051b
add pretag and tag hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1714
diff
changeset
|
491 pretag;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
492 Run before creating a tag. Exit status 0 allows the tag to be |
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
493 created. Non-zero status will cause the tag to fail. ID of |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
494 changeset to tag is in `$HG_NODE`. Name of tag is in `$HG_TAG`. Tag is |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
495 local if `$HG_LOCAL=1`, in repo if `$HG_LOCAL=0`. |
1730
0f1d2c75db5e
add prechangegroup and pretxnchangegroup hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1721
diff
changeset
|
496 pretxnchangegroup;; |
0f1d2c75db5e
add prechangegroup and pretxnchangegroup hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1721
diff
changeset
|
497 Run after a changegroup has been added via push, pull or unbundle, |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
498 but before the transaction has been committed. Changegroup is |
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
499 visible to hook program. This lets you validate incoming changes |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
500 before accepting them. Passed the ID of the first new changeset in |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
501 `$HG_NODE`. Exit status 0 allows the transaction to commit. Non-zero |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
502 status will cause the transaction to be rolled back and the push, |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
503 pull or unbundle will fail. URL that was source of changes is in |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
504 `$HG_URL`. |
1721
801756d0ca84
add pretxncommit hook.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1720
diff
changeset
|
505 pretxncommit;; |
801756d0ca84
add pretxncommit hook.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1720
diff
changeset
|
506 Run after a changeset has been created but the transaction not yet |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
507 committed. Changeset is visible to hook program. This lets you |
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
508 validate commit message and changes. Exit status 0 allows the |
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
509 commit to proceed. Non-zero status will cause the transaction to |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
510 be rolled back. ID of changeset is in `$HG_NODE`. Parent changeset |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
511 IDs are in `$HG_PARENT1` and `$HG_PARENT2`. |
2266
3f7692b0ff13
hooks: add preupdate and update hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2211
diff
changeset
|
512 preupdate;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
513 Run before updating the working directory. Exit status 0 allows |
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
514 the update to proceed. Non-zero status will prevent the update. |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
515 Changeset ID of first new parent is in `$HG_PARENT1`. If merge, ID |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
516 of second new parent is in `$HG_PARENT2`. |
1720
55017891051b
add pretag and tag hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1714
diff
changeset
|
517 tag;; |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
518 Run after a tag is created. ID of tagged changeset is in `$HG_NODE`. |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
519 Name of tag is in `$HG_TAG`. Tag is local if `$HG_LOCAL=1`, in repo if |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
520 `$HG_LOCAL=0`. |
2266
3f7692b0ff13
hooks: add preupdate and update hooks.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2211
diff
changeset
|
521 update;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
522 Run after updating the working directory. Changeset ID of first |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
523 new parent is in `$HG_PARENT1`. If merge, ID of second new parent is |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
524 in `$HG_PARENT2`. If the update succeeded, `$HG_ERROR=0`. If the |
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
525 update failed (e.g. because conflicts not resolved), `$HG_ERROR=1`. |
1726
56fb048b102c
prefix hook env var names with HG_.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1721
diff
changeset
|
526 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
527 Note: it is generally better to use standard hooks rather than the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
528 generic pre- and post- command hooks as they are guaranteed to be |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
529 called in the appropriate contexts for influencing transactions. |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
530 Also, hooks like "commit" will be called in all contexts that |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
531 generate a commit (e.g. tag) and not just the commit command. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
532 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
533 Note2: Environment variables with empty values may not be passed to |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
534 hooks on platforms such as Windows. As an example, `$HG_PARENT2` will |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
535 have an empty value under Unix-like platforms for non-merge |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
536 changesets, while it will not be available at all under Windows. |
4641
54b735135fd3
Document empty environment variables not being passed to hooks under Windows.
Patrick Mezard <pmezard@gmail.com>
parents:
4052
diff
changeset
|
537 |
2155
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
538 The syntax for Python hooks is as follows: |
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
539 |
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
540 hookname = python:modulename.submodule.callable |
7916
f779e1996e23
ability to load hooks from arbitrary python module
Alexander Solovyov <piranha@piranha.org.ua>
parents:
7499
diff
changeset
|
541 hookname = python:/path/to/python/module.py:callable |
2155
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
542 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
543 Python hooks are run within the Mercurial process. Each hook is |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
544 called with at least three keyword arguments: a ui object (keyword |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
545 "ui"), a repository object (keyword "repo"), and a "hooktype" |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
546 keyword that tells what kind of hook is used. Arguments listed as |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
547 environment variables above are passed as keyword arguments, with no |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
548 "HG_" prefix, and names in lower case. |
2155
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
549 |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
550 If a Python hook returns a "true" value or raises an exception, this |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
551 is treated as a failure. |
2155
ff255b41b4aa
support hooks written in python.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2003
diff
changeset
|
552 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
553 [[http_proxy]] |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
554 http_proxy:: |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
555 Used to access web-based Mercurial repositories through a HTTP |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
556 proxy. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
557 host;; |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
558 Host name and (optional) port of the proxy server, for example |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
559 "myproxy:8000". |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
560 no;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
561 Optional. Comma-separated list of host names that should bypass |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
562 the proxy. |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
563 passwd;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
564 Optional. Password to authenticate with at the proxy server. |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
565 user;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
566 Optional. User name to authenticate with at the proxy server. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
567 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
568 [[smtp]] |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
569 smtp:: |
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
570 Configuration for extensions that need to send email messages. |
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
571 host;; |
2853
619f1c65384c
Adjusted documentation for hgrc's "[smtp] host" for change in 9f745d3675d4.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
2691
diff
changeset
|
572 Host name of mail server, e.g. "mail.example.com". |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
573 port;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
574 Optional. Port to connect to on mail server. Default: 25. |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
575 tls;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
576 Optional. Whether to connect to mail server using TLS. True or |
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
577 False. Default: False. |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
578 username;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
579 Optional. User name to authenticate to SMTP server with. If |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
580 username is specified, password must also be specified. |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
581 Default: none. |
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
582 password;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
583 Optional. Password to authenticate to SMTP server with. If |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
584 username is specified, password must also be specified. |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
585 Default: none. |
2583
6e5427447f4c
adding local_hostname option to smtp configuration
Valentino Volonghi aka dialtone <dialtone@divmod.com>
parents:
2466
diff
changeset
|
586 local_hostname;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
587 Optional. It's the hostname that the sender can use to identify |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
588 itself to the MTA. |
2200
9f43b6e24232
move mail sending code into core, so extensions can share it.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2197
diff
changeset
|
589 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
590 [[paths]] |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
591 paths:: |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
592 Assigns symbolic names to repositories. The left side is the |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
593 symbolic name, and the right gives the directory or URL that is the |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
594 location of the repository. Default paths can be declared by setting |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
595 the following entries. |
2277
066d0055e430
Add more specific documentation about defaults for the [paths] section
Daniel <byteshack@gmail.com>
parents:
2266
diff
changeset
|
596 default;; |
066d0055e430
Add more specific documentation about defaults for the [paths] section
Daniel <byteshack@gmail.com>
parents:
2266
diff
changeset
|
597 Directory or URL to use when pulling if no source is specified. |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
598 Default is set to repository from which the current repository was |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
599 cloned. |
2277
066d0055e430
Add more specific documentation about defaults for the [paths] section
Daniel <byteshack@gmail.com>
parents:
2266
diff
changeset
|
600 default-push;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
601 Optional. Directory or URL to use when pushing if no destination |
2277
066d0055e430
Add more specific documentation about defaults for the [paths] section
Daniel <byteshack@gmail.com>
parents:
2266
diff
changeset
|
602 is specified. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
603 |
8022
4f3fdfaa3874
profiling: Adding profiling.output config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
7916
diff
changeset
|
604 [[profiling]] |
4f3fdfaa3874
profiling: Adding profiling.output config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
7916
diff
changeset
|
605 profiling:: |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
606 Specifies profiling format and file output. In this section |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
607 description, 'profiling data' stands for the raw data collected |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
608 during profiling, while 'profiling report' stands for a statistical |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
609 text report generated from the profiling data. The profiling is done |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
610 using lsprof. |
8023
fd9debb3ea1b
profiling: Adding a profiling.format config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
8022
diff
changeset
|
611 format;; |
fd9debb3ea1b
profiling: Adding a profiling.format config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
8022
diff
changeset
|
612 Profiling format. |
fd9debb3ea1b
profiling: Adding a profiling.format config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
8022
diff
changeset
|
613 Default: text. |
fd9debb3ea1b
profiling: Adding a profiling.format config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
8022
diff
changeset
|
614 text;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
615 Generate a profiling report. When saving to a file, it should be |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
616 noted that only the report is saved, and the profiling data is |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
617 not kept. |
8024
9a1b86cfd29e
profiling: Adding support for kcachegrind output format, using lsprofcalltree
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
8023
diff
changeset
|
618 kcachegrind;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
619 Format profiling data for kcachegrind use: when saving to a |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
620 file, the generated file can directly be loaded into |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
621 kcachegrind. |
8022
4f3fdfaa3874
profiling: Adding profiling.output config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
7916
diff
changeset
|
622 output;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
623 File path where profiling data or report should be saved. If the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
624 file exists, it is replaced. Default: None, data is printed on |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
625 stderr |
8022
4f3fdfaa3874
profiling: Adding profiling.output config variable
Nicolas Dumazet <nicdumz.commits@gmail.com>
parents:
7916
diff
changeset
|
626 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
627 [[server]] |
2621
5a5852a417b1
clone: disable stream support on server side by default.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2583
diff
changeset
|
628 server:: |
5a5852a417b1
clone: disable stream support on server side by default.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2583
diff
changeset
|
629 Controls generic server settings. |
2622
064aef9162cc
rename stream hgrc option to compressed.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2621
diff
changeset
|
630 uncompressed;; |
2621
5a5852a417b1
clone: disable stream support on server side by default.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2583
diff
changeset
|
631 Whether to allow clients to clone a repo using the uncompressed |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
632 streaming protocol. This transfers about 40% more data than a |
2621
5a5852a417b1
clone: disable stream support on server side by default.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2583
diff
changeset
|
633 regular clone, but uses less memory and CPU on both server and |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
634 client. Over a LAN (100Mbps or better) or a very fast WAN, an |
2621
5a5852a417b1
clone: disable stream support on server side by default.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2583
diff
changeset
|
635 uncompressed streaming clone is a lot faster (~10x) than a regular |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
636 clone. Over most WAN connections (anything slower than about |
2621
5a5852a417b1
clone: disable stream support on server side by default.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2583
diff
changeset
|
637 6Mbps), uncompressed streaming is slower, because of the extra |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
638 data transfer overhead. Default is False. |
2621
5a5852a417b1
clone: disable stream support on server side by default.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2583
diff
changeset
|
639 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
640 [[trusted]] |
3551
3b07e223534b
Only read .hg/hgrc files from trusted users/groups
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3489
diff
changeset
|
641 trusted:: |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
642 For security reasons, Mercurial will not use the settings in the |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
643 `.hg/hgrc` file from a repository if it doesn't belong to a trusted |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
644 user or to a trusted group. The main exception is the web interface, |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
645 which automatically uses some safe settings, since it's common to |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
646 serve repositories from different users. |
3552
9b52239dc740
save settings from untrusted config files in a separate configparser
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3551
diff
changeset
|
647 |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
648 This section specifies what users and groups are trusted. The |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
649 current user is always trusted. To trust everybody, list a user or a |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
650 group with name "*". |
3552
9b52239dc740
save settings from untrusted config files in a separate configparser
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3551
diff
changeset
|
651 |
3551
3b07e223534b
Only read .hg/hgrc files from trusted users/groups
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3489
diff
changeset
|
652 users;; |
3b07e223534b
Only read .hg/hgrc files from trusted users/groups
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3489
diff
changeset
|
653 Comma-separated list of trusted users. |
3b07e223534b
Only read .hg/hgrc files from trusted users/groups
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3489
diff
changeset
|
654 groups;; |
3b07e223534b
Only read .hg/hgrc files from trusted users/groups
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3489
diff
changeset
|
655 Comma-separated list of trusted groups. |
3b07e223534b
Only read .hg/hgrc files from trusted users/groups
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3489
diff
changeset
|
656 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
657 [[ui]] |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
658 ui:: |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
659 User interface controls. |
6183
0750e4ba9d3d
Add config option to disable putting .hg_archival.txt inside archives.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
6175
diff
changeset
|
660 archivemeta;; |
0750e4ba9d3d
Add config option to disable putting .hg_archival.txt inside archives.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
6175
diff
changeset
|
661 Whether to include the .hg_archival.txt file containing metadata |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
662 (hashes for the repository base and for tip) in archives created |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
663 by the hg archive command or downloaded via hgweb. |
6183
0750e4ba9d3d
Add config option to disable putting .hg_archival.txt inside archives.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
6175
diff
changeset
|
664 Default is true. |
6862
7192876ac329
ui: add an option to prompt for the username when it isn't provided
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
6614
diff
changeset
|
665 askusername;; |
7192876ac329
ui: add an option to prompt for the username when it isn't provided
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
6614
diff
changeset
|
666 Whether to prompt for a username when committing. If True, and |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
667 neither `$HGUSER` nor `$EMAIL` has been specified, then the user will |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
668 be prompted to enter a username. If no username is entered, the |
6862
7192876ac329
ui: add an option to prompt for the username when it isn't provided
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
6614
diff
changeset
|
669 default USER@HOST is used instead. |
7192876ac329
ui: add an option to prompt for the username when it isn't provided
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
6614
diff
changeset
|
670 Default is False. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
671 debug;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
672 Print debugging information. True or False. Default is False. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
673 editor;; |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
674 The editor to use during a commit. Default is `$EDITOR` or "vi". |
3835
d1ce5461beed
Allow the user to specify the fallback encoding for the changelog
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3721
diff
changeset
|
675 fallbackencoding;; |
d1ce5461beed
Allow the user to specify the fallback encoding for the changelog
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
3721
diff
changeset
|
676 Encoding to try if it's not possible to decode the changelog using |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
677 UTF-8. Default is ISO-8859-1. |
2003 | 678 ignore;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
679 A file to read per-user ignore patterns from. This file should be |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
680 in the same format as a repository-wide .hgignore file. This |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
681 option supports hook syntax, so if you want to specify multiple |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
682 ignore files, you can do so by setting something like |
2209
956e329f9e13
document hgignore syntax in new file doc/hgignore.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2200
diff
changeset
|
683 "ignore.other = ~/.hgignore2". For details of the ignore file |
956e329f9e13
document hgignore syntax in new file doc/hgignore.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2200
diff
changeset
|
684 format, see the hgignore(5) man page. |
702
a1099c50a622
Fix default values and add interactive setting to [ui] section of hgrc docs.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
671
diff
changeset
|
685 interactive;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
686 Allow to prompt the user. True or False. Default is True. |
1907
7718885070b1
let commands that show changesets use templates.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1788
diff
changeset
|
687 logtemplate;; |
7718885070b1
let commands that show changesets use templates.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
1788
diff
changeset
|
688 Template string for commands that print changesets. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
689 merge;; |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
690 The conflict resolution program to use during a manual merge. |
6010
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
691 There are some internal tools available: |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
692 |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
693 internal:local;; |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
694 keep the local version |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
695 internal:other;; |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
696 use the other version |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
697 internal:merge;; |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
698 use the internal non-interactive merge tool |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
699 internal:fail;; |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
700 fail to merge |
83d193a513c8
add merge sections to hgrc.5
Steve Borho <steve@borho.org>
parents:
5997
diff
changeset
|
701 |
8727 | 702 For more information on configuring merge tools see the |
703 merge-tools section. | |
6445
a1db3d8b9b8a
hgrc.5: fix subsection formatting
Christian Ebert <blacktrash@gmx.net>
parents:
6325
diff
changeset
|
704 |
4435 | 705 patch;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
706 command to use to apply patches. Look for 'gpatch' or 'patch' in |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
707 PATH if unset. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
708 quiet;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
709 Reduce the amount of output printed. True or False. Default is False. |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
710 remotecmd;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
711 remote command to use for clone/push/pull operations. Default is 'hg'. |
4717
97369f6a6bb6
New config option: ui.report_untrusted (defaults to True)
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4715
diff
changeset
|
712 report_untrusted;; |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
713 Warn if a `.hg/hgrc` file is ignored due to not being owned by a |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
714 trusted user or group. True or False. Default is True. |
4527
b422b558015b
Add ui.slash hgrc setting
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
4435
diff
changeset
|
715 slash;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
716 Display paths using a slash ("/") as the path separator. This only |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
717 makes a difference on systems where the default path separator is |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
718 not the slash character (e.g. Windows uses the backslash character |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
719 ("\")). |
4527
b422b558015b
Add ui.slash hgrc setting
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
4435
diff
changeset
|
720 Default is False. |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
721 ssh;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
722 command to use for SSH connections. Default is 'ssh'. |
2988
63c3a1921a67
Add ui.strict config item.
Bryan O'Sullivan <bos@serpentine.com>
parents:
2853
diff
changeset
|
723 strict;; |
63c3a1921a67
Add ui.strict config item.
Bryan O'Sullivan <bos@serpentine.com>
parents:
2853
diff
changeset
|
724 Require exact command names, instead of allowing unambiguous |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
725 abbreviations. True or False. Default is False. |
4715
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
726 style;; |
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
727 Name of style to use for command output. |
1787
e431344e604c
add a timeout when a lock is held (default 1024 sec)
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1736
diff
changeset
|
728 timeout;; |
e431344e604c
add a timeout when a lock is held (default 1024 sec)
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1736
diff
changeset
|
729 The timeout used when a lock is held (in seconds), a negative value |
1788
750b9cd83965
change the default timeout to 600 seconds
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents:
1787
diff
changeset
|
730 means no timeout. Default is 600. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
731 username;; |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
732 The committer of a changeset created when running "commit". |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
733 Typically a person's name and email address, e.g. "Fred Widget |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
734 <fred@example.com>". Default is `$EMAIL` or username@hostname. If |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
735 the username in hgrc is empty, it has to be specified manually or |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
736 in a different hgrc file (e.g. `$HOME/.hgrc`, if the admin set |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
737 "username =" in the system hgrc). |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
738 verbose;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
739 Increase the amount of output printed. True or False. Default is False. |
962
5730e90c025b
Doc updates for push, pull, hooks, local tags, and ssh options
mpm@selenic.com
parents:
953
diff
changeset
|
740 |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
741 |
6614
944a292d522a
doc/hgrc.5.txt: add anchors for sections
Adrian Buehlmann <adrian at cadifra.com>
parents:
6446
diff
changeset
|
742 [[web]] |
938 | 743 web:: |
744 Web interface configuration. | |
745 accesslog;; | |
746 Where to output the access log. Default is stdout. | |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
747 address;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
748 Interface address to bind to. Default is all. |
2358
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
749 allow_archive;; |
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
750 List of archive format (bz2, gz, zip) allowed for downloading. |
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
751 Default is empty. |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
752 allowbz2;; |
2358
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
753 (DEPRECATED) Whether to allow .tar.bz2 downloading of repo revisions. |
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
754 Default is false. |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
755 allowgz;; |
2358
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
756 (DEPRECATED) Whether to allow .tar.gz downloading of repo revisions. |
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
757 Default is false. |
964
3f37720e7dc7
hgweb: Make maxfiles, maxchanges, and allowpull proper config options
mpm@selenic.com
parents:
962
diff
changeset
|
758 allowpull;; |
3f37720e7dc7
hgweb: Make maxfiles, maxchanges, and allowpull proper config options
mpm@selenic.com
parents:
962
diff
changeset
|
759 Whether to allow pulling from the repository. Default is true. |
2466
e10665147d26
push over http: server side authorization support.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2430
diff
changeset
|
760 allow_push;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
761 Whether to allow pushing to the repository. If empty or not set, |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
762 push is not allowed. If the special value "*", any remote user can |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
763 push, including unauthenticated users. Otherwise, the remote user |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
764 must have been authenticated, and the authenticated user name must |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
765 be present in this list (separated by whitespace or ","). The |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
766 contents of the allow_push list are examined after the deny_push |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
767 list. |
7336
2dc868712dcc
hgweb: support for deny_read/allow_read options
Mark Edgington <edgimar@gmail.com>
parents:
7241
diff
changeset
|
768 allow_read;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
769 If the user has not already been denied repository access due to |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
770 the contents of deny_read, this list determines whether to grant |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
771 repository access to the user. If this list is not empty, and the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
772 user is unauthenticated or not present in the list (separated by |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
773 whitespace or ","), then access is denied for the user. If the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
774 list is empty or not set, then access is permitted to all users by |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
775 default. Setting allow_read to the special value "*" is equivalent |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
776 to it not being set (i.e. access is permitted to all users). The |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
777 contents of the allow_read list are examined after the deny_read |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
778 list. |
1079 | 779 allowzip;; |
2358
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
780 (DEPRECATED) Whether to allow .zip downloading of repo revisions. |
8819fc1dcf4b
hgweb: add allow_archive support to [web] section of hgrc
TK Soh <teekaysoh@yahoo.com>
parents:
2318
diff
changeset
|
781 Default is false. This feature creates temporary files. |
2197
5de8b44f0446
define standard name for base url to use when printing hgweb urls.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2155
diff
changeset
|
782 baseurl;; |
5de8b44f0446
define standard name for base url to use when printing hgweb urls.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2155
diff
changeset
|
783 Base URL to use when publishing URLs in other locations, so |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
784 third-party tools like email notification hooks can construct |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
785 URLs. Example: "http://hgserver/repos/" |
2430
4ccd71b83d5e
Add web.contact to the hgrc documentation.
"Daniel Santa Cruz <byteshack@gmail.com>"
parents:
2387
diff
changeset
|
786 contact;; |
4ccd71b83d5e
Add web.contact to the hgrc documentation.
"Daniel Santa Cruz <byteshack@gmail.com>"
parents:
2387
diff
changeset
|
787 Name or email address of the person in charge of the repository. |
8766
b2059435f176
man pages: mark filenames and env vars as fixed text
Martin Geisler <mg@lazybytes.net>
parents:
8730
diff
changeset
|
788 Defaults to ui.username or `$EMAIL` or "unknown" if unset or empty. |
2466
e10665147d26
push over http: server side authorization support.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2430
diff
changeset
|
789 deny_push;; |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
790 Whether to deny pushing to the repository. If empty or not set, |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
791 push is not denied. If the special value "*", all remote users are |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
792 denied push. Otherwise, unauthenticated users are all denied, and |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
793 any authenticated user name present in this list (separated by |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
794 whitespace or ",") is also denied. The contents of the deny_push |
2466
e10665147d26
push over http: server side authorization support.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2430
diff
changeset
|
795 list are examined before the allow_push list. |
7336
2dc868712dcc
hgweb: support for deny_read/allow_read options
Mark Edgington <edgimar@gmail.com>
parents:
7241
diff
changeset
|
796 deny_read;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
797 Whether to deny reading/viewing of the repository. If this list is |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
798 not empty, unauthenticated users are all denied, and any |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
799 authenticated user name present in this list (separated by |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
800 whitespace or ",") is also denied access to the repository. If set |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
801 to the special value "*", all remote users are denied access |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
802 (rarely needed ;). If deny_read is empty or not set, the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
803 determination of repository access depends on the presence and |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
804 content of the allow_read list (see description). If both |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
805 deny_read and allow_read are empty or not set, then access is |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
806 permitted to all users by default. If the repository is being |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
807 served via hgwebdir, denied users will not be able to see it in |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
808 the list of repositories. The contents of the deny_read list have |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
809 priority over (are examined before) the contents of the allow_read |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
810 list. |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
811 description;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
812 Textual description of the repository's purpose or contents. |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
813 Default is "unknown". |
4715
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
814 encoding;; |
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
815 Character encoding name. |
ad45209a7c7a
Fixed sorting inside nearly sorted sections in hgrc.5
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4709
diff
changeset
|
816 Example: "UTF-8" |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
817 errorlog;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
818 Where to output the error log. Default is stderr. |
4709
53eca35c3aeb
Add option "hidden" to hgwebdir.
Markus F.X.J. Oberhumer <markus@oberhumer.com>
parents:
4690
diff
changeset
|
819 hidden;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
820 Whether to hide the repository in the hgwebdir index. |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
821 Default is false. |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
822 ipv6;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
823 Whether to use IPv6. Default is false. |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
824 name;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
825 Repository name to use in the web interface. Default is current |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
826 working directory. |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
827 maxchanges;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
828 Maximum number of changes to list on the changelog. Default is 10. |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
829 maxfiles;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
830 Maximum number of files to list per changeset. Default is 10. |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
831 port;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
832 Port to listen on. Default is 8000. |
5972
d83020d0466f
added an entry about the prefix option inside the hgrc man page
Michele Cella <michele.cella@gmail.com>
parents:
5779
diff
changeset
|
833 prefix;; |
d83020d0466f
added an entry about the prefix option inside the hgrc man page
Michele Cella <michele.cella@gmail.com>
parents:
5779
diff
changeset
|
834 Prefix path to serve from. Default is '' (server root). |
2466
e10665147d26
push over http: server side authorization support.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2430
diff
changeset
|
835 push_ssl;; |
e10665147d26
push over http: server side authorization support.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2430
diff
changeset
|
836 Whether to require that inbound pushes be transported over SSL to |
6446
ee5313bc3c0c
asciidoc: consistently use 1 space after full stop
Christian Ebert <blacktrash@gmx.net>
parents:
6445
diff
changeset
|
837 prevent password sniffing. Default is true. |
4084
51e52db6b40d
hgweb: allow static files to be served directly by the HTTP server
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
4052
diff
changeset
|
838 staticurl;; |
8730
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
839 Base URL to use for static files. If unset, static files (e.g. the |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
840 hgicon.png favicon) will be served by the CGI script itself. Use |
01f0ddb90342
hgrc.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler <mg@lazybytes.net>
parents:
8727
diff
changeset
|
841 this setting to serve them directly with the HTTP server. |
4084
51e52db6b40d
hgweb: allow static files to be served directly by the HTTP server
Alexis S. L. Carvalho <alexis@cecm.usp.br>
parents:
4052
diff
changeset
|
842 Example: "http://hgserver/static/" |
2666
ebf033bc8eb2
hgweb: Configurable zebra stripes
Frank Kingswood <frank@kingswood-consulting.co.uk>
parents:
2622
diff
changeset
|
843 stripes;; |
ebf033bc8eb2
hgweb: Configurable zebra stripes
Frank Kingswood <frank@kingswood-consulting.co.uk>
parents:
2622
diff
changeset
|
844 How many lines a "zebra stripe" should span in multiline output. |
ebf033bc8eb2
hgweb: Configurable zebra stripes
Frank Kingswood <frank@kingswood-consulting.co.uk>
parents:
2622
diff
changeset
|
845 Default is 1; set to 0 to disable. |
1171
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
846 style;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
847 Which template map style to use. |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
848 templates;; |
a425bb927ede
Sort items in each hgrc section. Add web/description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
1079
diff
changeset
|
849 Where to find the HTML templates. Default is install path. |
1079 | 850 |
938 | 851 |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
852 AUTHOR |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
853 ------ |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
854 Bryan O'Sullivan <bos@serpentine.com>. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
855 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
856 Mercurial was written by Matt Mackall <mpm@selenic.com>. |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
857 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
858 SEE ALSO |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
859 -------- |
2209
956e329f9e13
document hgignore syntax in new file doc/hgignore.5.txt.
Vadim Gelfer <vadim.gelfer@gmail.com>
parents:
2200
diff
changeset
|
860 hg(1), hgignore(5) |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
861 |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
862 COPYING |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
863 ------- |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
864 This manual page is copyright 2005 Bryan O'Sullivan. |
4635
63b9d2deed48
Updated copyright notices and add "and others" to "hg version"
Thomas Arendsen Hein <thomas@intevation.de>
parents:
4630
diff
changeset
|
865 Mercurial is copyright 2005-2007 Matt Mackall. |
671
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
866 Free use of this software is granted under the terms of the GNU General |
efa4a7e2f322
Move hgrc documentation out to its own man page, hgrc(5).
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
867 Public License (GPL). |