Mercurial > hg
annotate mercurial/help/environment.txt @ 32140:40785ccab410 stable
help: call out specific replacement configuration settings
As an aside, I'm having trouble parsing the help text meaning for HG when it is
unset or empty. How can it be the frozen name or searched if it is empty?
author | Matt Harbison <matt_harbison@yahoo.com> |
---|---|
date | Wed, 03 May 2017 22:56:53 -0400 |
parents | 77e566fe31ec |
children | c9740b69b9b7 d4805a5e7e70 |
rev | line source |
---|---|
9539
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
1 HG |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
2 Path to the 'hg' executable, automatically passed when running |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
3 hooks, extensions or external tools. If unset or empty, this is |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
4 the hg executable's name if it's frozen, or an executable named |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
5 'hg' (with %PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
6 Windows) is searched. |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
7 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
8 HGEDITOR |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
9 This is the name of the editor to run when committing. See EDITOR. |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
10 |
32140
40785ccab410
help: call out specific replacement configuration settings
Matt Harbison <matt_harbison@yahoo.com>
parents:
28958
diff
changeset
|
11 (deprecated, see :hg:`help config.ui.editor`) |
9539
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
12 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
13 HGENCODING |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
14 This overrides the default locale setting detected by Mercurial. |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
15 This setting is used to convert data including usernames, |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
16 changeset descriptions, tag names, and branches. This setting can |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
17 be overridden with the --encoding command-line option. |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
18 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
19 HGENCODINGMODE |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
20 This sets Mercurial's behavior for handling unknown characters |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
21 while transcoding user input. The default is "strict", which |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
22 causes Mercurial to abort if it can't map a character. Other |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
23 settings include "replace", which replaces unknown characters, and |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
24 "ignore", which drops them. This setting can be overridden with |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
25 the --encodingmode command-line option. |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
26 |
12866
eddc20306ab6
encoding: default ambiguous character to narrow
Matt Mackall <mpm@selenic.com>
parents:
12083
diff
changeset
|
27 HGENCODINGAMBIGUOUS |
eddc20306ab6
encoding: default ambiguous character to narrow
Matt Mackall <mpm@selenic.com>
parents:
12083
diff
changeset
|
28 This sets Mercurial's behavior for handling characters with |
eddc20306ab6
encoding: default ambiguous character to narrow
Matt Mackall <mpm@selenic.com>
parents:
12083
diff
changeset
|
29 "ambiguous" widths like accented Latin characters with East Asian |
eddc20306ab6
encoding: default ambiguous character to narrow
Matt Mackall <mpm@selenic.com>
parents:
12083
diff
changeset
|
30 fonts. By default, Mercurial assumes ambiguous characters are |
eddc20306ab6
encoding: default ambiguous character to narrow
Matt Mackall <mpm@selenic.com>
parents:
12083
diff
changeset
|
31 narrow, set this variable to "wide" if such characters cause |
eddc20306ab6
encoding: default ambiguous character to narrow
Matt Mackall <mpm@selenic.com>
parents:
12083
diff
changeset
|
32 formatting problems. |
eddc20306ab6
encoding: default ambiguous character to narrow
Matt Mackall <mpm@selenic.com>
parents:
12083
diff
changeset
|
33 |
9539
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
34 HGMERGE |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
35 An executable to use for resolving merge conflicts. The program |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
36 will be executed with three arguments: local file, remote file, |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
37 ancestor file. |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
38 |
32140
40785ccab410
help: call out specific replacement configuration settings
Matt Harbison <matt_harbison@yahoo.com>
parents:
28958
diff
changeset
|
39 (deprecated, see :hg:`help config.ui.merge`) |
9539
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
40 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
41 HGRCPATH |
12083
ebfc46929f3e
help: refer to user configuration file more consistently
Brodie Rao <brodie@bitheap.org>
parents:
10455
diff
changeset
|
42 A list of files or directories to search for configuration |
ebfc46929f3e
help: refer to user configuration file more consistently
Brodie Rao <brodie@bitheap.org>
parents:
10455
diff
changeset
|
43 files. Item separator is ":" on Unix, ";" on Windows. If HGRCPATH |
ebfc46929f3e
help: refer to user configuration file more consistently
Brodie Rao <brodie@bitheap.org>
parents:
10455
diff
changeset
|
44 is not set, platform default search path is used. If empty, only |
ebfc46929f3e
help: refer to user configuration file more consistently
Brodie Rao <brodie@bitheap.org>
parents:
10455
diff
changeset
|
45 the .hg/hgrc from the current repository is read. |
9539
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
46 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
47 For each element in HGRCPATH: |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
48 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
49 - if it's a directory, all files ending with .rc are added |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
50 - otherwise, the file itself will be added |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
51 |
10455
40dfd46d098f
ui: add HGPLAIN environment variable for easier scripting
Brodie Rao <me+hg@dackz.net>
parents:
9999
diff
changeset
|
52 HGPLAIN |
12083
ebfc46929f3e
help: refer to user configuration file more consistently
Brodie Rao <brodie@bitheap.org>
parents:
10455
diff
changeset
|
53 When set, this disables any configuration settings that might |
ebfc46929f3e
help: refer to user configuration file more consistently
Brodie Rao <brodie@bitheap.org>
parents:
10455
diff
changeset
|
54 change Mercurial's default output. This includes encoding, |
ebfc46929f3e
help: refer to user configuration file more consistently
Brodie Rao <brodie@bitheap.org>
parents:
10455
diff
changeset
|
55 defaults, verbose mode, debug mode, quiet mode, tracebacks, and |
10455
40dfd46d098f
ui: add HGPLAIN environment variable for easier scripting
Brodie Rao <me+hg@dackz.net>
parents:
9999
diff
changeset
|
56 localization. This can be useful when scripting against Mercurial |
40dfd46d098f
ui: add HGPLAIN environment variable for easier scripting
Brodie Rao <me+hg@dackz.net>
parents:
9999
diff
changeset
|
57 in the face of existing user configuration. |
40dfd46d098f
ui: add HGPLAIN environment variable for easier scripting
Brodie Rao <me+hg@dackz.net>
parents:
9999
diff
changeset
|
58 |
40dfd46d098f
ui: add HGPLAIN environment variable for easier scripting
Brodie Rao <me+hg@dackz.net>
parents:
9999
diff
changeset
|
59 Equivalent options set via command line flags or environment |
40dfd46d098f
ui: add HGPLAIN environment variable for easier scripting
Brodie Rao <me+hg@dackz.net>
parents:
9999
diff
changeset
|
60 variables are not overridden. |
40dfd46d098f
ui: add HGPLAIN environment variable for easier scripting
Brodie Rao <me+hg@dackz.net>
parents:
9999
diff
changeset
|
61 |
13849
9f97de157aad
HGPLAIN: allow exceptions to plain mode, like i18n, via HGPLAINEXCEPT
Brodie Rao <brodie@bitheap.org>
parents:
12866
diff
changeset
|
62 HGPLAINEXCEPT |
9f97de157aad
HGPLAIN: allow exceptions to plain mode, like i18n, via HGPLAINEXCEPT
Brodie Rao <brodie@bitheap.org>
parents:
12866
diff
changeset
|
63 This is a comma-separated list of features to preserve when |
26827
a9ed5a8fc5e0
help: mention alias and revsetalias in description of HGPLAINEXCEPT
Yuya Nishihara <yuya@tcha.org>
parents:
13849
diff
changeset
|
64 HGPLAIN is enabled. Currently the following values are supported: |
a9ed5a8fc5e0
help: mention alias and revsetalias in description of HGPLAINEXCEPT
Yuya Nishihara <yuya@tcha.org>
parents:
13849
diff
changeset
|
65 |
a9ed5a8fc5e0
help: mention alias and revsetalias in description of HGPLAINEXCEPT
Yuya Nishihara <yuya@tcha.org>
parents:
13849
diff
changeset
|
66 ``alias`` |
a9ed5a8fc5e0
help: mention alias and revsetalias in description of HGPLAINEXCEPT
Yuya Nishihara <yuya@tcha.org>
parents:
13849
diff
changeset
|
67 Don't remove aliases. |
a9ed5a8fc5e0
help: mention alias and revsetalias in description of HGPLAINEXCEPT
Yuya Nishihara <yuya@tcha.org>
parents:
13849
diff
changeset
|
68 ``i18n`` |
a9ed5a8fc5e0
help: mention alias and revsetalias in description of HGPLAINEXCEPT
Yuya Nishihara <yuya@tcha.org>
parents:
13849
diff
changeset
|
69 Preserve internationalization. |
a9ed5a8fc5e0
help: mention alias and revsetalias in description of HGPLAINEXCEPT
Yuya Nishihara <yuya@tcha.org>
parents:
13849
diff
changeset
|
70 ``revsetalias`` |
a9ed5a8fc5e0
help: mention alias and revsetalias in description of HGPLAINEXCEPT
Yuya Nishihara <yuya@tcha.org>
parents:
13849
diff
changeset
|
71 Don't remove revset aliases. |
28958
77e566fe31ec
ui: drop template aliases by HGPLAIN
Yuya Nishihara <yuya@tcha.org>
parents:
28171
diff
changeset
|
72 ``templatealias`` |
77e566fe31ec
ui: drop template aliases by HGPLAIN
Yuya Nishihara <yuya@tcha.org>
parents:
28171
diff
changeset
|
73 Don't remove template aliases. |
28171
2d20d1d2ea76
progress: display progress bar when HGPLAINEXCEPT contains "progress"
Matt Anderson <andersonmat@fb.com>
parents:
26827
diff
changeset
|
74 ``progress`` |
2d20d1d2ea76
progress: display progress bar when HGPLAINEXCEPT contains "progress"
Matt Anderson <andersonmat@fb.com>
parents:
26827
diff
changeset
|
75 Don't hide progress output. |
13849
9f97de157aad
HGPLAIN: allow exceptions to plain mode, like i18n, via HGPLAINEXCEPT
Brodie Rao <brodie@bitheap.org>
parents:
12866
diff
changeset
|
76 |
9f97de157aad
HGPLAIN: allow exceptions to plain mode, like i18n, via HGPLAINEXCEPT
Brodie Rao <brodie@bitheap.org>
parents:
12866
diff
changeset
|
77 Setting HGPLAINEXCEPT to anything (even an empty string) will |
9f97de157aad
HGPLAIN: allow exceptions to plain mode, like i18n, via HGPLAINEXCEPT
Brodie Rao <brodie@bitheap.org>
parents:
12866
diff
changeset
|
78 enable plain mode. |
9f97de157aad
HGPLAIN: allow exceptions to plain mode, like i18n, via HGPLAINEXCEPT
Brodie Rao <brodie@bitheap.org>
parents:
12866
diff
changeset
|
79 |
9539
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
80 HGUSER |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
81 This is the string used as the author of a commit. If not set, |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
82 available values will be considered in this order: |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
83 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
84 - HGUSER (deprecated) |
12083
ebfc46929f3e
help: refer to user configuration file more consistently
Brodie Rao <brodie@bitheap.org>
parents:
10455
diff
changeset
|
85 - configuration files from the HGRCPATH |
9539
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
86 - EMAIL |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
87 - interactive prompt |
9704
90e968899c72
help: markup email addresses as inline literals
Martin Geisler <mg@lazybytes.net>
parents:
9539
diff
changeset
|
88 - LOGNAME (with ``@hostname`` appended) |
9539
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
89 |
32140
40785ccab410
help: call out specific replacement configuration settings
Matt Harbison <matt_harbison@yahoo.com>
parents:
28958
diff
changeset
|
90 (deprecated, see :hg:`help config.ui.username`) |
9539
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
91 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
92 EMAIL |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
93 May be used as the author of a commit; see HGUSER. |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
94 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
95 LOGNAME |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
96 May be used as the author of a commit; see HGUSER. |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
97 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
98 VISUAL |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
99 This is the name of the editor to use when committing. See EDITOR. |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
100 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
101 EDITOR |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
102 Sometimes Mercurial needs to open a text file in an editor for a |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
103 user to modify, for example when writing commit messages. The |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
104 editor it uses is determined by looking at the environment |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
105 variables HGEDITOR, VISUAL and EDITOR, in that order. The first |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
106 non-empty one is chosen. If all of them are empty, the editor |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
107 defaults to 'vi'. |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
108 |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
109 PYTHONPATH |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
110 This is used by Python to find imported modules and may need to be |
c904e76e3834
help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
111 set appropriately if this Mercurial is not installed system-wide. |