git-help.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   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>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-help(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.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 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.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
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var 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.
 562 toc: 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;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 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");
 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];
 612     if (entry.nodeName.toLowerCase() == 'div'
 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.
 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
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 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");
 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++;
 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       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 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   }
 706 },
 707
 708 install: 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;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-help(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-help -
 743    Display help information about Git
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git help</em> [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases]
 753 <em>git help</em> [[-i|--info] [-m|--man] [-w|--web]] [&lt;command&gt;|&lt;doc&gt;]
 754 <em>git help</em> [-g|--guides]
 755 <em>git help</em> [-c|--config]
 756 <em>git help</em> [--user-interfaces]
 757 <em>git help</em> [--developer-interfaces]</pre>
 758 <div class="attribution">
 759 </div></div>
 760 </div>
 761 </div>
 762 <div class="sect1">
 763 <h2 id="_description">DESCRIPTION</h2>
 764 <div class="sectionbody">
 765 <div class="paragraph"><p>With no options and no <em>&lt;command&gt;</em> or <em>&lt;doc&gt;</em> given, the synopsis of the <em>git</em>
 766 command and a list of the most commonly used Git commands are printed
 767 on the standard output.</p></div>
 768 <div class="paragraph"><p>If the option <code>--all</code> or <code>-a</code> is given, all available commands are
 769 printed on the standard output.</p></div>
 770 <div class="paragraph"><p>If the option <code>--guides</code> or <code>-g</code> is given, a list of the
 771 Git concept guides is also printed on the standard output.</p></div>
 772 <div class="paragraph"><p>If a command or other documentation is given, the relevant manual page
 773 will be brought up. The <em>man</em> program is used by default for this
 774 purpose, but this can be overridden by other options or configuration
 775 variables.</p></div>
 776 <div class="paragraph"><p>If an alias is given, git shows the definition of the alias on
 777 standard output. To get the manual page for the aliased command, use
 778 <code>git &lt;command&gt; --help</code>.</p></div>
 779 <div class="paragraph"><p>Note that <code>git --help ...</code> is identical to <code>git help ...</code> because the
 780 former is internally converted into the latter.</p></div>
 781 <div class="paragraph"><p>To display the <a href="git.html">git(1)</a> man page, use <code>git help git</code>.</p></div>
 782 <div class="paragraph"><p>This page can be displayed with <em>git help help</em> or <code>git help --help</code>.</p></div>
 783 </div>
 784 </div>
 785 <div class="sect1">
 786 <h2 id="_options">OPTIONS</h2>
 787 <div class="sectionbody">
 788 <div class="dlist"><dl>
 789 <dt class="hdlist1">
 790 -a
 791 </dt>
 792 <dt class="hdlist1">
 793 --all
 794 </dt>
 795 <dd>
 796 <p>
 797         Print all the available commands on the standard output.
 798 </p>
 799 </dd>
 800 <dt class="hdlist1">
 801 --no-external-commands
 802 </dt>
 803 <dd>
 804 <p>
 805         When used with <code>--all</code>, exclude the listing of external "git-*"
 806         commands found in the <code>$PATH</code>.
 807 </p>
 808 </dd>
 809 <dt class="hdlist1">
 810 --no-aliases
 811 </dt>
 812 <dd>
 813 <p>
 814         When used with <code>--all</code>, exclude the listing of configured
 815         aliases.
 816 </p>
 817 </dd>
 818 <dt class="hdlist1">
 819 --verbose
 820 </dt>
 821 <dd>
 822 <p>
 823         When used with <code>--all</code>, print description for all recognized
 824         commands. This is the default.
 825 </p>
 826 </dd>
 827 <dt class="hdlist1">
 828 -c
 829 </dt>
 830 <dt class="hdlist1">
 831 --config
 832 </dt>
 833 <dd>
 834 <p>
 835         List all available configuration variables. This is a short
 836         summary of the list in <a href="git-config.html">git-config(1)</a>.
 837 </p>
 838 </dd>
 839 <dt class="hdlist1">
 840 -g
 841 </dt>
 842 <dt class="hdlist1">
 843 --guides
 844 </dt>
 845 <dd>
 846 <p>
 847         Print a list of the Git concept guides on the standard output.
 848 </p>
 849 </dd>
 850 <dt class="hdlist1">
 851 --user-interfaces
 852 </dt>
 853 <dd>
 854 <p>
 855         Print a list of the repository, command and file interfaces
 856         documentation on the standard output.
 857 </p>
 858 <div class="paragraph"><p>In-repository file interfaces such as <code>.git/info/exclude</code> are
 859 documented here (see <a href="gitrepository-layout.html">gitrepository-layout(5)</a>), as well as
 860 in-tree configuration such as <code>.mailmap</code> (see <a href="gitmailmap.html">gitmailmap(5)</a>).</p></div>
 861 <div class="paragraph"><p>This section of the documentation also covers general or widespread
 862 user-interface conventions (e.g. <a href="gitcli.html">gitcli(7)</a>), and
 863 pseudo-configuration such as the file-based <code>.git/hooks/*</code> interface
 864 described in <a href="githooks.html">githooks(5)</a>.</p></div>
 865 </dd>
 866 <dt class="hdlist1">
 867 --developer-interfaces
 868 </dt>
 869 <dd>
 870 <p>
 871         Print a list of file formats, protocols and other developer
 872         interfaces documentation on the standard output.
 873 </p>
 874 </dd>
 875 <dt class="hdlist1">
 876 -i
 877 </dt>
 878 <dt class="hdlist1">
 879 --info
 880 </dt>
 881 <dd>
 882 <p>
 883         Display manual page for the command in the <em>info</em> format. The
 884         <em>info</em> program will be used for that purpose.
 885 </p>
 886 </dd>
 887 <dt class="hdlist1">
 888 -m
 889 </dt>
 890 <dt class="hdlist1">
 891 --man
 892 </dt>
 893 <dd>
 894 <p>
 895         Display manual page for the command in the <em>man</em> format. This
 896         option may be used to override a value set in the
 897         <code>help.format</code> configuration variable.
 898 </p>
 899 <div class="paragraph"><p>By default the <em>man</em> program will be used to display the manual page,
 900 but the <code>man.viewer</code> configuration variable may be used to choose
 901 other display programs (see below).</p></div>
 902 </dd>
 903 <dt class="hdlist1">
 904 -w
 905 </dt>
 906 <dt class="hdlist1">
 907 --web
 908 </dt>
 909 <dd>
 910 <p>
 911         Display manual page for the command in the <em>web</em> (HTML)
 912         format. A web browser will be used for that purpose.
 913 </p>
 914 <div class="paragraph"><p>The web browser can be specified using the configuration variable
 915 <code>help.browser</code>, or <code>web.browser</code> if the former is not set. If neither of
 916 these config variables is set, the <em>git web&#45;&#45;browse</em> helper script
 917 (called by <em>git help</em>) will pick a suitable default. See
 918 <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a> for more information about this.</p></div>
 919 </dd>
 920 </dl></div>
 921 </div>
 922 </div>
 923 <div class="sect1">
 924 <h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
 925 <div class="sectionbody">
 926 <div class="sect2">
 927 <h3 id="_help_format">help.format</h3>
 928 <div class="paragraph"><p>If no command-line option is passed, the <code>help.format</code> configuration
 929 variable will be checked. The following values are supported for this
 930 variable; they make <em>git help</em> behave as their corresponding command-
 931 line option:</p></div>
 932 <div class="ulist"><ul>
 933 <li>
 934 <p>
 935 "man" corresponds to <em>-m|--man</em>,
 936 </p>
 937 </li>
 938 <li>
 939 <p>
 940 "info" corresponds to <em>-i|--info</em>,
 941 </p>
 942 </li>
 943 <li>
 944 <p>
 945 "web" or "html" correspond to <em>-w|--web</em>.
 946 </p>
 947 </li>
 948 </ul></div>
 949 </div>
 950 <div class="sect2">
 951 <h3 id="_help_browser_web_browser_and_browser_lt_tool_gt_path">help.browser, web.browser, and browser.&lt;tool&gt;.path</h3>
 952 <div class="paragraph"><p>The <code>help.browser</code>, <code>web.browser</code> and <code>browser.&lt;tool&gt;.path</code> will also
 953 be checked if the <em>web</em> format is chosen (either by command-line
 954 option or configuration variable). See <em>-w|--web</em> in the OPTIONS
 955 section above and <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.</p></div>
 956 </div>
 957 <div class="sect2">
 958 <h3 id="_man_viewer">man.viewer</h3>
 959 <div class="paragraph"><p>The <code>man.viewer</code> configuration variable will be checked if the <em>man</em>
 960 format is chosen. The following values are currently supported:</p></div>
 961 <div class="ulist"><ul>
 962 <li>
 963 <p>
 964 "man": use the <em>man</em> program as usual,
 965 </p>
 966 </li>
 967 <li>
 968 <p>
 969 "woman": use <em>emacsclient</em> to launch the "woman" mode in emacs
 970   (this only works starting with emacsclient versions 22),
 971 </p>
 972 </li>
 973 <li>
 974 <p>
 975 "konqueror": use <em>kfmclient</em> to open the man page in a new konqueror
 976   tab (see <em>Note about konqueror</em> below).
 977 </p>
 978 </li>
 979 </ul></div>
 980 <div class="paragraph"><p>Values for other tools can be used if there is a corresponding
 981 <code>man.&lt;tool&gt;.cmd</code> configuration entry (see below).</p></div>
 982 <div class="paragraph"><p>Multiple values may be given to the <code>man.viewer</code> configuration
 983 variable. Their corresponding programs will be tried in the order
 984 listed in the configuration file.</p></div>
 985 <div class="paragraph"><p>For example, this configuration:</p></div>
 986 <div class="listingblock">
 987 <div class="content">
 988 <pre><code>        [man]
 989                 viewer = konqueror
 990                 viewer = woman</code></pre>
 991 </div></div>
 992 <div class="paragraph"><p>will try to use konqueror first. But this may fail (for example, if
 993 DISPLAY is not set) and in that case emacs' woman mode will be tried.</p></div>
 994 <div class="paragraph"><p>If everything fails, or if no viewer is configured, the viewer specified
 995 in the <code>GIT_MAN_VIEWER</code> environment variable will be tried.  If that
 996 fails too, the <em>man</em> program will be tried anyway.</p></div>
 997 </div>
 998 <div class="sect2">
 999 <h3 id="_man_lt_tool_gt_path">man.&lt;tool&gt;.path</h3>
1000 <div class="paragraph"><p>You can explicitly provide a full path to your preferred man viewer by
1001 setting the configuration variable <code>man.&lt;tool&gt;.path</code>. For example, you
1002 can configure the absolute path to konqueror by setting
1003 <em>man.konqueror.path</em>. Otherwise, <em>git help</em> assumes the tool is
1004 available in PATH.</p></div>
1005 </div>
1006 <div class="sect2">
1007 <h3 id="_man_lt_tool_gt_cmd">man.&lt;tool&gt;.cmd</h3>
1008 <div class="paragraph"><p>When the man viewer, specified by the <code>man.viewer</code> configuration
1009 variables, is not among the supported ones, then the corresponding
1010 <code>man.&lt;tool&gt;.cmd</code> configuration variable will be looked up. If this
1011 variable exists then the specified tool will be treated as a custom
1012 command and a shell eval will be used to run the command with the man
1013 page passed as arguments.</p></div>
1014 </div>
1015 <div class="sect2">
1016 <h3 id="_note_about_konqueror">Note about konqueror</h3>
1017 <div class="paragraph"><p>When <em>konqueror</em> is specified in the <code>man.viewer</code> configuration
1018 variable, we launch <em>kfmclient</em> to try to open the man page on an
1019 already opened konqueror in a new tab if possible.</p></div>
1020 <div class="paragraph"><p>For consistency, we also try such a trick if <em>man.konqueror.path</em> is
1021 set to something like <code>A_PATH_TO/konqueror</code>. That means we will try to
1022 launch <code>A_PATH_TO/kfmclient</code> instead.</p></div>
1023 <div class="paragraph"><p>If you really want to use <em>konqueror</em>, then you can use something like
1024 the following:</p></div>
1025 <div class="listingblock">
1026 <div class="content">
1027 <pre><code>        [man]
1028                 viewer = konq
1029
1030         [man "konq"]
1031                 cmd = A_PATH_TO/konqueror</code></pre>
1032 </div></div>
1033 </div>
1034 <div class="sect2">
1035 <h3 id="_note_about_git_config_global">Note about git config --global</h3>
1036 <div class="paragraph"><p>Note that all these configuration variables should probably be set
1037 using the <code>--global</code> flag, for example like this:</p></div>
1038 <div class="listingblock">
1039 <div class="content">
1040 <pre><code>$ git config --global help.format web
1041 $ git config --global web.browser firefox</code></pre>
1042 </div></div>
1043 <div class="paragraph"><p>as they are probably more user specific than repository specific.
1044 See <a href="git-config.html">git-config(1)</a> for more information about this.</p></div>
1045 </div>
1046 </div>
1047 </div>
1048 <div class="sect1">
1049 <h2 id="_git">GIT</h2>
1050 <div class="sectionbody">
1051 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1052 </div>
1053 </div>
1054 </div>
1055 <div id="footnotes"><hr /></div>
1056 <div id="footer">
1057 <div id="footer-text">
1058 Last updated
1059  2023-10-23 14:43:46 PDT
1060 </div>
1061 </div>
1062 </body>
1063 </html>