git-commit-vandalism/Documentation/git-help.txt
Christian Couder 45533d2694 Documentation: describe -i/--info option to "git-help"
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>
2007-12-03 22:16:54 -08:00

54 lines
1.3 KiB
Plaintext

git-help(1)
======
NAME
----
git-help - display help information about git
SYNOPSIS
--------
'git help' [-a|--all|-i|--info] [COMMAND]
DESCRIPTION
-----------
With no options and no COMMAND given, the synopsis of the 'git'
command and a list of the most commonly used git commands are printed
on the standard output.
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, 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.
OPTIONS
-------
-a|--all::
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
<git@vger.kernel.org>.
Documentation
-------------
Initial documentation was part of the gitlink: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