Documentation: help: describe 'man.viewer' config variable

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Tested-by: Xavier Maillard <xma@gnu.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index c5e094a9c4a31568e4efb2c70af7e7808ae63528..d2f2d673ab9666d4a348ae8d020049cfaadfba66 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -748,6 +748,10 @@ log.showroot::
        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
        normally hide the root commit will now show it. True by default.
 
        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
        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
+       'man' format. See linkgit:git-help[1].
+

 merge.summary::
        Whether to include summaries of merged commits in newly created
        merge commit messages. False by default.
 merge.summary::
        Whether to include summaries of merged commits in newly created
        merge commit messages. False by default.

diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 0926dc12bab23285256b8cd7906b79b7e5f5616f..73a51ae0398150597a1f4af27de97ebcb3a074f1 100644 (file)
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -33,17 +33,21 @@ OPTIONS
        option supersedes any other option.
 
 -i|--info::
        option supersedes any other option.
 
 -i|--info::

-       Use the 'info' program to display the manual page, instead of
-       the 'man' program that is used by default.
+       Display manual page for the command in the 'info' format. The
+       'info' program will be used for that purpose.

 
 -m|--man::
 
 -m|--man::

-       Use the 'man' program to display the manual page. This may be
-       used to override a value set in the 'help.format'
-       configuration variable.
+       Display manual page for the command in the 'man' format. This
+       option may be used to override a value set in the
+       'help.format' configuration variable.
++
+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).

 
 -w|--web::
 
 -w|--web::

-       Use a web browser to display the HTML manual page, instead of
-       the 'man' program that is used by default.
+       Display manual page for the command in the 'web' (HTML)
+       format. A web browser will be used for that purpose.

 +
 The web browser can be specified using the configuration variable
 'help.browser', or 'web.browser' if the former is not set. If none of
 +
 The web browser can be specified using the configuration variable
 'help.browser', or 'web.browser' if the former is not set. If none of


@@ -61,15 +65,23 @@ line option:
 
 * "man" corresponds to '-m|--man',
 * "info" corresponds to '-i|--info',
 
 * "man" corresponds to '-m|--man',
 * "info" corresponds to '-i|--info',

-* "web" or "html" correspond to '-w|--web',
+* "web" or "html" correspond to '-w|--web'.

 
 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].
 

-Note that these configuration variables should probably be set using
-the '--global' flag, for example like this:
+The 'man.viewer' config variable will be checked if the 'man' format
+is chosen. Only the following values are currently supported:
+
+* "man": use the 'man' program as usual,
+* "woman": use 'emacsclient' to launch the "woman" mode in emacs
+(this only works starting with emacsclient versions 22),
+* "konqueror": use a man KIO slave in konqueror.
+
+Note that all these configuration variables should probably be set
+using the '--global' flag, for example like this:

 
 ------------------------------------------------
 $ git config --global help.format web
 
 ------------------------------------------------
 $ git config --global help.format web