Skip to content

Commit

Permalink
Documentation: describe -i/--info option to "git-help"
Browse files Browse the repository at this point in the history
Option -i|--info for "git-help" is documented only in the new
"git-help.txt" man page, but this new man page is referenced
from the "--help" option documentation in the "git.txt" man page.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Christian Couder authored and Junio C Hamano committed Dec 4, 2007
1 parent df55c9c commit 45533d2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
9 changes: 7 additions & 2 deletions Documentation/git-help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ git-help - display help information about git

SYNOPSIS
--------
'git help' [-a|--all] [COMMAND]
'git help' [-a|--all|-i|--info] [COMMAND]

DESCRIPTION
-----------
Expand All @@ -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.
Expand All @@ -32,6 +33,10 @@ OPTIONS
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.

Author
------
Written by Junio C Hamano <gitster@pobox.com> and the git-list
Expand Down
5 changes: 5 additions & 0 deletions Documentation/git.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 45533d2

Please sign in to comment.