Documentation: instaweb: add 'git-web--browse' information.
Now that 'git-instaweb' uses 'git-web--browse', update the documentation accordingly. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Christian Couder committed
Feb 9, 2008 at 07:10 UTC
b261ec463a4c117aa7961fd3667ffafe0f9ee986
1 file changed
+23
-4
Documentation/git-instaweb.txt
+23
-4
@@ -38,10 +38,23 @@ OPTIONS
38
The port number to bind the httpd to. (Default: 1234)
39
40
-b|--browser::
41
-
42
- The web browser command-line to execute to view the gitweb page.
43
- If blank, the URL of the gitweb instance will be printed to
44
- stdout. (Default: 'firefox')
41
+ The web browser that should be used to view the gitweb
42
+ page. This will be passed to the 'git-web--browse' helper
43
+ script along with the URL of the gitweb instance. If the
44
+ script fails, the URL will be printed to stdout.
45
++
46
+Note that the 'git-web--browse' script tries, as much as possible, to
47
+display the HTML page in a new tab on an already opened browser.
48
++
49
+The following browsers are currently supported by 'git-web--browse':
50
++
51
+* firefox (this is the default under X Window when not using KDE)
52
+* iceweasel
53
+* konqueror (this is the default under KDE)
54
+* w3m (this is the default outside X Window)
55
+* links
56
+* lynx
57
+* dillo
58
59
--start::
60
Start the httpd instance and exit. This does not generate
@@ -74,6 +87,12 @@ You may specify configuration in your .git/config
87
If the configuration variable 'instaweb.browser' is not set,
88
'web.browser' will be used instead if it is defined.
89
90
+You can explicitly provide a full path to your preferred browser by
91
+setting the configuration variable 'browser.<tool>.path'. For example,
92
+you can configure the absolute path to firefox by setting
93
+'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
94
+is available in PATH.
95
+
96
Author
97
------
98
Written by Eric Wong <normalperson@yhbt.net>