index 8994c6d4344344293453684a1e811b56819d3c81..f414583fc48e85e4785fbf5f9431bb81a96ccd9d 100644 (file)
up. The 'man' program is used by default for this purpose, but this
can be overridden by other options or configuration variables.
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
-------
former is internally converted into the latter.
OPTIONS
-------
--a|--all::
+-a::
+--all::
Prints all the available commands on the standard output. This
option supersedes any other option.
Prints all the available commands on the standard output. This
option supersedes any other option.
--i|--info::
+-i::
+--info::
Display manual page for the command in the 'info' format. The
'info' program will be used for that purpose.
Display manual page for the command in the 'info' format. The
'info' program will be used for that purpose.
--m|--man::
+-m::
+--man::
Display manual page for the command in the 'man' format. This
option may be used to override a value set in the
'help.format' configuration variable.
Display manual page for the command in the 'man' format. This
option may be used to override a value set in the
'help.format' configuration variable.
but the 'man.viewer' configuration variable may be used to choose
other display programs (see below).
but the 'man.viewer' configuration variable may be used to choose
other display programs (see below).
--w|--web::
+-w::
+--web::
Display manual page for the command in the 'web' (HTML)
format. A web browser will be used for that purpose.
+
Display manual page for the command in the 'web' (HTML)
format. A web browser will be used for that purpose.
+
You can explicitly provide a full path to your preferred man viewer by
setting the configuration variable 'man.<tool>.path'. For example, you
can configure the absolute path to konqueror by setting
You can explicitly provide a full path to your preferred man viewer by
setting the configuration variable 'man.<tool>.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.<tool>.cmd
available in PATH.
man.<tool>.cmd