Google Git
Sign in
chromium / external / gitster / git-htmldocs / a65c1f44a0fb82bf498be0911b85fa42bb70147f / . / git-help.html
blob: d677482b0cf9f637a0b9bd64a4171624ad2a96b8 [file] [log] [blame]
Junio C Hamano944ce252018-05-30 22:25:26[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5<head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamano98c882d2020-08-13 22:06:57[diff] [blame]7<meta name="generator" content="AsciiDoc 9.0.0rc2" />
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]8<title>git-help(1)</title>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]9<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]38
39em {
40 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]41 color: navy;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]42}
43
44strong {
45 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]46 color: #083194;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]47}
48
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h1, h2, h3 {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]57 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]60 padding-top: 0.5em;
61}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]68h5 {
69 font-size: 1.0em;
70}
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]71
72div.sectionbody {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]85ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]88ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]90
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]95 padding: 0;
96 margin: 0;
97}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]98pre {
99 white-space: pre-wrap;
100}
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]101
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]102#author {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]103 color: #527bbd;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]104 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]105 font-size: 1.1em;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]106}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]107#email {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]108}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]109#revnumber, #revdate, #revremark {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]110}
111
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]112#footer {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]118#footer-text {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]122#footer-badges {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]127#preamble {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]134 margin-top: 1.0em;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]150 color: #527bbd;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]187 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]190}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]191
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]194 text-align: right;
195}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]196
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]209
210div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]220 border-left: 3px solid #dddddd;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]226}
227
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]230a.image:visited { color: white; }
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]239 font-style: normal;
240 color: navy;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]241}
242dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]243 margin-top: 0.1em;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]253 list-style-type: lower-alpha;
254}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]271
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]272tfoot {
273 font-weight: bold;
274}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]278
279div.hdlist {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]285}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]290 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]291 font-style: normal;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]292 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]293 color: navy;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]294}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]295td.hdlist2 {
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]296 vertical-align: top;
297}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]306
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
324#footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332}
333
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]341}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]342
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]351#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]352 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40[diff] [blame]439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]527body.manpage h2 {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]528 border-style: none;
529}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]532}
533
534@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]535 body.manpage div#toc { display: none; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]536}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]537
538
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]612 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]651 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]728}
729
730}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]732/*]]>*/
733</script>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]734</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]735<body class="manpage">
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]736<div id="header">
737<h1>
738git-help(1) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>git-help -
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]743 Display help information about Git
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]744</p>
745</div>
746</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]747<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]748<div class="sect1">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]749<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]750<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]751<div class="verseblock">
Junio C Hamano9c649b42020-07-31 05:19:26[diff] [blame]752<pre class="content"><em>git help</em> [-a|--all [--[no-]verbose]] [-g|--guides]
Junio C Hamano0eb11502013-04-12 02:14:19[diff] [blame]753 [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]</pre>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]754<div class="attribution">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]755</div></div>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]756</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]757</div>
758<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]759<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]760<div class="sectionbody">
Junio C Hamano0eb11502013-04-12 02:14:19[diff] [blame]761<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:21[diff] [blame]762command and a list of the most commonly used Git commands are printed
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]763on the standard output.</p></div>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]764<div class="paragraph"><p>If the option <code>--all</code> or <code>-a</code> is given, all available commands are
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]765printed on the standard output.</p></div>
Junio C Hamanoc9dd6422020-08-10 23:32:55[diff] [blame]766<div class="paragraph"><p>If the option <code>--guides</code> or <code>-g</code> is given, a list of the
767Git concept guides is also printed on the standard output.</p></div>
Junio C Hamano0eb11502013-04-12 02:14:19[diff] [blame]768<div class="paragraph"><p>If a command, or a guide, is given, a manual page for that command or
769guide is brought up. The <em>man</em> program is used by default for this
770purpose, but this can be overridden by other options or configuration
771variables.</p></div>
Junio C Hamanoa4df8ed2018-10-26 06:37:13[diff] [blame]772<div class="paragraph"><p>If an alias is given, git shows the definition of the alias on
773standard output. To get the manual page for the aliased command, use
774<code>git COMMAND --help</code>.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]775<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:31[diff] [blame]776former is internally converted into the latter.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]777<div class="paragraph"><p>To display the <a href="git.html">git(1)</a> man page, use <code>git help git</code>.</p></div>
778<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:13[diff] [blame]779</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]780</div>
781<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]782<h2 id="_options">OPTIONS</h2>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]783<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]784<div class="dlist"><dl>
785<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]786-a
787</dt>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]788<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]789--all
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]790</dt>
791<dd>
792<p>
793 Prints all the available commands on the standard output. This
Junio C Hamano0eb11502013-04-12 02:14:19[diff] [blame]794 option overrides any given command or guide name.
Junio C Hamanoabe2c592018-10-19 05:42:53[diff] [blame]795</p>
796</dd>
797<dt class="hdlist1">
798--verbose
799</dt>
800<dd>
801<p>
802 When used with <code>--all</code> print description for all recognized
803 commands. This is the default.
Junio C Hamano0eb11502013-04-12 02:14:19[diff] [blame]804</p>
805</dd>
806<dt class="hdlist1">
Junio C Hamanoec40f132018-06-28 21:40:57[diff] [blame]807-c
808</dt>
809<dt class="hdlist1">
810--config
811</dt>
812<dd>
813<p>
814 List all available configuration variables. This is a short
815 summary of the list in <a href="git-config.html">git-config(1)</a>.
816</p>
817</dd>
818<dt class="hdlist1">
Junio C Hamano0eb11502013-04-12 02:14:19[diff] [blame]819-g
820</dt>
821<dt class="hdlist1">
822--guides
823</dt>
824<dd>
825<p>
Junio C Hamanoc9dd6422020-08-10 23:32:55[diff] [blame]826 Prints a list of the Git concept guides on the standard output. This
Junio C Hamano0eb11502013-04-12 02:14:19[diff] [blame]827 option overrides any given command or guide name.
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]828</p>
829</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]830<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]831-i
832</dt>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]833<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]834--info
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]835</dt>
836<dd>
837<p>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]838 Display manual page for the command in the <em>info</em> format. The
839 <em>info</em> program will be used for that purpose.
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]840</p>
841</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]842<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]843-m
844</dt>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]845<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]846--man
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]847</dt>
848<dd>
849<p>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]850 Display manual page for the command in the <em>man</em> format. This
851 option may be used to override a value set in the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]852 <code>help.format</code> configuration variable.
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]853</p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]854<div class="paragraph"><p>By default the <em>man</em> program will be used to display the manual page,
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]855but the <code>man.viewer</code> configuration variable may be used to choose
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]856other display programs (see below).</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]857</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]858<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]859-w
860</dt>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]861<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]862--web
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]863</dt>
864<dd>
865<p>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]866 Display manual page for the command in the <em>web</em> (HTML)
867 format. A web browser will be used for that purpose.
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]868</p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]869<div class="paragraph"><p>The web browser can be specified using the configuration variable
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]870<code>help.browser</code>, or <code>web.browser</code> if the former is not set. If none of
Junio C Hamano2db3e752010-09-03 21:33:06[diff] [blame]871these config variables is set, the <em>git web&#45;&#45;browse</em> helper script
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]872(called by <em>git help</em>) will pick a suitable default. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]873<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:30[diff] [blame]874</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]875</dl></div>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]876</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]877</div>
878<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]879<h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]880<div class="sectionbody">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]881<div class="sect2">
882<h3 id="_help_format">help.format</h3>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]883<div class="paragraph"><p>If no command-line option is passed, the <code>help.format</code> configuration
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]884variable will be checked. The following values are supported for this
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]885variable; they make <em>git help</em> behave as their corresponding command-
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]886line option:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]887<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]888<li>
889<p>
890"man" corresponds to <em>-m|--man</em>,
891</p>
892</li>
893<li>
894<p>
895"info" corresponds to <em>-i|--info</em>,
896</p>
897</li>
898<li>
899<p>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]900"web" or "html" correspond to <em>-w|--web</em>.
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]901</p>
902</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]903</ul></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]904</div>
905<div class="sect2">
906<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 Hamano042f2142016-06-27 18:05:05[diff] [blame]907<div class="paragraph"><p>The <code>help.browser</code>, <code>web.browser</code> and <code>browser.&lt;tool&gt;.path</code> will also
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]908be checked if the <em>web</em> format is chosen (either by command-line
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]909option or configuration variable). See <em>-w|--web</em> in the OPTIONS
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]910section 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:11[diff] [blame]911</div>
912<div class="sect2">
913<h3 id="_man_viewer">man.viewer</h3>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]914<div class="paragraph"><p>The <code>man.viewer</code> configuration variable will be checked if the <em>man</em>
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]915format is chosen. The following values are currently supported:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]916<div class="ulist"><ul>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]917<li>
918<p>
919"man": use the <em>man</em> program as usual,
920</p>
921</li>
922<li>
923<p>
924"woman": use <em>emacsclient</em> to launch the "woman" mode in emacs
Junio C Hamano2567b322019-02-05 23:33:56[diff] [blame]925 (this only works starting with emacsclient versions 22),
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]926</p>
927</li>
928<li>
929<p>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]930"konqueror": use <em>kfmclient</em> to open the man page in a new konqueror
Junio C Hamano2567b322019-02-05 23:33:56[diff] [blame]931 tab (see <em>Note about konqueror</em> below).
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]932</p>
933</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]934</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]935<div class="paragraph"><p>Values for other tools can be used if there is a corresponding
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]936<code>man.&lt;tool&gt;.cmd</code> configuration entry (see below).</p></div>
937<div class="paragraph"><p>Multiple values may be given to the <code>man.viewer</code> configuration
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]938variable. Their corresponding programs will be tried in the order
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]939listed in the configuration file.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]940<div class="paragraph"><p>For example, this configuration:</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]941<div class="listingblock">
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]942<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]943<pre><code> [man]
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]944 viewer = konqueror
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]945 viewer = woman</code></pre>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]946</div></div>
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]947<div class="paragraph"><p>will try to use konqueror first. But this may fail (for example, if
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]948DISPLAY is not set) and in that case emacs' woman mode will be tried.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]949<div class="paragraph"><p>If everything fails, or if no viewer is configured, the viewer specified
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]950in the <code>GIT_MAN_VIEWER</code> environment variable will be tried. If that
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]951fails too, the <em>man</em> program will be tried anyway.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]952</div>
953<div class="sect2">
954<h3 id="_man_lt_tool_gt_path">man.&lt;tool&gt;.path</h3>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]955<div class="paragraph"><p>You can explicitly provide a full path to your preferred man viewer by
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]956setting the configuration variable <code>man.&lt;tool&gt;.path</code>. For example, you
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]957can configure the absolute path to konqueror by setting
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]958<em>man.konqueror.path</em>. Otherwise, <em>git help</em> assumes the tool is
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]959available in PATH.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]960</div>
961<div class="sect2">
962<h3 id="_man_lt_tool_gt_cmd">man.&lt;tool&gt;.cmd</h3>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]963<div class="paragraph"><p>When the man viewer, specified by the <code>man.viewer</code> configuration
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]964variables, is not among the supported ones, then the corresponding
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]965<code>man.&lt;tool&gt;.cmd</code> configuration variable will be looked up. If this
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]966variable exists then the specified tool will be treated as a custom
967command and a shell eval will be used to run the command with the man
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]968page passed as arguments.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]969</div>
970<div class="sect2">
971<h3 id="_note_about_konqueror">Note about konqueror</h3>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]972<div class="paragraph"><p>When <em>konqueror</em> is specified in the <code>man.viewer</code> configuration
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]973variable, we launch <em>kfmclient</em> to try to open the man page on an
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]974already opened konqueror in a new tab if possible.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]975<div class="paragraph"><p>For consistency, we also try such a trick if <em>man.konqueror.path</em> is
Junio C Hamanob5513772019-04-22 03:38:39[diff] [blame]976set to something like <code>A_PATH_TO/konqueror</code>. That means we will try to
977launch <code>A_PATH_TO/kfmclient</code> instead.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]978<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:31[diff] [blame]979the following:</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]980<div class="listingblock">
981<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]982<pre><code> [man]
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]983 viewer = konq
984
985 [man "konq"]
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]986 cmd = A_PATH_TO/konqueror</code></pre>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]987</div></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]988</div>
989<div class="sect2">
990<h3 id="_note_about_git_config_global">Note about git config --global</h3>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]991<div class="paragraph"><p>Note that all these configuration variables should probably be set
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]992using the <code>--global</code> flag, for example like this:</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]993<div class="listingblock">
994<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]995<pre><code>$ git config --global help.format web
996$ git config --global web.browser firefox</code></pre>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]997</div></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]998<div class="paragraph"><p>as they are probably more user specific than repository specific.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]999See <a href="git-config.html">git-config(1)</a> for more information about this.</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]1000</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1001</div>
1002</div>
1003<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1004<h2 id="_git">GIT</h2>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]1005<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1006<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]1007</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1008</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1009</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1010<div id="footnotes"><hr /></div>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]1011<div id="footer">
1012<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]1013Last updated
Junio C Hamanoc9dd6422020-08-10 23:32:55[diff] [blame]1014 2020-08-10 16:30:08 PDT
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]1015</div>
1016</div>
1017</body>
1018</html>