Documentation/git-help.txt

   1 git-help(1)
   2 ======
   3
   4 NAME
   5 ----
   6 git-help - display help information about git
   7
   8 SYNOPSIS
   9 --------
  10 'git help' [-a|--all|-i|--info] [COMMAND]
  11
  12 DESCRIPTION
  13 -----------
  14
  15 With no options and no COMMAND given, the synopsis of the 'git'
  16 command and a list of the most commonly used git commands are printed
  17 on the standard output.
  18
  19 If the option '--all' or '-a' is given, then all available commands are
  20 printed on the standard output.
  21
  22 If a git command is named, a manual page for that command is brought
  23 up. The 'man' program is used by default for this purpose, but this
  24 can be overriden by other options.
  25
  26 Note that 'git --help ...' is identical as 'git help ...' because the
  27 former is internally converted into the latter.
  28
  29 OPTIONS
  30 -------
  31 -a|--all::
  32
  33         Prints all the available commands on the standard output. This
  34         option superseeds any other option.
  35
  36 -i|--info::
  37         Use the 'info' program to display the manual page, instead of
  38         the 'man' program that is used by default.
  39
  40 Author
  41 ------
  42 Written by Junio C Hamano <gitster@pobox.com> and the git-list
  43 <git@vger.kernel.org>.
  44
  45 Documentation
  46 -------------
  47 Initial documentation was part of the gitlink:git[7] man page.
  48 Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a
  49 little. Maintenance is done by the git-list <git@vger.kernel.org>.
  50
  51 GIT
  52 ---
  53 Part of the gitlink:git[7] suite