X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=blobdiff_plain;f=Documentation%2Fgit-help.txt;h=ad41aabeb0ec85cd1ee3d67e9496111f2a4cfc3b;hb=5884f1fe96b33d9666a78e660042b1e3e5f9f4d9;hp=da3f71850a902feba27e809440ebcfebe0a4e483;hpb=d7e522cffb2224b91c9c0edde093fbb81a0289b0;p=git.git diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index da3f71850..ad41aabeb 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -21,7 +21,7 @@ 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, but this -can be overriden by other options or configuration variables. +can be overridden by other options or configuration variables. Note that 'git --help ...' is identical as 'git help ...' because the former is internally converted into the latter. @@ -30,7 +30,7 @@ OPTIONS ------- -a|--all:: Prints all the available commands on the standard output. This - option superseeds any other option. + option supersedes any other option. -i|--info:: Use the 'info' program to display the manual page, instead of @@ -47,17 +47,27 @@ OPTIONS + 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-help--browse' helper script +these config variables is set, the 'git-web--browse' helper script (called by 'git-help') will pick a suitable default. + -You can explicitly provide a full path to your prefered browser by +You can explicitly provide a full path to your preferred browser by setting the configuration variable 'browser..path'. For example, you can configure the absolute path to firefox by setting -'browser.firefox.path'. Otherwise, 'git-help--browse' assumes the tool +'browser.firefox.path'. Otherwise, 'git-web--browse' 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. ++ +The following browsers are currently supported by 'git-web--browse': ++ +* firefox (this is the default under X Window when not using KDE) +* iceweasel +* konqueror (this is the default under KDE) +* w3m (this is the default outside X Window) +* links +* lynx +* dillo CONFIGURATION VARIABLES ----------------------- @@ -72,7 +82,7 @@ line option: * "web" or "html" correspond to '-w|--web', The 'help.browser', 'web.browser' and 'browser..path' will also -be checked if the 'web' format is choosen (either by command line +be checked if the 'web' format is chosen (either by command line option or configuration variable). See '-w|--web' in the OPTIONS section above. @@ -85,7 +95,7 @@ $ git config --global web.browser firefox ------------------------------------------------ as they are probably more user specific than repository specific. -See gitlink:git-config[1] for more information about this. +See linkgit:git-config[1] for more information about this. Author ------ @@ -94,10 +104,10 @@ Written by Junio C Hamano and the git-list Documentation ------------- -Initial documentation was part of the gitlink:git[7] man page. +Initial documentation was part of the linkgit:git[7] man page. Christian Couder extracted and rewrote it a little. Maintenance is done by the git-list . GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite