mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: help: explain 'man.viewer' multiple values

Browse Source 
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>
This commit is contained in:
Christian Couder
2008-03-13 06:48:46 +01:00
committed by Junio C Hamano
parent 69099d6bed
commit b8322ea83b
2 changed files with 29 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/config.txt
View File

@ -749,7 +749,7 @@ log.showroot::
normally hide the root commit will now show it. True by default. normally hide the root commit will now show it. True by default.
man.viewer:: 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]. 'man' format. See linkgit:git-help[1].
merge.summary:: merge.summary::

29
Documentation/git-help.txt
View File

@ -43,7 +43,7 @@ OPTIONS
+ +
By default the 'man' program will be used to display the manual page, By default the 'man' program will be used to display the manual page,
but the 'man.viewer' configuration variable may be used to choose but the 'man.viewer' configuration variable may be used to choose
another display program (see below). other display programs (see below).
-w|--web:: -w|--web::
Display manual page for the command in the 'web' (HTML) 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 If no command line option is passed, the 'help.format' configuration
variable will be checked. The following values are supported for this variable will be checked. The following values are supported for this
variable; they make 'git-help' behave as their corresponding command variable; they make 'git-help' behave as their corresponding command
@ -67,11 +70,17 @@ line option:
* "info" corresponds to '-i|--info', * "info" corresponds to '-i|--info',
* "web" or "html" correspond to '-w|--web'. * "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 The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
be checked if the 'web' format is chosen (either by command line be checked if the 'web' format is chosen (either by command line
option or configuration variable). See '-w|--web' in the OPTIONS option or configuration variable). See '-w|--web' in the OPTIONS
section above and linkgit:git-web--browse[1]. section above and linkgit:git-web--browse[1].
man.viewer
~~~~~~~~~~
The 'man.viewer' config variable will be checked if the 'man' format The 'man.viewer' config variable will be checked if the 'man' format
is chosen. Only the following values are currently supported: 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), (this only works starting with emacsclient versions 22),
* "konqueror": use a man KIO slave in konqueror. * "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 Note that all these configuration variables should probably be set
using the '--global' flag, for example like this: using the '--global' flag, for example like this: