7
8
SYNOPSIS
9
--------
10
-'git help' [-a|--all|-i|--info|-w|--web] [COMMAND]
10
+'git help' [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]
11
12
DESCRIPTION
13
-----------
21
22
If a git command is named, a manual page for that command is brought
23
up. The 'man' program is used by default for this purpose, but this
24
-can be overriden by other options.
24
+can be overriden by other options or configuration variables.
25
26
Note that 'git --help ...' is identical as 'git help ...' because the
27
former is internally converted into the latter.
36
Use the 'info' program to display the manual page, instead of
37
the 'man' program that is used by default.
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.
43
+
44
-w|--web::
45
Use a web browser to display the HTML manual page, instead of
46
the 'man' program that is used by default.
59
Note that the script tries, as much as possible, to display the HTML
60
page in a new tab on an already opened browser.
61
62
+CONFIGURATION VARIABLES
63
+-----------------------
64
+
65
+If no command line option is passed, the 'help.format' configuration
66
+variable will be checked. The following values are supported for this
67
+variable; they make 'git-help' behave as their corresponding command
68
+line option:
69
+
70
+* "man" corresponds to '-m|--man',
71
+* "info" corresponds to '-i|--info',
72
+* "web" or "html" correspond to '-w|--web',
73
+
74
+The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
75
+be checked if the 'web' format is choosen (either by command line
76
+option or configuration variable). See '-w|--web' in the OPTIONS
77
+section above.
78
+
79
+Note that these configuration variables should probably be set using
80
+the '--global' flag, for example like this:
81
+
82
+------------------------------------------------
83
+$ git config --global help.format web
84
+$ git config --global web.browser firefox
85
+------------------------------------------------
86
+
87
+as they are probably more user specific than repository specific.
88
+See gitlink:git-config[1] for more information about this.
89
+
90
Author
91
------
92
Written by Junio C Hamano <gitster@pobox.com> and the git-list