git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Documentation: help: explain 'man.viewer' multiple values
@ 2008-03-13  5:48 Christian Couder
  2008-03-14  1:00 ` Xavier Maillard
  0 siblings, 1 reply; 6+ messages in thread
From: Christian Couder @ 2008-03-13  5:48 UTC (permalink / raw)
  To: Junio Hamano, Pascal Obry, Xavier Maillard; +Cc: git

Also add titles to paragraphs under "CONFIGURATION VARIABLES".

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
 Documentation/config.txt   |    2 +-
 Documentation/git-help.txt |   29 ++++++++++++++++++++++++++++-
 2 files changed, 29 insertions(+), 2 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index f64b269..c72c2e6 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..89f6d25 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 the following 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:
 
-- 
1.5.4.3.395.g492b.dirty

^ permalink raw reply related	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2008-03-15 13:08 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-03-13  5:48 [PATCH] Documentation: help: explain 'man.viewer' multiple values Christian Couder
2008-03-14  1:00 ` Xavier Maillard
2008-03-14  5:15   ` Christian Couder
2008-03-14  5:14     ` Junio C Hamano
2008-03-15 13:00       ` Xavier Maillard
2008-03-15 13:00     ` Xavier Maillard

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).