Documentation: help: explain 'man.viewer' multiple values
Also add titles to paragraphs under "CONFIGURATION VARIABLES". Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Christian Couder committed
Mar 13, 2008 at 06:48 UTC
b8322ea83bc23499a2cef883d051859eb79fef25
2 files changed
+29
-2
Documentation/config.txt
+1
-1
@@ -749,7 +749,7 @@ log.showroot::
749
normally hide the root commit will now show it. True by default.
750
751
man.viewer::
752
- Specify the program that will be used to display help in the
752
+ Specify the programs that may be used to display help in the
753
'man' format. See linkgit:git-help[1].
754
755
merge.summary::
Documentation/git-help.txt
+28
-1
@@ -43,7 +43,7 @@ OPTIONS
43
+
44
By default the 'man' program will be used to display the manual page,
45
but the 'man.viewer' configuration variable may be used to choose
46
-another display program (see below).
46
+other display programs (see below).
47
48
-w|--web::
49
Display manual page for the command in the 'web' (HTML)
@@ -58,6 +58,9 @@ linkgit:git-web--browse[1] for more information about this.
58
CONFIGURATION VARIABLES
59
-----------------------
60
61
+help.format
62
+~~~~~~~~~~~
63
+
64
If no command line option is passed, the 'help.format' configuration
65
variable will be checked. The following values are supported for this
66
variable; they make 'git-help' behave as their corresponding command
@@ -67,11 +70,17 @@ line option:
70
* "info" corresponds to '-i|--info',
71
* "web" or "html" correspond to '-w|--web'.
72
73
+help.browser, web.browser and browser.<tool>.path
74
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75
+
76
The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
77
be checked if the 'web' format is chosen (either by command line
78
option or configuration variable). See '-w|--web' in the OPTIONS
79
section above and linkgit:git-web--browse[1].
80
81
+man.viewer
82
+~~~~~~~~~~
83
+
84
The 'man.viewer' config variable will be checked if the 'man' format
85
is chosen. Only the following values are currently supported:
86
@@ -80,6 +89,24 @@ is chosen. Only the following values are currently supported:
89
(this only works starting with emacsclient versions 22),
90
* "konqueror": use a man KIO slave in konqueror.
91
92
+Multiple values may be given to this configuration variable. Their
93
+corresponding programs will be tried in the order listed in the
94
+configuration file.
95
+
96
+For example, this configuration:
97
+
98
+ [man]
99
+ viewer = konqueror
100
+ viewer = woman
101
+
102
+will try to use konqueror first. But this may fail (for example if
103
+DISPLAY is not set) and in that case emacs' woman mode will be tried.
104
+
105
+If everythings fails the 'man' program will be tried anyway.
106
+
107
+Note about git config --global
108
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109
+
110
Note that all these configuration variables should probably be set
111
using the '--global' flag, for example like this:
112