blob: cf8f6fc3b336876a73dff23108037042b7848173 [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>
Junio C Hamano9d971152012-12-19 00:43:115<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:536<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano103b5722011-01-31 05:03:457<title>git-help(1)</title>
Junio C Hamano58256872007-12-04 08:31:138<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:119/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano58256872007-12-04 08:31:1324}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
Junio C Hamanoba4b9282008-07-06 05:20:3130a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
Junio C Hamano58256872007-12-04 08:31:1337
38em {
39 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:4540 color: navy;
Junio C Hamano58256872007-12-04 08:31:1341}
42
43strong {
44 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:4545 color: #083194;
Junio C Hamano58256872007-12-04 08:31:1346}
47
Junio C Hamano58256872007-12-04 08:31:1348h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano58256872007-12-04 08:31:1350 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
Junio C Hamanoba4b9282008-07-06 05:20:3155h1, h2, h3 {
Junio C Hamano58256872007-12-04 08:31:1356 border-bottom: 2px solid silver;
57}
58h2 {
Junio C Hamano58256872007-12-04 08:31:1359 padding-top: 0.5em;
60}
Junio C Hamanoba4b9282008-07-06 05:20:3161h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:1167h5 {
68 font-size: 1.0em;
69}
Junio C Hamano58256872007-12-04 08:31:1370
71div.sectionbody {
Junio C Hamano58256872007-12-04 08:31:1372 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
Junio C Hamano103b5722011-01-31 05:03:4584ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:1187ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano103b5722011-01-31 05:03:4589
Junio C Hamanoc14e6ad2014-10-31 20:25:5390.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano58256872007-12-04 08:31:1394 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:5397pre {
98 white-space: pre-wrap;
99}
Junio C Hamano58256872007-12-04 08:31:13100
Junio C Hamano9d971152012-12-19 00:43:11101#author {
Junio C Hamano58256872007-12-04 08:31:13102 color: #527bbd;
Junio C Hamano58256872007-12-04 08:31:13103 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31104 font-size: 1.1em;
Junio C Hamano58256872007-12-04 08:31:13105}
Junio C Hamano9d971152012-12-19 00:43:11106#email {
Junio C Hamano58256872007-12-04 08:31:13107}
Junio C Hamano9d971152012-12-19 00:43:11108#revnumber, #revdate, #revremark {
Junio C Hamano58256872007-12-04 08:31:13109}
110
Junio C Hamano9d971152012-12-19 00:43:11111#footer {
Junio C Hamano58256872007-12-04 08:31:13112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11117#footer-text {
Junio C Hamano58256872007-12-04 08:31:13118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11121#footer-badges {
Junio C Hamano58256872007-12-04 08:31:13122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11126#preamble {
Junio C Hamano103b5722011-01-31 05:03:45127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano58256872007-12-04 08:31:13131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22133 margin-top: 1.0em;
Junio C Hamano58256872007-12-04 08:31:13134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
Junio C Hamano58256872007-12-04 08:31:13141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45149 color: #527bbd;
Junio C Hamano58256872007-12-04 08:31:13150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamano58256872007-12-04 08:31:13173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamano58256872007-12-04 08:31:13180 padding: 0.5em;
181}
182
Junio C Hamano7bd050f2011-09-22 06:32:22183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamano58256872007-12-04 08:31:13189}
Junio C Hamano7bd050f2011-09-22 06:32:22190
Junio C Hamano103b5722011-01-31 05:03:45191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
Junio C Hamano58256872007-12-04 08:31:13193 text-align: right;
194}
Junio C Hamano103b5722011-01-31 05:03:45195
Junio C Hamano9d971152012-12-19 00:43:11196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano103b5722011-01-31 05:03:45199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31205div.verseblock + div.attribution {
206 text-align: left;
207}
Junio C Hamano58256872007-12-04 08:31:13208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22219 border-left: 3px solid #dddddd;
Junio C Hamano58256872007-12-04 08:31:13220}
221
222div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
Junio C Hamano58256872007-12-04 08:31:13225}
226
Junio C Hamano58256872007-12-04 08:31:13227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano103b5722011-01-31 05:03:45229a.image:visited { color: white; }
Junio C Hamano58256872007-12-04 08:31:13230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45238 font-style: normal;
239 color: navy;
Junio C Hamano58256872007-12-04 08:31:13240}
241dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45242 margin-top: 0.1em;
Junio C Hamano58256872007-12-04 08:31:13243}
244
245ul, ol {
246 list-style-position: outside;
247}
Junio C Hamano103b5722011-01-31 05:03:45248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
Junio C Hamano58256872007-12-04 08:31:13252 list-style-type: lower-alpha;
253}
Junio C Hamano103b5722011-01-31 05:03:45254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
Junio C Hamano58256872007-12-04 08:31:13270
Junio C Hamano58256872007-12-04 08:31:13271tfoot {
272 font-weight: bold;
273}
Junio C Hamano103b5722011-01-31 05:03:45274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano103b5722011-01-31 05:03:45277
278div.hdlist {
Junio C Hamano58256872007-12-04 08:31:13279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
Junio C Hamano103b5722011-01-31 05:03:45282div.hdlist tr {
283 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31284}
Junio C Hamano103b5722011-01-31 05:03:45285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
Junio C Hamano58256872007-12-04 08:31:13289 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45290 font-style: normal;
Junio C Hamano58256872007-12-04 08:31:13291 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45292 color: navy;
Junio C Hamano58256872007-12-04 08:31:13293}
Junio C Hamano103b5722011-01-31 05:03:45294td.hdlist2 {
Junio C Hamano58256872007-12-04 08:31:13295 vertical-align: top;
296}
Junio C Hamano103b5722011-01-31 05:03:45297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
Junio C Hamano58256872007-12-04 08:31:13305
Junio C Hamano7bd050f2011-09-22 06:32:22306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamano58256872007-12-04 08:31:13340}
Junio C Hamanoba4b9282008-07-06 05:20:31341
Junio C Hamano9d971152012-12-19 00:43:11342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11350#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31351 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano9d971152012-12-19 00:43:11374
375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
427}
428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
432 font-weight: bold;
433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
449}
450
451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
480}
481
482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
501 text-align: right;
502}
503
504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
506}
507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
512}
513
514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
Junio C Hamano103b5722011-01-31 05:03:45521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
Junio C Hamano9d971152012-12-19 00:43:11526body.manpage h2 {
Junio C Hamano103b5722011-01-31 05:03:45527 border-style: none;
528}
Junio C Hamano9d971152012-12-19 00:43:11529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano103b5722011-01-31 05:03:45531}
532
533@media print {
Junio C Hamano9d971152012-12-19 00:43:11534 body.manpage div#toc { display: none; }
Junio C Hamano103b5722011-01-31 05:03:45535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53536
537
Junio C Hamano58256872007-12-04 08:31:13538</style>
Junio C Hamano7bd050f2011-09-22 06:32:22539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano7bd050f2011-09-22 06:32:22682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11730asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22731/*]]>*/
732</script>
Junio C Hamano58256872007-12-04 08:31:13733</head>
Junio C Hamano9d971152012-12-19 00:43:11734<body class="manpage">
Junio C Hamano58256872007-12-04 08:31:13735<div id="header">
736<h1>
737git-help(1) Manual Page
738</h1>
739<h2>NAME</h2>
740<div class="sectionbody">
741<p>git-help -
Junio C Hamano076ffcc2013-02-06 05:13:21742 Display help information about Git
Junio C Hamano58256872007-12-04 08:31:13743</p>
744</div>
745</div>
Junio C Hamano7bd050f2011-09-22 06:32:22746<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11747<div class="sect1">
Junio C Hamano103b5722011-01-31 05:03:45748<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano58256872007-12-04 08:31:13749<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59750<div class="verseblock">
Junio C Hamano0eb11502013-04-12 02:14:19751<pre class="content"><em>git help</em> [-a|--all] [-g|--guide]
752 [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]</pre>
Junio C Hamano9d971152012-12-19 00:43:11753<div class="attribution">
Junio C Hamano15567bc2011-07-23 00:51:59754</div></div>
Junio C Hamano58256872007-12-04 08:31:13755</div>
Junio C Hamano9d971152012-12-19 00:43:11756</div>
757<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31758<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano58256872007-12-04 08:31:13759<div class="sectionbody">
Junio C Hamano0eb11502013-04-12 02:14:19760<div class="paragraph"><p>With no options and no COMMAND or GUIDE given, the synopsis of the <em>git</em>
Junio C Hamano076ffcc2013-02-06 05:13:21761command and a list of the most commonly used Git commands are printed
Junio C Hamanoba4b9282008-07-06 05:20:31762on the standard output.</p></div>
Junio C Hamano0eb11502013-04-12 02:14:19763<div class="paragraph"><p>If the option <em>--all</em> or <em>-a</em> is given, all available commands are
Junio C Hamanoba4b9282008-07-06 05:20:31764printed on the standard output.</p></div>
Junio C Hamano0eb11502013-04-12 02:14:19765<div class="paragraph"><p>If the option <em>--guide</em> or <em>-g</em> is given, a list of the useful
766Git guides is also printed on the standard output.</p></div>
767<div class="paragraph"><p>If a command, or a guide, is given, a manual page for that command or
768guide is brought up. The <em>man</em> program is used by default for this
769purpose, but this can be overridden by other options or configuration
770variables.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53771<div class="paragraph"><p>Note that <code>git --help ...</code> is identical to <code>git help ...</code> because the
Junio C Hamanoba4b9282008-07-06 05:20:31772former is internally converted into the latter.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53773<div class="paragraph"><p>To display the <a href="git.html">git(1)</a> man page, use <code>git help git</code>.</p></div>
774<div class="paragraph"><p>This page can be displayed with <em>git help help</em> or <code>git help --help</code></p></div>
Junio C Hamano58256872007-12-04 08:31:13775</div>
Junio C Hamano9d971152012-12-19 00:43:11776</div>
777<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31778<h2 id="_options">OPTIONS</h2>
Junio C Hamano58256872007-12-04 08:31:13779<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45780<div class="dlist"><dl>
781<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47782-a
783</dt>
Junio C Hamano103b5722011-01-31 05:03:45784<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47785--all
Junio C Hamano58256872007-12-04 08:31:13786</dt>
787<dd>
788<p>
789 Prints all the available commands on the standard output. This
Junio C Hamano0eb11502013-04-12 02:14:19790 option overrides any given command or guide name.
791</p>
792</dd>
793<dt class="hdlist1">
794-g
795</dt>
796<dt class="hdlist1">
797--guides
798</dt>
799<dd>
800<p>
801 Prints a list of useful guides on the standard output. This
802 option overrides any given command or guide name.
Junio C Hamano58256872007-12-04 08:31:13803</p>
804</dd>
Junio C Hamano103b5722011-01-31 05:03:45805<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47806-i
807</dt>
Junio C Hamano103b5722011-01-31 05:03:45808<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47809--info
Junio C Hamano0c0da5f2007-12-13 02:45:30810</dt>
811<dd>
812<p>
Junio C Hamano8b588d52008-03-15 09:48:37813 Display manual page for the command in the <em>info</em> format. The
814 <em>info</em> program will be used for that purpose.
Junio C Hamano0c0da5f2007-12-13 02:45:30815</p>
816</dd>
Junio C Hamano103b5722011-01-31 05:03:45817<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47818-m
819</dt>
Junio C Hamano103b5722011-01-31 05:03:45820<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47821--man
Junio C Hamano3dac5042007-12-15 08:40:54822</dt>
823<dd>
824<p>
Junio C Hamano8b588d52008-03-15 09:48:37825 Display manual page for the command in the <em>man</em> format. This
826 option may be used to override a value set in the
827 <em>help.format</em> configuration variable.
Junio C Hamano3dac5042007-12-15 08:40:54828</p>
Junio C Hamano103b5722011-01-31 05:03:45829<div class="paragraph"><p>By default the <em>man</em> program will be used to display the manual page,
Junio C Hamano8b588d52008-03-15 09:48:37830but the <em>man.viewer</em> configuration variable may be used to choose
Junio C Hamanoba4b9282008-07-06 05:20:31831other display programs (see below).</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54832</dd>
Junio C Hamano103b5722011-01-31 05:03:45833<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47834-w
835</dt>
Junio C Hamano103b5722011-01-31 05:03:45836<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47837--web
Junio C Hamano0c0da5f2007-12-13 02:45:30838</dt>
839<dd>
840<p>
Junio C Hamano8b588d52008-03-15 09:48:37841 Display manual page for the command in the <em>web</em> (HTML)
842 format. A web browser will be used for that purpose.
Junio C Hamano0c0da5f2007-12-13 02:45:30843</p>
Junio C Hamano103b5722011-01-31 05:03:45844<div class="paragraph"><p>The web browser can be specified using the configuration variable
Junio C Hamano0c0da5f2007-12-13 02:45:30845<em>help.browser</em>, or <em>web.browser</em> if the former is not set. If none of
Junio C Hamano2db3e752010-09-03 21:33:06846these config variables is set, the <em>git web&#45;&#45;browse</em> helper script
Junio C Hamano1aa40d22010-01-21 17:46:43847(called by <em>git help</em>) will pick a suitable default. See
Junio C Hamanoa28a9202012-06-21 07:08:23848<a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a> for more information about this.</p></div>
Junio C Hamano0c0da5f2007-12-13 02:45:30849</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31850</dl></div>
Junio C Hamano58256872007-12-04 08:31:13851</div>
Junio C Hamano9d971152012-12-19 00:43:11852</div>
853<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31854<h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
Junio C Hamano3dac5042007-12-15 08:40:54855<div class="sectionbody">
Junio C Hamano9d971152012-12-19 00:43:11856<div class="sect2">
857<h3 id="_help_format">help.format</h3>
Junio C Hamanoe1aeb5e2014-06-06 19:16:29858<div class="paragraph"><p>If no command-line option is passed, the <em>help.format</em> configuration
Junio C Hamano3dac5042007-12-15 08:40:54859variable will be checked. The following values are supported for this
Junio C Hamanoe1aeb5e2014-06-06 19:16:29860variable; they make <em>git help</em> behave as their corresponding command-
Junio C Hamanoba4b9282008-07-06 05:20:31861line option:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45862<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54863<li>
864<p>
865"man" corresponds to <em>-m|--man</em>,
866</p>
867</li>
868<li>
869<p>
870"info" corresponds to <em>-i|--info</em>,
871</p>
872</li>
873<li>
874<p>
Junio C Hamano8b588d52008-03-15 09:48:37875"web" or "html" correspond to <em>-w|--web</em>.
Junio C Hamano3dac5042007-12-15 08:40:54876</p>
877</li>
Junio C Hamanoba4b9282008-07-06 05:20:31878</ul></div>
Junio C Hamano9d971152012-12-19 00:43:11879</div>
880<div class="sect2">
881<h3 id="_help_browser_web_browser_and_browser_lt_tool_gt_path">help.browser, web.browser and browser.&lt;tool&gt;.path</h3>
Junio C Hamano103b5722011-01-31 05:03:45882<div class="paragraph"><p>The <em>help.browser</em>, <em>web.browser</em> and <em>browser.&lt;tool&gt;.path</em> will also
Junio C Hamanoe1aeb5e2014-06-06 19:16:29883be checked if the <em>web</em> format is chosen (either by command-line
Junio C Hamano3dac5042007-12-15 08:40:54884option or configuration variable). See <em>-w|--web</em> in the OPTIONS
Junio C Hamanoa28a9202012-06-21 07:08:23885section above and <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11886</div>
887<div class="sect2">
888<h3 id="_man_viewer">man.viewer</h3>
Junio C Hamanoe1aeb5e2014-06-06 19:16:29889<div class="paragraph"><p>The <em>man.viewer</em> configuration variable will be checked if the <em>man</em>
890format is chosen. The following values are currently supported:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45891<div class="ulist"><ul>
Junio C Hamano8b588d52008-03-15 09:48:37892<li>
893<p>
894"man": use the <em>man</em> program as usual,
895</p>
896</li>
897<li>
898<p>
899"woman": use <em>emacsclient</em> to launch the "woman" mode in emacs
900(this only works starting with emacsclient versions 22),
901</p>
902</li>
903<li>
904<p>
Junio C Hamano6d76d612008-05-09 05:46:08905"konqueror": use <em>kfmclient</em> to open the man page in a new konqueror
906tab (see <em>Note about konqueror</em> below).
Junio C Hamano8b588d52008-03-15 09:48:37907</p>
908</li>
Junio C Hamanoba4b9282008-07-06 05:20:31909</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45910<div class="paragraph"><p>Values for other tools can be used if there is a corresponding
Junio C Hamanoba4b9282008-07-06 05:20:31911<em>man.&lt;tool&gt;.cmd</em> configuration entry (see below).</p></div>
Junio C Hamano103b5722011-01-31 05:03:45912<div class="paragraph"><p>Multiple values may be given to the <em>man.viewer</em> configuration
Junio C Hamano6d76d612008-05-09 05:46:08913variable. Their corresponding programs will be tried in the order
Junio C Hamanoba4b9282008-07-06 05:20:31914listed in the configuration file.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45915<div class="paragraph"><p>For example, this configuration:</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08916<div class="listingblock">
Junio C Hamano8b588d52008-03-15 09:48:37917<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53918<pre><code> [man]
Junio C Hamano6d76d612008-05-09 05:46:08919 viewer = konqueror
Junio C Hamanoc14e6ad2014-10-31 20:25:53920 viewer = woman</code></pre>
Junio C Hamano8b588d52008-03-15 09:48:37921</div></div>
Junio C Hamanoe1aeb5e2014-06-06 19:16:29922<div class="paragraph"><p>will try to use konqueror first. But this may fail (for example, if
Junio C Hamanoba4b9282008-07-06 05:20:31923DISPLAY is not set) and in that case emacs' woman mode will be tried.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45924<div class="paragraph"><p>If everything fails, or if no viewer is configured, the viewer specified
Junio C Hamanoa2f46622008-09-03 05:20:31925in the GIT_MAN_VIEWER environment variable will be tried. If that
926fails too, the <em>man</em> program will be tried anyway.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11927</div>
928<div class="sect2">
929<h3 id="_man_lt_tool_gt_path">man.&lt;tool&gt;.path</h3>
Junio C Hamano103b5722011-01-31 05:03:45930<div class="paragraph"><p>You can explicitly provide a full path to your preferred man viewer by
Junio C Hamano6d76d612008-05-09 05:46:08931setting the configuration variable <em>man.&lt;tool&gt;.path</em>. For example, you
932can configure the absolute path to konqueror by setting
Junio C Hamano1aa40d22010-01-21 17:46:43933<em>man.konqueror.path</em>. Otherwise, <em>git help</em> assumes the tool is
Junio C Hamanoba4b9282008-07-06 05:20:31934available in PATH.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11935</div>
936<div class="sect2">
937<h3 id="_man_lt_tool_gt_cmd">man.&lt;tool&gt;.cmd</h3>
Junio C Hamano103b5722011-01-31 05:03:45938<div class="paragraph"><p>When the man viewer, specified by the <em>man.viewer</em> configuration
Junio C Hamano6d76d612008-05-09 05:46:08939variables, is not among the supported ones, then the corresponding
940<em>man.&lt;tool&gt;.cmd</em> configuration variable will be looked up. If this
941variable exists then the specified tool will be treated as a custom
942command and a shell eval will be used to run the command with the man
Junio C Hamanoba4b9282008-07-06 05:20:31943page passed as arguments.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11944</div>
945<div class="sect2">
946<h3 id="_note_about_konqueror">Note about konqueror</h3>
Junio C Hamano103b5722011-01-31 05:03:45947<div class="paragraph"><p>When <em>konqueror</em> is specified in the <em>man.viewer</em> configuration
Junio C Hamano6d76d612008-05-09 05:46:08948variable, we launch <em>kfmclient</em> to try to open the man page on an
Junio C Hamanoba4b9282008-07-06 05:20:31949already opened konqueror in a new tab if possible.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45950<div class="paragraph"><p>For consistency, we also try such a trick if <em>man.konqueror.path</em> is
Junio C Hamano6d76d612008-05-09 05:46:08951set to something like <em>A_PATH_TO/konqueror</em>. That means we will try to
Junio C Hamanoba4b9282008-07-06 05:20:31952launch <em>A_PATH_TO/kfmclient</em> instead.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45953<div class="paragraph"><p>If you really want to use <em>konqueror</em>, then you can use something like
Junio C Hamanoba4b9282008-07-06 05:20:31954the following:</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08955<div class="listingblock">
956<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53957<pre><code> [man]
Junio C Hamano6d76d612008-05-09 05:46:08958 viewer = konq
959
960 [man "konq"]
Junio C Hamanoc14e6ad2014-10-31 20:25:53961 cmd = A_PATH_TO/konqueror</code></pre>
Junio C Hamano6d76d612008-05-09 05:46:08962</div></div>
Junio C Hamano9d971152012-12-19 00:43:11963</div>
964<div class="sect2">
965<h3 id="_note_about_git_config_global">Note about git config --global</h3>
Junio C Hamano103b5722011-01-31 05:03:45966<div class="paragraph"><p>Note that all these configuration variables should probably be set
Junio C Hamanoba4b9282008-07-06 05:20:31967using the <em>--global</em> flag, for example like this:</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54968<div class="listingblock">
969<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53970<pre><code>$ git config --global help.format web
971$ git config --global web.browser firefox</code></pre>
Junio C Hamano3dac5042007-12-15 08:40:54972</div></div>
Junio C Hamano103b5722011-01-31 05:03:45973<div class="paragraph"><p>as they are probably more user specific than repository specific.
Junio C Hamanoa28a9202012-06-21 07:08:23974See <a href="git-config.html">git-config(1)</a> for more information about this.</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54975</div>
Junio C Hamano9d971152012-12-19 00:43:11976</div>
977</div>
978<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31979<h2 id="_git">GIT</h2>
Junio C Hamano58256872007-12-04 08:31:13980<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23981<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano58256872007-12-04 08:31:13982</div>
Junio C Hamano7bd050f2011-09-22 06:32:22983</div>
Junio C Hamano9d971152012-12-19 00:43:11984</div>
Junio C Hamano7bd050f2011-09-22 06:32:22985<div id="footnotes"><hr /></div>
Junio C Hamano58256872007-12-04 08:31:13986<div id="footer">
987<div id="footer-text">
Junio C Hamanoe1aeb5e2014-06-06 19:16:29988Last updated 2014-06-06 12:15:38 PDT
Junio C Hamano58256872007-12-04 08:31:13989</div>
990</div>
991</body>
992</html>