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|-w|--web] [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         Prints all the available commands on the standard output. This
  33         option superseeds any other option.
  34
  35 -i|--info::
  36         Use the 'info' program to display the manual page, instead of
  37         the 'man' program that is used by default.
  38
  39 -w|--web::
  40         Use a web browser to display the HTML manual page, instead of
  41         the 'man' program that is used by default.
  42 +
  43 The web browser can be specified using the configuration variable
  44 'help.browser', or 'web.browser' if the former is not set. If none of
  45 these config variables is set, the 'git-browse-help' script (called by
  46 'git-help') will pick a suitable default.
  47 +
  48 You can explicitly provide a full path to your prefered browser by
  49 setting the configuration variable 'browser.<tool>.path'. For example,
  50 you can configure the absolute path to firefox by setting
  51 'browser.firefox.path'. Otherwise, 'git-browse-help' assumes the tool
  52 is available in PATH.
  53 +
  54 Note that the script tries, as much as possible, to display the HTML
  55 page in a new tab on an already opened browser.
  56
  57 Author
  58 ------
  59 Written by Junio C Hamano <gitster@pobox.com> and the git-list
  60 <git@vger.kernel.org>.
  61
  62 Documentation
  63 -------------
  64 Initial documentation was part of the gitlink:git[7] man page.
  65 Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a
  66 little. Maintenance is done by the git-list <git@vger.kernel.org>.
  67
  68 GIT
  69 ---
  70 Part of the gitlink:git[7] suite