summaryrefslogtreecommitdiff
path: root/Documentation/git-help.txt
diff options
context:
space:
mode:
authorChristian Couder <chriscool@tuxfamily.org>2007-12-05 06:09:40 +0100
committerJunio C Hamano <gitster@pobox.com>2007-12-09 01:19:54 -0800
commitc07a07c588fea82c2426d795a75324b3035c0a71 (patch)
tree970306ad55961e63641afc90da1c983b25363271 /Documentation/git-help.txt
parentd3a866bc8b5604d31638648d671e524cc84fbb26 (diff)
downloadgit-c07a07c588fea82c2426d795a75324b3035c0a71.tar.gz
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>
Diffstat (limited to 'Documentation/git-help.txt')
-rw-r--r--Documentation/git-help.txt21
1 files changed, 19 insertions, 2 deletions
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 232daae0d9..0e873fde28 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -7,7 +7,7 @@ git-help - display help information about git
SYNOPSIS
--------
-'git help' [-a|--all|-i|--info] [COMMAND]
+'git help' [-a|--all|-i|--info|-w|--web] [COMMAND]
DESCRIPTION
-----------
@@ -29,7 +29,6 @@ former is internally converted into the latter.
OPTIONS
-------
-a|--all::
-
Prints all the available commands on the standard output. This
option superseeds any other option.
@@ -37,6 +36,24 @@ OPTIONS
Use the 'info' program to display the manual page, instead of
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
------
Written by Junio C Hamano <gitster@pobox.com> and the git-list