Documentation: help: describe 'man.viewer' config variable
Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Tested-by: Xavier Maillard <xma@gnu.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Christian Couder committed
Mar 7, 2008 at 08:46 UTC
b5578f333595e40cb843461e685c887ad2d01e5c
2 files changed
+26
-10
Documentation/config.txt
+4
@@ -748,6 +748,10 @@ log.showroot::
748
Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
749
normally hide the root commit will now show it. True by default.
750
751
+man.viewer::
752
+ Specify the program that will be used to display help in the
753
+ 'man' format. See linkgit:git-help[1].
754
+
755
merge.summary::
756
Whether to include summaries of merged commits in newly created
757
merge commit messages. False by default.
Documentation/git-help.txt
+22
-10
@@ -33,17 +33,21 @@ OPTIONS
33
option supersedes any other option.
34
35
-i|--info::
36
- Use the 'info' program to display the manual page, instead of
37
- the 'man' program that is used by default.
36
+ Display manual page for the command in the 'info' format. The
37
+ 'info' program will be used for that purpose.
38
39
-m|--man::
40
- Use the 'man' program to display the manual page. This may be
41
- used to override a value set in the 'help.format'
42
- configuration variable.
40
+ Display manual page for the command in the 'man' format. This
41
+ option may be used to override a value set in the
42
+ 'help.format' configuration variable.
43
++
44
+By default the 'man' program will be used to display the manual page,
45
+but the 'man.viewer' configuration variable may be used to choose
46
+another display program (see below).
47
48
-w|--web::
45
- Use a web browser to display the HTML manual page, instead of
46
- the 'man' program that is used by default.
49
+ Display manual page for the command in the 'web' (HTML)
50
+ format. A web browser will be used for that purpose.
51
+
52
The web browser can be specified using the configuration variable
53
'help.browser', or 'web.browser' if the former is not set. If none of
@@ -61,15 +65,23 @@ line option:
65
66
* "man" corresponds to '-m|--man',
67
* "info" corresponds to '-i|--info',
64
-* "web" or "html" correspond to '-w|--web',
68
+* "web" or "html" correspond to '-w|--web'.
69
70
The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
71
be checked if the 'web' format is chosen (either by command line
72
option or configuration variable). See '-w|--web' in the OPTIONS
73
section above and linkgit:git-web--browse[1].
74
71
-Note that these configuration variables should probably be set using
72
-the '--global' flag, for example like this:
75
+The 'man.viewer' config variable will be checked if the 'man' format
76
+is chosen. Only the following values are currently supported:
77
+
78
+* "man": use the 'man' program as usual,
79
+* "woman": use 'emacsclient' to launch the "woman" mode in emacs
80
+(this only works starting with emacsclient versions 22),
81
+* "konqueror": use a man KIO slave in konqueror.
82
+
83
+Note that all these configuration variables should probably be set
84
+using the '--global' flag, for example like this:
85
86
------------------------------------------------
87
$ git config --global help.format web