diff options
| author |  Christian Couder <chriscool@tuxfamily.org> | 2008-03-13 06:48:46 +0100 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2008-03-12 23:03:35 -0700 |
| commit | b8322ea83bc23499a2cef883d051859eb79fef25 (patch) | |
| tree | e7d8d533ec13b7b92dc8c21dd45ca60e59c7fdea /Documentation/git-help.txt | |
| parent | help: implement multi-valued "man.viewer" config option (diff) | |
| download | tgif-b8322ea83bc23499a2cef883d051859eb79fef25.tar.xz | |
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/git-help.txt')
| -rw-r--r-- | Documentation/git-help.txt | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 73a51ae039..0354ac9861 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: |