Merge branch 'pb/prepare-commit-msg'
[gitweb.git] / Documentation / git-help.txt
index 31ec403a705456b0fcc41eb7196484e0919eccae..fb77ca3a57d9377e8939c6d32601cf1386f0261b 100644 (file)
@@ -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-browse-help' script (called by
-'git-help') will pick a suitable default.
+these config variables is set, the 'git-help--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.<tool>.path'. For example,
 you can configure the absolute path to firefox by setting
-'browser.firefox.path'. Otherwise, 'git-browse-help' assumes the tool
+'browser.firefox.path'. Otherwise, 'git-help--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-help--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.<tool>.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 <gitster@pobox.com> 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 <chriscool@tuxfamily.org> extracted and rewrote it a
 little. Maintenance is done by the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite