aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-help.txt
diff options
context:
space:
mode:
authorChristian Couder <chriscool@tuxfamily.org>2007-12-04 06:44:29 +0100
committerJunio C Hamano <gitster@pobox.com>2007-12-03 22:11:38 -0800
commit0f6f195b771eb09beda59bb29d3a1c46454085e8 (patch)
tree2ad1527943c6d9e202d218c47c796140ec8fbada /Documentation/git-help.txt
parent17ef10d0558d9622884e5b5930cee2569e40a4e4 (diff)
downloadgit-0f6f195b771eb09beda59bb29d3a1c46454085e8.tar.gz
git-0f6f195b771eb09beda59bb29d3a1c46454085e8.tar.xz
Documentation: add a new man page for "git-help"
Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-help.txt')
-rw-r--r--Documentation/git-help.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
new file mode 100644
index 000000000..a2255bc55
--- /dev/null
+++ b/Documentation/git-help.txt
@@ -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 <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