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>
This commit is contained in:
Christian Couder 2007-12-05 06:09:40 +01:00 committed by Junio C Hamano
parent d3a866bc8b
commit c07a07c588
2 changed files with 22 additions and 2 deletions

View File

@ -7,7 +7,7 @@ git-help - display help information about git
SYNOPSIS SYNOPSIS
-------- --------
'git help' [-a|--all|-i|--info] [COMMAND] 'git help' [-a|--all|-i|--info|-w|--web] [COMMAND]
DESCRIPTION DESCRIPTION
----------- -----------
@ -29,7 +29,6 @@ former is internally converted into the latter.
OPTIONS OPTIONS
------- -------
-a|--all:: -a|--all::
Prints all the available commands on the standard output. This Prints all the available commands on the standard output. This
option superseeds any other option. option superseeds any other option.
@ -37,6 +36,24 @@ OPTIONS
Use the 'info' program to display the manual page, instead of Use the 'info' program to display the manual page, instead of
the 'man' program that is used by default. the 'man' program that is used by default.
-w|--web::
Use a web browser to display the HTML manual page, instead of
the 'man' program that is used by default.
+
The web browser can be specified using the configuration variable
'help.browser', or 'web.browser' if the former is not set. If none of
these config variables is set, the 'git-browse-help' script (called by
'git-help') will pick a suitable default.
+
You can explicitly provide a full path to your prefered browser by
setting the configuration variable 'browser.<tool>.path'. For example,
you can configure the absolute path to firefox by setting
'browser.firefox.path'. Otherwise, 'git-browse-help' assumes the tool
is available in PATH.
+
Note that the script tries, as much as possible, to display the HTML
page in a new tab on an already opened browser.
Author Author
------ ------
Written by Junio C Hamano <gitster@pobox.com> and the git-list Written by Junio C Hamano <gitster@pobox.com> and the git-list

View File

@ -71,6 +71,9 @@ You may specify configuration in your .git/config
----------------------------------------------------------------------- -----------------------------------------------------------------------
If the configuration variable 'instaweb.browser' is not set,
'web.browser' will be used instead if it is defined.
Author Author
------ ------
Written by Eric Wong <normalperson@yhbt.net> Written by Eric Wong <normalperson@yhbt.net>