Documentation: describe -w/--web option to "git-help".
Also explain that "git instaweb" may use "web.browser" config variable. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Christian Couder committed
Dec 5, 2007 at 06:09 UTC
c07a07c588fea82c2426d795a75324b3035c0a71
2 files changed
+22
-2
Documentation/git-help.txt
+19
-2
@@ -7,7 +7,7 @@ git-help - display help information about git
7
8
SYNOPSIS
9
--------
10
-'git help' [-a|--all|-i|--info] [COMMAND]
10
+'git help' [-a|--all|-i|--info|-w|--web] [COMMAND]
11
12
DESCRIPTION
13
-----------
@@ -29,7 +29,6 @@ former is internally converted into the latter.
29
OPTIONS
30
-------
31
-a|--all::
32
-
32
Prints all the available commands on the standard output. This
33
option superseeds any other option.
34
@@ -37,6 +36,24 @@ OPTIONS
36
Use the 'info' program to display the manual page, instead of
37
the 'man' program that is used by default.
38
39
+-w|--web::
40
+ Use a web browser to display the HTML manual page, instead of
41
+ the 'man' program that is used by default.
42
++
43
+The web browser can be specified using the configuration variable
44
+'help.browser', or 'web.browser' if the former is not set. If none of
45
+these config variables is set, the 'git-browse-help' script (called by
46
+'git-help') will pick a suitable default.
47
++
48
+You can explicitly provide a full path to your prefered browser by
49
+setting the configuration variable 'browser.<tool>.path'. For example,
50
+you can configure the absolute path to firefox by setting
51
+'browser.firefox.path'. Otherwise, 'git-browse-help' assumes the tool
52
+is available in PATH.
53
++
54
+Note that the script tries, as much as possible, to display the HTML
55
+page in a new tab on an already opened browser.
56
+
57
Author
58
------
59
Written by Junio C Hamano <gitster@pobox.com> and the git-list
Documentation/git-instaweb.txt
+3
@@ -71,6 +71,9 @@ You may specify configuration in your .git/config
71
72
-----------------------------------------------------------------------
73
74
+If the configuration variable 'instaweb.browser' is not set,
75
+'web.browser' will be used instead if it is defined.
76
+
77
Author
78
------
79
Written by Eric Wong <normalperson@yhbt.net>