diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/Makefile | 4 | ||||
| -rw-r--r-- | Documentation/git-help.txt | 28 | ||||
| -rw-r--r-- | Documentation/git-instaweb.txt | 3 | ||||
| -rw-r--r-- | Documentation/git.txt | 5 |
4 files changed, 37 insertions, 3 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index 1b5802456d..9f0f9d70f6 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -29,6 +29,7 @@ DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT)) prefix?=$(HOME) bindir?=$(prefix)/bin +htmldir?=$(prefix)/share/doc/git-doc mandir?=$(prefix)/share/man man1dir=$(mandir)/man1 man5dir=$(mandir)/man5 @@ -98,6 +99,9 @@ install-info: info echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \ fi +install-html: html + sh ./install-webdoc.sh $(DESTDIR)$(htmldir) + ../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE $(MAKE) -C ../ GIT-VERSION-FILE diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 7ddbf467df..ac9e15d774 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] [COMMAND] +'git help' [-a|--all|-i|--info|-w|--web] [COMMAND] DESCRIPTION ----------- @@ -20,7 +20,8 @@ If the option '--all' or '-a' is given, then all available commands are printed on the standard output. If a git command is named, a manual page for that command is brought -up. The 'man' program is used by default for this purpose. +up. The 'man' program is used by default for this purpose, but this +can be overriden by other options. Note that 'git --help ...' is identical as 'git help ...' because the former is internally converted into the latter. @@ -28,10 +29,31 @@ 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. +-i|--info:: + 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 diff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt index 735008c1ab..d2ce7790e6 100644 --- a/Documentation/git-instaweb.txt +++ b/Documentation/git-instaweb.txt @@ -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 ------ Written by Eric Wong <normalperson@yhbt.net> diff --git a/Documentation/git.txt b/Documentation/git.txt index 1574ecd77e..a29b634e7a 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -104,6 +104,11 @@ OPTIONS commands. If the option '--all' or '-a' is given then all available commands are printed. If a git command is named this option will bring up the manual page for that command. ++ +Other options are available to control how the manual page is +displayed. See gitlink:git-help[1] for more information, +because 'git --help ...' is converted internally into 'git +help ...'. --exec-path:: Path to wherever your core git programs are installed. |