blob: adda8434e88cf29e61b49e900be5bb98afa5661b [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" />
6<meta name="generator" content="AsciiDoc 8.6.8" />
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 Hamano9d971152012-12-19 00:43:1190.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}
97
Junio C Hamano9d971152012-12-19 00:43:1198
99#author {
Junio C Hamano58256872007-12-04 08:31:13100 color: #527bbd;
Junio C Hamano58256872007-12-04 08:31:13101 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31102 font-size: 1.1em;
Junio C Hamano58256872007-12-04 08:31:13103}
Junio C Hamano9d971152012-12-19 00:43:11104#email {
Junio C Hamano58256872007-12-04 08:31:13105}
Junio C Hamano9d971152012-12-19 00:43:11106#revnumber, #revdate, #revremark {
Junio C Hamano58256872007-12-04 08:31:13107}
108
Junio C Hamano9d971152012-12-19 00:43:11109#footer {
Junio C Hamano58256872007-12-04 08:31:13110 font-size: small;
111 border-top: 2px solid silver;
112 padding-top: 0.5em;
113 margin-top: 4.0em;
114}
Junio C Hamano9d971152012-12-19 00:43:11115#footer-text {
Junio C Hamano58256872007-12-04 08:31:13116 float: left;
117 padding-bottom: 0.5em;
118}
Junio C Hamano9d971152012-12-19 00:43:11119#footer-badges {
Junio C Hamano58256872007-12-04 08:31:13120 float: right;
121 padding-bottom: 0.5em;
122}
123
Junio C Hamano9d971152012-12-19 00:43:11124#preamble {
Junio C Hamano103b5722011-01-31 05:03:45125 margin-top: 1.5em;
126 margin-bottom: 1.5em;
127}
Junio C Hamano9d971152012-12-19 00:43:11128div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano58256872007-12-04 08:31:13129div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
130div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22131 margin-top: 1.0em;
Junio C Hamano58256872007-12-04 08:31:13132 margin-bottom: 1.5em;
133}
134div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22135 margin-top: 2.0em;
136 margin-bottom: 2.0em;
137 margin-right: 10%;
138 color: #606060;
Junio C Hamano58256872007-12-04 08:31:13139}
140
141div.content { /* Block element content. */
142 padding: 0;
143}
144
145/* Block element titles. */
146div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45147 color: #527bbd;
Junio C Hamano58256872007-12-04 08:31:13148 font-weight: bold;
149 text-align: left;
150 margin-top: 1.0em;
151 margin-bottom: 0.5em;
152}
153div.title + * {
154 margin-top: 0;
155}
156
157td div.title:first-child {
158 margin-top: 0.0em;
159}
160div.content div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content + div.title {
164 margin-top: 0.0em;
165}
166
167div.sidebarblock > div.content {
168 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11169 border: 1px solid #dddddd;
170 border-left: 4px solid #f0f0f0;
Junio C Hamano58256872007-12-04 08:31:13171 padding: 0.5em;
172}
173
174div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11175 border: 1px solid #dddddd;
176 border-left: 5px solid #f0f0f0;
177 background: #f8f8f8;
Junio C Hamano58256872007-12-04 08:31:13178 padding: 0.5em;
179}
180
Junio C Hamano7bd050f2011-09-22 06:32:22181div.quoteblock, div.verseblock {
182 padding-left: 1.0em;
183 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45184 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11185 border-left: 5px solid #f0f0f0;
186 color: #888;
Junio C Hamano58256872007-12-04 08:31:13187}
Junio C Hamano7bd050f2011-09-22 06:32:22188
Junio C Hamano103b5722011-01-31 05:03:45189div.quoteblock > div.attribution {
190 padding-top: 0.5em;
Junio C Hamano58256872007-12-04 08:31:13191 text-align: right;
192}
Junio C Hamano103b5722011-01-31 05:03:45193
Junio C Hamano9d971152012-12-19 00:43:11194div.verseblock > pre.content {
195 font-family: inherit;
196 font-size: inherit;
Junio C Hamano103b5722011-01-31 05:03:45197}
198div.verseblock > div.attribution {
199 padding-top: 0.75em;
200 text-align: left;
201}
202/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31203div.verseblock + div.attribution {
204 text-align: left;
205}
Junio C Hamano58256872007-12-04 08:31:13206
207div.admonitionblock .icon {
208 vertical-align: top;
209 font-size: 1.1em;
210 font-weight: bold;
211 text-decoration: underline;
212 color: #527bbd;
213 padding-right: 0.5em;
214}
215div.admonitionblock td.content {
216 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22217 border-left: 3px solid #dddddd;
Junio C Hamano58256872007-12-04 08:31:13218}
219
220div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22221 border-left: 3px solid #dddddd;
222 padding-left: 0.5em;
Junio C Hamano58256872007-12-04 08:31:13223}
224
Junio C Hamano58256872007-12-04 08:31:13225div.imageblock div.content { padding-left: 0; }
Junio C Hamano58256872007-12-04 08:31:13226span.image img { border-style: none; }
Junio C Hamano103b5722011-01-31 05:03:45227a.image:visited { color: white; }
Junio C Hamano58256872007-12-04 08:31:13228
229dl {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
233dt {
234 margin-top: 0.5em;
235 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45236 font-style: normal;
237 color: navy;
Junio C Hamano58256872007-12-04 08:31:13238}
239dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45240 margin-top: 0.1em;
Junio C Hamano58256872007-12-04 08:31:13241}
242
243ul, ol {
244 list-style-position: outside;
245}
Junio C Hamano103b5722011-01-31 05:03:45246ol.arabic {
247 list-style-type: decimal;
248}
249ol.loweralpha {
Junio C Hamano58256872007-12-04 08:31:13250 list-style-type: lower-alpha;
251}
Junio C Hamano103b5722011-01-31 05:03:45252ol.upperalpha {
253 list-style-type: upper-alpha;
254}
255ol.lowerroman {
256 list-style-type: lower-roman;
257}
258ol.upperroman {
259 list-style-type: upper-roman;
260}
261
262div.compact ul, div.compact ol,
263div.compact p, div.compact p,
264div.compact div, div.compact div {
265 margin-top: 0.1em;
266 margin-bottom: 0.1em;
267}
Junio C Hamano58256872007-12-04 08:31:13268
Junio C Hamano58256872007-12-04 08:31:13269tfoot {
270 font-weight: bold;
271}
Junio C Hamano103b5722011-01-31 05:03:45272td > div.verse {
273 white-space: pre;
274}
Junio C Hamano103b5722011-01-31 05:03:45275
276div.hdlist {
Junio C Hamano58256872007-12-04 08:31:13277 margin-top: 0.8em;
278 margin-bottom: 0.8em;
279}
Junio C Hamano103b5722011-01-31 05:03:45280div.hdlist tr {
281 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31282}
Junio C Hamano103b5722011-01-31 05:03:45283dt.hdlist1.strong, td.hdlist1.strong {
284 font-weight: bold;
285}
286td.hdlist1 {
Junio C Hamano58256872007-12-04 08:31:13287 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45288 font-style: normal;
Junio C Hamano58256872007-12-04 08:31:13289 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45290 color: navy;
Junio C Hamano58256872007-12-04 08:31:13291}
Junio C Hamano103b5722011-01-31 05:03:45292td.hdlist2 {
Junio C Hamano58256872007-12-04 08:31:13293 vertical-align: top;
294}
Junio C Hamano103b5722011-01-31 05:03:45295div.hdlist.compact tr {
296 margin: 0;
297 padding-bottom: 0;
298}
299
300.comment {
301 background: yellow;
302}
Junio C Hamano58256872007-12-04 08:31:13303
Junio C Hamano7bd050f2011-09-22 06:32:22304.footnote, .footnoteref {
305 font-size: 0.8em;
306}
307
308span.footnote, span.footnoteref {
309 vertical-align: super;
310}
311
312#footnotes {
313 margin: 20px 0 20px 0;
314 padding: 7px 0 0 0;
315}
316
317#footnotes div.footnote {
318 margin: 0 0 5px 0;
319}
320
321#footnotes hr {
322 border: none;
323 border-top: 1px solid silver;
324 height: 1px;
325 text-align: left;
326 margin-left: 0;
327 width: 20%;
328 min-width: 100px;
329}
330
Junio C Hamano9d971152012-12-19 00:43:11331div.colist td {
332 padding-right: 0.5em;
333 padding-bottom: 0.3em;
334 vertical-align: top;
335}
336div.colist td img {
337 margin-top: 0.3em;
Junio C Hamano58256872007-12-04 08:31:13338}
Junio C Hamanoba4b9282008-07-06 05:20:31339
Junio C Hamano9d971152012-12-19 00:43:11340@media print {
341 #footer-badges { display: none; }
342}
343
344#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22345 margin-bottom: 2.5em;
346}
347
Junio C Hamano9d971152012-12-19 00:43:11348#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31349 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31350 font-size: 1.1em;
351 font-weight: bold;
352 margin-top: 1.0em;
353 margin-bottom: 0.1em;
354}
355
Junio C Hamano9d971152012-12-19 00:43:11356div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31357 margin-top: 0;
358 margin-bottom: 0;
359}
360div.toclevel2 {
361 margin-left: 2em;
362 font-size: 0.9em;
363}
364div.toclevel3 {
365 margin-left: 4em;
366 font-size: 0.9em;
367}
368div.toclevel4 {
369 margin-left: 6em;
370 font-size: 0.9em;
371}
Junio C Hamano9d971152012-12-19 00:43:11372
373span.aqua { color: aqua; }
374span.black { color: black; }
375span.blue { color: blue; }
376span.fuchsia { color: fuchsia; }
377span.gray { color: gray; }
378span.green { color: green; }
379span.lime { color: lime; }
380span.maroon { color: maroon; }
381span.navy { color: navy; }
382span.olive { color: olive; }
383span.purple { color: purple; }
384span.red { color: red; }
385span.silver { color: silver; }
386span.teal { color: teal; }
387span.white { color: white; }
388span.yellow { color: yellow; }
389
390span.aqua-background { background: aqua; }
391span.black-background { background: black; }
392span.blue-background { background: blue; }
393span.fuchsia-background { background: fuchsia; }
394span.gray-background { background: gray; }
395span.green-background { background: green; }
396span.lime-background { background: lime; }
397span.maroon-background { background: maroon; }
398span.navy-background { background: navy; }
399span.olive-background { background: olive; }
400span.purple-background { background: purple; }
401span.red-background { background: red; }
402span.silver-background { background: silver; }
403span.teal-background { background: teal; }
404span.white-background { background: white; }
405span.yellow-background { background: yellow; }
406
407span.big { font-size: 2em; }
408span.small { font-size: 0.6em; }
409
410span.underline { text-decoration: underline; }
411span.overline { text-decoration: overline; }
412span.line-through { text-decoration: line-through; }
413
414div.unbreakable { page-break-inside: avoid; }
415
416
417/*
418 * xhtml11 specific
419 *
420 * */
421
422div.tableblock {
423 margin-top: 1.0em;
424 margin-bottom: 1.5em;
425}
426div.tableblock > table {
427 border: 3px solid #527bbd;
428}
429thead, p.table.header {
430 font-weight: bold;
431 color: #527bbd;
432}
433p.table {
434 margin-top: 0;
435}
436/* Because the table frame attribute is overriden by CSS in most browsers. */
437div.tableblock > table[frame="void"] {
438 border-style: none;
439}
440div.tableblock > table[frame="hsides"] {
441 border-left-style: none;
442 border-right-style: none;
443}
444div.tableblock > table[frame="vsides"] {
445 border-top-style: none;
446 border-bottom-style: none;
447}
448
449
450/*
451 * html5 specific
452 *
453 * */
454
455table.tableblock {
456 margin-top: 1.0em;
457 margin-bottom: 1.5em;
458}
459thead, p.tableblock.header {
460 font-weight: bold;
461 color: #527bbd;
462}
463p.tableblock {
464 margin-top: 0;
465}
466table.tableblock {
467 border-width: 3px;
468 border-spacing: 0px;
469 border-style: solid;
470 border-color: #527bbd;
471 border-collapse: collapse;
472}
473th.tableblock, td.tableblock {
474 border-width: 1px;
475 padding: 4px;
476 border-style: solid;
477 border-color: #527bbd;
478}
479
480table.tableblock.frame-topbot {
481 border-left-style: hidden;
482 border-right-style: hidden;
483}
484table.tableblock.frame-sides {
485 border-top-style: hidden;
486 border-bottom-style: hidden;
487}
488table.tableblock.frame-none {
489 border-style: hidden;
490}
491
492th.tableblock.halign-left, td.tableblock.halign-left {
493 text-align: left;
494}
495th.tableblock.halign-center, td.tableblock.halign-center {
496 text-align: center;
497}
498th.tableblock.halign-right, td.tableblock.halign-right {
499 text-align: right;
500}
501
502th.tableblock.valign-top, td.tableblock.valign-top {
503 vertical-align: top;
504}
505th.tableblock.valign-middle, td.tableblock.valign-middle {
506 vertical-align: middle;
507}
508th.tableblock.valign-bottom, td.tableblock.valign-bottom {
509 vertical-align: bottom;
510}
511
512
513/*
514 * manpage specific
515 *
516 * */
517
518body.manpage h1 {
Junio C Hamano103b5722011-01-31 05:03:45519 padding-top: 0.5em;
520 padding-bottom: 0.5em;
521 border-top: 2px solid silver;
522 border-bottom: 2px solid silver;
523}
Junio C Hamano9d971152012-12-19 00:43:11524body.manpage h2 {
Junio C Hamano103b5722011-01-31 05:03:45525 border-style: none;
526}
Junio C Hamano9d971152012-12-19 00:43:11527body.manpage div.sectionbody {
528 margin-left: 3em;
Junio C Hamano103b5722011-01-31 05:03:45529}
530
531@media print {
Junio C Hamano9d971152012-12-19 00:43:11532 body.manpage div#toc { display: none; }
Junio C Hamano103b5722011-01-31 05:03:45533}
534
Junio C Hamano58256872007-12-04 08:31:13535
Junio C Hamano58256872007-12-04 08:31:13536</style>
Junio C Hamano7bd050f2011-09-22 06:32:22537<script type="text/javascript">
538/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22539var asciidoc = { // Namespace.
540
541/////////////////////////////////////////////////////////////////////
542// Table Of Contents generator
543/////////////////////////////////////////////////////////////////////
544
545/* Author: Mihai Bazon, September 2002
546 * http://students.infoiasi.ro/~mishoo
547 *
548 * Table Of Content generator
549 * Version: 0.4
550 *
551 * Feel free to use this script under the terms of the GNU General Public
552 * License, as long as you do not remove or alter this notice.
553 */
554
555 /* modified by Troy D. Hanson, September 2006. License: GPL */
556 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
557
558// toclevels = 1..4.
559toc: function (toclevels) {
560
561 function getText(el) {
562 var text = "";
563 for (var i = el.firstChild; i != null; i = i.nextSibling) {
564 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
565 text += i.data;
566 else if (i.firstChild != null)
567 text += getText(i);
568 }
569 return text;
570 }
571
572 function TocEntry(el, text, toclevel) {
573 this.element = el;
574 this.text = text;
575 this.toclevel = toclevel;
576 }
577
578 function tocEntries(el, toclevels) {
579 var result = new Array;
Junio C Hamano9d971152012-12-19 00:43:11580 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22581 // Function that scans the DOM tree for header elements (the DOM2
582 // nodeIterator API would be a better technique but not supported by all
583 // browsers).
584 var iterate = function (el) {
585 for (var i = el.firstChild; i != null; i = i.nextSibling) {
586 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
587 var mo = re.exec(i.tagName);
588 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
589 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
590 }
591 iterate(i);
592 }
593 }
594 }
595 iterate(el);
596 return result;
597 }
598
599 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11600 if (!toc) {
601 return;
602 }
603
604 // Delete existing TOC entries in case we're reloading the TOC.
605 var tocEntriesToRemove = [];
606 var i;
607 for (i = 0; i < toc.childNodes.length; i++) {
608 var entry = toc.childNodes[i];
609 if (entry.nodeName.toLowerCase() == 'div'
610 && entry.getAttribute("class")
611 && entry.getAttribute("class").match(/^toclevel/))
612 tocEntriesToRemove.push(entry);
613 }
614 for (i = 0; i < tocEntriesToRemove.length; i++) {
615 toc.removeChild(tocEntriesToRemove[i]);
616 }
617
618 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22619 var entries = tocEntries(document.getElementById("content"), toclevels);
620 for (var i = 0; i < entries.length; ++i) {
621 var entry = entries[i];
622 if (entry.element.id == "")
623 entry.element.id = "_toc_" + i;
624 var a = document.createElement("a");
625 a.href = "#" + entry.element.id;
626 a.appendChild(document.createTextNode(entry.text));
627 var div = document.createElement("div");
628 div.appendChild(a);
629 div.className = "toclevel" + entry.toclevel;
630 toc.appendChild(div);
631 }
632 if (entries.length == 0)
633 toc.parentNode.removeChild(toc);
634},
635
636
637/////////////////////////////////////////////////////////////////////
638// Footnotes generator
639/////////////////////////////////////////////////////////////////////
640
641/* Based on footnote generation code from:
642 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
643 */
644
645footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11646 // Delete existing footnote entries in case we're reloading the footnodes.
647 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22648 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11649 if (!noteholder) {
650 return;
651 }
652 var entriesToRemove = [];
653 for (i = 0; i < noteholder.childNodes.length; i++) {
654 var entry = noteholder.childNodes[i];
655 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
656 entriesToRemove.push(entry);
657 }
658 for (i = 0; i < entriesToRemove.length; i++) {
659 noteholder.removeChild(entriesToRemove[i]);
660 }
661
662 // Rebuild footnote entries.
663 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22664 var spans = cont.getElementsByTagName("span");
665 var refs = {};
666 var n = 0;
667 for (i=0; i<spans.length; i++) {
668 if (spans[i].className == "footnote") {
669 n++;
Junio C Hamano9d971152012-12-19 00:43:11670 var note = spans[i].getAttribute("data-note");
671 if (!note) {
672 // Use [\s\S] in place of . so multi-line matches work.
673 // Because JavaScript has no s (dotall) regex flag.
674 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
675 spans[i].innerHTML =
676 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
677 "' title='View footnote' class='footnote'>" + n + "</a>]";
678 spans[i].setAttribute("data-note", note);
679 }
Junio C Hamano7bd050f2011-09-22 06:32:22680 noteholder.innerHTML +=
681 "<div class='footnote' id='_footnote_" + n + "'>" +
682 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
683 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22684 var id =spans[i].getAttribute("id");
685 if (id != null) refs["#"+id] = n;
686 }
687 }
688 if (n == 0)
689 noteholder.parentNode.removeChild(noteholder);
690 else {
691 // Process footnoterefs.
692 for (i=0; i<spans.length; i++) {
693 if (spans[i].className == "footnoteref") {
694 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
695 href = href.match(/#.*/)[0]; // Because IE return full URL.
696 n = refs[href];
697 spans[i].innerHTML =
698 "[<a href='#_footnote_" + n +
699 "' title='View footnote' class='footnote'>" + n + "</a>]";
700 }
701 }
702 }
Junio C Hamano9d971152012-12-19 00:43:11703},
704
705install: function(toclevels) {
706 var timerId;
707
708 function reinstall() {
709 asciidoc.footnotes();
710 if (toclevels) {
711 asciidoc.toc(toclevels);
712 }
713 }
714
715 function reinstallAndRemoveTimer() {
716 clearInterval(timerId);
717 reinstall();
718 }
719
720 timerId = setInterval(reinstall, 500);
721 if (document.addEventListener)
722 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
723 else
724 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22725}
726
727}
Junio C Hamano9d971152012-12-19 00:43:11728asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22729/*]]>*/
730</script>
Junio C Hamano58256872007-12-04 08:31:13731</head>
Junio C Hamano9d971152012-12-19 00:43:11732<body class="manpage">
Junio C Hamano58256872007-12-04 08:31:13733<div id="header">
734<h1>
735git-help(1) Manual Page
736</h1>
737<h2>NAME</h2>
738<div class="sectionbody">
739<p>git-help -
Junio C Hamano076ffcc2013-02-06 05:13:21740 Display help information about Git
Junio C Hamano58256872007-12-04 08:31:13741</p>
742</div>
743</div>
Junio C Hamano7bd050f2011-09-22 06:32:22744<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11745<div class="sect1">
Junio C Hamano103b5722011-01-31 05:03:45746<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano58256872007-12-04 08:31:13747<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59748<div class="verseblock">
Junio C Hamano9d971152012-12-19 00:43:11749<pre class="content"><em>git help</em> [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]</pre>
750<div class="attribution">
Junio C Hamano15567bc2011-07-23 00:51:59751</div></div>
Junio C Hamano58256872007-12-04 08:31:13752</div>
Junio C Hamano9d971152012-12-19 00:43:11753</div>
754<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31755<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano58256872007-12-04 08:31:13756<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45757<div class="paragraph"><p>With no options and no COMMAND given, the synopsis of the <em>git</em>
Junio C Hamano076ffcc2013-02-06 05:13:21758command and a list of the most commonly used Git commands are printed
Junio C Hamanoba4b9282008-07-06 05:20:31759on the standard output.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45760<div class="paragraph"><p>If the option <em>--all</em> or <em>-a</em> is given, then all available commands are
Junio C Hamanoba4b9282008-07-06 05:20:31761printed on the standard output.</p></div>
Junio C Hamano076ffcc2013-02-06 05:13:21762<div class="paragraph"><p>If a Git subcommand is named, a manual page for that subcommand is brought
Junio C Hamano0c0da5f2007-12-13 02:45:30763up. The <em>man</em> program is used by default for this purpose, but this
Junio C Hamanoba4b9282008-07-06 05:20:31764can be overridden by other options or configuration variables.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11765<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:31766former is internally converted into the latter.</p></div>
Junio C Hamano58256872007-12-04 08:31:13767</div>
Junio C Hamano9d971152012-12-19 00:43:11768</div>
769<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31770<h2 id="_options">OPTIONS</h2>
Junio C Hamano58256872007-12-04 08:31:13771<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45772<div class="dlist"><dl>
773<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47774-a
775</dt>
Junio C Hamano103b5722011-01-31 05:03:45776<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47777--all
Junio C Hamano58256872007-12-04 08:31:13778</dt>
779<dd>
780<p>
781 Prints all the available commands on the standard output. This
Junio C Hamanofe986052007-12-19 07:33:38782 option supersedes any other option.
Junio C Hamano58256872007-12-04 08:31:13783</p>
784</dd>
Junio C Hamano103b5722011-01-31 05:03:45785<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47786-i
787</dt>
Junio C Hamano103b5722011-01-31 05:03:45788<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47789--info
Junio C Hamano0c0da5f2007-12-13 02:45:30790</dt>
791<dd>
792<p>
Junio C Hamano8b588d52008-03-15 09:48:37793 Display manual page for the command in the <em>info</em> format. The
794 <em>info</em> program will be used for that purpose.
Junio C Hamano0c0da5f2007-12-13 02:45:30795</p>
796</dd>
Junio C Hamano103b5722011-01-31 05:03:45797<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47798-m
799</dt>
Junio C Hamano103b5722011-01-31 05:03:45800<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47801--man
Junio C Hamano3dac5042007-12-15 08:40:54802</dt>
803<dd>
804<p>
Junio C Hamano8b588d52008-03-15 09:48:37805 Display manual page for the command in the <em>man</em> format. This
806 option may be used to override a value set in the
807 <em>help.format</em> configuration variable.
Junio C Hamano3dac5042007-12-15 08:40:54808</p>
Junio C Hamano103b5722011-01-31 05:03:45809<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:37810but the <em>man.viewer</em> configuration variable may be used to choose
Junio C Hamanoba4b9282008-07-06 05:20:31811other display programs (see below).</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54812</dd>
Junio C Hamano103b5722011-01-31 05:03:45813<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47814-w
815</dt>
Junio C Hamano103b5722011-01-31 05:03:45816<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47817--web
Junio C Hamano0c0da5f2007-12-13 02:45:30818</dt>
819<dd>
820<p>
Junio C Hamano8b588d52008-03-15 09:48:37821 Display manual page for the command in the <em>web</em> (HTML)
822 format. A web browser will be used for that purpose.
Junio C Hamano0c0da5f2007-12-13 02:45:30823</p>
Junio C Hamano103b5722011-01-31 05:03:45824<div class="paragraph"><p>The web browser can be specified using the configuration variable
Junio C Hamano0c0da5f2007-12-13 02:45:30825<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:06826these config variables is set, the <em>git web&#45;&#45;browse</em> helper script
Junio C Hamano1aa40d22010-01-21 17:46:43827(called by <em>git help</em>) will pick a suitable default. See
Junio C Hamanoa28a9202012-06-21 07:08:23828<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:30829</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31830</dl></div>
Junio C Hamano58256872007-12-04 08:31:13831</div>
Junio C Hamano9d971152012-12-19 00:43:11832</div>
833<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31834<h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
Junio C Hamano3dac5042007-12-15 08:40:54835<div class="sectionbody">
Junio C Hamano9d971152012-12-19 00:43:11836<div class="sect2">
837<h3 id="_help_format">help.format</h3>
Junio C Hamano103b5722011-01-31 05:03:45838<div class="paragraph"><p>If no command line option is passed, the <em>help.format</em> configuration
Junio C Hamano3dac5042007-12-15 08:40:54839variable will be checked. The following values are supported for this
Junio C Hamano1aa40d22010-01-21 17:46:43840variable; they make <em>git help</em> behave as their corresponding command
Junio C Hamanoba4b9282008-07-06 05:20:31841line option:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45842<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54843<li>
844<p>
845"man" corresponds to <em>-m|--man</em>,
846</p>
847</li>
848<li>
849<p>
850"info" corresponds to <em>-i|--info</em>,
851</p>
852</li>
853<li>
854<p>
Junio C Hamano8b588d52008-03-15 09:48:37855"web" or "html" correspond to <em>-w|--web</em>.
Junio C Hamano3dac5042007-12-15 08:40:54856</p>
857</li>
Junio C Hamanoba4b9282008-07-06 05:20:31858</ul></div>
Junio C Hamano9d971152012-12-19 00:43:11859</div>
860<div class="sect2">
861<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:45862<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 Hamanofe986052007-12-19 07:33:38863be checked if the <em>web</em> format is chosen (either by command line
Junio C Hamano3dac5042007-12-15 08:40:54864option or configuration variable). See <em>-w|--web</em> in the OPTIONS
Junio C Hamanoa28a9202012-06-21 07:08:23865section 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:11866</div>
867<div class="sect2">
868<h3 id="_man_viewer">man.viewer</h3>
Junio C Hamano103b5722011-01-31 05:03:45869<div class="paragraph"><p>The <em>man.viewer</em> config variable will be checked if the <em>man</em> format
Junio C Hamanoba4b9282008-07-06 05:20:31870is chosen. The following values are currently supported:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45871<div class="ulist"><ul>
Junio C Hamano8b588d52008-03-15 09:48:37872<li>
873<p>
874"man": use the <em>man</em> program as usual,
875</p>
876</li>
877<li>
878<p>
879"woman": use <em>emacsclient</em> to launch the "woman" mode in emacs
880(this only works starting with emacsclient versions 22),
881</p>
882</li>
883<li>
884<p>
Junio C Hamano6d76d612008-05-09 05:46:08885"konqueror": use <em>kfmclient</em> to open the man page in a new konqueror
886tab (see <em>Note about konqueror</em> below).
Junio C Hamano8b588d52008-03-15 09:48:37887</p>
888</li>
Junio C Hamanoba4b9282008-07-06 05:20:31889</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45890<div class="paragraph"><p>Values for other tools can be used if there is a corresponding
Junio C Hamanoba4b9282008-07-06 05:20:31891<em>man.&lt;tool&gt;.cmd</em> configuration entry (see below).</p></div>
Junio C Hamano103b5722011-01-31 05:03:45892<div class="paragraph"><p>Multiple values may be given to the <em>man.viewer</em> configuration
Junio C Hamano6d76d612008-05-09 05:46:08893variable. Their corresponding programs will be tried in the order
Junio C Hamanoba4b9282008-07-06 05:20:31894listed in the configuration file.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45895<div class="paragraph"><p>For example, this configuration:</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08896<div class="listingblock">
Junio C Hamano8b588d52008-03-15 09:48:37897<div class="content">
Junio C Hamano9d971152012-12-19 00:43:11898<pre><code> [man]
Junio C Hamano6d76d612008-05-09 05:46:08899 viewer = konqueror
Junio C Hamano9d971152012-12-19 00:43:11900 viewer = woman</code></pre>
Junio C Hamano8b588d52008-03-15 09:48:37901</div></div>
Junio C Hamano103b5722011-01-31 05:03:45902<div class="paragraph"><p>will try to use konqueror first. But this may fail (for example if
Junio C Hamanoba4b9282008-07-06 05:20:31903DISPLAY is not set) and in that case emacs' woman mode will be tried.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45904<div class="paragraph"><p>If everything fails, or if no viewer is configured, the viewer specified
Junio C Hamanoa2f46622008-09-03 05:20:31905in the GIT_MAN_VIEWER environment variable will be tried. If that
906fails too, the <em>man</em> program will be tried anyway.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11907</div>
908<div class="sect2">
909<h3 id="_man_lt_tool_gt_path">man.&lt;tool&gt;.path</h3>
Junio C Hamano103b5722011-01-31 05:03:45910<div class="paragraph"><p>You can explicitly provide a full path to your preferred man viewer by
Junio C Hamano6d76d612008-05-09 05:46:08911setting the configuration variable <em>man.&lt;tool&gt;.path</em>. For example, you
912can configure the absolute path to konqueror by setting
Junio C Hamano1aa40d22010-01-21 17:46:43913<em>man.konqueror.path</em>. Otherwise, <em>git help</em> assumes the tool is
Junio C Hamanoba4b9282008-07-06 05:20:31914available in PATH.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11915</div>
916<div class="sect2">
917<h3 id="_man_lt_tool_gt_cmd">man.&lt;tool&gt;.cmd</h3>
Junio C Hamano103b5722011-01-31 05:03:45918<div class="paragraph"><p>When the man viewer, specified by the <em>man.viewer</em> configuration
Junio C Hamano6d76d612008-05-09 05:46:08919variables, is not among the supported ones, then the corresponding
920<em>man.&lt;tool&gt;.cmd</em> configuration variable will be looked up. If this
921variable exists then the specified tool will be treated as a custom
922command and a shell eval will be used to run the command with the man
Junio C Hamanoba4b9282008-07-06 05:20:31923page passed as arguments.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11924</div>
925<div class="sect2">
926<h3 id="_note_about_konqueror">Note about konqueror</h3>
Junio C Hamano103b5722011-01-31 05:03:45927<div class="paragraph"><p>When <em>konqueror</em> is specified in the <em>man.viewer</em> configuration
Junio C Hamano6d76d612008-05-09 05:46:08928variable, we launch <em>kfmclient</em> to try to open the man page on an
Junio C Hamanoba4b9282008-07-06 05:20:31929already opened konqueror in a new tab if possible.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45930<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:08931set to something like <em>A_PATH_TO/konqueror</em>. That means we will try to
Junio C Hamanoba4b9282008-07-06 05:20:31932launch <em>A_PATH_TO/kfmclient</em> instead.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45933<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:31934the following:</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08935<div class="listingblock">
936<div class="content">
Junio C Hamano9d971152012-12-19 00:43:11937<pre><code> [man]
Junio C Hamano6d76d612008-05-09 05:46:08938 viewer = konq
939
940 [man "konq"]
Junio C Hamano9d971152012-12-19 00:43:11941 cmd = A_PATH_TO/konqueror</code></pre>
Junio C Hamano6d76d612008-05-09 05:46:08942</div></div>
Junio C Hamano9d971152012-12-19 00:43:11943</div>
944<div class="sect2">
945<h3 id="_note_about_git_config_global">Note about git config --global</h3>
Junio C Hamano103b5722011-01-31 05:03:45946<div class="paragraph"><p>Note that all these configuration variables should probably be set
Junio C Hamanoba4b9282008-07-06 05:20:31947using the <em>--global</em> flag, for example like this:</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54948<div class="listingblock">
949<div class="content">
Junio C Hamano9d971152012-12-19 00:43:11950<pre><code>$ git config --global help.format web
951$ git config --global web.browser firefox</code></pre>
Junio C Hamano3dac5042007-12-15 08:40:54952</div></div>
Junio C Hamano103b5722011-01-31 05:03:45953<div class="paragraph"><p>as they are probably more user specific than repository specific.
Junio C Hamanoa28a9202012-06-21 07:08:23954See <a href="git-config.html">git-config(1)</a> for more information about this.</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54955</div>
Junio C Hamano9d971152012-12-19 00:43:11956</div>
957</div>
958<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31959<h2 id="_git">GIT</h2>
Junio C Hamano58256872007-12-04 08:31:13960<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23961<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano58256872007-12-04 08:31:13962</div>
Junio C Hamano7bd050f2011-09-22 06:32:22963</div>
Junio C Hamano9d971152012-12-19 00:43:11964</div>
Junio C Hamano7bd050f2011-09-22 06:32:22965<div id="footnotes"><hr /></div>
Junio C Hamano58256872007-12-04 08:31:13966<div id="footer">
967<div id="footer-text">
Junio C Hamano076ffcc2013-02-06 05:13:21968Last updated 2013-02-05 21:07:26 PST
Junio C Hamano58256872007-12-04 08:31:13969</div>
970</div>
971</body>
972</html>