X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-help.txt;h=d9b9c34b3a60f09bea4f9e53b5127f33f356e042;hb=dde4af4313c6fba5269df384d97ef4fa3ab5971d;hp=5ace863c10c6c0b29199365f98d8de9832740dea;hpb=7dde4bb3674da53dd9e33c741bea3fe680690a0d;p=git.git diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 5ace863c1..d9b9c34b3 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -23,7 +23,7 @@ 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 overridden by other options or configuration variables. -Note that 'git --help ...' is identical as 'git help ...' because the +Note that `git --help ...` is identical to `git help ...` because the former is internally converted into the latter. OPTIONS @@ -55,8 +55,8 @@ other display programs (see below). + 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-web--browse` helper script -(called by `git-help`) will pick a suitable default. See +these config variables is set, the 'git-web--browse' helper script +(called by 'git-help') will pick a suitable default. See linkgit:git-web--browse[1] for more information about this. CONFIGURATION VARIABLES @@ -67,7 +67,7 @@ help.format If no command line option is passed, the 'help.format' configuration variable will be checked. The following values are supported for this -variable; they make `git-help` behave as their corresponding command +variable; they make 'git-help' behave as their corresponding command line option: * "man" corresponds to '-m|--man', @@ -112,7 +112,9 @@ For example, this configuration: will try to use konqueror first. But this may fail (for example if DISPLAY is not set) and in that case emacs' woman mode will be tried. -If everything fails the 'man' program will be tried anyway. +If everything fails, or if no viewer is configured, the viewer specified +in the GIT_MAN_VIEWER environment variable will be tried. If that +fails too, the 'man' program will be tried anyway. man..path ~~~~~~~~~~~~~~~ @@ -120,7 +122,7 @@ man..path You can explicitly provide a full path to your preferred man viewer by setting the configuration variable 'man..path'. For example, you can configure the absolute path to konqueror by setting -'man.konqueror.path'. Otherwise, 'git help' assumes the tool is +'man.konqueror.path'. Otherwise, 'git-help' assumes the tool is available in PATH. man..cmd