Skip to content

Commit

Permalink
Documentation: add a new man page for "git-help"
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Couder <[email protected]>
Signed-off-by: Junio C Hamano <[email protected]>
  • Loading branch information
chriscool authored and gitster committed Dec 4, 2007
1 parent 17ef10d commit 0f6f195
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 3 deletions.
48 changes: 48 additions & 0 deletions Documentation/git-help.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
git-help(1)
======

NAME
----
git-help - display help information about git

SYNOPSIS
--------
'git help' [-a|--all] [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.

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.

Author
------
Written by Junio C Hamano <[email protected]> and the git-list
<[email protected]>.

Documentation
-------------
Initial documentation was part of the gitlink:git[7] man page.
Christian Couder <[email protected]> extracted and rewrote it a
little. Maintenance is done by the git-list <[email protected]>.

GIT
---
Part of the gitlink:git[7] suite
6 changes: 3 additions & 3 deletions Documentation/git.txt
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ OPTIONS

--help::
Prints the synopsis and a list of the most commonly used
commands. If a git command is named this option will bring up
the man-page for that command. If the option '--all' or '-a' is
given then all available commands are printed.
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.

--exec-path::
Path to wherever your core git programs are installed.
Expand Down
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -1158,6 +1158,7 @@ check-docs::
case "$$how,$$cmd" in \
*,git-citool | \
*,git-gui | \
*,git-help | \
documented,gitattributes | \
documented,gitignore | \
documented,gitmodules | \
Expand Down
1 change: 1 addition & 0 deletions command-list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ git-get-tar-commit-id ancillaryinterrogators
git-grep mainporcelain common
git-gui mainporcelain
git-hash-object plumbingmanipulators
git-help ancillaryinterrogators
git-http-fetch synchelpers
git-http-push synchelpers
git-imap-send foreignscminterface
Expand Down

0 comments on commit 0f6f195

Please sign in to comment.