Merge branch 'jc/gitignore-ends-with-slash'
[git/git.git] / 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|-m|--man|-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 overridden by other options or configuration variables.
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 supersedes 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 -m|--man::
40 Use the 'man' program to display the manual page. This may be
41 used to override a value set in the 'help.format'
42 configuration variable.
43
44 -w|--web::
45 Use a web browser to display the HTML manual page, instead of
46 the 'man' program that is used by default.
47 +
48 The web browser can be specified using the configuration variable
49 'help.browser', or 'web.browser' if the former is not set. If none of
50 these config variables is set, the 'git-help--browse' helper script
51 (called by 'git-help') will pick a suitable default.
52 +
53 You can explicitly provide a full path to your preferred browser by
54 setting the configuration variable 'browser.<tool>.path'. For example,
55 you can configure the absolute path to firefox by setting
56 'browser.firefox.path'. Otherwise, 'git-help--browse' assumes the tool
57 is available in PATH.
58 +
59 Note that the script tries, as much as possible, to display the HTML
60 page in a new tab on an already opened browser.
61 +
62 The following browsers are currently supported by 'git-help--browse':
63 +
64 * firefox (this is the default under X Window when not using KDE)
65 * iceweasel
66 * konqueror (this is the default under KDE)
67 * w3m (this is the default outside X Window)
68 * links
69 * lynx
70 * dillo
71
72 CONFIGURATION VARIABLES
73 -----------------------
74
75 If no command line option is passed, the 'help.format' configuration
76 variable will be checked. The following values are supported for this
77 variable; they make 'git-help' behave as their corresponding command
78 line option:
79
80 * "man" corresponds to '-m|--man',
81 * "info" corresponds to '-i|--info',
82 * "web" or "html" correspond to '-w|--web',
83
84 The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
85 be checked if the 'web' format is chosen (either by command line
86 option or configuration variable). See '-w|--web' in the OPTIONS
87 section above.
88
89 Note that these configuration variables should probably be set using
90 the '--global' flag, for example like this:
91
92 ------------------------------------------------
93 $ git config --global help.format web
94 $ git config --global web.browser firefox
95 ------------------------------------------------
96
97 as they are probably more user specific than repository specific.
98 See linkgit:git-config[1] for more information about this.
99
100 Author
101 ------
102 Written by Junio C Hamano <gitster@pobox.com> and the git-list
103 <git@vger.kernel.org>.
104
105 Documentation
106 -------------
107 Initial documentation was part of the linkgit:git[7] man page.
108 Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a
109 little. Maintenance is done by the git-list <git@vger.kernel.org>.
110
111 GIT
112 ---
113 Part of the linkgit:git[7] suite