blob: d371d3b4ef5e157b2986ce7a9ca6a65a317bacf8 [file] [log] [blame]
Junio C Hamano58256872007-12-04 08:31:131<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamanoba4b9282008-07-06 05:20:316<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano58256872007-12-04 08:31:137<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanoba4b9282008-07-06 05:20:3119a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano58256872007-12-04 08:31:1326
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:3147h1, h2, h3 {
Junio C Hamano58256872007-12-04 08:31:1348 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano58256872007-12-04 08:31:1351 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:3153h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano58256872007-12-04 08:31:1359
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:3183 font-size: 1.1em;
Junio C Hamano58256872007-12-04 08:31:1384}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano58256872007-12-04 08:31:13155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31164
165div.attribution {
Junio C Hamano58256872007-12-04 08:31:13166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano58256872007-12-04 08:31:13171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31214div.olist2 ol {
Junio C Hamano58256872007-12-04 08:31:13215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31219 border: 3px solid #527bbd;
Junio C Hamano58256872007-12-04 08:31:13220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano58256872007-12-04 08:31:13236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano58256872007-12-04 08:31:13275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano58256872007-12-04 08:31:13306</style>
307<title>git-help(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-help(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-help -
317 display help information about git
318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31323<div class="para"><p><em>git help</em> [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]</p></div>
Junio C Hamano58256872007-12-04 08:31:13324</div>
Junio C Hamanoba4b9282008-07-06 05:20:31325<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano58256872007-12-04 08:31:13326<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31327<div class="para"><p>With no options and no COMMAND given, the synopsis of the <em>git</em>
Junio C Hamano58256872007-12-04 08:31:13328command and a list of the most commonly used git commands are printed
Junio C Hamanoba4b9282008-07-06 05:20:31329on the standard output.</p></div>
330<div class="para"><p>If the option <em>--all</em> or <em>-a</em> is given, then all available commands are
331printed on the standard output.</p></div>
332<div class="para"><p>If a git command is named, a manual page for that command is brought
Junio C Hamano0c0da5f2007-12-13 02:45:30333up. The <em>man</em> program is used by default for this purpose, but this
Junio C Hamanoba4b9282008-07-06 05:20:31334can be overridden by other options or configuration variables.</p></div>
335<div class="para"><p>Note that <tt>git --help &#8230;</tt> is identical to <tt>git help &#8230;</tt> because the
336former is internally converted into the latter.</p></div>
Junio C Hamano58256872007-12-04 08:31:13337</div>
Junio C Hamanoba4b9282008-07-06 05:20:31338<h2 id="_options">OPTIONS</h2>
Junio C Hamano58256872007-12-04 08:31:13339<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31340<div class="vlist"><dl>
Junio C Hamano58256872007-12-04 08:31:13341<dt>
Junio C Hamanoeb415992008-06-08 22:49:47342-a
343</dt>
344<dt>
345--all
Junio C Hamano58256872007-12-04 08:31:13346</dt>
347<dd>
348<p>
349 Prints all the available commands on the standard output. This
Junio C Hamanofe986052007-12-19 07:33:38350 option supersedes any other option.
Junio C Hamano58256872007-12-04 08:31:13351</p>
352</dd>
Junio C Hamano0c0da5f2007-12-13 02:45:30353<dt>
Junio C Hamanoeb415992008-06-08 22:49:47354-i
355</dt>
356<dt>
357--info
Junio C Hamano0c0da5f2007-12-13 02:45:30358</dt>
359<dd>
360<p>
Junio C Hamano8b588d52008-03-15 09:48:37361 Display manual page for the command in the <em>info</em> format. The
362 <em>info</em> program will be used for that purpose.
Junio C Hamano0c0da5f2007-12-13 02:45:30363</p>
364</dd>
365<dt>
Junio C Hamanoeb415992008-06-08 22:49:47366-m
367</dt>
368<dt>
369--man
Junio C Hamano3dac5042007-12-15 08:40:54370</dt>
371<dd>
372<p>
Junio C Hamano8b588d52008-03-15 09:48:37373 Display manual page for the command in the <em>man</em> format. This
374 option may be used to override a value set in the
375 <em>help.format</em> configuration variable.
Junio C Hamano3dac5042007-12-15 08:40:54376</p>
Junio C Hamanoba4b9282008-07-06 05:20:31377<div class="para"><p>By default the <em>man</em> program will be used to display the manual page,
Junio C Hamano8b588d52008-03-15 09:48:37378but the <em>man.viewer</em> configuration variable may be used to choose
Junio C Hamanoba4b9282008-07-06 05:20:31379other display programs (see below).</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54380</dd>
381<dt>
Junio C Hamanoeb415992008-06-08 22:49:47382-w
383</dt>
384<dt>
385--web
Junio C Hamano0c0da5f2007-12-13 02:45:30386</dt>
387<dd>
388<p>
Junio C Hamano8b588d52008-03-15 09:48:37389 Display manual page for the command in the <em>web</em> (HTML)
390 format. A web browser will be used for that purpose.
Junio C Hamano0c0da5f2007-12-13 02:45:30391</p>
Junio C Hamanoba4b9282008-07-06 05:20:31392<div class="para"><p>The web browser can be specified using the configuration variable
Junio C Hamano0c0da5f2007-12-13 02:45:30393<em>help.browser</em>, or <em>web.browser</em> if the former is not set. If none of
Junio C Hamanoba4b9282008-07-06 05:20:31394these config variables is set, the <em>git-web--browse</em> helper script
395(called by <em>git-help</em>) will pick a suitable default. See
396<a href="git-web--browse.html">git-web--browse(1)</a> for more information about this.</p></div>
Junio C Hamano0c0da5f2007-12-13 02:45:30397</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31398</dl></div>
Junio C Hamano58256872007-12-04 08:31:13399</div>
Junio C Hamanoba4b9282008-07-06 05:20:31400<h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
Junio C Hamano3dac5042007-12-15 08:40:54401<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31402<h3 id="_help_format">help.format</h3><div style="clear:left"></div>
403<div class="para"><p>If no command line option is passed, the <em>help.format</em> configuration
Junio C Hamano3dac5042007-12-15 08:40:54404variable will be checked. The following values are supported for this
Junio C Hamanoba4b9282008-07-06 05:20:31405variable; they make <em>git-help</em> behave as their corresponding command
406line option:</p></div>
407<div class="ilist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54408<li>
409<p>
410"man" corresponds to <em>-m|--man</em>,
411</p>
412</li>
413<li>
414<p>
415"info" corresponds to <em>-i|--info</em>,
416</p>
417</li>
418<li>
419<p>
Junio C Hamano8b588d52008-03-15 09:48:37420"web" or "html" correspond to <em>-w|--web</em>.
Junio C Hamano3dac5042007-12-15 08:40:54421</p>
422</li>
Junio C Hamanoba4b9282008-07-06 05:20:31423</ul></div>
424<h3 id="_help_browser_web_browser_and_browser_lt_tool_gt_path">help.browser, web.browser and browser.&lt;tool&gt;.path</h3><div style="clear:left"></div>
425<div class="para"><p>The <em>help.browser</em>, <em>web.browser</em> and <em>browser.&lt;tool&gt;.path</em> will also
Junio C Hamanofe986052007-12-19 07:33:38426be checked if the <em>web</em> format is chosen (either by command line
Junio C Hamano3dac5042007-12-15 08:40:54427option or configuration variable). See <em>-w|--web</em> in the OPTIONS
Junio C Hamanoba4b9282008-07-06 05:20:31428section above and <a href="git-web--browse.html">git-web--browse(1)</a>.</p></div>
429<h3 id="_man_viewer">man.viewer</h3><div style="clear:left"></div>
430<div class="para"><p>The <em>man.viewer</em> config variable will be checked if the <em>man</em> format
431is chosen. The following values are currently supported:</p></div>
432<div class="ilist"><ul>
Junio C Hamano8b588d52008-03-15 09:48:37433<li>
434<p>
435"man": use the <em>man</em> program as usual,
436</p>
437</li>
438<li>
439<p>
440"woman": use <em>emacsclient</em> to launch the "woman" mode in emacs
441(this only works starting with emacsclient versions 22),
442</p>
443</li>
444<li>
445<p>
Junio C Hamano6d76d612008-05-09 05:46:08446"konqueror": use <em>kfmclient</em> to open the man page in a new konqueror
447tab (see <em>Note about konqueror</em> below).
Junio C Hamano8b588d52008-03-15 09:48:37448</p>
449</li>
Junio C Hamanoba4b9282008-07-06 05:20:31450</ul></div>
451<div class="para"><p>Values for other tools can be used if there is a corresponding
452<em>man.&lt;tool&gt;.cmd</em> configuration entry (see below).</p></div>
453<div class="para"><p>Multiple values may be given to the <em>man.viewer</em> configuration
Junio C Hamano6d76d612008-05-09 05:46:08454variable. Their corresponding programs will be tried in the order
Junio C Hamanoba4b9282008-07-06 05:20:31455listed in the configuration file.</p></div>
456<div class="para"><p>For example, this configuration:</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08457<div class="listingblock">
Junio C Hamano8b588d52008-03-15 09:48:37458<div class="content">
Junio C Hamano6d76d612008-05-09 05:46:08459<pre><tt> [man]
460 viewer = konqueror
461 viewer = woman</tt></pre>
Junio C Hamano8b588d52008-03-15 09:48:37462</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31463<div class="para"><p>will try to use konqueror first. But this may fail (for example if
464DISPLAY is not set) and in that case emacs' woman mode will be tried.</p></div>
Junio C Hamanoa2f46622008-09-03 05:20:31465<div class="para"><p>If everything fails, or if no viewer is configured, the viewer specified
466in the GIT_MAN_VIEWER environment variable will be tried. If that
467fails too, the <em>man</em> program will be tried anyway.</p></div>
Junio C Hamanoba4b9282008-07-06 05:20:31468<h3 id="_man_lt_tool_gt_path">man.&lt;tool&gt;.path</h3><div style="clear:left"></div>
469<div class="para"><p>You can explicitly provide a full path to your preferred man viewer by
Junio C Hamano6d76d612008-05-09 05:46:08470setting the configuration variable <em>man.&lt;tool&gt;.path</em>. For example, you
471can configure the absolute path to konqueror by setting
Junio C Hamanoba4b9282008-07-06 05:20:31472<em>man.konqueror.path</em>. Otherwise, <em>git-help</em> assumes the tool is
473available in PATH.</p></div>
474<h3 id="_man_lt_tool_gt_cmd">man.&lt;tool&gt;.cmd</h3><div style="clear:left"></div>
475<div class="para"><p>When the man viewer, specified by the <em>man.viewer</em> configuration
Junio C Hamano6d76d612008-05-09 05:46:08476variables, is not among the supported ones, then the corresponding
477<em>man.&lt;tool&gt;.cmd</em> configuration variable will be looked up. If this
478variable exists then the specified tool will be treated as a custom
479command and a shell eval will be used to run the command with the man
Junio C Hamanoba4b9282008-07-06 05:20:31480page passed as arguments.</p></div>
481<h3 id="_note_about_konqueror">Note about konqueror</h3><div style="clear:left"></div>
482<div class="para"><p>When <em>konqueror</em> is specified in the <em>man.viewer</em> configuration
Junio C Hamano6d76d612008-05-09 05:46:08483variable, we launch <em>kfmclient</em> to try to open the man page on an
Junio C Hamanoba4b9282008-07-06 05:20:31484already opened konqueror in a new tab if possible.</p></div>
485<div class="para"><p>For consistency, we also try such a trick if <em>man.konqueror.path</em> is
Junio C Hamano6d76d612008-05-09 05:46:08486set to something like <em>A_PATH_TO/konqueror</em>. That means we will try to
Junio C Hamanoba4b9282008-07-06 05:20:31487launch <em>A_PATH_TO/kfmclient</em> instead.</p></div>
488<div class="para"><p>If you really want to use <em>konqueror</em>, then you can use something like
489the following:</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08490<div class="listingblock">
491<div class="content">
492<pre><tt> [man]
493 viewer = konq
494
495 [man "konq"]
496 cmd = A_PATH_TO/konqueror</tt></pre>
497</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31498<h3 id="_note_about_git_config_global">Note about git config --global</h3><div style="clear:left"></div>
499<div class="para"><p>Note that all these configuration variables should probably be set
500using the <em>--global</em> flag, for example like this:</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54501<div class="listingblock">
502<div class="content">
503<pre><tt>$ git config --global help.format web
504$ git config --global web.browser firefox</tt></pre>
505</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31506<div class="para"><p>as they are probably more user specific than repository specific.
507See <a href="git-config.html">git-config(1)</a> for more information about this.</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54508</div>
Junio C Hamanoba4b9282008-07-06 05:20:31509<h2 id="_author">Author</h2>
Junio C Hamano58256872007-12-04 08:31:13510<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31511<div class="para"><p>Written by Junio C Hamano &lt;gitster@pobox.com&gt; and the git-list
512&lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamano58256872007-12-04 08:31:13513</div>
Junio C Hamanoba4b9282008-07-06 05:20:31514<h2 id="_documentation">Documentation</h2>
Junio C Hamano58256872007-12-04 08:31:13515<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31516<div class="para"><p>Initial documentation was part of the <a href="git.html">git(1)</a> man page.
Junio C Hamano58256872007-12-04 08:31:13517Christian Couder &lt;chriscool@tuxfamily.org&gt; extracted and rewrote it a
Junio C Hamanoba4b9282008-07-06 05:20:31518little. Maintenance is done by the git-list &lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamano58256872007-12-04 08:31:13519</div>
Junio C Hamanoba4b9282008-07-06 05:20:31520<h2 id="_git">GIT</h2>
Junio C Hamano58256872007-12-04 08:31:13521<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31522<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano58256872007-12-04 08:31:13523</div>
524<div id="footer">
525<div id="footer-text">
Junio C Hamano73d812c2009-07-01 02:33:06526Last updated 2009-07-01 02:30:52 UTC
Junio C Hamano58256872007-12-04 08:31:13527</div>
528</div>
529</body>
530</html>