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>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index d2f2d673ab9666d4a348ae8d020049cfaadfba66..ae1486da3d812e16e35c5ffbe2e03f12bbde0774 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -749,7 +749,7 @@ log.showroot::
        normally hide the root commit will now show it. True by default.
 
 man.viewer::
        normally hide the root commit will now show it. True by default.
 
 man.viewer::

-       Specify the program that will be used to display help in the
+       Specify the programs that may be used to display help in the

        'man' format. See linkgit:git-help[1].
 
 merge.summary::
        'man' format. See linkgit:git-help[1].
 
 merge.summary::

diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 73a51ae0398150597a1f4af27de97ebcb3a074f1..0354ac9861b83e020f8d4de57fe5bca2f9b32f69 100644 (file)
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -43,7 +43,7 @@ OPTIONS
 +
 By default the 'man' program will be used to display the manual page,
 but the 'man.viewer' configuration variable may be used to choose
 +
 By default the 'man' program will be used to display the manual page,
 but the 'man.viewer' configuration variable may be used to choose

-another display program (see below).
+other display programs (see below).

 
 -w|--web::
        Display manual page for the command in the 'web' (HTML)
 
 -w|--web::
        Display manual page for the command in the 'web' (HTML)


@@ -58,6 +58,9 @@ linkgit:git-web--browse[1] for more information about this.
 CONFIGURATION VARIABLES
 -----------------------
 
 CONFIGURATION VARIABLES
 -----------------------
 

+help.format
+~~~~~~~~~~~
+

 If no command line option is passed, the 'help.format' configuration
 variable will be checked. The following values are supported for this
 variable; they make 'git-help' behave as their corresponding command
 If no command line option is passed, the 'help.format' configuration
 variable will be checked. The following values are supported for this
 variable; they make 'git-help' behave as their corresponding command


@@ -67,11 +70,17 @@ line option:
 * "info" corresponds to '-i|--info',
 * "web" or "html" correspond to '-w|--web'.
 
 * "info" corresponds to '-i|--info',
 * "web" or "html" correspond to '-w|--web'.
 

+help.browser, web.browser and browser.<tool>.path
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+

 The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
 be checked if the 'web' format is chosen (either by command line
 option or configuration variable). See '-w|--web' in the OPTIONS
 section above and linkgit:git-web--browse[1].
 
 The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
 be checked if the 'web' format is chosen (either by command line
 option or configuration variable). See '-w|--web' in the OPTIONS
 section above and linkgit:git-web--browse[1].
 

+man.viewer
+~~~~~~~~~~
+

 The 'man.viewer' config variable will be checked if the 'man' format
 is chosen. Only the following values are currently supported:
 
 The 'man.viewer' config variable will be checked if the 'man' format
 is chosen. Only the following values are currently supported:
 


@@ -80,6 +89,24 @@ is chosen. Only the following values are currently supported:
 (this only works starting with emacsclient versions 22),
 * "konqueror": use a man KIO slave in konqueror.
 
 (this only works starting with emacsclient versions 22),
 * "konqueror": use a man KIO slave in konqueror.
 

+Multiple values may be given to this configuration variable. Their
+corresponding programs will be tried in the order listed in the
+configuration file.
+
+For example, this configuration:
+
+       [man]
+               viewer = konqueror
+               viewer = woman
+
+will try to use konqueror first. But this may fail (for example if
+DISPLAY is not set) and in that case emacs' woman mode will be tried.
+
+If everythings fails the 'man' program will be tried anyway.
+
+Note about git config --global
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+

 Note that all these configuration variables should probably be set
 using the '--global' flag, for example like this:
 
 Note that all these configuration variables should probably be set
 using the '--global' flag, for example like this: