summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorChristian Couder <chriscool@tuxfamily.org>2008-03-13 05:48:46 (GMT)
committerJunio C Hamano <gitster@pobox.com>2008-03-13 06:03:35 (GMT)
commitb8322ea83bc23499a2cef883d051859eb79fef25 (patch)
treee7d8d533ec13b7b92dc8c21dd45ca60e59c7fdea /Documentation
parent69099d6bedb0217d7c35f7202acd6185551d762f (diff)
downloadgit-b8322ea83bc23499a2cef883d051859eb79fef25.zip
git-b8322ea83bc23499a2cef883d051859eb79fef25.tar.gz
git-b8322ea83bc23499a2cef883d051859eb79fef25.tar.bz2
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>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/config.txt2
-rw-r--r--Documentation/git-help.txt29
2 files changed, 29 insertions, 2 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index d2f2d67..ae1486d 100644
--- 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::
- 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::
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 73a51ae..0354ac9 100644
--- 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
-another display program (see below).
+other display programs (see below).
-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
-----------------------
+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
@@ -67,11 +70,17 @@ line option:
* "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].
+man.viewer
+~~~~~~~~~~
+
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.
+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: