documentation: help: add "man.<tool>.path" config variable
authorChristian Couder <chriscool@tuxfamily.org>
Fri, 25 Apr 2008 06:24:41 +0000 (08:24 +0200)
committerJunio C Hamano <gitster@pobox.com>
Sat, 26 Apr 2008 21:33:56 +0000 (14:33 -0700)
This patch documents the "man.<tool>.path" configuration
variable.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config.txt
Documentation/git-help.txt
index 7a24f6e819ea0e5431748cea64b46369dfd6a114..138ba9ad8f51665981f231525cbfdf657b2020db 100644 (file)
@@ -805,6 +805,10 @@ merge.<driver>.recursive::
        performing an internal merge between common ancestors.
        See linkgit:gitattributes[5] for details.
 
        performing an internal merge between common ancestors.
        See linkgit:gitattributes[5] for details.
 
+man.<tool>.path::
+       Override the path for the given tool that may be used to
+       display help in the 'man' format. See linkgit:git-help[1].
+
 mergetool.<tool>.path::
        Override the path for the given tool.  This is useful in case
        your tool is not in the PATH.
 mergetool.<tool>.path::
        Override the path for the given tool.  This is useful in case
        your tool is not in the PATH.
index be2ae53b90610d6c89fdf281634d06609562101b..4c6cb2194cc77123e15ad73eeead0152e075d5d6 100644 (file)
@@ -104,6 +104,15 @@ DISPLAY is not set) and in that case emacs' woman mode will be tried.
 
 If everything fails the 'man' program will be tried anyway.
 
 
 If everything fails the 'man' program will be tried anyway.
 
+man.<tool>.path
+~~~~~~~~~~~~~~~
+
+You can explicitly provide a full path to your preferred man viewer by
+setting the configuration variable 'man.<tool>.path'. For example, you
+can configure the absolute path to konqueror by setting
+'man.konqueror.path'. Otherwise, 'git help' assumes the tool is
+available in PATH.
+
 Note about git config --global
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Note about git config --global
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~