Documentation: user-manual: add information about "git help" at the beginning
authorChristian Couder <chriscool@tuxfamily.org>
Mon, 17 Nov 2008 15:42:47 +0000 (16:42 +0100)
committerJunio C Hamano <gitster@pobox.com>
Mon, 17 Nov 2008 16:21:31 +0000 (08:21 -0800)
Talking about "git help" is useful because it has a few more
features (like when using it without arguments or with "-a") and
it may work on non unix like platforms.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/user-manual.txt

index 645d752c5c26d8724e8ded0abe1f207bf3ff6854..c0d8caf46dd4feb53f71f11592a68c3febfc02fa 100644 (file)
@@ -18,12 +18,22 @@ People needing to do actual development will also want to read
 Further chapters cover more specialized topics.
 
 Comprehensive reference documentation is available through the man
-pages.  For a command such as "git clone <repo>", just use
+pages, or linkgit:git-help[1] command.  For example, for the command
+"git clone <repo>", you can either use:
 
 ------------------------------------------------
 $ man git-clone
 ------------------------------------------------
 
+or:
+
+------------------------------------------------
+$ git help clone
+------------------------------------------------
+
+With the latter, you can use the manual viewer of your choice; see
+linkgit:git-help[1] for more information.
+
 See also <<git-quick-start>> for a brief overview of git commands,
 without any explanation.