git-config.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-config(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-config(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-config -
 743    Get and set repository or global options
 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 config list</em> [&lt;file-option&gt;] [&lt;display-option&gt;] [--includes]
 753 <em>git config get</em> [&lt;file-option&gt;] [&lt;display-option&gt;] [--includes] [--all] [--regexp=&lt;regexp&gt;] [--value=&lt;value&gt;] [--fixed-value] [--default=&lt;default&gt;] &lt;name&gt;
 754 <em>git config set</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--all] [--value=&lt;value&gt;] [--fixed-value] &lt;name&gt; &lt;value&gt;
 755 <em>git config unset</em> [&lt;file-option&gt;] [--all] [--value=&lt;value&gt;] [--fixed-value] &lt;name&gt; &lt;value&gt;
 756 <em>git config rename-section</em> [&lt;file-option&gt;] &lt;old-name&gt; &lt;new-name&gt;
 757 <em>git config remove-section</em> [&lt;file-option&gt;] &lt;name&gt;
 758 <em>git config edit</em> [&lt;file-option&gt;]
 759 <em>git config</em> [&lt;file-option&gt;] --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]</pre>
 760 <div class="attribution">
 761 </div></div>
 762 </div>
 763 </div>
 764 <div class="sect1">
 765 <h2 id="_description">DESCRIPTION</h2>
 766 <div class="sectionbody">
 767 <div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is
 768 actually the section and the key separated by a dot, and the value will be
 769 escaped.</p></div>
 770 <div class="paragraph"><p>Multiple lines can be added to an option by using the <code>--append</code> option.
 771 If you want to update or unset an option which can occur on multiple
 772 lines, a <code>value-pattern</code> (which is an extended regular expression,
 773 unless the <code>--fixed-value</code> option is given) needs to be given.  Only the
 774 existing values that match the pattern are updated or unset.  If
 775 you want to handle the lines that do <strong>not</strong> match the pattern, just
 776 prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>),
 777 but note that this only works when the <code>--fixed-value</code> option is not
 778 in use.</p></div>
 779 <div class="paragraph"><p>The <code>--type=&lt;type&gt;</code> option instructs <em>git config</em> to ensure that incoming and
 780 outgoing values are canonicalize-able under the given &lt;type&gt;.  If no
 781 <code>--type=&lt;type&gt;</code> is given, no canonicalization will be performed. Callers may
 782 unset an existing <code>--type</code> specifier with <code>--no-type</code>.</p></div>
 783 <div class="paragraph"><p>When reading, the values are read from the system, global and
 784 repository local configuration files by default, and options
 785 <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code> and
 786 <code>--file &lt;filename&gt;</code> can be used to tell the command to read from only
 787 that location (see <a href="#FILES">[FILES]</a>).</p></div>
 788 <div class="paragraph"><p>When writing, the new value is written to the repository local
 789 configuration file by default, and options <code>--system</code>, <code>--global</code>,
 790 <code>--worktree</code>, <code>--file &lt;filename&gt;</code> can be used to tell the command to
 791 write to that location (you can say <code>--local</code> but that is the
 792 default).</p></div>
 793 <div class="paragraph"><p>This command will fail with non-zero status upon error.  Some exit
 794 codes are:</p></div>
 795 <div class="ulist"><ul>
 796 <li>
 797 <p>
 798 The section or key is invalid (ret=1),
 799 </p>
 800 </li>
 801 <li>
 802 <p>
 803 no section or name was provided (ret=2),
 804 </p>
 805 </li>
 806 <li>
 807 <p>
 808 the config file is invalid (ret=3),
 809 </p>
 810 </li>
 811 <li>
 812 <p>
 813 the config file cannot be written (ret=4),
 814 </p>
 815 </li>
 816 <li>
 817 <p>
 818 you try to unset an option which does not exist (ret=5),
 819 </p>
 820 </li>
 821 <li>
 822 <p>
 823 you try to unset/set an option for which multiple lines match (ret=5), or
 824 </p>
 825 </li>
 826 <li>
 827 <p>
 828 you try to use an invalid regexp (ret=6).
 829 </p>
 830 </li>
 831 </ul></div>
 832 <div class="paragraph"><p>On success, the command returns the exit code 0.</p></div>
 833 <div class="paragraph"><p>A list of all available configuration variables can be obtained using the
 834 <code>git help --config</code> command.</p></div>
 835 </div>
 836 </div>
 837 <div class="sect1">
 838 <h2 id="_commands">COMMANDS</h2>
 839 <div class="sectionbody">
 840 <div class="dlist"><dl>
 841 <dt class="hdlist1">
 842 list
 843 </dt>
 844 <dd>
 845 <p>
 846         List all variables set in config file, along with their values.
 847 </p>
 848 </dd>
 849 <dt class="hdlist1">
 850 get
 851 </dt>
 852 <dd>
 853 <p>
 854         Emits the value of the specified key. If key is present multiple times
 855         in the configuration, emits the last value. If <code>--all</code> is specified,
 856         emits all values associated with key. Returns error code 1 if key is
 857         not present.
 858 </p>
 859 </dd>
 860 <dt class="hdlist1">
 861 set
 862 </dt>
 863 <dd>
 864 <p>
 865         Set value for one or more config options. By default, this command
 866         refuses to write multi-valued config options. Passing <code>--all</code> will
 867         replace all multi-valued config options with the new value, whereas
 868         <code>--value=</code> will replace all config options whose values match the given
 869         pattern.
 870 </p>
 871 </dd>
 872 <dt class="hdlist1">
 873 unset
 874 </dt>
 875 <dd>
 876 <p>
 877         Unset value for one or more config options. By default, this command
 878         refuses to unset multi-valued keys. Passing <code>--all</code> will unset all
 879         multi-valued config options, whereas <code>--value</code> will unset all config
 880         options whose values match the given pattern.
 881 </p>
 882 </dd>
 883 <dt class="hdlist1">
 884 rename-section
 885 </dt>
 886 <dd>
 887 <p>
 888         Rename the given section to a new name.
 889 </p>
 890 </dd>
 891 <dt class="hdlist1">
 892 remove-section
 893 </dt>
 894 <dd>
 895 <p>
 896         Remove the given section from the configuration file.
 897 </p>
 898 </dd>
 899 <dt class="hdlist1">
 900 edit
 901 </dt>
 902 <dd>
 903 <p>
 904         Opens an editor to modify the specified config file; either
 905         <code>--system</code>, <code>--global</code>, <code>--local</code> (default), <code>--worktree</code>, or
 906         <code>--file &lt;config-file&gt;</code>.
 907 </p>
 908 </dd>
 909 </dl></div>
 910 </div>
 911 </div>
 912 <div class="sect1">
 913 <h2 id="OPTIONS">OPTIONS</h2>
 914 <div class="sectionbody">
 915 <div class="dlist"><dl>
 916 <dt class="hdlist1">
 917 --replace-all
 918 </dt>
 919 <dd>
 920 <p>
 921         Default behavior is to replace at most one line. This replaces
 922         all lines matching the key (and optionally the <code>value-pattern</code>).
 923 </p>
 924 </dd>
 925 <dt class="hdlist1">
 926 --append
 927 </dt>
 928 <dd>
 929 <p>
 930         Adds a new line to the option without altering any existing
 931         values. This is the same as providing <em>--value=^$</em> in <code>set</code>.
 932 </p>
 933 </dd>
 934 <dt class="hdlist1">
 935 --comment &lt;message&gt;
 936 </dt>
 937 <dd>
 938 <p>
 939         Append a comment at the end of new or modified lines.
 940 </p>
 941 <div class="literalblock">
 942 <div class="content">
 943 <pre><code>If _&lt;message&gt;_ begins with one or more whitespaces followed
 944 by "#", it is used as-is.  If it begins with "#", a space is
 945 prepended before it is used.  Otherwise, a string " # " (a
 946 space followed by a hash followed by a space) is prepended
 947 to it.  And the resulting string is placed immediately after
 948 the value defined for the variable.  The _&lt;message&gt;_ must
 949 not contain linefeed characters (no multi-line comments are
 950 permitted).</code></pre>
 951 </div></div>
 952 </dd>
 953 <dt class="hdlist1">
 954 --all
 955 </dt>
 956 <dd>
 957 <p>
 958         With <code>get</code>, return all values for a multi-valued key.
 959 </p>
 960 </dd>
 961 <dt class="hdlist1">
 962 ---regexp
 963 </dt>
 964 <dd>
 965 <p>
 966         With <code>get</code>, interpret the name as a regular expression. Regular
 967         expression matching is currently case-sensitive and done against a
 968         canonicalized version of the key in which section and variable names
 969         are lowercased, but subsection names are not.
 970 </p>
 971 </dd>
 972 <dt class="hdlist1">
 973 --url=&lt;URL&gt;
 974 </dt>
 975 <dd>
 976 <p>
 977         When given a two-part &lt;name&gt; as &lt;section&gt;.&lt;key&gt;, the value for
 978         &lt;section&gt;.&lt;URL&gt;.&lt;key&gt; whose &lt;URL&gt; part matches the best to the
 979         given URL is returned (if no such key exists, the value for
 980         &lt;section&gt;.&lt;key&gt; is used as a fallback).  When given just the
 981         &lt;section&gt; as name, do so for all the keys in the section and
 982         list them.  Returns error code 1 if no value is found.
 983 </p>
 984 </dd>
 985 <dt class="hdlist1">
 986 --global
 987 </dt>
 988 <dd>
 989 <p>
 990         For writing options: write to global <code>~/.gitconfig</code> file
 991         rather than the repository <code>.git/config</code>, write to
 992         <code>$XDG_CONFIG_HOME/git/config</code> file if this file exists and the
 993         <code>~/.gitconfig</code> file doesn&#8217;t.
 994 </p>
 995 <div class="paragraph"><p>For reading options: read only from global <code>~/.gitconfig</code> and from
 996 <code>$XDG_CONFIG_HOME/git/config</code> rather than from all available files.</p></div>
 997 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 998 </dd>
 999 <dt class="hdlist1">
1000 --system
1001 </dt>
1002 <dd>
1003 <p>
1004         For writing options: write to system-wide
1005         <code>$(prefix)/etc/gitconfig</code> rather than the repository
1006         <code>.git/config</code>.
1007 </p>
1008 <div class="paragraph"><p>For reading options: read only from system-wide <code>$(prefix)/etc/gitconfig</code>
1009 rather than from all available files.</p></div>
1010 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1011 </dd>
1012 <dt class="hdlist1">
1013 --local
1014 </dt>
1015 <dd>
1016 <p>
1017         For writing options: write to the repository <code>.git/config</code> file.
1018         This is the default behavior.
1019 </p>
1020 <div class="paragraph"><p>For reading options: read only from the repository <code>.git/config</code> rather than
1021 from all available files.</p></div>
1022 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1023 </dd>
1024 <dt class="hdlist1">
1025 --worktree
1026 </dt>
1027 <dd>
1028 <p>
1029         Similar to <code>--local</code> except that <code>$GIT_DIR/config.worktree</code> is
1030         read from or written to if <code>extensions.worktreeConfig</code> is
1031         enabled. If not it&#8217;s the same as <code>--local</code>. Note that <code>$GIT_DIR</code>
1032         is equal to <code>$GIT_COMMON_DIR</code> for the main working tree, but is of
1033         the form <code>$GIT_DIR/worktrees/&lt;id&gt;/</code> for other working trees. See
1034         <a href="git-worktree.html">git-worktree(1)</a> to learn how to enable
1035         <code>extensions.worktreeConfig</code>.
1036 </p>
1037 </dd>
1038 <dt class="hdlist1">
1039 -f &lt;config-file&gt;
1040 </dt>
1041 <dt class="hdlist1">
1042 --file &lt;config-file&gt;
1043 </dt>
1044 <dd>
1045 <p>
1046         For writing options: write to the specified file rather than the
1047         repository <code>.git/config</code>.
1048 </p>
1049 <div class="paragraph"><p>For reading options: read only from the specified file rather than from all
1050 available files.</p></div>
1051 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1052 </dd>
1053 <dt class="hdlist1">
1054 --blob &lt;blob&gt;
1055 </dt>
1056 <dd>
1057 <p>
1058         Similar to <code>--file</code> but use the given blob instead of a file. E.g.
1059         you can use <em>master:.gitmodules</em> to read values from the file
1060         <em>.gitmodules</em> in the master branch. See "SPECIFYING REVISIONS"
1061         section in <a href="gitrevisions.html">gitrevisions(7)</a> for a more complete list of
1062         ways to spell blob names.
1063 </p>
1064 </dd>
1065 <dt class="hdlist1">
1066 --fixed-value
1067 </dt>
1068 <dd>
1069 <p>
1070         When used with the <code>value-pattern</code> argument, treat <code>value-pattern</code> as
1071         an exact string instead of a regular expression. This will restrict
1072         the name/value pairs that are matched to only those where the value
1073         is exactly equal to the <code>value-pattern</code>.
1074 </p>
1075 </dd>
1076 <dt class="hdlist1">
1077 --type &lt;type&gt;
1078 </dt>
1079 <dd>
1080 <p>
1081   <em>git config</em> will ensure that any input or output is valid under the given
1082   type constraint(s), and will canonicalize outgoing values in <code>&lt;type&gt;</code>'s
1083   canonical form.
1084 </p>
1085 <div class="paragraph"><p>Valid <code>&lt;type&gt;</code>'s include:</p></div>
1086 <div class="ulist"><ul>
1087 <li>
1088 <p>
1089 <em>bool</em>: canonicalize values as either "true" or "false".
1090 </p>
1091 </li>
1092 <li>
1093 <p>
1094 <em>int</em>: canonicalize values as simple decimal numbers. An optional suffix of
1095   <em>k</em>, <em>m</em>, or <em>g</em> will cause the value to be multiplied by 1024, 1048576, or
1096   1073741824 upon input.
1097 </p>
1098 </li>
1099 <li>
1100 <p>
1101 <em>bool-or-int</em>: canonicalize according to either <em>bool</em> or <em>int</em>, as described
1102   above.
1103 </p>
1104 </li>
1105 <li>
1106 <p>
1107 <em>path</em>: canonicalize by expanding a leading <code>~</code> to the value of <code>$HOME</code> and
1108   <code>~user</code> to the home directory for the specified user. This specifier has no
1109   effect when setting the value (but you can use <code>git config section.variable
1110   ~/</code> from the command line to let your shell do the expansion.)
1111 </p>
1112 </li>
1113 <li>
1114 <p>
1115 <em>expiry-date</em>: canonicalize by converting from a fixed or relative date-string
1116   to a timestamp. This specifier has no effect when setting the value.
1117 </p>
1118 </li>
1119 <li>
1120 <p>
1121 <em>color</em>: When getting a value, canonicalize by converting to an ANSI color
1122   escape sequence. When setting a value, a sanity-check is performed to ensure
1123   that the given value is canonicalize-able as an ANSI color, but it is written
1124   as-is.
1125 </p>
1126 </li>
1127 </ul></div>
1128 </dd>
1129 <dt class="hdlist1">
1130 --bool
1131 </dt>
1132 <dt class="hdlist1">
1133 --int
1134 </dt>
1135 <dt class="hdlist1">
1136 --bool-or-int
1137 </dt>
1138 <dt class="hdlist1">
1139 --path
1140 </dt>
1141 <dt class="hdlist1">
1142 --expiry-date
1143 </dt>
1144 <dd>
1145 <p>
1146   Historical options for selecting a type specifier. Prefer instead <code>--type</code>
1147   (see above).
1148 </p>
1149 </dd>
1150 <dt class="hdlist1">
1151 --no-type
1152 </dt>
1153 <dd>
1154 <p>
1155   Un-sets the previously set type specifier (if one was previously set). This
1156   option requests that <em>git config</em> not canonicalize the retrieved variable.
1157   <code>--no-type</code> has no effect without <code>--type=&lt;type&gt;</code> or <code>--&lt;type&gt;</code>.
1158 </p>
1159 </dd>
1160 <dt class="hdlist1">
1161 -z
1162 </dt>
1163 <dt class="hdlist1">
1164 --null
1165 </dt>
1166 <dd>
1167 <p>
1168         For all options that output values and/or keys, always
1169         end values with the null character (instead of a
1170         newline). Use newline instead as a delimiter between
1171         key and value. This allows for secure parsing of the
1172         output without getting confused e.g. by values that
1173         contain line breaks.
1174 </p>
1175 </dd>
1176 <dt class="hdlist1">
1177 --name-only
1178 </dt>
1179 <dd>
1180 <p>
1181         Output only the names of config variables for <code>list</code> or
1182         <code>get</code>.
1183 </p>
1184 </dd>
1185 <dt class="hdlist1">
1186 --show-origin
1187 </dt>
1188 <dd>
1189 <p>
1190         Augment the output of all queried config options with the
1191         origin type (file, standard input, blob, command line) and
1192         the actual origin (config file path, ref, or blob id if
1193         applicable).
1194 </p>
1195 </dd>
1196 <dt class="hdlist1">
1197 --show-scope
1198 </dt>
1199 <dd>
1200 <p>
1201         Similar to <code>--show-origin</code> in that it augments the output of
1202         all queried config options with the scope of that value
1203         (worktree, local, global, system, command).
1204 </p>
1205 </dd>
1206 <dt class="hdlist1">
1207 --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]
1208 </dt>
1209 <dd>
1210 <p>
1211         Find the color setting for <code>&lt;name&gt;</code> (e.g. <code>color.diff</code>) and output
1212         "true" or "false".  <code>&lt;stdout-is-tty&gt;</code> should be either "true" or
1213         "false", and is taken into account when configuration says
1214         "auto".  If <code>&lt;stdout-is-tty&gt;</code> is missing, then checks the standard
1215         output of the command itself, and exits with status 0 if color
1216         is to be used, or exits with status 1 otherwise.
1217         When the color setting for <code>name</code> is undefined, the command uses
1218         <code>color.ui</code> as fallback.
1219 </p>
1220 </dd>
1221 <dt class="hdlist1">
1222 --[no-]includes
1223 </dt>
1224 <dd>
1225 <p>
1226         Respect <code>include.*</code> directives in config files when looking up
1227         values. Defaults to <code>off</code> when a specific file is given (e.g.,
1228         using <code>--file</code>, <code>--global</code>, etc) and <code>on</code> when searching all
1229         config files.
1230 </p>
1231 </dd>
1232 <dt class="hdlist1">
1233 --default &lt;value&gt;
1234 </dt>
1235 <dd>
1236 <p>
1237   When using <code>get</code>, and the requested variable is not found, behave as if
1238   &lt;value&gt; were the value assigned to that variable.
1239 </p>
1240 </dd>
1241 </dl></div>
1242 </div>
1243 </div>
1244 <div class="sect1">
1245 <h2 id="_deprecated_modes">DEPRECATED MODES</h2>
1246 <div class="sectionbody">
1247 <div class="paragraph"><p>The following modes have been deprecated in favor of subcommands. It is
1248 recommended to migrate to the new syntax.</p></div>
1249 <div class="dlist"><dl>
1250 <dt class="hdlist1">
1251 <em>git config &lt;name&gt;</em>
1252 </dt>
1253 <dd>
1254 <p>
1255         Replaced by <code>git config get &lt;name&gt;</code>.
1256 </p>
1257 </dd>
1258 <dt class="hdlist1">
1259 <em>git config &lt;name&gt; &lt;value&gt; [&lt;value-pattern&gt;]</em>
1260 </dt>
1261 <dd>
1262 <p>
1263         Replaced by <code>git config set [--value=&lt;pattern&gt;] &lt;name&gt; &lt;value&gt;</code>.
1264 </p>
1265 </dd>
1266 <dt class="hdlist1">
1267 -l
1268 </dt>
1269 <dt class="hdlist1">
1270 --list
1271 </dt>
1272 <dd>
1273 <p>
1274         Replaced by <code>git config list</code>.
1275 </p>
1276 </dd>
1277 <dt class="hdlist1">
1278 --get &lt;name&gt; [&lt;value-pattern&gt;]
1279 </dt>
1280 <dd>
1281 <p>
1282         Replaced by <code>git config get [--value=&lt;pattern&gt;] &lt;name&gt;</code>.
1283 </p>
1284 </dd>
1285 <dt class="hdlist1">
1286 --get-all &lt;name&gt; [&lt;value-pattern&gt;]
1287 </dt>
1288 <dd>
1289 <p>
1290         Replaced by <code>git config get [--value=&lt;pattern&gt;] --all --show-names &lt;name&gt;</code>.
1291 </p>
1292 </dd>
1293 <dt class="hdlist1">
1294 --get-regexp &lt;name-regexp&gt;
1295 </dt>
1296 <dd>
1297 <p>
1298         Replaced by <code>git config get --all --show-names --regexp &lt;name-regexp&gt;</code>.
1299 </p>
1300 </dd>
1301 <dt class="hdlist1">
1302 --get-urlmatch &lt;name&gt; &lt;URL&gt;
1303 </dt>
1304 <dd>
1305 <p>
1306         Replaced by <code>git config get --all --show-names --url=&lt;URL&gt; &lt;name&gt;</code>.
1307 </p>
1308 </dd>
1309 <dt class="hdlist1">
1310 --get-color &lt;name&gt; [&lt;default&gt;]
1311 </dt>
1312 <dd>
1313 <p>
1314         Replaced by <code>git config get --type=color [--default=&lt;default&gt;] &lt;name&gt;</code>.
1315 </p>
1316 </dd>
1317 <dt class="hdlist1">
1318 --add &lt;name&gt; &lt;value&gt;
1319 </dt>
1320 <dd>
1321 <p>
1322         Replaced by <code>git config set --append &lt;name&gt; &lt;value&gt;</code>.
1323 </p>
1324 </dd>
1325 <dt class="hdlist1">
1326 --unset &lt;name&gt; [&lt;value-pattern&gt;]
1327 </dt>
1328 <dd>
1329 <p>
1330         Replaced by <code>git config unset [--value=&lt;pattern&gt;] &lt;name&gt;</code>.
1331 </p>
1332 </dd>
1333 <dt class="hdlist1">
1334 --unset-all &lt;name&gt; [&lt;value-pattern&gt;]
1335 </dt>
1336 <dd>
1337 <p>
1338         Replaced by <code>git config unset [--value=&lt;pattern&gt;] --all &lt;name&gt;</code>.
1339 </p>
1340 </dd>
1341 <dt class="hdlist1">
1342 --rename-section &lt;old-name&gt; &lt;new-name&gt;
1343 </dt>
1344 <dd>
1345 <p>
1346         Replaced by <code>git config rename-section &lt;old-name&gt; &lt;new-name&gt;</code>.
1347 </p>
1348 </dd>
1349 <dt class="hdlist1">
1350 --remove-section &lt;name&gt;
1351 </dt>
1352 <dd>
1353 <p>
1354         Replaced by <code>git config remove-section &lt;name&gt;</code>.
1355 </p>
1356 </dd>
1357 <dt class="hdlist1">
1358 -e
1359 </dt>
1360 <dt class="hdlist1">
1361 --edit
1362 </dt>
1363 <dd>
1364 <p>
1365         Replaced by <code>git config edit</code>.
1366 </p>
1367 </dd>
1368 </dl></div>
1369 </div>
1370 </div>
1371 <div class="sect1">
1372 <h2 id="_configuration">CONFIGURATION</h2>
1373 <div class="sectionbody">
1374 <div class="paragraph"><p><code>pager.config</code> is only respected when listing configuration, i.e., when
1375 using <code>list</code> or <code>get</code> which may return multiple results. The default is to use
1376 a pager.</p></div>
1377 </div>
1378 </div>
1379 <div class="sect1">
1380 <h2 id="FILES">FILES</h2>
1381 <div class="sectionbody">
1382 <div class="paragraph"><p>By default, <em>git config</em> will read configuration options from multiple
1383 files:</p></div>
1384 <div class="dlist"><dl>
1385 <dt class="hdlist1">
1386 $(prefix)/etc/gitconfig
1387 </dt>
1388 <dd>
1389 <p>
1390         System-wide configuration file.
1391 </p>
1392 </dd>
1393 <dt class="hdlist1">
1394 $XDG_CONFIG_HOME/git/config
1395 </dt>
1396 <dt class="hdlist1">
1397 ~/.gitconfig
1398 </dt>
1399 <dd>
1400 <p>
1401         User-specific configuration files. When the XDG_CONFIG_HOME environment
1402         variable is not set or empty, $HOME/.config/ is used as
1403         $XDG_CONFIG_HOME.
1404 </p>
1405 <div class="paragraph"><p>These are also called "global" configuration files. If both files exist, both
1406 files are read in the order given above.</p></div>
1407 </dd>
1408 <dt class="hdlist1">
1409 $GIT_DIR/config
1410 </dt>
1411 <dd>
1412 <p>
1413         Repository specific configuration file.
1414 </p>
1415 </dd>
1416 <dt class="hdlist1">
1417 $GIT_DIR/config.worktree
1418 </dt>
1419 <dd>
1420 <p>
1421         This is optional and is only searched when
1422         <code>extensions.worktreeConfig</code> is present in $GIT_DIR/config.
1423 </p>
1424 </dd>
1425 </dl></div>
1426 <div class="paragraph"><p>You may also provide additional configuration parameters when running any
1427 git command by using the <code>-c</code> option. See <a href="git.html">git(1)</a> for details.</p></div>
1428 <div class="paragraph"><p>Options will be read from all of these files that are available. If the
1429 global or the system-wide configuration files are missing or unreadable they
1430 will be ignored. If the repository configuration file is missing or unreadable,
1431 <em>git config</em> will exit with a non-zero error code. An error message is produced
1432 if the file is unreadable, but not if it is missing.</p></div>
1433 <div class="paragraph"><p>The files are read in the order given above, with last value found taking
1434 precedence over values read earlier.  When multiple values are taken then all
1435 values of a key from all files will be used.</p></div>
1436 <div class="paragraph"><p>By default, options are only written to the repository specific
1437 configuration file. Note that this also affects options like <code>set</code>
1438 and <code>unset</code>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
1439 <div class="paragraph"><p>You can limit which configuration sources are read from or written to by
1440 specifying the path of a file with the <code>--file</code> option, or by specifying a
1441 configuration scope with <code>--system</code>, <code>--global</code>, <code>--local</code>, or <code>--worktree</code>.
1442 For more, see <a href="#OPTIONS">[OPTIONS]</a> above.</p></div>
1443 </div>
1444 </div>
1445 <div class="sect1">
1446 <h2 id="SCOPES">SCOPES</h2>
1447 <div class="sectionbody">
1448 <div class="paragraph"><p>Each configuration source falls within a configuration scope. The scopes
1449 are:</p></div>
1450 <div class="dlist"><dl>
1451 <dt class="hdlist1">
1452 system
1453 </dt>
1454 <dd>
1455 <p>
1456         $(prefix)/etc/gitconfig
1457 </p>
1458 </dd>
1459 <dt class="hdlist1">
1460 global
1461 </dt>
1462 <dd>
1463 <p>
1464         $XDG_CONFIG_HOME/git/config
1465 </p>
1466 <div class="paragraph"><p>~/.gitconfig</p></div>
1467 </dd>
1468 <dt class="hdlist1">
1469 local
1470 </dt>
1471 <dd>
1472 <p>
1473         $GIT_DIR/config
1474 </p>
1475 </dd>
1476 <dt class="hdlist1">
1477 worktree
1478 </dt>
1479 <dd>
1480 <p>
1481         $GIT_DIR/config.worktree
1482 </p>
1483 </dd>
1484 <dt class="hdlist1">
1485 command
1486 </dt>
1487 <dd>
1488 <p>
1489         GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see <a href="#ENVIRONMENT">[ENVIRONMENT]</a>
1490         below)
1491 </p>
1492 <div class="paragraph"><p>the <code>-c</code> option</p></div>
1493 </dd>
1494 </dl></div>
1495 <div class="paragraph"><p>With the exception of <em>command</em>, each scope corresponds to a command line
1496 option: <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code>.</p></div>
1497 <div class="paragraph"><p>When reading options, specifying a scope will only read options from the
1498 files within that scope. When writing options, specifying a scope will write
1499 to the files within that scope (instead of the repository specific
1500 configuration file). See <a href="#OPTIONS">[OPTIONS]</a> above for a complete description.</p></div>
1501 <div class="paragraph"><p>Most configuration options are respected regardless of the scope it is
1502 defined in, but some options are only respected in certain scopes. See the
1503 respective option&#8217;s documentation for the full details.</p></div>
1504 <div class="sect2">
1505 <h3 id="_protected_configuration">Protected configuration</h3>
1506 <div class="paragraph"><p>Protected configuration refers to the <em>system</em>, <em>global</em>, and <em>command</em> scopes.
1507 For security reasons, certain options are only respected when they are
1508 specified in protected configuration, and ignored otherwise.</p></div>
1509 <div class="paragraph"><p>Git treats these scopes as if they are controlled by the user or a trusted
1510 administrator. This is because an attacker who controls these scopes can do
1511 substantial harm without using Git, so it is assumed that the user&#8217;s environment
1512 protects these scopes against attackers.</p></div>
1513 </div>
1514 </div>
1515 </div>
1516 <div class="sect1">
1517 <h2 id="ENVIRONMENT">ENVIRONMENT</h2>
1518 <div class="sectionbody">
1519 <div class="dlist"><dl>
1520 <dt class="hdlist1">
1521 GIT_CONFIG_GLOBAL
1522 </dt>
1523 <dt class="hdlist1">
1524 GIT_CONFIG_SYSTEM
1525 </dt>
1526 <dd>
1527 <p>
1528         Take the configuration from the given files instead from global or
1529         system-level configuration. See <a href="git.html">git(1)</a> for details.
1530 </p>
1531 </dd>
1532 <dt class="hdlist1">
1533 GIT_CONFIG_NOSYSTEM
1534 </dt>
1535 <dd>
1536 <p>
1537         Whether to skip reading settings from the system-wide
1538         $(prefix)/etc/gitconfig file. See <a href="git.html">git(1)</a> for details.
1539 </p>
1540 </dd>
1541 </dl></div>
1542 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1543 <div class="dlist"><dl>
1544 <dt class="hdlist1">
1545 GIT_CONFIG_COUNT
1546 </dt>
1547 <dt class="hdlist1">
1548 GIT_CONFIG_KEY_&lt;n&gt;
1549 </dt>
1550 <dt class="hdlist1">
1551 GIT_CONFIG_VALUE_&lt;n&gt;
1552 </dt>
1553 <dd>
1554 <p>
1555         If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
1556         GIT_CONFIG_KEY_&lt;n&gt; and GIT_CONFIG_VALUE_&lt;n&gt; up to that number will be
1557         added to the process&#8217;s runtime configuration. The config pairs are
1558         zero-indexed. Any missing key or value is treated as an error. An empty
1559         GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
1560         pairs are processed. These environment variables will override values
1561         in configuration files, but will be overridden by any explicit options
1562         passed via <code>git -c</code>.
1563 </p>
1564 <div class="paragraph"><p>This is useful for cases where you want to spawn multiple git commands
1565 with a common configuration but cannot depend on a configuration file,
1566 for example when writing scripts.</p></div>
1567 </dd>
1568 <dt class="hdlist1">
1569 GIT_CONFIG
1570 </dt>
1571 <dd>
1572 <p>
1573         If no <code>--file</code> option is provided to <code>git config</code>, use the file
1574         given by <code>GIT_CONFIG</code> as if it were provided via <code>--file</code>. This
1575         variable has no effect on other Git commands, and is mostly for
1576         historical compatibility; there is generally no reason to use it
1577         instead of the <code>--file</code> option.
1578 </p>
1579 </dd>
1580 </dl></div>
1581 </div>
1582 </div>
1583 <div class="sect1">
1584 <h2 id="EXAMPLES">EXAMPLES</h2>
1585 <div class="sectionbody">
1586 <div class="paragraph"><p>Given a .git/config like this:</p></div>
1587 <div class="listingblock">
1588 <div class="content">
1589 <pre><code>#
1590 # This is the config file, and
1591 # a '#' or ';' character indicates
1592 # a comment
1593 #
1594
1595 ; core variables
1596 [core]
1597         ; Don't trust file modes
1598         filemode = false
1599
1600 ; Our diff algorithm
1601 [diff]
1602         external = /usr/local/bin/diff-wrapper
1603         renames = true
1604
1605 ; Proxy settings
1606 [core]
1607         gitproxy=proxy-command for kernel.org
1608         gitproxy=default-proxy ; for all the rest
1609
1610 ; HTTP
1611 [http]
1612         sslVerify
1613 [http "https://weak.example.com"]
1614         sslVerify = false
1615         cookieFile = /tmp/cookie.txt</code></pre>
1616 </div></div>
1617 <div class="paragraph"><p>you can set the filemode to true with</p></div>
1618 <div class="listingblock">
1619 <div class="content">
1620 <pre><code>% git config set core.filemode true</code></pre>
1621 </div></div>
1622 <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
1623 what URL they apply to. Here is how to change the entry for kernel.org
1624 to "ssh".</p></div>
1625 <div class="listingblock">
1626 <div class="content">
1627 <pre><code>% git config set --value='for kernel.org$' core.gitproxy '"ssh" for kernel.org'</code></pre>
1628 </div></div>
1629 <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
1630 <div class="paragraph"><p>To delete the entry for renames, do</p></div>
1631 <div class="listingblock">
1632 <div class="content">
1633 <pre><code>% git config unset diff.renames</code></pre>
1634 </div></div>
1635 <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
1636 you have to provide a regex matching the value of exactly one line.</p></div>
1637 <div class="paragraph"><p>To query the value for a given key, do</p></div>
1638 <div class="listingblock">
1639 <div class="content">
1640 <pre><code>% git config get core.filemode</code></pre>
1641 </div></div>
1642 <div class="paragraph"><p>or, to query a multivar:</p></div>
1643 <div class="listingblock">
1644 <div class="content">
1645 <pre><code>% git config get --value="for kernel.org$" core.gitproxy</code></pre>
1646 </div></div>
1647 <div class="paragraph"><p>If you want to know all the values for a multivar, do:</p></div>
1648 <div class="listingblock">
1649 <div class="content">
1650 <pre><code>% git config get --all --show-names core.gitproxy</code></pre>
1651 </div></div>
1652 <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
1653 new one with</p></div>
1654 <div class="listingblock">
1655 <div class="content">
1656 <pre><code>% git config set --all core.gitproxy ssh</code></pre>
1657 </div></div>
1658 <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy,
1659 i.e. the one without a "for &#8230;" postfix, do something like this:</p></div>
1660 <div class="listingblock">
1661 <div class="content">
1662 <pre><code>% git config set --value='! for ' core.gitproxy ssh</code></pre>
1663 </div></div>
1664 <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div>
1665 <div class="listingblock">
1666 <div class="content">
1667 <pre><code>% git config set --value='[!]' section.key value</code></pre>
1668 </div></div>
1669 <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
1670 <div class="listingblock">
1671 <div class="content">
1672 <pre><code>% git config set --append core.gitproxy '"proxy-command" for example.com'</code></pre>
1673 </div></div>
1674 <div class="paragraph"><p>An example to use customized color from the configuration in your
1675 script:</p></div>
1676 <div class="listingblock">
1677 <div class="content">
1678 <pre><code>#!/bin/sh
1679 WS=$(git config get --type=color --default="blue reverse" color.diff.whitespace)
1680 RESET=$(git config get --type=color --default="reset" "")
1681 echo "${WS}your whitespace color or blue reverse${RESET}"</code></pre>
1682 </div></div>
1683 <div class="paragraph"><p>For URLs in <code>https://weak.example.com</code>, <code>http.sslVerify</code> is set to
1684 false, while it is set to <code>true</code> for all others:</p></div>
1685 <div class="listingblock">
1686 <div class="content">
1687 <pre><code>% git config get --type=bool --url=https://good.example.com http.sslverify
1688 true
1689 % git config get --type=bool --url=https://weak.example.com http.sslverify
1690 false
1691 % git config get --url=https://weak.example.com http
1692 http.cookieFile /tmp/cookie.txt
1693 http.sslverify false</code></pre>
1694 </div></div>
1695 </div>
1696 </div>
1697 <div class="sect1">
1698 <h2 id="_configuration_file">CONFIGURATION FILE</h2>
1699 <div class="sectionbody">
1700 <div class="paragraph"><p>The Git configuration file contains a number of variables that affect
1701 the Git commands' behavior. The files <code>.git/config</code> and optionally
1702 <code>config.worktree</code> (see the "CONFIGURATION FILE" section of
1703 <a href="git-worktree.html">git-worktree(1)</a>) in each repository are used to store the
1704 configuration for that repository, and <code>$HOME/.gitconfig</code> is used to
1705 store a per-user configuration as fallback values for the <code>.git/config</code>
1706 file. The file <code>/etc/gitconfig</code> can be used to store a system-wide
1707 default configuration.</p></div>
1708 <div class="paragraph"><p>The configuration variables are used by both the Git plumbing
1709 and the porcelain commands. The variables are divided into sections, wherein
1710 the fully qualified variable name of the variable itself is the last
1711 dot-separated segment and the section name is everything before the last
1712 dot. The variable names are case-insensitive, allow only alphanumeric
1713 characters and <code>-</code>, and must start with an alphabetic character.  Some
1714 variables may appear multiple times; we say then that the variable is
1715 multivalued.</p></div>
1716 <div class="sect2">
1717 <h3 id="_syntax">Syntax</h3>
1718 <div class="paragraph"><p>The syntax is fairly flexible and permissive.  Whitespace characters,
1719 which in this context are the space character (SP) and the horizontal
1720 tabulation (HT), are mostly ignored.  The <em>#</em> and <em>;</em> characters begin
1721 comments to the end of line.  Blank lines are ignored.</p></div>
1722 <div class="paragraph"><p>The file consists of sections and variables.  A section begins with
1723 the name of the section in square brackets and continues until the next
1724 section begins.  Section names are case-insensitive.  Only alphanumeric
1725 characters, <code>-</code> and <code>.</code> are allowed in section names.  Each variable
1726 must belong to some section, which means that there must be a section
1727 header before the first setting of a variable.</p></div>
1728 <div class="paragraph"><p>Sections can be further divided into subsections.  To begin a subsection
1729 put its name in double quotes, separated by space from the section name,
1730 in the section header, like in the example below:</p></div>
1731 <div class="listingblock">
1732 <div class="content">
1733 <pre><code>        [section "subsection"]</code></pre>
1734 </div></div>
1735 <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
1736 newline and the null byte. Doublequote <code>"</code> and backslash can be included
1737 by escaping them as <code>\"</code> and <code>\\</code>, respectively. Backslashes preceding
1738 other characters are dropped when reading; for example, <code>\t</code> is read as
1739 <code>t</code> and <code>\0</code> is read as <code>0</code>. Section headers cannot span multiple lines.
1740 Variables may belong directly to a section or to a given subsection. You
1741 can have <code>[section]</code> if you have <code>[section "subsection"]</code>, but you don&#8217;t
1742 need to.</p></div>
1743 <div class="paragraph"><p>There is also a deprecated <code>[section.subsection]</code> syntax. With this
1744 syntax, the subsection name is converted to lower-case and is also
1745 compared case sensitively. These subsection names follow the same
1746 restrictions as section names.</p></div>
1747 <div class="paragraph"><p>All the other lines (and the remainder of the line after the section
1748 header) are recognized as setting variables, in the form
1749 <em>name = value</em> (or just <em>name</em>, which is a short-hand to say that
1750 the variable is the boolean "true").
1751 The variable names are case-insensitive, allow only alphanumeric characters
1752 and <code>-</code>, and must start with an alphabetic character.</p></div>
1753 <div class="paragraph"><p>Whitespace characters surrounding <code>name</code>, <code>=</code> and <code>value</code> are discarded.
1754 Internal whitespace characters within <em>value</em> are retained verbatim.
1755 Comments starting with either <code>#</code> or <code>;</code> and extending to the end of line
1756 are discarded.  A line that defines a value can be continued to the next
1757 line by ending it with a backslash (<code>\</code>);  the backslash and the end-of-line
1758 characters are discarded.</p></div>
1759 <div class="paragraph"><p>If <code>value</code> needs to contain leading or trailing whitespace characters,
1760 it must be enclosed in double quotation marks (<code>"</code>).  Inside double quotation
1761 marks, double quote (<code>"</code>) and backslash (<code>\</code>) characters must be escaped:
1762 use <code>\"</code> for <code>"</code> and <code>\\</code> for <code>\</code>.</p></div>
1763 <div class="paragraph"><p>The following escape sequences (beside <code>\"</code> and <code>\\</code>) are recognized:
1764 <code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB)
1765 and <code>\b</code> for backspace (BS).  Other char escape sequences (including octal
1766 escape sequences) are invalid.</p></div>
1767 </div>
1768 <div class="sect2">
1769 <h3 id="_includes">Includes</h3>
1770 <div class="paragraph"><p>The <code>include</code> and <code>includeIf</code> sections allow you to include config
1771 directives from another source. These sections behave identically to
1772 each other with the exception that <code>includeIf</code> sections may be ignored
1773 if their condition does not evaluate to true; see "Conditional includes"
1774 below.</p></div>
1775 <div class="paragraph"><p>You can include a config file from another by setting the special
1776 <code>include.path</code> (or <code>includeIf.*.path</code>) variable to the name of the file
1777 to be included. The variable takes a pathname as its value, and is
1778 subject to tilde expansion. These variables can be given multiple times.</p></div>
1779 <div class="paragraph"><p>The contents of the included file are inserted immediately, as if they
1780 had been found at the location of the include directive. If the value of the
1781 variable is a relative path, the path is considered to
1782 be relative to the configuration file in which the include directive
1783 was found.  See below for examples.</p></div>
1784 </div>
1785 <div class="sect2">
1786 <h3 id="_conditional_includes">Conditional includes</h3>
1787 <div class="paragraph"><p>You can conditionally include a config file from another by setting an
1788 <code>includeIf.&lt;condition&gt;.path</code> variable to the name of the file to be
1789 included.</p></div>
1790 <div class="paragraph"><p>The condition starts with a keyword followed by a colon and some data
1791 whose format and meaning depends on the keyword. Supported keywords
1792 are:</p></div>
1793 <div class="dlist"><dl>
1794 <dt class="hdlist1">
1795 <code>gitdir</code>
1796 </dt>
1797 <dd>
1798 <p>
1799         The data that follows the keyword <code>gitdir:</code> is used as a glob
1800         pattern. If the location of the .git directory matches the
1801         pattern, the include condition is met.
1802 </p>
1803 <div class="paragraph"><p>The .git location may be auto-discovered, or come from <code>$GIT_DIR</code>
1804 environment variable. If the repository is auto-discovered via a .git
1805 file (e.g. from submodules, or a linked worktree), the .git location
1806 would be the final location where the .git directory is, not where the
1807 .git file is.</p></div>
1808 <div class="paragraph"><p>The pattern can contain standard globbing wildcards and two additional
1809 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components. Please
1810 refer to <a href="gitignore.html">gitignore(5)</a> for details. For convenience:</p></div>
1811 <div class="ulist"><ul>
1812 <li>
1813 <p>
1814 If the pattern starts with <code>~/</code>, <code>~</code> will be substituted with the
1815    content of the environment variable <code>HOME</code>.
1816 </p>
1817 </li>
1818 <li>
1819 <p>
1820 If the pattern starts with <code>./</code>, it is replaced with the directory
1821    containing the current config file.
1822 </p>
1823 </li>
1824 <li>
1825 <p>
1826 If the pattern does not start with either <code>~/</code>, <code>./</code> or <code>/</code>, <code>**/</code>
1827    will be automatically prepended. For example, the pattern <code>foo/bar</code>
1828    becomes <code>**/foo/bar</code> and would match <code>/any/path/to/foo/bar</code>.
1829 </p>
1830 </li>
1831 <li>
1832 <p>
1833 If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1834    example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it
1835    matches "foo" and everything inside, recursively.
1836 </p>
1837 </li>
1838 </ul></div>
1839 </dd>
1840 <dt class="hdlist1">
1841 <code>gitdir/i</code>
1842 </dt>
1843 <dd>
1844 <p>
1845         This is the same as <code>gitdir</code> except that matching is done
1846         case-insensitively (e.g. on case-insensitive file systems)
1847 </p>
1848 </dd>
1849 <dt class="hdlist1">
1850 <code>onbranch</code>
1851 </dt>
1852 <dd>
1853 <p>
1854         The data that follows the keyword <code>onbranch:</code> is taken to be a
1855         pattern with standard globbing wildcards and two additional
1856         ones, <code>**/</code> and <code>/**</code>, that can match multiple path components.
1857         If we are in a worktree where the name of the branch that is
1858         currently checked out matches the pattern, the include condition
1859         is met.
1860 </p>
1861 <div class="paragraph"><p>If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1862 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it matches
1863 all branches that begin with <code>foo/</code>. This is useful if your branches are
1864 organized hierarchically and you would like to apply a configuration to
1865 all the branches in that hierarchy.</p></div>
1866 </dd>
1867 <dt class="hdlist1">
1868 <code>hasconfig:remote.*.url:</code>
1869 </dt>
1870 <dd>
1871 <p>
1872         The data that follows this keyword is taken to
1873         be a pattern with standard globbing wildcards and two
1874         additional ones, <code>**/</code> and <code>/**</code>, that can match multiple
1875         components. The first time this keyword is seen, the rest of
1876         the config files will be scanned for remote URLs (without
1877         applying any values). If there exists at least one remote URL
1878         that matches this pattern, the include condition is met.
1879 </p>
1880 <div class="paragraph"><p>Files included by this option (directly or indirectly) are not allowed
1881 to contain remote URLs.</p></div>
1882 <div class="paragraph"><p>Note that unlike other includeIf conditions, resolving this condition
1883 relies on information that is not yet known at the point of reading the
1884 condition. A typical use case is this option being present as a
1885 system-level or global-level config, and the remote URL being in a
1886 local-level config; hence the need to scan ahead when resolving this
1887 condition. In order to avoid the chicken-and-egg problem in which
1888 potentially-included files can affect whether such files are potentially
1889 included, Git breaks the cycle by prohibiting these files from affecting
1890 the resolution of these conditions (thus, prohibiting them from
1891 declaring remote URLs).</p></div>
1892 <div class="paragraph"><p>As for the naming of this keyword, it is for forwards compatibility with
1893 a naming scheme that supports more variable-based include conditions,
1894 but currently Git only supports the exact keyword described above.</p></div>
1895 </dd>
1896 </dl></div>
1897 <div class="paragraph"><p>A few more notes on matching via <code>gitdir</code> and <code>gitdir/i</code>:</p></div>
1898 <div class="ulist"><ul>
1899 <li>
1900 <p>
1901 Symlinks in <code>$GIT_DIR</code> are not resolved before matching.
1902 </p>
1903 </li>
1904 <li>
1905 <p>
1906 Both the symlink &amp; realpath versions of paths will be matched
1907    outside of <code>$GIT_DIR</code>. E.g. if ~/git is a symlink to
1908    /mnt/storage/git, both <code>gitdir:~/git</code> and <code>gitdir:/mnt/storage/git</code>
1909    will match.
1910 </p>
1911 <div class="paragraph"><p>This was not the case in the initial release of this feature in
1912 v2.13.0, which only matched the realpath version. Configuration that
1913 wants to be compatible with the initial release of this feature needs
1914 to either specify only the realpath version, or both versions.</p></div>
1915 </li>
1916 <li>
1917 <p>
1918 Note that "../" is not special and will match literally, which is
1919    unlikely what you want.
1920 </p>
1921 </li>
1922 </ul></div>
1923 </div>
1924 <div class="sect2">
1925 <h3 id="_example">Example</h3>
1926 <div class="listingblock">
1927 <div class="content">
1928 <pre><code># Core variables
1929 [core]
1930         ; Don't trust file modes
1931         filemode = false
1932
1933 # Our diff algorithm
1934 [diff]
1935         external = /usr/local/bin/diff-wrapper
1936         renames = true
1937
1938 [branch "devel"]
1939         remote = origin
1940         merge = refs/heads/devel
1941
1942 # Proxy settings
1943 [core]
1944         gitProxy="ssh" for "kernel.org"
1945         gitProxy=default-proxy ; for the rest
1946
1947 [include]
1948         path = /path/to/foo.inc ; include by absolute path
1949         path = foo.inc ; find "foo.inc" relative to the current file
1950         path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
1951
1952 ; include if $GIT_DIR is /path/to/foo/.git
1953 [includeIf "gitdir:/path/to/foo/.git"]
1954         path = /path/to/foo.inc
1955
1956 ; include for all repositories inside /path/to/group
1957 [includeIf "gitdir:/path/to/group/"]
1958         path = /path/to/foo.inc
1959
1960 ; include for all repositories inside $HOME/to/group
1961 [includeIf "gitdir:~/to/group/"]
1962         path = /path/to/foo.inc
1963
1964 ; relative paths are always relative to the including
1965 ; file (if the condition is true); their location is not
1966 ; affected by the condition
1967 [includeIf "gitdir:/path/to/group/"]
1968         path = foo.inc
1969
1970 ; include only if we are in a worktree where foo-branch is
1971 ; currently checked out
1972 [includeIf "onbranch:foo-branch"]
1973         path = foo.inc
1974
1975 ; include only if a remote with the given URL exists (note
1976 ; that such a URL may be provided later in a file or in a
1977 ; file read after this file is read, as seen in this example)
1978 [includeIf "hasconfig:remote.*.url:https://example.com/**"]
1979         path = foo.inc
1980 [remote "origin"]
1981         url = https://example.com/git</code></pre>
1982 </div></div>
1983 </div>
1984 <div class="sect2">
1985 <h3 id="_values">Values</h3>
1986 <div class="paragraph"><p>Values of many variables are treated as a simple string, but there
1987 are variables that take values of specific types and there are rules
1988 as to how to spell them.</p></div>
1989 <div class="dlist"><dl>
1990 <dt class="hdlist1">
1991 boolean
1992 </dt>
1993 <dd>
1994 <p>
1995        When a variable is said to take a boolean value, many
1996        synonyms are accepted for <em>true</em> and <em>false</em>; these are all
1997        case-insensitive.
1998 </p>
1999 <div class="dlist"><dl>
2000 <dt class="hdlist1">
2001 true
2002 </dt>
2003 <dd>
2004 <p>
2005 Boolean true literals are <code>yes</code>, <code>on</code>, <code>true</code>,
2006                 and <code>1</code>.  Also, a variable defined without <code>= &lt;value&gt;</code>
2007                 is taken as true.
2008 </p>
2009 </dd>
2010 <dt class="hdlist1">
2011 false
2012 </dt>
2013 <dd>
2014 <p>
2015 Boolean false literals are <code>no</code>, <code>off</code>, <code>false</code>,
2016                 <code>0</code> and the empty string.
2017 </p>
2018 <div class="paragraph"><p>When converting a value to its canonical form using the <code>--type=bool</code> type
2019 specifier, <em>git config</em> will ensure that the output is "true" or
2020 "false" (spelled in lowercase).</p></div>
2021 </dd>
2022 </dl></div>
2023 </dd>
2024 <dt class="hdlist1">
2025 integer
2026 </dt>
2027 <dd>
2028 <p>
2029        The value for many variables that specify various sizes can
2030        be suffixed with <code>k</code>, <code>M</code>,&#8230; to mean "scale the number by
2031        1024", "by 1024x1024", etc.
2032 </p>
2033 </dd>
2034 <dt class="hdlist1">
2035 color
2036 </dt>
2037 <dd>
2038 <p>
2039        The value for a variable that takes a color is a list of
2040        colors (at most two, one for foreground and one for background)
2041        and attributes (as many as you want), separated by spaces.
2042 </p>
2043 <div class="paragraph"><p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>,
2044 <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code> and <code>default</code>.  The first
2045 color given is the foreground; the second is the background.  All the
2046 basic colors except <code>normal</code> and <code>default</code> have a bright variant that can
2047 be specified by prefixing the color with <code>bright</code>, like <code>brightred</code>.</p></div>
2048 <div class="paragraph"><p>The color <code>normal</code> makes no change to the color. It is the same as an
2049 empty string, but can be used as the foreground color when specifying a
2050 background color alone (for example, "normal red").</p></div>
2051 <div class="paragraph"><p>The color <code>default</code> explicitly resets the color to the terminal default,
2052 for example to specify a cleared background. Although it varies between
2053 terminals, this is usually not the same as setting to "white black".</p></div>
2054 <div class="paragraph"><p>Colors may also be given as numbers between 0 and 255; these use ANSI
2055 256-color mode (but note that not all terminals may support this).  If
2056 your terminal supports it, you may also specify 24-bit RGB values as
2057 hex, like <code>#ff0ab3</code>, or 12-bit RGB values like <code>#f1b</code>, which is
2058 equivalent to the 24-bit color <code>#ff11bb</code>.</p></div>
2059 <div class="paragraph"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
2060 <code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters).
2061 The position of any attributes with respect to the colors
2062 (before, after, or in between), doesn&#8217;t matter. Specific attributes may
2063 be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>,
2064 <code>no-ul</code>, etc).</p></div>
2065 <div class="paragraph"><p>The pseudo-attribute <code>reset</code> resets all colors and attributes before
2066 applying the specified coloring. For example, <code>reset green</code> will result
2067 in a green foreground and default background without any active
2068 attributes.</p></div>
2069 <div class="paragraph"><p>An empty color string produces no color effect at all. This can be used
2070 to avoid coloring specific elements without disabling color entirely.</p></div>
2071 <div class="paragraph"><p>For git&#8217;s pre-defined color slots, the attributes are meant to be reset
2072 at the beginning of each item in the colored output. So setting
2073 <code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a
2074 plain <code>black</code>, even if the previous thing on the same output line (e.g.
2075 opening parenthesis before the list of branch names in <code>log --decorate</code>
2076 output) is set to be painted with <code>bold</code> or some other attribute.
2077 However, custom log formats may do more complicated and layered
2078 coloring, and the negated forms may be useful there.</p></div>
2079 </dd>
2080 <dt class="hdlist1">
2081 pathname
2082 </dt>
2083 <dd>
2084 <p>
2085         A variable that takes a pathname value can be given a
2086         string that begins with "<code>~/</code>" or "<code>~user/</code>", and the usual
2087         tilde expansion happens to such a string: <code>~/</code>
2088         is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the
2089         specified user&#8217;s home directory.
2090 </p>
2091 <div class="paragraph"><p>If a path starts with <code>%(prefix)/</code>, the remainder is interpreted as a
2092 path relative to Git&#8217;s "runtime prefix", i.e. relative to the location
2093 where Git itself was installed. For example, <code>%(prefix)/bin/</code> refers to
2094 the directory in which the Git executable itself lives. If Git was
2095 compiled without runtime prefix support, the compiled-in prefix will be
2096 substituted instead. In the unlikely event that a literal path needs to
2097 be specified that should <em>not</em> be expanded, it needs to be prefixed by
2098 <code>./</code>, like so: <code>./%(prefix)/bin</code>.</p></div>
2099 </dd>
2100 </dl></div>
2101 </div>
2102 <div class="sect2">
2103 <h3 id="_variables">Variables</h3>
2104 <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
2105 For command-specific variables, you will find a more detailed description
2106 in the appropriate manual page.</p></div>
2107 <div class="paragraph"><p>Other git-related tools may and do use their own variables.  When
2108 inventing new variables for use in your own tool, make sure their
2109 names do not conflict with those that are used by Git itself and
2110 other popular tools, and describe them in your documentation.</p></div>
2111 <div class="dlist"><dl>
2112 <dt class="hdlist1">
2113 add.ignoreErrors
2114 </dt>
2115 <dt class="hdlist1">
2116 add.ignore-errors (deprecated)
2117 </dt>
2118 <dd>
2119 <p>
2120         Tells <em>git add</em> to continue adding files when some files cannot be
2121         added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
2122         option of <a href="git-add.html">git-add(1)</a>.  <code>add.ignore-errors</code> is deprecated,
2123         as it does not follow the usual naming convention for configuration
2124         variables.
2125 </p>
2126 </dd>
2127 <dt class="hdlist1">
2128 add.interactive.useBuiltin
2129 </dt>
2130 <dd>
2131 <p>
2132         Unused configuration variable. Used in Git versions v2.25.0 to
2133         v2.36.0 to enable the built-in version of <a href="git-add.html">git-add(1)</a>'s
2134         interactive mode, which then became the default in Git
2135         versions v2.37.0 to v2.39.0.
2136 </p>
2137 </dd>
2138 <dt class="hdlist1">
2139 advice.*
2140 </dt>
2141 <dd>
2142 <p>
2143         These variables control various optional help messages designed to
2144         aid new users.  When left unconfigured, Git will give the message
2145         alongside instructions on how to squelch it.  You can tell Git
2146         that you do not need the help message by setting these to <code>false</code>:
2147 </p>
2148 <div class="openblock">
2149 <div class="content">
2150 <div class="dlist"><dl>
2151 <dt class="hdlist1">
2152 addEmbeddedRepo
2153 </dt>
2154 <dd>
2155 <p>
2156                 Shown when the user accidentally adds one
2157                 git repo inside of another.
2158 </p>
2159 </dd>
2160 <dt class="hdlist1">
2161 addEmptyPathspec
2162 </dt>
2163 <dd>
2164 <p>
2165                 Shown when the user runs <code>git add</code> without providing
2166                 the pathspec parameter.
2167 </p>
2168 </dd>
2169 <dt class="hdlist1">
2170 addIgnoredFile
2171 </dt>
2172 <dd>
2173 <p>
2174                 Shown when the user attempts to add an ignored file to
2175                 the index.
2176 </p>
2177 </dd>
2178 <dt class="hdlist1">
2179 amWorkDir
2180 </dt>
2181 <dd>
2182 <p>
2183                 Shown when <a href="git-am.html">git-am(1)</a> fails to apply a patch
2184                 file, to tell the user the location of the file.
2185 </p>
2186 </dd>
2187 <dt class="hdlist1">
2188 ambiguousFetchRefspec
2189 </dt>
2190 <dd>
2191 <p>
2192                 Shown when a fetch refspec for multiple remotes maps to
2193                 the same remote-tracking branch namespace and causes branch
2194                 tracking set-up to fail.
2195 </p>
2196 </dd>
2197 <dt class="hdlist1">
2198 checkoutAmbiguousRemoteBranchName
2199 </dt>
2200 <dd>
2201 <p>
2202                 Shown when the argument to
2203                 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
2204                 ambiguously resolves to a
2205                 remote tracking branch on more than one remote in
2206                 situations where an unambiguous argument would have
2207                 otherwise caused a remote-tracking branch to be
2208                 checked out. See the <code>checkout.defaultRemote</code>
2209                 configuration variable for how to set a given remote
2210                 to be used by default in some situations where this
2211                 advice would be printed.
2212 </p>
2213 </dd>
2214 <dt class="hdlist1">
2215 commitBeforeMerge
2216 </dt>
2217 <dd>
2218 <p>
2219                 Shown when <a href="git-merge.html">git-merge(1)</a> refuses to
2220                 merge to avoid overwriting local changes.
2221 </p>
2222 </dd>
2223 <dt class="hdlist1">
2224 detachedHead
2225 </dt>
2226 <dd>
2227 <p>
2228                 Shown when the user uses
2229                 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
2230                 to move to the detached HEAD state, to tell the user how
2231                 to create a local branch after the fact.
2232 </p>
2233 </dd>
2234 <dt class="hdlist1">
2235 diverging
2236 </dt>
2237 <dd>
2238 <p>
2239                 Shown when a fast-forward is not possible.
2240 </p>
2241 </dd>
2242 <dt class="hdlist1">
2243 fetchShowForcedUpdates
2244 </dt>
2245 <dd>
2246 <p>
2247                 Shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
2248                 to calculate forced updates after ref updates, or to warn
2249                 that the check is disabled.
2250 </p>
2251 </dd>
2252 <dt class="hdlist1">
2253 forceDeleteBranch
2254 </dt>
2255 <dd>
2256 <p>
2257                 Shown when the user tries to delete a not fully merged
2258                 branch without the force option set.
2259 </p>
2260 </dd>
2261 <dt class="hdlist1">
2262 ignoredHook
2263 </dt>
2264 <dd>
2265 <p>
2266                 Shown when a hook is ignored because the hook is not
2267                 set as executable.
2268 </p>
2269 </dd>
2270 <dt class="hdlist1">
2271 implicitIdentity
2272 </dt>
2273 <dd>
2274 <p>
2275                 Shown when the user&#8217;s information is guessed from the
2276                 system username and domain name, to tell the user how to
2277                 set their identity configuration.
2278 </p>
2279 </dd>
2280 <dt class="hdlist1">
2281 mergeConflict
2282 </dt>
2283 <dd>
2284 <p>
2285                 Shown when various commands stop because of conflicts.
2286 </p>
2287 </dd>
2288 <dt class="hdlist1">
2289 nestedTag
2290 </dt>
2291 <dd>
2292 <p>
2293                 Shown when a user attempts to recursively tag a tag object.
2294 </p>
2295 </dd>
2296 <dt class="hdlist1">
2297 pushAlreadyExists
2298 </dt>
2299 <dd>
2300 <p>
2301                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2302                 does not qualify for fast-forwarding (e.g., a tag.)
2303 </p>
2304 </dd>
2305 <dt class="hdlist1">
2306 pushFetchFirst
2307 </dt>
2308 <dd>
2309 <p>
2310                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2311                 tries to overwrite a remote ref that points at an
2312                 object we do not have.
2313 </p>
2314 </dd>
2315 <dt class="hdlist1">
2316 pushNeedsForce
2317 </dt>
2318 <dd>
2319 <p>
2320                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2321                 tries to overwrite a remote ref that points at an
2322                 object that is not a commit-ish, or make the remote
2323                 ref point at an object that is not a commit-ish.
2324 </p>
2325 </dd>
2326 <dt class="hdlist1">
2327 pushNonFFCurrent
2328 </dt>
2329 <dd>
2330 <p>
2331                 Shown when <a href="git-push.html">git-push(1)</a> fails due to a
2332                 non-fast-forward update to the current branch.
2333 </p>
2334 </dd>
2335 <dt class="hdlist1">
2336 pushNonFFMatching
2337 </dt>
2338 <dd>
2339 <p>
2340                 Shown when the user ran <a href="git-push.html">git-push(1)</a> and pushed
2341                 "matching refs" explicitly (i.e. used <code>:</code>, or
2342                 specified a refspec that isn&#8217;t the current branch) and
2343                 it resulted in a non-fast-forward error.
2344 </p>
2345 </dd>
2346 <dt class="hdlist1">
2347 pushRefNeedsUpdate
2348 </dt>
2349 <dd>
2350 <p>
2351                 Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
2352                 a branch when its remote-tracking ref has updates that we
2353                 do not have locally.
2354 </p>
2355 </dd>
2356 <dt class="hdlist1">
2357 pushUnqualifiedRefname
2358 </dt>
2359 <dd>
2360 <p>
2361                 Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
2362                 guess based on the source and destination refs what
2363                 remote ref namespace the source belongs in, but where
2364                 we can still suggest that the user push to either
2365                 <code>refs/heads/*</code> or <code>refs/tags/*</code> based on the type of the
2366                 source object.
2367 </p>
2368 </dd>
2369 <dt class="hdlist1">
2370 pushUpdateRejected
2371 </dt>
2372 <dd>
2373 <p>
2374                 Set this variable to <code>false</code> if you want to disable
2375                 <code>pushNonFFCurrent</code>, <code>pushNonFFMatching</code>, <code>pushAlreadyExists</code>,
2376                 <code>pushFetchFirst</code>, <code>pushNeedsForce</code>, and <code>pushRefNeedsUpdate</code>
2377                 simultaneously.
2378 </p>
2379 </dd>
2380 <dt class="hdlist1">
2381 refSyntax
2382 </dt>
2383 <dd>
2384 <p>
2385                 Shown when the user provides an illegal ref name, to
2386                 tell the user about the ref syntax documentation.
2387 </p>
2388 </dd>
2389 <dt class="hdlist1">
2390 resetNoRefresh
2391 </dt>
2392 <dd>
2393 <p>
2394                 Shown when <a href="git-reset.html">git-reset(1)</a> takes more than 2
2395                 seconds to refresh the index after reset, to tell the user
2396                 that they can use the <code>--no-refresh</code> option.
2397 </p>
2398 </dd>
2399 <dt class="hdlist1">
2400 resolveConflict
2401 </dt>
2402 <dd>
2403 <p>
2404                 Shown by various commands when conflicts
2405                 prevent the operation from being performed.
2406 </p>
2407 </dd>
2408 <dt class="hdlist1">
2409 rmHints
2410 </dt>
2411 <dd>
2412 <p>
2413                 Shown on failure in the output of <a href="git-rm.html">git-rm(1)</a>, to
2414                 give directions on how to proceed from the current state.
2415 </p>
2416 </dd>
2417 <dt class="hdlist1">
2418 sequencerInUse
2419 </dt>
2420 <dd>
2421 <p>
2422                 Shown when a sequencer command is already in progress.
2423 </p>
2424 </dd>
2425 <dt class="hdlist1">
2426 skippedCherryPicks
2427 </dt>
2428 <dd>
2429 <p>
2430                 Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
2431                 been cherry-picked onto the upstream branch.
2432 </p>
2433 </dd>
2434 <dt class="hdlist1">
2435 statusAheadBehind
2436 </dt>
2437 <dd>
2438 <p>
2439                 Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
2440                 counts for a local ref compared to its remote tracking ref,
2441                 and that calculation takes longer than expected. Will not
2442                 appear if <code>status.aheadBehind</code> is false or the option
2443                 <code>--no-ahead-behind</code> is given.
2444 </p>
2445 </dd>
2446 <dt class="hdlist1">
2447 statusHints
2448 </dt>
2449 <dd>
2450 <p>
2451                 Show directions on how to proceed from the current
2452                 state in the output of <a href="git-status.html">git-status(1)</a>, in
2453                 the template shown when writing commit messages in
2454                 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
2455                 by <a href="git-switch.html">git-switch(1)</a> or
2456                 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.
2457 </p>
2458 </dd>
2459 <dt class="hdlist1">
2460 statusUoption
2461 </dt>
2462 <dd>
2463 <p>
2464                 Shown when <a href="git-status.html">git-status(1)</a> takes more than 2
2465                 seconds to enumerate untracked files, to tell the user that
2466                 they can use the <code>-u</code> option.
2467 </p>
2468 </dd>
2469 <dt class="hdlist1">
2470 submoduleAlternateErrorStrategyDie
2471 </dt>
2472 <dd>
2473 <p>
2474                 Shown when a submodule.alternateErrorStrategy option
2475                 configured to "die" causes a fatal error.
2476 </p>
2477 </dd>
2478 <dt class="hdlist1">
2479 submoduleMergeConflict
2480 </dt>
2481 <dd>
2482 <p>
2483                 Advice shown when a non-trivial submodule merge conflict is
2484                 encountered.
2485 </p>
2486 </dd>
2487 <dt class="hdlist1">
2488 submodulesNotUpdated
2489 </dt>
2490 <dd>
2491 <p>
2492                 Shown when a user runs a submodule command that fails
2493                 because <code>git submodule update --init</code> was not run.
2494 </p>
2495 </dd>
2496 <dt class="hdlist1">
2497 suggestDetachingHead
2498 </dt>
2499 <dd>
2500 <p>
2501                 Shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
2502                 without the explicit <code>--detach</code> option.
2503 </p>
2504 </dd>
2505 <dt class="hdlist1">
2506 updateSparsePath
2507 </dt>
2508 <dd>
2509 <p>
2510                 Shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
2511                 is asked to update index entries outside the current sparse
2512                 checkout.
2513 </p>
2514 </dd>
2515 <dt class="hdlist1">
2516 waitingForEditor
2517 </dt>
2518 <dd>
2519 <p>
2520                 Shown when Git is waiting for editor input. Relevant
2521                 when e.g. the editor is not launched inside the terminal.
2522 </p>
2523 </dd>
2524 <dt class="hdlist1">
2525 worktreeAddOrphan
2526 </dt>
2527 <dd>
2528 <p>
2529                 Shown when the user tries to create a worktree from an
2530                 invalid reference, to tell the user how to create a new unborn
2531                 branch instead.
2532 </p>
2533 </dd>
2534 </dl></div>
2535 </div></div>
2536 </dd>
2537 <dt class="hdlist1">
2538 alias.*
2539 </dt>
2540 <dd>
2541 <p>
2542         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
2543         after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
2544         <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
2545         confusion and troubles with script usage, aliases that
2546         hide existing Git commands are ignored. Arguments are split by
2547         spaces, the usual shell quoting and escaping are supported.
2548         A quote pair or a backslash can be used to quote them.
2549 </p>
2550 <div class="paragraph"><p>Note that the first word of an alias does not necessarily have to be a
2551 command. It can be a command-line option that will be passed into the
2552 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
2553 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
2554 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
2555 running <code>git loud-rebase</code> would be equivalent to
2556 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
2557 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
2558 where the original command does not.</p></div>
2559 <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
2560 it will be treated as a shell command.  For example, defining
2561 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
2562 <code>git new</code> is equivalent to running the shell command
2563 <code>gitk --all --not ORIG_HEAD</code>.  Note:</p></div>
2564 <div class="ulist"><ul>
2565 <li>
2566 <p>
2567 Shell commands will be executed from the top-level directory of a
2568   repository, which may not necessarily be the current directory.
2569 </p>
2570 </li>
2571 <li>
2572 <p>
2573 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
2574   from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.
2575 </p>
2576 </li>
2577 <li>
2578 <p>
2579 Shell command aliases always receive any extra arguments provided to
2580   the Git command-line as positional arguments.
2581 </p>
2582 <div class="ulist"><ul>
2583 <li>
2584 <p>
2585 Care should be taken if your shell alias is a "one-liner" script
2586    with multiple commands (e.g. in a pipeline), references multiple
2587    arguments, or is otherwise not able to handle positional arguments
2588    added at the end.  For example: <code>alias.cmd = "!echo $1 | grep $2"</code>
2589    called as <code>git cmd 1 2</code> will be executed as <em>echo $1 | grep $2
2590    1 2</em>, which is not what you want.
2591 </p>
2592 </li>
2593 <li>
2594 <p>
2595 A convenient way to deal with this is to write your script
2596    operations in an inline function that is then called with any
2597    arguments from the command-line.  For example `alias.cmd = "!c() {
2598    echo $1 | grep $2 ; }; c" will correctly execute the prior example.
2599 </p>
2600 </li>
2601 <li>
2602 <p>
2603 Setting <code>GIT_TRACE=1</code> can help you debug the command being run for
2604    your alias.
2605 </p>
2606 </li>
2607 </ul></div>
2608 </li>
2609 </ul></div>
2610 </dd>
2611 <dt class="hdlist1">
2612 am.keepcr
2613 </dt>
2614 <dd>
2615 <p>
2616         If true, git-am will call git-mailsplit for patches in mbox format
2617         with parameter <code>--keep-cr</code>. In this case git-mailsplit will
2618         not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
2619         by giving <code>--no-keep-cr</code> from the command line.
2620         See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
2621 </p>
2622 </dd>
2623 <dt class="hdlist1">
2624 am.threeWay
2625 </dt>
2626 <dd>
2627 <p>
2628         By default, <code>git am</code> will fail if the patch does not apply cleanly. When
2629         set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
2630         the patch records the identity of blobs it is supposed to apply to and
2631         we have those blobs available locally (equivalent to giving the <code>--3way</code>
2632         option from the command line). Defaults to <code>false</code>.
2633         See <a href="git-am.html">git-am(1)</a>.
2634 </p>
2635 </dd>
2636 <dt class="hdlist1">
2637 apply.ignoreWhitespace
2638 </dt>
2639 <dd>
2640 <p>
2641         When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
2642         whitespace, in the same way as the <code>--ignore-space-change</code>
2643         option.
2644         When set to one of: no, none, never, false, it tells <em>git apply</em> to
2645         respect all whitespace differences.
2646         See <a href="git-apply.html">git-apply(1)</a>.
2647 </p>
2648 </dd>
2649 <dt class="hdlist1">
2650 apply.whitespace
2651 </dt>
2652 <dd>
2653 <p>
2654         Tells <em>git apply</em> how to handle whitespace, in the same way
2655         as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
2656 </p>
2657 </dd>
2658 <dt class="hdlist1">
2659 attr.tree
2660 </dt>
2661 <dd>
2662 <p>
2663         A reference to a tree in the repository from which to read attributes,
2664         instead of the <code>.gitattributes</code> file in the working tree. In a bare
2665         repository, this defaults to <code>HEAD:.gitattributes</code>. If the value does
2666         not resolve to a valid tree object, an empty tree is used instead.
2667         When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2668         command line option are used, this configuration variable has no effect.
2669 </p>
2670 </dd>
2671 <dt class="hdlist1">
2672 blame.blankBoundary
2673 </dt>
2674 <dd>
2675 <p>
2676         Show blank commit object name for boundary commits in
2677         <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.
2678 </p>
2679 </dd>
2680 <dt class="hdlist1">
2681 blame.coloring
2682 </dt>
2683 <dd>
2684 <p>
2685         This determines the coloring scheme to be applied to blame
2686         output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
2687         or <em>none</em> which is the default.
2688 </p>
2689 </dd>
2690 <dt class="hdlist1">
2691 blame.date
2692 </dt>
2693 <dd>
2694 <p>
2695         Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
2696         If unset the iso format is used. For supported values,
2697         see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.
2698 </p>
2699 </dd>
2700 <dt class="hdlist1">
2701 blame.showEmail
2702 </dt>
2703 <dd>
2704 <p>
2705         Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
2706         This option defaults to false.
2707 </p>
2708 </dd>
2709 <dt class="hdlist1">
2710 blame.showRoot
2711 </dt>
2712 <dd>
2713 <p>
2714         Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
2715         This option defaults to false.
2716 </p>
2717 </dd>
2718 <dt class="hdlist1">
2719 blame.ignoreRevsFile
2720 </dt>
2721 <dd>
2722 <p>
2723         Ignore revisions listed in the file, one unabbreviated object name per
2724         line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
2725         <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
2726         file names will reset the list of ignored revisions.  This option will
2727         be handled before the command line option <code>--ignore-revs-file</code>.
2728 </p>
2729 </dd>
2730 <dt class="hdlist1">
2731 blame.markUnblamableLines
2732 </dt>
2733 <dd>
2734 <p>
2735         Mark lines that were changed by an ignored revision that we could not
2736         attribute to another commit with a <em>*</em> in the output of
2737         <a href="git-blame.html">git-blame(1)</a>.
2738 </p>
2739 </dd>
2740 <dt class="hdlist1">
2741 blame.markIgnoredLines
2742 </dt>
2743 <dd>
2744 <p>
2745         Mark lines that were changed by an ignored revision that we attributed to
2746         another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.
2747 </p>
2748 </dd>
2749 <dt class="hdlist1">
2750 branch.autoSetupMerge
2751 </dt>
2752 <dd>
2753 <p>
2754         Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
2755         so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
2756         starting point branch. Note that even if this option is not set,
2757         this behavior can be chosen per-branch using the <code>--track</code>
2758         and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
2759         automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
2760         starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;        automatic setup is done when the starting point is either a
2761         local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
2762         has a tracking configuration, it is copied to the new
2763         branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
2764         is a remote-tracking branch and the new branch has the same name as the
2765         remote branch. This option defaults to true.
2766 </p>
2767 </dd>
2768 <dt class="hdlist1">
2769 branch.autoSetupRebase
2770 </dt>
2771 <dd>
2772 <p>
2773         When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
2774         that tracks another branch, this variable tells Git to set
2775         up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
2776         When <code>never</code>, rebase is never automatically set to true.
2777         When <code>local</code>, rebase is set to true for tracked branches of
2778         other local branches.
2779         When <code>remote</code>, rebase is set to true for tracked branches of
2780         remote-tracking branches.
2781         When <code>always</code>, rebase will be set to true for all tracking
2782         branches.
2783         See "branch.autoSetupMerge" for details on how to set up a
2784         branch to track another branch.
2785         This option defaults to never.
2786 </p>
2787 </dd>
2788 <dt class="hdlist1">
2789 branch.sort
2790 </dt>
2791 <dd>
2792 <p>
2793         This variable controls the sort ordering of branches when displayed by
2794         <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
2795         value of this variable will be used as the default.
2796         See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.
2797 </p>
2798 </dd>
2799 <dt class="hdlist1">
2800 branch.&lt;name&gt;.remote
2801 </dt>
2802 <dd>
2803 <p>
2804         When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
2805         which remote to fetch from or push to.  The remote to push to
2806         may be overridden with <code>remote.pushDefault</code> (for all branches).
2807         The remote to push to, for the current branch, may be further
2808         overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
2809         configured, or if you are not on any branch and there is more than
2810         one remote defined in the repository, it defaults to <code>origin</code> for
2811         fetching and <code>remote.pushDefault</code> for pushing.
2812         Additionally, <code>.</code> (a period) is the current local repository
2813         (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
2814 </p>
2815 </dd>
2816 <dt class="hdlist1">
2817 branch.&lt;name&gt;.pushRemote
2818 </dt>
2819 <dd>
2820 <p>
2821         When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
2822         pushing.  It also overrides <code>remote.pushDefault</code> for pushing
2823         from branch &lt;name&gt;.  When you pull from one place (e.g. your
2824         upstream) and push to another place (e.g. your own publishing
2825         repository), you would want to set <code>remote.pushDefault</code> to
2826         specify the remote to push to for all branches, and use this
2827         option to override it for a specific branch.
2828 </p>
2829 </dd>
2830 <dt class="hdlist1">
2831 branch.&lt;name&gt;.merge
2832 </dt>
2833 <dd>
2834 <p>
2835         Defines, together with branch.&lt;name&gt;.remote, the upstream branch
2836         for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
2837         branch to merge and can also affect <em>git push</em> (see push.default).
2838         When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
2839         refspec to be marked for merging in FETCH_HEAD. The value is
2840         handled like the remote part of a refspec, and must match a
2841         ref which is fetched from the remote given by
2842         "branch.&lt;name&gt;.remote".
2843         The merge information is used by <em>git pull</em> (which first calls
2844         <em>git fetch</em>) to lookup the default branch for merging. Without
2845         this option, <em>git pull</em> defaults to merge the first refspec fetched.
2846         Specify multiple values to get an octopus merge.
2847         If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
2848         another branch in the local repository, you can point
2849         branch.&lt;name&gt;.merge to the desired branch, and use the relative path
2850         setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
2851 </p>
2852 </dd>
2853 <dt class="hdlist1">
2854 branch.&lt;name&gt;.mergeOptions
2855 </dt>
2856 <dd>
2857 <p>
2858         Sets default options for merging into branch &lt;name&gt;. The syntax and
2859         supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
2860         option values containing whitespace characters are currently not
2861         supported.
2862 </p>
2863 </dd>
2864 <dt class="hdlist1">
2865 branch.&lt;name&gt;.rebase
2866 </dt>
2867 <dd>
2868 <p>
2869         When true, rebase the branch &lt;name&gt; on top of the fetched branch,
2870         instead of merging the default branch from the default remote when
2871         "git pull" is run. See "pull.rebase" for doing this in a non
2872         branch-specific manner.
2873 </p>
2874 <div class="paragraph"><p>When <code>merges</code> (or just <em>m</em>), pass the <code>--rebase-merges</code> option to <em>git rebase</em>
2875 so that the local merge commits are included in the rebase (see
2876 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
2877 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
2878 mode.</p></div>
2879 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
2880 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
2881 for details).</p></div>
2882 </dd>
2883 <dt class="hdlist1">
2884 branch.&lt;name&gt;.description
2885 </dt>
2886 <dd>
2887 <p>
2888         Branch description, can be edited with
2889         <code>git branch --edit-description</code>. Branch description is
2890         automatically added to the format-patch cover letter or
2891         request-pull summary.
2892 </p>
2893 </dd>
2894 <dt class="hdlist1">
2895 browser.&lt;tool&gt;.cmd
2896 </dt>
2897 <dd>
2898 <p>
2899         Specify the command to invoke the specified browser. The
2900         specified command is evaluated in shell with the URLs passed
2901         as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
2902 </p>
2903 </dd>
2904 <dt class="hdlist1">
2905 browser.&lt;tool&gt;.path
2906 </dt>
2907 <dd>
2908 <p>
2909         Override the path for the given tool that may be used to
2910         browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
2911         working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
2912 </p>
2913 </dd>
2914 <dt class="hdlist1">
2915 bundle.*
2916 </dt>
2917 <dd>
2918 <p>
2919         The <code>bundle.*</code> keys may appear in a bundle list file found via the
2920         <code>git clone --bundle-uri</code> option. These keys currently have no effect
2921         if placed in a repository config file, though this will change in the
2922         future. See <a href="technical/bundle-uri.html">the bundle URI design
2923         document</a> for more details.
2924 </p>
2925 </dd>
2926 <dt class="hdlist1">
2927 bundle.version
2928 </dt>
2929 <dd>
2930 <p>
2931         This integer value advertises the version of the bundle list format
2932         used by the bundle list. Currently, the only accepted value is <code>1</code>.
2933 </p>
2934 </dd>
2935 <dt class="hdlist1">
2936 bundle.mode
2937 </dt>
2938 <dd>
2939 <p>
2940         This string value should be either <code>all</code> or <code>any</code>. This value describes
2941         whether all of the advertised bundles are required to unbundle a
2942         complete understanding of the bundled information (<code>all</code>) or if any one
2943         of the listed bundle URIs is sufficient (<code>any</code>).
2944 </p>
2945 </dd>
2946 <dt class="hdlist1">
2947 bundle.heuristic
2948 </dt>
2949 <dd>
2950 <p>
2951         If this string-valued key exists, then the bundle list is designed to
2952         work well with incremental <code>git fetch</code> commands. The heuristic signals
2953         that there are additional keys available for each bundle that help
2954         determine which subset of bundles the client should download. The
2955         only value currently understood is <code>creationToken</code>.
2956 </p>
2957 </dd>
2958 <dt class="hdlist1">
2959 bundle.&lt;id&gt;.*
2960 </dt>
2961 <dd>
2962 <p>
2963         The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
2964         bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.
2965 </p>
2966 </dd>
2967 <dt class="hdlist1">
2968 bundle.&lt;id&gt;.uri
2969 </dt>
2970 <dd>
2971 <p>
2972         This string value defines the URI by which Git can reach the contents
2973         of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.
2974 </p>
2975 </dd>
2976 <dt class="hdlist1">
2977 checkout.defaultRemote
2978 </dt>
2979 <dd>
2980 <p>
2981         When you run <code>git checkout &lt;something&gt;</code>
2982         or <code>git switch &lt;something&gt;</code> and only have one
2983         remote, it may implicitly fall back on checking out and
2984         tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
2985         as you have more than one remote with a <code>&lt;something&gt;</code>
2986         reference. This setting allows for setting the name of a
2987         preferred remote that should always win when it comes to
2988         disambiguation. The typical use-case is to set this to
2989         <code>origin</code>.
2990 </p>
2991 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
2992 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
2993 or <code>git switch &lt;something&gt;</code>
2994 will checkout the <code>&lt;something&gt;</code> branch on another remote,
2995 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
2996 remote branch. This setting might be used for other checkout-like
2997 commands or functionality in the future.</p></div>
2998 </dd>
2999 <dt class="hdlist1">
3000 checkout.guess
3001 </dt>
3002 <dd>
3003 <p>
3004         Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
3005         option in <code>git checkout</code> and <code>git switch</code>. See
3006         <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
3007 </p>
3008 </dd>
3009 <dt class="hdlist1">
3010 checkout.workers
3011 </dt>
3012 <dd>
3013 <p>
3014         The number of parallel workers to use when updating the working tree.
3015         The default is one, i.e. sequential execution. If set to a value less
3016         than one, Git will use as many workers as the number of logical cores
3017         available. This setting and <code>checkout.thresholdForParallelism</code> affect
3018         all commands that perform checkout. E.g. checkout, clone, reset,
3019         sparse-checkout, etc.
3020 </p>
3021 <div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories
3022 located on SSDs or over NFS. For repositories on spinning disks and/or machines
3023 with a small number of cores, the default sequential checkout often performs
3024 better. The size and compression level of a repository might also influence how
3025 well the parallel version performs.</p></div>
3026 </dd>
3027 <dt class="hdlist1">
3028 checkout.thresholdForParallelism
3029 </dt>
3030 <dd>
3031 <p>
3032         When running parallel checkout with a small number of files, the cost
3033         of subprocess spawning and inter-process communication might outweigh
3034         the parallelization gains. This setting allows you to define the minimum
3035         number of files for which parallel checkout should be attempted. The
3036         default is 100.
3037 </p>
3038 </dd>
3039 <dt class="hdlist1">
3040 clean.requireForce
3041 </dt>
3042 <dd>
3043 <p>
3044         A boolean to make git-clean refuse to delete files unless -f
3045         is given. Defaults to true.
3046 </p>
3047 </dd>
3048 <dt class="hdlist1">
3049 <code>clone.defaultRemoteName</code>
3050 </dt>
3051 <dd>
3052 <p>
3053         The name of the remote to create when cloning a repository.  Defaults to
3054         <code>origin</code>.
3055         It can be overridden by passing the <code>--origin</code> command-line
3056         option to <a href="git-clone.html">git-clone(1)</a>.
3057 </p>
3058 </dd>
3059 <dt class="hdlist1">
3060 <code>clone.rejectShallow</code>
3061 </dt>
3062 <dd>
3063 <p>
3064         Reject cloning a repository if it is a shallow one; this can be overridden by
3065         passing the <code>--reject-shallow</code> option on the command line.
3066         See <a href="git-clone.html">git-clone(1)</a>.
3067 </p>
3068 </dd>
3069 <dt class="hdlist1">
3070 <code>clone.filterSubmodules</code>
3071 </dt>
3072 <dd>
3073 <p>
3074         If a partial clone filter is provided (see <code>--filter</code> in
3075         <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
3076         the filter to submodules.
3077 </p>
3078 </dd>
3079 <dt class="hdlist1">
3080 color.advice
3081 </dt>
3082 <dd>
3083 <p>
3084         A boolean to enable/disable color in hints (e.g. when a push
3085         failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
3086         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
3087         are used only when the error output goes to a terminal. If
3088         unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3089 </p>
3090 </dd>
3091 <dt class="hdlist1">
3092 color.advice.hint
3093 </dt>
3094 <dd>
3095 <p>
3096         Use customized color for hints.
3097 </p>
3098 </dd>
3099 <dt class="hdlist1">
3100 color.blame.highlightRecent
3101 </dt>
3102 <dd>
3103 <p>
3104         Specify the line annotation color for <code>git blame --color-by-age</code>
3105         depending upon the age of the line.
3106 </p>
3107 <div class="paragraph"><p>This setting should be set to a comma-separated list of color and
3108 date settings, starting and ending with a color, the dates should be
3109 set from oldest to newest. The metadata will be colored with the
3110 specified colors if the line was introduced before the given
3111 timestamp, overwriting older timestamped colors.</p></div>
3112 <div class="paragraph"><p>Instead of an absolute timestamp relative timestamps work as well,
3113 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
3114 <div class="paragraph"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
3115 colors everything older than one year blue, recent changes between
3116 one month and one year old are kept white, and lines introduced
3117 within the last month are colored red.</p></div>
3118 </dd>
3119 <dt class="hdlist1">
3120 color.blame.repeatedLines
3121 </dt>
3122 <dd>
3123 <p>
3124         Use the specified color to colorize line annotations for
3125         <code>git blame --color-lines</code>, if they come from the same commit as the
3126         preceding line. Defaults to cyan.
3127 </p>
3128 </dd>
3129 <dt class="hdlist1">
3130 color.branch
3131 </dt>
3132 <dd>
3133 <p>
3134         A boolean to enable/disable color in the output of
3135         <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
3136         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3137         only when the output is to a terminal. If unset, then the
3138         value of <code>color.ui</code> is used (<code>auto</code> by default).
3139 </p>
3140 </dd>
3141 <dt class="hdlist1">
3142 color.branch.&lt;slot&gt;
3143 </dt>
3144 <dd>
3145 <p>
3146         Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
3147         <code>current</code> (the current branch), <code>local</code> (a local branch),
3148         <code>remote</code> (a remote-tracking branch in refs/remotes/),
3149         <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
3150         refs).
3151 </p>
3152 </dd>
3153 <dt class="hdlist1">
3154 color.diff
3155 </dt>
3156 <dd>
3157 <p>
3158         Whether to use ANSI escape sequences to add color to patches.
3159         If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
3160         <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
3161         for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
3162         commands will only use color when output is to the terminal.
3163         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
3164         default).
3165 </p>
3166 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
3167 <em>git-diff-&#42;</em> plumbing commands.  Can be overridden on the
3168 command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
3169 </dd>
3170 <dt class="hdlist1">
3171 color.diff.&lt;slot&gt;
3172 </dt>
3173 <dd>
3174 <p>
3175         Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
3176         which part of the patch to use the specified color, and is one
3177         of <code>context</code> (context text - <code>plain</code> is a historical synonym),
3178         <code>meta</code> (metainformation), <code>frag</code>
3179         (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
3180         <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
3181         (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
3182         <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
3183         <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
3184         <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
3185         setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
3186         <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
3187         <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).
3188 </p>
3189 </dd>
3190 <dt class="hdlist1">
3191 color.decorate.&lt;slot&gt;
3192 </dt>
3193 <dd>
3194 <p>
3195         Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
3196         of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
3197         branches, remote-tracking branches, tags, stash and HEAD, respectively
3198         and <code>grafted</code> for grafted commits.
3199 </p>
3200 </dd>
3201 <dt class="hdlist1">
3202 color.grep
3203 </dt>
3204 <dd>
3205 <p>
3206         When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
3207         <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
3208         when the output is written to the terminal.  If unset, then the
3209         value of <code>color.ui</code> is used (<code>auto</code> by default).
3210 </p>
3211 </dd>
3212 <dt class="hdlist1">
3213 color.grep.&lt;slot&gt;
3214 </dt>
3215 <dd>
3216 <p>
3217         Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
3218         part of the line to use the specified color, and is one of
3219 </p>
3220 <div class="openblock">
3221 <div class="content">
3222 <div class="dlist"><dl>
3223 <dt class="hdlist1">
3224 <code>context</code>
3225 </dt>
3226 <dd>
3227 <p>
3228         non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
3229 </p>
3230 </dd>
3231 <dt class="hdlist1">
3232 <code>filename</code>
3233 </dt>
3234 <dd>
3235 <p>
3236         filename prefix (when not using <code>-h</code>)
3237 </p>
3238 </dd>
3239 <dt class="hdlist1">
3240 <code>function</code>
3241 </dt>
3242 <dd>
3243 <p>
3244         function name lines (when using <code>-p</code>)
3245 </p>
3246 </dd>
3247 <dt class="hdlist1">
3248 <code>lineNumber</code>
3249 </dt>
3250 <dd>
3251 <p>
3252         line number prefix (when using <code>-n</code>)
3253 </p>
3254 </dd>
3255 <dt class="hdlist1">
3256 <code>column</code>
3257 </dt>
3258 <dd>
3259 <p>
3260         column number prefix (when using <code>--column</code>)
3261 </p>
3262 </dd>
3263 <dt class="hdlist1">
3264 <code>match</code>
3265 </dt>
3266 <dd>
3267 <p>
3268         matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
3269 </p>
3270 </dd>
3271 <dt class="hdlist1">
3272 <code>matchContext</code>
3273 </dt>
3274 <dd>
3275 <p>
3276         matching text in context lines
3277 </p>
3278 </dd>
3279 <dt class="hdlist1">
3280 <code>matchSelected</code>
3281 </dt>
3282 <dd>
3283 <p>
3284         matching text in selected lines. Also, used to customize the following
3285         <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.
3286 </p>
3287 </dd>
3288 <dt class="hdlist1">
3289 <code>selected</code>
3290 </dt>
3291 <dd>
3292 <p>
3293         non-matching text in selected lines. Also, used to customize the
3294         following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
3295         <code>--committer</code>.
3296 </p>
3297 </dd>
3298 <dt class="hdlist1">
3299 <code>separator</code>
3300 </dt>
3301 <dd>
3302 <p>
3303         separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
3304         and between hunks (<code>--</code>)
3305 </p>
3306 </dd>
3307 </dl></div>
3308 </div></div>
3309 </dd>
3310 <dt class="hdlist1">
3311 color.interactive
3312 </dt>
3313 <dd>
3314 <p>
3315         When set to <code>always</code>, always use colors for interactive prompts
3316         and displays (such as those used by "git-add --interactive" and
3317         "git-clean --interactive"). When false (or <code>never</code>), never.
3318         When set to <code>true</code> or <code>auto</code>, use colors only when the output is
3319         to the terminal. If unset, then the value of <code>color.ui</code> is
3320         used (<code>auto</code> by default).
3321 </p>
3322 </dd>
3323 <dt class="hdlist1">
3324 color.interactive.&lt;slot&gt;
3325 </dt>
3326 <dd>
3327 <p>
3328         Use customized color for <em>git add --interactive</em> and <em>git clean
3329         --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
3330         or <code>error</code>, for four distinct types of normal output from
3331         interactive commands.
3332 </p>
3333 </dd>
3334 <dt class="hdlist1">
3335 color.pager
3336 </dt>
3337 <dd>
3338 <p>
3339         A boolean to specify whether <code>auto</code> color modes should colorize
3340         output going to the pager. Defaults to true; set this to false
3341         if your pager does not understand ANSI color codes.
3342 </p>
3343 </dd>
3344 <dt class="hdlist1">
3345 color.push
3346 </dt>
3347 <dd>
3348 <p>
3349         A boolean to enable/disable color in push errors. May be set to
3350         <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3351         case colors are used only when the error output goes to a terminal.
3352         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3353 </p>
3354 </dd>
3355 <dt class="hdlist1">
3356 color.push.error
3357 </dt>
3358 <dd>
3359 <p>
3360         Use customized color for push errors.
3361 </p>
3362 </dd>
3363 <dt class="hdlist1">
3364 color.remote
3365 </dt>
3366 <dd>
3367 <p>
3368         If set, keywords at the start of the line are highlighted. The
3369         keywords are "error", "warning", "hint" and "success", and are
3370         matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
3371         <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
3372         <code>color.ui</code> is used (<code>auto</code> by default).
3373 </p>
3374 </dd>
3375 <dt class="hdlist1">
3376 color.remote.&lt;slot&gt;
3377 </dt>
3378 <dd>
3379 <p>
3380         Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
3381         <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
3382         corresponding keyword.
3383 </p>
3384 </dd>
3385 <dt class="hdlist1">
3386 color.showBranch
3387 </dt>
3388 <dd>
3389 <p>
3390         A boolean to enable/disable color in the output of
3391         <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
3392         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3393         only when the output is to a terminal. If unset, then the
3394         value of <code>color.ui</code> is used (<code>auto</code> by default).
3395 </p>
3396 </dd>
3397 <dt class="hdlist1">
3398 color.status
3399 </dt>
3400 <dd>
3401 <p>
3402         A boolean to enable/disable color in the output of
3403         <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
3404         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3405         only when the output is to a terminal. If unset, then the
3406         value of <code>color.ui</code> is used (<code>auto</code> by default).
3407 </p>
3408 </dd>
3409 <dt class="hdlist1">
3410 color.status.&lt;slot&gt;
3411 </dt>
3412 <dd>
3413 <p>
3414         Use customized color for status colorization. <code>&lt;slot&gt;</code> is
3415         one of <code>header</code> (the header text of the status message),
3416         <code>added</code> or <code>updated</code> (files which are added but not committed),
3417         <code>changed</code> (files which are changed but not added in the index),
3418         <code>untracked</code> (files which are not tracked by Git),
3419         <code>branch</code> (the current branch),
3420         <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
3421         to red),
3422         <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
3423         respectively, when branch and tracking information is displayed in the
3424         status short-format), or
3425         <code>unmerged</code> (files which have unmerged changes).
3426 </p>
3427 </dd>
3428 <dt class="hdlist1">
3429 color.transport
3430 </dt>
3431 <dd>
3432 <p>
3433         A boolean to enable/disable color when pushes are rejected. May be
3434         set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3435         case colors are used only when the error output goes to a terminal.
3436         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3437 </p>
3438 </dd>
3439 <dt class="hdlist1">
3440 color.transport.rejected
3441 </dt>
3442 <dd>
3443 <p>
3444         Use customized color when a push was rejected.
3445 </p>
3446 </dd>
3447 <dt class="hdlist1">
3448 color.ui
3449 </dt>
3450 <dd>
3451 <p>
3452         This variable determines the default value for variables such
3453         as <code>color.diff</code> and <code>color.grep</code> that control the use of color
3454         per command family. Its scope will expand as more commands learn
3455         configuration to set a default for the <code>--color</code> option.  Set it
3456         to <code>false</code> or <code>never</code> if you prefer Git commands not to use
3457         color unless enabled explicitly with some other configuration
3458         or the <code>--color</code> option. Set it to <code>always</code> if you want all
3459         output not intended for machine consumption to use color, to
3460         <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
3461         want such output to use color when written to the terminal.
3462 </p>
3463 </dd>
3464 <dt class="hdlist1">
3465 column.ui
3466 </dt>
3467 <dd>
3468 <p>
3469         Specify whether supported commands should output in columns.
3470         This variable consists of a list of tokens separated by spaces
3471         or commas:
3472 </p>
3473 <div class="paragraph"><p>These options control when the feature should be enabled
3474 (defaults to <em>never</em>):</p></div>
3475 <div class="openblock">
3476 <div class="content">
3477 <div class="dlist"><dl>
3478 <dt class="hdlist1">
3479 <code>always</code>
3480 </dt>
3481 <dd>
3482 <p>
3483         always show in columns
3484 </p>
3485 </dd>
3486 <dt class="hdlist1">
3487 <code>never</code>
3488 </dt>
3489 <dd>
3490 <p>
3491         never show in columns
3492 </p>
3493 </dd>
3494 <dt class="hdlist1">
3495 <code>auto</code>
3496 </dt>
3497 <dd>
3498 <p>
3499         show in columns if the output is to the terminal
3500 </p>
3501 </dd>
3502 </dl></div>
3503 </div></div>
3504 <div class="paragraph"><p>These options control layout (defaults to <em>column</em>).  Setting any
3505 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
3506 specified.</p></div>
3507 <div class="openblock">
3508 <div class="content">
3509 <div class="dlist"><dl>
3510 <dt class="hdlist1">
3511 <code>column</code>
3512 </dt>
3513 <dd>
3514 <p>
3515         fill columns before rows
3516 </p>
3517 </dd>
3518 <dt class="hdlist1">
3519 <code>row</code>
3520 </dt>
3521 <dd>
3522 <p>
3523         fill rows before columns
3524 </p>
3525 </dd>
3526 <dt class="hdlist1">
3527 <code>plain</code>
3528 </dt>
3529 <dd>
3530 <p>
3531         show in one column
3532 </p>
3533 </dd>
3534 </dl></div>
3535 </div></div>
3536 <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
3537 to <em>nodense</em>):</p></div>
3538 <div class="openblock">
3539 <div class="content">
3540 <div class="dlist"><dl>
3541 <dt class="hdlist1">
3542 <code>dense</code>
3543 </dt>
3544 <dd>
3545 <p>
3546         make unequal size columns to utilize more space
3547 </p>
3548 </dd>
3549 <dt class="hdlist1">
3550 <code>nodense</code>
3551 </dt>
3552 <dd>
3553 <p>
3554         make equal size columns
3555 </p>
3556 </dd>
3557 </dl></div>
3558 </div></div>
3559 </dd>
3560 <dt class="hdlist1">
3561 column.branch
3562 </dt>
3563 <dd>
3564 <p>
3565         Specify whether to output branch listing in <code>git branch</code> in columns.
3566         See <code>column.ui</code> for details.
3567 </p>
3568 </dd>
3569 <dt class="hdlist1">
3570 column.clean
3571 </dt>
3572 <dd>
3573 <p>
3574         Specify the layout when listing items in <code>git clean -i</code>, which always
3575         shows files and directories in columns. See <code>column.ui</code> for details.
3576 </p>
3577 </dd>
3578 <dt class="hdlist1">
3579 column.status
3580 </dt>
3581 <dd>
3582 <p>
3583         Specify whether to output untracked files in <code>git status</code> in columns.
3584         See <code>column.ui</code> for details.
3585 </p>
3586 </dd>
3587 <dt class="hdlist1">
3588 column.tag
3589 </dt>
3590 <dd>
3591 <p>
3592         Specify whether to output tag listings in <code>git tag</code> in columns.
3593         See <code>column.ui</code> for details.
3594 </p>
3595 </dd>
3596 <dt class="hdlist1">
3597 commit.cleanup
3598 </dt>
3599 <dd>
3600 <p>
3601         This setting overrides the default of the <code>--cleanup</code> option in
3602         <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
3603         default can be useful when you always want to keep lines that begin
3604         with the comment character <code>#</code> in your log message, in which case you
3605         would do <code>git config commit.cleanup whitespace</code> (note that you will
3606         have to remove the help lines that begin with <code>#</code> in the commit log
3607         template yourself, if you do this).
3608 </p>
3609 </dd>
3610 <dt class="hdlist1">
3611 commit.gpgSign
3612 </dt>
3613 <dd>
3614 <p>
3615         A boolean to specify whether all commits should be GPG signed.
3616         Use of this option when doing operations such as rebase can
3617         result in a large number of commits being signed. It may be
3618         convenient to use an agent to avoid typing your GPG passphrase
3619         several times.
3620 </p>
3621 </dd>
3622 <dt class="hdlist1">
3623 commit.status
3624 </dt>
3625 <dd>
3626 <p>
3627         A boolean to enable/disable inclusion of status information in the
3628         commit message template when using an editor to prepare the commit
3629         message.  Defaults to true.
3630 </p>
3631 </dd>
3632 <dt class="hdlist1">
3633 commit.template
3634 </dt>
3635 <dd>
3636 <p>
3637         Specify the pathname of a file to use as the template for
3638         new commit messages.
3639 </p>
3640 </dd>
3641 <dt class="hdlist1">
3642 commit.verbose
3643 </dt>
3644 <dd>
3645 <p>
3646         A boolean or int to specify the level of verbosity with <code>git commit</code>.
3647         See <a href="git-commit.html">git-commit(1)</a>.
3648 </p>
3649 </dd>
3650 <dt class="hdlist1">
3651 commitGraph.generationVersion
3652 </dt>
3653 <dd>
3654 <p>
3655         Specifies the type of generation number version to use when writing
3656         or reading the commit-graph file. If version 1 is specified, then
3657         the corrected commit dates will not be written or read. Defaults to
3658         2.
3659 </p>
3660 </dd>
3661 <dt class="hdlist1">
3662 commitGraph.maxNewFilters
3663 </dt>
3664 <dd>
3665 <p>
3666         Specifies the default value for the <code>--max-new-filters</code> option of <code>git
3667         commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).
3668 </p>
3669 </dd>
3670 <dt class="hdlist1">
3671 commitGraph.readChangedPaths
3672 </dt>
3673 <dd>
3674 <p>
3675         If true, then git will use the changed-path Bloom filters in the
3676         commit-graph file (if it exists, and they are present). Defaults to
3677         true. See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
3678 </p>
3679 </dd>
3680 <dt class="hdlist1">
3681 completion.commands
3682 </dt>
3683 <dd>
3684 <p>
3685         This is only used by git-completion.bash to add or remove
3686         commands from the list of completed commands. Normally only
3687         porcelain commands and a few select others are completed. You
3688         can add more commands, separated by space, in this
3689         variable. Prefixing the command with <em>-</em> will remove it from
3690         the existing list.
3691 </p>
3692 </dd>
3693 <dt class="hdlist1">
3694 core.fileMode
3695 </dt>
3696 <dd>
3697 <p>
3698         Tells Git if the executable bit of files in the working tree
3699         is to be honored.
3700 </p>
3701 <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
3702 marked as executable is checked out, or checks out a
3703 non-executable file with executable bit on.
3704 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
3705 to see if it handles the executable bit correctly
3706 and this variable is automatically set as necessary.</p></div>
3707 <div class="paragraph"><p>A repository, however, may be on a filesystem that handles
3708 the filemode correctly, and this variable is set to <em>true</em>
3709 when created, but later may be made accessible from another
3710 environment that loses the filemode (e.g. exporting ext4 via
3711 CIFS mount, visiting a Cygwin created repository with
3712 Git for Windows or Eclipse).
3713 In such a case it may be necessary to set this variable to <em>false</em>.
3714 See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
3715 <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
3716 </dd>
3717 <dt class="hdlist1">
3718 core.hideDotFiles
3719 </dt>
3720 <dd>
3721 <p>
3722         (Windows-only) If true, mark newly-created directories and files whose
3723         name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
3724         directory is hidden, but no other files starting with a dot.  The
3725         default mode is <em>dotGitOnly</em>.
3726 </p>
3727 </dd>
3728 <dt class="hdlist1">
3729 core.ignoreCase
3730 </dt>
3731 <dd>
3732 <p>
3733         Internal variable which enables various workarounds to enable
3734         Git to work better on filesystems that are not case sensitive,
3735         like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
3736         finds "makefile" when Git expects "Makefile", Git will assume
3737         it is really the same file, and continue to remember it as
3738         "Makefile".
3739 </p>
3740 <div class="paragraph"><p>The default is false, except <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a>
3741 will probe and set core.ignoreCase true if appropriate when the repository
3742 is created.</p></div>
3743 <div class="paragraph"><p>Git relies on the proper configuration of this variable for your operating
3744 and file system. Modifying this value may result in unexpected behavior.</p></div>
3745 </dd>
3746 <dt class="hdlist1">
3747 core.precomposeUnicode
3748 </dt>
3749 <dd>
3750 <p>
3751         This option is only used by Mac OS implementation of Git.
3752         When core.precomposeUnicode=true, Git reverts the unicode decomposition
3753         of filenames done by Mac OS. This is useful when sharing a repository
3754         between Mac OS and Linux or Windows.
3755         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
3756         When false, file names are handled fully transparent by Git,
3757         which is backward compatible with older versions of Git.
3758 </p>
3759 </dd>
3760 <dt class="hdlist1">
3761 core.protectHFS
3762 </dt>
3763 <dd>
3764 <p>
3765         If set to true, do not allow checkout of paths that would
3766         be considered equivalent to <code>.git</code> on an HFS+ filesystem.
3767         Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
3768 </p>
3769 </dd>
3770 <dt class="hdlist1">
3771 core.protectNTFS
3772 </dt>
3773 <dd>
3774 <p>
3775         If set to true, do not allow checkout of paths that would
3776         cause problems with the NTFS filesystem, e.g. conflict with
3777         8.3 "short" names.
3778         Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
3779 </p>
3780 </dd>
3781 <dt class="hdlist1">
3782 core.fsmonitor
3783 </dt>
3784 <dd>
3785 <p>
3786         If set to true, enable the built-in file system monitor
3787         daemon for this working directory (<a href="git-fsmonitor&#45;&#45;daemon.html">git-fsmonitor&#45;&#45;daemon(1)</a>).
3788 </p>
3789 <div class="paragraph"><p>Like hook-based file system monitors, the built-in file system monitor
3790 can speed up Git commands that need to refresh the Git index
3791 (e.g. <code>git status</code>) in a working directory with many files.  The
3792 built-in monitor eliminates the need to install and maintain an
3793 external third-party tool.</p></div>
3794 <div class="paragraph"><p>The built-in file system monitor is currently available only on a
3795 limited set of supported platforms.  Currently, this includes Windows
3796 and MacOS.</p></div>
3797 <div class="literalblock">
3798 <div class="content">
3799 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor"
3800 hook command.</code></pre>
3801 </div></div>
3802 <div class="paragraph"><p>This hook command is used to identify all files that may have changed
3803 since the requested date/time. This information is used to speed up
3804 git by avoiding unnecessary scanning of files that have not changed.</p></div>
3805 <div class="paragraph"><p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p></div>
3806 <div class="paragraph"><p>Note that if you concurrently use multiple versions of Git, such
3807 as one version on the command line and another version in an IDE
3808 tool, that the definition of <code>core.fsmonitor</code> was extended to
3809 allow boolean values in addition to hook pathnames.  Git versions
3810 2.35.1 and prior will not understand the boolean values and will
3811 consider the "true" or "false" values as hook pathnames to be
3812 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
3813 V2 and will fall back to no fsmonitor (full scan).  Git versions
3814 prior to 2.26 default to hook protocol V1 and will silently
3815 assume there were no changes to report (no scan), so status
3816 commands may report incomplete results.  For this reason, it is
3817 best to upgrade all of your Git versions before using the built-in
3818 file system monitor.</p></div>
3819 </dd>
3820 <dt class="hdlist1">
3821 core.fsmonitorHookVersion
3822 </dt>
3823 <dd>
3824 <p>
3825         Sets the protocol version to be used when invoking the
3826         "fsmonitor" hook.
3827 </p>
3828 <div class="paragraph"><p>There are currently versions 1 and 2. When this is not set,
3829 version 2 will be tried first and if it fails then version 1
3830 will be tried. Version 1 uses a timestamp as input to determine
3831 which files have changes since that time but some monitors
3832 like Watchman have race conditions when used with a timestamp.
3833 Version 2 uses an opaque string so that the monitor can return
3834 something that can be used to determine what files have changed
3835 without race conditions.</p></div>
3836 </dd>
3837 <dt class="hdlist1">
3838 core.trustctime
3839 </dt>
3840 <dd>
3841 <p>
3842         If false, the ctime differences between the index and the
3843         working tree are ignored; useful when the inode change time
3844         is regularly modified by something outside Git (file system
3845         crawlers and some backup systems).
3846         See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
3847 </p>
3848 </dd>
3849 <dt class="hdlist1">
3850 core.splitIndex
3851 </dt>
3852 <dd>
3853 <p>
3854         If true, the split-index feature of the index will be used.
3855         See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
3856 </p>
3857 </dd>
3858 <dt class="hdlist1">
3859 core.untrackedCache
3860 </dt>
3861 <dd>
3862 <p>
3863         Determines what to do about the untracked cache feature of the
3864         index. It will be kept, if this variable is unset or set to
3865         <code>keep</code>. It will automatically be added if set to <code>true</code>. And
3866         it will automatically be removed, if set to <code>false</code>. Before
3867         setting it to <code>true</code>, you should check that mtime is working
3868         properly on your system.
3869         See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
3870         <code>feature.manyFiles</code> is enabled which sets this setting to
3871         <code>true</code> by default.
3872 </p>
3873 </dd>
3874 <dt class="hdlist1">
3875 core.checkStat
3876 </dt>
3877 <dd>
3878 <p>
3879         When missing or is set to <code>default</code>, many fields in the stat
3880         structure are checked to detect if a file has been modified
3881         since Git looked at it.  When this configuration variable is
3882         set to <code>minimal</code>, sub-second part of mtime and ctime, the
3883         uid and gid of the owner of the file, the inode number (and
3884         the device number, if Git was compiled to use it), are
3885         excluded from the check among these fields, leaving only the
3886         whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
3887         is set) and the filesize to be checked.
3888 </p>
3889 <div class="paragraph"><p>There are implementations of Git that do not leave usable values in
3890 some fields (e.g. JGit); by excluding these fields from the
3891 comparison, the <code>minimal</code> mode may help interoperability when the
3892 same repository is used by these other systems at the same time.</p></div>
3893 </dd>
3894 <dt class="hdlist1">
3895 core.quotePath
3896 </dt>
3897 <dd>
3898 <p>
3899         Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
3900         quote "unusual" characters in the pathname by enclosing the
3901         pathname in double-quotes and escaping those characters with
3902         backslashes in the same way C escapes control characters (e.g.
3903         <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
3904         values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
3905         UTF-8).  If this variable is set to false, bytes higher than
3906         0x80 are not considered "unusual" any more. Double-quotes,
3907         backslash and control characters are always escaped regardless
3908         of the setting of this variable.  A simple space character is
3909         not considered "unusual".  Many commands can output pathnames
3910         completely verbatim using the <code>-z</code> option. The default value
3911         is true.
3912 </p>
3913 </dd>
3914 <dt class="hdlist1">
3915 core.eol
3916 </dt>
3917 <dd>
3918 <p>
3919         Sets the line ending type to use in the working directory for
3920         files that are marked as text (either by having the <code>text</code>
3921         attribute set, or by having <code>text=auto</code> and Git auto-detecting
3922         the contents as text).
3923         Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
3924         native line ending.  The default value is <code>native</code>.  See
3925         <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
3926         conversion. Note that this value is ignored if <code>core.autocrlf</code>
3927         is set to <code>true</code> or <code>input</code>.
3928 </p>
3929 </dd>
3930 <dt class="hdlist1">
3931 core.safecrlf
3932 </dt>
3933 <dd>
3934 <p>
3935         If true, makes Git check if converting <code>CRLF</code> is reversible when
3936         end-of-line conversion is active.  Git will verify if a command
3937         modifies a file in the work tree either directly or indirectly.
3938         For example, committing a file followed by checking out the
3939         same file should yield the original file in the work tree.  If
3940         this is not the case for the current setting of
3941         <code>core.autocrlf</code>, Git will reject the file.  The variable can
3942         be set to "warn", in which case Git will only warn about an
3943         irreversible conversion but continue the operation.
3944 </p>
3945 <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
3946 When it is enabled, Git will convert CRLF to LF during commit and LF to
3947 CRLF during checkout.  A file that contains a mixture of LF and
3948 CRLF before the commit cannot be recreated by Git.  For text
3949 files this is the right thing to do: it corrects line endings
3950 such that we have only LF line endings in the repository.
3951 But for binary files that are accidentally classified as text the
3952 conversion can corrupt data.</p></div>
3953 <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
3954 setting the conversion type explicitly in .gitattributes.  Right
3955 after committing you still have the original file in your work
3956 tree and this file is not yet corrupted.  You can explicitly tell
3957 Git that this file is binary and Git will handle the file
3958 appropriately.</p></div>
3959 <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
3960 mixed line endings and the undesired effect of corrupting binary
3961 files cannot be distinguished.  In both cases CRLFs are removed
3962 in an irreversible way.  For text files this is the right thing
3963 to do because CRLFs are line endings, while for binary files
3964 converting CRLFs corrupts data.</p></div>
3965 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
3966 file identical to the original file for a different setting of
3967 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
3968 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
3969 and could later be checked out with <code>core.eol=crlf</code>, in which case the
3970 resulting file would contain <code>CRLF</code>, although the original file
3971 contained <code>LF</code>.  However, in both work trees the line endings would be
3972 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
3973 file with mixed line endings would be reported by the <code>core.safecrlf</code>
3974 mechanism.</p></div>
3975 </dd>
3976 <dt class="hdlist1">
3977 core.autocrlf
3978 </dt>
3979 <dd>
3980 <p>
3981         Setting this variable to "true" is the same as setting
3982         the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
3983         Set to true if you want to have <code>CRLF</code> line endings in your
3984         working directory and the repository has LF line endings.
3985         This variable can be set to <em>input</em>,
3986         in which case no output conversion is performed.
3987 </p>
3988 </dd>
3989 <dt class="hdlist1">
3990 core.checkRoundtripEncoding
3991 </dt>
3992 <dd>
3993 <p>
3994         A comma and/or whitespace separated list of encodings that Git
3995         performs UTF-8 round trip checks on if they are used in an
3996         <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
3997         The default value is <code>SHIFT-JIS</code>.
3998 </p>
3999 </dd>
4000 <dt class="hdlist1">
4001 core.symlinks
4002 </dt>
4003 <dd>
4004 <p>
4005         If false, symbolic links are checked out as small plain files that
4006         contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
4007         <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
4008         file. Useful on filesystems like FAT that do not support
4009         symbolic links.
4010 </p>
4011 <div class="paragraph"><p>The default is true, except <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a>
4012 will probe and set core.symlinks false if appropriate when the repository
4013 is created.</p></div>
4014 </dd>
4015 <dt class="hdlist1">
4016 core.gitProxy
4017 </dt>
4018 <dd>
4019 <p>
4020         A "proxy command" to execute (as <em>command host port</em>) instead
4021         of establishing direct connection to the remote server when
4022         using the Git protocol for fetching. If the variable value is
4023         in the "COMMAND for DOMAIN" format, the command is applied only
4024         on hostnames ending with the specified domain string. This variable
4025         may be set multiple times and is matched in the given order;
4026         the first match wins.
4027 </p>
4028 <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
4029 (which always applies universally, without the special "for"
4030 handling).</p></div>
4031 <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
4032 specify that no proxy be used for a given domain pattern.
4033 This is useful for excluding servers inside a firewall from
4034 proxy use, while defaulting to a common proxy for external domains.</p></div>
4035 </dd>
4036 <dt class="hdlist1">
4037 core.sshCommand
4038 </dt>
4039 <dd>
4040 <p>
4041         If this variable is set, <code>git fetch</code> and <code>git push</code> will
4042         use the specified command instead of <code>ssh</code> when they need to
4043         connect to a remote system. The command is in the same form as
4044         the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
4045         when the environment variable is set.
4046 </p>
4047 </dd>
4048 <dt class="hdlist1">
4049 core.ignoreStat
4050 </dt>
4051 <dd>
4052 <p>
4053         If true, Git will avoid using lstat() calls to detect if files have
4054         changed by setting the "assume-unchanged" bit for those tracked files
4055         which it has updated identically in both the index and working tree.
4056 </p>
4057 <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
4058 the modified files explicitly (e.g. see <em>Examples</em> section in
4059 <a href="git-update-index.html">git-update-index(1)</a>).
4060 Git will not normally detect changes to those files.</p></div>
4061 <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
4062 CIFS/Microsoft Windows.</p></div>
4063 <div class="paragraph"><p>False by default.</p></div>
4064 </dd>
4065 <dt class="hdlist1">
4066 core.preferSymlinkRefs
4067 </dt>
4068 <dd>
4069 <p>
4070         Instead of the default "symref" format for HEAD
4071         and other symbolic reference files, use symbolic links.
4072         This is sometimes needed to work with old scripts that
4073         expect HEAD to be a symbolic link.
4074 </p>
4075 </dd>
4076 <dt class="hdlist1">
4077 core.alternateRefsCommand
4078 </dt>
4079 <dd>
4080 <p>
4081         When advertising tips of available history from an alternate, use the shell to
4082         execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
4083         first argument is the absolute path of the alternate. Output must contain one
4084         hex object id per line (i.e., the same as produced by <code>git for-each-ref
4085         --format='%(objectname)'</code>).
4086 </p>
4087 <div class="paragraph"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
4088 value, as it does not take a repository path as an argument (but you can wrap
4089 the command above in a shell script).</p></div>
4090 </dd>
4091 <dt class="hdlist1">
4092 core.alternateRefsPrefixes
4093 </dt>
4094 <dd>
4095 <p>
4096         When listing references from an alternate, list only references that begin
4097         with the given prefix. Prefixes match as if they were given as arguments to
4098         <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
4099         whitespace. If <code>core.alternateRefsCommand</code> is set, setting
4100         <code>core.alternateRefsPrefixes</code> has no effect.
4101 </p>
4102 </dd>
4103 <dt class="hdlist1">
4104 core.bare
4105 </dt>
4106 <dd>
4107 <p>
4108         If true this repository is assumed to be <em>bare</em> and has no
4109         working directory associated with it.  If this is the case a
4110         number of commands that require a working directory will be
4111         disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
4112 </p>
4113 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
4114 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
4115 repository that ends in "/.git" is assumed to be not bare (bare =
4116 false), while all other repositories are assumed to be bare (bare
4117 = true).</p></div>
4118 </dd>
4119 <dt class="hdlist1">
4120 core.worktree
4121 </dt>
4122 <dd>
4123 <p>
4124         Set the path to the root of the working tree.
4125         If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
4126         is ignored and not used for determining the root of working tree.
4127         This can be overridden by the <code>GIT_WORK_TREE</code> environment
4128         variable and the <code>--work-tree</code> command-line option.
4129         The value can be an absolute path or relative to the path to
4130         the .git directory, which is either specified by --git-dir
4131         or GIT_DIR, or automatically discovered.
4132         If --git-dir or GIT_DIR is specified but none of
4133         --work-tree, GIT_WORK_TREE and core.worktree is specified,
4134         the current working directory is regarded as the top level
4135         of your working tree.
4136 </p>
4137 <div class="paragraph"><p>Note that this variable is honored even when set in a configuration
4138 file in a ".git" subdirectory of a directory and its value differs
4139 from the latter directory (e.g. "/path/to/.git/config" has
4140 core.worktree set to "/different/path"), which is most likely a
4141 misconfiguration.  Running Git commands in the "/path/to" directory will
4142 still use "/different/path" as the root of the work tree and can cause
4143 confusion unless you know what you are doing (e.g. you are creating a
4144 read-only snapshot of the same index to a location different from the
4145 repository&#8217;s usual working tree).</p></div>
4146 </dd>
4147 <dt class="hdlist1">
4148 core.logAllRefUpdates
4149 </dt>
4150 <dd>
4151 <p>
4152         Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
4153         "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
4154         SHA-1, the date/time and the reason of the update, but
4155         only when the file exists.  If this configuration
4156         variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
4157         file is automatically created for branch heads (i.e. under
4158         <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
4159         note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
4160         If it is set to <code>always</code>, then a missing reflog is automatically
4161         created for any ref under <code>refs/</code>.
4162 </p>
4163 <div class="paragraph"><p>This information can be used to determine what commit
4164 was the tip of a branch "2 days ago".</p></div>
4165 <div class="paragraph"><p>This value is true by default in a repository that has
4166 a working directory associated with it, and false by
4167 default in a bare repository.</p></div>
4168 </dd>
4169 <dt class="hdlist1">
4170 core.repositoryFormatVersion
4171 </dt>
4172 <dd>
4173 <p>
4174         Internal variable identifying the repository format and layout
4175         version.
4176 </p>
4177 </dd>
4178 <dt class="hdlist1">
4179 core.sharedRepository
4180 </dt>
4181 <dd>
4182 <p>
4183         When <em>group</em> (or <em>true</em>), the repository is made shareable between
4184         several users in a group (making sure all the files and objects are
4185         group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
4186         repository will be readable by all users, additionally to being
4187         group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
4188         reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
4189         files in the repository will have this mode value. <em>0xxx</em> will override
4190         user&#8217;s umask value (whereas the other options will only override
4191         requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
4192         the repo read/write-able for the owner and group, but inaccessible to
4193         others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
4194         repository that is group-readable but not group-writable.
4195         See <a href="git-init.html">git-init(1)</a>. False by default.
4196 </p>
4197 </dd>
4198 <dt class="hdlist1">
4199 core.warnAmbiguousRefs
4200 </dt>
4201 <dd>
4202 <p>
4203         If true, Git will warn you if the ref name you passed it is ambiguous
4204         and might match multiple refs in the repository. True by default.
4205 </p>
4206 </dd>
4207 <dt class="hdlist1">
4208 core.compression
4209 </dt>
4210 <dd>
4211 <p>
4212         An integer -1..9, indicating a default compression level.
4213         -1 is the zlib default. 0 means no compression,
4214         and 1..9 are various speed/size tradeoffs, 9 being slowest.
4215         If set, this provides a default to other compression variables,
4216         such as <code>core.looseCompression</code> and <code>pack.compression</code>.
4217 </p>
4218 </dd>
4219 <dt class="hdlist1">
4220 core.looseCompression
4221 </dt>
4222 <dd>
4223 <p>
4224         An integer -1..9, indicating the compression level for objects that
4225         are not in a pack file. -1 is the zlib default. 0 means no
4226         compression, and 1..9 are various speed/size tradeoffs, 9 being
4227         slowest.  If not set,  defaults to core.compression.  If that is
4228         not set,  defaults to 1 (best speed).
4229 </p>
4230 </dd>
4231 <dt class="hdlist1">
4232 core.packedGitWindowSize
4233 </dt>
4234 <dd>
4235 <p>
4236         Number of bytes of a pack file to map into memory in a
4237         single mapping operation.  Larger window sizes may allow
4238         your system to process a smaller number of large pack files
4239         more quickly.  Smaller window sizes will negatively affect
4240         performance due to increased calls to the operating system&#8217;s
4241         memory manager, but may improve performance when accessing
4242         a large number of large pack files.
4243 </p>
4244 <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
4245 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
4246 be reasonable for all users/operating systems.  You probably do
4247 not need to adjust this value.</p></div>
4248 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4249 </dd>
4250 <dt class="hdlist1">
4251 core.packedGitLimit
4252 </dt>
4253 <dd>
4254 <p>
4255         Maximum number of bytes to map simultaneously into memory
4256         from pack files.  If Git needs to access more than this many
4257         bytes at once to complete an operation it will unmap existing
4258         regions to reclaim virtual address space within the process.
4259 </p>
4260 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
4261 unlimited) on 64 bit platforms.
4262 This should be reasonable for all users/operating systems, except on
4263 the largest projects.  You probably do not need to adjust this value.</p></div>
4264 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4265 </dd>
4266 <dt class="hdlist1">
4267 core.deltaBaseCacheLimit
4268 </dt>
4269 <dd>
4270 <p>
4271         Maximum number of bytes per thread to reserve for caching base objects
4272         that may be referenced by multiple deltified objects.  By storing the
4273         entire decompressed base objects in a cache Git is able
4274         to avoid unpacking and decompressing frequently used base
4275         objects multiple times.
4276 </p>
4277 <div class="paragraph"><p>Default is 96 MiB on all platforms.  This should be reasonable
4278 for all users/operating systems, except on the largest projects.
4279 You probably do not need to adjust this value.</p></div>
4280 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4281 </dd>
4282 <dt class="hdlist1">
4283 core.bigFileThreshold
4284 </dt>
4285 <dd>
4286 <p>
4287         The size of files considered "big", which as discussed below
4288         changes the behavior of numerous git commands, as well as how
4289         such files are stored within the repository. The default is
4290         512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
4291         supported.
4292 </p>
4293 <div class="paragraph"><p>Files above the configured limit will be:</p></div>
4294 <div class="ulist"><ul>
4295 <li>
4296 <p>
4297 Stored deflated in packfiles, without attempting delta compression.
4298 </p>
4299 <div class="paragraph"><p>The default limit is primarily set with this use-case in mind. With it,
4300 most projects will have their source code and other text files delta
4301 compressed, but not larger binary media files.</p></div>
4302 <div class="paragraph"><p>Storing large files without delta compression avoids excessive memory
4303 usage, at the slight expense of increased disk usage.</p></div>
4304 </li>
4305 <li>
4306 <p>
4307 Will be treated as if they were labeled "binary" (see
4308   <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
4309   <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.
4310 </p>
4311 </li>
4312 <li>
4313 <p>
4314 Will generally be streamed when written, which avoids excessive
4315 memory usage, at the cost of some fixed overhead. Commands that make
4316 use of this include <a href="git-archive.html">git-archive(1)</a>,
4317 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
4318 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.
4319 </p>
4320 </li>
4321 </ul></div>
4322 </dd>
4323 <dt class="hdlist1">
4324 core.excludesFile
4325 </dt>
4326 <dd>
4327 <p>
4328         Specifies the pathname to the file that contains patterns to
4329         describe paths that are not meant to be tracked, in addition
4330         to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
4331         Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
4332         If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
4333         is used instead. See <a href="gitignore.html">gitignore(5)</a>.
4334 </p>
4335 </dd>
4336 <dt class="hdlist1">
4337 core.askPass
4338 </dt>
4339 <dd>
4340 <p>
4341         Some commands (e.g. svn and http interfaces) that interactively
4342         ask for a password can be told to use an external program given
4343         via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
4344         environment variable. If not set, fall back to the value of the
4345         <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
4346         prompt. The external program shall be given a suitable prompt as
4347         command-line argument and write the password on its STDOUT.
4348 </p>
4349 </dd>
4350 <dt class="hdlist1">
4351 core.attributesFile
4352 </dt>
4353 <dd>
4354 <p>
4355         In addition to <code>.gitattributes</code> (per-directory) and
4356         <code>.git/info/attributes</code>, Git looks into this file for attributes
4357         (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
4358         way as for <code>core.excludesFile</code>. Its default value is
4359         <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
4360         set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
4361 </p>
4362 </dd>
4363 <dt class="hdlist1">
4364 core.hooksPath
4365 </dt>
4366 <dd>
4367 <p>
4368         By default Git will look for your hooks in the
4369         <code>$GIT_DIR/hooks</code> directory. Set this to different path,
4370         e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
4371         that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
4372         in <code>$GIT_DIR/hooks/pre-receive</code>.
4373 </p>
4374 <div class="paragraph"><p>The path can be either absolute or relative. A relative path is
4375 taken as relative to the directory where the hooks are run (see
4376 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
4377 <div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
4378 centrally configure your Git hooks instead of configuring them on a
4379 per-repository basis, or as a more flexible and centralized
4380 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
4381 default hooks.</p></div>
4382 </dd>
4383 <dt class="hdlist1">
4384 core.editor
4385 </dt>
4386 <dd>
4387 <p>
4388         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4389         messages by launching an editor use the value of this
4390         variable when it is set, and the environment variable
4391         <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.
4392 </p>
4393 </dd>
4394 <dt class="hdlist1">
4395 core.commentChar
4396 </dt>
4397 <dt class="hdlist1">
4398 core.commentString
4399 </dt>
4400 <dd>
4401 <p>
4402         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4403         messages consider a line that begins with this character
4404         commented, and removes them after the editor returns
4405         (default <em>#</em>).
4406 </p>
4407 <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
4408 the beginning character of any line in existing commit messages.</p></div>
4409 <div class="paragraph"><p>Note that these two variables are aliases of each other, and in modern
4410 versions of Git you are free to use a string (e.g., <code>//</code> or <code>⁑⁕⁑</code>) with
4411 <code>commentChar</code>. Versions of Git prior to v2.45.0 will ignore
4412 <code>commentString</code> but will reject a value of <code>commentChar</code> that consists
4413 of more than a single ASCII byte. If you plan to use your config with
4414 older and newer versions of Git, you may want to specify both:</p></div>
4415 <div class="literalblock">
4416 <div class="content">
4417 <pre><code>[core]
4418 # single character for older versions
4419 commentChar = "#"
4420 # string for newer versions (which will override commentChar
4421 # because it comes later in the file)
4422 commentString = "//"</code></pre>
4423 </div></div>
4424 </dd>
4425 <dt class="hdlist1">
4426 core.filesRefLockTimeout
4427 </dt>
4428 <dd>
4429 <p>
4430         The length of time, in milliseconds, to retry when trying to
4431         lock an individual reference. Value 0 means not to retry at
4432         all; -1 means to try indefinitely. Default is 100 (i.e.,
4433         retry for 100ms).
4434 </p>
4435 </dd>
4436 <dt class="hdlist1">
4437 core.packedRefsTimeout
4438 </dt>
4439 <dd>
4440 <p>
4441         The length of time, in milliseconds, to retry when trying to
4442         lock the <code>packed-refs</code> file. Value 0 means not to retry at
4443         all; -1 means to try indefinitely. Default is 1000 (i.e.,
4444         retry for 1 second).
4445 </p>
4446 </dd>
4447 <dt class="hdlist1">
4448 core.pager
4449 </dt>
4450 <dd>
4451 <p>
4452         Text viewer for use by Git commands (e.g., <em>less</em>).  The value
4453         is meant to be interpreted by the shell.  The order of preference
4454         is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
4455         configuration, then <code>$PAGER</code>, and then the default chosen at
4456         compile time (usually <em>less</em>).
4457 </p>
4458 <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
4459 (if <code>LESS</code> environment variable is set, Git does not change it at
4460 all).  If you want to selectively override Git&#8217;s default setting
4461 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
4462 be passed to the shell by Git, which will translate the final
4463 command to <code>LESS=FRX less -S</code>. The environment does not set the
4464 <code>S</code> option but the command line does, instructing less to truncate
4465 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
4466 deactivate the <code>F</code> option specified by the environment from the
4467 command-line, deactivating the "quit if one screen" behavior of
4468 <code>less</code>.  One can specifically activate some flags for particular
4469 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
4470 line truncation only for <code>git blame</code>.</p></div>
4471 <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
4472 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
4473 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
4474 </dd>
4475 <dt class="hdlist1">
4476 core.whitespace
4477 </dt>
4478 <dd>
4479 <p>
4480         A comma separated list of common whitespace problems to
4481         notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
4482         highlight them, and <em>git apply --whitespace=error</em> will
4483         consider them as errors.  You can prefix <code>-</code> to disable
4484         any of them (e.g. <code>-trailing-space</code>):
4485 </p>
4486 <div class="ulist"><ul>
4487 <li>
4488 <p>
4489 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
4490   as an error (enabled by default).
4491 </p>
4492 </li>
4493 <li>
4494 <p>
4495 <code>space-before-tab</code> treats a space character that appears immediately
4496   before a tab character in the initial indent part of the line as an
4497   error (enabled by default).
4498 </p>
4499 </li>
4500 <li>
4501 <p>
4502 <code>indent-with-non-tab</code> treats a line that is indented with space
4503   characters instead of the equivalent tabs as an error (not enabled by
4504   default).
4505 </p>
4506 </li>
4507 <li>
4508 <p>
4509 <code>tab-in-indent</code> treats a tab character in the initial indent part of
4510   the line as an error (not enabled by default).
4511 </p>
4512 </li>
4513 <li>
4514 <p>
4515 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
4516   (enabled by default).
4517 </p>
4518 </li>
4519 <li>
4520 <p>
4521 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
4522   <code>blank-at-eof</code>.
4523 </p>
4524 </li>
4525 <li>
4526 <p>
4527 <code>cr-at-eol</code> treats a carriage-return at the end of line as
4528   part of the line terminator, i.e. with it, <code>trailing-space</code>
4529   does not trigger if the character before such a carriage-return
4530   is not a whitespace (not enabled by default).
4531 </p>
4532 </li>
4533 <li>
4534 <p>
4535 <code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
4536   is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
4537   errors. The default tab width is 8. Allowed values are 1 to 63.
4538 </p>
4539 </li>
4540 </ul></div>
4541 </dd>
4542 <dt class="hdlist1">
4543 core.fsync
4544 </dt>
4545 <dd>
4546 <p>
4547         A comma-separated list of components of the repository that
4548         should be hardened via the core.fsyncMethod when created or
4549         modified.  You can disable hardening of any component by
4550         prefixing it with a <em>-</em>.  Items that are not hardened may be
4551         lost in the event of an unclean system shutdown. Unless you
4552         have special requirements, it is recommended that you leave
4553         this option empty or pick one of <code>committed</code>, <code>added</code>,
4554         or <code>all</code>.
4555 </p>
4556 <div class="paragraph"><p>When this configuration is encountered, the set of components starts with
4557 the platform default value, disabled components are removed, and additional
4558 components are added. <code>none</code> resets the state so that the platform default
4559 is ignored.</p></div>
4560 <div class="paragraph"><p>The empty string resets the fsync configuration to the platform
4561 default. The default on most platforms is equivalent to
4562 <code>core.fsync=committed,-loose-object</code>, which has good performance,
4563 but risks losing recent work in the event of an unclean system shutdown.</p></div>
4564 <div class="ulist"><ul>
4565 <li>
4566 <p>
4567 <code>none</code> clears the set of fsynced components.
4568 </p>
4569 </li>
4570 <li>
4571 <p>
4572 <code>loose-object</code> hardens objects added to the repo in loose-object form.
4573 </p>
4574 </li>
4575 <li>
4576 <p>
4577 <code>pack</code> hardens objects added to the repo in packfile form.
4578 </p>
4579 </li>
4580 <li>
4581 <p>
4582 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
4583 </p>
4584 </li>
4585 <li>
4586 <p>
4587 <code>commit-graph</code> hardens the commit-graph file.
4588 </p>
4589 </li>
4590 <li>
4591 <p>
4592 <code>index</code> hardens the index when it is modified.
4593 </p>
4594 </li>
4595 <li>
4596 <p>
4597 <code>objects</code> is an aggregate option that is equivalent to
4598   <code>loose-object,pack</code>.
4599 </p>
4600 </li>
4601 <li>
4602 <p>
4603 <code>reference</code> hardens references modified in the repo.
4604 </p>
4605 </li>
4606 <li>
4607 <p>
4608 <code>derived-metadata</code> is an aggregate option that is equivalent to
4609   <code>pack-metadata,commit-graph</code>.
4610 </p>
4611 </li>
4612 <li>
4613 <p>
4614 <code>committed</code> is an aggregate option that is currently equivalent to
4615   <code>objects</code>. This mode sacrifices some performance to ensure that work
4616   that is committed to the repository with <code>git commit</code> or similar commands
4617   is hardened.
4618 </p>
4619 </li>
4620 <li>
4621 <p>
4622 <code>added</code> is an aggregate option that is currently equivalent to
4623   <code>committed,index</code>. This mode sacrifices additional performance to
4624   ensure that the results of commands like <code>git add</code> and similar operations
4625   are hardened.
4626 </p>
4627 </li>
4628 <li>
4629 <p>
4630 <code>all</code> is an aggregate option that syncs all individual components above.
4631 </p>
4632 </li>
4633 </ul></div>
4634 </dd>
4635 <dt class="hdlist1">
4636 core.fsyncMethod
4637 </dt>
4638 <dd>
4639 <p>
4640         A value indicating the strategy Git will use to harden repository data
4641         using fsync and related primitives.
4642 </p>
4643 <div class="ulist"><ul>
4644 <li>
4645 <p>
4646 <code>fsync</code> uses the fsync() system call or platform equivalents.
4647 </p>
4648 </li>
4649 <li>
4650 <p>
4651 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
4652   filesystem and storage hardware, data added to the repository may not be
4653   durable in the event of a system crash. This is the default mode on macOS.
4654 </p>
4655 </li>
4656 <li>
4657 <p>
4658 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
4659   updates in the disk writeback cache and then does a single full fsync of
4660   a dummy file to trigger the disk cache flush at the end of the operation.
4661 </p>
4662 <div class="paragraph"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
4663 data is made durable as if <code>fsync</code> was specified. This mode is expected to
4664 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
4665 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
4666 </li>
4667 </ul></div>
4668 </dd>
4669 <dt class="hdlist1">
4670 core.fsyncObjectFiles
4671 </dt>
4672 <dd>
4673 <p>
4674         This boolean will enable <em>fsync()</em> when writing object files.
4675         This setting is deprecated. Use core.fsync instead.
4676 </p>
4677 <div class="paragraph"><p>This setting affects data added to the Git repository in loose-object
4678 form. When set to true, Git will issue an fsync or similar system call
4679 to flush caches so that loose-objects remain consistent in the face
4680 of a unclean system shutdown.</p></div>
4681 </dd>
4682 <dt class="hdlist1">
4683 core.preloadIndex
4684 </dt>
4685 <dd>
4686 <p>
4687         Enable parallel index preload for operations like <em>git diff</em>
4688 </p>
4689 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
4690 on filesystems like NFS that have weak caching semantics and thus
4691 relatively high IO latencies.  When enabled, Git will do the
4692 index comparison to the filesystem data in parallel, allowing
4693 overlapping IO&#8217;s.  Defaults to true.</p></div>
4694 </dd>
4695 <dt class="hdlist1">
4696 core.unsetenvvars
4697 </dt>
4698 <dd>
4699 <p>
4700         Windows-only: comma-separated list of environment variables'
4701         names that need to be unset before spawning any other process.
4702         Defaults to <code>PERL5LIB</code> to account for the fact that Git for
4703         Windows insists on using its own Perl interpreter.
4704 </p>
4705 </dd>
4706 <dt class="hdlist1">
4707 core.restrictinheritedhandles
4708 </dt>
4709 <dd>
4710 <p>
4711         Windows-only: override whether spawned processes inherit only standard
4712         file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
4713         <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
4714         Windows 7 and later, and <code>false</code> on older Windows versions.
4715 </p>
4716 </dd>
4717 <dt class="hdlist1">
4718 core.createObject
4719 </dt>
4720 <dd>
4721 <p>
4722         You can set this to <em>link</em>, in which case a hardlink followed by
4723         a delete of the source are used to make sure that object creation
4724         will not overwrite existing objects.
4725 </p>
4726 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
4727 Set this config setting to <em>rename</em> there; however, this will remove the
4728 check that makes sure that existing object files will not get overwritten.</p></div>
4729 </dd>
4730 <dt class="hdlist1">
4731 core.notesRef
4732 </dt>
4733 <dd>
4734 <p>
4735         When showing commit messages, also show notes which are stored in
4736         the given ref.  The ref must be fully qualified.  If the given
4737         ref does not exist, it is not an error but means that no
4738         notes should be printed.
4739 </p>
4740 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
4741 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p></div>
4742 </dd>
4743 <dt class="hdlist1">
4744 core.commitGraph
4745 </dt>
4746 <dd>
4747 <p>
4748         If true, then git will read the commit-graph file (if it exists)
4749         to parse the graph structure of commits. Defaults to true. See
4750         <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
4751 </p>
4752 </dd>
4753 <dt class="hdlist1">
4754 core.useReplaceRefs
4755 </dt>
4756 <dd>
4757 <p>
4758         If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
4759         option was given on the command line. See <a href="git.html">git(1)</a> and
4760         <a href="git-replace.html">git-replace(1)</a> for more information.
4761 </p>
4762 </dd>
4763 <dt class="hdlist1">
4764 core.multiPackIndex
4765 </dt>
4766 <dd>
4767 <p>
4768         Use the multi-pack-index file to track multiple packfiles using a
4769         single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
4770         information. Defaults to true.
4771 </p>
4772 </dd>
4773 <dt class="hdlist1">
4774 core.sparseCheckout
4775 </dt>
4776 <dd>
4777 <p>
4778         Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
4779         for more information.
4780 </p>
4781 </dd>
4782 <dt class="hdlist1">
4783 core.sparseCheckoutCone
4784 </dt>
4785 <dd>
4786 <p>
4787         Enables the "cone mode" of the sparse checkout feature. When the
4788         sparse-checkout file contains a limited set of patterns, this
4789         mode provides significant performance advantages. The "non-cone
4790         mode" can be requested to allow specifying more flexible
4791         patterns by setting this variable to <em>false</em>. See
4792         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.
4793 </p>
4794 </dd>
4795 <dt class="hdlist1">
4796 core.abbrev
4797 </dt>
4798 <dd>
4799 <p>
4800         Set the length object names are abbreviated to.  If
4801         unspecified or set to "auto", an appropriate value is
4802         computed based on the approximate number of packed objects
4803         in your repository, which hopefully is enough for
4804         abbreviated object names to stay unique for some time.
4805         If set to "no", no abbreviation is made and the object names
4806         are shown in their full length.
4807         The minimum length is 4.
4808 </p>
4809 </dd>
4810 <dt class="hdlist1">
4811 core.maxTreeDepth
4812 </dt>
4813 <dd>
4814 <p>
4815         The maximum depth Git is willing to recurse while traversing a
4816         tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
4817         to allow Git to abort cleanly, and should not generally need to
4818         be adjusted. The default is 4096.
4819 </p>
4820 </dd>
4821 <dt class="hdlist1">
4822 credential.helper
4823 </dt>
4824 <dd>
4825 <p>
4826         Specify an external helper to be called when a username or
4827         password credential is needed; the helper may consult external
4828         storage to avoid prompting the user for the credentials. This is
4829         normally the name of a credential helper with possible
4830         arguments, but may also be an absolute path with arguments or, if
4831         preceded by <code>!</code>, shell commands.
4832 </p>
4833 <div class="paragraph"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
4834 for details and examples.</p></div>
4835 </dd>
4836 <dt class="hdlist1">
4837 credential.useHttpPath
4838 </dt>
4839 <dd>
4840 <p>
4841         When acquiring credentials, consider the "path" component of an http
4842         or https URL to be important. Defaults to false. See
4843         <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
4844 </p>
4845 </dd>
4846 <dt class="hdlist1">
4847 credential.username
4848 </dt>
4849 <dd>
4850 <p>
4851         If no username is set for a network authentication, use this username
4852         by default. See credential.&lt;context&gt;.* below, and
4853         <a href="gitcredentials.html">gitcredentials(7)</a>.
4854 </p>
4855 </dd>
4856 <dt class="hdlist1">
4857 credential.&lt;url&gt;.*
4858 </dt>
4859 <dd>
4860 <p>
4861         Any of the credential.* options above can be applied selectively to
4862         some credentials. For example, "credential.https://example.com.username"
4863         would set the default username only for https connections to
4864         example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
4865         matched.
4866 </p>
4867 </dd>
4868 <dt class="hdlist1">
4869 credentialCache.ignoreSIGHUP
4870 </dt>
4871 <dd>
4872 <p>
4873         Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
4874 </p>
4875 </dd>
4876 <dt class="hdlist1">
4877 credentialStore.lockTimeoutMS
4878 </dt>
4879 <dd>
4880 <p>
4881         The length of time, in milliseconds, for git-credential-store to retry
4882         when trying to lock the credentials file. A value of 0 means not to retry at
4883         all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
4884         1s).
4885 </p>
4886 </dd>
4887 <dt class="hdlist1">
4888 diff.autoRefreshIndex
4889 </dt>
4890 <dd>
4891 <p>
4892         When using <em>git diff</em> to compare with work tree
4893         files, do not consider stat-only changes as changed.
4894         Instead, silently run <code>git update-index --refresh</code> to
4895         update the cached stat information for paths whose
4896         contents in the work tree match the contents in the
4897         index.  This option defaults to true.  Note that this
4898         affects only <em>git diff</em> Porcelain, and not lower level
4899         <em>diff</em> commands such as <em>git diff-files</em>.
4900 </p>
4901 </dd>
4902 <dt class="hdlist1">
4903 diff.dirstat
4904 </dt>
4905 <dd>
4906 <p>
4907         A comma separated list of <code>--dirstat</code> parameters specifying the
4908         default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
4909         and friends. The defaults can be overridden on the command line
4910         (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
4911         (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
4912         The following parameters are available:
4913 </p>
4914 <div class="openblock">
4915 <div class="content">
4916 <div class="dlist"><dl>
4917 <dt class="hdlist1">
4918 <code>changes</code>
4919 </dt>
4920 <dd>
4921 <p>
4922         Compute the dirstat numbers by counting the lines that have been
4923         removed from the source, or added to the destination. This ignores
4924         the amount of pure code movements within a file.  In other words,
4925         rearranging lines in a file is not counted as much as other changes.
4926         This is the default behavior when no parameter is given.
4927 </p>
4928 </dd>
4929 <dt class="hdlist1">
4930 <code>lines</code>
4931 </dt>
4932 <dd>
4933 <p>
4934         Compute the dirstat numbers by doing the regular line-based diff
4935         analysis, and summing the removed/added line counts. (For binary
4936         files, count 64-byte chunks instead, since binary files have no
4937         natural concept of lines). This is a more expensive <code>--dirstat</code>
4938         behavior than the <code>changes</code> behavior, but it does count rearranged
4939         lines within a file as much as other changes. The resulting output
4940         is consistent with what you get from the other <code>--*stat</code> options.
4941 </p>
4942 </dd>
4943 <dt class="hdlist1">
4944 <code>files</code>
4945 </dt>
4946 <dd>
4947 <p>
4948         Compute the dirstat numbers by counting the number of files changed.
4949         Each changed file counts equally in the dirstat analysis. This is
4950         the computationally cheapest <code>--dirstat</code> behavior, since it does
4951         not have to look at the file contents at all.
4952 </p>
4953 </dd>
4954 <dt class="hdlist1">
4955 <code>cumulative</code>
4956 </dt>
4957 <dd>
4958 <p>
4959         Count changes in a child directory for the parent directory as well.
4960         Note that when using <code>cumulative</code>, the sum of the percentages
4961         reported may exceed 100%. The default (non-cumulative) behavior can
4962         be specified with the <code>noncumulative</code> parameter.
4963 </p>
4964 </dd>
4965 <dt class="hdlist1">
4966 &lt;limit&gt;
4967 </dt>
4968 <dd>
4969 <p>
4970         An integer parameter specifies a cut-off percent (3% by default).
4971         Directories contributing less than this percentage of the changes
4972         are not shown in the output.
4973 </p>
4974 </dd>
4975 </dl></div>
4976 </div></div>
4977 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
4978 directories with less than 10% of the total amount of changed files,
4979 and accumulating child directory counts in the parent directories:
4980 <code>files,10,cumulative</code>.</p></div>
4981 </dd>
4982 <dt class="hdlist1">
4983 diff.statNameWidth
4984 </dt>
4985 <dd>
4986 <p>
4987         Limit the width of the filename part in --stat output. If set, applies
4988         to all commands generating --stat output except format-patch.
4989 </p>
4990 </dd>
4991 <dt class="hdlist1">
4992 diff.statGraphWidth
4993 </dt>
4994 <dd>
4995 <p>
4996         Limit the width of the graph part in --stat output. If set, applies
4997         to all commands generating --stat output except format-patch.
4998 </p>
4999 </dd>
5000 <dt class="hdlist1">
5001 diff.context
5002 </dt>
5003 <dd>
5004 <p>
5005         Generate diffs with &lt;n&gt; lines of context instead of the default
5006         of 3. This value is overridden by the -U option.
5007 </p>
5008 </dd>
5009 <dt class="hdlist1">
5010 diff.interHunkContext
5011 </dt>
5012 <dd>
5013 <p>
5014         Show the context between diff hunks, up to the specified number
5015         of lines, thereby fusing the hunks that are close to each other.
5016         This value serves as the default for the <code>--inter-hunk-context</code>
5017         command line option.
5018 </p>
5019 </dd>
5020 <dt class="hdlist1">
5021 diff.external
5022 </dt>
5023 <dd>
5024 <p>
5025         If this config variable is set, diff generation is not
5026         performed using the internal diff machinery, but using the
5027         given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
5028         environment variable.  The command is called with parameters
5029         as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
5030         you want to use an external diff program only on a subset of
5031         your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
5032 </p>
5033 </dd>
5034 <dt class="hdlist1">
5035 diff.ignoreSubmodules
5036 </dt>
5037 <dd>
5038 <p>
5039         Sets the default value of --ignore-submodules. Note that this
5040         affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
5041         commands such as <em>git diff-files</em>. <em>git checkout</em>
5042         and <em>git switch</em> also honor
5043         this setting when reporting uncommitted changes. Setting it to
5044         <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
5045         and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
5046         overridden by using the --ignore-submodules command-line option.
5047         The <em>git submodule</em> commands are not affected by this setting.
5048         By default this is set to untracked so that any untracked
5049         submodules are ignored.
5050 </p>
5051 </dd>
5052 <dt class="hdlist1">
5053 diff.mnemonicPrefix
5054 </dt>
5055 <dd>
5056 <p>
5057         If set, <em>git diff</em> uses a prefix pair that is different from the
5058         standard "a/" and "b/" depending on what is being compared.  When
5059         this configuration is in effect, reverse diff output also swaps
5060         the order of the prefixes:
5061 </p>
5062 <div class="dlist"><dl>
5063 <dt class="hdlist1">
5064 <code>git diff</code>
5065 </dt>
5066 <dd>
5067 <p>
5068         compares the (i)ndex and the (w)ork tree;
5069 </p>
5070 </dd>
5071 <dt class="hdlist1">
5072 <code>git diff HEAD</code>
5073 </dt>
5074 <dd>
5075 <p>
5076          compares a (c)ommit and the (w)ork tree;
5077 </p>
5078 </dd>
5079 <dt class="hdlist1">
5080 <code>git diff --cached</code>
5081 </dt>
5082 <dd>
5083 <p>
5084         compares a (c)ommit and the (i)ndex;
5085 </p>
5086 </dd>
5087 <dt class="hdlist1">
5088 <code>git diff HEAD:file1 file2</code>
5089 </dt>
5090 <dd>
5091 <p>
5092         compares an (o)bject and a (w)ork tree entity;
5093 </p>
5094 </dd>
5095 <dt class="hdlist1">
5096 <code>git diff --no-index a b</code>
5097 </dt>
5098 <dd>
5099 <p>
5100         compares two non-git things (1) and (2).
5101 </p>
5102 </dd>
5103 </dl></div>
5104 </dd>
5105 <dt class="hdlist1">
5106 diff.noPrefix
5107 </dt>
5108 <dd>
5109 <p>
5110         If set, <em>git diff</em> does not show any source or destination prefix.
5111 </p>
5112 </dd>
5113 <dt class="hdlist1">
5114 diff.srcPrefix
5115 </dt>
5116 <dd>
5117 <p>
5118         If set, <em>git diff</em> uses this source prefix. Defaults to "a/".
5119 </p>
5120 </dd>
5121 <dt class="hdlist1">
5122 diff.dstPrefix
5123 </dt>
5124 <dd>
5125 <p>
5126         If set, <em>git diff</em> uses this destination prefix. Defaults to "b/".
5127 </p>
5128 </dd>
5129 <dt class="hdlist1">
5130 diff.relative
5131 </dt>
5132 <dd>
5133 <p>
5134         If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
5135         and show pathnames relative to the current directory.
5136 </p>
5137 </dd>
5138 <dt class="hdlist1">
5139 diff.orderFile
5140 </dt>
5141 <dd>
5142 <p>
5143         File indicating how to order files within a diff.
5144         See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
5145         If <code>diff.orderFile</code> is a relative pathname, it is treated as
5146         relative to the top of the working tree.
5147 </p>
5148 </dd>
5149 <dt class="hdlist1">
5150 diff.renameLimit
5151 </dt>
5152 <dd>
5153 <p>
5154         The number of files to consider in the exhaustive portion of
5155         copy/rename detection; equivalent to the <em>git diff</em> option
5156         <code>-l</code>.  If not set, the default value is currently 1000.  This
5157         setting has no effect if rename detection is turned off.
5158 </p>
5159 </dd>
5160 <dt class="hdlist1">
5161 diff.renames
5162 </dt>
5163 <dd>
5164 <p>
5165         Whether and how Git detects renames.  If set to "false",
5166         rename detection is disabled. If set to "true", basic rename
5167         detection is enabled.  If set to "copies" or "copy", Git will
5168         detect copies, as well.  Defaults to true.  Note that this
5169         affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
5170         <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
5171         <a href="git-diff-files.html">git-diff-files(1)</a>.
5172 </p>
5173 </dd>
5174 <dt class="hdlist1">
5175 diff.suppressBlankEmpty
5176 </dt>
5177 <dd>
5178 <p>
5179         A boolean to inhibit the standard behavior of printing a space
5180         before each empty output line. Defaults to false.
5181 </p>
5182 </dd>
5183 <dt class="hdlist1">
5184 diff.submodule
5185 </dt>
5186 <dd>
5187 <p>
5188         Specify the format in which differences in submodules are
5189         shown.  The "short" format just shows the names of the commits
5190         at the beginning and end of the range. The "log" format lists
5191         the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
5192         does. The "diff" format shows an inline diff of the changed
5193         contents of the submodule. Defaults to "short".
5194 </p>
5195 </dd>
5196 <dt class="hdlist1">
5197 diff.wordRegex
5198 </dt>
5199 <dd>
5200 <p>
5201         A POSIX Extended Regular Expression used to determine what is a "word"
5202         when performing word-by-word difference calculations.  Character
5203         sequences that match the regular expression are "words", all other
5204         characters are <strong>ignorable</strong> whitespace.
5205 </p>
5206 </dd>
5207 <dt class="hdlist1">
5208 diff.&lt;driver&gt;.command
5209 </dt>
5210 <dd>
5211 <p>
5212         The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
5213         for details.
5214 </p>
5215 </dd>
5216 <dt class="hdlist1">
5217 diff.&lt;driver&gt;.xfuncname
5218 </dt>
5219 <dd>
5220 <p>
5221         The regular expression that the diff driver should use to
5222         recognize the hunk header.  A built-in pattern may also be used.
5223         See <a href="gitattributes.html">gitattributes(5)</a> for details.
5224 </p>
5225 </dd>
5226 <dt class="hdlist1">
5227 diff.&lt;driver&gt;.binary
5228 </dt>
5229 <dd>
5230 <p>
5231         Set this option to true to make the diff driver treat files as
5232         binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5233 </p>
5234 </dd>
5235 <dt class="hdlist1">
5236 diff.&lt;driver&gt;.textconv
5237 </dt>
5238 <dd>
5239 <p>
5240         The command that the diff driver should call to generate the
5241         text-converted version of a file.  The result of the
5242         conversion is used to generate a human-readable diff.  See
5243         <a href="gitattributes.html">gitattributes(5)</a> for details.
5244 </p>
5245 </dd>
5246 <dt class="hdlist1">
5247 diff.&lt;driver&gt;.wordRegex
5248 </dt>
5249 <dd>
5250 <p>
5251         The regular expression that the diff driver should use to
5252         split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
5253         details.
5254 </p>
5255 </dd>
5256 <dt class="hdlist1">
5257 diff.&lt;driver&gt;.cachetextconv
5258 </dt>
5259 <dd>
5260 <p>
5261         Set this option to true to make the diff driver cache the text
5262         conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5263 </p>
5264 <div class="dlist"><dl>
5265 <dt class="hdlist1">
5266 <code>araxis</code>
5267 </dt>
5268 <dd>
5269 <p>
5270 Use Araxis Merge (requires a graphical session)
5271 </p>
5272 </dd>
5273 <dt class="hdlist1">
5274 <code>bc</code>
5275 </dt>
5276 <dd>
5277 <p>
5278 Use Beyond Compare (requires a graphical session)
5279 </p>
5280 </dd>
5281 <dt class="hdlist1">
5282 <code>bc3</code>
5283 </dt>
5284 <dd>
5285 <p>
5286 Use Beyond Compare (requires a graphical session)
5287 </p>
5288 </dd>
5289 <dt class="hdlist1">
5290 <code>bc4</code>
5291 </dt>
5292 <dd>
5293 <p>
5294 Use Beyond Compare (requires a graphical session)
5295 </p>
5296 </dd>
5297 <dt class="hdlist1">
5298 <code>codecompare</code>
5299 </dt>
5300 <dd>
5301 <p>
5302 Use Code Compare (requires a graphical session)
5303 </p>
5304 </dd>
5305 <dt class="hdlist1">
5306 <code>deltawalker</code>
5307 </dt>
5308 <dd>
5309 <p>
5310 Use DeltaWalker (requires a graphical session)
5311 </p>
5312 </dd>
5313 <dt class="hdlist1">
5314 <code>diffmerge</code>
5315 </dt>
5316 <dd>
5317 <p>
5318 Use DiffMerge (requires a graphical session)
5319 </p>
5320 </dd>
5321 <dt class="hdlist1">
5322 <code>diffuse</code>
5323 </dt>
5324 <dd>
5325 <p>
5326 Use Diffuse (requires a graphical session)
5327 </p>
5328 </dd>
5329 <dt class="hdlist1">
5330 <code>ecmerge</code>
5331 </dt>
5332 <dd>
5333 <p>
5334 Use ECMerge (requires a graphical session)
5335 </p>
5336 </dd>
5337 <dt class="hdlist1">
5338 <code>emerge</code>
5339 </dt>
5340 <dd>
5341 <p>
5342 Use Emacs' Emerge
5343 </p>
5344 </dd>
5345 <dt class="hdlist1">
5346 <code>examdiff</code>
5347 </dt>
5348 <dd>
5349 <p>
5350 Use ExamDiff Pro (requires a graphical session)
5351 </p>
5352 </dd>
5353 <dt class="hdlist1">
5354 <code>guiffy</code>
5355 </dt>
5356 <dd>
5357 <p>
5358 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
5359 </p>
5360 </dd>
5361 <dt class="hdlist1">
5362 <code>gvimdiff</code>
5363 </dt>
5364 <dd>
5365 <p>
5366 Use gVim (requires a graphical session)
5367 </p>
5368 </dd>
5369 <dt class="hdlist1">
5370 <code>kdiff3</code>
5371 </dt>
5372 <dd>
5373 <p>
5374 Use KDiff3 (requires a graphical session)
5375 </p>
5376 </dd>
5377 <dt class="hdlist1">
5378 <code>kompare</code>
5379 </dt>
5380 <dd>
5381 <p>
5382 Use Kompare (requires a graphical session)
5383 </p>
5384 </dd>
5385 <dt class="hdlist1">
5386 <code>meld</code>
5387 </dt>
5388 <dd>
5389 <p>
5390 Use Meld (requires a graphical session)
5391 </p>
5392 </dd>
5393 <dt class="hdlist1">
5394 <code>nvimdiff</code>
5395 </dt>
5396 <dd>
5397 <p>
5398 Use Neovim
5399 </p>
5400 </dd>
5401 <dt class="hdlist1">
5402 <code>opendiff</code>
5403 </dt>
5404 <dd>
5405 <p>
5406 Use FileMerge (requires a graphical session)
5407 </p>
5408 </dd>
5409 <dt class="hdlist1">
5410 <code>p4merge</code>
5411 </dt>
5412 <dd>
5413 <p>
5414 Use HelixCore P4Merge (requires a graphical session)
5415 </p>
5416 </dd>
5417 <dt class="hdlist1">
5418 <code>smerge</code>
5419 </dt>
5420 <dd>
5421 <p>
5422 Use Sublime Merge (requires a graphical session)
5423 </p>
5424 </dd>
5425 <dt class="hdlist1">
5426 <code>tkdiff</code>
5427 </dt>
5428 <dd>
5429 <p>
5430 Use TkDiff (requires a graphical session)
5431 </p>
5432 </dd>
5433 <dt class="hdlist1">
5434 <code>vimdiff</code>
5435 </dt>
5436 <dd>
5437 <p>
5438 Use Vim
5439 </p>
5440 </dd>
5441 <dt class="hdlist1">
5442 <code>winmerge</code>
5443 </dt>
5444 <dd>
5445 <p>
5446 Use WinMerge (requires a graphical session)
5447 </p>
5448 </dd>
5449 <dt class="hdlist1">
5450 <code>xxdiff</code>
5451 </dt>
5452 <dd>
5453 <p>
5454 Use xxdiff (requires a graphical session)
5455 </p>
5456 </dd>
5457 </dl></div>
5458 </dd>
5459 <dt class="hdlist1">
5460 diff.indentHeuristic
5461 </dt>
5462 <dd>
5463 <p>
5464         Set this option to <code>false</code> to disable the default heuristics
5465         that shift diff hunk boundaries to make patches easier to read.
5466 </p>
5467 </dd>
5468 <dt class="hdlist1">
5469 diff.algorithm
5470 </dt>
5471 <dd>
5472 <p>
5473         Choose a diff algorithm.  The variants are as follows:
5474 </p>
5475 <div class="openblock">
5476 <div class="content">
5477 <div class="dlist"><dl>
5478 <dt class="hdlist1">
5479 <code>default</code>, <code>myers</code>
5480 </dt>
5481 <dd>
5482 <p>
5483         The basic greedy diff algorithm. Currently, this is the default.
5484 </p>
5485 </dd>
5486 <dt class="hdlist1">
5487 <code>minimal</code>
5488 </dt>
5489 <dd>
5490 <p>
5491         Spend extra time to make sure the smallest possible diff is
5492         produced.
5493 </p>
5494 </dd>
5495 <dt class="hdlist1">
5496 <code>patience</code>
5497 </dt>
5498 <dd>
5499 <p>
5500         Use "patience diff" algorithm when generating patches.
5501 </p>
5502 </dd>
5503 <dt class="hdlist1">
5504 <code>histogram</code>
5505 </dt>
5506 <dd>
5507 <p>
5508         This algorithm extends the patience algorithm to "support
5509         low-occurrence common elements".
5510 </p>
5511 </dd>
5512 </dl></div>
5513 </div></div>
5514 </dd>
5515 <dt class="hdlist1">
5516 diff.wsErrorHighlight
5517 </dt>
5518 <dd>
5519 <p>
5520         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5521         lines of the diff.  Multiple values are separated by comma,
5522         <code>none</code> resets previous values, <code>default</code> reset the list to
5523         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
5524         whitespace errors are colored with <code>color.diff.whitespace</code>.
5525         The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
5526         overrides this setting.
5527 </p>
5528 </dd>
5529 <dt class="hdlist1">
5530 diff.colorMoved
5531 </dt>
5532 <dd>
5533 <p>
5534         If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
5535         in a diff are colored differently, for details of valid modes
5536         see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
5537         true the default color mode will be used. When set to false,
5538         moved lines are not colored.
5539 </p>
5540 </dd>
5541 <dt class="hdlist1">
5542 diff.colorMovedWS
5543 </dt>
5544 <dd>
5545 <p>
5546         When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5547         this option controls the <code>&lt;mode&gt;</code> how spaces are treated.
5548         For details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.
5549 </p>
5550 </dd>
5551 <dt class="hdlist1">
5552 diff.tool
5553 </dt>
5554 <dd>
5555 <p>
5556         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
5557         This variable overrides the value configured in <code>merge.tool</code>.
5558         The list below shows the valid built-in values.
5559         Any other value is treated as a custom diff tool and requires
5560         that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
5561 </p>
5562 </dd>
5563 <dt class="hdlist1">
5564 diff.guitool
5565 </dt>
5566 <dd>
5567 <p>
5568         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
5569         the -g/--gui flag is specified. This variable overrides the value
5570         configured in <code>merge.guitool</code>. The list below shows the valid
5571         built-in values. Any other value is treated as a custom diff tool
5572         and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
5573         is defined.
5574 </p>
5575 </dd>
5576 <dt class="hdlist1">
5577 difftool.&lt;tool&gt;.cmd
5578 </dt>
5579 <dd>
5580 <p>
5581         Specify the command to invoke the specified diff tool.
5582         The specified command is evaluated in shell with the following
5583         variables available:  <em>LOCAL</em> is set to the name of the temporary
5584         file containing the contents of the diff pre-image and <em>REMOTE</em>
5585         is set to the name of the temporary file containing the contents
5586         of the diff post-image.
5587 </p>
5588 <div class="paragraph"><p>See the <code>--tool=&lt;tool&gt;</code> option in <a href="git-difftool.html">git-difftool(1)</a> for more details.</p></div>
5589 </dd>
5590 <dt class="hdlist1">
5591 difftool.&lt;tool&gt;.path
5592 </dt>
5593 <dd>
5594 <p>
5595         Override the path for the given tool.  This is useful in case
5596         your tool is not in the PATH.
5597 </p>
5598 </dd>
5599 <dt class="hdlist1">
5600 difftool.trustExitCode
5601 </dt>
5602 <dd>
5603 <p>
5604         Exit difftool if the invoked diff tool returns a non-zero exit status.
5605 </p>
5606 <div class="paragraph"><p>See the <code>--trust-exit-code</code> option in <a href="git-difftool.html">git-difftool(1)</a> for more details.</p></div>
5607 </dd>
5608 <dt class="hdlist1">
5609 difftool.prompt
5610 </dt>
5611 <dd>
5612 <p>
5613         Prompt before each invocation of the diff tool.
5614 </p>
5615 </dd>
5616 <dt class="hdlist1">
5617 difftool.guiDefault
5618 </dt>
5619 <dd>
5620 <p>
5621         Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5622         the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5623         depending on the presence of a <code>DISPLAY</code> environment variable value. The
5624         default is <code>false</code>, where the <code>--gui</code> argument must be provided
5625         explicitly for the <code>diff.guitool</code> to be used.
5626 </p>
5627 </dd>
5628 <dt class="hdlist1">
5629 extensions.objectFormat
5630 </dt>
5631 <dd>
5632 <p>
5633         Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
5634         <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
5635         this key unless <code>core.repositoryFormatVersion</code> is 1.
5636 </p>
5637 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5638 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
5639 work and will produce hard-to-diagnose issues.</p></div>
5640 </dd>
5641 <dt class="hdlist1">
5642 extensions.compatObjectFormat
5643 </dt>
5644 <dd>
5645 <p>
5646         Specify a compatitbility hash algorithm to use.  The acceptable values
5647         are <code>sha1</code> and <code>sha256</code>.  The value specified must be different from the
5648         value of extensions.objectFormat.  This allows client level
5649         interoperability between git repositories whose objectFormat matches
5650         this compatObjectFormat.  In particular when fully implemented the
5651         pushes and pulls from a repository in whose objectFormat matches
5652         compatObjectFormat.  As well as being able to use oids encoded in
5653         compatObjectFormat in addition to oids encoded with objectFormat to
5654         locally specify objects.
5655 </p>
5656 </dd>
5657 <dt class="hdlist1">
5658 extensions.refStorage
5659 </dt>
5660 <dd>
5661 <p>
5662         Specify the ref storage format to use. The acceptable values are:
5663 </p>
5664 <div class="ulist"><ul>
5665 <li>
5666 <p>
5667 <code>files</code> for loose files with packed-refs. This is the default.
5668 </p>
5669 </li>
5670 <li>
5671 <p>
5672 <code>reftable</code> for the reftable format. This format is experimental and its
5673   internals are subject to change.
5674 </p>
5675 <div class="paragraph"><p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p></div>
5676 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5677 <a href="git-clone.html">git-clone(1)</a>. Trying to change it after initialization will not
5678 work and will produce hard-to-diagnose issues.</p></div>
5679 </li>
5680 </ul></div>
5681 </dd>
5682 <dt class="hdlist1">
5683 extensions.worktreeConfig
5684 </dt>
5685 <dd>
5686 <p>
5687         If enabled, then worktrees will load config settings from the
5688         <code>$GIT_DIR/config.worktree</code> file in addition to the
5689         <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5690         <code>$GIT_DIR</code> are the same for the main working tree, while other
5691         working trees have <code>$GIT_DIR</code> equal to
5692         <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
5693         <code>config.worktree</code> file will override settings from any other
5694         config files.
5695 </p>
5696 <div class="paragraph"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5697 certain values from the common config file to the main working tree&#8217;s
5698 <code>config.worktree</code> file, if present:</p></div>
5699 <div class="ulist"><ul>
5700 <li>
5701 <p>
5702 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5703   <code>$GIT_COMMON_DIR/config.worktree</code>.
5704 </p>
5705 </li>
5706 <li>
5707 <p>
5708 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5709   to <code>$GIT_COMMON_DIR/config.worktree</code>.
5710 </p>
5711 <div class="paragraph"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5712 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5713 sparse-checkout settings for each worktree. By default, the <code>git
5714 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5715 these config values on a per-worktree basis, and uses the
5716 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5717 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
5718 details.</p></div>
5719 <div class="paragraph"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5720 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5721 </li>
5722 </ul></div>
5723 </dd>
5724 <dt class="hdlist1">
5725 fastimport.unpackLimit
5726 </dt>
5727 <dd>
5728 <p>
5729         If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
5730         is below this limit, then the objects will be unpacked into
5731         loose object files.  However, if the number of imported objects
5732         equals or exceeds this limit, then the pack will be stored as a
5733         pack.  Storing the pack from a fast-import can make the import
5734         operation complete faster, especially on slow filesystems.  If
5735         not set, the value of <code>transfer.unpackLimit</code> is used instead.
5736 </p>
5737 </dd>
5738 <dt class="hdlist1">
5739 feature.*
5740 </dt>
5741 <dd>
5742 <p>
5743         The config settings that start with <code>feature.</code> modify the defaults of
5744         a group of other config settings. These groups are created by the Git
5745         developer community as recommended defaults and are subject to change.
5746         In particular, new config options may be added with different defaults.
5747 </p>
5748 </dd>
5749 <dt class="hdlist1">
5750 feature.experimental
5751 </dt>
5752 <dd>
5753 <p>
5754         Enable config options that are new to Git, and are being considered for
5755         future defaults. Config settings included here may be added or removed
5756         with each release, including minor version updates. These settings may
5757         have unintended interactions since they are so new. Please enable this
5758         setting if you are interested in providing feedback on experimental
5759         features. The new default values are:
5760 </p>
5761 <div class="ulist"><ul>
5762 <li>
5763 <p>
5764 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5765 skipping more commits at a time, reducing the number of round trips.
5766 </p>
5767 </li>
5768 <li>
5769 <p>
5770 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5771 walking fewer objects.
5772 </p>
5773 </li>
5774 <li>
5775 <p>
5776 <code>pack.allowPackReuse=multi</code> may improve the time it takes to create a pack by
5777 reusing objects from multiple packs instead of just one.
5778 </p>
5779 </li>
5780 </ul></div>
5781 </dd>
5782 <dt class="hdlist1">
5783 feature.manyFiles
5784 </dt>
5785 <dd>
5786 <p>
5787         Enable config options that optimize for repos with many files in the
5788         working directory. With many files, commands such as <code>git status</code> and
5789         <code>git checkout</code> may be slow and these new defaults improve performance:
5790 </p>
5791 <div class="ulist"><ul>
5792 <li>
5793 <p>
5794 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5795   checksum. Note that this will cause Git versions earlier than 2.13.0 to
5796   refuse to parse the index and Git versions earlier than 2.40.0 will report
5797   a corrupted index during <code>git fsck</code>.
5798 </p>
5799 </li>
5800 <li>
5801 <p>
5802 <code>index.version=4</code> enables path-prefix compression in the index.
5803 </p>
5804 </li>
5805 <li>
5806 <p>
5807 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5808 that mtime is working on your machine.
5809 </p>
5810 </li>
5811 </ul></div>
5812 </dd>
5813 <dt class="hdlist1">
5814 fetch.recurseSubmodules
5815 </dt>
5816 <dd>
5817 <p>
5818         This option controls whether <code>git fetch</code> (and the underlying fetch
5819         in <code>git pull</code>) will recursively fetch into populated submodules.
5820         This option can be set either to a boolean value or to <em>on-demand</em>.
5821         Setting it to a boolean changes the behavior of fetch and pull to
5822         recurse unconditionally into submodules when set to true or to not
5823         recurse at all when set to false. When set to <em>on-demand</em>, fetch and
5824         pull will only recurse into a populated submodule when its
5825         superproject retrieves a commit that updates the submodule&#8217;s
5826         reference.
5827         Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
5828 </p>
5829 </dd>
5830 <dt class="hdlist1">
5831 fetch.fsckObjects
5832 </dt>
5833 <dd>
5834 <p>
5835         If it is set to true, git-fetch-pack will check all fetched
5836         objects. See <code>transfer.fsckObjects</code> for what&#8217;s
5837         checked. Defaults to false. If not set, the value of
5838         <code>transfer.fsckObjects</code> is used instead.
5839 </p>
5840 </dd>
5841 <dt class="hdlist1">
5842 fetch.fsck.&lt;msg-id&gt;
5843 </dt>
5844 <dd>
5845 <p>
5846         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
5847         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5848         the <code>fsck.&lt;msg-id&gt;</code> documentation for details.
5849 </p>
5850 </dd>
5851 <dt class="hdlist1">
5852 fetch.fsck.skipList
5853 </dt>
5854 <dd>
5855 <p>
5856         Acts like <code>fsck.skipList</code>, but is used by
5857         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5858         the <code>fsck.skipList</code> documentation for details.
5859 </p>
5860 </dd>
5861 <dt class="hdlist1">
5862 fetch.unpackLimit
5863 </dt>
5864 <dd>
5865 <p>
5866         If the number of objects fetched over the Git native
5867         transfer is below this
5868         limit, then the objects will be unpacked into loose object
5869         files. However if the number of received objects equals or
5870         exceeds this limit then the received pack will be stored as
5871         a pack, after adding any missing delta bases.  Storing the
5872         pack from a push can make the push operation complete faster,
5873         especially on slow filesystems.  If not set, the value of
5874         <code>transfer.unpackLimit</code> is used instead.
5875 </p>
5876 </dd>
5877 <dt class="hdlist1">
5878 fetch.prune
5879 </dt>
5880 <dd>
5881 <p>
5882         If true, fetch will automatically behave as if the <code>--prune</code>
5883         option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
5884         and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.
5885 </p>
5886 </dd>
5887 <dt class="hdlist1">
5888 fetch.pruneTags
5889 </dt>
5890 <dd>
5891 <p>
5892         If true, fetch will automatically behave as if the
5893         <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
5894         if not set already. This allows for setting both this option
5895         and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
5896         refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
5897         section of <a href="git-fetch.html">git-fetch(1)</a>.
5898 </p>
5899 </dd>
5900 <dt class="hdlist1">
5901 fetch.all
5902 </dt>
5903 <dd>
5904 <p>
5905         If true, fetch will attempt to update all available remotes.
5906         This behavior can be overridden by passing <code>--no-all</code> or by
5907         explicitly specifying one or more remote(s) to fetch from.
5908         Defaults to false.
5909 </p>
5910 </dd>
5911 <dt class="hdlist1">
5912 fetch.output
5913 </dt>
5914 <dd>
5915 <p>
5916         Control how ref update status is printed. Valid values are
5917         <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
5918         OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.
5919 </p>
5920 </dd>
5921 <dt class="hdlist1">
5922 fetch.negotiationAlgorithm
5923 </dt>
5924 <dd>
5925 <p>
5926         Control how information about the commits in the local repository
5927         is sent when negotiating the contents of the packfile to be sent by
5928         the server.  Set to "consecutive" to use an algorithm that walks
5929         over consecutive commits checking each one.  Set to "skipping" to
5930         use an algorithm that skips commits in an effort to converge
5931         faster, but may result in a larger-than-necessary packfile; or set
5932         to "noop" to not send any information at all, which will almost
5933         certainly result in a larger-than-necessary packfile, but will skip
5934         the negotiation step.  Set to "default" to override settings made
5935         previously and use the default behaviour.  The default is normally
5936         "consecutive", but if <code>feature.experimental</code> is true, then the
5937         default is "skipping".  Unknown values will cause <em>git fetch</em> to
5938         error out.
5939 </p>
5940 <div class="paragraph"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
5941 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
5942 </dd>
5943 <dt class="hdlist1">
5944 fetch.showForcedUpdates
5945 </dt>
5946 <dd>
5947 <p>
5948         Set to false to enable <code>--no-show-forced-updates</code> in
5949         <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
5950         Defaults to true.
5951 </p>
5952 </dd>
5953 <dt class="hdlist1">
5954 fetch.parallel
5955 </dt>
5956 <dd>
5957 <p>
5958         Specifies the maximal number of fetch operations to be run in parallel
5959         at a time (submodules, or remotes when the <code>--multiple</code> option of
5960         <a href="git-fetch.html">git-fetch(1)</a> is in effect).
5961 </p>
5962 <div class="paragraph"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
5963 <div class="paragraph"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
5964 config setting.</p></div>
5965 </dd>
5966 <dt class="hdlist1">
5967 fetch.writeCommitGraph
5968 </dt>
5969 <dd>
5970 <p>
5971         Set to true to write a commit-graph after every <code>git fetch</code> command
5972         that downloads a pack-file from a remote. Using the <code>--split</code> option,
5973         most executions will create a very small commit-graph file on top of
5974         the existing commit-graph file(s). Occasionally, these files will
5975         merge and the write may take longer. Having an updated commit-graph
5976         file helps performance of many Git commands, including <code>git merge-base</code>,
5977         <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
5978 </p>
5979 </dd>
5980 <dt class="hdlist1">
5981 fetch.bundleURI
5982 </dt>
5983 <dd>
5984 <p>
5985         This value stores a URI for downloading Git object data from a bundle
5986         URI before performing an incremental fetch from the origin Git server.
5987         This is similar to how the <code>--bundle-uri</code> option behaves in
5988         <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
5989         <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
5990         list that is organized for incremental fetches.
5991 </p>
5992 <div class="paragraph"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
5993 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
5994 the new bundle URI.</p></div>
5995 </dd>
5996 <dt class="hdlist1">
5997 fetch.bundleCreationToken
5998 </dt>
5999 <dd>
6000 <p>
6001         When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
6002         list that uses the "creationToken" heuristic, this config value
6003         stores the maximum <code>creationToken</code> value of the downloaded bundles.
6004         This value is used to prevent downloading bundles in the future
6005         if the advertised <code>creationToken</code> is not strictly larger than this
6006         value.
6007 </p>
6008 <div class="paragraph"><p>The creation token values are chosen by the provider serving the specific
6009 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
6010 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
6011 </dd>
6012 <dt class="hdlist1">
6013 filter.&lt;driver&gt;.clean
6014 </dt>
6015 <dd>
6016 <p>
6017         The command which is used to convert the content of a worktree
6018         file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
6019         details.
6020 </p>
6021 </dd>
6022 <dt class="hdlist1">
6023 filter.&lt;driver&gt;.smudge
6024 </dt>
6025 <dd>
6026 <p>
6027         The command which is used to convert the content of a blob
6028         object to a worktree file upon checkout.  See
6029         <a href="gitattributes.html">gitattributes(5)</a> for details.
6030 </p>
6031 </dd>
6032 <dt class="hdlist1">
6033 format.attach
6034 </dt>
6035 <dd>
6036 <p>
6037         Enable multipart/mixed attachments as the default for
6038         <em>format-patch</em>.  The value can also be a double quoted string
6039         which will enable attachments as the default and set the
6040         value as the boundary.  See the --attach option in
6041         <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
6042         value, set it to an empty string.
6043 </p>
6044 </dd>
6045 <dt class="hdlist1">
6046 format.from
6047 </dt>
6048 <dd>
6049 <p>
6050         Provides the default value for the <code>--from</code> option to format-patch.
6051         Accepts a boolean value, or a name and email address.  If false,
6052         format-patch defaults to <code>--no-from</code>, using commit authors directly in
6053         the "From:" field of patch mails.  If true, format-patch defaults to
6054         <code>--from</code>, using your committer identity in the "From:" field of patch
6055         mails and including a "From:" field in the body of the patch mail if
6056         different.  If set to a non-boolean value, format-patch uses that
6057         value instead of your committer identity.  Defaults to false.
6058 </p>
6059 </dd>
6060 <dt class="hdlist1">
6061 format.forceInBodyFrom
6062 </dt>
6063 <dd>
6064 <p>
6065         Provides the default value for the <code>--[no-]force-in-body-from</code>
6066         option to format-patch.  Defaults to false.
6067 </p>
6068 </dd>
6069 <dt class="hdlist1">
6070 format.numbered
6071 </dt>
6072 <dd>
6073 <p>
6074         A boolean which can enable or disable sequence numbers in patch
6075         subjects.  It defaults to "auto" which enables it only if there
6076         is more than one patch.  It can be enabled or disabled for all
6077         messages by setting it to "true" or "false".  See --numbered
6078         option in <a href="git-format-patch.html">git-format-patch(1)</a>.
6079 </p>
6080 </dd>
6081 <dt class="hdlist1">
6082 format.headers
6083 </dt>
6084 <dd>
6085 <p>
6086         Additional email headers to include in a patch to be submitted
6087         by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.
6088 </p>
6089 </dd>
6090 <dt class="hdlist1">
6091 format.to
6092 </dt>
6093 <dt class="hdlist1">
6094 format.cc
6095 </dt>
6096 <dd>
6097 <p>
6098         Additional recipients to include in a patch to be submitted
6099         by mail.  See the --to and --cc options in
6100         <a href="git-format-patch.html">git-format-patch(1)</a>.
6101 </p>
6102 </dd>
6103 <dt class="hdlist1">
6104 format.subjectPrefix
6105 </dt>
6106 <dd>
6107 <p>
6108         The default for format-patch is to output files with the <em>[PATCH]</em>
6109         subject prefix. Use this variable to change that prefix.
6110 </p>
6111 </dd>
6112 <dt class="hdlist1">
6113 format.coverFromDescription
6114 </dt>
6115 <dd>
6116 <p>
6117         The default mode for format-patch to determine which parts of
6118         the cover letter will be populated using the branch&#8217;s
6119         description. See the <code>--cover-from-description</code> option in
6120         <a href="git-format-patch.html">git-format-patch(1)</a>.
6121 </p>
6122 </dd>
6123 <dt class="hdlist1">
6124 format.signature
6125 </dt>
6126 <dd>
6127 <p>
6128         The default for format-patch is to output a signature containing
6129         the Git version number. Use this variable to change that default.
6130         Set this variable to the empty string ("") to suppress
6131         signature generation.
6132 </p>
6133 </dd>
6134 <dt class="hdlist1">
6135 format.signatureFile
6136 </dt>
6137 <dd>
6138 <p>
6139         Works just like format.signature except the contents of the
6140         file specified by this variable will be used as the signature.
6141 </p>
6142 </dd>
6143 <dt class="hdlist1">
6144 format.suffix
6145 </dt>
6146 <dd>
6147 <p>
6148         The default for format-patch is to output files with the suffix
6149         <code>.patch</code>. Use this variable to change that suffix (make sure to
6150         include the dot if you want it).
6151 </p>
6152 </dd>
6153 <dt class="hdlist1">
6154 format.encodeEmailHeaders
6155 </dt>
6156 <dd>
6157 <p>
6158         Encode email headers that have non-ASCII characters with
6159         "Q-encoding" (described in RFC 2047) for email transmission.
6160         Defaults to true.
6161 </p>
6162 </dd>
6163 <dt class="hdlist1">
6164 format.pretty
6165 </dt>
6166 <dd>
6167 <p>
6168         The default pretty format for log/show/whatchanged command.
6169         See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
6170         <a href="git-whatchanged.html">git-whatchanged(1)</a>.
6171 </p>
6172 </dd>
6173 <dt class="hdlist1">
6174 format.thread
6175 </dt>
6176 <dd>
6177 <p>
6178         The default threading style for <em>git format-patch</em>.  Can be
6179         a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
6180         makes every mail a reply to the head of the series,
6181         where the head is chosen from the cover letter, the
6182         <code>--in-reply-to</code>, and the first patch mail, in this order.
6183         <code>deep</code> threading makes every mail a reply to the previous one.
6184         A true boolean value is the same as <code>shallow</code>, and a false
6185         value disables threading.
6186 </p>
6187 </dd>
6188 <dt class="hdlist1">
6189 format.signOff
6190 </dt>
6191 <dd>
6192 <p>
6193         A boolean value which lets you enable the <code>-s/--signoff</code> option of
6194         format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
6195         patch should be a conscious act and means that you certify you have
6196         the rights to submit this work under the same open source license.
6197         Please see the <em>SubmittingPatches</em> document for further discussion.
6198 </p>
6199 </dd>
6200 <dt class="hdlist1">
6201 format.coverLetter
6202 </dt>
6203 <dd>
6204 <p>
6205         A boolean that controls whether to generate a cover-letter when
6206         format-patch is invoked, but in addition can be set to "auto", to
6207         generate a cover-letter only when there&#8217;s more than one patch.
6208         Default is false.
6209 </p>
6210 </dd>
6211 <dt class="hdlist1">
6212 format.outputDirectory
6213 </dt>
6214 <dd>
6215 <p>
6216         Set a custom directory to store the resulting files instead of the
6217         current working directory. All directory components will be created.
6218 </p>
6219 </dd>
6220 <dt class="hdlist1">
6221 format.filenameMaxLength
6222 </dt>
6223 <dd>
6224 <p>
6225         The maximum length of the output filenames generated by the
6226         <code>format-patch</code> command; defaults to 64.  Can be overridden
6227         by the <code>--filename-max-length=&lt;n&gt;</code> command line option.
6228 </p>
6229 </dd>
6230 <dt class="hdlist1">
6231 format.useAutoBase
6232 </dt>
6233 <dd>
6234 <p>
6235         A boolean value which lets you enable the <code>--base=auto</code> option of
6236         format-patch by default. Can also be set to "whenAble" to allow
6237         enabling <code>--base=auto</code> if a suitable base is available, but to skip
6238         adding base info otherwise without the format dying.
6239 </p>
6240 </dd>
6241 <dt class="hdlist1">
6242 format.notes
6243 </dt>
6244 <dd>
6245 <p>
6246         Provides the default value for the <code>--notes</code> option to
6247         format-patch. Accepts a boolean value, or a ref which specifies
6248         where to get notes. If false, format-patch defaults to
6249         <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
6250         set to a non-boolean value, format-patch defaults to
6251         <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
6252         to false.
6253 </p>
6254 <div class="paragraph"><p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
6255 instead.</p></div>
6256 <div class="paragraph"><p>This configuration can be specified multiple times in order to allow
6257 multiple notes refs to be included. In that case, it will behave
6258 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
6259 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
6260 also show notes from that notes ref and a value of <code>false</code> will negate
6261 previous configurations and not show notes.</p></div>
6262 <div class="paragraph"><p>For example,</p></div>
6263 <div class="listingblock">
6264 <div class="content">
6265 <pre><code>[format]
6266         notes = true
6267         notes = foo
6268         notes = false
6269         notes = bar</code></pre>
6270 </div></div>
6271 <div class="paragraph"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
6272 </dd>
6273 <dt class="hdlist1">
6274 format.mboxrd
6275 </dt>
6276 <dd>
6277 <p>
6278         A boolean value which enables the robust "mboxrd" format when
6279         <code>--stdout</code> is in use to escape "^&gt;+From " lines.
6280 </p>
6281 </dd>
6282 <dt class="hdlist1">
6283 format.noprefix
6284 </dt>
6285 <dd>
6286 <p>
6287         If set, do not show any source or destination prefix in patches.
6288         This is equivalent to the <code>diff.noprefix</code> option used by <code>git
6289         diff</code> (but which is not respected by <code>format-patch</code>). Note that
6290         by setting this, the receiver of any patches you generate will
6291         have to apply them using the <code>-p0</code> option.
6292 </p>
6293 </dd>
6294 <dt class="hdlist1">
6295 fsck.&lt;msg-id&gt;
6296 </dt>
6297 <dd>
6298 <p>
6299         During fsck git may find issues with legacy data which
6300         wouldn&#8217;t be generated by current versions of git, and which
6301         wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
6302         set. This feature is intended to support working with legacy
6303         repositories containing such data.
6304 </p>
6305 <div class="paragraph"><p>Setting <code>fsck.&lt;msg-id&gt;</code> will be picked up by <a href="git-fsck.html">git-fsck(1)</a>, but
6306 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
6307 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
6308 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
6309 same applies for the corresponding <code>receive.fsck.*</code> and
6310 <code>fetch.fsck.*</code>. variables.</p></div>
6311 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
6312 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
6313 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
6314 uniformly configure the same fsck settings in different circumstances,
6315 all three of them must be set to the same values.</p></div>
6316 <div class="paragraph"><p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
6317 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
6318 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
6319 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
6320 with the message ID, e.g. "missingEmail: invalid author/committer
6321 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
6322 will hide that issue.</p></div>
6323 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
6324 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6325 problematic objects share to be ignored, as doing the latter will
6326 allow new instances of the same breakages go unnoticed.</p></div>
6327 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
6328 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
6329 will only cause git to warn.</p></div>
6330 <div class="paragraph"><p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
6331 values of <code>&lt;msg-id&gt;</code>.</p></div>
6332 </dd>
6333 <dt class="hdlist1">
6334 fsck.skipList
6335 </dt>
6336 <dd>
6337 <p>
6338         The path to a list of object names (i.e. one unabbreviated SHA-1 per
6339         line) that are known to be broken in a non-fatal way and should
6340         be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
6341         lines, and any leading and trailing whitespace are ignored. Everything
6342         but a SHA-1 per line will error out on older versions.
6343 </p>
6344 <div class="paragraph"><p>This feature is useful when an established project should be accepted
6345 despite early commits containing errors that can be safely ignored,
6346 such as invalid committer email addresses.  Note: corrupt objects
6347 cannot be skipped with this setting.</p></div>
6348 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
6349 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6350 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6351 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6352 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
6353 uniformly configure the same fsck settings in different circumstances,
6354 all three of them must be set to the same values.</p></div>
6355 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
6356 list should be sorted. This was never a requirement; the object names
6357 could appear in any order, but when reading the list we tracked whether
6358 the list was sorted for the purposes of an internal binary search
6359 implementation, which could save itself some work with an already sorted
6360 list. Unless you had a humongous list there was no reason to go out of
6361 your way to pre-sort the list. After Git version 2.20 a hash implementation
6362 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
6363 </dd>
6364 <dt class="hdlist1">
6365 fsmonitor.allowRemote
6366 </dt>
6367 <dd>
6368 <p>
6369     By default, the fsmonitor daemon refuses to work with network-mounted
6370     repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6371     behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6372 </p>
6373 </dd>
6374 <dt class="hdlist1">
6375 fsmonitor.socketDir
6376 </dt>
6377 <dd>
6378 <p>
6379     This Mac OS-specific option, if set, specifies the directory in
6380     which to create the Unix domain socket used for communication
6381     between the fsmonitor daemon and various Git commands. The directory must
6382     reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
6383     is set to <code>true</code>.
6384 </p>
6385 </dd>
6386 <dt class="hdlist1">
6387 gc.aggressiveDepth
6388 </dt>
6389 <dd>
6390 <p>
6391         The depth parameter used in the delta compression
6392         algorithm used by <em>git gc --aggressive</em>.  This defaults
6393         to 50, which is the default for the <code>--depth</code> option when
6394         <code>--aggressive</code> isn&#8217;t in use.
6395 </p>
6396 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
6397 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6398 </dd>
6399 <dt class="hdlist1">
6400 gc.aggressiveWindow
6401 </dt>
6402 <dd>
6403 <p>
6404         The window size parameter used in the delta compression
6405         algorithm used by <em>git gc --aggressive</em>.  This defaults
6406         to 250, which is a much more aggressive window size than
6407         the default <code>--window</code> of 10.
6408 </p>
6409 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
6410 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6411 </dd>
6412 <dt class="hdlist1">
6413 gc.auto
6414 </dt>
6415 <dd>
6416 <p>
6417         When there are approximately more than this many loose
6418         objects in the repository, <code>git gc --auto</code> will pack them.
6419         Some Porcelain commands use this command to perform a
6420         light-weight garbage collection from time to time.  The
6421         default value is 6700.
6422 </p>
6423 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
6424 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
6425 otherwise use to determine if there&#8217;s work to do, such as
6426 <code>gc.autoPackLimit</code>.</p></div>
6427 </dd>
6428 <dt class="hdlist1">
6429 gc.autoPackLimit
6430 </dt>
6431 <dd>
6432 <p>
6433         When there are more than this many packs that are not
6434         marked with <code>*.keep</code> file in the repository, <code>git gc
6435         --auto</code> consolidates them into one larger pack.  The
6436         default value is 50.  Setting this to 0 disables it.
6437         Setting <code>gc.auto</code> to 0 will also disable this.
6438 </p>
6439 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6440 use, it&#8217;ll affect how the auto pack limit works.</p></div>
6441 </dd>
6442 <dt class="hdlist1">
6443 gc.autoDetach
6444 </dt>
6445 <dd>
6446 <p>
6447         Make <code>git gc --auto</code> return immediately and run in the background
6448         if the system supports it. Default is true.
6449 </p>
6450 </dd>
6451 <dt class="hdlist1">
6452 gc.bigPackThreshold
6453 </dt>
6454 <dd>
6455 <p>
6456         If non-zero, all non-cruft packs larger than this limit are kept
6457         when <code>git gc</code> is run. This is very similar to
6458         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6459         the threshold are kept, not just the largest pack. Defaults to
6460         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6461 </p>
6462 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6463 this configuration variable is ignored, all packs except the base pack
6464 will be repacked. After this the number of packs should go below
6465 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6466 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6467 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6468 will also be excluded (this is the equivalent of running <code>git gc</code> with
6469 <code>--keep-largest-pack</code>).</p></div>
6470 </dd>
6471 <dt class="hdlist1">
6472 gc.writeCommitGraph
6473 </dt>
6474 <dd>
6475 <p>
6476         If true, then gc will rewrite the commit-graph file when
6477         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6478         the commit-graph will be updated if housekeeping is
6479         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
6480         for details.
6481 </p>
6482 </dd>
6483 <dt class="hdlist1">
6484 gc.logExpiry
6485 </dt>
6486 <dd>
6487 <p>
6488         If the file gc.log exists, then <code>git gc --auto</code> will print
6489         its content and exit with status zero instead of running
6490         unless that file is more than <em>gc.logExpiry</em> old.  Default is
6491         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
6492         value.
6493 </p>
6494 </dd>
6495 <dt class="hdlist1">
6496 gc.packRefs
6497 </dt>
6498 <dd>
6499 <p>
6500         Running <code>git pack-refs</code> in a repository renders it
6501         unclonable by Git versions prior to 1.5.1.2 over dumb
6502         transports such as HTTP.  This variable determines whether
6503         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6504         to enable it within all non-bare repos or it can be set to a
6505         boolean value.  The default is <code>true</code>.
6506 </p>
6507 </dd>
6508 <dt class="hdlist1">
6509 gc.cruftPacks
6510 </dt>
6511 <dd>
6512 <p>
6513         Store unreachable objects in a cruft pack (see
6514         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
6515         is <code>true</code>.
6516 </p>
6517 </dd>
6518 <dt class="hdlist1">
6519 gc.maxCruftSize
6520 </dt>
6521 <dd>
6522 <p>
6523         Limit the size of new cruft packs when repacking. When
6524         specified in addition to <code>--max-cruft-size</code>, the command line
6525         option takes priority. See the <code>--max-cruft-size</code> option of
6526         <a href="git-repack.html">git-repack(1)</a>.
6527 </p>
6528 </dd>
6529 <dt class="hdlist1">
6530 gc.pruneExpire
6531 </dt>
6532 <dd>
6533 <p>
6534         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6535         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6536         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
6537         grace period with this config variable.  The value "now" may be
6538         used to disable this grace period and always prune unreachable
6539         objects immediately, or "never" may be used to suppress pruning.
6540         This feature helps prevent corruption when <em>git gc</em> runs
6541         concurrently with another process writing to the repository; see
6542         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
6543 </p>
6544 </dd>
6545 <dt class="hdlist1">
6546 gc.worktreePruneExpire
6547 </dt>
6548 <dd>
6549 <p>
6550         When <em>git gc</em> is run, it calls
6551         <em>git worktree prune --expire 3.months.ago</em>.
6552         This config variable can be used to set a different grace
6553         period. The value "now" may be used to disable the grace
6554         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
6555         may be used to suppress pruning.
6556 </p>
6557 </dd>
6558 <dt class="hdlist1">
6559 gc.reflogExpire
6560 </dt>
6561 <dt class="hdlist1">
6562 gc.&lt;pattern&gt;.reflogExpire
6563 </dt>
6564 <dd>
6565 <p>
6566         <em>git reflog expire</em> removes reflog entries older than
6567         this time; defaults to 90 days. The value "now" expires all
6568         entries immediately, and "never" suppresses expiration
6569         altogether. With "&lt;pattern&gt;" (e.g.
6570         "refs/stash") in the middle the setting applies only to
6571         the refs that match the &lt;pattern&gt;.
6572 </p>
6573 </dd>
6574 <dt class="hdlist1">
6575 gc.reflogExpireUnreachable
6576 </dt>
6577 <dt class="hdlist1">
6578 gc.&lt;pattern&gt;.reflogExpireUnreachable
6579 </dt>
6580 <dd>
6581 <p>
6582         <em>git reflog expire</em> removes reflog entries older than
6583         this time and are not reachable from the current tip;
6584         defaults to 30 days. The value "now" expires all entries
6585         immediately, and "never" suppresses expiration altogether.
6586         With "&lt;pattern&gt;" (e.g. "refs/stash")
6587         in the middle, the setting applies only to the refs that
6588         match the &lt;pattern&gt;.
6589 </p>
6590 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
6591 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6592 or rebase occurring.  Since these changes are not part of the current
6593 project most users will want to expire them sooner, which is why the
6594 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6595 </dd>
6596 <dt class="hdlist1">
6597 gc.recentObjectsHook
6598 </dt>
6599 <dd>
6600 <p>
6601         When considering whether or not to remove an object (either when
6602         generating a cruft pack or storing unreachable objects as
6603         loose), use the shell to execute the specified command(s).
6604         Interpret their output as object IDs which Git will consider as
6605         "recent", regardless of their age. By treating their mtimes as
6606         "now", any objects (and their descendants) mentioned in the
6607         output will be kept regardless of their true age.
6608 </p>
6609 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
6610 else. Objects which cannot be found in the repository are ignored.
6611 Multiple hooks are supported, but all must exit successfully, else the
6612 operation (either generating a cruft pack or unpacking unreachable
6613 objects) will be halted.</p></div>
6614 </dd>
6615 <dt class="hdlist1">
6616 gc.repackFilter
6617 </dt>
6618 <dd>
6619 <p>
6620         When repacking, use the specified filter to move certain
6621         objects into a separate packfile.  See the
6622         <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.
6623 </p>
6624 </dd>
6625 <dt class="hdlist1">
6626 gc.repackFilterTo
6627 </dt>
6628 <dd>
6629 <p>
6630         When repacking and using a filter, see <code>gc.repackFilter</code>, the
6631         specified location will be used to create the packfile
6632         containing the filtered out objects. <strong>WARNING:</strong> The
6633         specified location should be accessible, using for example the
6634         Git alternates mechanism, otherwise the repo could be
6635         considered corrupt by Git as it migh not be able to access the
6636         objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
6637         of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
6638         section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.
6639 </p>
6640 </dd>
6641 <dt class="hdlist1">
6642 gc.rerereResolved
6643 </dt>
6644 <dd>
6645 <p>
6646         Records of conflicted merge you resolved earlier are
6647         kept for this many days when <em>git rerere gc</em> is run.
6648         You can also use more human-readable "1.month.ago", etc.
6649         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6650 </p>
6651 </dd>
6652 <dt class="hdlist1">
6653 gc.rerereUnresolved
6654 </dt>
6655 <dd>
6656 <p>
6657         Records of conflicted merge you have not resolved are
6658         kept for this many days when <em>git rerere gc</em> is run.
6659         You can also use more human-readable "1.month.ago", etc.
6660         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6661 </p>
6662 </dd>
6663 <dt class="hdlist1">
6664 gitcvs.commitMsgAnnotation
6665 </dt>
6666 <dd>
6667 <p>
6668         Append this string to each commit message. Set to empty string
6669         to disable this feature. Defaults to "via git-CVS emulator".
6670 </p>
6671 </dd>
6672 <dt class="hdlist1">
6673 gitcvs.enabled
6674 </dt>
6675 <dd>
6676 <p>
6677         Whether the CVS server interface is enabled for this repository.
6678         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6679 </p>
6680 </dd>
6681 <dt class="hdlist1">
6682 gitcvs.logFile
6683 </dt>
6684 <dd>
6685 <p>
6686         Path to a log file where the CVS server interface well&#8230; logs
6687         various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6688 </p>
6689 </dd>
6690 <dt class="hdlist1">
6691 gitcvs.usecrlfattr
6692 </dt>
6693 <dd>
6694 <p>
6695         If true, the server will look up the end-of-line conversion
6696         attributes for files to determine the <code>-k</code> modes to use. If
6697         the attributes force Git to treat a file as text,
6698         the <code>-k</code> mode will be left blank so CVS clients will
6699         treat it as text. If they suppress text conversion, the file
6700         will be set with <em>-kb</em> mode, which suppresses any newline munging
6701         the client might otherwise do. If the attributes do not allow
6702         the file type to be determined, then <code>gitcvs.allBinary</code> is
6703         used. See <a href="gitattributes.html">gitattributes(5)</a>.
6704 </p>
6705 </dd>
6706 <dt class="hdlist1">
6707 gitcvs.allBinary
6708 </dt>
6709 <dd>
6710 <p>
6711         This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6712         the correct <em>-kb</em> mode to use. If true, all
6713         unresolved files are sent to the client in
6714         mode <em>-kb</em>. This causes the client to treat them
6715         as binary files, which suppresses any newline munging it
6716         otherwise might do. Alternatively, if it is set to "guess",
6717         then the contents of the file are examined to decide if
6718         it is binary, similar to <code>core.autocrlf</code>.
6719 </p>
6720 </dd>
6721 <dt class="hdlist1">
6722 gitcvs.dbName
6723 </dt>
6724 <dd>
6725 <p>
6726         Database used by git-cvsserver to cache revision information
6727         derived from the Git repository. The exact meaning depends on the
6728         used database driver, for SQLite (which is the default driver) this
6729         is a filename. Supports variable substitution (see
6730         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6731         Default: <em>%Ggitcvs.%m.sqlite</em>
6732 </p>
6733 </dd>
6734 <dt class="hdlist1">
6735 gitcvs.dbDriver
6736 </dt>
6737 <dd>
6738 <p>
6739         Used Perl DBI driver. You can specify any available driver
6740         for this here, but it might not work. git-cvsserver is tested
6741         with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6742         reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6743         May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6744         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6745 </p>
6746 </dd>
6747 <dt class="hdlist1">
6748 gitcvs.dbUser, gitcvs.dbPass
6749 </dt>
6750 <dd>
6751 <p>
6752         Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6753         since SQLite has no concept of database users and/or passwords.
6754         <em>gitcvs.dbUser</em> supports variable substitution (see
6755         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
6756 </p>
6757 </dd>
6758 <dt class="hdlist1">
6759 gitcvs.dbTableNamePrefix
6760 </dt>
6761 <dd>
6762 <p>
6763         Database table name prefix.  Prepended to the names of any
6764         database tables used, allowing a single database to be used
6765         for several repositories.  Supports variable substitution (see
6766         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
6767         characters will be replaced with underscores.
6768 </p>
6769 </dd>
6770 </dl></div>
6771 <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6772 <code>gitcvs.allBinary</code> can also be specified as
6773 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
6774 is one of "ext" and "pserver") to make them apply only for the given
6775 access method.</p></div>
6776 <div class="dlist"><dl>
6777 <dt class="hdlist1">
6778 gitweb.category
6779 </dt>
6780 <dt class="hdlist1">
6781 gitweb.description
6782 </dt>
6783 <dt class="hdlist1">
6784 gitweb.owner
6785 </dt>
6786 <dt class="hdlist1">
6787 gitweb.url
6788 </dt>
6789 <dd>
6790 <p>
6791         See <a href="gitweb.html">gitweb(1)</a> for description.
6792 </p>
6793 </dd>
6794 <dt class="hdlist1">
6795 gitweb.avatar
6796 </dt>
6797 <dt class="hdlist1">
6798 gitweb.blame
6799 </dt>
6800 <dt class="hdlist1">
6801 gitweb.grep
6802 </dt>
6803 <dt class="hdlist1">
6804 gitweb.highlight
6805 </dt>
6806 <dt class="hdlist1">
6807 gitweb.patches
6808 </dt>
6809 <dt class="hdlist1">
6810 gitweb.pickaxe
6811 </dt>
6812 <dt class="hdlist1">
6813 gitweb.remote_heads
6814 </dt>
6815 <dt class="hdlist1">
6816 gitweb.showSizes
6817 </dt>
6818 <dt class="hdlist1">
6819 gitweb.snapshot
6820 </dt>
6821 <dd>
6822 <p>
6823         See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
6824 </p>
6825 </dd>
6826 <dt class="hdlist1">
6827 gpg.program
6828 </dt>
6829 <dd>
6830 <p>
6831         Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
6832         making or verifying a PGP signature. The program must support the
6833         same command-line interface as GPG, namely, to verify a detached
6834         signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
6835         program is expected to signal a good signature by exiting with
6836         code 0.  To generate an ASCII-armored detached signature, the
6837         standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
6838         signed, and the program is expected to send the result to its
6839         standard output.
6840 </p>
6841 </dd>
6842 <dt class="hdlist1">
6843 gpg.format
6844 </dt>
6845 <dd>
6846 <p>
6847         Specifies which key format to use when signing with <code>--gpg-sign</code>.
6848         Default is "openpgp". Other possible values are "x509", "ssh".
6849 </p>
6850 <div class="paragraph"><p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
6851 based on the selected <code>gpg.format</code>.</p></div>
6852 </dd>
6853 <dt class="hdlist1">
6854 gpg.&lt;format&gt;.program
6855 </dt>
6856 <dd>
6857 <p>
6858         Use this to customize the program used for the signing format you
6859         chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
6860         be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
6861         value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".
6862 </p>
6863 </dd>
6864 <dt class="hdlist1">
6865 gpg.minTrustLevel
6866 </dt>
6867 <dd>
6868 <p>
6869         Specifies a minimum trust level for signature verification.  If
6870         this option is unset, then signature verification for merge
6871         operations requires a key with at least <code>marginal</code> trust.  Other
6872         operations that perform signature verification require a key
6873         with at least <code>undefined</code> trust.  Setting this option overrides
6874         the required trust-level for all operations.  Supported values,
6875         in increasing order of significance:
6876 </p>
6877 <div class="ulist"><ul>
6878 <li>
6879 <p>
6880 <code>undefined</code>
6881 </p>
6882 </li>
6883 <li>
6884 <p>
6885 <code>never</code>
6886 </p>
6887 </li>
6888 <li>
6889 <p>
6890 <code>marginal</code>
6891 </p>
6892 </li>
6893 <li>
6894 <p>
6895 <code>fully</code>
6896 </p>
6897 </li>
6898 <li>
6899 <p>
6900 <code>ultimate</code>
6901 </p>
6902 </li>
6903 </ul></div>
6904 </dd>
6905 <dt class="hdlist1">
6906 gpg.ssh.defaultKeyCommand
6907 </dt>
6908 <dd>
6909 <p>
6910         This command will be run when user.signingkey is not set and a ssh
6911         signature is requested. On successful exit a valid ssh public key
6912         prefixed with <code>key::</code> is expected in the first line of its output.
6913         This allows for a script doing a dynamic lookup of the correct public
6914         key when it is impractical to statically configure <code>user.signingKey</code>.
6915         For example when keys or SSH Certificates are rotated frequently or
6916         selection of the right key depends on external factors unknown to git.
6917 </p>
6918 </dd>
6919 <dt class="hdlist1">
6920 gpg.ssh.allowedSignersFile
6921 </dt>
6922 <dd>
6923 <p>
6924         A file containing ssh public keys which you are willing to trust.
6925         The file consists of one or more lines of principals followed by an ssh
6926         public key.
6927         e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
6928         See ssh-keygen(1) "ALLOWED SIGNERS" for details.
6929         The principal is only used to identify the key and is available when
6930         verifying a signature.
6931 </p>
6932 <div class="paragraph"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
6933 between valid signatures and trusted signatures the trust level of a signature
6934 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
6935 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
6936 <div class="paragraph"><p>This file can be set to a location outside of the repository and every developer
6937 maintains their own trust store. A central repository server could generate this
6938 file automatically from ssh keys with push access to verify the code against.
6939 In a corporate setting this file is probably generated at a global location
6940 from automation that already handles developer ssh keys.</p></div>
6941 <div class="paragraph"><p>A repository that only allows signed commits can store the file
6942 in the repository itself using a path relative to the top-level of the working tree.
6943 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
6944 <div class="paragraph"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
6945 valid-before options. Git will mark signatures as valid if the signing key was
6946 valid at the time of the signature&#8217;s creation. This allows users to change a
6947 signing key without invalidating all previously made signatures.</p></div>
6948 <div class="paragraph"><p>Using a SSH CA key with the cert-authority option
6949 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p></div>
6950 </dd>
6951 <dt class="hdlist1">
6952 gpg.ssh.revocationFile
6953 </dt>
6954 <dd>
6955 <p>
6956         Either a SSH KRL or a list of revoked public keys (without the principal prefix).
6957         See ssh-keygen(1) for details.
6958         If a public key is found in this file then it will always be treated
6959         as having trust level "never" and signatures will show as invalid.
6960 </p>
6961 </dd>
6962 <dt class="hdlist1">
6963 grep.lineNumber
6964 </dt>
6965 <dd>
6966 <p>
6967         If set to true, enable <code>-n</code> option by default.
6968 </p>
6969 </dd>
6970 <dt class="hdlist1">
6971 grep.column
6972 </dt>
6973 <dd>
6974 <p>
6975         If set to true, enable the <code>--column</code> option by default.
6976 </p>
6977 </dd>
6978 <dt class="hdlist1">
6979 grep.patternType
6980 </dt>
6981 <dd>
6982 <p>
6983         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
6984         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
6985         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
6986         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
6987         between <em>basic</em> and <em>extended</em>.
6988 </p>
6989 </dd>
6990 <dt class="hdlist1">
6991 grep.extendedRegexp
6992 </dt>
6993 <dd>
6994 <p>
6995         If set to true, enable <code>--extended-regexp</code> option by default. This
6996         option is ignored when the <code>grep.patternType</code> option is set to a value
6997         other than <em>default</em>.
6998 </p>
6999 </dd>
7000 <dt class="hdlist1">
7001 grep.threads
7002 </dt>
7003 <dd>
7004 <p>
7005         Number of grep worker threads to use. If unset (or set to 0), Git will
7006         use as many threads as the number of logical cores available.
7007 </p>
7008 </dd>
7009 <dt class="hdlist1">
7010 grep.fullName
7011 </dt>
7012 <dd>
7013 <p>
7014         If set to true, enable <code>--full-name</code> option by default.
7015 </p>
7016 </dd>
7017 <dt class="hdlist1">
7018 grep.fallbackToNoIndex
7019 </dt>
7020 <dd>
7021 <p>
7022         If set to true, fall back to <code>git grep --no-index</code> if <code>git grep</code>
7023         is executed outside of a git repository.  Defaults to false.
7024 </p>
7025 </dd>
7026 <dt class="hdlist1">
7027 gui.commitMsgWidth
7028 </dt>
7029 <dd>
7030 <p>
7031         Defines how wide the commit message window is in the
7032         <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
7033 </p>
7034 </dd>
7035 <dt class="hdlist1">
7036 gui.diffContext
7037 </dt>
7038 <dd>
7039 <p>
7040         Specifies how many context lines should be used in calls to diff
7041         made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
7042 </p>
7043 </dd>
7044 <dt class="hdlist1">
7045 gui.displayUntracked
7046 </dt>
7047 <dd>
7048 <p>
7049         Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
7050         in the file list. The default is "true".
7051 </p>
7052 </dd>
7053 <dt class="hdlist1">
7054 gui.encoding
7055 </dt>
7056 <dd>
7057 <p>
7058         Specifies the default character encoding to use for displaying of
7059         file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
7060         It can be overridden by setting the <em>encoding</em> attribute
7061         for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
7062         If this option is not set, the tools default to the
7063         locale encoding.
7064 </p>
7065 </dd>
7066 <dt class="hdlist1">
7067 gui.matchTrackingBranch
7068 </dt>
7069 <dd>
7070 <p>
7071         Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
7072         default to tracking remote branches with matching names or
7073         not. Default: "false".
7074 </p>
7075 </dd>
7076 <dt class="hdlist1">
7077 gui.newBranchTemplate
7078 </dt>
7079 <dd>
7080 <p>
7081         Is used as a suggested name when creating new branches using the
7082         <a href="git-gui.html">git-gui(1)</a>.
7083 </p>
7084 </dd>
7085 <dt class="hdlist1">
7086 gui.pruneDuringFetch
7087 </dt>
7088 <dd>
7089 <p>
7090         "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
7091         performing a fetch. The default value is "false".
7092 </p>
7093 </dd>
7094 <dt class="hdlist1">
7095 gui.trustmtime
7096 </dt>
7097 <dd>
7098 <p>
7099         Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
7100         timestamp or not. By default the timestamps are not trusted.
7101 </p>
7102 </dd>
7103 <dt class="hdlist1">
7104 gui.spellingDictionary
7105 </dt>
7106 <dd>
7107 <p>
7108         Specifies the dictionary used for spell checking commit messages in
7109         the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
7110         off.
7111 </p>
7112 </dd>
7113 <dt class="hdlist1">
7114 gui.fastCopyBlame
7115 </dt>
7116 <dd>
7117 <p>
7118         If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
7119         location detection. It makes blame significantly faster on huge
7120         repositories at the expense of less thorough copy detection.
7121 </p>
7122 </dd>
7123 <dt class="hdlist1">
7124 gui.copyBlameThreshold
7125 </dt>
7126 <dd>
7127 <p>
7128         Specifies the threshold to use in <em>git gui blame</em> original location
7129         detection, measured in alphanumeric characters. See the
7130         <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
7131 </p>
7132 </dd>
7133 <dt class="hdlist1">
7134 gui.blamehistoryctx
7135 </dt>
7136 <dd>
7137 <p>
7138         Specifies the radius of history context in days to show in
7139         <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
7140         Context</code> menu item is invoked from <em>git gui blame</em>. If this
7141         variable is set to zero, the whole history is shown.
7142 </p>
7143 </dd>
7144 <dt class="hdlist1">
7145 guitool.&lt;name&gt;.cmd
7146 </dt>
7147 <dd>
7148 <p>
7149         Specifies the shell command line to execute when the corresponding item
7150         of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
7151         mandatory for every tool. The command is executed from the root of
7152         the working directory, and in the environment it receives the name of
7153         the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
7154         <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
7155         the head is detached, <em>CUR_BRANCH</em> is empty).
7156 </p>
7157 </dd>
7158 <dt class="hdlist1">
7159 guitool.&lt;name&gt;.needsFile
7160 </dt>
7161 <dd>
7162 <p>
7163         Run the tool only if a diff is selected in the GUI. It guarantees
7164         that <em>FILENAME</em> is not empty.
7165 </p>
7166 </dd>
7167 <dt class="hdlist1">
7168 guitool.&lt;name&gt;.noConsole
7169 </dt>
7170 <dd>
7171 <p>
7172         Run the command silently, without creating a window to display its
7173         output.
7174 </p>
7175 </dd>
7176 <dt class="hdlist1">
7177 guitool.&lt;name&gt;.noRescan
7178 </dt>
7179 <dd>
7180 <p>
7181         Don&#8217;t rescan the working directory for changes after the tool
7182         finishes execution.
7183 </p>
7184 </dd>
7185 <dt class="hdlist1">
7186 guitool.&lt;name&gt;.confirm
7187 </dt>
7188 <dd>
7189 <p>
7190         Show a confirmation dialog before actually running the tool.
7191 </p>
7192 </dd>
7193 <dt class="hdlist1">
7194 guitool.&lt;name&gt;.argPrompt
7195 </dt>
7196 <dd>
7197 <p>
7198         Request a string argument from the user, and pass it to the tool
7199         through the <code>ARGS</code> environment variable. Since requesting an
7200         argument implies confirmation, the <em>confirm</em> option has no effect
7201         if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
7202         the dialog uses a built-in generic prompt; otherwise the exact
7203         value of the variable is used.
7204 </p>
7205 </dd>
7206 <dt class="hdlist1">
7207 guitool.&lt;name&gt;.revPrompt
7208 </dt>
7209 <dd>
7210 <p>
7211         Request a single valid revision from the user, and set the
7212         <code>REVISION</code> environment variable. In other aspects this option
7213         is similar to <em>argPrompt</em>, and can be used together with it.
7214 </p>
7215 </dd>
7216 <dt class="hdlist1">
7217 guitool.&lt;name&gt;.revUnmerged
7218 </dt>
7219 <dd>
7220 <p>
7221         Show only unmerged branches in the <em>revPrompt</em> subdialog.
7222         This is useful for tools similar to merge or rebase, but not
7223         for things like checkout or reset.
7224 </p>
7225 </dd>
7226 <dt class="hdlist1">
7227 guitool.&lt;name&gt;.title
7228 </dt>
7229 <dd>
7230 <p>
7231         Specifies the title to use for the prompt dialog. The default
7232         is the tool name.
7233 </p>
7234 </dd>
7235 <dt class="hdlist1">
7236 guitool.&lt;name&gt;.prompt
7237 </dt>
7238 <dd>
7239 <p>
7240         Specifies the general prompt string to display at the top of
7241         the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
7242         The default value includes the actual command.
7243 </p>
7244 </dd>
7245 <dt class="hdlist1">
7246 help.browser
7247 </dt>
7248 <dd>
7249 <p>
7250         Specify the browser that will be used to display help in the
7251         <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
7252 </p>
7253 </dd>
7254 <dt class="hdlist1">
7255 help.format
7256 </dt>
7257 <dd>
7258 <p>
7259         Override the default help format used by <a href="git-help.html">git-help(1)</a>.
7260         Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
7261         the default. <em>web</em> and <em>html</em> are the same.
7262 </p>
7263 </dd>
7264 <dt class="hdlist1">
7265 help.autoCorrect
7266 </dt>
7267 <dd>
7268 <p>
7269         If git detects typos and can identify exactly one valid command similar
7270         to the error, git will try to suggest the correct command or even
7271         run the suggestion automatically. Possible config values are:
7272 </p>
7273 <div class="ulist"><ul>
7274 <li>
7275 <p>
7276 0 (default): show the suggested command.
7277 </p>
7278 </li>
7279 <li>
7280 <p>
7281 positive number: run the suggested command after specified
7282 deciseconds (0.1 sec).
7283 </p>
7284 </li>
7285 <li>
7286 <p>
7287 "immediate": run the suggested command immediately.
7288 </p>
7289 </li>
7290 <li>
7291 <p>
7292 "prompt": show the suggestion and prompt for confirmation to run
7293 the command.
7294 </p>
7295 </li>
7296 <li>
7297 <p>
7298 "never": don&#8217;t run or show any suggested command.
7299 </p>
7300 </li>
7301 </ul></div>
7302 </dd>
7303 <dt class="hdlist1">
7304 help.htmlPath
7305 </dt>
7306 <dd>
7307 <p>
7308         Specify the path where the HTML documentation resides. File system paths
7309         and URLs are supported. HTML pages will be prefixed with this path when
7310         help is displayed in the <em>web</em> format. This defaults to the documentation
7311         path of your Git installation.
7312 </p>
7313 </dd>
7314 <dt class="hdlist1">
7315 http.proxy
7316 </dt>
7317 <dd>
7318 <p>
7319         Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
7320         <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
7321         addition to the syntax understood by curl, it is possible to specify a
7322         proxy string with a user name but no password, in which case git will
7323         attempt to acquire one in the same way it does for other credentials. See
7324         <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
7325         <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
7326         on a per-remote basis; see remote.&lt;name&gt;.proxy
7327 </p>
7328 </dd>
7329 <dt class="hdlist1">
7330 http.proxyAuthMethod
7331 </dt>
7332 <dd>
7333 <p>
7334         Set the method with which to authenticate against the HTTP proxy. This
7335         only takes effect if the configured proxy string contains a user name part
7336         (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
7337         overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
7338         Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
7339         variable.  Possible values are:
7340 </p>
7341 <div class="openblock">
7342 <div class="content">
7343 <div class="ulist"><ul>
7344 <li>
7345 <p>
7346 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
7347   assumed that the proxy answers an unauthenticated request with a 407
7348   status code and one or more Proxy-authenticate headers with supported
7349   authentication methods. This is the default.
7350 </p>
7351 </li>
7352 <li>
7353 <p>
7354 <code>basic</code> - HTTP Basic authentication
7355 </p>
7356 </li>
7357 <li>
7358 <p>
7359 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
7360   transmitted to the proxy in clear text
7361 </p>
7362 </li>
7363 <li>
7364 <p>
7365 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7366   of <code>curl(1)</code>)
7367 </p>
7368 </li>
7369 <li>
7370 <p>
7371 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7372 </p>
7373 </li>
7374 </ul></div>
7375 </div></div>
7376 </dd>
7377 <dt class="hdlist1">
7378 http.proxySSLCert
7379 </dt>
7380 <dd>
7381 <p>
7382         The pathname of a file that stores a client certificate to use to authenticate
7383         with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7384         variable.
7385 </p>
7386 </dd>
7387 <dt class="hdlist1">
7388 http.proxySSLKey
7389 </dt>
7390 <dd>
7391 <p>
7392         The pathname of a file that stores a private key to use to authenticate with
7393         an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7394         variable.
7395 </p>
7396 </dd>
7397 <dt class="hdlist1">
7398 http.proxySSLCertPasswordProtected
7399 </dt>
7400 <dd>
7401 <p>
7402         Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
7403         will prompt the user, possibly many times, if the certificate or private key
7404         is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7405         environment variable.
7406 </p>
7407 </dd>
7408 <dt class="hdlist1">
7409 http.proxySSLCAInfo
7410 </dt>
7411 <dd>
7412 <p>
7413         Pathname to the file containing the certificate bundle that should be used to
7414         verify the proxy with when using an HTTPS proxy. Can be overridden by the
7415         <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7416 </p>
7417 </dd>
7418 <dt class="hdlist1">
7419 http.emptyAuth
7420 </dt>
7421 <dd>
7422 <p>
7423         Attempt authentication without seeking a username or password.  This
7424         can be used to attempt GSS-Negotiate authentication without specifying
7425         a username in the URL, as libcurl normally requires a username for
7426         authentication.
7427 </p>
7428 </dd>
7429 <dt class="hdlist1">
7430 http.delegation
7431 </dt>
7432 <dd>
7433 <p>
7434         Control GSSAPI credential delegation. The delegation is disabled
7435         by default in libcurl since version 7.21.7. Set parameter to tell
7436         the server what it is allowed to delegate when it comes to user
7437         credentials. Used with GSS/kerberos. Possible values are:
7438 </p>
7439 <div class="openblock">
7440 <div class="content">
7441 <div class="ulist"><ul>
7442 <li>
7443 <p>
7444 <code>none</code> - Don&#8217;t allow any delegation.
7445 </p>
7446 </li>
7447 <li>
7448 <p>
7449 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7450   Kerberos service ticket, which is a matter of realm policy.
7451 </p>
7452 </li>
7453 <li>
7454 <p>
7455 <code>always</code> - Unconditionally allow the server to delegate.
7456 </p>
7457 </li>
7458 </ul></div>
7459 </div></div>
7460 </dd>
7461 <dt class="hdlist1">
7462 http.extraHeader
7463 </dt>
7464 <dd>
7465 <p>
7466         Pass an additional HTTP header when communicating with a server.  If
7467         more than one such entry exists, all of them are added as extra
7468         headers.  To allow overriding the settings inherited from the system
7469         config, an empty value will reset the extra headers to the empty list.
7470 </p>
7471 </dd>
7472 <dt class="hdlist1">
7473 http.cookieFile
7474 </dt>
7475 <dd>
7476 <p>
7477         The pathname of a file containing previously stored cookie lines,
7478         which should be used
7479         in the Git http session, if they match the server. The file format
7480         of the file to read cookies from should be plain HTTP headers or
7481         the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7482         NOTE that the file specified with http.cookieFile is used only as
7483         input unless http.saveCookies is set.
7484 </p>
7485 </dd>
7486 <dt class="hdlist1">
7487 http.saveCookies
7488 </dt>
7489 <dd>
7490 <p>
7491         If set, store cookies received during requests to the file specified by
7492         http.cookieFile. Has no effect if http.cookieFile is unset.
7493 </p>
7494 </dd>
7495 <dt class="hdlist1">
7496 http.version
7497 </dt>
7498 <dd>
7499 <p>
7500         Use the specified HTTP protocol version when communicating with a server.
7501         If you want to force the default. The available and default version depend
7502         on libcurl. Currently the possible values of
7503         this option are:
7504 </p>
7505 <div class="ulist"><ul>
7506 <li>
7507 <p>
7508 HTTP/2
7509 </p>
7510 </li>
7511 <li>
7512 <p>
7513 HTTP/1.1
7514 </p>
7515 </li>
7516 </ul></div>
7517 </dd>
7518 <dt class="hdlist1">
7519 http.curloptResolve
7520 </dt>
7521 <dd>
7522 <p>
7523         Hostname resolution information that will be used first by
7524         libcurl when sending HTTP requests.  This information should
7525         be in one of the following formats:
7526 </p>
7527 <div class="ulist"><ul>
7528 <li>
7529 <p>
7530 [+]HOST:PORT:ADDRESS[,ADDRESS]
7531 </p>
7532 </li>
7533 <li>
7534 <p>
7535 -HOST:PORT
7536 </p>
7537 </li>
7538 </ul></div>
7539 <div class="paragraph"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7540 to the provided <code>ADDRESS</code>(s). The second format clears all
7541 previous config values for that <code>HOST:PORT</code> combination.  To
7542 allow easy overriding of all the settings inherited from the
7543 system config, an empty value will reset all resolution
7544 information to the empty list.</p></div>
7545 </dd>
7546 <dt class="hdlist1">
7547 http.sslVersion
7548 </dt>
7549 <dd>
7550 <p>
7551         The SSL version to use when negotiating an SSL connection, if you
7552         want to force the default.  The available and default version
7553         depend on whether libcurl was built against NSS or OpenSSL and the
7554         particular configuration of the crypto library in use. Internally
7555         this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7556         documentation for more details on the format of this option and
7557         for the ssl version supported. Currently the possible values of
7558         this option are:
7559 </p>
7560 <div class="ulist"><ul>
7561 <li>
7562 <p>
7563 sslv2
7564 </p>
7565 </li>
7566 <li>
7567 <p>
7568 sslv3
7569 </p>
7570 </li>
7571 <li>
7572 <p>
7573 tlsv1
7574 </p>
7575 </li>
7576 <li>
7577 <p>
7578 tlsv1.0
7579 </p>
7580 </li>
7581 <li>
7582 <p>
7583 tlsv1.1
7584 </p>
7585 </li>
7586 <li>
7587 <p>
7588 tlsv1.2
7589 </p>
7590 </li>
7591 <li>
7592 <p>
7593 tlsv1.3
7594 </p>
7595 </li>
7596 </ul></div>
7597 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7598 To force git to use libcurl&#8217;s default ssl version and ignore any
7599 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7600 empty string.</p></div>
7601 </dd>
7602 <dt class="hdlist1">
7603 http.sslCipherList
7604 </dt>
7605 <dd>
7606 <p>
7607   A list of SSL ciphers to use when negotiating an SSL connection.
7608   The available ciphers depend on whether libcurl was built against
7609   NSS or OpenSSL and the particular configuration of the crypto
7610   library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7611   option; see the libcurl documentation for more details on the format
7612   of this list.
7613 </p>
7614 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7615 To force git to use libcurl&#8217;s default cipher list and ignore any
7616 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7617 empty string.</p></div>
7618 </dd>
7619 <dt class="hdlist1">
7620 http.sslVerify
7621 </dt>
7622 <dd>
7623 <p>
7624         Whether to verify the SSL certificate when fetching or pushing
7625         over HTTPS. Defaults to true. Can be overridden by the
7626         <code>GIT_SSL_NO_VERIFY</code> environment variable.
7627 </p>
7628 </dd>
7629 <dt class="hdlist1">
7630 http.sslCert
7631 </dt>
7632 <dd>
7633 <p>
7634         File containing the SSL certificate when fetching or pushing
7635         over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7636         variable.
7637 </p>
7638 </dd>
7639 <dt class="hdlist1">
7640 http.sslKey
7641 </dt>
7642 <dd>
7643 <p>
7644         File containing the SSL private key when fetching or pushing
7645         over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7646         variable.
7647 </p>
7648 </dd>
7649 <dt class="hdlist1">
7650 http.sslCertPasswordProtected
7651 </dt>
7652 <dd>
7653 <p>
7654         Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
7655         OpenSSL will prompt the user, possibly many times, if the
7656         certificate or private key is encrypted.  Can be overridden by the
7657         <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7658 </p>
7659 </dd>
7660 <dt class="hdlist1">
7661 http.sslCAInfo
7662 </dt>
7663 <dd>
7664 <p>
7665         File containing the certificates to verify the peer with when
7666         fetching or pushing over HTTPS. Can be overridden by the
7667         <code>GIT_SSL_CAINFO</code> environment variable.
7668 </p>
7669 </dd>
7670 <dt class="hdlist1">
7671 http.sslCAPath
7672 </dt>
7673 <dd>
7674 <p>
7675         Path containing files with the CA certificates to verify the peer
7676         with when fetching or pushing over HTTPS. Can be overridden
7677         by the <code>GIT_SSL_CAPATH</code> environment variable.
7678 </p>
7679 </dd>
7680 <dt class="hdlist1">
7681 http.sslBackend
7682 </dt>
7683 <dd>
7684 <p>
7685         Name of the SSL backend to use (e.g. "openssl" or "schannel").
7686         This option is ignored if cURL lacks support for choosing the SSL
7687         backend at runtime.
7688 </p>
7689 </dd>
7690 <dt class="hdlist1">
7691 http.schannelCheckRevoke
7692 </dt>
7693 <dd>
7694 <p>
7695         Used to enforce or disable certificate revocation checks in cURL
7696         when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
7697         unset. Only necessary to disable this if Git consistently errors
7698         and the message is about checking the revocation status of a
7699         certificate. This option is ignored if cURL lacks support for
7700         setting the relevant SSL option at runtime.
7701 </p>
7702 </dd>
7703 <dt class="hdlist1">
7704 http.schannelUseSSLCAInfo
7705 </dt>
7706 <dd>
7707 <p>
7708         As of cURL v7.60.0, the Secure Channel backend can use the
7709         certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7710         override the Windows Certificate Store. Since this is not desirable
7711         by default, Git will tell cURL not to use that bundle by default
7712         when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7713         unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7714 </p>
7715 </dd>
7716 <dt class="hdlist1">
7717 http.pinnedPubkey
7718 </dt>
7719 <dd>
7720 <p>
7721         Public key of the https service. It may either be the filename of
7722         a PEM or DER encoded public key file or a string starting with
7723         <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7724         public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7725         exit with an error if this option is set but not supported by
7726         cURL.
7727 </p>
7728 </dd>
7729 <dt class="hdlist1">
7730 http.sslTry
7731 </dt>
7732 <dd>
7733 <p>
7734         Attempt to use AUTH SSL/TLS and encrypted data transfers
7735         when connecting via regular FTP protocol. This might be needed
7736         if the FTP server requires it for security reasons or you wish
7737         to connect securely whenever remote FTP server supports it.
7738         Default is false since it might trigger certificate verification
7739         errors on misconfigured servers.
7740 </p>
7741 </dd>
7742 <dt class="hdlist1">
7743 http.maxRequests
7744 </dt>
7745 <dd>
7746 <p>
7747         How many HTTP requests to launch in parallel. Can be overridden
7748         by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7749 </p>
7750 </dd>
7751 <dt class="hdlist1">
7752 http.minSessions
7753 </dt>
7754 <dd>
7755 <p>
7756         The number of curl sessions (counted across slots) to be kept across
7757         requests. They will not be ended with curl_easy_cleanup() until
7758         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7759         value will be capped at 1. Defaults to 1.
7760 </p>
7761 </dd>
7762 <dt class="hdlist1">
7763 http.postBuffer
7764 </dt>
7765 <dd>
7766 <p>
7767         Maximum size in bytes of the buffer used by smart HTTP
7768         transports when POSTing data to the remote system.
7769         For requests larger than this buffer size, HTTP/1.1 and
7770         Transfer-Encoding: chunked is used to avoid creating a
7771         massive pack file locally.  Default is 1 MiB, which is
7772         sufficient for most requests.
7773 </p>
7774 <div class="paragraph"><p>Note that raising this limit is only effective for disabling chunked
7775 transfer encoding and therefore should be used only where the remote
7776 server or a proxy only supports HTTP/1.0 or is noncompliant with the
7777 HTTP standard.  Raising this is not, in general, an effective solution
7778 for most push problems, but can increase memory consumption
7779 significantly since the entire buffer is allocated even for small
7780 pushes.</p></div>
7781 </dd>
7782 <dt class="hdlist1">
7783 http.lowSpeedLimit, http.lowSpeedTime
7784 </dt>
7785 <dd>
7786 <p>
7787         If the HTTP transfer speed, in bytes per second, is less than
7788         <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
7789         the transfer is aborted.
7790         Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
7791         <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
7792 </p>
7793 </dd>
7794 <dt class="hdlist1">
7795 http.noEPSV
7796 </dt>
7797 <dd>
7798 <p>
7799         A boolean which disables using of EPSV ftp command by curl.
7800         This can be helpful with some "poor" ftp servers which don&#8217;t
7801         support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
7802         environment variable. Default is false (curl will use EPSV).
7803 </p>
7804 </dd>
7805 <dt class="hdlist1">
7806 http.userAgent
7807 </dt>
7808 <dd>
7809 <p>
7810         The HTTP USER_AGENT string presented to an HTTP server.  The default
7811         value represents the version of the Git client such as git/1.7.1.
7812         This option allows you to override this value to a more common value
7813         such as Mozilla/4.0.  This may be necessary, for instance, if
7814         connecting through a firewall that restricts HTTP connections to a set
7815         of common USER_AGENT strings (but not including those like git/1.7.1).
7816         Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
7817 </p>
7818 </dd>
7819 <dt class="hdlist1">
7820 http.followRedirects
7821 </dt>
7822 <dd>
7823 <p>
7824         Whether git should follow HTTP redirects. If set to <code>true</code>, git
7825         will transparently follow any redirect issued by a server it
7826         encounters. If set to <code>false</code>, git will treat all redirects as
7827         errors. If set to <code>initial</code>, git will follow redirects only for
7828         the initial request to a remote, but not for subsequent
7829         follow-up HTTP requests. Since git uses the redirected URL as
7830         the base for the follow-up requests, this is generally
7831         sufficient. The default is <code>initial</code>.
7832 </p>
7833 </dd>
7834 <dt class="hdlist1">
7835 http.&lt;url&gt;.*
7836 </dt>
7837 <dd>
7838 <p>
7839         Any of the http.* options above can be applied selectively to some URLs.
7840         For a config key to match a URL, each element of the config key is
7841         compared to that of the URL, in the following order:
7842 </p>
7843 <div class="openblock">
7844 <div class="content">
7845 <div class="olist arabic"><ol class="arabic">
7846 <li>
7847 <p>
7848 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
7849   must match exactly between the config key and the URL.
7850 </p>
7851 </li>
7852 <li>
7853 <p>
7854 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
7855   This field must match between the config key and the URL. It is
7856   possible to specify a <code>*</code> as part of the host name to match all subdomains
7857   at this level. <code>https://*.example.com/</code> for example would match
7858   <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
7859 </p>
7860 </li>
7861 <li>
7862 <p>
7863 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
7864   This field must match exactly between the config key and the URL.
7865   Omitted port numbers are automatically converted to the correct
7866   default for the scheme before matching.
7867 </p>
7868 </li>
7869 <li>
7870 <p>
7871 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
7872   path field of the config key must match the path field of the URL
7873   either exactly or as a prefix of slash-delimited path elements.  This means
7874   a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
7875   match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
7876   key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
7877   key with just path <code>foo/</code>).
7878 </p>
7879 </li>
7880 <li>
7881 <p>
7882 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
7883   the config key has a user name it must match the user name in the
7884   URL exactly. If the config key does not have a user name, that
7885   config key will match a URL with any user name (including none),
7886   but at a lower precedence than a config key with a user name.
7887 </p>
7888 </li>
7889 </ol></div>
7890 </div></div>
7891 <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
7892 a config key&#8217;s path is preferred to one that matches its user name. For example,
7893 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
7894 <code>https://example.com/foo</code> will be preferred over a config key match of
7895 <code>https://user@example.com</code>.</p></div>
7896 <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
7897 if embedded in the URL, is always ignored for matching purposes) so that
7898 equivalent URLs that are simply spelled differently will match properly.
7899 Environment variable settings always override any matches.  The URLs that are
7900 matched against are those given directly to Git commands.  This means any URLs
7901 visited as a result of a redirection do not participate in matching.</p></div>
7902 </dd>
7903 <dt class="hdlist1">
7904 i18n.commitEncoding
7905 </dt>
7906 <dd>
7907 <p>
7908         Character encoding the commit messages are stored in; Git itself
7909         does not care per se, but this information is necessary e.g. when
7910         importing commits from emails or in the gitk graphical history
7911         browser (and possibly in other places in the future or in other
7912         porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
7913 </p>
7914 </dd>
7915 <dt class="hdlist1">
7916 i18n.logOutputEncoding
7917 </dt>
7918 <dd>
7919 <p>
7920         Character encoding the commit messages are converted to when
7921         running <em>git log</em> and friends.
7922 </p>
7923 </dd>
7924 <dt class="hdlist1">
7925 imap.folder
7926 </dt>
7927 <dd>
7928 <p>
7929         The folder to drop the mails into, which is typically the Drafts
7930         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
7931         "[Gmail]/Drafts". Required.
7932 </p>
7933 </dd>
7934 <dt class="hdlist1">
7935 imap.tunnel
7936 </dt>
7937 <dd>
7938 <p>
7939         Command used to set up a tunnel to the IMAP server through which
7940         commands will be piped instead of using a direct network connection
7941         to the server. Required when imap.host is not set.
7942 </p>
7943 </dd>
7944 <dt class="hdlist1">
7945 imap.host
7946 </dt>
7947 <dd>
7948 <p>
7949         A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
7950         connections and an <code>imaps://</code> prefix for secure connections.
7951         Ignored when imap.tunnel is set, but required otherwise.
7952 </p>
7953 </dd>
7954 <dt class="hdlist1">
7955 imap.user
7956 </dt>
7957 <dd>
7958 <p>
7959         The username to use when logging in to the server.
7960 </p>
7961 </dd>
7962 <dt class="hdlist1">
7963 imap.pass
7964 </dt>
7965 <dd>
7966 <p>
7967         The password to use when logging in to the server.
7968 </p>
7969 </dd>
7970 <dt class="hdlist1">
7971 imap.port
7972 </dt>
7973 <dd>
7974 <p>
7975         An integer port number to connect to on the server.
7976         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
7977         Ignored when imap.tunnel is set.
7978 </p>
7979 </dd>
7980 <dt class="hdlist1">
7981 imap.sslverify
7982 </dt>
7983 <dd>
7984 <p>
7985         A boolean to enable/disable verification of the server certificate
7986         used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
7987         imap.tunnel is set.
7988 </p>
7989 </dd>
7990 <dt class="hdlist1">
7991 imap.preformattedHTML
7992 </dt>
7993 <dd>
7994 <p>
7995         A boolean to enable/disable the use of html encoding when sending
7996         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
7997         and have a content type of text/html.  Ironically, enabling this
7998         option causes Thunderbird to send the patch as a plain/text,
7999         format=fixed email.  Default is <code>false</code>.
8000 </p>
8001 </dd>
8002 <dt class="hdlist1">
8003 imap.authMethod
8004 </dt>
8005 <dd>
8006 <p>
8007         Specify the authentication method for authenticating with the IMAP server.
8008         If Git was built with the NO_CURL option, or if your curl version is older
8009         than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
8010         option, the only supported method is <em>CRAM-MD5</em>. If this is not set
8011         then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
8012 </p>
8013 </dd>
8014 <dt class="hdlist1">
8015 include.path
8016 </dt>
8017 <dt class="hdlist1">
8018 includeIf.&lt;condition&gt;.path
8019 </dt>
8020 <dd>
8021 <p>
8022         Special variables to include other configuration files. See
8023         the "CONFIGURATION FILE" section in the main
8024         <a href="git-config.html">git-config(1)</a> documentation,
8025         specifically the "Includes" and "Conditional Includes" subsections.
8026 </p>
8027 </dd>
8028 <dt class="hdlist1">
8029 index.recordEndOfIndexEntries
8030 </dt>
8031 <dd>
8032 <p>
8033         Specifies whether the index file should include an "End Of Index
8034         Entry" section. This reduces index load time on multiprocessor
8035         machines but produces a message "ignoring EOIE extension" when
8036         reading the index using Git versions before 2.20. Defaults to
8037         <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
8038         otherwise.
8039 </p>
8040 </dd>
8041 <dt class="hdlist1">
8042 index.recordOffsetTable
8043 </dt>
8044 <dd>
8045 <p>
8046         Specifies whether the index file should include an "Index Entry
8047         Offset Table" section. This reduces index load time on
8048         multiprocessor machines but produces a message "ignoring IEOT
8049         extension" when reading the index using Git versions before 2.20.
8050         Defaults to <em>true</em> if index.threads has been explicitly enabled,
8051         <em>false</em> otherwise.
8052 </p>
8053 </dd>
8054 <dt class="hdlist1">
8055 index.sparse
8056 </dt>
8057 <dd>
8058 <p>
8059         When enabled, write the index using sparse-directory entries. This
8060         has no effect unless <code>core.sparseCheckout</code> and
8061         <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
8062 </p>
8063 </dd>
8064 <dt class="hdlist1">
8065 index.threads
8066 </dt>
8067 <dd>
8068 <p>
8069         Specifies the number of threads to spawn when loading the index.
8070         This is meant to reduce index load time on multiprocessor machines.
8071         Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
8072         CPUs and set the number of threads accordingly. Specifying 1 or
8073         <em>false</em> will disable multithreading. Defaults to <em>true</em>.
8074 </p>
8075 </dd>
8076 <dt class="hdlist1">
8077 index.version
8078 </dt>
8079 <dd>
8080 <p>
8081         Specify the version with which new index files should be
8082         initialized.  This does not affect existing repositories.
8083         If <code>feature.manyFiles</code> is enabled, then the default is 4.
8084 </p>
8085 </dd>
8086 <dt class="hdlist1">
8087 index.skipHash
8088 </dt>
8089 <dd>
8090 <p>
8091         When enabled, do not compute the trailing hash for the index file.
8092         This accelerates Git commands that manipulate the index, such as
8093         <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
8094         checksum, write a trailing set of bytes with value zero, indicating
8095         that the computation was skipped.
8096 </p>
8097 <div class="paragraph"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
8098 refuse to parse the index and Git clients older than 2.40.0 will report an
8099 error during <code>git fsck</code>.</p></div>
8100 </dd>
8101 </dl></div>
8102 <div class="dlist"><dl>
8103 <dt class="hdlist1">
8104 <code>init.templateDir</code>
8105 </dt>
8106 <dd>
8107 <p>
8108         Specify the directory from which templates will be copied. (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
8109 </p>
8110 </dd>
8111 <dt class="hdlist1">
8112 <code>init.defaultBranch</code>
8113 </dt>
8114 <dd>
8115 <p>
8116         Allows overriding the default branch name e.g. when initializing
8117         a new repository.
8118 </p>
8119 </dd>
8120 <dt class="hdlist1">
8121 instaweb.browser
8122 </dt>
8123 <dd>
8124 <p>
8125         Specify the program that will be used to browse your working
8126         repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
8127 </p>
8128 </dd>
8129 <dt class="hdlist1">
8130 instaweb.httpd
8131 </dt>
8132 <dd>
8133 <p>
8134         The HTTP daemon command-line to start gitweb on your working
8135         repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
8136 </p>
8137 </dd>
8138 <dt class="hdlist1">
8139 instaweb.local
8140 </dt>
8141 <dd>
8142 <p>
8143         If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
8144         be bound to the local IP (127.0.0.1).
8145 </p>
8146 </dd>
8147 <dt class="hdlist1">
8148 instaweb.modulePath
8149 </dt>
8150 <dd>
8151 <p>
8152         The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
8153         instead of /usr/lib/apache2/modules.  Only used if httpd
8154         is Apache.
8155 </p>
8156 </dd>
8157 <dt class="hdlist1">
8158 instaweb.port
8159 </dt>
8160 <dd>
8161 <p>
8162         The port number to bind the gitweb httpd to. See
8163         <a href="git-instaweb.html">git-instaweb(1)</a>.
8164 </p>
8165 </dd>
8166 <dt class="hdlist1">
8167 interactive.singleKey
8168 </dt>
8169 <dd>
8170 <p>
8171         In interactive commands, allow the user to provide one-letter
8172         input with a single key (i.e., without hitting enter).
8173         Currently this is used by the <code>--patch</code> mode of
8174         <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
8175         <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
8176         <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>.
8177 </p>
8178 </dd>
8179 <dt class="hdlist1">
8180 interactive.diffFilter
8181 </dt>
8182 <dd>
8183 <p>
8184         When an interactive command (such as <code>git add --patch</code>) shows
8185         a colorized diff, git will pipe the diff through the shell
8186         command defined by this configuration variable. The command may
8187         mark up the diff further for human consumption, provided that it
8188         retains a one-to-one correspondence with the lines in the
8189         original diff. Defaults to disabled (no filtering).
8190 </p>
8191 </dd>
8192 <dt class="hdlist1">
8193 log.abbrevCommit
8194 </dt>
8195 <dd>
8196 <p>
8197         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8198         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
8199         override this option with <code>--no-abbrev-commit</code>.
8200 </p>
8201 </dd>
8202 <dt class="hdlist1">
8203 log.date
8204 </dt>
8205 <dd>
8206 <p>
8207         Set the default date-time mode for the <em>log</em> command.
8208         Setting a value for log.date is similar to using <em>git log</em>'s
8209         <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.
8210 </p>
8211 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
8212 "foo" will be used for the date format. Otherwise, "default" will
8213 be used.</p></div>
8214 </dd>
8215 <dt class="hdlist1">
8216 log.decorate
8217 </dt>
8218 <dd>
8219 <p>
8220         Print out the ref names of any commits that are shown by the log
8221         command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
8222         <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
8223         specified, the full ref name (including prefix) will be printed.
8224         If <em>auto</em> is specified, then if the output is going to a terminal,
8225         the ref names are shown as if <em>short</em> were given, otherwise no ref
8226         names are shown. This is the same as the <code>--decorate</code> option
8227         of the <code>git log</code>.
8228 </p>
8229 </dd>
8230 <dt class="hdlist1">
8231 log.initialDecorationSet
8232 </dt>
8233 <dd>
8234 <p>
8235         By default, <code>git log</code> only shows decorations for certain known ref
8236         namespaces. If <em>all</em> is specified, then show all refs as
8237         decorations.
8238 </p>
8239 </dd>
8240 <dt class="hdlist1">
8241 log.excludeDecoration
8242 </dt>
8243 <dd>
8244 <p>
8245         Exclude the specified patterns from the log decorations. This is
8246         similar to the <code>--decorate-refs-exclude</code> command-line option, but
8247         the config option can be overridden by the <code>--decorate-refs</code>
8248         option.
8249 </p>
8250 </dd>
8251 <dt class="hdlist1">
8252 log.diffMerges
8253 </dt>
8254 <dd>
8255 <p>
8256         Set diff format to be used when <code>--diff-merges=on</code> is
8257         specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
8258         details. Defaults to <code>separate</code>.
8259 </p>
8260 </dd>
8261 <dt class="hdlist1">
8262 log.follow
8263 </dt>
8264 <dd>
8265 <p>
8266         If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
8267         a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
8268         i.e. it cannot be used to follow multiple files and does not work well
8269         on non-linear history.
8270 </p>
8271 </dd>
8272 <dt class="hdlist1">
8273 log.graphColors
8274 </dt>
8275 <dd>
8276 <p>
8277         A list of colors, separated by commas, that can be used to draw
8278         history lines in <code>git log --graph</code>.
8279 </p>
8280 </dd>
8281 <dt class="hdlist1">
8282 log.showRoot
8283 </dt>
8284 <dd>
8285 <p>
8286         If true, the initial commit will be shown as a big creation event.
8287         This is equivalent to a diff against an empty tree.
8288         Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
8289         normally hide the root commit will now show it. True by default.
8290 </p>
8291 </dd>
8292 <dt class="hdlist1">
8293 log.showSignature
8294 </dt>
8295 <dd>
8296 <p>
8297         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8298         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
8299 </p>
8300 </dd>
8301 <dt class="hdlist1">
8302 log.mailmap
8303 </dt>
8304 <dd>
8305 <p>
8306         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8307         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
8308         assume <code>--no-use-mailmap</code>. True by default.
8309 </p>
8310 </dd>
8311 <dt class="hdlist1">
8312 lsrefs.unborn
8313 </dt>
8314 <dd>
8315 <p>
8316         May be "advertise" (the default), "allow", or "ignore". If "advertise",
8317         the server will respond to the client sending "unborn" (as described in
8318         <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
8319         protocol v2 capability advertisement. "allow" is the same as
8320         "advertise" except that the server will not advertise support for this
8321         feature; this is useful for load-balanced servers that cannot be
8322         updated atomically (for example), since the administrator could
8323         configure "allow", then after a delay, configure "advertise".
8324 </p>
8325 </dd>
8326 <dt class="hdlist1">
8327 mailinfo.scissors
8328 </dt>
8329 <dd>
8330 <p>
8331         If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
8332         <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
8333         was provided on the command-line. When active, this feature
8334         removes everything from the message body before a scissors
8335         line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
8336 </p>
8337 </dd>
8338 <dt class="hdlist1">
8339 mailmap.file
8340 </dt>
8341 <dd>
8342 <p>
8343         The location of an augmenting mailmap file. The default
8344         mailmap, located in the root of the repository, is loaded
8345         first, then the mailmap file pointed to by this variable.
8346         The location of the mailmap file may be in a repository
8347         subdirectory, or somewhere outside of the repository itself.
8348         See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
8349 </p>
8350 </dd>
8351 <dt class="hdlist1">
8352 mailmap.blob
8353 </dt>
8354 <dd>
8355 <p>
8356         Like <code>mailmap.file</code>, but consider the value as a reference to a
8357         blob in the repository. If both <code>mailmap.file</code> and
8358         <code>mailmap.blob</code> are given, both are parsed, with entries from
8359         <code>mailmap.file</code> taking precedence. In a bare repository, this
8360         defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8361         defaults to empty.
8362 </p>
8363 </dd>
8364 <dt class="hdlist1">
8365 maintenance.auto
8366 </dt>
8367 <dd>
8368 <p>
8369         This boolean config option controls whether some commands run
8370         <code>git maintenance run --auto</code> after doing their normal work. Defaults
8371         to true.
8372 </p>
8373 </dd>
8374 <dt class="hdlist1">
8375 maintenance.strategy
8376 </dt>
8377 <dd>
8378 <p>
8379         This string config option provides a way to specify one of a few
8380         recommended schedules for background maintenance. This only affects
8381         which tasks are run during <code>git maintenance run --schedule=X</code>
8382         commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
8383         Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
8384         then that value is used instead of the one provided by
8385         <code>maintenance.strategy</code>. The possible strategy strings are:
8386 </p>
8387 <div class="ulist"><ul>
8388 <li>
8389 <p>
8390 <code>none</code>: This default setting implies no tasks are run at any schedule.
8391 </p>
8392 </li>
8393 <li>
8394 <p>
8395 <code>incremental</code>: This setting optimizes for performing small maintenance
8396   activities that do not delete any data. This does not schedule the <code>gc</code>
8397   task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8398   <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8399   task weekly.
8400 </p>
8401 </li>
8402 </ul></div>
8403 </dd>
8404 <dt class="hdlist1">
8405 maintenance.&lt;task&gt;.enabled
8406 </dt>
8407 <dd>
8408 <p>
8409         This boolean config option controls whether the maintenance task
8410         with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
8411         <code>git maintenance run</code>. These config values are ignored if a
8412         <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8413         is true.
8414 </p>
8415 </dd>
8416 <dt class="hdlist1">
8417 maintenance.&lt;task&gt;.schedule
8418 </dt>
8419 <dd>
8420 <p>
8421         This config option controls whether or not the given <code>&lt;task&gt;</code> runs
8422         during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
8423         value must be one of "hourly", "daily", or "weekly".
8424 </p>
8425 </dd>
8426 <dt class="hdlist1">
8427 maintenance.commit-graph.auto
8428 </dt>
8429 <dd>
8430 <p>
8431         This integer config option controls how often the <code>commit-graph</code> task
8432         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8433         the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8434         negative value will force the task to run every time. Otherwise, a
8435         positive value implies the command should run when the number of
8436         reachable commits that are not in the commit-graph file is at least
8437         the value of <code>maintenance.commit-graph.auto</code>. The default value is
8438         100.
8439 </p>
8440 </dd>
8441 <dt class="hdlist1">
8442 maintenance.loose-objects.auto
8443 </dt>
8444 <dd>
8445 <p>
8446         This integer config option controls how often the <code>loose-objects</code> task
8447         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8448         the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8449         negative value will force the task to run every time. Otherwise, a
8450         positive value implies the command should run when the number of
8451         loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8452         The default value is 100.
8453 </p>
8454 </dd>
8455 <dt class="hdlist1">
8456 maintenance.incremental-repack.auto
8457 </dt>
8458 <dd>
8459 <p>
8460         This integer config option controls how often the <code>incremental-repack</code>
8461         task should be run as part of <code>git maintenance run --auto</code>. If zero,
8462         then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8463         option. A negative value will force the task to run every time.
8464         Otherwise, a positive value implies the command should run when the
8465         number of pack-files not in the multi-pack-index is at least the value
8466         of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8467 </p>
8468 </dd>
8469 <dt class="hdlist1">
8470 man.viewer
8471 </dt>
8472 <dd>
8473 <p>
8474         Specify the programs that may be used to display help in the
8475         <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8476 </p>
8477 </dd>
8478 <dt class="hdlist1">
8479 man.&lt;tool&gt;.cmd
8480 </dt>
8481 <dd>
8482 <p>
8483         Specify the command to invoke the specified man viewer. The
8484         specified command is evaluated in shell with the man page
8485         passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)
8486 </p>
8487 </dd>
8488 <dt class="hdlist1">
8489 man.&lt;tool&gt;.path
8490 </dt>
8491 <dd>
8492 <p>
8493         Override the path for the given tool that may be used to
8494         display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8495 </p>
8496 </dd>
8497 <dt class="hdlist1">
8498 merge.conflictStyle
8499 </dt>
8500 <dd>
8501 <p>
8502         Specify the style in which conflicted hunks are written out to
8503         working tree files upon merge.  The default is "merge", which
8504         shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
8505         a <code>=======</code> marker, changes made by the other side, and then
8506         a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
8507         marker and the original text before the <code>=======</code> marker.  The
8508         "merge" style tends to produce smaller conflict regions than diff3,
8509         both because of the exclusion of the original text, and because
8510         when a subset of lines match on the two sides, they are just pulled
8511         out of the conflict region.  Another alternate style, "zdiff3", is
8512         similar to diff3 but removes matching lines on the two sides from
8513         the conflict region when those matching lines appear near either
8514         the beginning or end of a conflict region.
8515 </p>
8516 </dd>
8517 <dt class="hdlist1">
8518 merge.defaultToUpstream
8519 </dt>
8520 <dd>
8521 <p>
8522         If merge is called without any commit argument, merge the upstream
8523         branches configured for the current branch by using their last
8524         observed values stored in their remote-tracking branches.
8525         The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
8526         branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
8527         are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
8528         to their corresponding remote-tracking branches, and the tips of
8529         these tracking branches are merged. Defaults to true.
8530 </p>
8531 </dd>
8532 <dt class="hdlist1">
8533 merge.ff
8534 </dt>
8535 <dd>
8536 <p>
8537         By default, Git does not create an extra merge commit when merging
8538         a commit that is a descendant of the current commit. Instead, the
8539         tip of the current branch is fast-forwarded. When set to <code>false</code>,
8540         this variable tells Git to create an extra merge commit in such
8541         a case (equivalent to giving the <code>--no-ff</code> option from the command
8542         line). When set to <code>only</code>, only such fast-forward merges are
8543         allowed (equivalent to giving the <code>--ff-only</code> option from the
8544         command line).
8545 </p>
8546 </dd>
8547 <dt class="hdlist1">
8548 merge.verifySignatures
8549 </dt>
8550 <dd>
8551 <p>
8552         If true, this is equivalent to the --verify-signatures command
8553         line option. See <a href="git-merge.html">git-merge(1)</a> for details.
8554 </p>
8555 </dd>
8556 <dt class="hdlist1">
8557 merge.branchdesc
8558 </dt>
8559 <dd>
8560 <p>
8561         In addition to branch names, populate the log message with
8562         the branch description text associated with them.  Defaults
8563         to false.
8564 </p>
8565 </dd>
8566 <dt class="hdlist1">
8567 merge.log
8568 </dt>
8569 <dd>
8570 <p>
8571         In addition to branch names, populate the log message with at
8572         most the specified number of one-line descriptions from the
8573         actual commits that are being merged.  Defaults to false, and
8574         true is a synonym for 20.
8575 </p>
8576 </dd>
8577 <dt class="hdlist1">
8578 merge.suppressDest
8579 </dt>
8580 <dd>
8581 <p>
8582         By adding a glob that matches the names of integration
8583         branches to this multi-valued configuration variable, the
8584         default merge message computed for merges into these
8585         integration branches will omit "into &lt;branch name&gt;" from
8586         its title.
8587 </p>
8588 <div class="paragraph"><p>An element with an empty value can be used to clear the list
8589 of globs accumulated from previous configuration entries.
8590 When there is no <code>merge.suppressDest</code> variable defined, the
8591 default value of <code>master</code> is used for backward compatibility.</p></div>
8592 </dd>
8593 <dt class="hdlist1">
8594 merge.renameLimit
8595 </dt>
8596 <dd>
8597 <p>
8598         The number of files to consider in the exhaustive portion of
8599         rename detection during a merge.  If not specified, defaults
8600         to the value of diff.renameLimit.  If neither
8601         merge.renameLimit nor diff.renameLimit are specified,
8602         currently defaults to 7000.  This setting has no effect if
8603         rename detection is turned off.
8604 </p>
8605 </dd>
8606 <dt class="hdlist1">
8607 merge.renames
8608 </dt>
8609 <dd>
8610 <p>
8611         Whether Git detects renames.  If set to "false", rename detection
8612         is disabled. If set to "true", basic rename detection is enabled.
8613         Defaults to the value of diff.renames.
8614 </p>
8615 </dd>
8616 <dt class="hdlist1">
8617 merge.directoryRenames
8618 </dt>
8619 <dd>
8620 <p>
8621         Whether Git detects directory renames, affecting what happens at
8622         merge time to new files added to a directory on one side of
8623         history when that directory was renamed on the other side of
8624         history.  If merge.directoryRenames is set to "false", directory
8625         rename detection is disabled, meaning that such new files will be
8626         left behind in the old directory.  If set to "true", directory
8627         rename detection is enabled, meaning that such new files will be
8628         moved into the new directory.  If set to "conflict", a conflict
8629         will be reported for such paths.  If merge.renames is false,
8630         merge.directoryRenames is ignored and treated as false.  Defaults
8631         to "conflict".
8632 </p>
8633 </dd>
8634 <dt class="hdlist1">
8635 merge.renormalize
8636 </dt>
8637 <dd>
8638 <p>
8639         Tell Git that canonical representation of files in the
8640         repository has changed over time (e.g. earlier commits record
8641         text files with CRLF line endings, but recent ones use LF line
8642         endings).  In such a repository, Git can convert the data
8643         recorded in commits to a canonical form before performing a
8644         merge to reduce unnecessary conflicts.  For more information,
8645         see section "Merging branches with differing checkin/checkout
8646         attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
8647 </p>
8648 </dd>
8649 <dt class="hdlist1">
8650 merge.stat
8651 </dt>
8652 <dd>
8653 <p>
8654         Whether to print the diffstat between ORIG_HEAD and the merge result
8655         at the end of the merge.  True by default.
8656 </p>
8657 </dd>
8658 <dt class="hdlist1">
8659 merge.autoStash
8660 </dt>
8661 <dd>
8662 <p>
8663         When set to true, automatically create a temporary stash entry
8664         before the operation begins, and apply it after the operation
8665         ends.  This means that you can run merge on a dirty worktree.
8666         However, use with care: the final stash application after a
8667         successful merge might result in non-trivial conflicts.
8668         This option can be overridden by the <code>--no-autostash</code> and
8669         <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
8670         Defaults to false.
8671 </p>
8672 </dd>
8673 <dt class="hdlist1">
8674 merge.tool
8675 </dt>
8676 <dd>
8677 <p>
8678         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
8679         The list below shows the valid built-in values.
8680         Any other value is treated as a custom merge tool and requires
8681         that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
8682 </p>
8683 </dd>
8684 <dt class="hdlist1">
8685 merge.guitool
8686 </dt>
8687 <dd>
8688 <p>
8689         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
8690         -g/--gui flag is specified. The list below shows the valid built-in values.
8691         Any other value is treated as a custom merge tool and requires that a
8692         corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.
8693 </p>
8694 <div class="dlist"><dl>
8695 <dt class="hdlist1">
8696 <code>araxis</code>
8697 </dt>
8698 <dd>
8699 <p>
8700 Use Araxis Merge (requires a graphical session)
8701 </p>
8702 </dd>
8703 <dt class="hdlist1">
8704 <code>bc</code>
8705 </dt>
8706 <dd>
8707 <p>
8708 Use Beyond Compare (requires a graphical session)
8709 </p>
8710 </dd>
8711 <dt class="hdlist1">
8712 <code>bc3</code>
8713 </dt>
8714 <dd>
8715 <p>
8716 Use Beyond Compare (requires a graphical session)
8717 </p>
8718 </dd>
8719 <dt class="hdlist1">
8720 <code>bc4</code>
8721 </dt>
8722 <dd>
8723 <p>
8724 Use Beyond Compare (requires a graphical session)
8725 </p>
8726 </dd>
8727 <dt class="hdlist1">
8728 <code>codecompare</code>
8729 </dt>
8730 <dd>
8731 <p>
8732 Use Code Compare (requires a graphical session)
8733 </p>
8734 </dd>
8735 <dt class="hdlist1">
8736 <code>deltawalker</code>
8737 </dt>
8738 <dd>
8739 <p>
8740 Use DeltaWalker (requires a graphical session)
8741 </p>
8742 </dd>
8743 <dt class="hdlist1">
8744 <code>diffmerge</code>
8745 </dt>
8746 <dd>
8747 <p>
8748 Use DiffMerge (requires a graphical session)
8749 </p>
8750 </dd>
8751 <dt class="hdlist1">
8752 <code>diffuse</code>
8753 </dt>
8754 <dd>
8755 <p>
8756 Use Diffuse (requires a graphical session)
8757 </p>
8758 </dd>
8759 <dt class="hdlist1">
8760 <code>ecmerge</code>
8761 </dt>
8762 <dd>
8763 <p>
8764 Use ECMerge (requires a graphical session)
8765 </p>
8766 </dd>
8767 <dt class="hdlist1">
8768 <code>emerge</code>
8769 </dt>
8770 <dd>
8771 <p>
8772 Use Emacs' Emerge
8773 </p>
8774 </dd>
8775 <dt class="hdlist1">
8776 <code>examdiff</code>
8777 </dt>
8778 <dd>
8779 <p>
8780 Use ExamDiff Pro (requires a graphical session)
8781 </p>
8782 </dd>
8783 <dt class="hdlist1">
8784 <code>guiffy</code>
8785 </dt>
8786 <dd>
8787 <p>
8788 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
8789 </p>
8790 </dd>
8791 <dt class="hdlist1">
8792 <code>gvimdiff</code>
8793 </dt>
8794 <dd>
8795 <p>
8796 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8797 </p>
8798 </dd>
8799 <dt class="hdlist1">
8800 <code>gvimdiff1</code>
8801 </dt>
8802 <dd>
8803 <p>
8804 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
8805 </p>
8806 </dd>
8807 <dt class="hdlist1">
8808 <code>gvimdiff2</code>
8809 </dt>
8810 <dd>
8811 <p>
8812 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
8813 </p>
8814 </dd>
8815 <dt class="hdlist1">
8816 <code>gvimdiff3</code>
8817 </dt>
8818 <dd>
8819 <p>
8820 Use gVim (requires a graphical session) where only the MERGED file is shown
8821 </p>
8822 </dd>
8823 <dt class="hdlist1">
8824 <code>kdiff3</code>
8825 </dt>
8826 <dd>
8827 <p>
8828 Use KDiff3 (requires a graphical session)
8829 </p>
8830 </dd>
8831 <dt class="hdlist1">
8832 <code>meld</code>
8833 </dt>
8834 <dd>
8835 <p>
8836 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
8837 </p>
8838 </dd>
8839 <dt class="hdlist1">
8840 <code>nvimdiff</code>
8841 </dt>
8842 <dd>
8843 <p>
8844 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8845 </p>
8846 </dd>
8847 <dt class="hdlist1">
8848 <code>nvimdiff1</code>
8849 </dt>
8850 <dd>
8851 <p>
8852 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
8853 </p>
8854 </dd>
8855 <dt class="hdlist1">
8856 <code>nvimdiff2</code>
8857 </dt>
8858 <dd>
8859 <p>
8860 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8861 </p>
8862 </dd>
8863 <dt class="hdlist1">
8864 <code>nvimdiff3</code>
8865 </dt>
8866 <dd>
8867 <p>
8868 Use Neovim where only the MERGED file is shown
8869 </p>
8870 </dd>
8871 <dt class="hdlist1">
8872 <code>opendiff</code>
8873 </dt>
8874 <dd>
8875 <p>
8876 Use FileMerge (requires a graphical session)
8877 </p>
8878 </dd>
8879 <dt class="hdlist1">
8880 <code>p4merge</code>
8881 </dt>
8882 <dd>
8883 <p>
8884 Use HelixCore P4Merge (requires a graphical session)
8885 </p>
8886 </dd>
8887 <dt class="hdlist1">
8888 <code>smerge</code>
8889 </dt>
8890 <dd>
8891 <p>
8892 Use Sublime Merge (requires a graphical session)
8893 </p>
8894 </dd>
8895 <dt class="hdlist1">
8896 <code>tkdiff</code>
8897 </dt>
8898 <dd>
8899 <p>
8900 Use TkDiff (requires a graphical session)
8901 </p>
8902 </dd>
8903 <dt class="hdlist1">
8904 <code>tortoisemerge</code>
8905 </dt>
8906 <dd>
8907 <p>
8908 Use TortoiseMerge (requires a graphical session)
8909 </p>
8910 </dd>
8911 <dt class="hdlist1">
8912 <code>vimdiff</code>
8913 </dt>
8914 <dd>
8915 <p>
8916 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8917 </p>
8918 </dd>
8919 <dt class="hdlist1">
8920 <code>vimdiff1</code>
8921 </dt>
8922 <dd>
8923 <p>
8924 Use Vim with a 2 panes layout (LOCAL and REMOTE)
8925 </p>
8926 </dd>
8927 <dt class="hdlist1">
8928 <code>vimdiff2</code>
8929 </dt>
8930 <dd>
8931 <p>
8932 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8933 </p>
8934 </dd>
8935 <dt class="hdlist1">
8936 <code>vimdiff3</code>
8937 </dt>
8938 <dd>
8939 <p>
8940 Use Vim where only the MERGED file is shown
8941 </p>
8942 </dd>
8943 <dt class="hdlist1">
8944 <code>winmerge</code>
8945 </dt>
8946 <dd>
8947 <p>
8948 Use WinMerge (requires a graphical session)
8949 </p>
8950 </dd>
8951 <dt class="hdlist1">
8952 <code>xxdiff</code>
8953 </dt>
8954 <dd>
8955 <p>
8956 Use xxdiff (requires a graphical session)
8957 </p>
8958 </dd>
8959 </dl></div>
8960 </dd>
8961 <dt class="hdlist1">
8962 merge.verbosity
8963 </dt>
8964 <dd>
8965 <p>
8966         Controls the amount of output shown by the recursive merge
8967         strategy.  Level 0 outputs nothing except a final error
8968         message if conflicts were detected. Level 1 outputs only
8969         conflicts, 2 outputs conflicts and file changes.  Level 5 and
8970         above outputs debugging information.  The default is level 2.
8971         Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
8972 </p>
8973 </dd>
8974 <dt class="hdlist1">
8975 merge.&lt;driver&gt;.name
8976 </dt>
8977 <dd>
8978 <p>
8979         Defines a human-readable name for a custom low-level
8980         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8981 </p>
8982 </dd>
8983 <dt class="hdlist1">
8984 merge.&lt;driver&gt;.driver
8985 </dt>
8986 <dd>
8987 <p>
8988         Defines the command that implements a custom low-level
8989         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8990 </p>
8991 </dd>
8992 <dt class="hdlist1">
8993 merge.&lt;driver&gt;.recursive
8994 </dt>
8995 <dd>
8996 <p>
8997         Names a low-level merge driver to be used when
8998         performing an internal merge between common ancestors.
8999         See <a href="gitattributes.html">gitattributes(5)</a> for details.
9000 </p>
9001 </dd>
9002 <dt class="hdlist1">
9003 mergetool.&lt;tool&gt;.path
9004 </dt>
9005 <dd>
9006 <p>
9007         Override the path for the given tool.  This is useful in case
9008         your tool is not in the PATH.
9009 </p>
9010 </dd>
9011 <dt class="hdlist1">
9012 mergetool.&lt;tool&gt;.cmd
9013 </dt>
9014 <dd>
9015 <p>
9016         Specify the command to invoke the specified merge tool.  The
9017         specified command is evaluated in shell with the following
9018         variables available: <em>BASE</em> is the name of a temporary file
9019         containing the common base of the files to be merged, if available;
9020         <em>LOCAL</em> is the name of a temporary file containing the contents of
9021         the file on the current branch; <em>REMOTE</em> is the name of a temporary
9022         file containing the contents of the file from the branch being
9023         merged; <em>MERGED</em> contains the name of the file to which the merge
9024         tool should write the results of a successful merge.
9025 </p>
9026 </dd>
9027 <dt class="hdlist1">
9028 mergetool.&lt;tool&gt;.hideResolved
9029 </dt>
9030 <dd>
9031 <p>
9032         Allows the user to override the global <code>mergetool.hideResolved</code> value
9033         for a specific tool. See <code>mergetool.hideResolved</code> for the full
9034         description.
9035 </p>
9036 </dd>
9037 <dt class="hdlist1">
9038 mergetool.&lt;tool&gt;.trustExitCode
9039 </dt>
9040 <dd>
9041 <p>
9042         For a custom merge command, specify whether the exit code of
9043         the merge command can be used to determine whether the merge was
9044         successful.  If this is not set to true then the merge target file
9045         timestamp is checked, and the merge is assumed to have been successful
9046         if the file has been updated; otherwise, the user is prompted to
9047         indicate the success of the merge.
9048 </p>
9049 </dd>
9050 <dt class="hdlist1">
9051 mergetool.meld.hasOutput
9052 </dt>
9053 <dd>
9054 <p>
9055         Older versions of <code>meld</code> do not support the <code>--output</code> option.
9056         Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
9057         by inspecting the output of <code>meld --help</code>.  Configuring
9058         <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
9059         use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
9060         to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
9061         and <code>false</code> avoids using <code>--output</code>.
9062 </p>
9063 </dd>
9064 <dt class="hdlist1">
9065 mergetool.meld.useAutoMerge
9066 </dt>
9067 <dd>
9068 <p>
9069         When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
9070         parts automatically, highlight the conflicting parts, and wait for
9071         user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
9072         Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
9073         Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
9074         is supported and will only use <code>--auto-merge</code> when available.  A
9075         value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
9076         default value.
9077 </p>
9078 </dd>
9079 <dt class="hdlist1">
9080 mergetool.&lt;vimdiff variant&gt;.layout
9081 </dt>
9082 <dd>
9083 <p>
9084         Configure the split window layout for vimdiff&#8217;s <code>&lt;variant&gt;</code>, which is any of <code>vimdiff</code>,
9085         <code>nvimdiff</code>, <code>gvimdiff</code>.
9086         Upon launching <code>git mergetool</code> with <code>--tool=&lt;variant&gt;</code> (or without <code>--tool</code>
9087         if <code>merge.tool</code> is configured as <code>&lt;variant&gt;</code>), Git will consult
9088         <code>mergetool.&lt;variant&gt;.layout</code> to determine the tool&#8217;s layout. If the
9089         variant-specific configuration is not available, <code>vimdiff</code>'s is used as
9090         fallback.  If that too is not available, a default layout with 4 windows
9091         will be used.  To configure the layout, see the <code>BACKEND SPECIFIC HINTS</code>
9092         section in <a href="git-mergetool.html">git-mergetool(1)</a>.
9093 </p>
9094 </dd>
9095 <dt class="hdlist1">
9096 mergetool.hideResolved
9097 </dt>
9098 <dd>
9099 <p>
9100         During a merge, Git will automatically resolve as many conflicts as
9101         possible and write the <em>MERGED</em> file containing conflict markers around
9102         any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
9103         represent the versions of the file from before Git&#8217;s conflict
9104         resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
9105         that only the unresolved conflicts are presented to the merge tool. Can
9106         be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
9107         configuration variable. Defaults to <code>false</code>.
9108 </p>
9109 </dd>
9110 <dt class="hdlist1">
9111 mergetool.keepBackup
9112 </dt>
9113 <dd>
9114 <p>
9115         After performing a merge, the original file with conflict markers
9116         can be saved as a file with a <code>.orig</code> extension.  If this variable
9117         is set to <code>false</code> then this file is not preserved.  Defaults to
9118         <code>true</code> (i.e. keep the backup files).
9119 </p>
9120 </dd>
9121 <dt class="hdlist1">
9122 mergetool.keepTemporaries
9123 </dt>
9124 <dd>
9125 <p>
9126         When invoking a custom merge tool, Git uses a set of temporary
9127         files to pass to the tool. If the tool returns an error and this
9128         variable is set to <code>true</code>, then these temporary files will be
9129         preserved; otherwise, they will be removed after the tool has
9130         exited. Defaults to <code>false</code>.
9131 </p>
9132 </dd>
9133 <dt class="hdlist1">
9134 mergetool.writeToTemp
9135 </dt>
9136 <dd>
9137 <p>
9138         Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
9139         conflicting files in the worktree by default.  Git will attempt
9140         to use a temporary directory for these files when set <code>true</code>.
9141         Defaults to <code>false</code>.
9142 </p>
9143 </dd>
9144 <dt class="hdlist1">
9145 mergetool.prompt
9146 </dt>
9147 <dd>
9148 <p>
9149         Prompt before each invocation of the merge resolution program.
9150 </p>
9151 </dd>
9152 <dt class="hdlist1">
9153 mergetool.guiDefault
9154 </dt>
9155 <dd>
9156 <p>
9157         Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
9158         specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
9159         or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
9160         variable value. The default is <code>false</code>, where the <code>--gui</code> argument
9161         must be provided explicitly for the <code>merge.guitool</code> to be used.
9162 </p>
9163 </dd>
9164 <dt class="hdlist1">
9165 notes.mergeStrategy
9166 </dt>
9167 <dd>
9168 <p>
9169         Which merge strategy to choose by default when resolving notes
9170         conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
9171         <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
9172         section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
9173 </p>
9174 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
9175 <a href="git-notes.html">git-notes(1)</a>.</p></div>
9176 </dd>
9177 <dt class="hdlist1">
9178 notes.&lt;name&gt;.mergeStrategy
9179 </dt>
9180 <dd>
9181 <p>
9182         Which merge strategy to choose when doing a notes merge into
9183         refs/notes/&lt;name&gt;.  This overrides the more general
9184         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
9185         <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
9186 </p>
9187 </dd>
9188 <dt class="hdlist1">
9189 notes.displayRef
9190 </dt>
9191 <dd>
9192 <p>
9193         Which ref (or refs, if a glob or specified more than once), in
9194         addition to the default set by <code>core.notesRef</code> or
9195         <code>GIT_NOTES_REF</code>, to read notes from when showing commit
9196         messages with the <em>git log</em> family of commands.
9197 </p>
9198 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
9199 environment variable, which must be a colon separated list of refs or
9200 globs.</p></div>
9201 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
9202 but a glob that does not match any refs is silently ignored.</p></div>
9203 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
9204 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
9205 those commands.</p></div>
9206 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
9207 GIT_NOTES_REF) is also implicitly added to the list of refs to be
9208 displayed.</p></div>
9209 </dd>
9210 <dt class="hdlist1">
9211 notes.rewrite.&lt;command&gt;
9212 </dt>
9213 <dd>
9214 <p>
9215         When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
9216         <code>rebase</code>), if this variable is <code>false</code>, git will not copy
9217         notes from the original to the rewritten commit.  Defaults to
9218         <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.
9219 </p>
9220 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
9221 environment variable, which must be a colon separated list of refs or
9222 globs.</p></div>
9223 </dd>
9224 <dt class="hdlist1">
9225 notes.rewriteMode
9226 </dt>
9227 <dd>
9228 <p>
9229         When copying notes during a rewrite (see the
9230         "notes.rewrite.&lt;command&gt;" option), determines what to do if
9231         the target commit already has a note.  Must be one of
9232         <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
9233         Defaults to <code>concatenate</code>.
9234 </p>
9235 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
9236 environment variable.</p></div>
9237 </dd>
9238 <dt class="hdlist1">
9239 notes.rewriteRef
9240 </dt>
9241 <dd>
9242 <p>
9243         When copying notes during a rewrite, specifies the (fully
9244         qualified) ref whose notes should be copied.  May be a glob,
9245         in which case notes in all matching refs will be copied.  You
9246         may also specify this configuration several times.
9247 </p>
9248 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
9249 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
9250 rewriting for the default commit notes.</p></div>
9251 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
9252 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
9253 </dd>
9254 <dt class="hdlist1">
9255 pack.window
9256 </dt>
9257 <dd>
9258 <p>
9259         The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9260         window size is given on the command line. Defaults to 10.
9261 </p>
9262 </dd>
9263 <dt class="hdlist1">
9264 pack.depth
9265 </dt>
9266 <dd>
9267 <p>
9268         The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9269         maximum depth is given on the command line. Defaults to 50.
9270         Maximum value is 4095.
9271 </p>
9272 </dd>
9273 <dt class="hdlist1">
9274 pack.windowMemory
9275 </dt>
9276 <dd>
9277 <p>
9278         The maximum size of memory that is consumed by each thread
9279         in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
9280         no limit is given on the command line.  The value can be
9281         suffixed with "k", "m", or "g".  When left unconfigured (or
9282         set explicitly to 0), there will be no limit.
9283 </p>
9284 </dd>
9285 <dt class="hdlist1">
9286 pack.compression
9287 </dt>
9288 <dd>
9289 <p>
9290         An integer -1..9, indicating the compression level for objects
9291         in a pack file. -1 is the zlib default. 0 means no
9292         compression, and 1..9 are various speed/size tradeoffs, 9 being
9293         slowest.  If not set,  defaults to core.compression.  If that is
9294         not set,  defaults to -1, the zlib default, which is "a default
9295         compromise between speed and compression (currently equivalent
9296         to level 6)."
9297 </p>
9298 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
9299 all existing objects. You can force recompression by passing the -F option
9300 to <a href="git-repack.html">git-repack(1)</a>.</p></div>
9301 </dd>
9302 <dt class="hdlist1">
9303 pack.allowPackReuse
9304 </dt>
9305 <dd>
9306 <p>
9307         When true or "single", and when reachability bitmaps are
9308         enabled, pack-objects will try to send parts of the bitmapped
9309         packfile verbatim. When "multi", and when a multi-pack
9310         reachability bitmap is available, pack-objects will try to send
9311         parts of all packs in the MIDX.
9312 </p>
9313 <div class="paragraph"><p>If only a single pack bitmap is available, and <code>pack.allowPackReuse</code>
9314 is set to "multi", reuse parts of just the bitmapped packfile. This
9315 can reduce memory and CPU usage to serve fetches, but might result in
9316 sending a slightly larger pack. Defaults to true.</p></div>
9317 </dd>
9318 <dt class="hdlist1">
9319 pack.island
9320 </dt>
9321 <dd>
9322 <p>
9323         An extended regular expression configuring a set of delta
9324         islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
9325         for details.
9326 </p>
9327 </dd>
9328 <dt class="hdlist1">
9329 pack.islandCore
9330 </dt>
9331 <dd>
9332 <p>
9333         Specify an island name which gets to have its objects be
9334         packed first. This creates a kind of pseudo-pack at the front
9335         of one pack, so that the objects from the specified island are
9336         hopefully faster to copy into any pack that should be served
9337         to a user requesting these objects. In practice this means
9338         that the island specified should likely correspond to what is
9339         the most commonly cloned in the repo. See also "DELTA ISLANDS"
9340         in <a href="git-pack-objects.html">git-pack-objects(1)</a>.
9341 </p>
9342 </dd>
9343 <dt class="hdlist1">
9344 pack.deltaCacheSize
9345 </dt>
9346 <dd>
9347 <p>
9348         The maximum memory in bytes used for caching deltas in
9349         <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
9350         This cache is used to speed up the writing object phase by not
9351         having to recompute the final delta result once the best match
9352         for all objects is found.  Repacking large repositories on machines
9353         which are tight with memory might be badly impacted by this though,
9354         especially if this cache pushes the system into swapping.
9355         A value of 0 means no limit. The smallest size of 1 byte may be
9356         used to virtually disable this cache. Defaults to 256 MiB.
9357 </p>
9358 </dd>
9359 <dt class="hdlist1">
9360 pack.deltaCacheLimit
9361 </dt>
9362 <dd>
9363 <p>
9364         The maximum size of a delta, that is cached in
9365         <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
9366         writing object phase by not having to recompute the final delta
9367         result once the best match for all objects is found.
9368         Defaults to 1000. Maximum value is 65535.
9369 </p>
9370 </dd>
9371 <dt class="hdlist1">
9372 pack.threads
9373 </dt>
9374 <dd>
9375 <p>
9376         Specifies the number of threads to spawn when searching for best
9377         delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
9378         be compiled with pthreads otherwise this option is ignored with a
9379         warning. This is meant to reduce packing time on multiprocessor
9380         machines. The required amount of memory for the delta search window
9381         is however multiplied by the number of threads.
9382         Specifying 0 will cause Git to auto-detect the number of CPUs
9383         and set the number of threads accordingly.
9384 </p>
9385 </dd>
9386 <dt class="hdlist1">
9387 pack.indexVersion
9388 </dt>
9389 <dd>
9390 <p>
9391         Specify the default pack index version.  Valid values are 1 for
9392         legacy pack index used by Git versions prior to 1.5.2, and 2 for
9393         the new pack index with capabilities for packs larger than 4 GB
9394         as well as proper protection against the repacking of corrupted
9395         packs.  Version 2 is the default.  Note that version 2 is enforced
9396         and this config option is ignored whenever the corresponding pack is
9397         larger than 2 GB.
9398 </p>
9399 <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9400 cloning or fetching over a non-native protocol (e.g. "http")
9401 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9402 other side may give you a repository that cannot be accessed with your
9403 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9404 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
9405 the <code>*.idx</code> file.</p></div>
9406 </dd>
9407 <dt class="hdlist1">
9408 pack.packSizeLimit
9409 </dt>
9410 <dd>
9411 <p>
9412         The maximum size of a pack.  This setting only affects
9413         packing to a file when repacking, i.e. the git:// protocol
9414         is unaffected.  It can be overridden by the <code>--max-pack-size</code>
9415         option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
9416         in the creation of multiple packfiles.
9417 </p>
9418 <div class="paragraph"><p>Note that this option is rarely useful, and may result in a larger total
9419 on-disk size (because Git will not store deltas between packs) and
9420 worse runtime performance (object lookup within multiple packs is
9421 slower than a single pack, and optimizations like reachability bitmaps
9422 cannot cope with multiple packs).</p></div>
9423 <div class="paragraph"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9424 filesystem does not support large files), this option may help. But if
9425 your goal is to transmit a packfile over a medium that supports limited
9426 sizes (e.g., removable media that cannot store the whole repository),
9427 you are likely better off creating a single large packfile and splitting
9428 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9429 <div class="paragraph"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9430 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9431 </dd>
9432 <dt class="hdlist1">
9433 pack.useBitmaps
9434 </dt>
9435 <dd>
9436 <p>
9437         When true, git will use pack bitmaps (if available) when packing
9438         to stdout (e.g., during the server side of a fetch). Defaults to
9439         true. You should not generally need to turn this off unless
9440         you are debugging pack bitmaps.
9441 </p>
9442 </dd>
9443 <dt class="hdlist1">
9444 pack.useBitmapBoundaryTraversal
9445 </dt>
9446 <dd>
9447 <p>
9448         When true, Git will use an experimental algorithm for computing
9449         reachability queries with bitmaps. Instead of building up
9450         complete bitmaps for all of the negated tips and then OR-ing
9451         them together, consider negated tips with existing bitmaps as
9452         additive (i.e. OR-ing them into the result if they exist,
9453         ignoring them otherwise), and build up a bitmap at the boundary
9454         instead.
9455 </p>
9456 <div class="paragraph"><p>When using this algorithm, Git may include too many objects as a result
9457 of not opening up trees belonging to certain UNINTERESTING commits. This
9458 inexactness matches the non-bitmap traversal algorithm.</p></div>
9459 <div class="paragraph"><p>In many cases, this can provide a speed-up over the exact algorithm,
9460 particularly when there is poor bitmap coverage of the negated side of
9461 the query.</p></div>
9462 </dd>
9463 <dt class="hdlist1">
9464 pack.useSparse
9465 </dt>
9466 <dd>
9467 <p>
9468         When true, git will default to using the <em>--sparse</em> option in
9469         <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9470         algorithm only walks trees that appear in paths that introduce new
9471         objects. This can have significant performance benefits when
9472         computing a pack to send a small change. However, it is possible
9473         that extra objects are added to the pack-file if the included
9474         commits contain certain types of direct renames. Default is
9475         <code>true</code>.
9476 </p>
9477 </dd>
9478 <dt class="hdlist1">
9479 pack.preferBitmapTips
9480 </dt>
9481 <dd>
9482 <p>
9483         When selecting which commits will receive bitmaps, prefer a
9484         commit at the tip of any reference that is a suffix of any value
9485         of this configuration over any other commits in the "selection
9486         window".
9487 </p>
9488 <div class="paragraph"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9489 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9490 necessarily be selected. This is because commits are selected for
9491 bitmaps from within a series of windows of variable length.</p></div>
9492 <div class="paragraph"><p>If a commit at the tip of any reference which is a suffix of any value
9493 of this configuration is seen in a window, it is immediately given
9494 preference over any other commit in that window.</p></div>
9495 </dd>
9496 <dt class="hdlist1">
9497 pack.writeBitmaps (deprecated)
9498 </dt>
9499 <dd>
9500 <p>
9501         This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9502 </p>
9503 </dd>
9504 <dt class="hdlist1">
9505 pack.writeBitmapHashCache
9506 </dt>
9507 <dd>
9508 <p>
9509         When true, git will include a "hash cache" section in the bitmap
9510         index (if one is written). This cache can be used to feed git&#8217;s
9511         delta heuristics, potentially leading to better deltas between
9512         bitmapped and non-bitmapped objects (e.g., when serving a fetch
9513         between an older, bitmapped pack and objects that have been
9514         pushed since the last gc). The downside is that it consumes 4
9515         bytes per object of disk space. Defaults to true.
9516 </p>
9517 <div class="paragraph"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9518 computed; instead, any namehashes stored in an existing bitmap are
9519 permuted into their appropriate location when writing a new bitmap.</p></div>
9520 </dd>
9521 <dt class="hdlist1">
9522 pack.writeBitmapLookupTable
9523 </dt>
9524 <dd>
9525 <p>
9526         When true, Git will include a "lookup table" section in the
9527         bitmap index (if one is written). This table is used to defer
9528         loading individual bitmaps as late as possible. This can be
9529         beneficial in repositories that have relatively large bitmap
9530         indexes. Defaults to false.
9531 </p>
9532 </dd>
9533 <dt class="hdlist1">
9534 pack.readReverseIndex
9535 </dt>
9536 <dd>
9537 <p>
9538         When true, git will read any .rev file(s) that may be available
9539         (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
9540         will be generated from scratch and stored in memory. Defaults to
9541         true.
9542 </p>
9543 </dd>
9544 <dt class="hdlist1">
9545 pack.writeReverseIndex
9546 </dt>
9547 <dd>
9548 <p>
9549         When true, git will write a corresponding .rev file (see:
9550         <a href="gitformat-pack.html">gitformat-pack(5)</a>)
9551         for each new packfile that it writes in all places except for
9552         <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
9553         Defaults to true.
9554 </p>
9555 </dd>
9556 <dt class="hdlist1">
9557 pager.&lt;cmd&gt;
9558 </dt>
9559 <dd>
9560 <p>
9561         If the value is boolean, turns on or off pagination of the
9562         output of a particular Git subcommand when writing to a tty.
9563         Otherwise, turns on pagination for the subcommand using the
9564         pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
9565         or <code>--no-pager</code> is specified on the command line, it takes
9566         precedence over this option.  To disable pagination for all
9567         commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9568 </p>
9569 </dd>
9570 <dt class="hdlist1">
9571 pretty.&lt;name&gt;
9572 </dt>
9573 <dd>
9574 <p>
9575         Alias for a --pretty= format string, as specified in
9576         <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
9577         as the built-in pretty formats could. For example,
9578         running <code>git config pretty.changelog "format:* %H %s"</code>
9579         would cause the invocation <code>git log --pretty=changelog</code>
9580         to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
9581         Note that an alias with the same name as a built-in format
9582         will be silently ignored.
9583 </p>
9584 </dd>
9585 <dt class="hdlist1">
9586 promisor.quiet
9587 </dt>
9588 <dd>
9589 <p>
9590         If set to "true" assume <code>--quiet</code> when fetching additional
9591         objects for a partial clone.
9592 </p>
9593 </dd>
9594 <dt class="hdlist1">
9595 protocol.allow
9596 </dt>
9597 <dd>
9598 <p>
9599         If set, provide a user defined default policy for all protocols which
9600         don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
9601         if unset, known-safe protocols (http, https, git, ssh) have a
9602         default policy of <code>always</code>, known-dangerous protocols (ext) have a
9603         default policy of <code>never</code>, and all other protocols (including file)
9604         have a default policy of <code>user</code>.  Supported policies:
9605 </p>
9606 <div class="openblock">
9607 <div class="content">
9608 <div class="ulist"><ul>
9609 <li>
9610 <p>
9611 <code>always</code> - protocol is always able to be used.
9612 </p>
9613 </li>
9614 <li>
9615 <p>
9616 <code>never</code> - protocol is never able to be used.
9617 </p>
9618 </li>
9619 <li>
9620 <p>
9621 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9622   either unset or has a value of 1.  This policy should be used when you want a
9623   protocol to be directly usable by the user but don&#8217;t want it used by commands which
9624   execute clone/fetch/push commands without user input, e.g. recursive
9625   submodule initialization.
9626 </p>
9627 </li>
9628 </ul></div>
9629 </div></div>
9630 </dd>
9631 <dt class="hdlist1">
9632 protocol.&lt;name&gt;.allow
9633 </dt>
9634 <dd>
9635 <p>
9636         Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
9637         commands. See <code>protocol.allow</code> above for the available policies.
9638 </p>
9639 <div class="paragraph"><p>The protocol names currently used by git are:</p></div>
9640 <div class="openblock">
9641 <div class="content">
9642 <div class="ulist"><ul>
9643 <li>
9644 <p>
9645 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9646     or local paths)
9647 </p>
9648 </li>
9649 <li>
9650 <p>
9651 <code>git</code>: the anonymous git protocol over a direct TCP
9652     connection (or proxy, if configured)
9653 </p>
9654 </li>
9655 <li>
9656 <p>
9657 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9658     <code>ssh://</code>, etc).
9659 </p>
9660 </li>
9661 <li>
9662 <p>
9663 <code>http</code>: git over http, both "smart http" and "dumb http".
9664     Note that this does <em>not</em> include <code>https</code>; if you want to configure
9665     both, you must do so individually.
9666 </p>
9667 </li>
9668 <li>
9669 <p>
9670 any external helpers are named by their protocol (e.g., use
9671     <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9672 </p>
9673 </li>
9674 </ul></div>
9675 </div></div>
9676 </dd>
9677 <dt class="hdlist1">
9678 protocol.version
9679 </dt>
9680 <dd>
9681 <p>
9682         If set, clients will attempt to communicate with a server
9683         using the specified protocol version.  If the server does
9684         not support it, communication falls back to version 0.
9685         If unset, the default is <code>2</code>.
9686         Supported versions:
9687 </p>
9688 <div class="openblock">
9689 <div class="content">
9690 <div class="ulist"><ul>
9691 <li>
9692 <p>
9693 <code>0</code> - the original wire protocol.
9694 </p>
9695 </li>
9696 <li>
9697 <p>
9698 <code>1</code> - the original wire protocol with the addition of a version string
9699   in the initial response from the server.
9700 </p>
9701 </li>
9702 <li>
9703 <p>
9704 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.
9705 </p>
9706 </li>
9707 </ul></div>
9708 </div></div>
9709 </dd>
9710 <dt class="hdlist1">
9711 pull.ff
9712 </dt>
9713 <dd>
9714 <p>
9715         By default, Git does not create an extra merge commit when merging
9716         a commit that is a descendant of the current commit. Instead, the
9717         tip of the current branch is fast-forwarded. When set to <code>false</code>,
9718         this variable tells Git to create an extra merge commit in such
9719         a case (equivalent to giving the <code>--no-ff</code> option from the command
9720         line). When set to <code>only</code>, only such fast-forward merges are
9721         allowed (equivalent to giving the <code>--ff-only</code> option from the
9722         command line). This setting overrides <code>merge.ff</code> when pulling.
9723 </p>
9724 </dd>
9725 <dt class="hdlist1">
9726 pull.rebase
9727 </dt>
9728 <dd>
9729 <p>
9730         When true, rebase branches on top of the fetched branch, instead
9731         of merging the default branch from the default remote when "git
9732         pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
9733         per-branch basis.
9734 </p>
9735 <div class="paragraph"><p>When <code>merges</code> (or just <em>m</em>), pass the <code>--rebase-merges</code> option to <em>git rebase</em>
9736 so that the local merge commits are included in the rebase (see
9737 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
9738 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9739 mode.</p></div>
9740 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9741 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
9742 for details).</p></div>
9743 </dd>
9744 <dt class="hdlist1">
9745 pull.octopus
9746 </dt>
9747 <dd>
9748 <p>
9749         The default merge strategy to use when pulling multiple branches
9750         at once.
9751 </p>
9752 </dd>
9753 <dt class="hdlist1">
9754 pull.twohead
9755 </dt>
9756 <dd>
9757 <p>
9758         The default merge strategy to use when pulling a single branch.
9759 </p>
9760 </dd>
9761 <dt class="hdlist1">
9762 push.autoSetupRemote
9763 </dt>
9764 <dd>
9765 <p>
9766         If set to "true" assume <code>--set-upstream</code> on default push when no
9767         upstream tracking exists for the current branch; this option
9768         takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9769         and <em>current</em>. It is useful if by default you want new branches
9770         to be pushed to the default remote (like the behavior of
9771         <em>push.default=current</em>) and you also want the upstream tracking
9772         to be set. Workflows most likely to benefit from this option are
9773         <em>simple</em> central workflows where all branches are expected to
9774         have the same name on the remote.
9775 </p>
9776 </dd>
9777 <dt class="hdlist1">
9778 push.default
9779 </dt>
9780 <dd>
9781 <p>
9782         Defines the action <code>git push</code> should take if no refspec is
9783         given (whether from the command-line, config, or elsewhere).
9784         Different values are well-suited for
9785         specific workflows; for instance, in a purely central workflow
9786         (i.e. the fetch source is equal to the push destination),
9787         <code>upstream</code> is probably what you want.  Possible values are:
9788 </p>
9789 <div class="openblock">
9790 <div class="content">
9791 <div class="ulist"><ul>
9792 <li>
9793 <p>
9794 <code>nothing</code> - do not push anything (error out) unless a refspec is
9795   given. This is primarily meant for people who want to
9796   avoid mistakes by always being explicit.
9797 </p>
9798 </li>
9799 <li>
9800 <p>
9801 <code>current</code> - push the current branch to update a branch with the same
9802   name on the receiving end.  Works in both central and non-central
9803   workflows.
9804 </p>
9805 </li>
9806 <li>
9807 <p>
9808 <code>upstream</code> - push the current branch back to the branch whose
9809   changes are usually integrated into the current branch (which is
9810   called <code>@{upstream}</code>).  This mode only makes sense if you are
9811   pushing to the same repository you would normally pull from
9812   (i.e. central workflow).
9813 </p>
9814 </li>
9815 <li>
9816 <p>
9817 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
9818 </p>
9819 </li>
9820 <li>
9821 <p>
9822 <code>simple</code> - push the current branch with the same name on the remote.
9823 </p>
9824 <div class="paragraph"><p>If you are working on a centralized workflow (pushing to the same repository you
9825 pull from, which is typically <code>origin</code>), then you need to configure an upstream
9826 branch with the same name.</p></div>
9827 <div class="paragraph"><p>This mode is the default since Git 2.0, and is the safest option suited for
9828 beginners.</p></div>
9829 </li>
9830 <li>
9831 <p>
9832 <code>matching</code> - push all branches having the same name on both ends.
9833   This makes the repository you are pushing to remember the set of
9834   branches that will be pushed out (e.g. if you always push <em>maint</em>
9835   and <em>master</em> there and no other branches, the repository you push
9836   to will have these two branches, and your local <em>maint</em> and
9837   <em>master</em> will be pushed there).
9838 </p>
9839 <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
9840 branches you would push out are ready to be pushed out before
9841 running <em>git push</em>, as the whole point of this mode is to allow you
9842 to push all of the branches in one go.  If you usually finish work
9843 on only one branch and push out the result, while other branches are
9844 unfinished, this mode is not for you.  Also this mode is not
9845 suitable for pushing into a shared central repository, as other
9846 people may add new branches there, or update the tip of existing
9847 branches outside your control.</p></div>
9848 <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
9849 new default).</p></div>
9850 </li>
9851 </ul></div>
9852 </div></div>
9853 </dd>
9854 <dt class="hdlist1">
9855 push.followTags
9856 </dt>
9857 <dd>
9858 <p>
9859         If set to true, enable <code>--follow-tags</code> option by default.  You
9860         may override this configuration at time of push by specifying
9861         <code>--no-follow-tags</code>.
9862 </p>
9863 </dd>
9864 <dt class="hdlist1">
9865 push.gpgSign
9866 </dt>
9867 <dd>
9868 <p>
9869         May be set to a boolean value, or the string <em>if-asked</em>. A true
9870         value causes all pushes to be GPG signed, as if <code>--signed</code> is
9871         passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
9872         pushes to be signed if the server supports it, as if
9873         <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
9874         override a value from a lower-priority config file. An explicit
9875         command-line flag always overrides this config option.
9876 </p>
9877 </dd>
9878 <dt class="hdlist1">
9879 push.pushOption
9880 </dt>
9881 <dd>
9882 <p>
9883         When no <code>--push-option=&lt;option&gt;</code> argument is given from the
9884         command line, <code>git push</code> behaves as if each &lt;value&gt; of
9885         this variable is given as <code>--push-option=&lt;value&gt;</code>.
9886 </p>
9887 <div class="paragraph"><p>This is a multi-valued variable, and an empty value can be used in a
9888 higher priority configuration file (e.g. <code>.git/config</code> in a
9889 repository) to clear the values inherited from a lower priority
9890 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
9891 <div class="listingblock">
9892 <div class="content">
9893 <pre><code>Example:
9894
9895 /etc/gitconfig
9896   push.pushoption = a
9897   push.pushoption = b
9898
9899 ~/.gitconfig
9900   push.pushoption = c
9901
9902 repo/.git/config
9903   push.pushoption =
9904   push.pushoption = b
9905
9906 This will result in only b (a and c are cleared).</code></pre>
9907 </div></div>
9908 </dd>
9909 <dt class="hdlist1">
9910 push.recurseSubmodules
9911 </dt>
9912 <dd>
9913 <p>
9914         May be "check", "on-demand", "only", or "no", with the same behavior
9915         as that of "push --recurse-submodules".
9916         If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
9917         set (in which case a <em>true</em> value means <em>on-demand</em>).
9918 </p>
9919 </dd>
9920 <dt class="hdlist1">
9921 push.useForceIfIncludes
9922 </dt>
9923 <dd>
9924 <p>
9925         If set to "true", it is equivalent to specifying
9926         <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
9927         in the command line. Adding <code>--no-force-if-includes</code> at the
9928         time of push overrides this configuration setting.
9929 </p>
9930 </dd>
9931 <dt class="hdlist1">
9932 push.negotiate
9933 </dt>
9934 <dd>
9935 <p>
9936         If set to "true", attempt to reduce the size of the packfile
9937         sent by rounds of negotiation in which the client and the
9938         server attempt to find commits in common. If "false", Git will
9939         rely solely on the server&#8217;s ref advertisement to find commits
9940         in common.
9941 </p>
9942 </dd>
9943 <dt class="hdlist1">
9944 push.useBitmaps
9945 </dt>
9946 <dd>
9947 <p>
9948         If set to "false", disable use of bitmaps for "git push" even if
9949         <code>pack.useBitmaps</code> is "true", without preventing other git operations
9950         from using bitmaps. Default is true.
9951 </p>
9952 </dd>
9953 <dt class="hdlist1">
9954 rebase.backend
9955 </dt>
9956 <dd>
9957 <p>
9958         Default backend to use for rebasing.  Possible choices are
9959         <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
9960         all remaining capabilities of the apply backend, this setting
9961         may become unused.
9962 </p>
9963 </dd>
9964 <dt class="hdlist1">
9965 rebase.stat
9966 </dt>
9967 <dd>
9968 <p>
9969         Whether to show a diffstat of what changed upstream since the last
9970         rebase. False by default.
9971 </p>
9972 </dd>
9973 <dt class="hdlist1">
9974 rebase.autoSquash
9975 </dt>
9976 <dd>
9977 <p>
9978         If set to true, enable the <code>--autosquash</code> option of
9979         <a href="git-rebase.html">git-rebase(1)</a> by default for interactive mode.
9980         This can be overridden with the <code>--no-autosquash</code> option.
9981 </p>
9982 </dd>
9983 <dt class="hdlist1">
9984 rebase.autoStash
9985 </dt>
9986 <dd>
9987 <p>
9988         When set to true, automatically create a temporary stash entry
9989         before the operation begins, and apply it after the operation
9990         ends.  This means that you can run rebase on a dirty worktree.
9991         However, use with care: the final stash application after a
9992         successful rebase might result in non-trivial conflicts.
9993         This option can be overridden by the <code>--no-autostash</code> and
9994         <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
9995         Defaults to false.
9996 </p>
9997 </dd>
9998 <dt class="hdlist1">
9999 rebase.updateRefs
10000 </dt>
10001 <dd>
10002 <p>
10003         If set to true enable <code>--update-refs</code> option by default.
10004 </p>
10005 </dd>
10006 <dt class="hdlist1">
10007 rebase.missingCommitsCheck
10008 </dt>
10009 <dd>
10010 <p>
10011         If set to "warn", git rebase -i will print a warning if some
10012         commits are removed (e.g. a line was deleted), however the
10013         rebase will still proceed. If set to "error", it will print
10014         the previous warning and stop the rebase, <em>git rebase
10015         --edit-todo</em> can then be used to correct the error. If set to
10016         "ignore", no checking is done.
10017         To drop a commit without warning or error, use the <code>drop</code>
10018         command in the todo list.
10019         Defaults to "ignore".
10020 </p>
10021 </dd>
10022 <dt class="hdlist1">
10023 rebase.instructionFormat
10024 </dt>
10025 <dd>
10026 <p>
10027         A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
10028         todo list during an interactive rebase.  The format will
10029         automatically have the commit hash prepended to the format.
10030 </p>
10031 </dd>
10032 <dt class="hdlist1">
10033 rebase.abbreviateCommands
10034 </dt>
10035 <dd>
10036 <p>
10037         If set to true, <code>git rebase</code> will use abbreviated command names in the
10038         todo list resulting in something like this:
10039 </p>
10040 <div class="listingblock">
10041 <div class="content">
10042 <pre><code>        p deadbee The oneline of the commit
10043         p fa1afe1 The oneline of the next commit
10044         ...</code></pre>
10045 </div></div>
10046 <div class="paragraph"><p>instead of:</p></div>
10047 <div class="listingblock">
10048 <div class="content">
10049 <pre><code>        pick deadbee The oneline of the commit
10050         pick fa1afe1 The oneline of the next commit
10051         ...</code></pre>
10052 </div></div>
10053 <div class="paragraph"><p>Defaults to false.</p></div>
10054 </dd>
10055 <dt class="hdlist1">
10056 rebase.rescheduleFailedExec
10057 </dt>
10058 <dd>
10059 <p>
10060         Automatically reschedule <code>exec</code> commands that failed. This only makes
10061         sense in interactive mode (or when an <code>--exec</code> option was provided).
10062         This is the same as specifying the <code>--reschedule-failed-exec</code> option.
10063 </p>
10064 </dd>
10065 <dt class="hdlist1">
10066 rebase.forkPoint
10067 </dt>
10068 <dd>
10069 <p>
10070         If set to false set <code>--no-fork-point</code> option by default.
10071 </p>
10072 </dd>
10073 <dt class="hdlist1">
10074 rebase.rebaseMerges
10075 </dt>
10076 <dd>
10077 <p>
10078         Whether and how to set the <code>--rebase-merges</code> option by default. Can
10079         be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
10080         true or to <code>no-rebase-cousins</code> is equivalent to
10081         <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
10082         equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
10083         equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
10084         command line, with or without an argument, overrides any
10085         <code>rebase.rebaseMerges</code> configuration.
10086 </p>
10087 </dd>
10088 <dt class="hdlist1">
10089 rebase.maxLabelLength
10090 </dt>
10091 <dd>
10092 <p>
10093         When generating label names from commit subjects, truncate the names to
10094         this length. By default, the names are truncated to a little less than
10095         <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
10096         corresponding loose refs).
10097 </p>
10098 </dd>
10099 <dt class="hdlist1">
10100 receive.advertiseAtomic
10101 </dt>
10102 <dd>
10103 <p>
10104         By default, git-receive-pack will advertise the atomic push
10105         capability to its clients. If you don&#8217;t want to advertise this
10106         capability, set this variable to false.
10107 </p>
10108 </dd>
10109 <dt class="hdlist1">
10110 receive.advertisePushOptions
10111 </dt>
10112 <dd>
10113 <p>
10114         When set to true, git-receive-pack will advertise the push options
10115         capability to its clients. False by default.
10116 </p>
10117 </dd>
10118 <dt class="hdlist1">
10119 receive.autogc
10120 </dt>
10121 <dd>
10122 <p>
10123         By default, git-receive-pack will run "git maintenance run --auto" after
10124         receiving data from git-push and updating refs.  You can stop
10125         it by setting this variable to false.
10126 </p>
10127 </dd>
10128 <dt class="hdlist1">
10129 receive.certNonceSeed
10130 </dt>
10131 <dd>
10132 <p>
10133         By setting this variable to a string, <code>git receive-pack</code>
10134         will accept a <code>git push --signed</code> and verify it by using
10135         a "nonce" protected by HMAC using this string as a secret
10136         key.
10137 </p>
10138 </dd>
10139 <dt class="hdlist1">
10140 receive.certNonceSlop
10141 </dt>
10142 <dd>
10143 <p>
10144         When a <code>git push --signed</code> sends a push certificate with a
10145         "nonce" that was issued by a receive-pack serving the same
10146         repository within this many seconds, export the "nonce"
10147         found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
10148         hooks (instead of what the receive-pack asked the sending
10149         side to include).  This may allow writing checks in
10150         <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
10151         checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
10152         that records by how many seconds the nonce is stale to
10153         decide if they want to accept the certificate, they only
10154         can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
10155 </p>
10156 </dd>
10157 <dt class="hdlist1">
10158 receive.fsckObjects
10159 </dt>
10160 <dd>
10161 <p>
10162         If it is set to true, git-receive-pack will check all received
10163         objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
10164         Defaults to false. If not set, the value of
10165         <code>transfer.fsckObjects</code> is used instead.
10166 </p>
10167 </dd>
10168 <dt class="hdlist1">
10169 receive.fsck.&lt;msg-id&gt;
10170 </dt>
10171 <dd>
10172 <p>
10173         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
10174         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
10175         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
10176         details.
10177 </p>
10178 </dd>
10179 <dt class="hdlist1">
10180 receive.fsck.skipList
10181 </dt>
10182 <dd>
10183 <p>
10184         Acts like <code>fsck.skipList</code>, but is used by
10185         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
10186         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
10187         details.
10188 </p>
10189 </dd>
10190 <dt class="hdlist1">
10191 receive.keepAlive
10192 </dt>
10193 <dd>
10194 <p>
10195         After receiving the pack from the client, <code>receive-pack</code> may
10196         produce no output (if <code>--quiet</code> was specified) while processing
10197         the pack, causing some networks to drop the TCP connection.
10198         With this option set, if <code>receive-pack</code> does not transmit
10199         any data in this phase for <code>receive.keepAlive</code> seconds, it will
10200         send a short keepalive packet.  The default is 5 seconds; set
10201         to 0 to disable keepalives entirely.
10202 </p>
10203 </dd>
10204 <dt class="hdlist1">
10205 receive.unpackLimit
10206 </dt>
10207 <dd>
10208 <p>
10209         If the number of objects received in a push is below this
10210         limit then the objects will be unpacked into loose object
10211         files. However if the number of received objects equals or
10212         exceeds this limit then the received pack will be stored as
10213         a pack, after adding any missing delta bases.  Storing the
10214         pack from a push can make the push operation complete faster,
10215         especially on slow filesystems.  If not set, the value of
10216         <code>transfer.unpackLimit</code> is used instead.
10217 </p>
10218 </dd>
10219 <dt class="hdlist1">
10220 receive.maxInputSize
10221 </dt>
10222 <dd>
10223 <p>
10224         If the size of the incoming pack stream is larger than this
10225         limit, then git-receive-pack will error out, instead of
10226         accepting the pack file. If not set or set to 0, then the size
10227         is unlimited.
10228 </p>
10229 </dd>
10230 <dt class="hdlist1">
10231 receive.denyDeletes
10232 </dt>
10233 <dd>
10234 <p>
10235         If set to true, git-receive-pack will deny a ref update that deletes
10236         the ref. Use this to prevent such a ref deletion via a push.
10237 </p>
10238 </dd>
10239 <dt class="hdlist1">
10240 receive.denyDeleteCurrent
10241 </dt>
10242 <dd>
10243 <p>
10244         If set to true, git-receive-pack will deny a ref update that
10245         deletes the currently checked out branch of a non-bare repository.
10246 </p>
10247 </dd>
10248 <dt class="hdlist1">
10249 receive.denyCurrentBranch
10250 </dt>
10251 <dd>
10252 <p>
10253         If set to true or "refuse", git-receive-pack will deny a ref update
10254         to the currently checked out branch of a non-bare repository.
10255         Such a push is potentially dangerous because it brings the HEAD
10256         out of sync with the index and working tree. If set to "warn",
10257         print a warning of such a push to stderr, but allow the push to
10258         proceed. If set to false or "ignore", allow such pushes with no
10259         message. Defaults to "refuse".
10260 </p>
10261 <div class="paragraph"><p>Another option is "updateInstead" which will update the working
10262 tree if pushing into the current branch.  This option is
10263 intended for synchronizing working directories when one side is not easily
10264 accessible via interactive ssh (e.g. a live web site, hence the requirement
10265 that the working directory be clean). This mode also comes in handy when
10266 developing inside a VM to test and fix code on different Operating Systems.</p></div>
10267 <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
10268 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
10269 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p></div>
10270 </dd>
10271 <dt class="hdlist1">
10272 receive.denyNonFastForwards
10273 </dt>
10274 <dd>
10275 <p>
10276         If set to true, git-receive-pack will deny a ref update which is
10277         not a fast-forward. Use this to prevent such an update via a push,
10278         even if that push is forced. This configuration variable is
10279         set when initializing a shared repository.
10280 </p>
10281 </dd>
10282 <dt class="hdlist1">
10283 receive.hideRefs
10284 </dt>
10285 <dd>
10286 <p>
10287         This variable is the same as <code>transfer.hideRefs</code>, but applies
10288         only to <code>receive-pack</code> (and so affects pushes, but not fetches).
10289         An attempt to update or delete a hidden ref by <code>git push</code> is
10290         rejected.
10291 </p>
10292 </dd>
10293 <dt class="hdlist1">
10294 receive.procReceiveRefs
10295 </dt>
10296 <dd>
10297 <p>
10298         This is a multi-valued variable that defines reference prefixes
10299         to match the commands in <code>receive-pack</code>.  Commands matching the
10300         prefixes will be executed by an external hook "proc-receive",
10301         instead of the internal <code>execute_commands</code> function.  If this
10302         variable is not defined, the "proc-receive" hook will never be
10303         used, and all commands will be executed by the internal
10304         <code>execute_commands</code> function.
10305 </p>
10306 <div class="paragraph"><p>For example, if this variable is set to "refs/for", pushing to reference
10307 such as "refs/for/master" will not create or update a reference named
10308 "refs/for/master", but may create or update a pull request directly by
10309 running the hook "proc-receive".</p></div>
10310 <div class="paragraph"><p>Optional modifiers can be provided in the beginning of the value to filter
10311 commands for specific actions: create (a), modify (m), delete (d).
10312 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
10313 E.g.:</p></div>
10314 <div class="literalblock">
10315 <div class="content">
10316 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
10317 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
10318 </div></div>
10319 </dd>
10320 <dt class="hdlist1">
10321 receive.updateServerInfo
10322 </dt>
10323 <dd>
10324 <p>
10325         If set to true, git-receive-pack will run git-update-server-info
10326         after receiving data from git-push and updating refs.
10327 </p>
10328 </dd>
10329 <dt class="hdlist1">
10330 receive.shallowUpdate
10331 </dt>
10332 <dd>
10333 <p>
10334         If set to true, .git/shallow can be updated when new refs
10335         require new shallow roots. Otherwise those refs are rejected.
10336 </p>
10337 </dd>
10338 <dt class="hdlist1">
10339 reftable.blockSize
10340 </dt>
10341 <dd>
10342 <p>
10343         The size in bytes used by the reftable backend when writing blocks.
10344         The block size is determined by the writer, and does not have to be a
10345         power of 2. The block size must be larger than the longest reference
10346         name or log entry used in the repository, as references cannot span
10347         blocks.
10348 </p>
10349 <div class="paragraph"><p>Powers of two that are friendly to the virtual memory system or
10350 filesystem (such as 4kB or 8kB) are recommended. Larger sizes (64kB) can
10351 yield better compression, with a possible increased cost incurred by
10352 readers during access.</p></div>
10353 <div class="paragraph"><p>The largest block size is <code>16777215</code> bytes (15.99 MiB). The default value is
10354 <code>4096</code> bytes (4kB). A value of <code>0</code> will use the default value.</p></div>
10355 </dd>
10356 <dt class="hdlist1">
10357 reftable.restartInterval
10358 </dt>
10359 <dd>
10360 <p>
10361         The interval at which to create restart points. The reftable backend
10362         determines the restart points at file creation. Every 16 may be
10363         more suitable for smaller block sizes (4k or 8k), every 64 for larger
10364         block sizes (64k).
10365 </p>
10366 <div class="paragraph"><p>More frequent restart points reduces prefix compression and increases
10367 space consumed by the restart table, both of which increase file size.</p></div>
10368 <div class="paragraph"><p>Less frequent restart points makes prefix compression more effective,
10369 decreasing overall file size, with increased penalties for readers
10370 walking through more records after the binary search step.</p></div>
10371 <div class="paragraph"><p>A maximum of <code>65535</code> restart points per block is supported.</p></div>
10372 <div class="paragraph"><p>The default value is to create restart points every 16 records. A value of <code>0</code>
10373 will use the default value.</p></div>
10374 </dd>
10375 <dt class="hdlist1">
10376 reftable.indexObjects
10377 </dt>
10378 <dd>
10379 <p>
10380         Whether the reftable backend shall write object blocks. Object blocks
10381         are a reverse mapping of object ID to the references pointing to them.
10382 </p>
10383 <div class="paragraph"><p>The default value is <code>true</code>.</p></div>
10384 </dd>
10385 <dt class="hdlist1">
10386 reftable.geometricFactor
10387 </dt>
10388 <dd>
10389 <p>
10390         Whenever the reftable backend appends a new table to the stack, it
10391         performs auto compaction to ensure that there is only a handful of
10392         tables. The backend does this by ensuring that tables form a geometric
10393         sequence regarding the respective sizes of each table.
10394 </p>
10395 <div class="paragraph"><p>By default, the geometric sequence uses a factor of 2, meaning that for any
10396 table, the next-biggest table must at least be twice as big. A maximum factor
10397 of 256 is supported.</p></div>
10398 </dd>
10399 <dt class="hdlist1">
10400 remote.pushDefault
10401 </dt>
10402 <dd>
10403 <p>
10404         The remote to push to by default.  Overrides
10405         <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
10406         <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
10407 </p>
10408 </dd>
10409 <dt class="hdlist1">
10410 remote.&lt;name&gt;.url
10411 </dt>
10412 <dd>
10413 <p>
10414         The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
10415         <a href="git-push.html">git-push(1)</a>.
10416 </p>
10417 </dd>
10418 <dt class="hdlist1">
10419 remote.&lt;name&gt;.pushurl
10420 </dt>
10421 <dd>
10422 <p>
10423         The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
10424 </p>
10425 </dd>
10426 <dt class="hdlist1">
10427 remote.&lt;name&gt;.proxy
10428 </dt>
10429 <dd>
10430 <p>
10431         For remotes that require curl (http, https and ftp), the URL to
10432         the proxy to use for that remote.  Set to the empty string to
10433         disable proxying for that remote.
10434 </p>
10435 </dd>
10436 <dt class="hdlist1">
10437 remote.&lt;name&gt;.proxyAuthMethod
10438 </dt>
10439 <dd>
10440 <p>
10441         For remotes that require curl (http, https and ftp), the method to use for
10442         authenticating against the proxy in use (probably set in
10443         <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
10444 </p>
10445 </dd>
10446 <dt class="hdlist1">
10447 remote.&lt;name&gt;.fetch
10448 </dt>
10449 <dd>
10450 <p>
10451         The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
10452         <a href="git-fetch.html">git-fetch(1)</a>.
10453 </p>
10454 </dd>
10455 <dt class="hdlist1">
10456 remote.&lt;name&gt;.push
10457 </dt>
10458 <dd>
10459 <p>
10460         The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
10461         <a href="git-push.html">git-push(1)</a>.
10462 </p>
10463 </dd>
10464 <dt class="hdlist1">
10465 remote.&lt;name&gt;.mirror
10466 </dt>
10467 <dd>
10468 <p>
10469         If true, pushing to this remote will automatically behave
10470         as if the <code>--mirror</code> option was given on the command line.
10471 </p>
10472 </dd>
10473 <dt class="hdlist1">
10474 remote.&lt;name&gt;.skipDefaultUpdate
10475 </dt>
10476 <dd>
10477 <p>
10478         If true, this remote will be skipped by default when updating
10479         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10480         <a href="git-remote.html">git-remote(1)</a>.
10481 </p>
10482 </dd>
10483 <dt class="hdlist1">
10484 remote.&lt;name&gt;.skipFetchAll
10485 </dt>
10486 <dd>
10487 <p>
10488         If true, this remote will be skipped by default when updating
10489         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10490         <a href="git-remote.html">git-remote(1)</a>.
10491 </p>
10492 </dd>
10493 <dt class="hdlist1">
10494 remote.&lt;name&gt;.receivepack
10495 </dt>
10496 <dd>
10497 <p>
10498         The default program to execute on the remote side when pushing.  See
10499         option --receive-pack of <a href="git-push.html">git-push(1)</a>.
10500 </p>
10501 </dd>
10502 <dt class="hdlist1">
10503 remote.&lt;name&gt;.uploadpack
10504 </dt>
10505 <dd>
10506 <p>
10507         The default program to execute on the remote side when fetching.  See
10508         option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
10509 </p>
10510 </dd>
10511 <dt class="hdlist1">
10512 remote.&lt;name&gt;.tagOpt
10513 </dt>
10514 <dd>
10515 <p>
10516         Setting this value to --no-tags disables automatic tag following when
10517         fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
10518         tag from remote &lt;name&gt;, even if they are not reachable from remote
10519         branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
10520         override this setting. See options --tags and --no-tags of
10521         <a href="git-fetch.html">git-fetch(1)</a>.
10522 </p>
10523 </dd>
10524 <dt class="hdlist1">
10525 remote.&lt;name&gt;.vcs
10526 </dt>
10527 <dd>
10528 <p>
10529         Setting this to a value &lt;vcs&gt; will cause Git to interact with
10530         the remote with the git-remote-&lt;vcs&gt; helper.
10531 </p>
10532 </dd>
10533 <dt class="hdlist1">
10534 remote.&lt;name&gt;.prune
10535 </dt>
10536 <dd>
10537 <p>
10538         When set to true, fetching from this remote by default will also
10539         remove any remote-tracking references that no longer exist on the
10540         remote (as if the <code>--prune</code> option was given on the command line).
10541         Overrides <code>fetch.prune</code> settings, if any.
10542 </p>
10543 </dd>
10544 <dt class="hdlist1">
10545 remote.&lt;name&gt;.pruneTags
10546 </dt>
10547 <dd>
10548 <p>
10549         When set to true, fetching from this remote by default will also
10550         remove any local tags that no longer exist on the remote if pruning
10551         is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
10552         <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10553 </p>
10554 <div class="paragraph"><p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
10555 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
10556 </dd>
10557 <dt class="hdlist1">
10558 remote.&lt;name&gt;.promisor
10559 </dt>
10560 <dd>
10561 <p>
10562         When set to true, this remote will be used to fetch promisor
10563         objects.
10564 </p>
10565 </dd>
10566 <dt class="hdlist1">
10567 remote.&lt;name&gt;.partialclonefilter
10568 </dt>
10569 <dd>
10570 <p>
10571         The filter that will be applied when fetching from this promisor remote.
10572         Changing or clearing this value will only affect fetches for new commits.
10573         To fetch associated objects for commits already present in the local object
10574         database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.
10575 </p>
10576 </dd>
10577 <dt class="hdlist1">
10578 remotes.&lt;group&gt;
10579 </dt>
10580 <dd>
10581 <p>
10582         The list of remotes which are fetched by "git remote update
10583         &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.
10584 </p>
10585 </dd>
10586 <dt class="hdlist1">
10587 repack.useDeltaBaseOffset
10588 </dt>
10589 <dd>
10590 <p>
10591         By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
10592         delta-base offset. If you need to share your repository with
10593         Git older than version 1.4.4, either directly or via a dumb
10594         protocol such as http, then you need to set this option to
10595         "false" and repack. Access from old Git versions over the
10596         native protocol are unaffected by this option.
10597 </p>
10598 </dd>
10599 <dt class="hdlist1">
10600 repack.packKeptObjects
10601 </dt>
10602 <dd>
10603 <p>
10604         If set to true, makes <code>git repack</code> act as if
10605         <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
10606         details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10607         index is being written (either via <code>--write-bitmap-index</code> or
10608         <code>repack.writeBitmaps</code>).
10609 </p>
10610 </dd>
10611 <dt class="hdlist1">
10612 repack.useDeltaIslands
10613 </dt>
10614 <dd>
10615 <p>
10616         If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10617         was passed. Defaults to <code>false</code>.
10618 </p>
10619 </dd>
10620 <dt class="hdlist1">
10621 repack.writeBitmaps
10622 </dt>
10623 <dd>
10624 <p>
10625         When true, git will write a bitmap index when packing all
10626         objects to disk (e.g., when <code>git repack -a</code> is run).  This
10627         index can speed up the "counting objects" phase of subsequent
10628         packs created for clones and fetches, at the cost of some disk
10629         space and extra time spent on the initial repack.  This has
10630         no effect if multiple packfiles are created.
10631         Defaults to true on bare repos, false otherwise.
10632 </p>
10633 </dd>
10634 <dt class="hdlist1">
10635 repack.updateServerInfo
10636 </dt>
10637 <dd>
10638 <p>
10639         If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
10640         <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10641         when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.
10642 </p>
10643 </dd>
10644 <dt class="hdlist1">
10645 repack.cruftWindow
10646 </dt>
10647 <dt class="hdlist1">
10648 repack.cruftWindowMemory
10649 </dt>
10650 <dt class="hdlist1">
10651 repack.cruftDepth
10652 </dt>
10653 <dt class="hdlist1">
10654 repack.cruftThreads
10655 </dt>
10656 <dd>
10657 <p>
10658         Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
10659         a cruft pack and the respective parameters are not given over
10660         the command line. See similarly named <code>pack.*</code> configuration
10661         variables for defaults and meaning.
10662 </p>
10663 </dd>
10664 <dt class="hdlist1">
10665 rerere.autoUpdate
10666 </dt>
10667 <dd>
10668 <p>
10669         When set to true, <code>git-rerere</code> updates the index with the
10670         resulting contents after it cleanly resolves conflicts using
10671         previously recorded resolutions.  Defaults to false.
10672 </p>
10673 </dd>
10674 <dt class="hdlist1">
10675 rerere.enabled
10676 </dt>
10677 <dd>
10678 <p>
10679         Activate recording of resolved conflicts, so that identical
10680         conflict hunks can be resolved automatically, should they be
10681         encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
10682         enabled if there is an <code>rr-cache</code> directory under the
10683         <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
10684         repository.
10685 </p>
10686 </dd>
10687 <dt class="hdlist1">
10688 revert.reference
10689 </dt>
10690 <dd>
10691 <p>
10692         Setting this variable to true makes <code>git revert</code> behave
10693         as if the <code>--reference</code> option is given.
10694 </p>
10695 </dd>
10696 <dt class="hdlist1">
10697 safe.bareRepository
10698 </dt>
10699 <dd>
10700 <p>
10701         Specifies which bare repositories Git will work with. The currently
10702         supported values are:
10703 </p>
10704 <div class="ulist"><ul>
10705 <li>
10706 <p>
10707 <code>all</code>: Git works with all bare repositories. This is the default.
10708 </p>
10709 </li>
10710 <li>
10711 <p>
10712 <code>explicit</code>: Git only works with bare repositories specified via
10713   the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10714   environment variable (see <a href="git.html">git(1)</a>).
10715 </p>
10716 <div class="paragraph"><p>If you do not use bare repositories in your workflow, then it may be
10717 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10718 config. This will protect you from attacks that involve cloning a
10719 repository that contains a bare repository and running a Git command
10720 within that directory.</p></div>
10721 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10722 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with
10723 this value.</p></div>
10724 </li>
10725 </ul></div>
10726 </dd>
10727 <dt class="hdlist1">
10728 safe.directory
10729 </dt>
10730 <dd>
10731 <p>
10732         These config entries specify Git-tracked directories that are
10733         considered safe even if they are owned by someone other than the
10734         current user. By default, Git will refuse to even parse a Git
10735         config of a repository owned by someone else, let alone run its
10736         hooks, and this config setting allows users to specify exceptions,
10737         e.g. for intentionally shared repositories (see the <code>--shared</code>
10738         option in <a href="git-init.html">git-init(1)</a>).
10739 </p>
10740 <div class="paragraph"><p>This is a multi-valued setting, i.e. you can add more than one directory
10741 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10742 override any such directories specified in the system config), add a
10743 <code>safe.directory</code> entry with an empty value.</p></div>
10744 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10745 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with this
10746 value.</p></div>
10747 <div class="paragraph"><p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
10748 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
10749 path relative to Git&#8217;s (runtime) prefix.</p></div>
10750 <div class="paragraph"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10751 string <code>*</code>. This will allow all repositories to be treated as if their
10752 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10753 is set in system config and you want to re-enable this protection, then
10754 initialize your list with an empty value before listing the repositories
10755 that you deem safe.  Giving a directory with <code>/*</code> appended to it will
10756 allow access to all repositories under the named directory.</p></div>
10757 <div class="paragraph"><p>As explained, Git only allows you to access repositories owned by
10758 yourself, i.e. the user who is running Git, by default.  When Git
10759 is running as <em>root</em> in a non Windows platform that provides sudo,
10760 however, git checks the SUDO_UID environment variable that sudo creates
10761 and will allow access to the uid recorded as its value in addition to
10762 the id from <em>root</em>.
10763 This is to make it easy to perform a common sequence during installation
10764 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
10765 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
10766 which id the original user has.
10767 If that is not what you would prefer and want git to only trust
10768 repositories that are owned by root instead, then you can remove
10769 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p></div>
10770 </dd>
10771 <dt class="hdlist1">
10772 sendemail.identity
10773 </dt>
10774 <dd>
10775 <p>
10776         A configuration identity. When given, causes values in the
10777         <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
10778         values in the <em>sendemail</em> section. The default identity is
10779         the value of <code>sendemail.identity</code>.
10780 </p>
10781 </dd>
10782 <dt class="hdlist1">
10783 sendemail.smtpEncryption
10784 </dt>
10785 <dd>
10786 <p>
10787         See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
10788         setting is not subject to the <em>identity</em> mechanism.
10789 </p>
10790 </dd>
10791 <dt class="hdlist1">
10792 sendemail.smtpSSLCertPath
10793 </dt>
10794 <dd>
10795 <p>
10796         Path to ca-certificates (either a directory or a single file).
10797         Set it to an empty string to disable certificate verification.
10798 </p>
10799 </dd>
10800 <dt class="hdlist1">
10801 sendemail.&lt;identity&gt;.*
10802 </dt>
10803 <dd>
10804 <p>
10805         Identity-specific versions of the <em>sendemail.*</em> parameters
10806         found below, taking precedence over those when this
10807         identity is selected, through either the command-line or
10808         <code>sendemail.identity</code>.
10809 </p>
10810 </dd>
10811 <dt class="hdlist1">
10812 sendemail.multiEdit
10813 </dt>
10814 <dd>
10815 <p>
10816         If true (default), a single editor instance will be spawned to edit
10817         files you have to edit (patches when <code>--annotate</code> is used, and the
10818         summary when <code>--compose</code> is used). If false, files will be edited one
10819         after the other, spawning a new editor each time.
10820 </p>
10821 </dd>
10822 <dt class="hdlist1">
10823 sendemail.confirm
10824 </dt>
10825 <dd>
10826 <p>
10827         Sets the default for whether to confirm before sending. Must be
10828         one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
10829         in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
10830         values.
10831 </p>
10832 </dd>
10833 <dt class="hdlist1">
10834 sendemail.aliasesFile
10835 </dt>
10836 <dd>
10837 <p>
10838         To avoid typing long email addresses, point this to one or more
10839         email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.
10840 </p>
10841 </dd>
10842 <dt class="hdlist1">
10843 sendemail.aliasFileType
10844 </dt>
10845 <dd>
10846 <p>
10847         Format of the file(s) specified in sendemail.aliasesFile. Must be
10848         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.
10849 </p>
10850 <div class="paragraph"><p>What an alias file in each format looks like can be found in
10851 the documentation of the email program of the same name. The
10852 differences and limitations from the standard formats are
10853 described below:</p></div>
10854 <div class="openblock">
10855 <div class="content">
10856 <div class="dlist"><dl>
10857 <dt class="hdlist1">
10858 sendmail
10859 </dt>
10860 <dd>
10861 <div class="ulist"><ul>
10862 <li>
10863 <p>
10864 Quoted aliases and quoted addresses are not supported: lines that
10865         contain a <code>"</code> symbol are ignored.
10866 </p>
10867 </li>
10868 <li>
10869 <p>
10870 Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
10871         supported.
10872 </p>
10873 </li>
10874 <li>
10875 <p>
10876 File inclusion (<code>:include: /path/name</code>) is not supported.
10877 </p>
10878 </li>
10879 <li>
10880 <p>
10881 Warnings are printed on the standard error output for any
10882         explicitly unsupported constructs, and any other lines that are not
10883         recognized by the parser.
10884 </p>
10885 </li>
10886 </ul></div>
10887 </dd>
10888 </dl></div>
10889 </div></div>
10890 </dd>
10891 <dt class="hdlist1">
10892 sendemail.annotate
10893 </dt>
10894 <dt class="hdlist1">
10895 sendemail.bcc
10896 </dt>
10897 <dt class="hdlist1">
10898 sendemail.cc
10899 </dt>
10900 <dt class="hdlist1">
10901 sendemail.ccCmd
10902 </dt>
10903 <dt class="hdlist1">
10904 sendemail.chainReplyTo
10905 </dt>
10906 <dt class="hdlist1">
10907 sendemail.envelopeSender
10908 </dt>
10909 <dt class="hdlist1">
10910 sendemail.from
10911 </dt>
10912 <dt class="hdlist1">
10913 sendemail.headerCmd
10914 </dt>
10915 <dt class="hdlist1">
10916 sendemail.signedOffByCc
10917 </dt>
10918 <dt class="hdlist1">
10919 sendemail.smtpPass
10920 </dt>
10921 <dt class="hdlist1">
10922 sendemail.suppressCc
10923 </dt>
10924 <dt class="hdlist1">
10925 sendemail.suppressFrom
10926 </dt>
10927 <dt class="hdlist1">
10928 sendemail.to
10929 </dt>
10930 <dt class="hdlist1">
10931 sendemail.toCmd
10932 </dt>
10933 <dt class="hdlist1">
10934 sendemail.smtpDomain
10935 </dt>
10936 <dt class="hdlist1">
10937 sendemail.smtpServer
10938 </dt>
10939 <dt class="hdlist1">
10940 sendemail.smtpServerPort
10941 </dt>
10942 <dt class="hdlist1">
10943 sendemail.smtpServerOption
10944 </dt>
10945 <dt class="hdlist1">
10946 sendemail.smtpUser
10947 </dt>
10948 <dt class="hdlist1">
10949 sendemail.thread
10950 </dt>
10951 <dt class="hdlist1">
10952 sendemail.transferEncoding
10953 </dt>
10954 <dt class="hdlist1">
10955 sendemail.validate
10956 </dt>
10957 <dt class="hdlist1">
10958 sendemail.xmailer
10959 </dt>
10960 <dd>
10961 <p>
10962         These configuration variables all provide a default for
10963         <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
10964         documentation for details.
10965 </p>
10966 </dd>
10967 <dt class="hdlist1">
10968 sendemail.signedOffCc (deprecated)
10969 </dt>
10970 <dd>
10971 <p>
10972         Deprecated alias for <code>sendemail.signedOffByCc</code>.
10973 </p>
10974 </dd>
10975 <dt class="hdlist1">
10976 sendemail.smtpBatchSize
10977 </dt>
10978 <dd>
10979 <p>
10980         Number of messages to be sent per connection, after that a relogin
10981         will happen.  If the value is 0 or undefined, send all messages in
10982         one connection.
10983         See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10984 </p>
10985 </dd>
10986 <dt class="hdlist1">
10987 sendemail.smtpReloginDelay
10988 </dt>
10989 <dd>
10990 <p>
10991         Seconds to wait before reconnecting to the smtp server.
10992         See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10993 </p>
10994 </dd>
10995 <dt class="hdlist1">
10996 sendemail.forbidSendmailVariables
10997 </dt>
10998 <dd>
10999 <p>
11000         To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
11001         will abort with a warning if any configuration options for "sendmail"
11002         exist. Set this variable to bypass the check.
11003 </p>
11004 </dd>
11005 <dt class="hdlist1">
11006 sequence.editor
11007 </dt>
11008 <dd>
11009 <p>
11010         Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
11011         The value is meant to be interpreted by the shell when it is used.
11012         It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
11013         When not configured, the default commit message editor is used instead.
11014 </p>
11015 </dd>
11016 <dt class="hdlist1">
11017 showBranch.default
11018 </dt>
11019 <dd>
11020 <p>
11021         The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
11022         See <a href="git-show-branch.html">git-show-branch(1)</a>.
11023 </p>
11024 </dd>
11025 <dt class="hdlist1">
11026 sparse.expectFilesOutsideOfPatterns
11027 </dt>
11028 <dd>
11029 <p>
11030         Typically with sparse checkouts, files not matching any
11031         sparsity patterns are marked with a SKIP_WORKTREE bit in the
11032         index and are missing from the working tree.  Accordingly, Git
11033         will ordinarily check whether files with the SKIP_WORKTREE bit
11034         are in fact present in the working tree contrary to
11035         expectations.  If Git finds any, it marks those paths as
11036         present by clearing the relevant SKIP_WORKTREE bits.  This
11037         option can be used to tell Git that such
11038         present-despite-skipped files are expected and to stop
11039         checking for them.
11040 </p>
11041 <div class="paragraph"><p>The default is <code>false</code>, which allows Git to automatically recover
11042 from the list of files in the index and working tree falling out of
11043 sync.</p></div>
11044 <div class="paragraph"><p>Set this to <code>true</code> if you are in a setup where some external factor
11045 relieves Git of the responsibility for maintaining the consistency
11046 between the presence of working tree files and sparsity patterns.  For
11047 example, if you have a Git-aware virtual file system that has a robust
11048 mechanism for keeping the working tree and the sparsity patterns up to
11049 date based on access patterns.</p></div>
11050 <div class="paragraph"><p>Regardless of this setting, Git does not check for
11051 present-despite-skipped files unless sparse checkout is enabled, so
11052 this config option has no effect unless <code>core.sparseCheckout</code> is
11053 <code>true</code>.</p></div>
11054 </dd>
11055 <dt class="hdlist1">
11056 splitIndex.maxPercentChange
11057 </dt>
11058 <dd>
11059 <p>
11060         When the split index feature is used, this specifies the
11061         percent of entries the split index can contain compared to the
11062         total number of entries in both the split index and the shared
11063         index before a new shared index is written.
11064         The value should be between 0 and 100. If the value is 0, then
11065         a new shared index is always written; if it is 100, a new
11066         shared index is never written.
11067         By default, the value is 20, so a new shared index is written
11068         if the number of entries in the split index would be greater
11069         than 20 percent of the total number of entries.
11070         See <a href="git-update-index.html">git-update-index(1)</a>.
11071 </p>
11072 </dd>
11073 <dt class="hdlist1">
11074 splitIndex.sharedIndexExpire
11075 </dt>
11076 <dd>
11077 <p>
11078         When the split index feature is used, shared index files that
11079         were not modified since the time this variable specifies will
11080         be removed when a new shared index file is created. The value
11081         "now" expires all entries immediately, and "never" suppresses
11082         expiration altogether.
11083         The default value is "2.weeks.ago".
11084         Note that a shared index file is considered modified (for the
11085         purpose of expiration) each time a new split-index file is
11086         either created based on it or read from it.
11087         See <a href="git-update-index.html">git-update-index(1)</a>.
11088 </p>
11089 </dd>
11090 <dt class="hdlist1">
11091 ssh.variant
11092 </dt>
11093 <dd>
11094 <p>
11095         By default, Git determines the command line arguments to use
11096         based on the basename of the configured SSH command (configured
11097         using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
11098         the config setting <code>core.sshCommand</code>). If the basename is
11099         unrecognized, Git will attempt to detect support of OpenSSH
11100         options by first invoking the configured SSH command with the
11101         <code>-G</code> (print configuration) option and will subsequently use
11102         OpenSSH options (if that is successful) or no options besides
11103         the host and remote command (if it fails).
11104 </p>
11105 <div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this detection.
11106 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
11107 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
11108 The default auto-detection can be explicitly requested using the value
11109 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
11110 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
11111 <div class="paragraph"><p>The current command-line parameters used for each variant are as
11112 follows:</p></div>
11113 <div class="openblock">
11114 <div class="content">
11115 <div class="ulist"><ul>
11116 <li>
11117 <p>
11118 <code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command
11119 </p>
11120 </li>
11121 <li>
11122 <p>
11123 <code>simple</code> - [username@]host command
11124 </p>
11125 </li>
11126 <li>
11127 <p>
11128 <code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command
11129 </p>
11130 </li>
11131 <li>
11132 <p>
11133 <code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command
11134 </p>
11135 </li>
11136 </ul></div>
11137 </div></div>
11138 <div class="paragraph"><p>Except for the <code>simple</code> variant, command-line parameters are likely to
11139 change as git gains new features.</p></div>
11140 </dd>
11141 <dt class="hdlist1">
11142 stash.showIncludeUntracked
11143 </dt>
11144 <dd>
11145 <p>
11146         If this is set to true, the <code>git stash show</code> command will show
11147         the untracked files of a stash entry.  Defaults to false. See
11148         the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11149 </p>
11150 </dd>
11151 <dt class="hdlist1">
11152 stash.showPatch
11153 </dt>
11154 <dd>
11155 <p>
11156         If this is set to true, the <code>git stash show</code> command without an
11157         option will show the stash entry in patch form.  Defaults to false.
11158         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11159 </p>
11160 </dd>
11161 <dt class="hdlist1">
11162 stash.showStat
11163 </dt>
11164 <dd>
11165 <p>
11166         If this is set to true, the <code>git stash show</code> command without an
11167         option will show a diffstat of the stash entry.  Defaults to true.
11168         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11169 </p>
11170 </dd>
11171 <dt class="hdlist1">
11172 status.relativePaths
11173 </dt>
11174 <dd>
11175 <p>
11176         By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
11177         current directory. Setting this variable to <code>false</code> shows paths
11178         relative to the repository root (this was the default for Git
11179         prior to v1.5.4).
11180 </p>
11181 </dd>
11182 <dt class="hdlist1">
11183 status.short
11184 </dt>
11185 <dd>
11186 <p>
11187         Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
11188         The option --no-short takes precedence over this variable.
11189 </p>
11190 </dd>
11191 <dt class="hdlist1">
11192 status.branch
11193 </dt>
11194 <dd>
11195 <p>
11196         Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
11197         The option --no-branch takes precedence over this variable.
11198 </p>
11199 </dd>
11200 <dt class="hdlist1">
11201 status.aheadBehind
11202 </dt>
11203 <dd>
11204 <p>
11205         Set to true to enable <code>--ahead-behind</code> and false to enable
11206         <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
11207         non-porcelain status formats.  Defaults to true.
11208 </p>
11209 </dd>
11210 <dt class="hdlist1">
11211 status.displayCommentPrefix
11212 </dt>
11213 <dd>
11214 <p>
11215         If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
11216         prefix before each output line (starting with
11217         <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
11218         behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
11219         Defaults to false.
11220 </p>
11221 </dd>
11222 <dt class="hdlist1">
11223 status.renameLimit
11224 </dt>
11225 <dd>
11226 <p>
11227         The number of files to consider when performing rename detection
11228         in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
11229         the value of diff.renameLimit.
11230 </p>
11231 </dd>
11232 <dt class="hdlist1">
11233 status.renames
11234 </dt>
11235 <dd>
11236 <p>
11237         Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
11238         <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
11239         disabled. If set to "true", basic rename detection is enabled.
11240         If set to "copies" or "copy", Git will detect copies, as well.
11241         Defaults to the value of diff.renames.
11242 </p>
11243 </dd>
11244 <dt class="hdlist1">
11245 status.showStash
11246 </dt>
11247 <dd>
11248 <p>
11249         If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
11250         entries currently stashed away.
11251         Defaults to false.
11252 </p>
11253 </dd>
11254 <dt class="hdlist1">
11255 status.showUntrackedFiles
11256 </dt>
11257 <dd>
11258 <p>
11259         By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
11260         files which are not currently tracked by Git. Directories which
11261         contain only untracked files, are shown with the directory name
11262         only. Showing untracked files means that Git needs to lstat() all
11263         the files in the whole repository, which might be slow on some
11264         systems. So, this variable controls how the commands display
11265         the untracked files. Possible values are:
11266 </p>
11267 <div class="openblock">
11268 <div class="content">
11269 <div class="ulist"><ul>
11270 <li>
11271 <p>
11272 <code>no</code> - Show no untracked files.
11273 </p>
11274 </li>
11275 <li>
11276 <p>
11277 <code>normal</code> - Show untracked files and directories.
11278 </p>
11279 </li>
11280 <li>
11281 <p>
11282 <code>all</code> - Show also individual files in untracked directories.
11283 </p>
11284 </li>
11285 </ul></div>
11286 </div></div>
11287 <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
11288 All usual spellings for Boolean value <code>true</code> are taken as <code>normal</code>
11289 and <code>false</code> as <code>no</code>.
11290 This variable can be overridden with the -u|--untracked-files option
11291 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
11292 </dd>
11293 <dt class="hdlist1">
11294 status.submoduleSummary
11295 </dt>
11296 <dd>
11297 <p>
11298         Defaults to false.
11299         If this is set to a non-zero number or true (identical to -1 or an
11300         unlimited number), the submodule summary will be enabled and a
11301         summary of commits for modified submodules will be shown (see
11302         --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
11303         that the summary output command will be suppressed for all
11304         submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
11305         for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
11306         exception to that rule is that status and commit will show staged
11307         submodule changes. To
11308         also view the summary for ignored submodules you can either use
11309         the --ignore-submodules=dirty command-line option or the <em>git
11310         submodule summary</em> command, which shows a similar output but does
11311         not honor these settings.
11312 </p>
11313 </dd>
11314 <dt class="hdlist1">
11315 submodule.&lt;name&gt;.url
11316 </dt>
11317 <dd>
11318 <p>
11319         The URL for a submodule. This variable is copied from the .gitmodules
11320         file to the git config via <em>git submodule init</em>. The user can change
11321         the configured URL before obtaining the submodule via <em>git submodule
11322         update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
11323         set, the presence of this variable is used as a fallback to indicate
11324         whether the submodule is of interest to git commands.
11325         See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
11326 </p>
11327 </dd>
11328 <dt class="hdlist1">
11329 submodule.&lt;name&gt;.update
11330 </dt>
11331 <dd>
11332 <p>
11333         The method by which a submodule is updated by <em>git submodule update</em>,
11334         which is the only affected command, others such as
11335         <em>git checkout --recurse-submodules</em> are unaffected. It exists for
11336         historical reasons, when <em>git submodule</em> was the only command to
11337         interact with submodules; settings like <code>submodule.active</code>
11338         and <code>pull.rebase</code> are more specific. It is populated by
11339         <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
11340         See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.
11341 </p>
11342 </dd>
11343 <dt class="hdlist1">
11344 submodule.&lt;name&gt;.branch
11345 </dt>
11346 <dd>
11347 <p>
11348         The remote branch name for a submodule, used by <code>git submodule
11349         update --remote</code>.  Set this option to override the value found in
11350         the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
11351         <a href="gitmodules.html">gitmodules(5)</a> for details.
11352 </p>
11353 </dd>
11354 <dt class="hdlist1">
11355 submodule.&lt;name&gt;.fetchRecurseSubmodules
11356 </dt>
11357 <dd>
11358 <p>
11359         This option can be used to control recursive fetching of this
11360         submodule. It can be overridden by using the --[no-]recurse-submodules
11361         command-line option to "git fetch" and "git pull".
11362         This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
11363         file.
11364 </p>
11365 </dd>
11366 <dt class="hdlist1">
11367 submodule.&lt;name&gt;.ignore
11368 </dt>
11369 <dd>
11370 <p>
11371         Defines under what circumstances "git status" and the diff family show
11372         a submodule as modified. When set to "all", it will never be considered
11373         modified (but it will nonetheless show up in the output of status and
11374         commit when it has been staged), "dirty" will ignore all changes
11375         to the submodule&#8217;s work tree and
11376         takes only differences between the HEAD of the submodule and the commit
11377         recorded in the superproject into account. "untracked" will additionally
11378         let submodules with modified tracked files in their work tree show up.
11379         Using "none" (the default when this option is not set) also shows
11380         submodules that have untracked files in their work tree as changed.
11381         This setting overrides any setting made in .gitmodules for this submodule,
11382         both settings can be overridden on the command line by using the
11383         "--ignore-submodules" option. The <em>git submodule</em> commands are not
11384         affected by this setting.
11385 </p>
11386 </dd>
11387 <dt class="hdlist1">
11388 submodule.&lt;name&gt;.active
11389 </dt>
11390 <dd>
11391 <p>
11392         Boolean value indicating if the submodule is of interest to git
11393         commands.  This config option takes precedence over the
11394         submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
11395         details.
11396 </p>
11397 </dd>
11398 <dt class="hdlist1">
11399 submodule.active
11400 </dt>
11401 <dd>
11402 <p>
11403         A repeated field which contains a pathspec used to match against a
11404         submodule&#8217;s path to determine if the submodule is of interest to git
11405         commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.
11406 </p>
11407 </dd>
11408 <dt class="hdlist1">
11409 submodule.recurse
11410 </dt>
11411 <dd>
11412 <p>
11413         A boolean indicating if commands should enable the <code>--recurse-submodules</code>
11414         option by default. Defaults to false.
11415 </p>
11416 <div class="paragraph"><p>When set to true, it can be deactivated via the
11417 <code>--no-recurse-submodules</code> option. Note that some Git commands
11418 lacking this option may call some of the above commands affected by
11419 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
11420 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
11421 For these commands a workaround is to temporarily change the
11422 configuration value by using <code>git -c submodule.recurse=0</code>.</p></div>
11423 <div class="paragraph"><p>The following list shows the commands that accept
11424 <code>--recurse-submodules</code> and whether they are supported by this
11425 setting.</p></div>
11426 <div class="ulist"><ul>
11427 <li>
11428 <p>
11429 <code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
11430 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.
11431 </p>
11432 </li>
11433 <li>
11434 <p>
11435 <code>clone</code> and <code>ls-files</code> are not supported.
11436 </p>
11437 </li>
11438 <li>
11439 <p>
11440 <code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
11441 enabled
11442 </p>
11443 </li>
11444 </ul></div>
11445 </dd>
11446 <dt class="hdlist1">
11447 submodule.propagateBranches
11448 </dt>
11449 <dd>
11450 <p>
11451         [EXPERIMENTAL] A boolean that enables branching support when
11452         using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
11453         Enabling this will allow certain commands to accept
11454         <code>--recurse-submodules</code> and certain commands that already accept
11455         <code>--recurse-submodules</code> will now consider branches.
11456         Defaults to false.
11457 </p>
11458 </dd>
11459 <dt class="hdlist1">
11460 submodule.fetchJobs
11461 </dt>
11462 <dd>
11463 <p>
11464         Specifies how many submodules are fetched/cloned at the same time.
11465         A positive integer allows up to that number of submodules fetched
11466         in parallel. A value of 0 will give some reasonable default.
11467         If unset, it defaults to 1.
11468 </p>
11469 </dd>
11470 <dt class="hdlist1">
11471 submodule.alternateLocation
11472 </dt>
11473 <dd>
11474 <p>
11475         Specifies how the submodules obtain alternates when submodules are
11476         cloned. Possible values are <code>no</code>, <code>superproject</code>.
11477         By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
11478         value is set to <code>superproject</code> the submodule to be cloned computes
11479         its alternates location relative to the superprojects alternate.
11480 </p>
11481 </dd>
11482 <dt class="hdlist1">
11483 submodule.alternateErrorStrategy
11484 </dt>
11485 <dd>
11486 <p>
11487         Specifies how to treat errors with the alternates for a submodule
11488         as computed via <code>submodule.alternateLocation</code>. Possible values are
11489         <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
11490         or <code>info</code>, and if there is an error with the computed alternate, the
11491         clone proceeds as if no alternate was specified.
11492 </p>
11493 </dd>
11494 <dt class="hdlist1">
11495 tag.forceSignAnnotated
11496 </dt>
11497 <dd>
11498 <p>
11499         A boolean to specify whether annotated tags created should be GPG signed.
11500         If <code>--annotate</code> is specified on the command line, it takes
11501         precedence over this option.
11502 </p>
11503 </dd>
11504 <dt class="hdlist1">
11505 tag.sort
11506 </dt>
11507 <dd>
11508 <p>
11509         This variable controls the sort ordering of tags when displayed by
11510         <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
11511         value of this variable will be used as the default.
11512 </p>
11513 </dd>
11514 <dt class="hdlist1">
11515 tag.gpgSign
11516 </dt>
11517 <dd>
11518 <p>
11519         A boolean to specify whether all tags should be GPG signed.
11520         Use of this option when running in an automated script can
11521         result in a large number of tags being signed. It is therefore
11522         convenient to use an agent to avoid typing your gpg passphrase
11523         several times. Note that this option doesn&#8217;t affect tag signing
11524         behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.
11525 </p>
11526 </dd>
11527 <dt class="hdlist1">
11528 tar.umask
11529 </dt>
11530 <dd>
11531 <p>
11532         This variable can be used to restrict the permission bits of
11533         tar archive entries.  The default is 0002, which turns off the
11534         world write bit.  The special value "user" indicates that the
11535         archiving user&#8217;s umask will be used instead.  See umask(2) and
11536         <a href="git-archive.html">git-archive(1)</a>.
11537 </p>
11538 </dd>
11539 </dl></div>
11540 <div class="paragraph"><p>Trace2 config settings are only read from the system and global
11541 config files; repository local and worktree config files and <code>-c</code>
11542 command line arguments are not respected.</p></div>
11543 <div class="dlist"><dl>
11544 <dt class="hdlist1">
11545 trace2.normalTarget
11546 </dt>
11547 <dd>
11548 <p>
11549         This variable controls the normal target destination.
11550         It may be overridden by the <code>GIT_TRACE2</code> environment variable.
11551         The following table shows possible values.
11552 </p>
11553 </dd>
11554 <dt class="hdlist1">
11555 trace2.perfTarget
11556 </dt>
11557 <dd>
11558 <p>
11559         This variable controls the performance target destination.
11560         It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
11561         The following table shows possible values.
11562 </p>
11563 </dd>
11564 <dt class="hdlist1">
11565 trace2.eventTarget
11566 </dt>
11567 <dd>
11568 <p>
11569         This variable controls the event target destination.
11570         It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
11571         The following table shows possible values.
11572 </p>
11573 <div class="openblock">
11574 <div class="content">
11575 <div class="ulist"><ul>
11576 <li>
11577 <p>
11578 <code>0</code> or <code>false</code> - Disables the target.
11579 </p>
11580 </li>
11581 <li>
11582 <p>
11583 <code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.
11584 </p>
11585 </li>
11586 <li>
11587 <p>
11588 <code>[2-9]</code> - Writes to the already opened file descriptor.
11589 </p>
11590 </li>
11591 <li>
11592 <p>
11593 <code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
11594 already exists and is a directory, the traces will be written to files (one
11595 per process) underneath the given directory.
11596 </p>
11597 </li>
11598 <li>
11599 <p>
11600 <code>af_unix:[&lt;socket-type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
11601 Unix DomainSocket (on platforms that support them).  Socket
11602 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
11603 try both.
11604 </p>
11605 </li>
11606 </ul></div>
11607 </div></div>
11608 </dd>
11609 <dt class="hdlist1">
11610 trace2.normalBrief
11611 </dt>
11612 <dd>
11613 <p>
11614         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11615         omitted from normal output.  May be overridden by the
11616         <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.
11617 </p>
11618 </dd>
11619 <dt class="hdlist1">
11620 trace2.perfBrief
11621 </dt>
11622 <dd>
11623 <p>
11624         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11625         omitted from PERF output.  May be overridden by the
11626         <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.
11627 </p>
11628 </dd>
11629 <dt class="hdlist1">
11630 trace2.eventBrief
11631 </dt>
11632 <dd>
11633 <p>
11634         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11635         omitted from event output.  May be overridden by the
11636         <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.
11637 </p>
11638 </dd>
11639 <dt class="hdlist1">
11640 trace2.eventNesting
11641 </dt>
11642 <dd>
11643 <p>
11644         Integer.  Specifies desired depth of nested regions in the
11645         event output.  Regions deeper than this value will be
11646         omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
11647         environment variable.  Defaults to 2.
11648 </p>
11649 </dd>
11650 <dt class="hdlist1">
11651 trace2.configParams
11652 </dt>
11653 <dd>
11654 <p>
11655         A comma-separated list of patterns of "important" config
11656         settings that should be recorded in the trace2 output.
11657         For example, <code>core.*,remote.*.url</code> would cause the trace2
11658         output to contain events listing each configured remote.
11659         May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
11660         variable.  Unset by default.
11661 </p>
11662 </dd>
11663 <dt class="hdlist1">
11664 trace2.envVars
11665 </dt>
11666 <dd>
11667 <p>
11668         A comma-separated list of "important" environment variables that should
11669         be recorded in the trace2 output.  For example,
11670         <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
11671         contain events listing the overrides for HTTP user agent and the
11672         location of the Git configuration file (assuming any are set).  May be
11673         overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
11674         default.
11675 </p>
11676 </dd>
11677 <dt class="hdlist1">
11678 trace2.destinationDebug
11679 </dt>
11680 <dd>
11681 <p>
11682         Boolean.  When true Git will print error messages when a
11683         trace target destination cannot be opened for writing.
11684         By default, these errors are suppressed and tracing is
11685         silently disabled.  May be overridden by the
11686         <code>GIT_TRACE2_DST_DEBUG</code> environment variable.
11687 </p>
11688 </dd>
11689 <dt class="hdlist1">
11690 trace2.maxFiles
11691 </dt>
11692 <dd>
11693 <p>
11694         Integer.  When writing trace files to a target directory, do not
11695         write additional traces if doing so would exceed this many files. Instead,
11696         write a sentinel file that will block further tracing to this
11697         directory. Defaults to 0, which disables this check.
11698 </p>
11699 </dd>
11700 <dt class="hdlist1">
11701 transfer.credentialsInUrl
11702 </dt>
11703 <dd>
11704 <p>
11705         A configured URL can contain plaintext credentials in the form
11706         <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
11707         to warn or forbid the use of such configuration (in favor of
11708         using <a href="git-credential.html">git-credential(1)</a>). This will be used on
11709         <a href="git-clone.html">git-clone(1)</a>, <a href="git-fetch.html">git-fetch(1)</a>, <a href="git-push.html">git-push(1)</a>,
11710         and any other direct use of the configured URL.
11711 </p>
11712 <div class="paragraph"><p>Note that this is currently limited to detecting credentials in
11713 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
11714 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p></div>
11715 <div class="paragraph"><p>You might want to enable this to prevent inadvertent credentials
11716 exposure, e.g. because:</p></div>
11717 <div class="ulist"><ul>
11718 <li>
11719 <p>
11720 The OS or system where you&#8217;re running git may not provide a way or
11721   otherwise allow you to configure the permissions of the
11722   configuration file where the username and/or password are stored.
11723 </p>
11724 </li>
11725 <li>
11726 <p>
11727 Even if it does, having such data stored "at rest" might expose you
11728   in other ways, e.g. a backup process might copy the data to another
11729   system.
11730 </p>
11731 </li>
11732 <li>
11733 <p>
11734 The git programs will pass the full URL to one another as arguments
11735   on the command-line, meaning the credentials will be exposed to other
11736   unprivileged users on systems that allow them to see the full
11737   process list of other users. On linux the "hidepid" setting
11738   documented in procfs(5) allows for configuring this behavior.
11739 </p>
11740 <div class="paragraph"><p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
11741 concerned about credentials exposure due to storing sensitive
11742 data in git&#8217;s configuration files. If you do want to use this, set
11743 <code>transfer.credentialsInUrl</code> to one of these values:</p></div>
11744 </li>
11745 <li>
11746 <p>
11747 <code>allow</code> (default): Git will proceed with its activity without warning.
11748 </p>
11749 </li>
11750 <li>
11751 <p>
11752 <code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
11753   with a plaintext credential.
11754 </p>
11755 </li>
11756 <li>
11757 <p>
11758 <code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
11759   with a plaintext credential.
11760 </p>
11761 </li>
11762 </ul></div>
11763 </dd>
11764 <dt class="hdlist1">
11765 transfer.fsckObjects
11766 </dt>
11767 <dd>
11768 <p>
11769         When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
11770         not set, the value of this variable is used instead.
11771         Defaults to false.
11772 </p>
11773 <div class="paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
11774 object or a link to a nonexistent object. In addition, various other
11775 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
11776 and potential security issues like the existence of a <code>.GIT</code> directory
11777 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
11778 and v2.17.1 for details). Other sanity and security checks may be
11779 added in future releases.</p></div>
11780 <div class="paragraph"><p>On the receiving side, failing fsckObjects will make those objects
11781 unreachable, see "QUARANTINE ENVIRONMENT" in
11782 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
11783 instead be left unreferenced in the repository.</p></div>
11784 <div class="paragraph"><p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
11785 implementation it cannot be relied upon to leave the object store
11786 clean like <code>receive.fsckObjects</code> can.</p></div>
11787 <div class="paragraph"><p>As objects are unpacked they&#8217;re written to the object store, so there
11788 can be cases where malicious objects get introduced even though the
11789 "fetch" failed, only to have a subsequent "fetch" succeed because only
11790 new incoming objects are checked, not those that have already been
11791 written to the object store. That difference in behavior should not be
11792 relied upon. In the future, such objects may be quarantined for
11793 "fetch" as well.</p></div>
11794 <div class="paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
11795 environment if they&#8217;d like the same protection as "push". E.g. in the
11796 case of an internal mirror do the mirroring in two steps, one to fetch
11797 the untrusted objects, and then do a second "push" (which will use the
11798 quarantine) to another internal repo, and have internal clients
11799 consume this pushed-to repository, or embargo internal fetches and
11800 only allow them once a full "fsck" has run (and no new fetches have
11801 happened in the meantime).</p></div>
11802 </dd>
11803 <dt class="hdlist1">
11804 transfer.hideRefs
11805 </dt>
11806 <dd>
11807 <p>
11808         String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
11809         refs to omit from their initial advertisements.  Use more than
11810         one definition to specify multiple prefix strings. A ref that is
11811         under the hierarchies listed in the value of this variable is
11812         excluded, and is hidden when responding to <code>git push</code> or <code>git
11813         fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
11814         program-specific versions of this config.
11815 </p>
11816 <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
11817 explicitly exposing it, even if an earlier entry marked it as hidden.
11818 If you have multiple hideRefs values, later entries override earlier ones
11819 (and entries in more-specific config files override less-specific ones).</p></div>
11820 <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
11821 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
11822 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
11823 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
11824 <div class="paragraph"><p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
11825 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
11826 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
11827 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
11828 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
11829 <code>receive-pack</code>, on the other hand, will still advertise the object id the
11830 ref is pointing to without mentioning its name (a so-called ".have" line).</p></div>
11831 <div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
11832 objects via the techniques described in the "SECURITY" section of the
11833 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
11834 separate repository.</p></div>
11835 </dd>
11836 <dt class="hdlist1">
11837 transfer.unpackLimit
11838 </dt>
11839 <dd>
11840 <p>
11841         When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
11842         not set, the value of this variable is used instead.
11843         The default value is 100.
11844 </p>
11845 </dd>
11846 <dt class="hdlist1">
11847 transfer.advertiseSID
11848 </dt>
11849 <dd>
11850 <p>
11851         Boolean. When true, client and server processes will advertise their
11852         unique session IDs to their remote counterpart. Defaults to false.
11853 </p>
11854 </dd>
11855 <dt class="hdlist1">
11856 transfer.bundleURI
11857 </dt>
11858 <dd>
11859 <p>
11860         When <code>true</code>, local <code>git clone</code> commands will request bundle
11861         information from the remote server (if advertised) and download
11862         bundles before continuing the clone through the Git protocol.
11863         Defaults to <code>false</code>.
11864 </p>
11865 </dd>
11866 <dt class="hdlist1">
11867 transfer.advertiseObjectInfo
11868 </dt>
11869 <dd>
11870 <p>
11871         When <code>true</code>, the <code>object-info</code> capability is advertised by
11872         servers. Defaults to false.
11873 </p>
11874 </dd>
11875 <dt class="hdlist1">
11876 uploadarchive.allowUnreachable
11877 </dt>
11878 <dd>
11879 <p>
11880         If true, allow clients to use <code>git archive --remote</code> to request
11881         any tree, whether reachable from the ref tips or not. See the
11882         discussion in the "SECURITY" section of
11883         <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
11884         <code>false</code>.
11885 </p>
11886 </dd>
11887 <dt class="hdlist1">
11888 uploadpack.hideRefs
11889 </dt>
11890 <dd>
11891 <p>
11892         This variable is the same as <code>transfer.hideRefs</code>, but applies
11893         only to <code>upload-pack</code> (and so affects only fetches, not pushes).
11894         An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
11895         also <code>uploadpack.allowTipSHA1InWant</code>.
11896 </p>
11897 </dd>
11898 <dt class="hdlist1">
11899 uploadpack.allowTipSHA1InWant
11900 </dt>
11901 <dd>
11902 <p>
11903         When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
11904         to accept a fetch request that asks for an object at the tip
11905         of a hidden ref (by default, such a request is rejected).
11906         See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
11907         may be able to steal objects via the techniques described in the
11908         "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
11909         best to keep private data in a separate repository.
11910 </p>
11911 </dd>
11912 <dt class="hdlist1">
11913 uploadpack.allowReachableSHA1InWant
11914 </dt>
11915 <dd>
11916 <p>
11917         Allow <code>upload-pack</code> to accept a fetch request that asks for an
11918         object that is reachable from any ref tip. However, note that
11919         calculating object reachability is computationally expensive.
11920         Defaults to <code>false</code>.  Even if this is false, a client may be able
11921         to steal objects via the techniques described in the "SECURITY"
11922         section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
11923         keep private data in a separate repository.
11924 </p>
11925 </dd>
11926 <dt class="hdlist1">
11927 uploadpack.allowAnySHA1InWant
11928 </dt>
11929 <dd>
11930 <p>
11931         Allow <code>upload-pack</code> to accept a fetch request that asks for any
11932         object at all.
11933         Defaults to <code>false</code>.
11934 </p>
11935 </dd>
11936 <dt class="hdlist1">
11937 uploadpack.keepAlive
11938 </dt>
11939 <dd>
11940 <p>
11941         When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
11942         quiet period while <code>pack-objects</code> prepares the pack. Normally
11943         it would output progress information, but if <code>--quiet</code> was used
11944         for the fetch, <code>pack-objects</code> will output nothing at all until
11945         the pack data begins. Some clients and networks may consider
11946         the server to be hung and give up. Setting this option instructs
11947         <code>upload-pack</code> to send an empty keepalive packet every
11948         <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
11949         disables keepalive packets entirely. The default is 5 seconds.
11950 </p>
11951 </dd>
11952 <dt class="hdlist1">
11953 uploadpack.packObjectsHook
11954 </dt>
11955 <dd>
11956 <p>
11957         If this option is set, when <code>upload-pack</code> would run
11958         <code>git pack-objects</code> to create a packfile for a client, it will
11959         run this shell command instead.  The <code>pack-objects</code> command and
11960         arguments it <em>would</em> have run (including the <code>git pack-objects</code>
11961         at the beginning) are appended to the shell command. The stdin
11962         and stdout of the hook are treated as if <code>pack-objects</code> itself
11963         was run. I.e., <code>upload-pack</code> will feed input intended for
11964         <code>pack-objects</code> to the hook, and expects a completed packfile on
11965         stdout.
11966 </p>
11967 <div class="paragraph"><p>Note that this configuration variable is only respected when it is specified
11968 in protected configuration (see <a href="#SCOPES">[SCOPES]</a>). This is a safety measure
11969 against fetching from untrusted repositories.</p></div>
11970 </dd>
11971 <dt class="hdlist1">
11972 uploadpack.allowFilter
11973 </dt>
11974 <dd>
11975 <p>
11976         If this option is set, <code>upload-pack</code> will support partial
11977         clone and partial fetch object filtering.
11978 </p>
11979 </dd>
11980 <dt class="hdlist1">
11981 uploadpackfilter.allow
11982 </dt>
11983 <dd>
11984 <p>
11985         Provides a default value for unspecified object filters (see: the
11986         below configuration variable). If set to <code>true</code>, this will also
11987         enable all filters which get added in the future.
11988         Defaults to <code>true</code>.
11989 </p>
11990 </dd>
11991 <dt class="hdlist1">
11992 uploadpackfilter.&lt;filter&gt;.allow
11993 </dt>
11994 <dd>
11995 <p>
11996         Explicitly allow or ban the object filter corresponding to
11997         <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
11998         <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
11999         If using combined filters, both <code>combine</code> and all of the nested
12000         filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.
12001 </p>
12002 </dd>
12003 <dt class="hdlist1">
12004 uploadpackfilter.tree.maxDepth
12005 </dt>
12006 <dd>
12007 <p>
12008         Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
12009         <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
12010         <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
12011         variable had already been set. Has no effect if unset.
12012 </p>
12013 </dd>
12014 <dt class="hdlist1">
12015 uploadpack.allowRefInWant
12016 </dt>
12017 <dd>
12018 <p>
12019         If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
12020         feature of the protocol version 2 <code>fetch</code> command.  This feature
12021         is intended for the benefit of load-balanced servers which may
12022         not have the same view of what OIDs their refs point to due to
12023         replication delay.
12024 </p>
12025 </dd>
12026 <dt class="hdlist1">
12027 url.&lt;base&gt;.insteadOf
12028 </dt>
12029 <dd>
12030 <p>
12031         Any URL that starts with this value will be rewritten to
12032         start, instead, with &lt;base&gt;. In cases where some site serves a
12033         large number of repositories, and serves them with multiple
12034         access methods, and some users need to use different access
12035         methods, this feature allows people to specify any of the
12036         equivalent URLs and have Git automatically rewrite the URL to
12037         the best alternative for the particular user, even for a
12038         never-before-seen repository on the site.  When more than one
12039         insteadOf strings match a given URL, the longest match is used.
12040 </p>
12041 <div class="paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
12042 URL. If the rewrite changes the URL to use a custom protocol or remote
12043 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
12044 the request.  In particular, protocols you expect to use for submodules
12045 must be set to <code>always</code> rather than the default of <code>user</code>. See the
12046 description of <code>protocol.allow</code> above.</p></div>
12047 </dd>
12048 <dt class="hdlist1">
12049 url.&lt;base&gt;.pushInsteadOf
12050 </dt>
12051 <dd>
12052 <p>
12053         Any URL that starts with this value will not be pushed to;
12054         instead, it will be rewritten to start with &lt;base&gt;, and the
12055         resulting URL will be pushed to. In cases where some site serves
12056         a large number of repositories, and serves them with multiple
12057         access methods, some of which do not allow push, this feature
12058         allows people to specify a pull-only URL and have Git
12059         automatically use an appropriate URL to push, even for a
12060         never-before-seen repository on the site.  When more than one
12061         pushInsteadOf strings match a given URL, the longest match is
12062         used.  If a remote has an explicit pushurl, Git will ignore this
12063         setting for that remote.
12064 </p>
12065 </dd>
12066 <dt class="hdlist1">
12067 user.name
12068 </dt>
12069 <dt class="hdlist1">
12070 user.email
12071 </dt>
12072 <dt class="hdlist1">
12073 author.name
12074 </dt>
12075 <dt class="hdlist1">
12076 author.email
12077 </dt>
12078 <dt class="hdlist1">
12079 committer.name
12080 </dt>
12081 <dt class="hdlist1">
12082 committer.email
12083 </dt>
12084 <dd>
12085 <p>
12086         The <code>user.name</code> and <code>user.email</code> variables determine what ends
12087         up in the <code>author</code> and <code>committer</code> fields of commit
12088         objects.
12089         If you need the <code>author</code> or <code>committer</code> to be different, the
12090         <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
12091         <code>committer.email</code> variables can be set.
12092         All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
12093         <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
12094         <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.
12095 </p>
12096 <div class="paragraph"><p>Note that the <code>name</code> forms of these variables conventionally refer to
12097 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
12098 environment variables section of <a href="git.html">git(1)</a> for more information on
12099 these settings and the <code>credential.username</code> option if you&#8217;re looking
12100 for authentication credentials instead.</p></div>
12101 </dd>
12102 <dt class="hdlist1">
12103 user.useConfigOnly
12104 </dt>
12105 <dd>
12106 <p>
12107         Instruct Git to avoid trying to guess defaults for <code>user.email</code>
12108         and <code>user.name</code>, and instead retrieve the values only from the
12109         configuration. For example, if you have multiple email addresses
12110         and would like to use a different one for each repository, then
12111         with this configuration option set to <code>true</code> in the global config
12112         along with a name, Git will prompt you to set up an email before
12113         making new commits in a newly cloned repository.
12114         Defaults to <code>false</code>.
12115 </p>
12116 </dd>
12117 <dt class="hdlist1">
12118 user.signingKey
12119 </dt>
12120 <dd>
12121 <p>
12122         If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
12123         key you want it to automatically when creating a signed tag or
12124         commit, you can override the default selection with this variable.
12125         This option is passed unchanged to gpg&#8217;s --local-user parameter,
12126         so you may specify a key using any method that gpg supports.
12127         If gpg.format is set to <code>ssh</code> this can contain the path to either
12128         your private ssh key or the public key when ssh-agent is used.
12129         Alternatively it can contain a public key prefixed with <code>key::</code>
12130         directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
12131         needs to be available via ssh-agent. If not set Git will call
12132         gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
12133         first key available. For backward compatibility, a raw key which
12134         begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
12135         as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
12136         use the <code>key::</code> form instead.
12137 </p>
12138 </dd>
12139 <dt class="hdlist1">
12140 versionsort.prereleaseSuffix (deprecated)
12141 </dt>
12142 <dd>
12143 <p>
12144         Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
12145         <code>versionsort.suffix</code> is set.
12146 </p>
12147 </dd>
12148 <dt class="hdlist1">
12149 versionsort.suffix
12150 </dt>
12151 <dd>
12152 <p>
12153         Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
12154         with the same base version but different suffixes are still sorted
12155         lexicographically, resulting e.g. in prerelease tags appearing
12156         after the main release (e.g. "1.0-rc1" after "1.0").  This
12157         variable can be specified to determine the sorting order of tags
12158         with different suffixes.
12159 </p>
12160 <div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
12161 that suffix will appear before the corresponding main release.  E.g. if
12162 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
12163 "1.0".  If specified multiple times, once per suffix, then the order of
12164 suffixes in the configuration will determine the sorting order of tagnames
12165 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
12166 configuration, then all "1.0-preX" tags will be listed before any
12167 "1.0-rcX" tags.  The placement of the main release tag relative to tags
12168 with various suffixes can be determined by specifying the empty suffix
12169 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
12170 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
12171 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
12172 "v4.8-bfsX".</p></div>
12173 <div class="paragraph"><p>If more than one suffix matches the same tagname, then that tagname will
12174 be sorted according to the suffix which starts at the earliest position in
12175 the tagname.  If more than one different matching suffix starts at
12176 that earliest position, then that tagname will be sorted according to the
12177 longest of those suffixes.
12178 The sorting order between different suffixes is undefined if they are
12179 in multiple config files.</p></div>
12180 </dd>
12181 <dt class="hdlist1">
12182 web.browser
12183 </dt>
12184 <dd>
12185 <p>
12186         Specify a web browser that may be used by some commands.
12187         Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
12188         may use it.
12189 </p>
12190 </dd>
12191 <dt class="hdlist1">
12192 worktree.guessRemote
12193 </dt>
12194 <dd>
12195 <p>
12196         If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
12197         <code>--detach</code> is used, then <code>git worktree add</code> defaults to
12198         creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
12199         set to true, <code>worktree add</code> tries to find a remote-tracking
12200         branch whose name uniquely matches the new branch name.  If
12201         such a branch exists, it is checked out and set as "upstream"
12202         for the new branch.  If no such match can be found, it falls
12203         back to creating a new branch from the current HEAD.
12204 </p>
12205 </dd>
12206 </dl></div>
12207 </div>
12208 </div>
12209 </div>
12210 <div class="sect1">
12211 <h2 id="_bugs">BUGS</h2>
12212 <div class="sectionbody">
12213 <div class="paragraph"><p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
12214 will result in adding a multi-line key instead of a change, if the subsection
12215 is given with at least one uppercase character. For example when the config
12216 looks like</p></div>
12217 <div class="listingblock">
12218 <div class="content">
12219 <pre><code>  [section.subsection]
12220     key = value1</code></pre>
12221 </div></div>
12222 <div class="paragraph"><p>and running <code>git config section.Subsection.key value2</code> will result in</p></div>
12223 <div class="listingblock">
12224 <div class="content">
12225 <pre><code>  [section.subsection]
12226     key = value1
12227     key = value2</code></pre>
12228 </div></div>
12229 </div>
12230 </div>
12231 <div class="sect1">
12232 <h2 id="_git">GIT</h2>
12233 <div class="sectionbody">
12234 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
12235 </div>
12236 </div>
12237 </div>
12238 <div id="footnotes"><hr /></div>
12239 <div id="footer">
12240 <div id="footer-text">
12241 Last updated
12242  2024-05-16 11:09:25 PDT
12243 </div>
12244 </div>
12245 </body>
12246 </html>