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 rebaseTodoError
2382 </dt>
2383 <dd>
2384 <p>
2385                 Shown when there is an error after editing the rebase todo list.
2386 </p>
2387 </dd>
2388 <dt class="hdlist1">
2389 refSyntax
2390 </dt>
2391 <dd>
2392 <p>
2393                 Shown when the user provides an illegal ref name, to
2394                 tell the user about the ref syntax documentation.
2395 </p>
2396 </dd>
2397 <dt class="hdlist1">
2398 resetNoRefresh
2399 </dt>
2400 <dd>
2401 <p>
2402                 Shown when <a href="git-reset.html">git-reset(1)</a> takes more than 2
2403                 seconds to refresh the index after reset, to tell the user
2404                 that they can use the <code>--no-refresh</code> option.
2405 </p>
2406 </dd>
2407 <dt class="hdlist1">
2408 resolveConflict
2409 </dt>
2410 <dd>
2411 <p>
2412                 Shown by various commands when conflicts
2413                 prevent the operation from being performed.
2414 </p>
2415 </dd>
2416 <dt class="hdlist1">
2417 rmHints
2418 </dt>
2419 <dd>
2420 <p>
2421                 Shown on failure in the output of <a href="git-rm.html">git-rm(1)</a>, to
2422                 give directions on how to proceed from the current state.
2423 </p>
2424 </dd>
2425 <dt class="hdlist1">
2426 sequencerInUse
2427 </dt>
2428 <dd>
2429 <p>
2430                 Shown when a sequencer command is already in progress.
2431 </p>
2432 </dd>
2433 <dt class="hdlist1">
2434 skippedCherryPicks
2435 </dt>
2436 <dd>
2437 <p>
2438                 Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
2439                 been cherry-picked onto the upstream branch.
2440 </p>
2441 </dd>
2442 <dt class="hdlist1">
2443 statusAheadBehind
2444 </dt>
2445 <dd>
2446 <p>
2447                 Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
2448                 counts for a local ref compared to its remote tracking ref,
2449                 and that calculation takes longer than expected. Will not
2450                 appear if <code>status.aheadBehind</code> is false or the option
2451                 <code>--no-ahead-behind</code> is given.
2452 </p>
2453 </dd>
2454 <dt class="hdlist1">
2455 statusHints
2456 </dt>
2457 <dd>
2458 <p>
2459                 Show directions on how to proceed from the current
2460                 state in the output of <a href="git-status.html">git-status(1)</a>, in
2461                 the template shown when writing commit messages in
2462                 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
2463                 by <a href="git-switch.html">git-switch(1)</a> or
2464                 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.
2465 </p>
2466 </dd>
2467 <dt class="hdlist1">
2468 statusUoption
2469 </dt>
2470 <dd>
2471 <p>
2472                 Shown when <a href="git-status.html">git-status(1)</a> takes more than 2
2473                 seconds to enumerate untracked files, to tell the user that
2474                 they can use the <code>-u</code> option.
2475 </p>
2476 </dd>
2477 <dt class="hdlist1">
2478 submoduleAlternateErrorStrategyDie
2479 </dt>
2480 <dd>
2481 <p>
2482                 Shown when a submodule.alternateErrorStrategy option
2483                 configured to "die" causes a fatal error.
2484 </p>
2485 </dd>
2486 <dt class="hdlist1">
2487 submoduleMergeConflict
2488 </dt>
2489 <dd>
2490 <p>
2491                 Advice shown when a non-trivial submodule merge conflict is
2492                 encountered.
2493 </p>
2494 </dd>
2495 <dt class="hdlist1">
2496 submodulesNotUpdated
2497 </dt>
2498 <dd>
2499 <p>
2500                 Shown when a user runs a submodule command that fails
2501                 because <code>git submodule update --init</code> was not run.
2502 </p>
2503 </dd>
2504 <dt class="hdlist1">
2505 suggestDetachingHead
2506 </dt>
2507 <dd>
2508 <p>
2509                 Shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
2510                 without the explicit <code>--detach</code> option.
2511 </p>
2512 </dd>
2513 <dt class="hdlist1">
2514 updateSparsePath
2515 </dt>
2516 <dd>
2517 <p>
2518                 Shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
2519                 is asked to update index entries outside the current sparse
2520                 checkout.
2521 </p>
2522 </dd>
2523 <dt class="hdlist1">
2524 waitingForEditor
2525 </dt>
2526 <dd>
2527 <p>
2528                 Shown when Git is waiting for editor input. Relevant
2529                 when e.g. the editor is not launched inside the terminal.
2530 </p>
2531 </dd>
2532 <dt class="hdlist1">
2533 worktreeAddOrphan
2534 </dt>
2535 <dd>
2536 <p>
2537                 Shown when the user tries to create a worktree from an
2538                 invalid reference, to tell the user how to create a new unborn
2539                 branch instead.
2540 </p>
2541 </dd>
2542 </dl></div>
2543 </div></div>
2544 </dd>
2545 <dt class="hdlist1">
2546 alias.*
2547 </dt>
2548 <dd>
2549 <p>
2550         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
2551         after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
2552         <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
2553         confusion and troubles with script usage, aliases that
2554         hide existing Git commands are ignored. Arguments are split by
2555         spaces, the usual shell quoting and escaping are supported.
2556         A quote pair or a backslash can be used to quote them.
2557 </p>
2558 <div class="paragraph"><p>Note that the first word of an alias does not necessarily have to be a
2559 command. It can be a command-line option that will be passed into the
2560 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
2561 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
2562 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
2563 running <code>git loud-rebase</code> would be equivalent to
2564 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
2565 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
2566 where the original command does not.</p></div>
2567 <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
2568 it will be treated as a shell command.  For example, defining
2569 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
2570 <code>git new</code> is equivalent to running the shell command
2571 <code>gitk --all --not ORIG_HEAD</code>.  Note:</p></div>
2572 <div class="ulist"><ul>
2573 <li>
2574 <p>
2575 Shell commands will be executed from the top-level directory of a
2576   repository, which may not necessarily be the current directory.
2577 </p>
2578 </li>
2579 <li>
2580 <p>
2581 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
2582   from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.
2583 </p>
2584 </li>
2585 <li>
2586 <p>
2587 Shell command aliases always receive any extra arguments provided to
2588   the Git command-line as positional arguments.
2589 </p>
2590 <div class="ulist"><ul>
2591 <li>
2592 <p>
2593 Care should be taken if your shell alias is a "one-liner" script
2594    with multiple commands (e.g. in a pipeline), references multiple
2595    arguments, or is otherwise not able to handle positional arguments
2596    added at the end.  For example: <code>alias.cmd = "!echo $1 | grep $2"</code>
2597    called as <code>git cmd 1 2</code> will be executed as <em>echo $1 | grep $2
2598    1 2</em>, which is not what you want.
2599 </p>
2600 </li>
2601 <li>
2602 <p>
2603 A convenient way to deal with this is to write your script
2604    operations in an inline function that is then called with any
2605    arguments from the command-line.  For example `alias.cmd = "!c() {
2606    echo $1 | grep $2 ; }; c" will correctly execute the prior example.
2607 </p>
2608 </li>
2609 <li>
2610 <p>
2611 Setting <code>GIT_TRACE=1</code> can help you debug the command being run for
2612    your alias.
2613 </p>
2614 </li>
2615 </ul></div>
2616 </li>
2617 </ul></div>
2618 </dd>
2619 <dt class="hdlist1">
2620 am.keepcr
2621 </dt>
2622 <dd>
2623 <p>
2624         If true, git-am will call git-mailsplit for patches in mbox format
2625         with parameter <code>--keep-cr</code>. In this case git-mailsplit will
2626         not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
2627         by giving <code>--no-keep-cr</code> from the command line.
2628         See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
2629 </p>
2630 </dd>
2631 <dt class="hdlist1">
2632 am.threeWay
2633 </dt>
2634 <dd>
2635 <p>
2636         By default, <code>git am</code> will fail if the patch does not apply cleanly. When
2637         set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
2638         the patch records the identity of blobs it is supposed to apply to and
2639         we have those blobs available locally (equivalent to giving the <code>--3way</code>
2640         option from the command line). Defaults to <code>false</code>.
2641         See <a href="git-am.html">git-am(1)</a>.
2642 </p>
2643 </dd>
2644 <dt class="hdlist1">
2645 apply.ignoreWhitespace
2646 </dt>
2647 <dd>
2648 <p>
2649         When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
2650         whitespace, in the same way as the <code>--ignore-space-change</code>
2651         option.
2652         When set to one of: no, none, never, false, it tells <em>git apply</em> to
2653         respect all whitespace differences.
2654         See <a href="git-apply.html">git-apply(1)</a>.
2655 </p>
2656 </dd>
2657 <dt class="hdlist1">
2658 apply.whitespace
2659 </dt>
2660 <dd>
2661 <p>
2662         Tells <em>git apply</em> how to handle whitespace, in the same way
2663         as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
2664 </p>
2665 </dd>
2666 <dt class="hdlist1">
2667 attr.tree
2668 </dt>
2669 <dd>
2670 <p>
2671         A reference to a tree in the repository from which to read attributes,
2672         instead of the <code>.gitattributes</code> file in the working tree. In a bare
2673         repository, this defaults to <code>HEAD:.gitattributes</code>. If the value does
2674         not resolve to a valid tree object, an empty tree is used instead.
2675         When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2676         command line option are used, this configuration variable has no effect.
2677 </p>
2678 </dd>
2679 <dt class="hdlist1">
2680 blame.blankBoundary
2681 </dt>
2682 <dd>
2683 <p>
2684         Show blank commit object name for boundary commits in
2685         <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.
2686 </p>
2687 </dd>
2688 <dt class="hdlist1">
2689 blame.coloring
2690 </dt>
2691 <dd>
2692 <p>
2693         This determines the coloring scheme to be applied to blame
2694         output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
2695         or <em>none</em> which is the default.
2696 </p>
2697 </dd>
2698 <dt class="hdlist1">
2699 blame.date
2700 </dt>
2701 <dd>
2702 <p>
2703         Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
2704         If unset the iso format is used. For supported values,
2705         see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.
2706 </p>
2707 </dd>
2708 <dt class="hdlist1">
2709 blame.showEmail
2710 </dt>
2711 <dd>
2712 <p>
2713         Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
2714         This option defaults to false.
2715 </p>
2716 </dd>
2717 <dt class="hdlist1">
2718 blame.showRoot
2719 </dt>
2720 <dd>
2721 <p>
2722         Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
2723         This option defaults to false.
2724 </p>
2725 </dd>
2726 <dt class="hdlist1">
2727 blame.ignoreRevsFile
2728 </dt>
2729 <dd>
2730 <p>
2731         Ignore revisions listed in the file, one unabbreviated object name per
2732         line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
2733         <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
2734         file names will reset the list of ignored revisions.  This option will
2735         be handled before the command line option <code>--ignore-revs-file</code>.
2736 </p>
2737 </dd>
2738 <dt class="hdlist1">
2739 blame.markUnblamableLines
2740 </dt>
2741 <dd>
2742 <p>
2743         Mark lines that were changed by an ignored revision that we could not
2744         attribute to another commit with a <em>*</em> in the output of
2745         <a href="git-blame.html">git-blame(1)</a>.
2746 </p>
2747 </dd>
2748 <dt class="hdlist1">
2749 blame.markIgnoredLines
2750 </dt>
2751 <dd>
2752 <p>
2753         Mark lines that were changed by an ignored revision that we attributed to
2754         another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.
2755 </p>
2756 </dd>
2757 <dt class="hdlist1">
2758 branch.autoSetupMerge
2759 </dt>
2760 <dd>
2761 <p>
2762         Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
2763         so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
2764         starting point branch. Note that even if this option is not set,
2765         this behavior can be chosen per-branch using the <code>--track</code>
2766         and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
2767         automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
2768         starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;        automatic setup is done when the starting point is either a
2769         local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
2770         has a tracking configuration, it is copied to the new
2771         branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
2772         is a remote-tracking branch and the new branch has the same name as the
2773         remote branch. This option defaults to true.
2774 </p>
2775 </dd>
2776 <dt class="hdlist1">
2777 branch.autoSetupRebase
2778 </dt>
2779 <dd>
2780 <p>
2781         When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
2782         that tracks another branch, this variable tells Git to set
2783         up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
2784         When <code>never</code>, rebase is never automatically set to true.
2785         When <code>local</code>, rebase is set to true for tracked branches of
2786         other local branches.
2787         When <code>remote</code>, rebase is set to true for tracked branches of
2788         remote-tracking branches.
2789         When <code>always</code>, rebase will be set to true for all tracking
2790         branches.
2791         See "branch.autoSetupMerge" for details on how to set up a
2792         branch to track another branch.
2793         This option defaults to never.
2794 </p>
2795 </dd>
2796 <dt class="hdlist1">
2797 branch.sort
2798 </dt>
2799 <dd>
2800 <p>
2801         This variable controls the sort ordering of branches when displayed by
2802         <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
2803         value of this variable will be used as the default.
2804         See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.
2805 </p>
2806 </dd>
2807 <dt class="hdlist1">
2808 branch.&lt;name&gt;.remote
2809 </dt>
2810 <dd>
2811 <p>
2812         When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
2813         which remote to fetch from or push to.  The remote to push to
2814         may be overridden with <code>remote.pushDefault</code> (for all branches).
2815         The remote to push to, for the current branch, may be further
2816         overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
2817         configured, or if you are not on any branch and there is more than
2818         one remote defined in the repository, it defaults to <code>origin</code> for
2819         fetching and <code>remote.pushDefault</code> for pushing.
2820         Additionally, <code>.</code> (a period) is the current local repository
2821         (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
2822 </p>
2823 </dd>
2824 <dt class="hdlist1">
2825 branch.&lt;name&gt;.pushRemote
2826 </dt>
2827 <dd>
2828 <p>
2829         When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
2830         pushing.  It also overrides <code>remote.pushDefault</code> for pushing
2831         from branch &lt;name&gt;.  When you pull from one place (e.g. your
2832         upstream) and push to another place (e.g. your own publishing
2833         repository), you would want to set <code>remote.pushDefault</code> to
2834         specify the remote to push to for all branches, and use this
2835         option to override it for a specific branch.
2836 </p>
2837 </dd>
2838 <dt class="hdlist1">
2839 branch.&lt;name&gt;.merge
2840 </dt>
2841 <dd>
2842 <p>
2843         Defines, together with branch.&lt;name&gt;.remote, the upstream branch
2844         for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
2845         branch to merge and can also affect <em>git push</em> (see push.default).
2846         When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
2847         refspec to be marked for merging in FETCH_HEAD. The value is
2848         handled like the remote part of a refspec, and must match a
2849         ref which is fetched from the remote given by
2850         "branch.&lt;name&gt;.remote".
2851         The merge information is used by <em>git pull</em> (which first calls
2852         <em>git fetch</em>) to lookup the default branch for merging. Without
2853         this option, <em>git pull</em> defaults to merge the first refspec fetched.
2854         Specify multiple values to get an octopus merge.
2855         If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
2856         another branch in the local repository, you can point
2857         branch.&lt;name&gt;.merge to the desired branch, and use the relative path
2858         setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
2859 </p>
2860 </dd>
2861 <dt class="hdlist1">
2862 branch.&lt;name&gt;.mergeOptions
2863 </dt>
2864 <dd>
2865 <p>
2866         Sets default options for merging into branch &lt;name&gt;. The syntax and
2867         supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
2868         option values containing whitespace characters are currently not
2869         supported.
2870 </p>
2871 </dd>
2872 <dt class="hdlist1">
2873 branch.&lt;name&gt;.rebase
2874 </dt>
2875 <dd>
2876 <p>
2877         When true, rebase the branch &lt;name&gt; on top of the fetched branch,
2878         instead of merging the default branch from the default remote when
2879         "git pull" is run. See "pull.rebase" for doing this in a non
2880         branch-specific manner.
2881 </p>
2882 <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>
2883 so that the local merge commits are included in the rebase (see
2884 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
2885 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
2886 mode.</p></div>
2887 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
2888 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
2889 for details).</p></div>
2890 </dd>
2891 <dt class="hdlist1">
2892 branch.&lt;name&gt;.description
2893 </dt>
2894 <dd>
2895 <p>
2896         Branch description, can be edited with
2897         <code>git branch --edit-description</code>. Branch description is
2898         automatically added to the format-patch cover letter or
2899         request-pull summary.
2900 </p>
2901 </dd>
2902 <dt class="hdlist1">
2903 browser.&lt;tool&gt;.cmd
2904 </dt>
2905 <dd>
2906 <p>
2907         Specify the command to invoke the specified browser. The
2908         specified command is evaluated in shell with the URLs passed
2909         as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
2910 </p>
2911 </dd>
2912 <dt class="hdlist1">
2913 browser.&lt;tool&gt;.path
2914 </dt>
2915 <dd>
2916 <p>
2917         Override the path for the given tool that may be used to
2918         browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
2919         working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
2920 </p>
2921 </dd>
2922 <dt class="hdlist1">
2923 bundle.*
2924 </dt>
2925 <dd>
2926 <p>
2927         The <code>bundle.*</code> keys may appear in a bundle list file found via the
2928         <code>git clone --bundle-uri</code> option. These keys currently have no effect
2929         if placed in a repository config file, though this will change in the
2930         future. See <a href="technical/bundle-uri.html">the bundle URI design
2931         document</a> for more details.
2932 </p>
2933 </dd>
2934 <dt class="hdlist1">
2935 bundle.version
2936 </dt>
2937 <dd>
2938 <p>
2939         This integer value advertises the version of the bundle list format
2940         used by the bundle list. Currently, the only accepted value is <code>1</code>.
2941 </p>
2942 </dd>
2943 <dt class="hdlist1">
2944 bundle.mode
2945 </dt>
2946 <dd>
2947 <p>
2948         This string value should be either <code>all</code> or <code>any</code>. This value describes
2949         whether all of the advertised bundles are required to unbundle a
2950         complete understanding of the bundled information (<code>all</code>) or if any one
2951         of the listed bundle URIs is sufficient (<code>any</code>).
2952 </p>
2953 </dd>
2954 <dt class="hdlist1">
2955 bundle.heuristic
2956 </dt>
2957 <dd>
2958 <p>
2959         If this string-valued key exists, then the bundle list is designed to
2960         work well with incremental <code>git fetch</code> commands. The heuristic signals
2961         that there are additional keys available for each bundle that help
2962         determine which subset of bundles the client should download. The
2963         only value currently understood is <code>creationToken</code>.
2964 </p>
2965 </dd>
2966 <dt class="hdlist1">
2967 bundle.&lt;id&gt;.*
2968 </dt>
2969 <dd>
2970 <p>
2971         The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
2972         bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.
2973 </p>
2974 </dd>
2975 <dt class="hdlist1">
2976 bundle.&lt;id&gt;.uri
2977 </dt>
2978 <dd>
2979 <p>
2980         This string value defines the URI by which Git can reach the contents
2981         of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.
2982 </p>
2983 </dd>
2984 <dt class="hdlist1">
2985 checkout.defaultRemote
2986 </dt>
2987 <dd>
2988 <p>
2989         When you run <code>git checkout &lt;something&gt;</code>
2990         or <code>git switch &lt;something&gt;</code> and only have one
2991         remote, it may implicitly fall back on checking out and
2992         tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
2993         as you have more than one remote with a <code>&lt;something&gt;</code>
2994         reference. This setting allows for setting the name of a
2995         preferred remote that should always win when it comes to
2996         disambiguation. The typical use-case is to set this to
2997         <code>origin</code>.
2998 </p>
2999 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
3000 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
3001 or <code>git switch &lt;something&gt;</code>
3002 will checkout the <code>&lt;something&gt;</code> branch on another remote,
3003 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
3004 remote branch. This setting might be used for other checkout-like
3005 commands or functionality in the future.</p></div>
3006 </dd>
3007 <dt class="hdlist1">
3008 checkout.guess
3009 </dt>
3010 <dd>
3011 <p>
3012         Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
3013         option in <code>git checkout</code> and <code>git switch</code>. See
3014         <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
3015 </p>
3016 </dd>
3017 <dt class="hdlist1">
3018 checkout.workers
3019 </dt>
3020 <dd>
3021 <p>
3022         The number of parallel workers to use when updating the working tree.
3023         The default is one, i.e. sequential execution. If set to a value less
3024         than one, Git will use as many workers as the number of logical cores
3025         available. This setting and <code>checkout.thresholdForParallelism</code> affect
3026         all commands that perform checkout. E.g. checkout, clone, reset,
3027         sparse-checkout, etc.
3028 </p>
3029 <div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories
3030 located on SSDs or over NFS. For repositories on spinning disks and/or machines
3031 with a small number of cores, the default sequential checkout often performs
3032 better. The size and compression level of a repository might also influence how
3033 well the parallel version performs.</p></div>
3034 </dd>
3035 <dt class="hdlist1">
3036 checkout.thresholdForParallelism
3037 </dt>
3038 <dd>
3039 <p>
3040         When running parallel checkout with a small number of files, the cost
3041         of subprocess spawning and inter-process communication might outweigh
3042         the parallelization gains. This setting allows you to define the minimum
3043         number of files for which parallel checkout should be attempted. The
3044         default is 100.
3045 </p>
3046 </dd>
3047 <dt class="hdlist1">
3048 clean.requireForce
3049 </dt>
3050 <dd>
3051 <p>
3052         A boolean to make git-clean refuse to delete files unless -f
3053         is given. Defaults to true.
3054 </p>
3055 </dd>
3056 <dt class="hdlist1">
3057 <code>clone.defaultRemoteName</code>
3058 </dt>
3059 <dd>
3060 <p>
3061         The name of the remote to create when cloning a repository.  Defaults to
3062         <code>origin</code>.
3063         It can be overridden by passing the <code>--origin</code> command-line
3064         option to <a href="git-clone.html">git-clone(1)</a>.
3065 </p>
3066 </dd>
3067 <dt class="hdlist1">
3068 <code>clone.rejectShallow</code>
3069 </dt>
3070 <dd>
3071 <p>
3072         Reject cloning a repository if it is a shallow one; this can be overridden by
3073         passing the <code>--reject-shallow</code> option on the command line.
3074         See <a href="git-clone.html">git-clone(1)</a>.
3075 </p>
3076 </dd>
3077 <dt class="hdlist1">
3078 <code>clone.filterSubmodules</code>
3079 </dt>
3080 <dd>
3081 <p>
3082         If a partial clone filter is provided (see <code>--filter</code> in
3083         <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
3084         the filter to submodules.
3085 </p>
3086 </dd>
3087 <dt class="hdlist1">
3088 color.advice
3089 </dt>
3090 <dd>
3091 <p>
3092         A boolean to enable/disable color in hints (e.g. when a push
3093         failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
3094         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
3095         are used only when the error output goes to a terminal. If
3096         unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3097 </p>
3098 </dd>
3099 <dt class="hdlist1">
3100 color.advice.hint
3101 </dt>
3102 <dd>
3103 <p>
3104         Use customized color for hints.
3105 </p>
3106 </dd>
3107 <dt class="hdlist1">
3108 color.blame.highlightRecent
3109 </dt>
3110 <dd>
3111 <p>
3112         Specify the line annotation color for <code>git blame --color-by-age</code>
3113         depending upon the age of the line.
3114 </p>
3115 <div class="paragraph"><p>This setting should be set to a comma-separated list of color and
3116 date settings, starting and ending with a color, the dates should be
3117 set from oldest to newest. The metadata will be colored with the
3118 specified colors if the line was introduced before the given
3119 timestamp, overwriting older timestamped colors.</p></div>
3120 <div class="paragraph"><p>Instead of an absolute timestamp relative timestamps work as well,
3121 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
3122 <div class="paragraph"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
3123 colors everything older than one year blue, recent changes between
3124 one month and one year old are kept white, and lines introduced
3125 within the last month are colored red.</p></div>
3126 </dd>
3127 <dt class="hdlist1">
3128 color.blame.repeatedLines
3129 </dt>
3130 <dd>
3131 <p>
3132         Use the specified color to colorize line annotations for
3133         <code>git blame --color-lines</code>, if they come from the same commit as the
3134         preceding line. Defaults to cyan.
3135 </p>
3136 </dd>
3137 <dt class="hdlist1">
3138 color.branch
3139 </dt>
3140 <dd>
3141 <p>
3142         A boolean to enable/disable color in the output of
3143         <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
3144         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3145         only when the output is to a terminal. If unset, then the
3146         value of <code>color.ui</code> is used (<code>auto</code> by default).
3147 </p>
3148 </dd>
3149 <dt class="hdlist1">
3150 color.branch.&lt;slot&gt;
3151 </dt>
3152 <dd>
3153 <p>
3154         Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
3155         <code>current</code> (the current branch), <code>local</code> (a local branch),
3156         <code>remote</code> (a remote-tracking branch in refs/remotes/),
3157         <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
3158         refs).
3159 </p>
3160 </dd>
3161 <dt class="hdlist1">
3162 color.diff
3163 </dt>
3164 <dd>
3165 <p>
3166         Whether to use ANSI escape sequences to add color to patches.
3167         If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
3168         <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
3169         for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
3170         commands will only use color when output is to the terminal.
3171         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
3172         default).
3173 </p>
3174 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
3175 <em>git-diff-&#42;</em> plumbing commands.  Can be overridden on the
3176 command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
3177 </dd>
3178 <dt class="hdlist1">
3179 color.diff.&lt;slot&gt;
3180 </dt>
3181 <dd>
3182 <p>
3183         Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
3184         which part of the patch to use the specified color, and is one
3185         of <code>context</code> (context text - <code>plain</code> is a historical synonym),
3186         <code>meta</code> (metainformation), <code>frag</code>
3187         (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
3188         <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
3189         (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
3190         <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
3191         <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
3192         <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
3193         setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
3194         <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
3195         <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).
3196 </p>
3197 </dd>
3198 <dt class="hdlist1">
3199 color.decorate.&lt;slot&gt;
3200 </dt>
3201 <dd>
3202 <p>
3203         Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
3204         of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
3205         branches, remote-tracking branches, tags, stash and HEAD, respectively
3206         and <code>grafted</code> for grafted commits.
3207 </p>
3208 </dd>
3209 <dt class="hdlist1">
3210 color.grep
3211 </dt>
3212 <dd>
3213 <p>
3214         When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
3215         <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
3216         when the output is written to the terminal.  If unset, then the
3217         value of <code>color.ui</code> is used (<code>auto</code> by default).
3218 </p>
3219 </dd>
3220 <dt class="hdlist1">
3221 color.grep.&lt;slot&gt;
3222 </dt>
3223 <dd>
3224 <p>
3225         Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
3226         part of the line to use the specified color, and is one of
3227 </p>
3228 <div class="openblock">
3229 <div class="content">
3230 <div class="dlist"><dl>
3231 <dt class="hdlist1">
3232 <code>context</code>
3233 </dt>
3234 <dd>
3235 <p>
3236         non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
3237 </p>
3238 </dd>
3239 <dt class="hdlist1">
3240 <code>filename</code>
3241 </dt>
3242 <dd>
3243 <p>
3244         filename prefix (when not using <code>-h</code>)
3245 </p>
3246 </dd>
3247 <dt class="hdlist1">
3248 <code>function</code>
3249 </dt>
3250 <dd>
3251 <p>
3252         function name lines (when using <code>-p</code>)
3253 </p>
3254 </dd>
3255 <dt class="hdlist1">
3256 <code>lineNumber</code>
3257 </dt>
3258 <dd>
3259 <p>
3260         line number prefix (when using <code>-n</code>)
3261 </p>
3262 </dd>
3263 <dt class="hdlist1">
3264 <code>column</code>
3265 </dt>
3266 <dd>
3267 <p>
3268         column number prefix (when using <code>--column</code>)
3269 </p>
3270 </dd>
3271 <dt class="hdlist1">
3272 <code>match</code>
3273 </dt>
3274 <dd>
3275 <p>
3276         matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
3277 </p>
3278 </dd>
3279 <dt class="hdlist1">
3280 <code>matchContext</code>
3281 </dt>
3282 <dd>
3283 <p>
3284         matching text in context lines
3285 </p>
3286 </dd>
3287 <dt class="hdlist1">
3288 <code>matchSelected</code>
3289 </dt>
3290 <dd>
3291 <p>
3292         matching text in selected lines. Also, used to customize the following
3293         <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.
3294 </p>
3295 </dd>
3296 <dt class="hdlist1">
3297 <code>selected</code>
3298 </dt>
3299 <dd>
3300 <p>
3301         non-matching text in selected lines. Also, used to customize the
3302         following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
3303         <code>--committer</code>.
3304 </p>
3305 </dd>
3306 <dt class="hdlist1">
3307 <code>separator</code>
3308 </dt>
3309 <dd>
3310 <p>
3311         separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
3312         and between hunks (<code>--</code>)
3313 </p>
3314 </dd>
3315 </dl></div>
3316 </div></div>
3317 </dd>
3318 <dt class="hdlist1">
3319 color.interactive
3320 </dt>
3321 <dd>
3322 <p>
3323         When set to <code>always</code>, always use colors for interactive prompts
3324         and displays (such as those used by "git-add --interactive" and
3325         "git-clean --interactive"). When false (or <code>never</code>), never.
3326         When set to <code>true</code> or <code>auto</code>, use colors only when the output is
3327         to the terminal. If unset, then the value of <code>color.ui</code> is
3328         used (<code>auto</code> by default).
3329 </p>
3330 </dd>
3331 <dt class="hdlist1">
3332 color.interactive.&lt;slot&gt;
3333 </dt>
3334 <dd>
3335 <p>
3336         Use customized color for <em>git add --interactive</em> and <em>git clean
3337         --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
3338         or <code>error</code>, for four distinct types of normal output from
3339         interactive commands.
3340 </p>
3341 </dd>
3342 <dt class="hdlist1">
3343 color.pager
3344 </dt>
3345 <dd>
3346 <p>
3347         A boolean to specify whether <code>auto</code> color modes should colorize
3348         output going to the pager. Defaults to true; set this to false
3349         if your pager does not understand ANSI color codes.
3350 </p>
3351 </dd>
3352 <dt class="hdlist1">
3353 color.push
3354 </dt>
3355 <dd>
3356 <p>
3357         A boolean to enable/disable color in push errors. May be set to
3358         <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3359         case colors are used only when the error output goes to a terminal.
3360         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3361 </p>
3362 </dd>
3363 <dt class="hdlist1">
3364 color.push.error
3365 </dt>
3366 <dd>
3367 <p>
3368         Use customized color for push errors.
3369 </p>
3370 </dd>
3371 <dt class="hdlist1">
3372 color.remote
3373 </dt>
3374 <dd>
3375 <p>
3376         If set, keywords at the start of the line are highlighted. The
3377         keywords are "error", "warning", "hint" and "success", and are
3378         matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
3379         <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
3380         <code>color.ui</code> is used (<code>auto</code> by default).
3381 </p>
3382 </dd>
3383 <dt class="hdlist1">
3384 color.remote.&lt;slot&gt;
3385 </dt>
3386 <dd>
3387 <p>
3388         Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
3389         <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
3390         corresponding keyword.
3391 </p>
3392 </dd>
3393 <dt class="hdlist1">
3394 color.showBranch
3395 </dt>
3396 <dd>
3397 <p>
3398         A boolean to enable/disable color in the output of
3399         <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
3400         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3401         only when the output is to a terminal. If unset, then the
3402         value of <code>color.ui</code> is used (<code>auto</code> by default).
3403 </p>
3404 </dd>
3405 <dt class="hdlist1">
3406 color.status
3407 </dt>
3408 <dd>
3409 <p>
3410         A boolean to enable/disable color in the output of
3411         <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
3412         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3413         only when the output is to a terminal. If unset, then the
3414         value of <code>color.ui</code> is used (<code>auto</code> by default).
3415 </p>
3416 </dd>
3417 <dt class="hdlist1">
3418 color.status.&lt;slot&gt;
3419 </dt>
3420 <dd>
3421 <p>
3422         Use customized color for status colorization. <code>&lt;slot&gt;</code> is
3423         one of <code>header</code> (the header text of the status message),
3424         <code>added</code> or <code>updated</code> (files which are added but not committed),
3425         <code>changed</code> (files which are changed but not added in the index),
3426         <code>untracked</code> (files which are not tracked by Git),
3427         <code>branch</code> (the current branch),
3428         <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
3429         to red),
3430         <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
3431         respectively, when branch and tracking information is displayed in the
3432         status short-format), or
3433         <code>unmerged</code> (files which have unmerged changes).
3434 </p>
3435 </dd>
3436 <dt class="hdlist1">
3437 color.transport
3438 </dt>
3439 <dd>
3440 <p>
3441         A boolean to enable/disable color when pushes are rejected. May be
3442         set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3443         case colors are used only when the error output goes to a terminal.
3444         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3445 </p>
3446 </dd>
3447 <dt class="hdlist1">
3448 color.transport.rejected
3449 </dt>
3450 <dd>
3451 <p>
3452         Use customized color when a push was rejected.
3453 </p>
3454 </dd>
3455 <dt class="hdlist1">
3456 color.ui
3457 </dt>
3458 <dd>
3459 <p>
3460         This variable determines the default value for variables such
3461         as <code>color.diff</code> and <code>color.grep</code> that control the use of color
3462         per command family. Its scope will expand as more commands learn
3463         configuration to set a default for the <code>--color</code> option.  Set it
3464         to <code>false</code> or <code>never</code> if you prefer Git commands not to use
3465         color unless enabled explicitly with some other configuration
3466         or the <code>--color</code> option. Set it to <code>always</code> if you want all
3467         output not intended for machine consumption to use color, to
3468         <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
3469         want such output to use color when written to the terminal.
3470 </p>
3471 </dd>
3472 <dt class="hdlist1">
3473 column.ui
3474 </dt>
3475 <dd>
3476 <p>
3477         Specify whether supported commands should output in columns.
3478         This variable consists of a list of tokens separated by spaces
3479         or commas:
3480 </p>
3481 <div class="paragraph"><p>These options control when the feature should be enabled
3482 (defaults to <em>never</em>):</p></div>
3483 <div class="openblock">
3484 <div class="content">
3485 <div class="dlist"><dl>
3486 <dt class="hdlist1">
3487 <code>always</code>
3488 </dt>
3489 <dd>
3490 <p>
3491         always show in columns
3492 </p>
3493 </dd>
3494 <dt class="hdlist1">
3495 <code>never</code>
3496 </dt>
3497 <dd>
3498 <p>
3499         never show in columns
3500 </p>
3501 </dd>
3502 <dt class="hdlist1">
3503 <code>auto</code>
3504 </dt>
3505 <dd>
3506 <p>
3507         show in columns if the output is to the terminal
3508 </p>
3509 </dd>
3510 </dl></div>
3511 </div></div>
3512 <div class="paragraph"><p>These options control layout (defaults to <em>column</em>).  Setting any
3513 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
3514 specified.</p></div>
3515 <div class="openblock">
3516 <div class="content">
3517 <div class="dlist"><dl>
3518 <dt class="hdlist1">
3519 <code>column</code>
3520 </dt>
3521 <dd>
3522 <p>
3523         fill columns before rows
3524 </p>
3525 </dd>
3526 <dt class="hdlist1">
3527 <code>row</code>
3528 </dt>
3529 <dd>
3530 <p>
3531         fill rows before columns
3532 </p>
3533 </dd>
3534 <dt class="hdlist1">
3535 <code>plain</code>
3536 </dt>
3537 <dd>
3538 <p>
3539         show in one column
3540 </p>
3541 </dd>
3542 </dl></div>
3543 </div></div>
3544 <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
3545 to <em>nodense</em>):</p></div>
3546 <div class="openblock">
3547 <div class="content">
3548 <div class="dlist"><dl>
3549 <dt class="hdlist1">
3550 <code>dense</code>
3551 </dt>
3552 <dd>
3553 <p>
3554         make unequal size columns to utilize more space
3555 </p>
3556 </dd>
3557 <dt class="hdlist1">
3558 <code>nodense</code>
3559 </dt>
3560 <dd>
3561 <p>
3562         make equal size columns
3563 </p>
3564 </dd>
3565 </dl></div>
3566 </div></div>
3567 </dd>
3568 <dt class="hdlist1">
3569 column.branch
3570 </dt>
3571 <dd>
3572 <p>
3573         Specify whether to output branch listing in <code>git branch</code> in columns.
3574         See <code>column.ui</code> for details.
3575 </p>
3576 </dd>
3577 <dt class="hdlist1">
3578 column.clean
3579 </dt>
3580 <dd>
3581 <p>
3582         Specify the layout when listing items in <code>git clean -i</code>, which always
3583         shows files and directories in columns. See <code>column.ui</code> for details.
3584 </p>
3585 </dd>
3586 <dt class="hdlist1">
3587 column.status
3588 </dt>
3589 <dd>
3590 <p>
3591         Specify whether to output untracked files in <code>git status</code> in columns.
3592         See <code>column.ui</code> for details.
3593 </p>
3594 </dd>
3595 <dt class="hdlist1">
3596 column.tag
3597 </dt>
3598 <dd>
3599 <p>
3600         Specify whether to output tag listings in <code>git tag</code> in columns.
3601         See <code>column.ui</code> for details.
3602 </p>
3603 </dd>
3604 <dt class="hdlist1">
3605 commit.cleanup
3606 </dt>
3607 <dd>
3608 <p>
3609         This setting overrides the default of the <code>--cleanup</code> option in
3610         <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
3611         default can be useful when you always want to keep lines that begin
3612         with the comment character <code>#</code> in your log message, in which case you
3613         would do <code>git config commit.cleanup whitespace</code> (note that you will
3614         have to remove the help lines that begin with <code>#</code> in the commit log
3615         template yourself, if you do this).
3616 </p>
3617 </dd>
3618 <dt class="hdlist1">
3619 commit.gpgSign
3620 </dt>
3621 <dd>
3622 <p>
3623         A boolean to specify whether all commits should be GPG signed.
3624         Use of this option when doing operations such as rebase can
3625         result in a large number of commits being signed. It may be
3626         convenient to use an agent to avoid typing your GPG passphrase
3627         several times.
3628 </p>
3629 </dd>
3630 <dt class="hdlist1">
3631 commit.status
3632 </dt>
3633 <dd>
3634 <p>
3635         A boolean to enable/disable inclusion of status information in the
3636         commit message template when using an editor to prepare the commit
3637         message.  Defaults to true.
3638 </p>
3639 </dd>
3640 <dt class="hdlist1">
3641 commit.template
3642 </dt>
3643 <dd>
3644 <p>
3645         Specify the pathname of a file to use as the template for
3646         new commit messages.
3647 </p>
3648 </dd>
3649 <dt class="hdlist1">
3650 commit.verbose
3651 </dt>
3652 <dd>
3653 <p>
3654         A boolean or int to specify the level of verbosity with <code>git commit</code>.
3655         See <a href="git-commit.html">git-commit(1)</a>.
3656 </p>
3657 </dd>
3658 <dt class="hdlist1">
3659 commitGraph.generationVersion
3660 </dt>
3661 <dd>
3662 <p>
3663         Specifies the type of generation number version to use when writing
3664         or reading the commit-graph file. If version 1 is specified, then
3665         the corrected commit dates will not be written or read. Defaults to
3666         2.
3667 </p>
3668 </dd>
3669 <dt class="hdlist1">
3670 commitGraph.maxNewFilters
3671 </dt>
3672 <dd>
3673 <p>
3674         Specifies the default value for the <code>--max-new-filters</code> option of <code>git
3675         commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).
3676 </p>
3677 </dd>
3678 <dt class="hdlist1">
3679 commitGraph.readChangedPaths
3680 </dt>
3681 <dd>
3682 <p>
3683         If true, then git will use the changed-path Bloom filters in the
3684         commit-graph file (if it exists, and they are present). Defaults to
3685         true. See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
3686 </p>
3687 </dd>
3688 <dt class="hdlist1">
3689 completion.commands
3690 </dt>
3691 <dd>
3692 <p>
3693         This is only used by git-completion.bash to add or remove
3694         commands from the list of completed commands. Normally only
3695         porcelain commands and a few select others are completed. You
3696         can add more commands, separated by space, in this
3697         variable. Prefixing the command with <em>-</em> will remove it from
3698         the existing list.
3699 </p>
3700 </dd>
3701 <dt class="hdlist1">
3702 core.fileMode
3703 </dt>
3704 <dd>
3705 <p>
3706         Tells Git if the executable bit of files in the working tree
3707         is to be honored.
3708 </p>
3709 <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
3710 marked as executable is checked out, or checks out a
3711 non-executable file with executable bit on.
3712 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
3713 to see if it handles the executable bit correctly
3714 and this variable is automatically set as necessary.</p></div>
3715 <div class="paragraph"><p>A repository, however, may be on a filesystem that handles
3716 the filemode correctly, and this variable is set to <em>true</em>
3717 when created, but later may be made accessible from another
3718 environment that loses the filemode (e.g. exporting ext4 via
3719 CIFS mount, visiting a Cygwin created repository with
3720 Git for Windows or Eclipse).
3721 In such a case it may be necessary to set this variable to <em>false</em>.
3722 See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
3723 <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
3724 </dd>
3725 <dt class="hdlist1">
3726 core.hideDotFiles
3727 </dt>
3728 <dd>
3729 <p>
3730         (Windows-only) If true, mark newly-created directories and files whose
3731         name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
3732         directory is hidden, but no other files starting with a dot.  The
3733         default mode is <em>dotGitOnly</em>.
3734 </p>
3735 </dd>
3736 <dt class="hdlist1">
3737 core.ignoreCase
3738 </dt>
3739 <dd>
3740 <p>
3741         Internal variable which enables various workarounds to enable
3742         Git to work better on filesystems that are not case sensitive,
3743         like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
3744         finds "makefile" when Git expects "Makefile", Git will assume
3745         it is really the same file, and continue to remember it as
3746         "Makefile".
3747 </p>
3748 <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>
3749 will probe and set core.ignoreCase true if appropriate when the repository
3750 is created.</p></div>
3751 <div class="paragraph"><p>Git relies on the proper configuration of this variable for your operating
3752 and file system. Modifying this value may result in unexpected behavior.</p></div>
3753 </dd>
3754 <dt class="hdlist1">
3755 core.precomposeUnicode
3756 </dt>
3757 <dd>
3758 <p>
3759         This option is only used by Mac OS implementation of Git.
3760         When core.precomposeUnicode=true, Git reverts the unicode decomposition
3761         of filenames done by Mac OS. This is useful when sharing a repository
3762         between Mac OS and Linux or Windows.
3763         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
3764         When false, file names are handled fully transparent by Git,
3765         which is backward compatible with older versions of Git.
3766 </p>
3767 </dd>
3768 <dt class="hdlist1">
3769 core.protectHFS
3770 </dt>
3771 <dd>
3772 <p>
3773         If set to true, do not allow checkout of paths that would
3774         be considered equivalent to <code>.git</code> on an HFS+ filesystem.
3775         Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
3776 </p>
3777 </dd>
3778 <dt class="hdlist1">
3779 core.protectNTFS
3780 </dt>
3781 <dd>
3782 <p>
3783         If set to true, do not allow checkout of paths that would
3784         cause problems with the NTFS filesystem, e.g. conflict with
3785         8.3 "short" names.
3786         Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
3787 </p>
3788 </dd>
3789 <dt class="hdlist1">
3790 core.fsmonitor
3791 </dt>
3792 <dd>
3793 <p>
3794         If set to true, enable the built-in file system monitor
3795         daemon for this working directory (<a href="git-fsmonitor&#45;&#45;daemon.html">git-fsmonitor&#45;&#45;daemon(1)</a>).
3796 </p>
3797 <div class="paragraph"><p>Like hook-based file system monitors, the built-in file system monitor
3798 can speed up Git commands that need to refresh the Git index
3799 (e.g. <code>git status</code>) in a working directory with many files.  The
3800 built-in monitor eliminates the need to install and maintain an
3801 external third-party tool.</p></div>
3802 <div class="paragraph"><p>The built-in file system monitor is currently available only on a
3803 limited set of supported platforms.  Currently, this includes Windows
3804 and MacOS.</p></div>
3805 <div class="literalblock">
3806 <div class="content">
3807 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor"
3808 hook command.</code></pre>
3809 </div></div>
3810 <div class="paragraph"><p>This hook command is used to identify all files that may have changed
3811 since the requested date/time. This information is used to speed up
3812 git by avoiding unnecessary scanning of files that have not changed.</p></div>
3813 <div class="paragraph"><p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p></div>
3814 <div class="paragraph"><p>Note that if you concurrently use multiple versions of Git, such
3815 as one version on the command line and another version in an IDE
3816 tool, that the definition of <code>core.fsmonitor</code> was extended to
3817 allow boolean values in addition to hook pathnames.  Git versions
3818 2.35.1 and prior will not understand the boolean values and will
3819 consider the "true" or "false" values as hook pathnames to be
3820 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
3821 V2 and will fall back to no fsmonitor (full scan).  Git versions
3822 prior to 2.26 default to hook protocol V1 and will silently
3823 assume there were no changes to report (no scan), so status
3824 commands may report incomplete results.  For this reason, it is
3825 best to upgrade all of your Git versions before using the built-in
3826 file system monitor.</p></div>
3827 </dd>
3828 <dt class="hdlist1">
3829 core.fsmonitorHookVersion
3830 </dt>
3831 <dd>
3832 <p>
3833         Sets the protocol version to be used when invoking the
3834         "fsmonitor" hook.
3835 </p>
3836 <div class="paragraph"><p>There are currently versions 1 and 2. When this is not set,
3837 version 2 will be tried first and if it fails then version 1
3838 will be tried. Version 1 uses a timestamp as input to determine
3839 which files have changes since that time but some monitors
3840 like Watchman have race conditions when used with a timestamp.
3841 Version 2 uses an opaque string so that the monitor can return
3842 something that can be used to determine what files have changed
3843 without race conditions.</p></div>
3844 </dd>
3845 <dt class="hdlist1">
3846 core.trustctime
3847 </dt>
3848 <dd>
3849 <p>
3850         If false, the ctime differences between the index and the
3851         working tree are ignored; useful when the inode change time
3852         is regularly modified by something outside Git (file system
3853         crawlers and some backup systems).
3854         See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
3855 </p>
3856 </dd>
3857 <dt class="hdlist1">
3858 core.splitIndex
3859 </dt>
3860 <dd>
3861 <p>
3862         If true, the split-index feature of the index will be used.
3863         See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
3864 </p>
3865 </dd>
3866 <dt class="hdlist1">
3867 core.untrackedCache
3868 </dt>
3869 <dd>
3870 <p>
3871         Determines what to do about the untracked cache feature of the
3872         index. It will be kept, if this variable is unset or set to
3873         <code>keep</code>. It will automatically be added if set to <code>true</code>. And
3874         it will automatically be removed, if set to <code>false</code>. Before
3875         setting it to <code>true</code>, you should check that mtime is working
3876         properly on your system.
3877         See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
3878         <code>feature.manyFiles</code> is enabled which sets this setting to
3879         <code>true</code> by default.
3880 </p>
3881 </dd>
3882 <dt class="hdlist1">
3883 core.checkStat
3884 </dt>
3885 <dd>
3886 <p>
3887         When missing or is set to <code>default</code>, many fields in the stat
3888         structure are checked to detect if a file has been modified
3889         since Git looked at it.  When this configuration variable is
3890         set to <code>minimal</code>, sub-second part of mtime and ctime, the
3891         uid and gid of the owner of the file, the inode number (and
3892         the device number, if Git was compiled to use it), are
3893         excluded from the check among these fields, leaving only the
3894         whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
3895         is set) and the filesize to be checked.
3896 </p>
3897 <div class="paragraph"><p>There are implementations of Git that do not leave usable values in
3898 some fields (e.g. JGit); by excluding these fields from the
3899 comparison, the <code>minimal</code> mode may help interoperability when the
3900 same repository is used by these other systems at the same time.</p></div>
3901 </dd>
3902 <dt class="hdlist1">
3903 core.quotePath
3904 </dt>
3905 <dd>
3906 <p>
3907         Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
3908         quote "unusual" characters in the pathname by enclosing the
3909         pathname in double-quotes and escaping those characters with
3910         backslashes in the same way C escapes control characters (e.g.
3911         <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
3912         values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
3913         UTF-8).  If this variable is set to false, bytes higher than
3914         0x80 are not considered "unusual" any more. Double-quotes,
3915         backslash and control characters are always escaped regardless
3916         of the setting of this variable.  A simple space character is
3917         not considered "unusual".  Many commands can output pathnames
3918         completely verbatim using the <code>-z</code> option. The default value
3919         is true.
3920 </p>
3921 </dd>
3922 <dt class="hdlist1">
3923 core.eol
3924 </dt>
3925 <dd>
3926 <p>
3927         Sets the line ending type to use in the working directory for
3928         files that are marked as text (either by having the <code>text</code>
3929         attribute set, or by having <code>text=auto</code> and Git auto-detecting
3930         the contents as text).
3931         Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
3932         native line ending.  The default value is <code>native</code>.  See
3933         <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
3934         conversion. Note that this value is ignored if <code>core.autocrlf</code>
3935         is set to <code>true</code> or <code>input</code>.
3936 </p>
3937 </dd>
3938 <dt class="hdlist1">
3939 core.safecrlf
3940 </dt>
3941 <dd>
3942 <p>
3943         If true, makes Git check if converting <code>CRLF</code> is reversible when
3944         end-of-line conversion is active.  Git will verify if a command
3945         modifies a file in the work tree either directly or indirectly.
3946         For example, committing a file followed by checking out the
3947         same file should yield the original file in the work tree.  If
3948         this is not the case for the current setting of
3949         <code>core.autocrlf</code>, Git will reject the file.  The variable can
3950         be set to "warn", in which case Git will only warn about an
3951         irreversible conversion but continue the operation.
3952 </p>
3953 <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
3954 When it is enabled, Git will convert CRLF to LF during commit and LF to
3955 CRLF during checkout.  A file that contains a mixture of LF and
3956 CRLF before the commit cannot be recreated by Git.  For text
3957 files this is the right thing to do: it corrects line endings
3958 such that we have only LF line endings in the repository.
3959 But for binary files that are accidentally classified as text the
3960 conversion can corrupt data.</p></div>
3961 <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
3962 setting the conversion type explicitly in .gitattributes.  Right
3963 after committing you still have the original file in your work
3964 tree and this file is not yet corrupted.  You can explicitly tell
3965 Git that this file is binary and Git will handle the file
3966 appropriately.</p></div>
3967 <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
3968 mixed line endings and the undesired effect of corrupting binary
3969 files cannot be distinguished.  In both cases CRLFs are removed
3970 in an irreversible way.  For text files this is the right thing
3971 to do because CRLFs are line endings, while for binary files
3972 converting CRLFs corrupts data.</p></div>
3973 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
3974 file identical to the original file for a different setting of
3975 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
3976 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
3977 and could later be checked out with <code>core.eol=crlf</code>, in which case the
3978 resulting file would contain <code>CRLF</code>, although the original file
3979 contained <code>LF</code>.  However, in both work trees the line endings would be
3980 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
3981 file with mixed line endings would be reported by the <code>core.safecrlf</code>
3982 mechanism.</p></div>
3983 </dd>
3984 <dt class="hdlist1">
3985 core.autocrlf
3986 </dt>
3987 <dd>
3988 <p>
3989         Setting this variable to "true" is the same as setting
3990         the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
3991         Set to true if you want to have <code>CRLF</code> line endings in your
3992         working directory and the repository has LF line endings.
3993         This variable can be set to <em>input</em>,
3994         in which case no output conversion is performed.
3995 </p>
3996 </dd>
3997 <dt class="hdlist1">
3998 core.checkRoundtripEncoding
3999 </dt>
4000 <dd>
4001 <p>
4002         A comma and/or whitespace separated list of encodings that Git
4003         performs UTF-8 round trip checks on if they are used in an
4004         <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
4005         The default value is <code>SHIFT-JIS</code>.
4006 </p>
4007 </dd>
4008 <dt class="hdlist1">
4009 core.symlinks
4010 </dt>
4011 <dd>
4012 <p>
4013         If false, symbolic links are checked out as small plain files that
4014         contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
4015         <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
4016         file. Useful on filesystems like FAT that do not support
4017         symbolic links.
4018 </p>
4019 <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>
4020 will probe and set core.symlinks false if appropriate when the repository
4021 is created.</p></div>
4022 </dd>
4023 <dt class="hdlist1">
4024 core.gitProxy
4025 </dt>
4026 <dd>
4027 <p>
4028         A "proxy command" to execute (as <em>command host port</em>) instead
4029         of establishing direct connection to the remote server when
4030         using the Git protocol for fetching. If the variable value is
4031         in the "COMMAND for DOMAIN" format, the command is applied only
4032         on hostnames ending with the specified domain string. This variable
4033         may be set multiple times and is matched in the given order;
4034         the first match wins.
4035 </p>
4036 <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
4037 (which always applies universally, without the special "for"
4038 handling).</p></div>
4039 <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
4040 specify that no proxy be used for a given domain pattern.
4041 This is useful for excluding servers inside a firewall from
4042 proxy use, while defaulting to a common proxy for external domains.</p></div>
4043 </dd>
4044 <dt class="hdlist1">
4045 core.sshCommand
4046 </dt>
4047 <dd>
4048 <p>
4049         If this variable is set, <code>git fetch</code> and <code>git push</code> will
4050         use the specified command instead of <code>ssh</code> when they need to
4051         connect to a remote system. The command is in the same form as
4052         the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
4053         when the environment variable is set.
4054 </p>
4055 </dd>
4056 <dt class="hdlist1">
4057 core.ignoreStat
4058 </dt>
4059 <dd>
4060 <p>
4061         If true, Git will avoid using lstat() calls to detect if files have
4062         changed by setting the "assume-unchanged" bit for those tracked files
4063         which it has updated identically in both the index and working tree.
4064 </p>
4065 <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
4066 the modified files explicitly (e.g. see <em>Examples</em> section in
4067 <a href="git-update-index.html">git-update-index(1)</a>).
4068 Git will not normally detect changes to those files.</p></div>
4069 <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
4070 CIFS/Microsoft Windows.</p></div>
4071 <div class="paragraph"><p>False by default.</p></div>
4072 </dd>
4073 <dt class="hdlist1">
4074 core.preferSymlinkRefs
4075 </dt>
4076 <dd>
4077 <p>
4078         Instead of the default "symref" format for HEAD
4079         and other symbolic reference files, use symbolic links.
4080         This is sometimes needed to work with old scripts that
4081         expect HEAD to be a symbolic link.
4082 </p>
4083 </dd>
4084 <dt class="hdlist1">
4085 core.alternateRefsCommand
4086 </dt>
4087 <dd>
4088 <p>
4089         When advertising tips of available history from an alternate, use the shell to
4090         execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
4091         first argument is the absolute path of the alternate. Output must contain one
4092         hex object id per line (i.e., the same as produced by <code>git for-each-ref
4093         --format='%(objectname)'</code>).
4094 </p>
4095 <div class="paragraph"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
4096 value, as it does not take a repository path as an argument (but you can wrap
4097 the command above in a shell script).</p></div>
4098 </dd>
4099 <dt class="hdlist1">
4100 core.alternateRefsPrefixes
4101 </dt>
4102 <dd>
4103 <p>
4104         When listing references from an alternate, list only references that begin
4105         with the given prefix. Prefixes match as if they were given as arguments to
4106         <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
4107         whitespace. If <code>core.alternateRefsCommand</code> is set, setting
4108         <code>core.alternateRefsPrefixes</code> has no effect.
4109 </p>
4110 </dd>
4111 <dt class="hdlist1">
4112 core.bare
4113 </dt>
4114 <dd>
4115 <p>
4116         If true this repository is assumed to be <em>bare</em> and has no
4117         working directory associated with it.  If this is the case a
4118         number of commands that require a working directory will be
4119         disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
4120 </p>
4121 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
4122 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
4123 repository that ends in "/.git" is assumed to be not bare (bare =
4124 false), while all other repositories are assumed to be bare (bare
4125 = true).</p></div>
4126 </dd>
4127 <dt class="hdlist1">
4128 core.worktree
4129 </dt>
4130 <dd>
4131 <p>
4132         Set the path to the root of the working tree.
4133         If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
4134         is ignored and not used for determining the root of working tree.
4135         This can be overridden by the <code>GIT_WORK_TREE</code> environment
4136         variable and the <code>--work-tree</code> command-line option.
4137         The value can be an absolute path or relative to the path to
4138         the .git directory, which is either specified by --git-dir
4139         or GIT_DIR, or automatically discovered.
4140         If --git-dir or GIT_DIR is specified but none of
4141         --work-tree, GIT_WORK_TREE and core.worktree is specified,
4142         the current working directory is regarded as the top level
4143         of your working tree.
4144 </p>
4145 <div class="paragraph"><p>Note that this variable is honored even when set in a configuration
4146 file in a ".git" subdirectory of a directory and its value differs
4147 from the latter directory (e.g. "/path/to/.git/config" has
4148 core.worktree set to "/different/path"), which is most likely a
4149 misconfiguration.  Running Git commands in the "/path/to" directory will
4150 still use "/different/path" as the root of the work tree and can cause
4151 confusion unless you know what you are doing (e.g. you are creating a
4152 read-only snapshot of the same index to a location different from the
4153 repository&#8217;s usual working tree).</p></div>
4154 </dd>
4155 <dt class="hdlist1">
4156 core.logAllRefUpdates
4157 </dt>
4158 <dd>
4159 <p>
4160         Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
4161         "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
4162         SHA-1, the date/time and the reason of the update, but
4163         only when the file exists.  If this configuration
4164         variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
4165         file is automatically created for branch heads (i.e. under
4166         <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
4167         note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
4168         If it is set to <code>always</code>, then a missing reflog is automatically
4169         created for any ref under <code>refs/</code>.
4170 </p>
4171 <div class="paragraph"><p>This information can be used to determine what commit
4172 was the tip of a branch "2 days ago".</p></div>
4173 <div class="paragraph"><p>This value is true by default in a repository that has
4174 a working directory associated with it, and false by
4175 default in a bare repository.</p></div>
4176 </dd>
4177 <dt class="hdlist1">
4178 core.repositoryFormatVersion
4179 </dt>
4180 <dd>
4181 <p>
4182         Internal variable identifying the repository format and layout
4183         version.
4184 </p>
4185 </dd>
4186 <dt class="hdlist1">
4187 core.sharedRepository
4188 </dt>
4189 <dd>
4190 <p>
4191         When <em>group</em> (or <em>true</em>), the repository is made shareable between
4192         several users in a group (making sure all the files and objects are
4193         group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
4194         repository will be readable by all users, additionally to being
4195         group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
4196         reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
4197         files in the repository will have this mode value. <em>0xxx</em> will override
4198         user&#8217;s umask value (whereas the other options will only override
4199         requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
4200         the repo read/write-able for the owner and group, but inaccessible to
4201         others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
4202         repository that is group-readable but not group-writable.
4203         See <a href="git-init.html">git-init(1)</a>. False by default.
4204 </p>
4205 </dd>
4206 <dt class="hdlist1">
4207 core.warnAmbiguousRefs
4208 </dt>
4209 <dd>
4210 <p>
4211         If true, Git will warn you if the ref name you passed it is ambiguous
4212         and might match multiple refs in the repository. True by default.
4213 </p>
4214 </dd>
4215 <dt class="hdlist1">
4216 core.compression
4217 </dt>
4218 <dd>
4219 <p>
4220         An integer -1..9, indicating a default compression level.
4221         -1 is the zlib default. 0 means no compression,
4222         and 1..9 are various speed/size tradeoffs, 9 being slowest.
4223         If set, this provides a default to other compression variables,
4224         such as <code>core.looseCompression</code> and <code>pack.compression</code>.
4225 </p>
4226 </dd>
4227 <dt class="hdlist1">
4228 core.looseCompression
4229 </dt>
4230 <dd>
4231 <p>
4232         An integer -1..9, indicating the compression level for objects that
4233         are not in a pack file. -1 is the zlib default. 0 means no
4234         compression, and 1..9 are various speed/size tradeoffs, 9 being
4235         slowest.  If not set,  defaults to core.compression.  If that is
4236         not set,  defaults to 1 (best speed).
4237 </p>
4238 </dd>
4239 <dt class="hdlist1">
4240 core.packedGitWindowSize
4241 </dt>
4242 <dd>
4243 <p>
4244         Number of bytes of a pack file to map into memory in a
4245         single mapping operation.  Larger window sizes may allow
4246         your system to process a smaller number of large pack files
4247         more quickly.  Smaller window sizes will negatively affect
4248         performance due to increased calls to the operating system&#8217;s
4249         memory manager, but may improve performance when accessing
4250         a large number of large pack files.
4251 </p>
4252 <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
4253 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
4254 be reasonable for all users/operating systems.  You probably do
4255 not need to adjust this value.</p></div>
4256 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4257 </dd>
4258 <dt class="hdlist1">
4259 core.packedGitLimit
4260 </dt>
4261 <dd>
4262 <p>
4263         Maximum number of bytes to map simultaneously into memory
4264         from pack files.  If Git needs to access more than this many
4265         bytes at once to complete an operation it will unmap existing
4266         regions to reclaim virtual address space within the process.
4267 </p>
4268 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
4269 unlimited) on 64 bit platforms.
4270 This should be reasonable for all users/operating systems, except on
4271 the largest projects.  You probably do not need to adjust this value.</p></div>
4272 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4273 </dd>
4274 <dt class="hdlist1">
4275 core.deltaBaseCacheLimit
4276 </dt>
4277 <dd>
4278 <p>
4279         Maximum number of bytes per thread to reserve for caching base objects
4280         that may be referenced by multiple deltified objects.  By storing the
4281         entire decompressed base objects in a cache Git is able
4282         to avoid unpacking and decompressing frequently used base
4283         objects multiple times.
4284 </p>
4285 <div class="paragraph"><p>Default is 96 MiB on all platforms.  This should be reasonable
4286 for all users/operating systems, except on the largest projects.
4287 You probably do not need to adjust this value.</p></div>
4288 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4289 </dd>
4290 <dt class="hdlist1">
4291 core.bigFileThreshold
4292 </dt>
4293 <dd>
4294 <p>
4295         The size of files considered "big", which as discussed below
4296         changes the behavior of numerous git commands, as well as how
4297         such files are stored within the repository. The default is
4298         512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
4299         supported.
4300 </p>
4301 <div class="paragraph"><p>Files above the configured limit will be:</p></div>
4302 <div class="ulist"><ul>
4303 <li>
4304 <p>
4305 Stored deflated in packfiles, without attempting delta compression.
4306 </p>
4307 <div class="paragraph"><p>The default limit is primarily set with this use-case in mind. With it,
4308 most projects will have their source code and other text files delta
4309 compressed, but not larger binary media files.</p></div>
4310 <div class="paragraph"><p>Storing large files without delta compression avoids excessive memory
4311 usage, at the slight expense of increased disk usage.</p></div>
4312 </li>
4313 <li>
4314 <p>
4315 Will be treated as if they were labeled "binary" (see
4316   <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
4317   <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.
4318 </p>
4319 </li>
4320 <li>
4321 <p>
4322 Will generally be streamed when written, which avoids excessive
4323 memory usage, at the cost of some fixed overhead. Commands that make
4324 use of this include <a href="git-archive.html">git-archive(1)</a>,
4325 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
4326 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.
4327 </p>
4328 </li>
4329 </ul></div>
4330 </dd>
4331 <dt class="hdlist1">
4332 core.excludesFile
4333 </dt>
4334 <dd>
4335 <p>
4336         Specifies the pathname to the file that contains patterns to
4337         describe paths that are not meant to be tracked, in addition
4338         to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
4339         Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
4340         If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
4341         is used instead. See <a href="gitignore.html">gitignore(5)</a>.
4342 </p>
4343 </dd>
4344 <dt class="hdlist1">
4345 core.askPass
4346 </dt>
4347 <dd>
4348 <p>
4349         Some commands (e.g. svn and http interfaces) that interactively
4350         ask for a password can be told to use an external program given
4351         via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
4352         environment variable. If not set, fall back to the value of the
4353         <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
4354         prompt. The external program shall be given a suitable prompt as
4355         command-line argument and write the password on its STDOUT.
4356 </p>
4357 </dd>
4358 <dt class="hdlist1">
4359 core.attributesFile
4360 </dt>
4361 <dd>
4362 <p>
4363         In addition to <code>.gitattributes</code> (per-directory) and
4364         <code>.git/info/attributes</code>, Git looks into this file for attributes
4365         (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
4366         way as for <code>core.excludesFile</code>. Its default value is
4367         <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
4368         set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
4369 </p>
4370 </dd>
4371 <dt class="hdlist1">
4372 core.hooksPath
4373 </dt>
4374 <dd>
4375 <p>
4376         By default Git will look for your hooks in the
4377         <code>$GIT_DIR/hooks</code> directory. Set this to different path,
4378         e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
4379         that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
4380         in <code>$GIT_DIR/hooks/pre-receive</code>.
4381 </p>
4382 <div class="paragraph"><p>The path can be either absolute or relative. A relative path is
4383 taken as relative to the directory where the hooks are run (see
4384 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
4385 <div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
4386 centrally configure your Git hooks instead of configuring them on a
4387 per-repository basis, or as a more flexible and centralized
4388 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
4389 default hooks.</p></div>
4390 </dd>
4391 <dt class="hdlist1">
4392 core.editor
4393 </dt>
4394 <dd>
4395 <p>
4396         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4397         messages by launching an editor use the value of this
4398         variable when it is set, and the environment variable
4399         <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.
4400 </p>
4401 </dd>
4402 <dt class="hdlist1">
4403 core.commentChar
4404 </dt>
4405 <dt class="hdlist1">
4406 core.commentString
4407 </dt>
4408 <dd>
4409 <p>
4410         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4411         messages consider a line that begins with this character
4412         commented, and removes them after the editor returns
4413         (default <em>#</em>).
4414 </p>
4415 <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
4416 the beginning character of any line in existing commit messages.</p></div>
4417 <div class="paragraph"><p>Note that these two variables are aliases of each other, and in modern
4418 versions of Git you are free to use a string (e.g., <code>//</code> or <code>⁑⁕⁑</code>) with
4419 <code>commentChar</code>. Versions of Git prior to v2.45.0 will ignore
4420 <code>commentString</code> but will reject a value of <code>commentChar</code> that consists
4421 of more than a single ASCII byte. If you plan to use your config with
4422 older and newer versions of Git, you may want to specify both:</p></div>
4423 <div class="literalblock">
4424 <div class="content">
4425 <pre><code>[core]
4426 # single character for older versions
4427 commentChar = "#"
4428 # string for newer versions (which will override commentChar
4429 # because it comes later in the file)
4430 commentString = "//"</code></pre>
4431 </div></div>
4432 </dd>
4433 <dt class="hdlist1">
4434 core.filesRefLockTimeout
4435 </dt>
4436 <dd>
4437 <p>
4438         The length of time, in milliseconds, to retry when trying to
4439         lock an individual reference. Value 0 means not to retry at
4440         all; -1 means to try indefinitely. Default is 100 (i.e.,
4441         retry for 100ms).
4442 </p>
4443 </dd>
4444 <dt class="hdlist1">
4445 core.packedRefsTimeout
4446 </dt>
4447 <dd>
4448 <p>
4449         The length of time, in milliseconds, to retry when trying to
4450         lock the <code>packed-refs</code> file. Value 0 means not to retry at
4451         all; -1 means to try indefinitely. Default is 1000 (i.e.,
4452         retry for 1 second).
4453 </p>
4454 </dd>
4455 <dt class="hdlist1">
4456 core.pager
4457 </dt>
4458 <dd>
4459 <p>
4460         Text viewer for use by Git commands (e.g., <em>less</em>).  The value
4461         is meant to be interpreted by the shell.  The order of preference
4462         is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
4463         configuration, then <code>$PAGER</code>, and then the default chosen at
4464         compile time (usually <em>less</em>).
4465 </p>
4466 <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
4467 (if <code>LESS</code> environment variable is set, Git does not change it at
4468 all).  If you want to selectively override Git&#8217;s default setting
4469 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
4470 be passed to the shell by Git, which will translate the final
4471 command to <code>LESS=FRX less -S</code>. The environment does not set the
4472 <code>S</code> option but the command line does, instructing less to truncate
4473 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
4474 deactivate the <code>F</code> option specified by the environment from the
4475 command-line, deactivating the "quit if one screen" behavior of
4476 <code>less</code>.  One can specifically activate some flags for particular
4477 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
4478 line truncation only for <code>git blame</code>.</p></div>
4479 <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
4480 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
4481 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
4482 </dd>
4483 <dt class="hdlist1">
4484 core.whitespace
4485 </dt>
4486 <dd>
4487 <p>
4488         A comma separated list of common whitespace problems to
4489         notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
4490         highlight them, and <em>git apply --whitespace=error</em> will
4491         consider them as errors.  You can prefix <code>-</code> to disable
4492         any of them (e.g. <code>-trailing-space</code>):
4493 </p>
4494 <div class="ulist"><ul>
4495 <li>
4496 <p>
4497 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
4498   as an error (enabled by default).
4499 </p>
4500 </li>
4501 <li>
4502 <p>
4503 <code>space-before-tab</code> treats a space character that appears immediately
4504   before a tab character in the initial indent part of the line as an
4505   error (enabled by default).
4506 </p>
4507 </li>
4508 <li>
4509 <p>
4510 <code>indent-with-non-tab</code> treats a line that is indented with space
4511   characters instead of the equivalent tabs as an error (not enabled by
4512   default).
4513 </p>
4514 </li>
4515 <li>
4516 <p>
4517 <code>tab-in-indent</code> treats a tab character in the initial indent part of
4518   the line as an error (not enabled by default).
4519 </p>
4520 </li>
4521 <li>
4522 <p>
4523 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
4524   (enabled by default).
4525 </p>
4526 </li>
4527 <li>
4528 <p>
4529 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
4530   <code>blank-at-eof</code>.
4531 </p>
4532 </li>
4533 <li>
4534 <p>
4535 <code>cr-at-eol</code> treats a carriage-return at the end of line as
4536   part of the line terminator, i.e. with it, <code>trailing-space</code>
4537   does not trigger if the character before such a carriage-return
4538   is not a whitespace (not enabled by default).
4539 </p>
4540 </li>
4541 <li>
4542 <p>
4543 <code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
4544   is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
4545   errors. The default tab width is 8. Allowed values are 1 to 63.
4546 </p>
4547 </li>
4548 </ul></div>
4549 </dd>
4550 <dt class="hdlist1">
4551 core.fsync
4552 </dt>
4553 <dd>
4554 <p>
4555         A comma-separated list of components of the repository that
4556         should be hardened via the core.fsyncMethod when created or
4557         modified.  You can disable hardening of any component by
4558         prefixing it with a <em>-</em>.  Items that are not hardened may be
4559         lost in the event of an unclean system shutdown. Unless you
4560         have special requirements, it is recommended that you leave
4561         this option empty or pick one of <code>committed</code>, <code>added</code>,
4562         or <code>all</code>.
4563 </p>
4564 <div class="paragraph"><p>When this configuration is encountered, the set of components starts with
4565 the platform default value, disabled components are removed, and additional
4566 components are added. <code>none</code> resets the state so that the platform default
4567 is ignored.</p></div>
4568 <div class="paragraph"><p>The empty string resets the fsync configuration to the platform
4569 default. The default on most platforms is equivalent to
4570 <code>core.fsync=committed,-loose-object</code>, which has good performance,
4571 but risks losing recent work in the event of an unclean system shutdown.</p></div>
4572 <div class="ulist"><ul>
4573 <li>
4574 <p>
4575 <code>none</code> clears the set of fsynced components.
4576 </p>
4577 </li>
4578 <li>
4579 <p>
4580 <code>loose-object</code> hardens objects added to the repo in loose-object form.
4581 </p>
4582 </li>
4583 <li>
4584 <p>
4585 <code>pack</code> hardens objects added to the repo in packfile form.
4586 </p>
4587 </li>
4588 <li>
4589 <p>
4590 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
4591 </p>
4592 </li>
4593 <li>
4594 <p>
4595 <code>commit-graph</code> hardens the commit-graph file.
4596 </p>
4597 </li>
4598 <li>
4599 <p>
4600 <code>index</code> hardens the index when it is modified.
4601 </p>
4602 </li>
4603 <li>
4604 <p>
4605 <code>objects</code> is an aggregate option that is equivalent to
4606   <code>loose-object,pack</code>.
4607 </p>
4608 </li>
4609 <li>
4610 <p>
4611 <code>reference</code> hardens references modified in the repo.
4612 </p>
4613 </li>
4614 <li>
4615 <p>
4616 <code>derived-metadata</code> is an aggregate option that is equivalent to
4617   <code>pack-metadata,commit-graph</code>.
4618 </p>
4619 </li>
4620 <li>
4621 <p>
4622 <code>committed</code> is an aggregate option that is currently equivalent to
4623   <code>objects</code>. This mode sacrifices some performance to ensure that work
4624   that is committed to the repository with <code>git commit</code> or similar commands
4625   is hardened.
4626 </p>
4627 </li>
4628 <li>
4629 <p>
4630 <code>added</code> is an aggregate option that is currently equivalent to
4631   <code>committed,index</code>. This mode sacrifices additional performance to
4632   ensure that the results of commands like <code>git add</code> and similar operations
4633   are hardened.
4634 </p>
4635 </li>
4636 <li>
4637 <p>
4638 <code>all</code> is an aggregate option that syncs all individual components above.
4639 </p>
4640 </li>
4641 </ul></div>
4642 </dd>
4643 <dt class="hdlist1">
4644 core.fsyncMethod
4645 </dt>
4646 <dd>
4647 <p>
4648         A value indicating the strategy Git will use to harden repository data
4649         using fsync and related primitives.
4650 </p>
4651 <div class="ulist"><ul>
4652 <li>
4653 <p>
4654 <code>fsync</code> uses the fsync() system call or platform equivalents.
4655 </p>
4656 </li>
4657 <li>
4658 <p>
4659 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
4660   filesystem and storage hardware, data added to the repository may not be
4661   durable in the event of a system crash. This is the default mode on macOS.
4662 </p>
4663 </li>
4664 <li>
4665 <p>
4666 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
4667   updates in the disk writeback cache and then does a single full fsync of
4668   a dummy file to trigger the disk cache flush at the end of the operation.
4669 </p>
4670 <div class="paragraph"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
4671 data is made durable as if <code>fsync</code> was specified. This mode is expected to
4672 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
4673 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
4674 </li>
4675 </ul></div>
4676 </dd>
4677 <dt class="hdlist1">
4678 core.fsyncObjectFiles
4679 </dt>
4680 <dd>
4681 <p>
4682         This boolean will enable <em>fsync()</em> when writing object files.
4683         This setting is deprecated. Use core.fsync instead.
4684 </p>
4685 <div class="paragraph"><p>This setting affects data added to the Git repository in loose-object
4686 form. When set to true, Git will issue an fsync or similar system call
4687 to flush caches so that loose-objects remain consistent in the face
4688 of a unclean system shutdown.</p></div>
4689 </dd>
4690 <dt class="hdlist1">
4691 core.preloadIndex
4692 </dt>
4693 <dd>
4694 <p>
4695         Enable parallel index preload for operations like <em>git diff</em>
4696 </p>
4697 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
4698 on filesystems like NFS that have weak caching semantics and thus
4699 relatively high IO latencies.  When enabled, Git will do the
4700 index comparison to the filesystem data in parallel, allowing
4701 overlapping IO&#8217;s.  Defaults to true.</p></div>
4702 </dd>
4703 <dt class="hdlist1">
4704 core.unsetenvvars
4705 </dt>
4706 <dd>
4707 <p>
4708         Windows-only: comma-separated list of environment variables'
4709         names that need to be unset before spawning any other process.
4710         Defaults to <code>PERL5LIB</code> to account for the fact that Git for
4711         Windows insists on using its own Perl interpreter.
4712 </p>
4713 </dd>
4714 <dt class="hdlist1">
4715 core.restrictinheritedhandles
4716 </dt>
4717 <dd>
4718 <p>
4719         Windows-only: override whether spawned processes inherit only standard
4720         file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
4721         <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
4722         Windows 7 and later, and <code>false</code> on older Windows versions.
4723 </p>
4724 </dd>
4725 <dt class="hdlist1">
4726 core.createObject
4727 </dt>
4728 <dd>
4729 <p>
4730         You can set this to <em>link</em>, in which case a hardlink followed by
4731         a delete of the source are used to make sure that object creation
4732         will not overwrite existing objects.
4733 </p>
4734 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
4735 Set this config setting to <em>rename</em> there; however, this will remove the
4736 check that makes sure that existing object files will not get overwritten.</p></div>
4737 </dd>
4738 <dt class="hdlist1">
4739 core.notesRef
4740 </dt>
4741 <dd>
4742 <p>
4743         When showing commit messages, also show notes which are stored in
4744         the given ref.  The ref must be fully qualified.  If the given
4745         ref does not exist, it is not an error but means that no
4746         notes should be printed.
4747 </p>
4748 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
4749 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p></div>
4750 </dd>
4751 <dt class="hdlist1">
4752 core.commitGraph
4753 </dt>
4754 <dd>
4755 <p>
4756         If true, then git will read the commit-graph file (if it exists)
4757         to parse the graph structure of commits. Defaults to true. See
4758         <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
4759 </p>
4760 </dd>
4761 <dt class="hdlist1">
4762 core.useReplaceRefs
4763 </dt>
4764 <dd>
4765 <p>
4766         If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
4767         option was given on the command line. See <a href="git.html">git(1)</a> and
4768         <a href="git-replace.html">git-replace(1)</a> for more information.
4769 </p>
4770 </dd>
4771 <dt class="hdlist1">
4772 core.multiPackIndex
4773 </dt>
4774 <dd>
4775 <p>
4776         Use the multi-pack-index file to track multiple packfiles using a
4777         single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
4778         information. Defaults to true.
4779 </p>
4780 </dd>
4781 <dt class="hdlist1">
4782 core.sparseCheckout
4783 </dt>
4784 <dd>
4785 <p>
4786         Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
4787         for more information.
4788 </p>
4789 </dd>
4790 <dt class="hdlist1">
4791 core.sparseCheckoutCone
4792 </dt>
4793 <dd>
4794 <p>
4795         Enables the "cone mode" of the sparse checkout feature. When the
4796         sparse-checkout file contains a limited set of patterns, this
4797         mode provides significant performance advantages. The "non-cone
4798         mode" can be requested to allow specifying more flexible
4799         patterns by setting this variable to <em>false</em>. See
4800         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.
4801 </p>
4802 </dd>
4803 <dt class="hdlist1">
4804 core.abbrev
4805 </dt>
4806 <dd>
4807 <p>
4808         Set the length object names are abbreviated to.  If
4809         unspecified or set to "auto", an appropriate value is
4810         computed based on the approximate number of packed objects
4811         in your repository, which hopefully is enough for
4812         abbreviated object names to stay unique for some time.
4813         If set to "no", no abbreviation is made and the object names
4814         are shown in their full length.
4815         The minimum length is 4.
4816 </p>
4817 </dd>
4818 <dt class="hdlist1">
4819 core.maxTreeDepth
4820 </dt>
4821 <dd>
4822 <p>
4823         The maximum depth Git is willing to recurse while traversing a
4824         tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
4825         to allow Git to abort cleanly, and should not generally need to
4826         be adjusted. The default is 4096.
4827 </p>
4828 </dd>
4829 <dt class="hdlist1">
4830 credential.helper
4831 </dt>
4832 <dd>
4833 <p>
4834         Specify an external helper to be called when a username or
4835         password credential is needed; the helper may consult external
4836         storage to avoid prompting the user for the credentials. This is
4837         normally the name of a credential helper with possible
4838         arguments, but may also be an absolute path with arguments or, if
4839         preceded by <code>!</code>, shell commands.
4840 </p>
4841 <div class="paragraph"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
4842 for details and examples.</p></div>
4843 </dd>
4844 <dt class="hdlist1">
4845 credential.useHttpPath
4846 </dt>
4847 <dd>
4848 <p>
4849         When acquiring credentials, consider the "path" component of an http
4850         or https URL to be important. Defaults to false. See
4851         <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
4852 </p>
4853 </dd>
4854 <dt class="hdlist1">
4855 credential.username
4856 </dt>
4857 <dd>
4858 <p>
4859         If no username is set for a network authentication, use this username
4860         by default. See credential.&lt;context&gt;.* below, and
4861         <a href="gitcredentials.html">gitcredentials(7)</a>.
4862 </p>
4863 </dd>
4864 <dt class="hdlist1">
4865 credential.&lt;url&gt;.*
4866 </dt>
4867 <dd>
4868 <p>
4869         Any of the credential.* options above can be applied selectively to
4870         some credentials. For example, "credential.https://example.com.username"
4871         would set the default username only for https connections to
4872         example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
4873         matched.
4874 </p>
4875 </dd>
4876 <dt class="hdlist1">
4877 credentialCache.ignoreSIGHUP
4878 </dt>
4879 <dd>
4880 <p>
4881         Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
4882 </p>
4883 </dd>
4884 <dt class="hdlist1">
4885 credentialStore.lockTimeoutMS
4886 </dt>
4887 <dd>
4888 <p>
4889         The length of time, in milliseconds, for git-credential-store to retry
4890         when trying to lock the credentials file. A value of 0 means not to retry at
4891         all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
4892         1s).
4893 </p>
4894 </dd>
4895 <dt class="hdlist1">
4896 diff.autoRefreshIndex
4897 </dt>
4898 <dd>
4899 <p>
4900         When using <em>git diff</em> to compare with work tree
4901         files, do not consider stat-only changes as changed.
4902         Instead, silently run <code>git update-index --refresh</code> to
4903         update the cached stat information for paths whose
4904         contents in the work tree match the contents in the
4905         index.  This option defaults to true.  Note that this
4906         affects only <em>git diff</em> Porcelain, and not lower level
4907         <em>diff</em> commands such as <em>git diff-files</em>.
4908 </p>
4909 </dd>
4910 <dt class="hdlist1">
4911 diff.dirstat
4912 </dt>
4913 <dd>
4914 <p>
4915         A comma separated list of <code>--dirstat</code> parameters specifying the
4916         default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
4917         and friends. The defaults can be overridden on the command line
4918         (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
4919         (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
4920         The following parameters are available:
4921 </p>
4922 <div class="openblock">
4923 <div class="content">
4924 <div class="dlist"><dl>
4925 <dt class="hdlist1">
4926 <code>changes</code>
4927 </dt>
4928 <dd>
4929 <p>
4930         Compute the dirstat numbers by counting the lines that have been
4931         removed from the source, or added to the destination. This ignores
4932         the amount of pure code movements within a file.  In other words,
4933         rearranging lines in a file is not counted as much as other changes.
4934         This is the default behavior when no parameter is given.
4935 </p>
4936 </dd>
4937 <dt class="hdlist1">
4938 <code>lines</code>
4939 </dt>
4940 <dd>
4941 <p>
4942         Compute the dirstat numbers by doing the regular line-based diff
4943         analysis, and summing the removed/added line counts. (For binary
4944         files, count 64-byte chunks instead, since binary files have no
4945         natural concept of lines). This is a more expensive <code>--dirstat</code>
4946         behavior than the <code>changes</code> behavior, but it does count rearranged
4947         lines within a file as much as other changes. The resulting output
4948         is consistent with what you get from the other <code>--*stat</code> options.
4949 </p>
4950 </dd>
4951 <dt class="hdlist1">
4952 <code>files</code>
4953 </dt>
4954 <dd>
4955 <p>
4956         Compute the dirstat numbers by counting the number of files changed.
4957         Each changed file counts equally in the dirstat analysis. This is
4958         the computationally cheapest <code>--dirstat</code> behavior, since it does
4959         not have to look at the file contents at all.
4960 </p>
4961 </dd>
4962 <dt class="hdlist1">
4963 <code>cumulative</code>
4964 </dt>
4965 <dd>
4966 <p>
4967         Count changes in a child directory for the parent directory as well.
4968         Note that when using <code>cumulative</code>, the sum of the percentages
4969         reported may exceed 100%. The default (non-cumulative) behavior can
4970         be specified with the <code>noncumulative</code> parameter.
4971 </p>
4972 </dd>
4973 <dt class="hdlist1">
4974 &lt;limit&gt;
4975 </dt>
4976 <dd>
4977 <p>
4978         An integer parameter specifies a cut-off percent (3% by default).
4979         Directories contributing less than this percentage of the changes
4980         are not shown in the output.
4981 </p>
4982 </dd>
4983 </dl></div>
4984 </div></div>
4985 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
4986 directories with less than 10% of the total amount of changed files,
4987 and accumulating child directory counts in the parent directories:
4988 <code>files,10,cumulative</code>.</p></div>
4989 </dd>
4990 <dt class="hdlist1">
4991 diff.statNameWidth
4992 </dt>
4993 <dd>
4994 <p>
4995         Limit the width of the filename part in --stat output. If set, applies
4996         to all commands generating --stat output except format-patch.
4997 </p>
4998 </dd>
4999 <dt class="hdlist1">
5000 diff.statGraphWidth
5001 </dt>
5002 <dd>
5003 <p>
5004         Limit the width of the graph part in --stat output. If set, applies
5005         to all commands generating --stat output except format-patch.
5006 </p>
5007 </dd>
5008 <dt class="hdlist1">
5009 diff.context
5010 </dt>
5011 <dd>
5012 <p>
5013         Generate diffs with &lt;n&gt; lines of context instead of the default
5014         of 3. This value is overridden by the -U option.
5015 </p>
5016 </dd>
5017 <dt class="hdlist1">
5018 diff.interHunkContext
5019 </dt>
5020 <dd>
5021 <p>
5022         Show the context between diff hunks, up to the specified number
5023         of lines, thereby fusing the hunks that are close to each other.
5024         This value serves as the default for the <code>--inter-hunk-context</code>
5025         command line option.
5026 </p>
5027 </dd>
5028 <dt class="hdlist1">
5029 diff.external
5030 </dt>
5031 <dd>
5032 <p>
5033         If this config variable is set, diff generation is not
5034         performed using the internal diff machinery, but using the
5035         given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
5036         environment variable.  The command is called with parameters
5037         as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
5038         you want to use an external diff program only on a subset of
5039         your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
5040 </p>
5041 </dd>
5042 <dt class="hdlist1">
5043 diff.trustExitCode
5044 </dt>
5045 <dd>
5046 <p>
5047         If this boolean value is set to true then the
5048         <code>diff.external</code> command is expected to return exit code
5049         0 if it considers the input files to be equal or 1 if it
5050         considers them to be different, like <code>diff(1)</code>.
5051         If it is set to false, which is the default, then the command
5052         is expected to return exit code 0 regardless of equality.
5053         Any other exit code causes Git to report a fatal error.
5054 </p>
5055 </dd>
5056 <dt class="hdlist1">
5057 diff.ignoreSubmodules
5058 </dt>
5059 <dd>
5060 <p>
5061         Sets the default value of --ignore-submodules. Note that this
5062         affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
5063         commands such as <em>git diff-files</em>. <em>git checkout</em>
5064         and <em>git switch</em> also honor
5065         this setting when reporting uncommitted changes. Setting it to
5066         <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
5067         and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
5068         overridden by using the --ignore-submodules command-line option.
5069         The <em>git submodule</em> commands are not affected by this setting.
5070         By default this is set to untracked so that any untracked
5071         submodules are ignored.
5072 </p>
5073 </dd>
5074 <dt class="hdlist1">
5075 diff.mnemonicPrefix
5076 </dt>
5077 <dd>
5078 <p>
5079         If set, <em>git diff</em> uses a prefix pair that is different from the
5080         standard "a/" and "b/" depending on what is being compared.  When
5081         this configuration is in effect, reverse diff output also swaps
5082         the order of the prefixes:
5083 </p>
5084 <div class="dlist"><dl>
5085 <dt class="hdlist1">
5086 <code>git diff</code>
5087 </dt>
5088 <dd>
5089 <p>
5090         compares the (i)ndex and the (w)ork tree;
5091 </p>
5092 </dd>
5093 <dt class="hdlist1">
5094 <code>git diff HEAD</code>
5095 </dt>
5096 <dd>
5097 <p>
5098          compares a (c)ommit and the (w)ork tree;
5099 </p>
5100 </dd>
5101 <dt class="hdlist1">
5102 <code>git diff --cached</code>
5103 </dt>
5104 <dd>
5105 <p>
5106         compares a (c)ommit and the (i)ndex;
5107 </p>
5108 </dd>
5109 <dt class="hdlist1">
5110 <code>git diff HEAD:file1 file2</code>
5111 </dt>
5112 <dd>
5113 <p>
5114         compares an (o)bject and a (w)ork tree entity;
5115 </p>
5116 </dd>
5117 <dt class="hdlist1">
5118 <code>git diff --no-index a b</code>
5119 </dt>
5120 <dd>
5121 <p>
5122         compares two non-git things (1) and (2).
5123 </p>
5124 </dd>
5125 </dl></div>
5126 </dd>
5127 <dt class="hdlist1">
5128 diff.noPrefix
5129 </dt>
5130 <dd>
5131 <p>
5132         If set, <em>git diff</em> does not show any source or destination prefix.
5133 </p>
5134 </dd>
5135 <dt class="hdlist1">
5136 diff.srcPrefix
5137 </dt>
5138 <dd>
5139 <p>
5140         If set, <em>git diff</em> uses this source prefix. Defaults to "a/".
5141 </p>
5142 </dd>
5143 <dt class="hdlist1">
5144 diff.dstPrefix
5145 </dt>
5146 <dd>
5147 <p>
5148         If set, <em>git diff</em> uses this destination prefix. Defaults to "b/".
5149 </p>
5150 </dd>
5151 <dt class="hdlist1">
5152 diff.relative
5153 </dt>
5154 <dd>
5155 <p>
5156         If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
5157         and show pathnames relative to the current directory.
5158 </p>
5159 </dd>
5160 <dt class="hdlist1">
5161 diff.orderFile
5162 </dt>
5163 <dd>
5164 <p>
5165         File indicating how to order files within a diff.
5166         See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
5167         If <code>diff.orderFile</code> is a relative pathname, it is treated as
5168         relative to the top of the working tree.
5169 </p>
5170 </dd>
5171 <dt class="hdlist1">
5172 diff.renameLimit
5173 </dt>
5174 <dd>
5175 <p>
5176         The number of files to consider in the exhaustive portion of
5177         copy/rename detection; equivalent to the <em>git diff</em> option
5178         <code>-l</code>.  If not set, the default value is currently 1000.  This
5179         setting has no effect if rename detection is turned off.
5180 </p>
5181 </dd>
5182 <dt class="hdlist1">
5183 diff.renames
5184 </dt>
5185 <dd>
5186 <p>
5187         Whether and how Git detects renames.  If set to "false",
5188         rename detection is disabled. If set to "true", basic rename
5189         detection is enabled.  If set to "copies" or "copy", Git will
5190         detect copies, as well.  Defaults to true.  Note that this
5191         affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
5192         <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
5193         <a href="git-diff-files.html">git-diff-files(1)</a>.
5194 </p>
5195 </dd>
5196 <dt class="hdlist1">
5197 diff.suppressBlankEmpty
5198 </dt>
5199 <dd>
5200 <p>
5201         A boolean to inhibit the standard behavior of printing a space
5202         before each empty output line. Defaults to false.
5203 </p>
5204 </dd>
5205 <dt class="hdlist1">
5206 diff.submodule
5207 </dt>
5208 <dd>
5209 <p>
5210         Specify the format in which differences in submodules are
5211         shown.  The "short" format just shows the names of the commits
5212         at the beginning and end of the range. The "log" format lists
5213         the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
5214         does. The "diff" format shows an inline diff of the changed
5215         contents of the submodule. Defaults to "short".
5216 </p>
5217 </dd>
5218 <dt class="hdlist1">
5219 diff.wordRegex
5220 </dt>
5221 <dd>
5222 <p>
5223         A POSIX Extended Regular Expression used to determine what is a "word"
5224         when performing word-by-word difference calculations.  Character
5225         sequences that match the regular expression are "words", all other
5226         characters are <strong>ignorable</strong> whitespace.
5227 </p>
5228 </dd>
5229 <dt class="hdlist1">
5230 diff.&lt;driver&gt;.command
5231 </dt>
5232 <dd>
5233 <p>
5234         The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
5235         for details.
5236 </p>
5237 </dd>
5238 <dt class="hdlist1">
5239 diff.&lt;driver&gt;.trustExitCode
5240 </dt>
5241 <dd>
5242 <p>
5243         If this boolean value is set to true then the
5244         <code>diff.&lt;driver&gt;.command</code> command is expected to return exit code
5245         0 if it considers the input files to be equal or 1 if it
5246         considers them to be different, like <code>diff(1)</code>.
5247         If it is set to false, which is the default, then the command
5248         is expected to return exit code 0 regardless of equality.
5249         Any other exit code causes Git to report a fatal error.
5250 </p>
5251 </dd>
5252 <dt class="hdlist1">
5253 diff.&lt;driver&gt;.xfuncname
5254 </dt>
5255 <dd>
5256 <p>
5257         The regular expression that the diff driver should use to
5258         recognize the hunk header.  A built-in pattern may also be used.
5259         See <a href="gitattributes.html">gitattributes(5)</a> for details.
5260 </p>
5261 </dd>
5262 <dt class="hdlist1">
5263 diff.&lt;driver&gt;.binary
5264 </dt>
5265 <dd>
5266 <p>
5267         Set this option to true to make the diff driver treat files as
5268         binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5269 </p>
5270 </dd>
5271 <dt class="hdlist1">
5272 diff.&lt;driver&gt;.textconv
5273 </dt>
5274 <dd>
5275 <p>
5276         The command that the diff driver should call to generate the
5277         text-converted version of a file.  The result of the
5278         conversion is used to generate a human-readable diff.  See
5279         <a href="gitattributes.html">gitattributes(5)</a> for details.
5280 </p>
5281 </dd>
5282 <dt class="hdlist1">
5283 diff.&lt;driver&gt;.wordRegex
5284 </dt>
5285 <dd>
5286 <p>
5287         The regular expression that the diff driver should use to
5288         split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
5289         details.
5290 </p>
5291 </dd>
5292 <dt class="hdlist1">
5293 diff.&lt;driver&gt;.cachetextconv
5294 </dt>
5295 <dd>
5296 <p>
5297         Set this option to true to make the diff driver cache the text
5298         conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5299 </p>
5300 <div class="dlist"><dl>
5301 <dt class="hdlist1">
5302 <code>araxis</code>
5303 </dt>
5304 <dd>
5305 <p>
5306 Use Araxis Merge (requires a graphical session)
5307 </p>
5308 </dd>
5309 <dt class="hdlist1">
5310 <code>bc</code>
5311 </dt>
5312 <dd>
5313 <p>
5314 Use Beyond Compare (requires a graphical session)
5315 </p>
5316 </dd>
5317 <dt class="hdlist1">
5318 <code>bc3</code>
5319 </dt>
5320 <dd>
5321 <p>
5322 Use Beyond Compare (requires a graphical session)
5323 </p>
5324 </dd>
5325 <dt class="hdlist1">
5326 <code>bc4</code>
5327 </dt>
5328 <dd>
5329 <p>
5330 Use Beyond Compare (requires a graphical session)
5331 </p>
5332 </dd>
5333 <dt class="hdlist1">
5334 <code>codecompare</code>
5335 </dt>
5336 <dd>
5337 <p>
5338 Use Code Compare (requires a graphical session)
5339 </p>
5340 </dd>
5341 <dt class="hdlist1">
5342 <code>deltawalker</code>
5343 </dt>
5344 <dd>
5345 <p>
5346 Use DeltaWalker (requires a graphical session)
5347 </p>
5348 </dd>
5349 <dt class="hdlist1">
5350 <code>diffmerge</code>
5351 </dt>
5352 <dd>
5353 <p>
5354 Use DiffMerge (requires a graphical session)
5355 </p>
5356 </dd>
5357 <dt class="hdlist1">
5358 <code>diffuse</code>
5359 </dt>
5360 <dd>
5361 <p>
5362 Use Diffuse (requires a graphical session)
5363 </p>
5364 </dd>
5365 <dt class="hdlist1">
5366 <code>ecmerge</code>
5367 </dt>
5368 <dd>
5369 <p>
5370 Use ECMerge (requires a graphical session)
5371 </p>
5372 </dd>
5373 <dt class="hdlist1">
5374 <code>emerge</code>
5375 </dt>
5376 <dd>
5377 <p>
5378 Use Emacs' Emerge
5379 </p>
5380 </dd>
5381 <dt class="hdlist1">
5382 <code>examdiff</code>
5383 </dt>
5384 <dd>
5385 <p>
5386 Use ExamDiff Pro (requires a graphical session)
5387 </p>
5388 </dd>
5389 <dt class="hdlist1">
5390 <code>guiffy</code>
5391 </dt>
5392 <dd>
5393 <p>
5394 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
5395 </p>
5396 </dd>
5397 <dt class="hdlist1">
5398 <code>gvimdiff</code>
5399 </dt>
5400 <dd>
5401 <p>
5402 Use gVim (requires a graphical session)
5403 </p>
5404 </dd>
5405 <dt class="hdlist1">
5406 <code>kdiff3</code>
5407 </dt>
5408 <dd>
5409 <p>
5410 Use KDiff3 (requires a graphical session)
5411 </p>
5412 </dd>
5413 <dt class="hdlist1">
5414 <code>kompare</code>
5415 </dt>
5416 <dd>
5417 <p>
5418 Use Kompare (requires a graphical session)
5419 </p>
5420 </dd>
5421 <dt class="hdlist1">
5422 <code>meld</code>
5423 </dt>
5424 <dd>
5425 <p>
5426 Use Meld (requires a graphical session)
5427 </p>
5428 </dd>
5429 <dt class="hdlist1">
5430 <code>nvimdiff</code>
5431 </dt>
5432 <dd>
5433 <p>
5434 Use Neovim
5435 </p>
5436 </dd>
5437 <dt class="hdlist1">
5438 <code>opendiff</code>
5439 </dt>
5440 <dd>
5441 <p>
5442 Use FileMerge (requires a graphical session)
5443 </p>
5444 </dd>
5445 <dt class="hdlist1">
5446 <code>p4merge</code>
5447 </dt>
5448 <dd>
5449 <p>
5450 Use HelixCore P4Merge (requires a graphical session)
5451 </p>
5452 </dd>
5453 <dt class="hdlist1">
5454 <code>smerge</code>
5455 </dt>
5456 <dd>
5457 <p>
5458 Use Sublime Merge (requires a graphical session)
5459 </p>
5460 </dd>
5461 <dt class="hdlist1">
5462 <code>tkdiff</code>
5463 </dt>
5464 <dd>
5465 <p>
5466 Use TkDiff (requires a graphical session)
5467 </p>
5468 </dd>
5469 <dt class="hdlist1">
5470 <code>vimdiff</code>
5471 </dt>
5472 <dd>
5473 <p>
5474 Use Vim
5475 </p>
5476 </dd>
5477 <dt class="hdlist1">
5478 <code>winmerge</code>
5479 </dt>
5480 <dd>
5481 <p>
5482 Use WinMerge (requires a graphical session)
5483 </p>
5484 </dd>
5485 <dt class="hdlist1">
5486 <code>xxdiff</code>
5487 </dt>
5488 <dd>
5489 <p>
5490 Use xxdiff (requires a graphical session)
5491 </p>
5492 </dd>
5493 </dl></div>
5494 </dd>
5495 <dt class="hdlist1">
5496 diff.indentHeuristic
5497 </dt>
5498 <dd>
5499 <p>
5500         Set this option to <code>false</code> to disable the default heuristics
5501         that shift diff hunk boundaries to make patches easier to read.
5502 </p>
5503 </dd>
5504 <dt class="hdlist1">
5505 diff.algorithm
5506 </dt>
5507 <dd>
5508 <p>
5509         Choose a diff algorithm.  The variants are as follows:
5510 </p>
5511 <div class="openblock">
5512 <div class="content">
5513 <div class="dlist"><dl>
5514 <dt class="hdlist1">
5515 <code>default</code>, <code>myers</code>
5516 </dt>
5517 <dd>
5518 <p>
5519         The basic greedy diff algorithm. Currently, this is the default.
5520 </p>
5521 </dd>
5522 <dt class="hdlist1">
5523 <code>minimal</code>
5524 </dt>
5525 <dd>
5526 <p>
5527         Spend extra time to make sure the smallest possible diff is
5528         produced.
5529 </p>
5530 </dd>
5531 <dt class="hdlist1">
5532 <code>patience</code>
5533 </dt>
5534 <dd>
5535 <p>
5536         Use "patience diff" algorithm when generating patches.
5537 </p>
5538 </dd>
5539 <dt class="hdlist1">
5540 <code>histogram</code>
5541 </dt>
5542 <dd>
5543 <p>
5544         This algorithm extends the patience algorithm to "support
5545         low-occurrence common elements".
5546 </p>
5547 </dd>
5548 </dl></div>
5549 </div></div>
5550 </dd>
5551 <dt class="hdlist1">
5552 diff.wsErrorHighlight
5553 </dt>
5554 <dd>
5555 <p>
5556         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5557         lines of the diff.  Multiple values are separated by comma,
5558         <code>none</code> resets previous values, <code>default</code> reset the list to
5559         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
5560         whitespace errors are colored with <code>color.diff.whitespace</code>.
5561         The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
5562         overrides this setting.
5563 </p>
5564 </dd>
5565 <dt class="hdlist1">
5566 diff.colorMoved
5567 </dt>
5568 <dd>
5569 <p>
5570         If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
5571         in a diff are colored differently, for details of valid modes
5572         see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
5573         true the default color mode will be used. When set to false,
5574         moved lines are not colored.
5575 </p>
5576 </dd>
5577 <dt class="hdlist1">
5578 diff.colorMovedWS
5579 </dt>
5580 <dd>
5581 <p>
5582         When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5583         this option controls the <code>&lt;mode&gt;</code> how spaces are treated.
5584         For details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.
5585 </p>
5586 </dd>
5587 <dt class="hdlist1">
5588 diff.tool
5589 </dt>
5590 <dd>
5591 <p>
5592         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
5593         This variable overrides the value configured in <code>merge.tool</code>.
5594         The list below shows the valid built-in values.
5595         Any other value is treated as a custom diff tool and requires
5596         that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
5597 </p>
5598 </dd>
5599 <dt class="hdlist1">
5600 diff.guitool
5601 </dt>
5602 <dd>
5603 <p>
5604         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
5605         the -g/--gui flag is specified. This variable overrides the value
5606         configured in <code>merge.guitool</code>. The list below shows the valid
5607         built-in values. Any other value is treated as a custom diff tool
5608         and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
5609         is defined.
5610 </p>
5611 </dd>
5612 <dt class="hdlist1">
5613 difftool.&lt;tool&gt;.cmd
5614 </dt>
5615 <dd>
5616 <p>
5617         Specify the command to invoke the specified diff tool.
5618         The specified command is evaluated in shell with the following
5619         variables available:  <em>LOCAL</em> is set to the name of the temporary
5620         file containing the contents of the diff pre-image and <em>REMOTE</em>
5621         is set to the name of the temporary file containing the contents
5622         of the diff post-image.
5623 </p>
5624 <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>
5625 </dd>
5626 <dt class="hdlist1">
5627 difftool.&lt;tool&gt;.path
5628 </dt>
5629 <dd>
5630 <p>
5631         Override the path for the given tool.  This is useful in case
5632         your tool is not in the PATH.
5633 </p>
5634 </dd>
5635 <dt class="hdlist1">
5636 difftool.trustExitCode
5637 </dt>
5638 <dd>
5639 <p>
5640         Exit difftool if the invoked diff tool returns a non-zero exit status.
5641 </p>
5642 <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>
5643 </dd>
5644 <dt class="hdlist1">
5645 difftool.prompt
5646 </dt>
5647 <dd>
5648 <p>
5649         Prompt before each invocation of the diff tool.
5650 </p>
5651 </dd>
5652 <dt class="hdlist1">
5653 difftool.guiDefault
5654 </dt>
5655 <dd>
5656 <p>
5657         Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5658         the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5659         depending on the presence of a <code>DISPLAY</code> environment variable value. The
5660         default is <code>false</code>, where the <code>--gui</code> argument must be provided
5661         explicitly for the <code>diff.guitool</code> to be used.
5662 </p>
5663 </dd>
5664 <dt class="hdlist1">
5665 extensions.objectFormat
5666 </dt>
5667 <dd>
5668 <p>
5669         Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
5670         <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
5671         this key unless <code>core.repositoryFormatVersion</code> is 1.
5672 </p>
5673 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5674 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
5675 work and will produce hard-to-diagnose issues.</p></div>
5676 </dd>
5677 <dt class="hdlist1">
5678 extensions.compatObjectFormat
5679 </dt>
5680 <dd>
5681 <p>
5682         Specify a compatitbility hash algorithm to use.  The acceptable values
5683         are <code>sha1</code> and <code>sha256</code>.  The value specified must be different from the
5684         value of extensions.objectFormat.  This allows client level
5685         interoperability between git repositories whose objectFormat matches
5686         this compatObjectFormat.  In particular when fully implemented the
5687         pushes and pulls from a repository in whose objectFormat matches
5688         compatObjectFormat.  As well as being able to use oids encoded in
5689         compatObjectFormat in addition to oids encoded with objectFormat to
5690         locally specify objects.
5691 </p>
5692 </dd>
5693 <dt class="hdlist1">
5694 extensions.refStorage
5695 </dt>
5696 <dd>
5697 <p>
5698         Specify the ref storage format to use. The acceptable values are:
5699 </p>
5700 <div class="ulist"><ul>
5701 <li>
5702 <p>
5703 <code>files</code> for loose files with packed-refs. This is the default.
5704 </p>
5705 </li>
5706 <li>
5707 <p>
5708 <code>reftable</code> for the reftable format. This format is experimental and its
5709   internals are subject to change.
5710 </p>
5711 <div class="paragraph"><p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p></div>
5712 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5713 <a href="git-clone.html">git-clone(1)</a>. Trying to change it after initialization will not
5714 work and will produce hard-to-diagnose issues.</p></div>
5715 </li>
5716 </ul></div>
5717 </dd>
5718 <dt class="hdlist1">
5719 extensions.worktreeConfig
5720 </dt>
5721 <dd>
5722 <p>
5723         If enabled, then worktrees will load config settings from the
5724         <code>$GIT_DIR/config.worktree</code> file in addition to the
5725         <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5726         <code>$GIT_DIR</code> are the same for the main working tree, while other
5727         working trees have <code>$GIT_DIR</code> equal to
5728         <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
5729         <code>config.worktree</code> file will override settings from any other
5730         config files.
5731 </p>
5732 <div class="paragraph"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5733 certain values from the common config file to the main working tree&#8217;s
5734 <code>config.worktree</code> file, if present:</p></div>
5735 <div class="ulist"><ul>
5736 <li>
5737 <p>
5738 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5739   <code>$GIT_COMMON_DIR/config.worktree</code>.
5740 </p>
5741 </li>
5742 <li>
5743 <p>
5744 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5745   to <code>$GIT_COMMON_DIR/config.worktree</code>.
5746 </p>
5747 <div class="paragraph"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5748 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5749 sparse-checkout settings for each worktree. By default, the <code>git
5750 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5751 these config values on a per-worktree basis, and uses the
5752 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5753 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
5754 details.</p></div>
5755 <div class="paragraph"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5756 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5757 </li>
5758 </ul></div>
5759 </dd>
5760 <dt class="hdlist1">
5761 fastimport.unpackLimit
5762 </dt>
5763 <dd>
5764 <p>
5765         If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
5766         is below this limit, then the objects will be unpacked into
5767         loose object files.  However, if the number of imported objects
5768         equals or exceeds this limit, then the pack will be stored as a
5769         pack.  Storing the pack from a fast-import can make the import
5770         operation complete faster, especially on slow filesystems.  If
5771         not set, the value of <code>transfer.unpackLimit</code> is used instead.
5772 </p>
5773 </dd>
5774 <dt class="hdlist1">
5775 feature.*
5776 </dt>
5777 <dd>
5778 <p>
5779         The config settings that start with <code>feature.</code> modify the defaults of
5780         a group of other config settings. These groups are created by the Git
5781         developer community as recommended defaults and are subject to change.
5782         In particular, new config options may be added with different defaults.
5783 </p>
5784 </dd>
5785 <dt class="hdlist1">
5786 feature.experimental
5787 </dt>
5788 <dd>
5789 <p>
5790         Enable config options that are new to Git, and are being considered for
5791         future defaults. Config settings included here may be added or removed
5792         with each release, including minor version updates. These settings may
5793         have unintended interactions since they are so new. Please enable this
5794         setting if you are interested in providing feedback on experimental
5795         features. The new default values are:
5796 </p>
5797 <div class="ulist"><ul>
5798 <li>
5799 <p>
5800 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5801 skipping more commits at a time, reducing the number of round trips.
5802 </p>
5803 </li>
5804 <li>
5805 <p>
5806 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5807 walking fewer objects.
5808 </p>
5809 </li>
5810 <li>
5811 <p>
5812 <code>pack.allowPackReuse=multi</code> may improve the time it takes to create a pack by
5813 reusing objects from multiple packs instead of just one.
5814 </p>
5815 </li>
5816 </ul></div>
5817 </dd>
5818 <dt class="hdlist1">
5819 feature.manyFiles
5820 </dt>
5821 <dd>
5822 <p>
5823         Enable config options that optimize for repos with many files in the
5824         working directory. With many files, commands such as <code>git status</code> and
5825         <code>git checkout</code> may be slow and these new defaults improve performance:
5826 </p>
5827 <div class="ulist"><ul>
5828 <li>
5829 <p>
5830 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5831   checksum. Note that this will cause Git versions earlier than 2.13.0 to
5832   refuse to parse the index and Git versions earlier than 2.40.0 will report
5833   a corrupted index during <code>git fsck</code>.
5834 </p>
5835 </li>
5836 <li>
5837 <p>
5838 <code>index.version=4</code> enables path-prefix compression in the index.
5839 </p>
5840 </li>
5841 <li>
5842 <p>
5843 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5844 that mtime is working on your machine.
5845 </p>
5846 </li>
5847 </ul></div>
5848 </dd>
5849 <dt class="hdlist1">
5850 fetch.recurseSubmodules
5851 </dt>
5852 <dd>
5853 <p>
5854         This option controls whether <code>git fetch</code> (and the underlying fetch
5855         in <code>git pull</code>) will recursively fetch into populated submodules.
5856         This option can be set either to a boolean value or to <em>on-demand</em>.
5857         Setting it to a boolean changes the behavior of fetch and pull to
5858         recurse unconditionally into submodules when set to true or to not
5859         recurse at all when set to false. When set to <em>on-demand</em>, fetch and
5860         pull will only recurse into a populated submodule when its
5861         superproject retrieves a commit that updates the submodule&#8217;s
5862         reference.
5863         Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
5864 </p>
5865 </dd>
5866 <dt class="hdlist1">
5867 fetch.fsckObjects
5868 </dt>
5869 <dd>
5870 <p>
5871         If it is set to true, git-fetch-pack will check all fetched
5872         objects. See <code>transfer.fsckObjects</code> for what&#8217;s
5873         checked. Defaults to false. If not set, the value of
5874         <code>transfer.fsckObjects</code> is used instead.
5875 </p>
5876 </dd>
5877 <dt class="hdlist1">
5878 fetch.fsck.&lt;msg-id&gt;
5879 </dt>
5880 <dd>
5881 <p>
5882         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
5883         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5884         the <code>fsck.&lt;msg-id&gt;</code> documentation for details.
5885 </p>
5886 </dd>
5887 <dt class="hdlist1">
5888 fetch.fsck.skipList
5889 </dt>
5890 <dd>
5891 <p>
5892         Acts like <code>fsck.skipList</code>, but is used by
5893         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5894         the <code>fsck.skipList</code> documentation for details.
5895 </p>
5896 </dd>
5897 <dt class="hdlist1">
5898 fetch.unpackLimit
5899 </dt>
5900 <dd>
5901 <p>
5902         If the number of objects fetched over the Git native
5903         transfer is below this
5904         limit, then the objects will be unpacked into loose object
5905         files. However if the number of received objects equals or
5906         exceeds this limit then the received pack will be stored as
5907         a pack, after adding any missing delta bases.  Storing the
5908         pack from a push can make the push operation complete faster,
5909         especially on slow filesystems.  If not set, the value of
5910         <code>transfer.unpackLimit</code> is used instead.
5911 </p>
5912 </dd>
5913 <dt class="hdlist1">
5914 fetch.prune
5915 </dt>
5916 <dd>
5917 <p>
5918         If true, fetch will automatically behave as if the <code>--prune</code>
5919         option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
5920         and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.
5921 </p>
5922 </dd>
5923 <dt class="hdlist1">
5924 fetch.pruneTags
5925 </dt>
5926 <dd>
5927 <p>
5928         If true, fetch will automatically behave as if the
5929         <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
5930         if not set already. This allows for setting both this option
5931         and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
5932         refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
5933         section of <a href="git-fetch.html">git-fetch(1)</a>.
5934 </p>
5935 </dd>
5936 <dt class="hdlist1">
5937 fetch.all
5938 </dt>
5939 <dd>
5940 <p>
5941         If true, fetch will attempt to update all available remotes.
5942         This behavior can be overridden by passing <code>--no-all</code> or by
5943         explicitly specifying one or more remote(s) to fetch from.
5944         Defaults to false.
5945 </p>
5946 </dd>
5947 <dt class="hdlist1">
5948 fetch.output
5949 </dt>
5950 <dd>
5951 <p>
5952         Control how ref update status is printed. Valid values are
5953         <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
5954         OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.
5955 </p>
5956 </dd>
5957 <dt class="hdlist1">
5958 fetch.negotiationAlgorithm
5959 </dt>
5960 <dd>
5961 <p>
5962         Control how information about the commits in the local repository
5963         is sent when negotiating the contents of the packfile to be sent by
5964         the server.  Set to "consecutive" to use an algorithm that walks
5965         over consecutive commits checking each one.  Set to "skipping" to
5966         use an algorithm that skips commits in an effort to converge
5967         faster, but may result in a larger-than-necessary packfile; or set
5968         to "noop" to not send any information at all, which will almost
5969         certainly result in a larger-than-necessary packfile, but will skip
5970         the negotiation step.  Set to "default" to override settings made
5971         previously and use the default behaviour.  The default is normally
5972         "consecutive", but if <code>feature.experimental</code> is true, then the
5973         default is "skipping".  Unknown values will cause <em>git fetch</em> to
5974         error out.
5975 </p>
5976 <div class="paragraph"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
5977 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
5978 </dd>
5979 <dt class="hdlist1">
5980 fetch.showForcedUpdates
5981 </dt>
5982 <dd>
5983 <p>
5984         Set to false to enable <code>--no-show-forced-updates</code> in
5985         <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
5986         Defaults to true.
5987 </p>
5988 </dd>
5989 <dt class="hdlist1">
5990 fetch.parallel
5991 </dt>
5992 <dd>
5993 <p>
5994         Specifies the maximal number of fetch operations to be run in parallel
5995         at a time (submodules, or remotes when the <code>--multiple</code> option of
5996         <a href="git-fetch.html">git-fetch(1)</a> is in effect).
5997 </p>
5998 <div class="paragraph"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
5999 <div class="paragraph"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
6000 config setting.</p></div>
6001 </dd>
6002 <dt class="hdlist1">
6003 fetch.writeCommitGraph
6004 </dt>
6005 <dd>
6006 <p>
6007         Set to true to write a commit-graph after every <code>git fetch</code> command
6008         that downloads a pack-file from a remote. Using the <code>--split</code> option,
6009         most executions will create a very small commit-graph file on top of
6010         the existing commit-graph file(s). Occasionally, these files will
6011         merge and the write may take longer. Having an updated commit-graph
6012         file helps performance of many Git commands, including <code>git merge-base</code>,
6013         <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
6014 </p>
6015 </dd>
6016 <dt class="hdlist1">
6017 fetch.bundleURI
6018 </dt>
6019 <dd>
6020 <p>
6021         This value stores a URI for downloading Git object data from a bundle
6022         URI before performing an incremental fetch from the origin Git server.
6023         This is similar to how the <code>--bundle-uri</code> option behaves in
6024         <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
6025         <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
6026         list that is organized for incremental fetches.
6027 </p>
6028 <div class="paragraph"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
6029 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
6030 the new bundle URI.</p></div>
6031 </dd>
6032 <dt class="hdlist1">
6033 fetch.bundleCreationToken
6034 </dt>
6035 <dd>
6036 <p>
6037         When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
6038         list that uses the "creationToken" heuristic, this config value
6039         stores the maximum <code>creationToken</code> value of the downloaded bundles.
6040         This value is used to prevent downloading bundles in the future
6041         if the advertised <code>creationToken</code> is not strictly larger than this
6042         value.
6043 </p>
6044 <div class="paragraph"><p>The creation token values are chosen by the provider serving the specific
6045 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
6046 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
6047 </dd>
6048 <dt class="hdlist1">
6049 filter.&lt;driver&gt;.clean
6050 </dt>
6051 <dd>
6052 <p>
6053         The command which is used to convert the content of a worktree
6054         file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
6055         details.
6056 </p>
6057 </dd>
6058 <dt class="hdlist1">
6059 filter.&lt;driver&gt;.smudge
6060 </dt>
6061 <dd>
6062 <p>
6063         The command which is used to convert the content of a blob
6064         object to a worktree file upon checkout.  See
6065         <a href="gitattributes.html">gitattributes(5)</a> for details.
6066 </p>
6067 </dd>
6068 <dt class="hdlist1">
6069 format.attach
6070 </dt>
6071 <dd>
6072 <p>
6073         Enable multipart/mixed attachments as the default for
6074         <em>format-patch</em>.  The value can also be a double quoted string
6075         which will enable attachments as the default and set the
6076         value as the boundary.  See the --attach option in
6077         <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
6078         value, set it to an empty string.
6079 </p>
6080 </dd>
6081 <dt class="hdlist1">
6082 format.from
6083 </dt>
6084 <dd>
6085 <p>
6086         Provides the default value for the <code>--from</code> option to format-patch.
6087         Accepts a boolean value, or a name and email address.  If false,
6088         format-patch defaults to <code>--no-from</code>, using commit authors directly in
6089         the "From:" field of patch mails.  If true, format-patch defaults to
6090         <code>--from</code>, using your committer identity in the "From:" field of patch
6091         mails and including a "From:" field in the body of the patch mail if
6092         different.  If set to a non-boolean value, format-patch uses that
6093         value instead of your committer identity.  Defaults to false.
6094 </p>
6095 </dd>
6096 <dt class="hdlist1">
6097 format.forceInBodyFrom
6098 </dt>
6099 <dd>
6100 <p>
6101         Provides the default value for the <code>--[no-]force-in-body-from</code>
6102         option to format-patch.  Defaults to false.
6103 </p>
6104 </dd>
6105 <dt class="hdlist1">
6106 format.numbered
6107 </dt>
6108 <dd>
6109 <p>
6110         A boolean which can enable or disable sequence numbers in patch
6111         subjects.  It defaults to "auto" which enables it only if there
6112         is more than one patch.  It can be enabled or disabled for all
6113         messages by setting it to "true" or "false".  See --numbered
6114         option in <a href="git-format-patch.html">git-format-patch(1)</a>.
6115 </p>
6116 </dd>
6117 <dt class="hdlist1">
6118 format.headers
6119 </dt>
6120 <dd>
6121 <p>
6122         Additional email headers to include in a patch to be submitted
6123         by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.
6124 </p>
6125 </dd>
6126 <dt class="hdlist1">
6127 format.to
6128 </dt>
6129 <dt class="hdlist1">
6130 format.cc
6131 </dt>
6132 <dd>
6133 <p>
6134         Additional recipients to include in a patch to be submitted
6135         by mail.  See the --to and --cc options in
6136         <a href="git-format-patch.html">git-format-patch(1)</a>.
6137 </p>
6138 </dd>
6139 <dt class="hdlist1">
6140 format.subjectPrefix
6141 </dt>
6142 <dd>
6143 <p>
6144         The default for format-patch is to output files with the <em>[PATCH]</em>
6145         subject prefix. Use this variable to change that prefix.
6146 </p>
6147 </dd>
6148 <dt class="hdlist1">
6149 format.coverFromDescription
6150 </dt>
6151 <dd>
6152 <p>
6153         The default mode for format-patch to determine which parts of
6154         the cover letter will be populated using the branch&#8217;s
6155         description. See the <code>--cover-from-description</code> option in
6156         <a href="git-format-patch.html">git-format-patch(1)</a>.
6157 </p>
6158 </dd>
6159 <dt class="hdlist1">
6160 format.signature
6161 </dt>
6162 <dd>
6163 <p>
6164         The default for format-patch is to output a signature containing
6165         the Git version number. Use this variable to change that default.
6166         Set this variable to the empty string ("") to suppress
6167         signature generation.
6168 </p>
6169 </dd>
6170 <dt class="hdlist1">
6171 format.signatureFile
6172 </dt>
6173 <dd>
6174 <p>
6175         Works just like format.signature except the contents of the
6176         file specified by this variable will be used as the signature.
6177 </p>
6178 </dd>
6179 <dt class="hdlist1">
6180 format.suffix
6181 </dt>
6182 <dd>
6183 <p>
6184         The default for format-patch is to output files with the suffix
6185         <code>.patch</code>. Use this variable to change that suffix (make sure to
6186         include the dot if you want it).
6187 </p>
6188 </dd>
6189 <dt class="hdlist1">
6190 format.encodeEmailHeaders
6191 </dt>
6192 <dd>
6193 <p>
6194         Encode email headers that have non-ASCII characters with
6195         "Q-encoding" (described in RFC 2047) for email transmission.
6196         Defaults to true.
6197 </p>
6198 </dd>
6199 <dt class="hdlist1">
6200 format.pretty
6201 </dt>
6202 <dd>
6203 <p>
6204         The default pretty format for log/show/whatchanged command.
6205         See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
6206         <a href="git-whatchanged.html">git-whatchanged(1)</a>.
6207 </p>
6208 </dd>
6209 <dt class="hdlist1">
6210 format.thread
6211 </dt>
6212 <dd>
6213 <p>
6214         The default threading style for <em>git format-patch</em>.  Can be
6215         a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
6216         makes every mail a reply to the head of the series,
6217         where the head is chosen from the cover letter, the
6218         <code>--in-reply-to</code>, and the first patch mail, in this order.
6219         <code>deep</code> threading makes every mail a reply to the previous one.
6220         A true boolean value is the same as <code>shallow</code>, and a false
6221         value disables threading.
6222 </p>
6223 </dd>
6224 <dt class="hdlist1">
6225 format.signOff
6226 </dt>
6227 <dd>
6228 <p>
6229         A boolean value which lets you enable the <code>-s/--signoff</code> option of
6230         format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
6231         patch should be a conscious act and means that you certify you have
6232         the rights to submit this work under the same open source license.
6233         Please see the <em>SubmittingPatches</em> document for further discussion.
6234 </p>
6235 </dd>
6236 <dt class="hdlist1">
6237 format.coverLetter
6238 </dt>
6239 <dd>
6240 <p>
6241         A boolean that controls whether to generate a cover-letter when
6242         format-patch is invoked, but in addition can be set to "auto", to
6243         generate a cover-letter only when there&#8217;s more than one patch.
6244         Default is false.
6245 </p>
6246 </dd>
6247 <dt class="hdlist1">
6248 format.outputDirectory
6249 </dt>
6250 <dd>
6251 <p>
6252         Set a custom directory to store the resulting files instead of the
6253         current working directory. All directory components will be created.
6254 </p>
6255 </dd>
6256 <dt class="hdlist1">
6257 format.filenameMaxLength
6258 </dt>
6259 <dd>
6260 <p>
6261         The maximum length of the output filenames generated by the
6262         <code>format-patch</code> command; defaults to 64.  Can be overridden
6263         by the <code>--filename-max-length=&lt;n&gt;</code> command line option.
6264 </p>
6265 </dd>
6266 <dt class="hdlist1">
6267 format.useAutoBase
6268 </dt>
6269 <dd>
6270 <p>
6271         A boolean value which lets you enable the <code>--base=auto</code> option of
6272         format-patch by default. Can also be set to "whenAble" to allow
6273         enabling <code>--base=auto</code> if a suitable base is available, but to skip
6274         adding base info otherwise without the format dying.
6275 </p>
6276 </dd>
6277 <dt class="hdlist1">
6278 format.notes
6279 </dt>
6280 <dd>
6281 <p>
6282         Provides the default value for the <code>--notes</code> option to
6283         format-patch. Accepts a boolean value, or a ref which specifies
6284         where to get notes. If false, format-patch defaults to
6285         <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
6286         set to a non-boolean value, format-patch defaults to
6287         <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
6288         to false.
6289 </p>
6290 <div class="paragraph"><p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
6291 instead.</p></div>
6292 <div class="paragraph"><p>This configuration can be specified multiple times in order to allow
6293 multiple notes refs to be included. In that case, it will behave
6294 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
6295 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
6296 also show notes from that notes ref and a value of <code>false</code> will negate
6297 previous configurations and not show notes.</p></div>
6298 <div class="paragraph"><p>For example,</p></div>
6299 <div class="listingblock">
6300 <div class="content">
6301 <pre><code>[format]
6302         notes = true
6303         notes = foo
6304         notes = false
6305         notes = bar</code></pre>
6306 </div></div>
6307 <div class="paragraph"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
6308 </dd>
6309 <dt class="hdlist1">
6310 format.mboxrd
6311 </dt>
6312 <dd>
6313 <p>
6314         A boolean value which enables the robust "mboxrd" format when
6315         <code>--stdout</code> is in use to escape "^&gt;+From " lines.
6316 </p>
6317 </dd>
6318 <dt class="hdlist1">
6319 format.noprefix
6320 </dt>
6321 <dd>
6322 <p>
6323         If set, do not show any source or destination prefix in patches.
6324         This is equivalent to the <code>diff.noprefix</code> option used by <code>git
6325         diff</code> (but which is not respected by <code>format-patch</code>). Note that
6326         by setting this, the receiver of any patches you generate will
6327         have to apply them using the <code>-p0</code> option.
6328 </p>
6329 </dd>
6330 <dt class="hdlist1">
6331 fsck.&lt;msg-id&gt;
6332 </dt>
6333 <dd>
6334 <p>
6335         During fsck git may find issues with legacy data which
6336         wouldn&#8217;t be generated by current versions of git, and which
6337         wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
6338         set. This feature is intended to support working with legacy
6339         repositories containing such data.
6340 </p>
6341 <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
6342 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
6343 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
6344 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
6345 same applies for the corresponding <code>receive.fsck.*</code> and
6346 <code>fetch.fsck.*</code>. variables.</p></div>
6347 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
6348 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
6349 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
6350 uniformly configure the same fsck settings in different circumstances,
6351 all three of them must be set to the same values.</p></div>
6352 <div class="paragraph"><p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
6353 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
6354 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
6355 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
6356 with the message ID, e.g. "missingEmail: invalid author/committer
6357 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
6358 will hide that issue.</p></div>
6359 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
6360 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6361 problematic objects share to be ignored, as doing the latter will
6362 allow new instances of the same breakages go unnoticed.</p></div>
6363 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
6364 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
6365 will only cause git to warn.</p></div>
6366 <div class="paragraph"><p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
6367 values of <code>&lt;msg-id&gt;</code>.</p></div>
6368 </dd>
6369 <dt class="hdlist1">
6370 fsck.skipList
6371 </dt>
6372 <dd>
6373 <p>
6374         The path to a list of object names (i.e. one unabbreviated SHA-1 per
6375         line) that are known to be broken in a non-fatal way and should
6376         be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
6377         lines, and any leading and trailing whitespace are ignored. Everything
6378         but a SHA-1 per line will error out on older versions.
6379 </p>
6380 <div class="paragraph"><p>This feature is useful when an established project should be accepted
6381 despite early commits containing errors that can be safely ignored,
6382 such as invalid committer email addresses.  Note: corrupt objects
6383 cannot be skipped with this setting.</p></div>
6384 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
6385 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6386 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6387 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6388 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
6389 uniformly configure the same fsck settings in different circumstances,
6390 all three of them must be set to the same values.</p></div>
6391 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
6392 list should be sorted. This was never a requirement; the object names
6393 could appear in any order, but when reading the list we tracked whether
6394 the list was sorted for the purposes of an internal binary search
6395 implementation, which could save itself some work with an already sorted
6396 list. Unless you had a humongous list there was no reason to go out of
6397 your way to pre-sort the list. After Git version 2.20 a hash implementation
6398 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
6399 </dd>
6400 <dt class="hdlist1">
6401 fsmonitor.allowRemote
6402 </dt>
6403 <dd>
6404 <p>
6405     By default, the fsmonitor daemon refuses to work with network-mounted
6406     repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6407     behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6408 </p>
6409 </dd>
6410 <dt class="hdlist1">
6411 fsmonitor.socketDir
6412 </dt>
6413 <dd>
6414 <p>
6415     This Mac OS-specific option, if set, specifies the directory in
6416     which to create the Unix domain socket used for communication
6417     between the fsmonitor daemon and various Git commands. The directory must
6418     reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
6419     is set to <code>true</code>.
6420 </p>
6421 </dd>
6422 <dt class="hdlist1">
6423 gc.aggressiveDepth
6424 </dt>
6425 <dd>
6426 <p>
6427         The depth parameter used in the delta compression
6428         algorithm used by <em>git gc --aggressive</em>.  This defaults
6429         to 50, which is the default for the <code>--depth</code> option when
6430         <code>--aggressive</code> isn&#8217;t in use.
6431 </p>
6432 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
6433 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6434 </dd>
6435 <dt class="hdlist1">
6436 gc.aggressiveWindow
6437 </dt>
6438 <dd>
6439 <p>
6440         The window size parameter used in the delta compression
6441         algorithm used by <em>git gc --aggressive</em>.  This defaults
6442         to 250, which is a much more aggressive window size than
6443         the default <code>--window</code> of 10.
6444 </p>
6445 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
6446 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6447 </dd>
6448 <dt class="hdlist1">
6449 gc.auto
6450 </dt>
6451 <dd>
6452 <p>
6453         When there are approximately more than this many loose
6454         objects in the repository, <code>git gc --auto</code> will pack them.
6455         Some Porcelain commands use this command to perform a
6456         light-weight garbage collection from time to time.  The
6457         default value is 6700.
6458 </p>
6459 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
6460 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
6461 otherwise use to determine if there&#8217;s work to do, such as
6462 <code>gc.autoPackLimit</code>.</p></div>
6463 </dd>
6464 <dt class="hdlist1">
6465 gc.autoPackLimit
6466 </dt>
6467 <dd>
6468 <p>
6469         When there are more than this many packs that are not
6470         marked with <code>*.keep</code> file in the repository, <code>git gc
6471         --auto</code> consolidates them into one larger pack.  The
6472         default value is 50.  Setting this to 0 disables it.
6473         Setting <code>gc.auto</code> to 0 will also disable this.
6474 </p>
6475 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6476 use, it&#8217;ll affect how the auto pack limit works.</p></div>
6477 </dd>
6478 <dt class="hdlist1">
6479 gc.autoDetach
6480 </dt>
6481 <dd>
6482 <p>
6483         Make <code>git gc --auto</code> return immediately and run in the background
6484         if the system supports it. Default is true.
6485 </p>
6486 </dd>
6487 <dt class="hdlist1">
6488 gc.bigPackThreshold
6489 </dt>
6490 <dd>
6491 <p>
6492         If non-zero, all non-cruft packs larger than this limit are kept
6493         when <code>git gc</code> is run. This is very similar to
6494         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6495         the threshold are kept, not just the largest pack. Defaults to
6496         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6497 </p>
6498 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6499 this configuration variable is ignored, all packs except the base pack
6500 will be repacked. After this the number of packs should go below
6501 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6502 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6503 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6504 will also be excluded (this is the equivalent of running <code>git gc</code> with
6505 <code>--keep-largest-pack</code>).</p></div>
6506 </dd>
6507 <dt class="hdlist1">
6508 gc.writeCommitGraph
6509 </dt>
6510 <dd>
6511 <p>
6512         If true, then gc will rewrite the commit-graph file when
6513         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6514         the commit-graph will be updated if housekeeping is
6515         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
6516         for details.
6517 </p>
6518 </dd>
6519 <dt class="hdlist1">
6520 gc.logExpiry
6521 </dt>
6522 <dd>
6523 <p>
6524         If the file gc.log exists, then <code>git gc --auto</code> will print
6525         its content and exit with status zero instead of running
6526         unless that file is more than <em>gc.logExpiry</em> old.  Default is
6527         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
6528         value.
6529 </p>
6530 </dd>
6531 <dt class="hdlist1">
6532 gc.packRefs
6533 </dt>
6534 <dd>
6535 <p>
6536         Running <code>git pack-refs</code> in a repository renders it
6537         unclonable by Git versions prior to 1.5.1.2 over dumb
6538         transports such as HTTP.  This variable determines whether
6539         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6540         to enable it within all non-bare repos or it can be set to a
6541         boolean value.  The default is <code>true</code>.
6542 </p>
6543 </dd>
6544 <dt class="hdlist1">
6545 gc.cruftPacks
6546 </dt>
6547 <dd>
6548 <p>
6549         Store unreachable objects in a cruft pack (see
6550         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
6551         is <code>true</code>.
6552 </p>
6553 </dd>
6554 <dt class="hdlist1">
6555 gc.maxCruftSize
6556 </dt>
6557 <dd>
6558 <p>
6559         Limit the size of new cruft packs when repacking. When
6560         specified in addition to <code>--max-cruft-size</code>, the command line
6561         option takes priority. See the <code>--max-cruft-size</code> option of
6562         <a href="git-repack.html">git-repack(1)</a>.
6563 </p>
6564 </dd>
6565 <dt class="hdlist1">
6566 gc.pruneExpire
6567 </dt>
6568 <dd>
6569 <p>
6570         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6571         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6572         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
6573         grace period with this config variable.  The value "now" may be
6574         used to disable this grace period and always prune unreachable
6575         objects immediately, or "never" may be used to suppress pruning.
6576         This feature helps prevent corruption when <em>git gc</em> runs
6577         concurrently with another process writing to the repository; see
6578         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
6579 </p>
6580 </dd>
6581 <dt class="hdlist1">
6582 gc.worktreePruneExpire
6583 </dt>
6584 <dd>
6585 <p>
6586         When <em>git gc</em> is run, it calls
6587         <em>git worktree prune --expire 3.months.ago</em>.
6588         This config variable can be used to set a different grace
6589         period. The value "now" may be used to disable the grace
6590         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
6591         may be used to suppress pruning.
6592 </p>
6593 </dd>
6594 <dt class="hdlist1">
6595 gc.reflogExpire
6596 </dt>
6597 <dt class="hdlist1">
6598 gc.&lt;pattern&gt;.reflogExpire
6599 </dt>
6600 <dd>
6601 <p>
6602         <em>git reflog expire</em> removes reflog entries older than
6603         this time; defaults to 90 days. The value "now" expires all
6604         entries immediately, and "never" suppresses expiration
6605         altogether. With "&lt;pattern&gt;" (e.g.
6606         "refs/stash") in the middle the setting applies only to
6607         the refs that match the &lt;pattern&gt;.
6608 </p>
6609 </dd>
6610 <dt class="hdlist1">
6611 gc.reflogExpireUnreachable
6612 </dt>
6613 <dt class="hdlist1">
6614 gc.&lt;pattern&gt;.reflogExpireUnreachable
6615 </dt>
6616 <dd>
6617 <p>
6618         <em>git reflog expire</em> removes reflog entries older than
6619         this time and are not reachable from the current tip;
6620         defaults to 30 days. The value "now" expires all entries
6621         immediately, and "never" suppresses expiration altogether.
6622         With "&lt;pattern&gt;" (e.g. "refs/stash")
6623         in the middle, the setting applies only to the refs that
6624         match the &lt;pattern&gt;.
6625 </p>
6626 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
6627 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6628 or rebase occurring.  Since these changes are not part of the current
6629 project most users will want to expire them sooner, which is why the
6630 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6631 </dd>
6632 <dt class="hdlist1">
6633 gc.recentObjectsHook
6634 </dt>
6635 <dd>
6636 <p>
6637         When considering whether or not to remove an object (either when
6638         generating a cruft pack or storing unreachable objects as
6639         loose), use the shell to execute the specified command(s).
6640         Interpret their output as object IDs which Git will consider as
6641         "recent", regardless of their age. By treating their mtimes as
6642         "now", any objects (and their descendants) mentioned in the
6643         output will be kept regardless of their true age.
6644 </p>
6645 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
6646 else. Objects which cannot be found in the repository are ignored.
6647 Multiple hooks are supported, but all must exit successfully, else the
6648 operation (either generating a cruft pack or unpacking unreachable
6649 objects) will be halted.</p></div>
6650 </dd>
6651 <dt class="hdlist1">
6652 gc.repackFilter
6653 </dt>
6654 <dd>
6655 <p>
6656         When repacking, use the specified filter to move certain
6657         objects into a separate packfile.  See the
6658         <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.
6659 </p>
6660 </dd>
6661 <dt class="hdlist1">
6662 gc.repackFilterTo
6663 </dt>
6664 <dd>
6665 <p>
6666         When repacking and using a filter, see <code>gc.repackFilter</code>, the
6667         specified location will be used to create the packfile
6668         containing the filtered out objects. <strong>WARNING:</strong> The
6669         specified location should be accessible, using for example the
6670         Git alternates mechanism, otherwise the repo could be
6671         considered corrupt by Git as it migh not be able to access the
6672         objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
6673         of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
6674         section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.
6675 </p>
6676 </dd>
6677 <dt class="hdlist1">
6678 gc.rerereResolved
6679 </dt>
6680 <dd>
6681 <p>
6682         Records of conflicted merge you resolved earlier are
6683         kept for this many days when <em>git rerere gc</em> is run.
6684         You can also use more human-readable "1.month.ago", etc.
6685         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6686 </p>
6687 </dd>
6688 <dt class="hdlist1">
6689 gc.rerereUnresolved
6690 </dt>
6691 <dd>
6692 <p>
6693         Records of conflicted merge you have not resolved are
6694         kept for this many days when <em>git rerere gc</em> is run.
6695         You can also use more human-readable "1.month.ago", etc.
6696         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6697 </p>
6698 </dd>
6699 <dt class="hdlist1">
6700 gitcvs.commitMsgAnnotation
6701 </dt>
6702 <dd>
6703 <p>
6704         Append this string to each commit message. Set to empty string
6705         to disable this feature. Defaults to "via git-CVS emulator".
6706 </p>
6707 </dd>
6708 <dt class="hdlist1">
6709 gitcvs.enabled
6710 </dt>
6711 <dd>
6712 <p>
6713         Whether the CVS server interface is enabled for this repository.
6714         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6715 </p>
6716 </dd>
6717 <dt class="hdlist1">
6718 gitcvs.logFile
6719 </dt>
6720 <dd>
6721 <p>
6722         Path to a log file where the CVS server interface well&#8230; logs
6723         various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6724 </p>
6725 </dd>
6726 <dt class="hdlist1">
6727 gitcvs.usecrlfattr
6728 </dt>
6729 <dd>
6730 <p>
6731         If true, the server will look up the end-of-line conversion
6732         attributes for files to determine the <code>-k</code> modes to use. If
6733         the attributes force Git to treat a file as text,
6734         the <code>-k</code> mode will be left blank so CVS clients will
6735         treat it as text. If they suppress text conversion, the file
6736         will be set with <em>-kb</em> mode, which suppresses any newline munging
6737         the client might otherwise do. If the attributes do not allow
6738         the file type to be determined, then <code>gitcvs.allBinary</code> is
6739         used. See <a href="gitattributes.html">gitattributes(5)</a>.
6740 </p>
6741 </dd>
6742 <dt class="hdlist1">
6743 gitcvs.allBinary
6744 </dt>
6745 <dd>
6746 <p>
6747         This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6748         the correct <em>-kb</em> mode to use. If true, all
6749         unresolved files are sent to the client in
6750         mode <em>-kb</em>. This causes the client to treat them
6751         as binary files, which suppresses any newline munging it
6752         otherwise might do. Alternatively, if it is set to "guess",
6753         then the contents of the file are examined to decide if
6754         it is binary, similar to <code>core.autocrlf</code>.
6755 </p>
6756 </dd>
6757 <dt class="hdlist1">
6758 gitcvs.dbName
6759 </dt>
6760 <dd>
6761 <p>
6762         Database used by git-cvsserver to cache revision information
6763         derived from the Git repository. The exact meaning depends on the
6764         used database driver, for SQLite (which is the default driver) this
6765         is a filename. Supports variable substitution (see
6766         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6767         Default: <em>%Ggitcvs.%m.sqlite</em>
6768 </p>
6769 </dd>
6770 <dt class="hdlist1">
6771 gitcvs.dbDriver
6772 </dt>
6773 <dd>
6774 <p>
6775         Used Perl DBI driver. You can specify any available driver
6776         for this here, but it might not work. git-cvsserver is tested
6777         with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6778         reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6779         May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6780         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6781 </p>
6782 </dd>
6783 <dt class="hdlist1">
6784 gitcvs.dbUser, gitcvs.dbPass
6785 </dt>
6786 <dd>
6787 <p>
6788         Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6789         since SQLite has no concept of database users and/or passwords.
6790         <em>gitcvs.dbUser</em> supports variable substitution (see
6791         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
6792 </p>
6793 </dd>
6794 <dt class="hdlist1">
6795 gitcvs.dbTableNamePrefix
6796 </dt>
6797 <dd>
6798 <p>
6799         Database table name prefix.  Prepended to the names of any
6800         database tables used, allowing a single database to be used
6801         for several repositories.  Supports variable substitution (see
6802         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
6803         characters will be replaced with underscores.
6804 </p>
6805 </dd>
6806 </dl></div>
6807 <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6808 <code>gitcvs.allBinary</code> can also be specified as
6809 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
6810 is one of "ext" and "pserver") to make them apply only for the given
6811 access method.</p></div>
6812 <div class="dlist"><dl>
6813 <dt class="hdlist1">
6814 gitweb.category
6815 </dt>
6816 <dt class="hdlist1">
6817 gitweb.description
6818 </dt>
6819 <dt class="hdlist1">
6820 gitweb.owner
6821 </dt>
6822 <dt class="hdlist1">
6823 gitweb.url
6824 </dt>
6825 <dd>
6826 <p>
6827         See <a href="gitweb.html">gitweb(1)</a> for description.
6828 </p>
6829 </dd>
6830 <dt class="hdlist1">
6831 gitweb.avatar
6832 </dt>
6833 <dt class="hdlist1">
6834 gitweb.blame
6835 </dt>
6836 <dt class="hdlist1">
6837 gitweb.grep
6838 </dt>
6839 <dt class="hdlist1">
6840 gitweb.highlight
6841 </dt>
6842 <dt class="hdlist1">
6843 gitweb.patches
6844 </dt>
6845 <dt class="hdlist1">
6846 gitweb.pickaxe
6847 </dt>
6848 <dt class="hdlist1">
6849 gitweb.remote_heads
6850 </dt>
6851 <dt class="hdlist1">
6852 gitweb.showSizes
6853 </dt>
6854 <dt class="hdlist1">
6855 gitweb.snapshot
6856 </dt>
6857 <dd>
6858 <p>
6859         See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
6860 </p>
6861 </dd>
6862 <dt class="hdlist1">
6863 gpg.program
6864 </dt>
6865 <dd>
6866 <p>
6867         Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
6868         making or verifying a PGP signature. The program must support the
6869         same command-line interface as GPG, namely, to verify a detached
6870         signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
6871         program is expected to signal a good signature by exiting with
6872         code 0.  To generate an ASCII-armored detached signature, the
6873         standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
6874         signed, and the program is expected to send the result to its
6875         standard output.
6876 </p>
6877 </dd>
6878 <dt class="hdlist1">
6879 gpg.format
6880 </dt>
6881 <dd>
6882 <p>
6883         Specifies which key format to use when signing with <code>--gpg-sign</code>.
6884         Default is "openpgp". Other possible values are "x509", "ssh".
6885 </p>
6886 <div class="paragraph"><p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
6887 based on the selected <code>gpg.format</code>.</p></div>
6888 </dd>
6889 <dt class="hdlist1">
6890 gpg.&lt;format&gt;.program
6891 </dt>
6892 <dd>
6893 <p>
6894         Use this to customize the program used for the signing format you
6895         chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
6896         be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
6897         value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".
6898 </p>
6899 </dd>
6900 <dt class="hdlist1">
6901 gpg.minTrustLevel
6902 </dt>
6903 <dd>
6904 <p>
6905         Specifies a minimum trust level for signature verification.  If
6906         this option is unset, then signature verification for merge
6907         operations requires a key with at least <code>marginal</code> trust.  Other
6908         operations that perform signature verification require a key
6909         with at least <code>undefined</code> trust.  Setting this option overrides
6910         the required trust-level for all operations.  Supported values,
6911         in increasing order of significance:
6912 </p>
6913 <div class="ulist"><ul>
6914 <li>
6915 <p>
6916 <code>undefined</code>
6917 </p>
6918 </li>
6919 <li>
6920 <p>
6921 <code>never</code>
6922 </p>
6923 </li>
6924 <li>
6925 <p>
6926 <code>marginal</code>
6927 </p>
6928 </li>
6929 <li>
6930 <p>
6931 <code>fully</code>
6932 </p>
6933 </li>
6934 <li>
6935 <p>
6936 <code>ultimate</code>
6937 </p>
6938 </li>
6939 </ul></div>
6940 </dd>
6941 <dt class="hdlist1">
6942 gpg.ssh.defaultKeyCommand
6943 </dt>
6944 <dd>
6945 <p>
6946         This command will be run when user.signingkey is not set and a ssh
6947         signature is requested. On successful exit a valid ssh public key
6948         prefixed with <code>key::</code> is expected in the first line of its output.
6949         This allows for a script doing a dynamic lookup of the correct public
6950         key when it is impractical to statically configure <code>user.signingKey</code>.
6951         For example when keys or SSH Certificates are rotated frequently or
6952         selection of the right key depends on external factors unknown to git.
6953 </p>
6954 </dd>
6955 <dt class="hdlist1">
6956 gpg.ssh.allowedSignersFile
6957 </dt>
6958 <dd>
6959 <p>
6960         A file containing ssh public keys which you are willing to trust.
6961         The file consists of one or more lines of principals followed by an ssh
6962         public key.
6963         e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
6964         See ssh-keygen(1) "ALLOWED SIGNERS" for details.
6965         The principal is only used to identify the key and is available when
6966         verifying a signature.
6967 </p>
6968 <div class="paragraph"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
6969 between valid signatures and trusted signatures the trust level of a signature
6970 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
6971 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
6972 <div class="paragraph"><p>This file can be set to a location outside of the repository and every developer
6973 maintains their own trust store. A central repository server could generate this
6974 file automatically from ssh keys with push access to verify the code against.
6975 In a corporate setting this file is probably generated at a global location
6976 from automation that already handles developer ssh keys.</p></div>
6977 <div class="paragraph"><p>A repository that only allows signed commits can store the file
6978 in the repository itself using a path relative to the top-level of the working tree.
6979 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
6980 <div class="paragraph"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
6981 valid-before options. Git will mark signatures as valid if the signing key was
6982 valid at the time of the signature&#8217;s creation. This allows users to change a
6983 signing key without invalidating all previously made signatures.</p></div>
6984 <div class="paragraph"><p>Using a SSH CA key with the cert-authority option
6985 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p></div>
6986 </dd>
6987 <dt class="hdlist1">
6988 gpg.ssh.revocationFile
6989 </dt>
6990 <dd>
6991 <p>
6992         Either a SSH KRL or a list of revoked public keys (without the principal prefix).
6993         See ssh-keygen(1) for details.
6994         If a public key is found in this file then it will always be treated
6995         as having trust level "never" and signatures will show as invalid.
6996 </p>
6997 </dd>
6998 <dt class="hdlist1">
6999 grep.lineNumber
7000 </dt>
7001 <dd>
7002 <p>
7003         If set to true, enable <code>-n</code> option by default.
7004 </p>
7005 </dd>
7006 <dt class="hdlist1">
7007 grep.column
7008 </dt>
7009 <dd>
7010 <p>
7011         If set to true, enable the <code>--column</code> option by default.
7012 </p>
7013 </dd>
7014 <dt class="hdlist1">
7015 grep.patternType
7016 </dt>
7017 <dd>
7018 <p>
7019         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
7020         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
7021         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
7022         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
7023         between <em>basic</em> and <em>extended</em>.
7024 </p>
7025 </dd>
7026 <dt class="hdlist1">
7027 grep.extendedRegexp
7028 </dt>
7029 <dd>
7030 <p>
7031         If set to true, enable <code>--extended-regexp</code> option by default. This
7032         option is ignored when the <code>grep.patternType</code> option is set to a value
7033         other than <em>default</em>.
7034 </p>
7035 </dd>
7036 <dt class="hdlist1">
7037 grep.threads
7038 </dt>
7039 <dd>
7040 <p>
7041         Number of grep worker threads to use. If unset (or set to 0), Git will
7042         use as many threads as the number of logical cores available.
7043 </p>
7044 </dd>
7045 <dt class="hdlist1">
7046 grep.fullName
7047 </dt>
7048 <dd>
7049 <p>
7050         If set to true, enable <code>--full-name</code> option by default.
7051 </p>
7052 </dd>
7053 <dt class="hdlist1">
7054 grep.fallbackToNoIndex
7055 </dt>
7056 <dd>
7057 <p>
7058         If set to true, fall back to <code>git grep --no-index</code> if <code>git grep</code>
7059         is executed outside of a git repository.  Defaults to false.
7060 </p>
7061 </dd>
7062 <dt class="hdlist1">
7063 gui.commitMsgWidth
7064 </dt>
7065 <dd>
7066 <p>
7067         Defines how wide the commit message window is in the
7068         <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
7069 </p>
7070 </dd>
7071 <dt class="hdlist1">
7072 gui.diffContext
7073 </dt>
7074 <dd>
7075 <p>
7076         Specifies how many context lines should be used in calls to diff
7077         made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
7078 </p>
7079 </dd>
7080 <dt class="hdlist1">
7081 gui.displayUntracked
7082 </dt>
7083 <dd>
7084 <p>
7085         Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
7086         in the file list. The default is "true".
7087 </p>
7088 </dd>
7089 <dt class="hdlist1">
7090 gui.encoding
7091 </dt>
7092 <dd>
7093 <p>
7094         Specifies the default character encoding to use for displaying of
7095         file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
7096         It can be overridden by setting the <em>encoding</em> attribute
7097         for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
7098         If this option is not set, the tools default to the
7099         locale encoding.
7100 </p>
7101 </dd>
7102 <dt class="hdlist1">
7103 gui.matchTrackingBranch
7104 </dt>
7105 <dd>
7106 <p>
7107         Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
7108         default to tracking remote branches with matching names or
7109         not. Default: "false".
7110 </p>
7111 </dd>
7112 <dt class="hdlist1">
7113 gui.newBranchTemplate
7114 </dt>
7115 <dd>
7116 <p>
7117         Is used as a suggested name when creating new branches using the
7118         <a href="git-gui.html">git-gui(1)</a>.
7119 </p>
7120 </dd>
7121 <dt class="hdlist1">
7122 gui.pruneDuringFetch
7123 </dt>
7124 <dd>
7125 <p>
7126         "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
7127         performing a fetch. The default value is "false".
7128 </p>
7129 </dd>
7130 <dt class="hdlist1">
7131 gui.trustmtime
7132 </dt>
7133 <dd>
7134 <p>
7135         Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
7136         timestamp or not. By default the timestamps are not trusted.
7137 </p>
7138 </dd>
7139 <dt class="hdlist1">
7140 gui.spellingDictionary
7141 </dt>
7142 <dd>
7143 <p>
7144         Specifies the dictionary used for spell checking commit messages in
7145         the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
7146         off.
7147 </p>
7148 </dd>
7149 <dt class="hdlist1">
7150 gui.fastCopyBlame
7151 </dt>
7152 <dd>
7153 <p>
7154         If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
7155         location detection. It makes blame significantly faster on huge
7156         repositories at the expense of less thorough copy detection.
7157 </p>
7158 </dd>
7159 <dt class="hdlist1">
7160 gui.copyBlameThreshold
7161 </dt>
7162 <dd>
7163 <p>
7164         Specifies the threshold to use in <em>git gui blame</em> original location
7165         detection, measured in alphanumeric characters. See the
7166         <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
7167 </p>
7168 </dd>
7169 <dt class="hdlist1">
7170 gui.blamehistoryctx
7171 </dt>
7172 <dd>
7173 <p>
7174         Specifies the radius of history context in days to show in
7175         <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
7176         Context</code> menu item is invoked from <em>git gui blame</em>. If this
7177         variable is set to zero, the whole history is shown.
7178 </p>
7179 </dd>
7180 <dt class="hdlist1">
7181 guitool.&lt;name&gt;.cmd
7182 </dt>
7183 <dd>
7184 <p>
7185         Specifies the shell command line to execute when the corresponding item
7186         of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
7187         mandatory for every tool. The command is executed from the root of
7188         the working directory, and in the environment it receives the name of
7189         the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
7190         <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
7191         the head is detached, <em>CUR_BRANCH</em> is empty).
7192 </p>
7193 </dd>
7194 <dt class="hdlist1">
7195 guitool.&lt;name&gt;.needsFile
7196 </dt>
7197 <dd>
7198 <p>
7199         Run the tool only if a diff is selected in the GUI. It guarantees
7200         that <em>FILENAME</em> is not empty.
7201 </p>
7202 </dd>
7203 <dt class="hdlist1">
7204 guitool.&lt;name&gt;.noConsole
7205 </dt>
7206 <dd>
7207 <p>
7208         Run the command silently, without creating a window to display its
7209         output.
7210 </p>
7211 </dd>
7212 <dt class="hdlist1">
7213 guitool.&lt;name&gt;.noRescan
7214 </dt>
7215 <dd>
7216 <p>
7217         Don&#8217;t rescan the working directory for changes after the tool
7218         finishes execution.
7219 </p>
7220 </dd>
7221 <dt class="hdlist1">
7222 guitool.&lt;name&gt;.confirm
7223 </dt>
7224 <dd>
7225 <p>
7226         Show a confirmation dialog before actually running the tool.
7227 </p>
7228 </dd>
7229 <dt class="hdlist1">
7230 guitool.&lt;name&gt;.argPrompt
7231 </dt>
7232 <dd>
7233 <p>
7234         Request a string argument from the user, and pass it to the tool
7235         through the <code>ARGS</code> environment variable. Since requesting an
7236         argument implies confirmation, the <em>confirm</em> option has no effect
7237         if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
7238         the dialog uses a built-in generic prompt; otherwise the exact
7239         value of the variable is used.
7240 </p>
7241 </dd>
7242 <dt class="hdlist1">
7243 guitool.&lt;name&gt;.revPrompt
7244 </dt>
7245 <dd>
7246 <p>
7247         Request a single valid revision from the user, and set the
7248         <code>REVISION</code> environment variable. In other aspects this option
7249         is similar to <em>argPrompt</em>, and can be used together with it.
7250 </p>
7251 </dd>
7252 <dt class="hdlist1">
7253 guitool.&lt;name&gt;.revUnmerged
7254 </dt>
7255 <dd>
7256 <p>
7257         Show only unmerged branches in the <em>revPrompt</em> subdialog.
7258         This is useful for tools similar to merge or rebase, but not
7259         for things like checkout or reset.
7260 </p>
7261 </dd>
7262 <dt class="hdlist1">
7263 guitool.&lt;name&gt;.title
7264 </dt>
7265 <dd>
7266 <p>
7267         Specifies the title to use for the prompt dialog. The default
7268         is the tool name.
7269 </p>
7270 </dd>
7271 <dt class="hdlist1">
7272 guitool.&lt;name&gt;.prompt
7273 </dt>
7274 <dd>
7275 <p>
7276         Specifies the general prompt string to display at the top of
7277         the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
7278         The default value includes the actual command.
7279 </p>
7280 </dd>
7281 <dt class="hdlist1">
7282 help.browser
7283 </dt>
7284 <dd>
7285 <p>
7286         Specify the browser that will be used to display help in the
7287         <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
7288 </p>
7289 </dd>
7290 <dt class="hdlist1">
7291 help.format
7292 </dt>
7293 <dd>
7294 <p>
7295         Override the default help format used by <a href="git-help.html">git-help(1)</a>.
7296         Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
7297         the default. <em>web</em> and <em>html</em> are the same.
7298 </p>
7299 </dd>
7300 <dt class="hdlist1">
7301 help.autoCorrect
7302 </dt>
7303 <dd>
7304 <p>
7305         If git detects typos and can identify exactly one valid command similar
7306         to the error, git will try to suggest the correct command or even
7307         run the suggestion automatically. Possible config values are:
7308 </p>
7309 <div class="ulist"><ul>
7310 <li>
7311 <p>
7312 0 (default): show the suggested command.
7313 </p>
7314 </li>
7315 <li>
7316 <p>
7317 positive number: run the suggested command after specified
7318 deciseconds (0.1 sec).
7319 </p>
7320 </li>
7321 <li>
7322 <p>
7323 "immediate": run the suggested command immediately.
7324 </p>
7325 </li>
7326 <li>
7327 <p>
7328 "prompt": show the suggestion and prompt for confirmation to run
7329 the command.
7330 </p>
7331 </li>
7332 <li>
7333 <p>
7334 "never": don&#8217;t run or show any suggested command.
7335 </p>
7336 </li>
7337 </ul></div>
7338 </dd>
7339 <dt class="hdlist1">
7340 help.htmlPath
7341 </dt>
7342 <dd>
7343 <p>
7344         Specify the path where the HTML documentation resides. File system paths
7345         and URLs are supported. HTML pages will be prefixed with this path when
7346         help is displayed in the <em>web</em> format. This defaults to the documentation
7347         path of your Git installation.
7348 </p>
7349 </dd>
7350 <dt class="hdlist1">
7351 http.proxy
7352 </dt>
7353 <dd>
7354 <p>
7355         Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
7356         <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
7357         addition to the syntax understood by curl, it is possible to specify a
7358         proxy string with a user name but no password, in which case git will
7359         attempt to acquire one in the same way it does for other credentials. See
7360         <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
7361         <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
7362         on a per-remote basis; see remote.&lt;name&gt;.proxy
7363 </p>
7364 </dd>
7365 <dt class="hdlist1">
7366 http.proxyAuthMethod
7367 </dt>
7368 <dd>
7369 <p>
7370         Set the method with which to authenticate against the HTTP proxy. This
7371         only takes effect if the configured proxy string contains a user name part
7372         (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
7373         overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
7374         Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
7375         variable.  Possible values are:
7376 </p>
7377 <div class="openblock">
7378 <div class="content">
7379 <div class="ulist"><ul>
7380 <li>
7381 <p>
7382 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
7383   assumed that the proxy answers an unauthenticated request with a 407
7384   status code and one or more Proxy-authenticate headers with supported
7385   authentication methods. This is the default.
7386 </p>
7387 </li>
7388 <li>
7389 <p>
7390 <code>basic</code> - HTTP Basic authentication
7391 </p>
7392 </li>
7393 <li>
7394 <p>
7395 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
7396   transmitted to the proxy in clear text
7397 </p>
7398 </li>
7399 <li>
7400 <p>
7401 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7402   of <code>curl(1)</code>)
7403 </p>
7404 </li>
7405 <li>
7406 <p>
7407 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7408 </p>
7409 </li>
7410 </ul></div>
7411 </div></div>
7412 </dd>
7413 <dt class="hdlist1">
7414 http.proxySSLCert
7415 </dt>
7416 <dd>
7417 <p>
7418         The pathname of a file that stores a client certificate to use to authenticate
7419         with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7420         variable.
7421 </p>
7422 </dd>
7423 <dt class="hdlist1">
7424 http.proxySSLKey
7425 </dt>
7426 <dd>
7427 <p>
7428         The pathname of a file that stores a private key to use to authenticate with
7429         an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7430         variable.
7431 </p>
7432 </dd>
7433 <dt class="hdlist1">
7434 http.proxySSLCertPasswordProtected
7435 </dt>
7436 <dd>
7437 <p>
7438         Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
7439         will prompt the user, possibly many times, if the certificate or private key
7440         is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7441         environment variable.
7442 </p>
7443 </dd>
7444 <dt class="hdlist1">
7445 http.proxySSLCAInfo
7446 </dt>
7447 <dd>
7448 <p>
7449         Pathname to the file containing the certificate bundle that should be used to
7450         verify the proxy with when using an HTTPS proxy. Can be overridden by the
7451         <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7452 </p>
7453 </dd>
7454 <dt class="hdlist1">
7455 http.emptyAuth
7456 </dt>
7457 <dd>
7458 <p>
7459         Attempt authentication without seeking a username or password.  This
7460         can be used to attempt GSS-Negotiate authentication without specifying
7461         a username in the URL, as libcurl normally requires a username for
7462         authentication.
7463 </p>
7464 </dd>
7465 <dt class="hdlist1">
7466 http.delegation
7467 </dt>
7468 <dd>
7469 <p>
7470         Control GSSAPI credential delegation. The delegation is disabled
7471         by default in libcurl since version 7.21.7. Set parameter to tell
7472         the server what it is allowed to delegate when it comes to user
7473         credentials. Used with GSS/kerberos. Possible values are:
7474 </p>
7475 <div class="openblock">
7476 <div class="content">
7477 <div class="ulist"><ul>
7478 <li>
7479 <p>
7480 <code>none</code> - Don&#8217;t allow any delegation.
7481 </p>
7482 </li>
7483 <li>
7484 <p>
7485 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7486   Kerberos service ticket, which is a matter of realm policy.
7487 </p>
7488 </li>
7489 <li>
7490 <p>
7491 <code>always</code> - Unconditionally allow the server to delegate.
7492 </p>
7493 </li>
7494 </ul></div>
7495 </div></div>
7496 </dd>
7497 <dt class="hdlist1">
7498 http.extraHeader
7499 </dt>
7500 <dd>
7501 <p>
7502         Pass an additional HTTP header when communicating with a server.  If
7503         more than one such entry exists, all of them are added as extra
7504         headers.  To allow overriding the settings inherited from the system
7505         config, an empty value will reset the extra headers to the empty list.
7506 </p>
7507 </dd>
7508 <dt class="hdlist1">
7509 http.cookieFile
7510 </dt>
7511 <dd>
7512 <p>
7513         The pathname of a file containing previously stored cookie lines,
7514         which should be used
7515         in the Git http session, if they match the server. The file format
7516         of the file to read cookies from should be plain HTTP headers or
7517         the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7518         NOTE that the file specified with http.cookieFile is used only as
7519         input unless http.saveCookies is set.
7520 </p>
7521 </dd>
7522 <dt class="hdlist1">
7523 http.saveCookies
7524 </dt>
7525 <dd>
7526 <p>
7527         If set, store cookies received during requests to the file specified by
7528         http.cookieFile. Has no effect if http.cookieFile is unset.
7529 </p>
7530 </dd>
7531 <dt class="hdlist1">
7532 http.version
7533 </dt>
7534 <dd>
7535 <p>
7536         Use the specified HTTP protocol version when communicating with a server.
7537         If you want to force the default. The available and default version depend
7538         on libcurl. Currently the possible values of
7539         this option are:
7540 </p>
7541 <div class="ulist"><ul>
7542 <li>
7543 <p>
7544 HTTP/2
7545 </p>
7546 </li>
7547 <li>
7548 <p>
7549 HTTP/1.1
7550 </p>
7551 </li>
7552 </ul></div>
7553 </dd>
7554 <dt class="hdlist1">
7555 http.curloptResolve
7556 </dt>
7557 <dd>
7558 <p>
7559         Hostname resolution information that will be used first by
7560         libcurl when sending HTTP requests.  This information should
7561         be in one of the following formats:
7562 </p>
7563 <div class="ulist"><ul>
7564 <li>
7565 <p>
7566 [+]HOST:PORT:ADDRESS[,ADDRESS]
7567 </p>
7568 </li>
7569 <li>
7570 <p>
7571 -HOST:PORT
7572 </p>
7573 </li>
7574 </ul></div>
7575 <div class="paragraph"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7576 to the provided <code>ADDRESS</code>(s). The second format clears all
7577 previous config values for that <code>HOST:PORT</code> combination.  To
7578 allow easy overriding of all the settings inherited from the
7579 system config, an empty value will reset all resolution
7580 information to the empty list.</p></div>
7581 </dd>
7582 <dt class="hdlist1">
7583 http.sslVersion
7584 </dt>
7585 <dd>
7586 <p>
7587         The SSL version to use when negotiating an SSL connection, if you
7588         want to force the default.  The available and default version
7589         depend on whether libcurl was built against NSS or OpenSSL and the
7590         particular configuration of the crypto library in use. Internally
7591         this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7592         documentation for more details on the format of this option and
7593         for the ssl version supported. Currently the possible values of
7594         this option are:
7595 </p>
7596 <div class="ulist"><ul>
7597 <li>
7598 <p>
7599 sslv2
7600 </p>
7601 </li>
7602 <li>
7603 <p>
7604 sslv3
7605 </p>
7606 </li>
7607 <li>
7608 <p>
7609 tlsv1
7610 </p>
7611 </li>
7612 <li>
7613 <p>
7614 tlsv1.0
7615 </p>
7616 </li>
7617 <li>
7618 <p>
7619 tlsv1.1
7620 </p>
7621 </li>
7622 <li>
7623 <p>
7624 tlsv1.2
7625 </p>
7626 </li>
7627 <li>
7628 <p>
7629 tlsv1.3
7630 </p>
7631 </li>
7632 </ul></div>
7633 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7634 To force git to use libcurl&#8217;s default ssl version and ignore any
7635 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7636 empty string.</p></div>
7637 </dd>
7638 <dt class="hdlist1">
7639 http.sslCipherList
7640 </dt>
7641 <dd>
7642 <p>
7643   A list of SSL ciphers to use when negotiating an SSL connection.
7644   The available ciphers depend on whether libcurl was built against
7645   NSS or OpenSSL and the particular configuration of the crypto
7646   library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7647   option; see the libcurl documentation for more details on the format
7648   of this list.
7649 </p>
7650 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7651 To force git to use libcurl&#8217;s default cipher list and ignore any
7652 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7653 empty string.</p></div>
7654 </dd>
7655 <dt class="hdlist1">
7656 http.sslVerify
7657 </dt>
7658 <dd>
7659 <p>
7660         Whether to verify the SSL certificate when fetching or pushing
7661         over HTTPS. Defaults to true. Can be overridden by the
7662         <code>GIT_SSL_NO_VERIFY</code> environment variable.
7663 </p>
7664 </dd>
7665 <dt class="hdlist1">
7666 http.sslCert
7667 </dt>
7668 <dd>
7669 <p>
7670         File containing the SSL certificate when fetching or pushing
7671         over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7672         variable.
7673 </p>
7674 </dd>
7675 <dt class="hdlist1">
7676 http.sslKey
7677 </dt>
7678 <dd>
7679 <p>
7680         File containing the SSL private key when fetching or pushing
7681         over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7682         variable.
7683 </p>
7684 </dd>
7685 <dt class="hdlist1">
7686 http.sslCertPasswordProtected
7687 </dt>
7688 <dd>
7689 <p>
7690         Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
7691         OpenSSL will prompt the user, possibly many times, if the
7692         certificate or private key is encrypted.  Can be overridden by the
7693         <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7694 </p>
7695 </dd>
7696 <dt class="hdlist1">
7697 http.sslCAInfo
7698 </dt>
7699 <dd>
7700 <p>
7701         File containing the certificates to verify the peer with when
7702         fetching or pushing over HTTPS. Can be overridden by the
7703         <code>GIT_SSL_CAINFO</code> environment variable.
7704 </p>
7705 </dd>
7706 <dt class="hdlist1">
7707 http.sslCAPath
7708 </dt>
7709 <dd>
7710 <p>
7711         Path containing files with the CA certificates to verify the peer
7712         with when fetching or pushing over HTTPS. Can be overridden
7713         by the <code>GIT_SSL_CAPATH</code> environment variable.
7714 </p>
7715 </dd>
7716 <dt class="hdlist1">
7717 http.sslBackend
7718 </dt>
7719 <dd>
7720 <p>
7721         Name of the SSL backend to use (e.g. "openssl" or "schannel").
7722         This option is ignored if cURL lacks support for choosing the SSL
7723         backend at runtime.
7724 </p>
7725 </dd>
7726 <dt class="hdlist1">
7727 http.schannelCheckRevoke
7728 </dt>
7729 <dd>
7730 <p>
7731         Used to enforce or disable certificate revocation checks in cURL
7732         when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
7733         unset. Only necessary to disable this if Git consistently errors
7734         and the message is about checking the revocation status of a
7735         certificate. This option is ignored if cURL lacks support for
7736         setting the relevant SSL option at runtime.
7737 </p>
7738 </dd>
7739 <dt class="hdlist1">
7740 http.schannelUseSSLCAInfo
7741 </dt>
7742 <dd>
7743 <p>
7744         As of cURL v7.60.0, the Secure Channel backend can use the
7745         certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7746         override the Windows Certificate Store. Since this is not desirable
7747         by default, Git will tell cURL not to use that bundle by default
7748         when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7749         unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7750 </p>
7751 </dd>
7752 <dt class="hdlist1">
7753 http.pinnedPubkey
7754 </dt>
7755 <dd>
7756 <p>
7757         Public key of the https service. It may either be the filename of
7758         a PEM or DER encoded public key file or a string starting with
7759         <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7760         public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7761         exit with an error if this option is set but not supported by
7762         cURL.
7763 </p>
7764 </dd>
7765 <dt class="hdlist1">
7766 http.sslTry
7767 </dt>
7768 <dd>
7769 <p>
7770         Attempt to use AUTH SSL/TLS and encrypted data transfers
7771         when connecting via regular FTP protocol. This might be needed
7772         if the FTP server requires it for security reasons or you wish
7773         to connect securely whenever remote FTP server supports it.
7774         Default is false since it might trigger certificate verification
7775         errors on misconfigured servers.
7776 </p>
7777 </dd>
7778 <dt class="hdlist1">
7779 http.maxRequests
7780 </dt>
7781 <dd>
7782 <p>
7783         How many HTTP requests to launch in parallel. Can be overridden
7784         by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7785 </p>
7786 </dd>
7787 <dt class="hdlist1">
7788 http.minSessions
7789 </dt>
7790 <dd>
7791 <p>
7792         The number of curl sessions (counted across slots) to be kept across
7793         requests. They will not be ended with curl_easy_cleanup() until
7794         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7795         value will be capped at 1. Defaults to 1.
7796 </p>
7797 </dd>
7798 <dt class="hdlist1">
7799 http.postBuffer
7800 </dt>
7801 <dd>
7802 <p>
7803         Maximum size in bytes of the buffer used by smart HTTP
7804         transports when POSTing data to the remote system.
7805         For requests larger than this buffer size, HTTP/1.1 and
7806         Transfer-Encoding: chunked is used to avoid creating a
7807         massive pack file locally.  Default is 1 MiB, which is
7808         sufficient for most requests.
7809 </p>
7810 <div class="paragraph"><p>Note that raising this limit is only effective for disabling chunked
7811 transfer encoding and therefore should be used only where the remote
7812 server or a proxy only supports HTTP/1.0 or is noncompliant with the
7813 HTTP standard.  Raising this is not, in general, an effective solution
7814 for most push problems, but can increase memory consumption
7815 significantly since the entire buffer is allocated even for small
7816 pushes.</p></div>
7817 </dd>
7818 <dt class="hdlist1">
7819 http.lowSpeedLimit, http.lowSpeedTime
7820 </dt>
7821 <dd>
7822 <p>
7823         If the HTTP transfer speed, in bytes per second, is less than
7824         <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
7825         the transfer is aborted.
7826         Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
7827         <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
7828 </p>
7829 </dd>
7830 <dt class="hdlist1">
7831 http.noEPSV
7832 </dt>
7833 <dd>
7834 <p>
7835         A boolean which disables using of EPSV ftp command by curl.
7836         This can be helpful with some "poor" ftp servers which don&#8217;t
7837         support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
7838         environment variable. Default is false (curl will use EPSV).
7839 </p>
7840 </dd>
7841 <dt class="hdlist1">
7842 http.userAgent
7843 </dt>
7844 <dd>
7845 <p>
7846         The HTTP USER_AGENT string presented to an HTTP server.  The default
7847         value represents the version of the Git client such as git/1.7.1.
7848         This option allows you to override this value to a more common value
7849         such as Mozilla/4.0.  This may be necessary, for instance, if
7850         connecting through a firewall that restricts HTTP connections to a set
7851         of common USER_AGENT strings (but not including those like git/1.7.1).
7852         Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
7853 </p>
7854 </dd>
7855 <dt class="hdlist1">
7856 http.followRedirects
7857 </dt>
7858 <dd>
7859 <p>
7860         Whether git should follow HTTP redirects. If set to <code>true</code>, git
7861         will transparently follow any redirect issued by a server it
7862         encounters. If set to <code>false</code>, git will treat all redirects as
7863         errors. If set to <code>initial</code>, git will follow redirects only for
7864         the initial request to a remote, but not for subsequent
7865         follow-up HTTP requests. Since git uses the redirected URL as
7866         the base for the follow-up requests, this is generally
7867         sufficient. The default is <code>initial</code>.
7868 </p>
7869 </dd>
7870 <dt class="hdlist1">
7871 http.&lt;url&gt;.*
7872 </dt>
7873 <dd>
7874 <p>
7875         Any of the http.* options above can be applied selectively to some URLs.
7876         For a config key to match a URL, each element of the config key is
7877         compared to that of the URL, in the following order:
7878 </p>
7879 <div class="openblock">
7880 <div class="content">
7881 <div class="olist arabic"><ol class="arabic">
7882 <li>
7883 <p>
7884 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
7885   must match exactly between the config key and the URL.
7886 </p>
7887 </li>
7888 <li>
7889 <p>
7890 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
7891   This field must match between the config key and the URL. It is
7892   possible to specify a <code>*</code> as part of the host name to match all subdomains
7893   at this level. <code>https://*.example.com/</code> for example would match
7894   <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
7895 </p>
7896 </li>
7897 <li>
7898 <p>
7899 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
7900   This field must match exactly between the config key and the URL.
7901   Omitted port numbers are automatically converted to the correct
7902   default for the scheme before matching.
7903 </p>
7904 </li>
7905 <li>
7906 <p>
7907 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
7908   path field of the config key must match the path field of the URL
7909   either exactly or as a prefix of slash-delimited path elements.  This means
7910   a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
7911   match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
7912   key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
7913   key with just path <code>foo/</code>).
7914 </p>
7915 </li>
7916 <li>
7917 <p>
7918 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
7919   the config key has a user name it must match the user name in the
7920   URL exactly. If the config key does not have a user name, that
7921   config key will match a URL with any user name (including none),
7922   but at a lower precedence than a config key with a user name.
7923 </p>
7924 </li>
7925 </ol></div>
7926 </div></div>
7927 <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
7928 a config key&#8217;s path is preferred to one that matches its user name. For example,
7929 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
7930 <code>https://example.com/foo</code> will be preferred over a config key match of
7931 <code>https://user@example.com</code>.</p></div>
7932 <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
7933 if embedded in the URL, is always ignored for matching purposes) so that
7934 equivalent URLs that are simply spelled differently will match properly.
7935 Environment variable settings always override any matches.  The URLs that are
7936 matched against are those given directly to Git commands.  This means any URLs
7937 visited as a result of a redirection do not participate in matching.</p></div>
7938 </dd>
7939 <dt class="hdlist1">
7940 i18n.commitEncoding
7941 </dt>
7942 <dd>
7943 <p>
7944         Character encoding the commit messages are stored in; Git itself
7945         does not care per se, but this information is necessary e.g. when
7946         importing commits from emails or in the gitk graphical history
7947         browser (and possibly in other places in the future or in other
7948         porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
7949 </p>
7950 </dd>
7951 <dt class="hdlist1">
7952 i18n.logOutputEncoding
7953 </dt>
7954 <dd>
7955 <p>
7956         Character encoding the commit messages are converted to when
7957         running <em>git log</em> and friends.
7958 </p>
7959 </dd>
7960 <dt class="hdlist1">
7961 imap.folder
7962 </dt>
7963 <dd>
7964 <p>
7965         The folder to drop the mails into, which is typically the Drafts
7966         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
7967         "[Gmail]/Drafts". Required.
7968 </p>
7969 </dd>
7970 <dt class="hdlist1">
7971 imap.tunnel
7972 </dt>
7973 <dd>
7974 <p>
7975         Command used to set up a tunnel to the IMAP server through which
7976         commands will be piped instead of using a direct network connection
7977         to the server. Required when imap.host is not set.
7978 </p>
7979 </dd>
7980 <dt class="hdlist1">
7981 imap.host
7982 </dt>
7983 <dd>
7984 <p>
7985         A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
7986         connections and an <code>imaps://</code> prefix for secure connections.
7987         Ignored when imap.tunnel is set, but required otherwise.
7988 </p>
7989 </dd>
7990 <dt class="hdlist1">
7991 imap.user
7992 </dt>
7993 <dd>
7994 <p>
7995         The username to use when logging in to the server.
7996 </p>
7997 </dd>
7998 <dt class="hdlist1">
7999 imap.pass
8000 </dt>
8001 <dd>
8002 <p>
8003         The password to use when logging in to the server.
8004 </p>
8005 </dd>
8006 <dt class="hdlist1">
8007 imap.port
8008 </dt>
8009 <dd>
8010 <p>
8011         An integer port number to connect to on the server.
8012         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
8013         Ignored when imap.tunnel is set.
8014 </p>
8015 </dd>
8016 <dt class="hdlist1">
8017 imap.sslverify
8018 </dt>
8019 <dd>
8020 <p>
8021         A boolean to enable/disable verification of the server certificate
8022         used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
8023         imap.tunnel is set.
8024 </p>
8025 </dd>
8026 <dt class="hdlist1">
8027 imap.preformattedHTML
8028 </dt>
8029 <dd>
8030 <p>
8031         A boolean to enable/disable the use of html encoding when sending
8032         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
8033         and have a content type of text/html.  Ironically, enabling this
8034         option causes Thunderbird to send the patch as a plain/text,
8035         format=fixed email.  Default is <code>false</code>.
8036 </p>
8037 </dd>
8038 <dt class="hdlist1">
8039 imap.authMethod
8040 </dt>
8041 <dd>
8042 <p>
8043         Specify the authentication method for authenticating with the IMAP server.
8044         If Git was built with the NO_CURL option, or if your curl version is older
8045         than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
8046         option, the only supported method is <em>CRAM-MD5</em>. If this is not set
8047         then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
8048 </p>
8049 </dd>
8050 <dt class="hdlist1">
8051 include.path
8052 </dt>
8053 <dt class="hdlist1">
8054 includeIf.&lt;condition&gt;.path
8055 </dt>
8056 <dd>
8057 <p>
8058         Special variables to include other configuration files. See
8059         the "CONFIGURATION FILE" section in the main
8060         <a href="git-config.html">git-config(1)</a> documentation,
8061         specifically the "Includes" and "Conditional Includes" subsections.
8062 </p>
8063 </dd>
8064 <dt class="hdlist1">
8065 index.recordEndOfIndexEntries
8066 </dt>
8067 <dd>
8068 <p>
8069         Specifies whether the index file should include an "End Of Index
8070         Entry" section. This reduces index load time on multiprocessor
8071         machines but produces a message "ignoring EOIE extension" when
8072         reading the index using Git versions before 2.20. Defaults to
8073         <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
8074         otherwise.
8075 </p>
8076 </dd>
8077 <dt class="hdlist1">
8078 index.recordOffsetTable
8079 </dt>
8080 <dd>
8081 <p>
8082         Specifies whether the index file should include an "Index Entry
8083         Offset Table" section. This reduces index load time on
8084         multiprocessor machines but produces a message "ignoring IEOT
8085         extension" when reading the index using Git versions before 2.20.
8086         Defaults to <em>true</em> if index.threads has been explicitly enabled,
8087         <em>false</em> otherwise.
8088 </p>
8089 </dd>
8090 <dt class="hdlist1">
8091 index.sparse
8092 </dt>
8093 <dd>
8094 <p>
8095         When enabled, write the index using sparse-directory entries. This
8096         has no effect unless <code>core.sparseCheckout</code> and
8097         <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
8098 </p>
8099 </dd>
8100 <dt class="hdlist1">
8101 index.threads
8102 </dt>
8103 <dd>
8104 <p>
8105         Specifies the number of threads to spawn when loading the index.
8106         This is meant to reduce index load time on multiprocessor machines.
8107         Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
8108         CPUs and set the number of threads accordingly. Specifying 1 or
8109         <em>false</em> will disable multithreading. Defaults to <em>true</em>.
8110 </p>
8111 </dd>
8112 <dt class="hdlist1">
8113 index.version
8114 </dt>
8115 <dd>
8116 <p>
8117         Specify the version with which new index files should be
8118         initialized.  This does not affect existing repositories.
8119         If <code>feature.manyFiles</code> is enabled, then the default is 4.
8120 </p>
8121 </dd>
8122 <dt class="hdlist1">
8123 index.skipHash
8124 </dt>
8125 <dd>
8126 <p>
8127         When enabled, do not compute the trailing hash for the index file.
8128         This accelerates Git commands that manipulate the index, such as
8129         <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
8130         checksum, write a trailing set of bytes with value zero, indicating
8131         that the computation was skipped.
8132 </p>
8133 <div class="paragraph"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
8134 refuse to parse the index and Git clients older than 2.40.0 will report an
8135 error during <code>git fsck</code>.</p></div>
8136 </dd>
8137 </dl></div>
8138 <div class="dlist"><dl>
8139 <dt class="hdlist1">
8140 <code>init.templateDir</code>
8141 </dt>
8142 <dd>
8143 <p>
8144         Specify the directory from which templates will be copied. (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
8145 </p>
8146 </dd>
8147 <dt class="hdlist1">
8148 <code>init.defaultBranch</code>
8149 </dt>
8150 <dd>
8151 <p>
8152         Allows overriding the default branch name e.g. when initializing
8153         a new repository.
8154 </p>
8155 </dd>
8156 <dt class="hdlist1">
8157 instaweb.browser
8158 </dt>
8159 <dd>
8160 <p>
8161         Specify the program that will be used to browse your working
8162         repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
8163 </p>
8164 </dd>
8165 <dt class="hdlist1">
8166 instaweb.httpd
8167 </dt>
8168 <dd>
8169 <p>
8170         The HTTP daemon command-line to start gitweb on your working
8171         repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
8172 </p>
8173 </dd>
8174 <dt class="hdlist1">
8175 instaweb.local
8176 </dt>
8177 <dd>
8178 <p>
8179         If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
8180         be bound to the local IP (127.0.0.1).
8181 </p>
8182 </dd>
8183 <dt class="hdlist1">
8184 instaweb.modulePath
8185 </dt>
8186 <dd>
8187 <p>
8188         The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
8189         instead of /usr/lib/apache2/modules.  Only used if httpd
8190         is Apache.
8191 </p>
8192 </dd>
8193 <dt class="hdlist1">
8194 instaweb.port
8195 </dt>
8196 <dd>
8197 <p>
8198         The port number to bind the gitweb httpd to. See
8199         <a href="git-instaweb.html">git-instaweb(1)</a>.
8200 </p>
8201 </dd>
8202 <dt class="hdlist1">
8203 interactive.singleKey
8204 </dt>
8205 <dd>
8206 <p>
8207         When set to true, allow the user to provide one-letter input
8208         with a single key (i.e., without hitting the Enter key) in
8209         interactive commands.  This is currently used by the <code>--patch</code>
8210         mode of <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
8211         <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
8212         <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>.
8213 </p>
8214 </dd>
8215 <dt class="hdlist1">
8216 interactive.diffFilter
8217 </dt>
8218 <dd>
8219 <p>
8220         When an interactive command (such as <code>git add --patch</code>) shows
8221         a colorized diff, git will pipe the diff through the shell
8222         command defined by this configuration variable. The command may
8223         mark up the diff further for human consumption, provided that it
8224         retains a one-to-one correspondence with the lines in the
8225         original diff. Defaults to disabled (no filtering).
8226 </p>
8227 </dd>
8228 <dt class="hdlist1">
8229 log.abbrevCommit
8230 </dt>
8231 <dd>
8232 <p>
8233         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8234         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
8235         override this option with <code>--no-abbrev-commit</code>.
8236 </p>
8237 </dd>
8238 <dt class="hdlist1">
8239 log.date
8240 </dt>
8241 <dd>
8242 <p>
8243         Set the default date-time mode for the <em>log</em> command.
8244         Setting a value for log.date is similar to using <em>git log</em>'s
8245         <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.
8246 </p>
8247 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
8248 "foo" will be used for the date format. Otherwise, "default" will
8249 be used.</p></div>
8250 </dd>
8251 <dt class="hdlist1">
8252 log.decorate
8253 </dt>
8254 <dd>
8255 <p>
8256         Print out the ref names of any commits that are shown by the log
8257         command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
8258         <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
8259         specified, the full ref name (including prefix) will be printed.
8260         If <em>auto</em> is specified, then if the output is going to a terminal,
8261         the ref names are shown as if <em>short</em> were given, otherwise no ref
8262         names are shown. This is the same as the <code>--decorate</code> option
8263         of the <code>git log</code>.
8264 </p>
8265 </dd>
8266 <dt class="hdlist1">
8267 log.initialDecorationSet
8268 </dt>
8269 <dd>
8270 <p>
8271         By default, <code>git log</code> only shows decorations for certain known ref
8272         namespaces. If <em>all</em> is specified, then show all refs as
8273         decorations.
8274 </p>
8275 </dd>
8276 <dt class="hdlist1">
8277 log.excludeDecoration
8278 </dt>
8279 <dd>
8280 <p>
8281         Exclude the specified patterns from the log decorations. This is
8282         similar to the <code>--decorate-refs-exclude</code> command-line option, but
8283         the config option can be overridden by the <code>--decorate-refs</code>
8284         option.
8285 </p>
8286 </dd>
8287 <dt class="hdlist1">
8288 log.diffMerges
8289 </dt>
8290 <dd>
8291 <p>
8292         Set diff format to be used when <code>--diff-merges=on</code> is
8293         specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
8294         details. Defaults to <code>separate</code>.
8295 </p>
8296 </dd>
8297 <dt class="hdlist1">
8298 log.follow
8299 </dt>
8300 <dd>
8301 <p>
8302         If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
8303         a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
8304         i.e. it cannot be used to follow multiple files and does not work well
8305         on non-linear history.
8306 </p>
8307 </dd>
8308 <dt class="hdlist1">
8309 log.graphColors
8310 </dt>
8311 <dd>
8312 <p>
8313         A list of colors, separated by commas, that can be used to draw
8314         history lines in <code>git log --graph</code>.
8315 </p>
8316 </dd>
8317 <dt class="hdlist1">
8318 log.showRoot
8319 </dt>
8320 <dd>
8321 <p>
8322         If true, the initial commit will be shown as a big creation event.
8323         This is equivalent to a diff against an empty tree.
8324         Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
8325         normally hide the root commit will now show it. True by default.
8326 </p>
8327 </dd>
8328 <dt class="hdlist1">
8329 log.showSignature
8330 </dt>
8331 <dd>
8332 <p>
8333         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8334         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
8335 </p>
8336 </dd>
8337 <dt class="hdlist1">
8338 log.mailmap
8339 </dt>
8340 <dd>
8341 <p>
8342         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8343         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
8344         assume <code>--no-use-mailmap</code>. True by default.
8345 </p>
8346 </dd>
8347 <dt class="hdlist1">
8348 lsrefs.unborn
8349 </dt>
8350 <dd>
8351 <p>
8352         May be "advertise" (the default), "allow", or "ignore". If "advertise",
8353         the server will respond to the client sending "unborn" (as described in
8354         <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
8355         protocol v2 capability advertisement. "allow" is the same as
8356         "advertise" except that the server will not advertise support for this
8357         feature; this is useful for load-balanced servers that cannot be
8358         updated atomically (for example), since the administrator could
8359         configure "allow", then after a delay, configure "advertise".
8360 </p>
8361 </dd>
8362 <dt class="hdlist1">
8363 mailinfo.scissors
8364 </dt>
8365 <dd>
8366 <p>
8367         If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
8368         <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
8369         was provided on the command-line. When active, this feature
8370         removes everything from the message body before a scissors
8371         line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
8372 </p>
8373 </dd>
8374 <dt class="hdlist1">
8375 mailmap.file
8376 </dt>
8377 <dd>
8378 <p>
8379         The location of an augmenting mailmap file. The default
8380         mailmap, located in the root of the repository, is loaded
8381         first, then the mailmap file pointed to by this variable.
8382         The location of the mailmap file may be in a repository
8383         subdirectory, or somewhere outside of the repository itself.
8384         See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
8385 </p>
8386 </dd>
8387 <dt class="hdlist1">
8388 mailmap.blob
8389 </dt>
8390 <dd>
8391 <p>
8392         Like <code>mailmap.file</code>, but consider the value as a reference to a
8393         blob in the repository. If both <code>mailmap.file</code> and
8394         <code>mailmap.blob</code> are given, both are parsed, with entries from
8395         <code>mailmap.file</code> taking precedence. In a bare repository, this
8396         defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8397         defaults to empty.
8398 </p>
8399 </dd>
8400 <dt class="hdlist1">
8401 maintenance.auto
8402 </dt>
8403 <dd>
8404 <p>
8405         This boolean config option controls whether some commands run
8406         <code>git maintenance run --auto</code> after doing their normal work. Defaults
8407         to true.
8408 </p>
8409 </dd>
8410 <dt class="hdlist1">
8411 maintenance.strategy
8412 </dt>
8413 <dd>
8414 <p>
8415         This string config option provides a way to specify one of a few
8416         recommended schedules for background maintenance. This only affects
8417         which tasks are run during <code>git maintenance run --schedule=X</code>
8418         commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
8419         Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
8420         then that value is used instead of the one provided by
8421         <code>maintenance.strategy</code>. The possible strategy strings are:
8422 </p>
8423 <div class="ulist"><ul>
8424 <li>
8425 <p>
8426 <code>none</code>: This default setting implies no tasks are run at any schedule.
8427 </p>
8428 </li>
8429 <li>
8430 <p>
8431 <code>incremental</code>: This setting optimizes for performing small maintenance
8432   activities that do not delete any data. This does not schedule the <code>gc</code>
8433   task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8434   <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8435   task weekly.
8436 </p>
8437 </li>
8438 </ul></div>
8439 </dd>
8440 <dt class="hdlist1">
8441 maintenance.&lt;task&gt;.enabled
8442 </dt>
8443 <dd>
8444 <p>
8445         This boolean config option controls whether the maintenance task
8446         with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
8447         <code>git maintenance run</code>. These config values are ignored if a
8448         <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8449         is true.
8450 </p>
8451 </dd>
8452 <dt class="hdlist1">
8453 maintenance.&lt;task&gt;.schedule
8454 </dt>
8455 <dd>
8456 <p>
8457         This config option controls whether or not the given <code>&lt;task&gt;</code> runs
8458         during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
8459         value must be one of "hourly", "daily", or "weekly".
8460 </p>
8461 </dd>
8462 <dt class="hdlist1">
8463 maintenance.commit-graph.auto
8464 </dt>
8465 <dd>
8466 <p>
8467         This integer config option controls how often the <code>commit-graph</code> task
8468         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8469         the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8470         negative value will force the task to run every time. Otherwise, a
8471         positive value implies the command should run when the number of
8472         reachable commits that are not in the commit-graph file is at least
8473         the value of <code>maintenance.commit-graph.auto</code>. The default value is
8474         100.
8475 </p>
8476 </dd>
8477 <dt class="hdlist1">
8478 maintenance.loose-objects.auto
8479 </dt>
8480 <dd>
8481 <p>
8482         This integer config option controls how often the <code>loose-objects</code> task
8483         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8484         the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8485         negative value will force the task to run every time. Otherwise, a
8486         positive value implies the command should run when the number of
8487         loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8488         The default value is 100.
8489 </p>
8490 </dd>
8491 <dt class="hdlist1">
8492 maintenance.incremental-repack.auto
8493 </dt>
8494 <dd>
8495 <p>
8496         This integer config option controls how often the <code>incremental-repack</code>
8497         task should be run as part of <code>git maintenance run --auto</code>. If zero,
8498         then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8499         option. A negative value will force the task to run every time.
8500         Otherwise, a positive value implies the command should run when the
8501         number of pack-files not in the multi-pack-index is at least the value
8502         of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8503 </p>
8504 </dd>
8505 <dt class="hdlist1">
8506 man.viewer
8507 </dt>
8508 <dd>
8509 <p>
8510         Specify the programs that may be used to display help in the
8511         <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8512 </p>
8513 </dd>
8514 <dt class="hdlist1">
8515 man.&lt;tool&gt;.cmd
8516 </dt>
8517 <dd>
8518 <p>
8519         Specify the command to invoke the specified man viewer. The
8520         specified command is evaluated in shell with the man page
8521         passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)
8522 </p>
8523 </dd>
8524 <dt class="hdlist1">
8525 man.&lt;tool&gt;.path
8526 </dt>
8527 <dd>
8528 <p>
8529         Override the path for the given tool that may be used to
8530         display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8531 </p>
8532 </dd>
8533 <dt class="hdlist1">
8534 merge.conflictStyle
8535 </dt>
8536 <dd>
8537 <p>
8538         Specify the style in which conflicted hunks are written out to
8539         working tree files upon merge.  The default is "merge", which
8540         shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
8541         a <code>=======</code> marker, changes made by the other side, and then
8542         a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
8543         marker and the original text before the <code>=======</code> marker.  The
8544         "merge" style tends to produce smaller conflict regions than diff3,
8545         both because of the exclusion of the original text, and because
8546         when a subset of lines match on the two sides, they are just pulled
8547         out of the conflict region.  Another alternate style, "zdiff3", is
8548         similar to diff3 but removes matching lines on the two sides from
8549         the conflict region when those matching lines appear near either
8550         the beginning or end of a conflict region.
8551 </p>
8552 </dd>
8553 <dt class="hdlist1">
8554 merge.defaultToUpstream
8555 </dt>
8556 <dd>
8557 <p>
8558         If merge is called without any commit argument, merge the upstream
8559         branches configured for the current branch by using their last
8560         observed values stored in their remote-tracking branches.
8561         The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
8562         branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
8563         are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
8564         to their corresponding remote-tracking branches, and the tips of
8565         these tracking branches are merged. Defaults to true.
8566 </p>
8567 </dd>
8568 <dt class="hdlist1">
8569 merge.ff
8570 </dt>
8571 <dd>
8572 <p>
8573         By default, Git does not create an extra merge commit when merging
8574         a commit that is a descendant of the current commit. Instead, the
8575         tip of the current branch is fast-forwarded. When set to <code>false</code>,
8576         this variable tells Git to create an extra merge commit in such
8577         a case (equivalent to giving the <code>--no-ff</code> option from the command
8578         line). When set to <code>only</code>, only such fast-forward merges are
8579         allowed (equivalent to giving the <code>--ff-only</code> option from the
8580         command line).
8581 </p>
8582 </dd>
8583 <dt class="hdlist1">
8584 merge.verifySignatures
8585 </dt>
8586 <dd>
8587 <p>
8588         If true, this is equivalent to the --verify-signatures command
8589         line option. See <a href="git-merge.html">git-merge(1)</a> for details.
8590 </p>
8591 </dd>
8592 <dt class="hdlist1">
8593 merge.branchdesc
8594 </dt>
8595 <dd>
8596 <p>
8597         In addition to branch names, populate the log message with
8598         the branch description text associated with them.  Defaults
8599         to false.
8600 </p>
8601 </dd>
8602 <dt class="hdlist1">
8603 merge.log
8604 </dt>
8605 <dd>
8606 <p>
8607         In addition to branch names, populate the log message with at
8608         most the specified number of one-line descriptions from the
8609         actual commits that are being merged.  Defaults to false, and
8610         true is a synonym for 20.
8611 </p>
8612 </dd>
8613 <dt class="hdlist1">
8614 merge.suppressDest
8615 </dt>
8616 <dd>
8617 <p>
8618         By adding a glob that matches the names of integration
8619         branches to this multi-valued configuration variable, the
8620         default merge message computed for merges into these
8621         integration branches will omit "into &lt;branch name&gt;" from
8622         its title.
8623 </p>
8624 <div class="paragraph"><p>An element with an empty value can be used to clear the list
8625 of globs accumulated from previous configuration entries.
8626 When there is no <code>merge.suppressDest</code> variable defined, the
8627 default value of <code>master</code> is used for backward compatibility.</p></div>
8628 </dd>
8629 <dt class="hdlist1">
8630 merge.renameLimit
8631 </dt>
8632 <dd>
8633 <p>
8634         The number of files to consider in the exhaustive portion of
8635         rename detection during a merge.  If not specified, defaults
8636         to the value of diff.renameLimit.  If neither
8637         merge.renameLimit nor diff.renameLimit are specified,
8638         currently defaults to 7000.  This setting has no effect if
8639         rename detection is turned off.
8640 </p>
8641 </dd>
8642 <dt class="hdlist1">
8643 merge.renames
8644 </dt>
8645 <dd>
8646 <p>
8647         Whether Git detects renames.  If set to "false", rename detection
8648         is disabled. If set to "true", basic rename detection is enabled.
8649         Defaults to the value of diff.renames.
8650 </p>
8651 </dd>
8652 <dt class="hdlist1">
8653 merge.directoryRenames
8654 </dt>
8655 <dd>
8656 <p>
8657         Whether Git detects directory renames, affecting what happens at
8658         merge time to new files added to a directory on one side of
8659         history when that directory was renamed on the other side of
8660         history.  If merge.directoryRenames is set to "false", directory
8661         rename detection is disabled, meaning that such new files will be
8662         left behind in the old directory.  If set to "true", directory
8663         rename detection is enabled, meaning that such new files will be
8664         moved into the new directory.  If set to "conflict", a conflict
8665         will be reported for such paths.  If merge.renames is false,
8666         merge.directoryRenames is ignored and treated as false.  Defaults
8667         to "conflict".
8668 </p>
8669 </dd>
8670 <dt class="hdlist1">
8671 merge.renormalize
8672 </dt>
8673 <dd>
8674 <p>
8675         Tell Git that canonical representation of files in the
8676         repository has changed over time (e.g. earlier commits record
8677         text files with CRLF line endings, but recent ones use LF line
8678         endings).  In such a repository, Git can convert the data
8679         recorded in commits to a canonical form before performing a
8680         merge to reduce unnecessary conflicts.  For more information,
8681         see section "Merging branches with differing checkin/checkout
8682         attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
8683 </p>
8684 </dd>
8685 <dt class="hdlist1">
8686 merge.stat
8687 </dt>
8688 <dd>
8689 <p>
8690         Whether to print the diffstat between ORIG_HEAD and the merge result
8691         at the end of the merge.  True by default.
8692 </p>
8693 </dd>
8694 <dt class="hdlist1">
8695 merge.autoStash
8696 </dt>
8697 <dd>
8698 <p>
8699         When set to true, automatically create a temporary stash entry
8700         before the operation begins, and apply it after the operation
8701         ends.  This means that you can run merge on a dirty worktree.
8702         However, use with care: the final stash application after a
8703         successful merge might result in non-trivial conflicts.
8704         This option can be overridden by the <code>--no-autostash</code> and
8705         <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
8706         Defaults to false.
8707 </p>
8708 </dd>
8709 <dt class="hdlist1">
8710 merge.tool
8711 </dt>
8712 <dd>
8713 <p>
8714         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
8715         The list below shows the valid built-in values.
8716         Any other value is treated as a custom merge tool and requires
8717         that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
8718 </p>
8719 </dd>
8720 <dt class="hdlist1">
8721 merge.guitool
8722 </dt>
8723 <dd>
8724 <p>
8725         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
8726         -g/--gui flag is specified. The list below shows the valid built-in values.
8727         Any other value is treated as a custom merge tool and requires that a
8728         corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.
8729 </p>
8730 <div class="dlist"><dl>
8731 <dt class="hdlist1">
8732 <code>araxis</code>
8733 </dt>
8734 <dd>
8735 <p>
8736 Use Araxis Merge (requires a graphical session)
8737 </p>
8738 </dd>
8739 <dt class="hdlist1">
8740 <code>bc</code>
8741 </dt>
8742 <dd>
8743 <p>
8744 Use Beyond Compare (requires a graphical session)
8745 </p>
8746 </dd>
8747 <dt class="hdlist1">
8748 <code>bc3</code>
8749 </dt>
8750 <dd>
8751 <p>
8752 Use Beyond Compare (requires a graphical session)
8753 </p>
8754 </dd>
8755 <dt class="hdlist1">
8756 <code>bc4</code>
8757 </dt>
8758 <dd>
8759 <p>
8760 Use Beyond Compare (requires a graphical session)
8761 </p>
8762 </dd>
8763 <dt class="hdlist1">
8764 <code>codecompare</code>
8765 </dt>
8766 <dd>
8767 <p>
8768 Use Code Compare (requires a graphical session)
8769 </p>
8770 </dd>
8771 <dt class="hdlist1">
8772 <code>deltawalker</code>
8773 </dt>
8774 <dd>
8775 <p>
8776 Use DeltaWalker (requires a graphical session)
8777 </p>
8778 </dd>
8779 <dt class="hdlist1">
8780 <code>diffmerge</code>
8781 </dt>
8782 <dd>
8783 <p>
8784 Use DiffMerge (requires a graphical session)
8785 </p>
8786 </dd>
8787 <dt class="hdlist1">
8788 <code>diffuse</code>
8789 </dt>
8790 <dd>
8791 <p>
8792 Use Diffuse (requires a graphical session)
8793 </p>
8794 </dd>
8795 <dt class="hdlist1">
8796 <code>ecmerge</code>
8797 </dt>
8798 <dd>
8799 <p>
8800 Use ECMerge (requires a graphical session)
8801 </p>
8802 </dd>
8803 <dt class="hdlist1">
8804 <code>emerge</code>
8805 </dt>
8806 <dd>
8807 <p>
8808 Use Emacs' Emerge
8809 </p>
8810 </dd>
8811 <dt class="hdlist1">
8812 <code>examdiff</code>
8813 </dt>
8814 <dd>
8815 <p>
8816 Use ExamDiff Pro (requires a graphical session)
8817 </p>
8818 </dd>
8819 <dt class="hdlist1">
8820 <code>guiffy</code>
8821 </dt>
8822 <dd>
8823 <p>
8824 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
8825 </p>
8826 </dd>
8827 <dt class="hdlist1">
8828 <code>gvimdiff</code>
8829 </dt>
8830 <dd>
8831 <p>
8832 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8833 </p>
8834 </dd>
8835 <dt class="hdlist1">
8836 <code>gvimdiff1</code>
8837 </dt>
8838 <dd>
8839 <p>
8840 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
8841 </p>
8842 </dd>
8843 <dt class="hdlist1">
8844 <code>gvimdiff2</code>
8845 </dt>
8846 <dd>
8847 <p>
8848 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
8849 </p>
8850 </dd>
8851 <dt class="hdlist1">
8852 <code>gvimdiff3</code>
8853 </dt>
8854 <dd>
8855 <p>
8856 Use gVim (requires a graphical session) where only the MERGED file is shown
8857 </p>
8858 </dd>
8859 <dt class="hdlist1">
8860 <code>kdiff3</code>
8861 </dt>
8862 <dd>
8863 <p>
8864 Use KDiff3 (requires a graphical session)
8865 </p>
8866 </dd>
8867 <dt class="hdlist1">
8868 <code>meld</code>
8869 </dt>
8870 <dd>
8871 <p>
8872 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
8873 </p>
8874 </dd>
8875 <dt class="hdlist1">
8876 <code>nvimdiff</code>
8877 </dt>
8878 <dd>
8879 <p>
8880 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8881 </p>
8882 </dd>
8883 <dt class="hdlist1">
8884 <code>nvimdiff1</code>
8885 </dt>
8886 <dd>
8887 <p>
8888 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
8889 </p>
8890 </dd>
8891 <dt class="hdlist1">
8892 <code>nvimdiff2</code>
8893 </dt>
8894 <dd>
8895 <p>
8896 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8897 </p>
8898 </dd>
8899 <dt class="hdlist1">
8900 <code>nvimdiff3</code>
8901 </dt>
8902 <dd>
8903 <p>
8904 Use Neovim where only the MERGED file is shown
8905 </p>
8906 </dd>
8907 <dt class="hdlist1">
8908 <code>opendiff</code>
8909 </dt>
8910 <dd>
8911 <p>
8912 Use FileMerge (requires a graphical session)
8913 </p>
8914 </dd>
8915 <dt class="hdlist1">
8916 <code>p4merge</code>
8917 </dt>
8918 <dd>
8919 <p>
8920 Use HelixCore P4Merge (requires a graphical session)
8921 </p>
8922 </dd>
8923 <dt class="hdlist1">
8924 <code>smerge</code>
8925 </dt>
8926 <dd>
8927 <p>
8928 Use Sublime Merge (requires a graphical session)
8929 </p>
8930 </dd>
8931 <dt class="hdlist1">
8932 <code>tkdiff</code>
8933 </dt>
8934 <dd>
8935 <p>
8936 Use TkDiff (requires a graphical session)
8937 </p>
8938 </dd>
8939 <dt class="hdlist1">
8940 <code>tortoisemerge</code>
8941 </dt>
8942 <dd>
8943 <p>
8944 Use TortoiseMerge (requires a graphical session)
8945 </p>
8946 </dd>
8947 <dt class="hdlist1">
8948 <code>vimdiff</code>
8949 </dt>
8950 <dd>
8951 <p>
8952 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8953 </p>
8954 </dd>
8955 <dt class="hdlist1">
8956 <code>vimdiff1</code>
8957 </dt>
8958 <dd>
8959 <p>
8960 Use Vim with a 2 panes layout (LOCAL and REMOTE)
8961 </p>
8962 </dd>
8963 <dt class="hdlist1">
8964 <code>vimdiff2</code>
8965 </dt>
8966 <dd>
8967 <p>
8968 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8969 </p>
8970 </dd>
8971 <dt class="hdlist1">
8972 <code>vimdiff3</code>
8973 </dt>
8974 <dd>
8975 <p>
8976 Use Vim where only the MERGED file is shown
8977 </p>
8978 </dd>
8979 <dt class="hdlist1">
8980 <code>winmerge</code>
8981 </dt>
8982 <dd>
8983 <p>
8984 Use WinMerge (requires a graphical session)
8985 </p>
8986 </dd>
8987 <dt class="hdlist1">
8988 <code>xxdiff</code>
8989 </dt>
8990 <dd>
8991 <p>
8992 Use xxdiff (requires a graphical session)
8993 </p>
8994 </dd>
8995 </dl></div>
8996 </dd>
8997 <dt class="hdlist1">
8998 merge.verbosity
8999 </dt>
9000 <dd>
9001 <p>
9002         Controls the amount of output shown by the recursive merge
9003         strategy.  Level 0 outputs nothing except a final error
9004         message if conflicts were detected. Level 1 outputs only
9005         conflicts, 2 outputs conflicts and file changes.  Level 5 and
9006         above outputs debugging information.  The default is level 2.
9007         Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
9008 </p>
9009 </dd>
9010 <dt class="hdlist1">
9011 merge.&lt;driver&gt;.name
9012 </dt>
9013 <dd>
9014 <p>
9015         Defines a human-readable name for a custom low-level
9016         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
9017 </p>
9018 </dd>
9019 <dt class="hdlist1">
9020 merge.&lt;driver&gt;.driver
9021 </dt>
9022 <dd>
9023 <p>
9024         Defines the command that implements a custom low-level
9025         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
9026 </p>
9027 </dd>
9028 <dt class="hdlist1">
9029 merge.&lt;driver&gt;.recursive
9030 </dt>
9031 <dd>
9032 <p>
9033         Names a low-level merge driver to be used when
9034         performing an internal merge between common ancestors.
9035         See <a href="gitattributes.html">gitattributes(5)</a> for details.
9036 </p>
9037 </dd>
9038 <dt class="hdlist1">
9039 mergetool.&lt;tool&gt;.path
9040 </dt>
9041 <dd>
9042 <p>
9043         Override the path for the given tool.  This is useful in case
9044         your tool is not in the PATH.
9045 </p>
9046 </dd>
9047 <dt class="hdlist1">
9048 mergetool.&lt;tool&gt;.cmd
9049 </dt>
9050 <dd>
9051 <p>
9052         Specify the command to invoke the specified merge tool.  The
9053         specified command is evaluated in shell with the following
9054         variables available: <em>BASE</em> is the name of a temporary file
9055         containing the common base of the files to be merged, if available;
9056         <em>LOCAL</em> is the name of a temporary file containing the contents of
9057         the file on the current branch; <em>REMOTE</em> is the name of a temporary
9058         file containing the contents of the file from the branch being
9059         merged; <em>MERGED</em> contains the name of the file to which the merge
9060         tool should write the results of a successful merge.
9061 </p>
9062 </dd>
9063 <dt class="hdlist1">
9064 mergetool.&lt;tool&gt;.hideResolved
9065 </dt>
9066 <dd>
9067 <p>
9068         Allows the user to override the global <code>mergetool.hideResolved</code> value
9069         for a specific tool. See <code>mergetool.hideResolved</code> for the full
9070         description.
9071 </p>
9072 </dd>
9073 <dt class="hdlist1">
9074 mergetool.&lt;tool&gt;.trustExitCode
9075 </dt>
9076 <dd>
9077 <p>
9078         For a custom merge command, specify whether the exit code of
9079         the merge command can be used to determine whether the merge was
9080         successful.  If this is not set to true then the merge target file
9081         timestamp is checked, and the merge is assumed to have been successful
9082         if the file has been updated; otherwise, the user is prompted to
9083         indicate the success of the merge.
9084 </p>
9085 </dd>
9086 <dt class="hdlist1">
9087 mergetool.meld.hasOutput
9088 </dt>
9089 <dd>
9090 <p>
9091         Older versions of <code>meld</code> do not support the <code>--output</code> option.
9092         Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
9093         by inspecting the output of <code>meld --help</code>.  Configuring
9094         <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
9095         use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
9096         to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
9097         and <code>false</code> avoids using <code>--output</code>.
9098 </p>
9099 </dd>
9100 <dt class="hdlist1">
9101 mergetool.meld.useAutoMerge
9102 </dt>
9103 <dd>
9104 <p>
9105         When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
9106         parts automatically, highlight the conflicting parts, and wait for
9107         user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
9108         Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
9109         Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
9110         is supported and will only use <code>--auto-merge</code> when available.  A
9111         value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
9112         default value.
9113 </p>
9114 </dd>
9115 <dt class="hdlist1">
9116 mergetool.&lt;vimdiff variant&gt;.layout
9117 </dt>
9118 <dd>
9119 <p>
9120         Configure the split window layout for vimdiff&#8217;s <code>&lt;variant&gt;</code>, which is any of <code>vimdiff</code>,
9121         <code>nvimdiff</code>, <code>gvimdiff</code>.
9122         Upon launching <code>git mergetool</code> with <code>--tool=&lt;variant&gt;</code> (or without <code>--tool</code>
9123         if <code>merge.tool</code> is configured as <code>&lt;variant&gt;</code>), Git will consult
9124         <code>mergetool.&lt;variant&gt;.layout</code> to determine the tool&#8217;s layout. If the
9125         variant-specific configuration is not available, <code>vimdiff</code>'s is used as
9126         fallback.  If that too is not available, a default layout with 4 windows
9127         will be used.  To configure the layout, see the <code>BACKEND SPECIFIC HINTS</code>
9128         section in <a href="git-mergetool.html">git-mergetool(1)</a>.
9129 </p>
9130 </dd>
9131 <dt class="hdlist1">
9132 mergetool.hideResolved
9133 </dt>
9134 <dd>
9135 <p>
9136         During a merge, Git will automatically resolve as many conflicts as
9137         possible and write the <em>MERGED</em> file containing conflict markers around
9138         any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
9139         represent the versions of the file from before Git&#8217;s conflict
9140         resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
9141         that only the unresolved conflicts are presented to the merge tool. Can
9142         be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
9143         configuration variable. Defaults to <code>false</code>.
9144 </p>
9145 </dd>
9146 <dt class="hdlist1">
9147 mergetool.keepBackup
9148 </dt>
9149 <dd>
9150 <p>
9151         After performing a merge, the original file with conflict markers
9152         can be saved as a file with a <code>.orig</code> extension.  If this variable
9153         is set to <code>false</code> then this file is not preserved.  Defaults to
9154         <code>true</code> (i.e. keep the backup files).
9155 </p>
9156 </dd>
9157 <dt class="hdlist1">
9158 mergetool.keepTemporaries
9159 </dt>
9160 <dd>
9161 <p>
9162         When invoking a custom merge tool, Git uses a set of temporary
9163         files to pass to the tool. If the tool returns an error and this
9164         variable is set to <code>true</code>, then these temporary files will be
9165         preserved; otherwise, they will be removed after the tool has
9166         exited. Defaults to <code>false</code>.
9167 </p>
9168 </dd>
9169 <dt class="hdlist1">
9170 mergetool.writeToTemp
9171 </dt>
9172 <dd>
9173 <p>
9174         Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
9175         conflicting files in the worktree by default.  Git will attempt
9176         to use a temporary directory for these files when set <code>true</code>.
9177         Defaults to <code>false</code>.
9178 </p>
9179 </dd>
9180 <dt class="hdlist1">
9181 mergetool.prompt
9182 </dt>
9183 <dd>
9184 <p>
9185         Prompt before each invocation of the merge resolution program.
9186 </p>
9187 </dd>
9188 <dt class="hdlist1">
9189 mergetool.guiDefault
9190 </dt>
9191 <dd>
9192 <p>
9193         Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
9194         specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
9195         or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
9196         variable value. The default is <code>false</code>, where the <code>--gui</code> argument
9197         must be provided explicitly for the <code>merge.guitool</code> to be used.
9198 </p>
9199 </dd>
9200 <dt class="hdlist1">
9201 notes.mergeStrategy
9202 </dt>
9203 <dd>
9204 <p>
9205         Which merge strategy to choose by default when resolving notes
9206         conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
9207         <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
9208         section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
9209 </p>
9210 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
9211 <a href="git-notes.html">git-notes(1)</a>.</p></div>
9212 </dd>
9213 <dt class="hdlist1">
9214 notes.&lt;name&gt;.mergeStrategy
9215 </dt>
9216 <dd>
9217 <p>
9218         Which merge strategy to choose when doing a notes merge into
9219         refs/notes/&lt;name&gt;.  This overrides the more general
9220         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
9221         <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
9222 </p>
9223 </dd>
9224 <dt class="hdlist1">
9225 notes.displayRef
9226 </dt>
9227 <dd>
9228 <p>
9229         Which ref (or refs, if a glob or specified more than once), in
9230         addition to the default set by <code>core.notesRef</code> or
9231         <code>GIT_NOTES_REF</code>, to read notes from when showing commit
9232         messages with the <em>git log</em> family of commands.
9233 </p>
9234 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
9235 environment variable, which must be a colon separated list of refs or
9236 globs.</p></div>
9237 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
9238 but a glob that does not match any refs is silently ignored.</p></div>
9239 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
9240 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
9241 those commands.</p></div>
9242 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
9243 GIT_NOTES_REF) is also implicitly added to the list of refs to be
9244 displayed.</p></div>
9245 </dd>
9246 <dt class="hdlist1">
9247 notes.rewrite.&lt;command&gt;
9248 </dt>
9249 <dd>
9250 <p>
9251         When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
9252         <code>rebase</code>), if this variable is <code>false</code>, git will not copy
9253         notes from the original to the rewritten commit.  Defaults to
9254         <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.
9255 </p>
9256 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
9257 environment variable, which must be a colon separated list of refs or
9258 globs.</p></div>
9259 </dd>
9260 <dt class="hdlist1">
9261 notes.rewriteMode
9262 </dt>
9263 <dd>
9264 <p>
9265         When copying notes during a rewrite (see the
9266         "notes.rewrite.&lt;command&gt;" option), determines what to do if
9267         the target commit already has a note.  Must be one of
9268         <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
9269         Defaults to <code>concatenate</code>.
9270 </p>
9271 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
9272 environment variable.</p></div>
9273 </dd>
9274 <dt class="hdlist1">
9275 notes.rewriteRef
9276 </dt>
9277 <dd>
9278 <p>
9279         When copying notes during a rewrite, specifies the (fully
9280         qualified) ref whose notes should be copied.  May be a glob,
9281         in which case notes in all matching refs will be copied.  You
9282         may also specify this configuration several times.
9283 </p>
9284 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
9285 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
9286 rewriting for the default commit notes.</p></div>
9287 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
9288 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
9289 </dd>
9290 <dt class="hdlist1">
9291 pack.window
9292 </dt>
9293 <dd>
9294 <p>
9295         The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9296         window size is given on the command line. Defaults to 10.
9297 </p>
9298 </dd>
9299 <dt class="hdlist1">
9300 pack.depth
9301 </dt>
9302 <dd>
9303 <p>
9304         The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9305         maximum depth is given on the command line. Defaults to 50.
9306         Maximum value is 4095.
9307 </p>
9308 </dd>
9309 <dt class="hdlist1">
9310 pack.windowMemory
9311 </dt>
9312 <dd>
9313 <p>
9314         The maximum size of memory that is consumed by each thread
9315         in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
9316         no limit is given on the command line.  The value can be
9317         suffixed with "k", "m", or "g".  When left unconfigured (or
9318         set explicitly to 0), there will be no limit.
9319 </p>
9320 </dd>
9321 <dt class="hdlist1">
9322 pack.compression
9323 </dt>
9324 <dd>
9325 <p>
9326         An integer -1..9, indicating the compression level for objects
9327         in a pack file. -1 is the zlib default. 0 means no
9328         compression, and 1..9 are various speed/size tradeoffs, 9 being
9329         slowest.  If not set,  defaults to core.compression.  If that is
9330         not set,  defaults to -1, the zlib default, which is "a default
9331         compromise between speed and compression (currently equivalent
9332         to level 6)."
9333 </p>
9334 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
9335 all existing objects. You can force recompression by passing the -F option
9336 to <a href="git-repack.html">git-repack(1)</a>.</p></div>
9337 </dd>
9338 <dt class="hdlist1">
9339 pack.allowPackReuse
9340 </dt>
9341 <dd>
9342 <p>
9343         When true or "single", and when reachability bitmaps are
9344         enabled, pack-objects will try to send parts of the bitmapped
9345         packfile verbatim. When "multi", and when a multi-pack
9346         reachability bitmap is available, pack-objects will try to send
9347         parts of all packs in the MIDX.
9348 </p>
9349 <div class="paragraph"><p>If only a single pack bitmap is available, and <code>pack.allowPackReuse</code>
9350 is set to "multi", reuse parts of just the bitmapped packfile. This
9351 can reduce memory and CPU usage to serve fetches, but might result in
9352 sending a slightly larger pack. Defaults to true.</p></div>
9353 </dd>
9354 <dt class="hdlist1">
9355 pack.island
9356 </dt>
9357 <dd>
9358 <p>
9359         An extended regular expression configuring a set of delta
9360         islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
9361         for details.
9362 </p>
9363 </dd>
9364 <dt class="hdlist1">
9365 pack.islandCore
9366 </dt>
9367 <dd>
9368 <p>
9369         Specify an island name which gets to have its objects be
9370         packed first. This creates a kind of pseudo-pack at the front
9371         of one pack, so that the objects from the specified island are
9372         hopefully faster to copy into any pack that should be served
9373         to a user requesting these objects. In practice this means
9374         that the island specified should likely correspond to what is
9375         the most commonly cloned in the repo. See also "DELTA ISLANDS"
9376         in <a href="git-pack-objects.html">git-pack-objects(1)</a>.
9377 </p>
9378 </dd>
9379 <dt class="hdlist1">
9380 pack.deltaCacheSize
9381 </dt>
9382 <dd>
9383 <p>
9384         The maximum memory in bytes used for caching deltas in
9385         <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
9386         This cache is used to speed up the writing object phase by not
9387         having to recompute the final delta result once the best match
9388         for all objects is found.  Repacking large repositories on machines
9389         which are tight with memory might be badly impacted by this though,
9390         especially if this cache pushes the system into swapping.
9391         A value of 0 means no limit. The smallest size of 1 byte may be
9392         used to virtually disable this cache. Defaults to 256 MiB.
9393 </p>
9394 </dd>
9395 <dt class="hdlist1">
9396 pack.deltaCacheLimit
9397 </dt>
9398 <dd>
9399 <p>
9400         The maximum size of a delta, that is cached in
9401         <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
9402         writing object phase by not having to recompute the final delta
9403         result once the best match for all objects is found.
9404         Defaults to 1000. Maximum value is 65535.
9405 </p>
9406 </dd>
9407 <dt class="hdlist1">
9408 pack.threads
9409 </dt>
9410 <dd>
9411 <p>
9412         Specifies the number of threads to spawn when searching for best
9413         delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
9414         be compiled with pthreads otherwise this option is ignored with a
9415         warning. This is meant to reduce packing time on multiprocessor
9416         machines. The required amount of memory for the delta search window
9417         is however multiplied by the number of threads.
9418         Specifying 0 will cause Git to auto-detect the number of CPUs
9419         and set the number of threads accordingly.
9420 </p>
9421 </dd>
9422 <dt class="hdlist1">
9423 pack.indexVersion
9424 </dt>
9425 <dd>
9426 <p>
9427         Specify the default pack index version.  Valid values are 1 for
9428         legacy pack index used by Git versions prior to 1.5.2, and 2 for
9429         the new pack index with capabilities for packs larger than 4 GB
9430         as well as proper protection against the repacking of corrupted
9431         packs.  Version 2 is the default.  Note that version 2 is enforced
9432         and this config option is ignored whenever the corresponding pack is
9433         larger than 2 GB.
9434 </p>
9435 <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9436 cloning or fetching over a non-native protocol (e.g. "http")
9437 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9438 other side may give you a repository that cannot be accessed with your
9439 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9440 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
9441 the <code>*.idx</code> file.</p></div>
9442 </dd>
9443 <dt class="hdlist1">
9444 pack.packSizeLimit
9445 </dt>
9446 <dd>
9447 <p>
9448         The maximum size of a pack.  This setting only affects
9449         packing to a file when repacking, i.e. the git:// protocol
9450         is unaffected.  It can be overridden by the <code>--max-pack-size</code>
9451         option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
9452         in the creation of multiple packfiles.
9453 </p>
9454 <div class="paragraph"><p>Note that this option is rarely useful, and may result in a larger total
9455 on-disk size (because Git will not store deltas between packs) and
9456 worse runtime performance (object lookup within multiple packs is
9457 slower than a single pack, and optimizations like reachability bitmaps
9458 cannot cope with multiple packs).</p></div>
9459 <div class="paragraph"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9460 filesystem does not support large files), this option may help. But if
9461 your goal is to transmit a packfile over a medium that supports limited
9462 sizes (e.g., removable media that cannot store the whole repository),
9463 you are likely better off creating a single large packfile and splitting
9464 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9465 <div class="paragraph"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9466 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9467 </dd>
9468 <dt class="hdlist1">
9469 pack.useBitmaps
9470 </dt>
9471 <dd>
9472 <p>
9473         When true, git will use pack bitmaps (if available) when packing
9474         to stdout (e.g., during the server side of a fetch). Defaults to
9475         true. You should not generally need to turn this off unless
9476         you are debugging pack bitmaps.
9477 </p>
9478 </dd>
9479 <dt class="hdlist1">
9480 pack.useBitmapBoundaryTraversal
9481 </dt>
9482 <dd>
9483 <p>
9484         When true, Git will use an experimental algorithm for computing
9485         reachability queries with bitmaps. Instead of building up
9486         complete bitmaps for all of the negated tips and then OR-ing
9487         them together, consider negated tips with existing bitmaps as
9488         additive (i.e. OR-ing them into the result if they exist,
9489         ignoring them otherwise), and build up a bitmap at the boundary
9490         instead.
9491 </p>
9492 <div class="paragraph"><p>When using this algorithm, Git may include too many objects as a result
9493 of not opening up trees belonging to certain UNINTERESTING commits. This
9494 inexactness matches the non-bitmap traversal algorithm.</p></div>
9495 <div class="paragraph"><p>In many cases, this can provide a speed-up over the exact algorithm,
9496 particularly when there is poor bitmap coverage of the negated side of
9497 the query.</p></div>
9498 </dd>
9499 <dt class="hdlist1">
9500 pack.useSparse
9501 </dt>
9502 <dd>
9503 <p>
9504         When true, git will default to using the <em>--sparse</em> option in
9505         <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9506         algorithm only walks trees that appear in paths that introduce new
9507         objects. This can have significant performance benefits when
9508         computing a pack to send a small change. However, it is possible
9509         that extra objects are added to the pack-file if the included
9510         commits contain certain types of direct renames. Default is
9511         <code>true</code>.
9512 </p>
9513 </dd>
9514 <dt class="hdlist1">
9515 pack.preferBitmapTips
9516 </dt>
9517 <dd>
9518 <p>
9519         When selecting which commits will receive bitmaps, prefer a
9520         commit at the tip of any reference that is a suffix of any value
9521         of this configuration over any other commits in the "selection
9522         window".
9523 </p>
9524 <div class="paragraph"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9525 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9526 necessarily be selected. This is because commits are selected for
9527 bitmaps from within a series of windows of variable length.</p></div>
9528 <div class="paragraph"><p>If a commit at the tip of any reference which is a suffix of any value
9529 of this configuration is seen in a window, it is immediately given
9530 preference over any other commit in that window.</p></div>
9531 </dd>
9532 <dt class="hdlist1">
9533 pack.writeBitmaps (deprecated)
9534 </dt>
9535 <dd>
9536 <p>
9537         This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9538 </p>
9539 </dd>
9540 <dt class="hdlist1">
9541 pack.writeBitmapHashCache
9542 </dt>
9543 <dd>
9544 <p>
9545         When true, git will include a "hash cache" section in the bitmap
9546         index (if one is written). This cache can be used to feed git&#8217;s
9547         delta heuristics, potentially leading to better deltas between
9548         bitmapped and non-bitmapped objects (e.g., when serving a fetch
9549         between an older, bitmapped pack and objects that have been
9550         pushed since the last gc). The downside is that it consumes 4
9551         bytes per object of disk space. Defaults to true.
9552 </p>
9553 <div class="paragraph"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9554 computed; instead, any namehashes stored in an existing bitmap are
9555 permuted into their appropriate location when writing a new bitmap.</p></div>
9556 </dd>
9557 <dt class="hdlist1">
9558 pack.writeBitmapLookupTable
9559 </dt>
9560 <dd>
9561 <p>
9562         When true, Git will include a "lookup table" section in the
9563         bitmap index (if one is written). This table is used to defer
9564         loading individual bitmaps as late as possible. This can be
9565         beneficial in repositories that have relatively large bitmap
9566         indexes. Defaults to false.
9567 </p>
9568 </dd>
9569 <dt class="hdlist1">
9570 pack.readReverseIndex
9571 </dt>
9572 <dd>
9573 <p>
9574         When true, git will read any .rev file(s) that may be available
9575         (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
9576         will be generated from scratch and stored in memory. Defaults to
9577         true.
9578 </p>
9579 </dd>
9580 <dt class="hdlist1">
9581 pack.writeReverseIndex
9582 </dt>
9583 <dd>
9584 <p>
9585         When true, git will write a corresponding .rev file (see:
9586         <a href="gitformat-pack.html">gitformat-pack(5)</a>)
9587         for each new packfile that it writes in all places except for
9588         <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
9589         Defaults to true.
9590 </p>
9591 </dd>
9592 <dt class="hdlist1">
9593 pager.&lt;cmd&gt;
9594 </dt>
9595 <dd>
9596 <p>
9597         If the value is boolean, turns on or off pagination of the
9598         output of a particular Git subcommand when writing to a tty.
9599         Otherwise, turns on pagination for the subcommand using the
9600         pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
9601         or <code>--no-pager</code> is specified on the command line, it takes
9602         precedence over this option.  To disable pagination for all
9603         commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9604 </p>
9605 </dd>
9606 <dt class="hdlist1">
9607 pretty.&lt;name&gt;
9608 </dt>
9609 <dd>
9610 <p>
9611         Alias for a --pretty= format string, as specified in
9612         <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
9613         as the built-in pretty formats could. For example,
9614         running <code>git config pretty.changelog "format:* %H %s"</code>
9615         would cause the invocation <code>git log --pretty=changelog</code>
9616         to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
9617         Note that an alias with the same name as a built-in format
9618         will be silently ignored.
9619 </p>
9620 </dd>
9621 <dt class="hdlist1">
9622 promisor.quiet
9623 </dt>
9624 <dd>
9625 <p>
9626         If set to "true" assume <code>--quiet</code> when fetching additional
9627         objects for a partial clone.
9628 </p>
9629 </dd>
9630 <dt class="hdlist1">
9631 protocol.allow
9632 </dt>
9633 <dd>
9634 <p>
9635         If set, provide a user defined default policy for all protocols which
9636         don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
9637         if unset, known-safe protocols (http, https, git, ssh) have a
9638         default policy of <code>always</code>, known-dangerous protocols (ext) have a
9639         default policy of <code>never</code>, and all other protocols (including file)
9640         have a default policy of <code>user</code>.  Supported policies:
9641 </p>
9642 <div class="openblock">
9643 <div class="content">
9644 <div class="ulist"><ul>
9645 <li>
9646 <p>
9647 <code>always</code> - protocol is always able to be used.
9648 </p>
9649 </li>
9650 <li>
9651 <p>
9652 <code>never</code> - protocol is never able to be used.
9653 </p>
9654 </li>
9655 <li>
9656 <p>
9657 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9658   either unset or has a value of 1.  This policy should be used when you want a
9659   protocol to be directly usable by the user but don&#8217;t want it used by commands which
9660   execute clone/fetch/push commands without user input, e.g. recursive
9661   submodule initialization.
9662 </p>
9663 </li>
9664 </ul></div>
9665 </div></div>
9666 </dd>
9667 <dt class="hdlist1">
9668 protocol.&lt;name&gt;.allow
9669 </dt>
9670 <dd>
9671 <p>
9672         Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
9673         commands. See <code>protocol.allow</code> above for the available policies.
9674 </p>
9675 <div class="paragraph"><p>The protocol names currently used by git are:</p></div>
9676 <div class="openblock">
9677 <div class="content">
9678 <div class="ulist"><ul>
9679 <li>
9680 <p>
9681 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9682     or local paths)
9683 </p>
9684 </li>
9685 <li>
9686 <p>
9687 <code>git</code>: the anonymous git protocol over a direct TCP
9688     connection (or proxy, if configured)
9689 </p>
9690 </li>
9691 <li>
9692 <p>
9693 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9694     <code>ssh://</code>, etc).
9695 </p>
9696 </li>
9697 <li>
9698 <p>
9699 <code>http</code>: git over http, both "smart http" and "dumb http".
9700     Note that this does <em>not</em> include <code>https</code>; if you want to configure
9701     both, you must do so individually.
9702 </p>
9703 </li>
9704 <li>
9705 <p>
9706 any external helpers are named by their protocol (e.g., use
9707     <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9708 </p>
9709 </li>
9710 </ul></div>
9711 </div></div>
9712 </dd>
9713 <dt class="hdlist1">
9714 protocol.version
9715 </dt>
9716 <dd>
9717 <p>
9718         If set, clients will attempt to communicate with a server
9719         using the specified protocol version.  If the server does
9720         not support it, communication falls back to version 0.
9721         If unset, the default is <code>2</code>.
9722         Supported versions:
9723 </p>
9724 <div class="openblock">
9725 <div class="content">
9726 <div class="ulist"><ul>
9727 <li>
9728 <p>
9729 <code>0</code> - the original wire protocol.
9730 </p>
9731 </li>
9732 <li>
9733 <p>
9734 <code>1</code> - the original wire protocol with the addition of a version string
9735   in the initial response from the server.
9736 </p>
9737 </li>
9738 <li>
9739 <p>
9740 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.
9741 </p>
9742 </li>
9743 </ul></div>
9744 </div></div>
9745 </dd>
9746 <dt class="hdlist1">
9747 pull.ff
9748 </dt>
9749 <dd>
9750 <p>
9751         By default, Git does not create an extra merge commit when merging
9752         a commit that is a descendant of the current commit. Instead, the
9753         tip of the current branch is fast-forwarded. When set to <code>false</code>,
9754         this variable tells Git to create an extra merge commit in such
9755         a case (equivalent to giving the <code>--no-ff</code> option from the command
9756         line). When set to <code>only</code>, only such fast-forward merges are
9757         allowed (equivalent to giving the <code>--ff-only</code> option from the
9758         command line). This setting overrides <code>merge.ff</code> when pulling.
9759 </p>
9760 </dd>
9761 <dt class="hdlist1">
9762 pull.rebase
9763 </dt>
9764 <dd>
9765 <p>
9766         When true, rebase branches on top of the fetched branch, instead
9767         of merging the default branch from the default remote when "git
9768         pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
9769         per-branch basis.
9770 </p>
9771 <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>
9772 so that the local merge commits are included in the rebase (see
9773 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
9774 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9775 mode.</p></div>
9776 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9777 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
9778 for details).</p></div>
9779 </dd>
9780 <dt class="hdlist1">
9781 pull.octopus
9782 </dt>
9783 <dd>
9784 <p>
9785         The default merge strategy to use when pulling multiple branches
9786         at once.
9787 </p>
9788 </dd>
9789 <dt class="hdlist1">
9790 pull.twohead
9791 </dt>
9792 <dd>
9793 <p>
9794         The default merge strategy to use when pulling a single branch.
9795 </p>
9796 </dd>
9797 <dt class="hdlist1">
9798 push.autoSetupRemote
9799 </dt>
9800 <dd>
9801 <p>
9802         If set to "true" assume <code>--set-upstream</code> on default push when no
9803         upstream tracking exists for the current branch; this option
9804         takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9805         and <em>current</em>. It is useful if by default you want new branches
9806         to be pushed to the default remote (like the behavior of
9807         <em>push.default=current</em>) and you also want the upstream tracking
9808         to be set. Workflows most likely to benefit from this option are
9809         <em>simple</em> central workflows where all branches are expected to
9810         have the same name on the remote.
9811 </p>
9812 </dd>
9813 <dt class="hdlist1">
9814 push.default
9815 </dt>
9816 <dd>
9817 <p>
9818         Defines the action <code>git push</code> should take if no refspec is
9819         given (whether from the command-line, config, or elsewhere).
9820         Different values are well-suited for
9821         specific workflows; for instance, in a purely central workflow
9822         (i.e. the fetch source is equal to the push destination),
9823         <code>upstream</code> is probably what you want.  Possible values are:
9824 </p>
9825 <div class="openblock">
9826 <div class="content">
9827 <div class="ulist"><ul>
9828 <li>
9829 <p>
9830 <code>nothing</code> - do not push anything (error out) unless a refspec is
9831   given. This is primarily meant for people who want to
9832   avoid mistakes by always being explicit.
9833 </p>
9834 </li>
9835 <li>
9836 <p>
9837 <code>current</code> - push the current branch to update a branch with the same
9838   name on the receiving end.  Works in both central and non-central
9839   workflows.
9840 </p>
9841 </li>
9842 <li>
9843 <p>
9844 <code>upstream</code> - push the current branch back to the branch whose
9845   changes are usually integrated into the current branch (which is
9846   called <code>@{upstream}</code>).  This mode only makes sense if you are
9847   pushing to the same repository you would normally pull from
9848   (i.e. central workflow).
9849 </p>
9850 </li>
9851 <li>
9852 <p>
9853 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
9854 </p>
9855 </li>
9856 <li>
9857 <p>
9858 <code>simple</code> - push the current branch with the same name on the remote.
9859 </p>
9860 <div class="paragraph"><p>If you are working on a centralized workflow (pushing to the same repository you
9861 pull from, which is typically <code>origin</code>), then you need to configure an upstream
9862 branch with the same name.</p></div>
9863 <div class="paragraph"><p>This mode is the default since Git 2.0, and is the safest option suited for
9864 beginners.</p></div>
9865 </li>
9866 <li>
9867 <p>
9868 <code>matching</code> - push all branches having the same name on both ends.
9869   This makes the repository you are pushing to remember the set of
9870   branches that will be pushed out (e.g. if you always push <em>maint</em>
9871   and <em>master</em> there and no other branches, the repository you push
9872   to will have these two branches, and your local <em>maint</em> and
9873   <em>master</em> will be pushed there).
9874 </p>
9875 <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
9876 branches you would push out are ready to be pushed out before
9877 running <em>git push</em>, as the whole point of this mode is to allow you
9878 to push all of the branches in one go.  If you usually finish work
9879 on only one branch and push out the result, while other branches are
9880 unfinished, this mode is not for you.  Also this mode is not
9881 suitable for pushing into a shared central repository, as other
9882 people may add new branches there, or update the tip of existing
9883 branches outside your control.</p></div>
9884 <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
9885 new default).</p></div>
9886 </li>
9887 </ul></div>
9888 </div></div>
9889 </dd>
9890 <dt class="hdlist1">
9891 push.followTags
9892 </dt>
9893 <dd>
9894 <p>
9895         If set to true, enable <code>--follow-tags</code> option by default.  You
9896         may override this configuration at time of push by specifying
9897         <code>--no-follow-tags</code>.
9898 </p>
9899 </dd>
9900 <dt class="hdlist1">
9901 push.gpgSign
9902 </dt>
9903 <dd>
9904 <p>
9905         May be set to a boolean value, or the string <em>if-asked</em>. A true
9906         value causes all pushes to be GPG signed, as if <code>--signed</code> is
9907         passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
9908         pushes to be signed if the server supports it, as if
9909         <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
9910         override a value from a lower-priority config file. An explicit
9911         command-line flag always overrides this config option.
9912 </p>
9913 </dd>
9914 <dt class="hdlist1">
9915 push.pushOption
9916 </dt>
9917 <dd>
9918 <p>
9919         When no <code>--push-option=&lt;option&gt;</code> argument is given from the
9920         command line, <code>git push</code> behaves as if each &lt;value&gt; of
9921         this variable is given as <code>--push-option=&lt;value&gt;</code>.
9922 </p>
9923 <div class="paragraph"><p>This is a multi-valued variable, and an empty value can be used in a
9924 higher priority configuration file (e.g. <code>.git/config</code> in a
9925 repository) to clear the values inherited from a lower priority
9926 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
9927 <div class="listingblock">
9928 <div class="content">
9929 <pre><code>Example:
9930
9931 /etc/gitconfig
9932   push.pushoption = a
9933   push.pushoption = b
9934
9935 ~/.gitconfig
9936   push.pushoption = c
9937
9938 repo/.git/config
9939   push.pushoption =
9940   push.pushoption = b
9941
9942 This will result in only b (a and c are cleared).</code></pre>
9943 </div></div>
9944 </dd>
9945 <dt class="hdlist1">
9946 push.recurseSubmodules
9947 </dt>
9948 <dd>
9949 <p>
9950         May be "check", "on-demand", "only", or "no", with the same behavior
9951         as that of "push --recurse-submodules".
9952         If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
9953         set (in which case a <em>true</em> value means <em>on-demand</em>).
9954 </p>
9955 </dd>
9956 <dt class="hdlist1">
9957 push.useForceIfIncludes
9958 </dt>
9959 <dd>
9960 <p>
9961         If set to "true", it is equivalent to specifying
9962         <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
9963         in the command line. Adding <code>--no-force-if-includes</code> at the
9964         time of push overrides this configuration setting.
9965 </p>
9966 </dd>
9967 <dt class="hdlist1">
9968 push.negotiate
9969 </dt>
9970 <dd>
9971 <p>
9972         If set to "true", attempt to reduce the size of the packfile
9973         sent by rounds of negotiation in which the client and the
9974         server attempt to find commits in common. If "false", Git will
9975         rely solely on the server&#8217;s ref advertisement to find commits
9976         in common.
9977 </p>
9978 </dd>
9979 <dt class="hdlist1">
9980 push.useBitmaps
9981 </dt>
9982 <dd>
9983 <p>
9984         If set to "false", disable use of bitmaps for "git push" even if
9985         <code>pack.useBitmaps</code> is "true", without preventing other git operations
9986         from using bitmaps. Default is true.
9987 </p>
9988 </dd>
9989 <dt class="hdlist1">
9990 rebase.backend
9991 </dt>
9992 <dd>
9993 <p>
9994         Default backend to use for rebasing.  Possible choices are
9995         <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
9996         all remaining capabilities of the apply backend, this setting
9997         may become unused.
9998 </p>
9999 </dd>
10000 <dt class="hdlist1">
10001 rebase.stat
10002 </dt>
10003 <dd>
10004 <p>
10005         Whether to show a diffstat of what changed upstream since the last
10006         rebase. False by default.
10007 </p>
10008 </dd>
10009 <dt class="hdlist1">
10010 rebase.autoSquash
10011 </dt>
10012 <dd>
10013 <p>
10014         If set to true, enable the <code>--autosquash</code> option of
10015         <a href="git-rebase.html">git-rebase(1)</a> by default for interactive mode.
10016         This can be overridden with the <code>--no-autosquash</code> option.
10017 </p>
10018 </dd>
10019 <dt class="hdlist1">
10020 rebase.autoStash
10021 </dt>
10022 <dd>
10023 <p>
10024         When set to true, automatically create a temporary stash entry
10025         before the operation begins, and apply it after the operation
10026         ends.  This means that you can run rebase on a dirty worktree.
10027         However, use with care: the final stash application after a
10028         successful rebase might result in non-trivial conflicts.
10029         This option can be overridden by the <code>--no-autostash</code> and
10030         <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
10031         Defaults to false.
10032 </p>
10033 </dd>
10034 <dt class="hdlist1">
10035 rebase.updateRefs
10036 </dt>
10037 <dd>
10038 <p>
10039         If set to true enable <code>--update-refs</code> option by default.
10040 </p>
10041 </dd>
10042 <dt class="hdlist1">
10043 rebase.missingCommitsCheck
10044 </dt>
10045 <dd>
10046 <p>
10047         If set to "warn", git rebase -i will print a warning if some
10048         commits are removed (e.g. a line was deleted), however the
10049         rebase will still proceed. If set to "error", it will print
10050         the previous warning and stop the rebase, <em>git rebase
10051         --edit-todo</em> can then be used to correct the error. If set to
10052         "ignore", no checking is done.
10053         To drop a commit without warning or error, use the <code>drop</code>
10054         command in the todo list.
10055         Defaults to "ignore".
10056 </p>
10057 </dd>
10058 <dt class="hdlist1">
10059 rebase.instructionFormat
10060 </dt>
10061 <dd>
10062 <p>
10063         A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
10064         todo list during an interactive rebase.  The format will
10065         automatically have the commit hash prepended to the format.
10066 </p>
10067 </dd>
10068 <dt class="hdlist1">
10069 rebase.abbreviateCommands
10070 </dt>
10071 <dd>
10072 <p>
10073         If set to true, <code>git rebase</code> will use abbreviated command names in the
10074         todo list resulting in something like this:
10075 </p>
10076 <div class="listingblock">
10077 <div class="content">
10078 <pre><code>        p deadbee The oneline of the commit
10079         p fa1afe1 The oneline of the next commit
10080         ...</code></pre>
10081 </div></div>
10082 <div class="paragraph"><p>instead of:</p></div>
10083 <div class="listingblock">
10084 <div class="content">
10085 <pre><code>        pick deadbee The oneline of the commit
10086         pick fa1afe1 The oneline of the next commit
10087         ...</code></pre>
10088 </div></div>
10089 <div class="paragraph"><p>Defaults to false.</p></div>
10090 </dd>
10091 <dt class="hdlist1">
10092 rebase.rescheduleFailedExec
10093 </dt>
10094 <dd>
10095 <p>
10096         Automatically reschedule <code>exec</code> commands that failed. This only makes
10097         sense in interactive mode (or when an <code>--exec</code> option was provided).
10098         This is the same as specifying the <code>--reschedule-failed-exec</code> option.
10099 </p>
10100 </dd>
10101 <dt class="hdlist1">
10102 rebase.forkPoint
10103 </dt>
10104 <dd>
10105 <p>
10106         If set to false set <code>--no-fork-point</code> option by default.
10107 </p>
10108 </dd>
10109 <dt class="hdlist1">
10110 rebase.rebaseMerges
10111 </dt>
10112 <dd>
10113 <p>
10114         Whether and how to set the <code>--rebase-merges</code> option by default. Can
10115         be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
10116         true or to <code>no-rebase-cousins</code> is equivalent to
10117         <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
10118         equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
10119         equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
10120         command line, with or without an argument, overrides any
10121         <code>rebase.rebaseMerges</code> configuration.
10122 </p>
10123 </dd>
10124 <dt class="hdlist1">
10125 rebase.maxLabelLength
10126 </dt>
10127 <dd>
10128 <p>
10129         When generating label names from commit subjects, truncate the names to
10130         this length. By default, the names are truncated to a little less than
10131         <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
10132         corresponding loose refs).
10133 </p>
10134 </dd>
10135 <dt class="hdlist1">
10136 receive.advertiseAtomic
10137 </dt>
10138 <dd>
10139 <p>
10140         By default, git-receive-pack will advertise the atomic push
10141         capability to its clients. If you don&#8217;t want to advertise this
10142         capability, set this variable to false.
10143 </p>
10144 </dd>
10145 <dt class="hdlist1">
10146 receive.advertisePushOptions
10147 </dt>
10148 <dd>
10149 <p>
10150         When set to true, git-receive-pack will advertise the push options
10151         capability to its clients. False by default.
10152 </p>
10153 </dd>
10154 <dt class="hdlist1">
10155 receive.autogc
10156 </dt>
10157 <dd>
10158 <p>
10159         By default, git-receive-pack will run "git maintenance run --auto" after
10160         receiving data from git-push and updating refs.  You can stop
10161         it by setting this variable to false.
10162 </p>
10163 </dd>
10164 <dt class="hdlist1">
10165 receive.certNonceSeed
10166 </dt>
10167 <dd>
10168 <p>
10169         By setting this variable to a string, <code>git receive-pack</code>
10170         will accept a <code>git push --signed</code> and verify it by using
10171         a "nonce" protected by HMAC using this string as a secret
10172         key.
10173 </p>
10174 </dd>
10175 <dt class="hdlist1">
10176 receive.certNonceSlop
10177 </dt>
10178 <dd>
10179 <p>
10180         When a <code>git push --signed</code> sends a push certificate with a
10181         "nonce" that was issued by a receive-pack serving the same
10182         repository within this many seconds, export the "nonce"
10183         found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
10184         hooks (instead of what the receive-pack asked the sending
10185         side to include).  This may allow writing checks in
10186         <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
10187         checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
10188         that records by how many seconds the nonce is stale to
10189         decide if they want to accept the certificate, they only
10190         can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
10191 </p>
10192 </dd>
10193 <dt class="hdlist1">
10194 receive.fsckObjects
10195 </dt>
10196 <dd>
10197 <p>
10198         If it is set to true, git-receive-pack will check all received
10199         objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
10200         Defaults to false. If not set, the value of
10201         <code>transfer.fsckObjects</code> is used instead.
10202 </p>
10203 </dd>
10204 <dt class="hdlist1">
10205 receive.fsck.&lt;msg-id&gt;
10206 </dt>
10207 <dd>
10208 <p>
10209         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
10210         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
10211         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
10212         details.
10213 </p>
10214 </dd>
10215 <dt class="hdlist1">
10216 receive.fsck.skipList
10217 </dt>
10218 <dd>
10219 <p>
10220         Acts like <code>fsck.skipList</code>, but is used by
10221         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
10222         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
10223         details.
10224 </p>
10225 </dd>
10226 <dt class="hdlist1">
10227 receive.keepAlive
10228 </dt>
10229 <dd>
10230 <p>
10231         After receiving the pack from the client, <code>receive-pack</code> may
10232         produce no output (if <code>--quiet</code> was specified) while processing
10233         the pack, causing some networks to drop the TCP connection.
10234         With this option set, if <code>receive-pack</code> does not transmit
10235         any data in this phase for <code>receive.keepAlive</code> seconds, it will
10236         send a short keepalive packet.  The default is 5 seconds; set
10237         to 0 to disable keepalives entirely.
10238 </p>
10239 </dd>
10240 <dt class="hdlist1">
10241 receive.unpackLimit
10242 </dt>
10243 <dd>
10244 <p>
10245         If the number of objects received in a push is below this
10246         limit then the objects will be unpacked into loose object
10247         files. However if the number of received objects equals or
10248         exceeds this limit then the received pack will be stored as
10249         a pack, after adding any missing delta bases.  Storing the
10250         pack from a push can make the push operation complete faster,
10251         especially on slow filesystems.  If not set, the value of
10252         <code>transfer.unpackLimit</code> is used instead.
10253 </p>
10254 </dd>
10255 <dt class="hdlist1">
10256 receive.maxInputSize
10257 </dt>
10258 <dd>
10259 <p>
10260         If the size of the incoming pack stream is larger than this
10261         limit, then git-receive-pack will error out, instead of
10262         accepting the pack file. If not set or set to 0, then the size
10263         is unlimited.
10264 </p>
10265 </dd>
10266 <dt class="hdlist1">
10267 receive.denyDeletes
10268 </dt>
10269 <dd>
10270 <p>
10271         If set to true, git-receive-pack will deny a ref update that deletes
10272         the ref. Use this to prevent such a ref deletion via a push.
10273 </p>
10274 </dd>
10275 <dt class="hdlist1">
10276 receive.denyDeleteCurrent
10277 </dt>
10278 <dd>
10279 <p>
10280         If set to true, git-receive-pack will deny a ref update that
10281         deletes the currently checked out branch of a non-bare repository.
10282 </p>
10283 </dd>
10284 <dt class="hdlist1">
10285 receive.denyCurrentBranch
10286 </dt>
10287 <dd>
10288 <p>
10289         If set to true or "refuse", git-receive-pack will deny a ref update
10290         to the currently checked out branch of a non-bare repository.
10291         Such a push is potentially dangerous because it brings the HEAD
10292         out of sync with the index and working tree. If set to "warn",
10293         print a warning of such a push to stderr, but allow the push to
10294         proceed. If set to false or "ignore", allow such pushes with no
10295         message. Defaults to "refuse".
10296 </p>
10297 <div class="paragraph"><p>Another option is "updateInstead" which will update the working
10298 tree if pushing into the current branch.  This option is
10299 intended for synchronizing working directories when one side is not easily
10300 accessible via interactive ssh (e.g. a live web site, hence the requirement
10301 that the working directory be clean). This mode also comes in handy when
10302 developing inside a VM to test and fix code on different Operating Systems.</p></div>
10303 <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
10304 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
10305 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p></div>
10306 </dd>
10307 <dt class="hdlist1">
10308 receive.denyNonFastForwards
10309 </dt>
10310 <dd>
10311 <p>
10312         If set to true, git-receive-pack will deny a ref update which is
10313         not a fast-forward. Use this to prevent such an update via a push,
10314         even if that push is forced. This configuration variable is
10315         set when initializing a shared repository.
10316 </p>
10317 </dd>
10318 <dt class="hdlist1">
10319 receive.hideRefs
10320 </dt>
10321 <dd>
10322 <p>
10323         This variable is the same as <code>transfer.hideRefs</code>, but applies
10324         only to <code>receive-pack</code> (and so affects pushes, but not fetches).
10325         An attempt to update or delete a hidden ref by <code>git push</code> is
10326         rejected.
10327 </p>
10328 </dd>
10329 <dt class="hdlist1">
10330 receive.procReceiveRefs
10331 </dt>
10332 <dd>
10333 <p>
10334         This is a multi-valued variable that defines reference prefixes
10335         to match the commands in <code>receive-pack</code>.  Commands matching the
10336         prefixes will be executed by an external hook "proc-receive",
10337         instead of the internal <code>execute_commands</code> function.  If this
10338         variable is not defined, the "proc-receive" hook will never be
10339         used, and all commands will be executed by the internal
10340         <code>execute_commands</code> function.
10341 </p>
10342 <div class="paragraph"><p>For example, if this variable is set to "refs/for", pushing to reference
10343 such as "refs/for/master" will not create or update a reference named
10344 "refs/for/master", but may create or update a pull request directly by
10345 running the hook "proc-receive".</p></div>
10346 <div class="paragraph"><p>Optional modifiers can be provided in the beginning of the value to filter
10347 commands for specific actions: create (a), modify (m), delete (d).
10348 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
10349 E.g.:</p></div>
10350 <div class="literalblock">
10351 <div class="content">
10352 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
10353 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
10354 </div></div>
10355 </dd>
10356 <dt class="hdlist1">
10357 receive.updateServerInfo
10358 </dt>
10359 <dd>
10360 <p>
10361         If set to true, git-receive-pack will run git-update-server-info
10362         after receiving data from git-push and updating refs.
10363 </p>
10364 </dd>
10365 <dt class="hdlist1">
10366 receive.shallowUpdate
10367 </dt>
10368 <dd>
10369 <p>
10370         If set to true, .git/shallow can be updated when new refs
10371         require new shallow roots. Otherwise those refs are rejected.
10372 </p>
10373 </dd>
10374 <dt class="hdlist1">
10375 reftable.blockSize
10376 </dt>
10377 <dd>
10378 <p>
10379         The size in bytes used by the reftable backend when writing blocks.
10380         The block size is determined by the writer, and does not have to be a
10381         power of 2. The block size must be larger than the longest reference
10382         name or log entry used in the repository, as references cannot span
10383         blocks.
10384 </p>
10385 <div class="paragraph"><p>Powers of two that are friendly to the virtual memory system or
10386 filesystem (such as 4kB or 8kB) are recommended. Larger sizes (64kB) can
10387 yield better compression, with a possible increased cost incurred by
10388 readers during access.</p></div>
10389 <div class="paragraph"><p>The largest block size is <code>16777215</code> bytes (15.99 MiB). The default value is
10390 <code>4096</code> bytes (4kB). A value of <code>0</code> will use the default value.</p></div>
10391 </dd>
10392 <dt class="hdlist1">
10393 reftable.restartInterval
10394 </dt>
10395 <dd>
10396 <p>
10397         The interval at which to create restart points. The reftable backend
10398         determines the restart points at file creation. Every 16 may be
10399         more suitable for smaller block sizes (4k or 8k), every 64 for larger
10400         block sizes (64k).
10401 </p>
10402 <div class="paragraph"><p>More frequent restart points reduces prefix compression and increases
10403 space consumed by the restart table, both of which increase file size.</p></div>
10404 <div class="paragraph"><p>Less frequent restart points makes prefix compression more effective,
10405 decreasing overall file size, with increased penalties for readers
10406 walking through more records after the binary search step.</p></div>
10407 <div class="paragraph"><p>A maximum of <code>65535</code> restart points per block is supported.</p></div>
10408 <div class="paragraph"><p>The default value is to create restart points every 16 records. A value of <code>0</code>
10409 will use the default value.</p></div>
10410 </dd>
10411 <dt class="hdlist1">
10412 reftable.indexObjects
10413 </dt>
10414 <dd>
10415 <p>
10416         Whether the reftable backend shall write object blocks. Object blocks
10417         are a reverse mapping of object ID to the references pointing to them.
10418 </p>
10419 <div class="paragraph"><p>The default value is <code>true</code>.</p></div>
10420 </dd>
10421 <dt class="hdlist1">
10422 reftable.geometricFactor
10423 </dt>
10424 <dd>
10425 <p>
10426         Whenever the reftable backend appends a new table to the stack, it
10427         performs auto compaction to ensure that there is only a handful of
10428         tables. The backend does this by ensuring that tables form a geometric
10429         sequence regarding the respective sizes of each table.
10430 </p>
10431 <div class="paragraph"><p>By default, the geometric sequence uses a factor of 2, meaning that for any
10432 table, the next-biggest table must at least be twice as big. A maximum factor
10433 of 256 is supported.</p></div>
10434 </dd>
10435 <dt class="hdlist1">
10436 remote.pushDefault
10437 </dt>
10438 <dd>
10439 <p>
10440         The remote to push to by default.  Overrides
10441         <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
10442         <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
10443 </p>
10444 </dd>
10445 <dt class="hdlist1">
10446 remote.&lt;name&gt;.url
10447 </dt>
10448 <dd>
10449 <p>
10450         The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
10451         <a href="git-push.html">git-push(1)</a>.
10452 </p>
10453 </dd>
10454 <dt class="hdlist1">
10455 remote.&lt;name&gt;.pushurl
10456 </dt>
10457 <dd>
10458 <p>
10459         The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
10460 </p>
10461 </dd>
10462 <dt class="hdlist1">
10463 remote.&lt;name&gt;.proxy
10464 </dt>
10465 <dd>
10466 <p>
10467         For remotes that require curl (http, https and ftp), the URL to
10468         the proxy to use for that remote.  Set to the empty string to
10469         disable proxying for that remote.
10470 </p>
10471 </dd>
10472 <dt class="hdlist1">
10473 remote.&lt;name&gt;.proxyAuthMethod
10474 </dt>
10475 <dd>
10476 <p>
10477         For remotes that require curl (http, https and ftp), the method to use for
10478         authenticating against the proxy in use (probably set in
10479         <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
10480 </p>
10481 </dd>
10482 <dt class="hdlist1">
10483 remote.&lt;name&gt;.fetch
10484 </dt>
10485 <dd>
10486 <p>
10487         The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
10488         <a href="git-fetch.html">git-fetch(1)</a>.
10489 </p>
10490 </dd>
10491 <dt class="hdlist1">
10492 remote.&lt;name&gt;.push
10493 </dt>
10494 <dd>
10495 <p>
10496         The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
10497         <a href="git-push.html">git-push(1)</a>.
10498 </p>
10499 </dd>
10500 <dt class="hdlist1">
10501 remote.&lt;name&gt;.mirror
10502 </dt>
10503 <dd>
10504 <p>
10505         If true, pushing to this remote will automatically behave
10506         as if the <code>--mirror</code> option was given on the command line.
10507 </p>
10508 </dd>
10509 <dt class="hdlist1">
10510 remote.&lt;name&gt;.skipDefaultUpdate
10511 </dt>
10512 <dd>
10513 <p>
10514         If true, this remote will be skipped by default when updating
10515         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10516         <a href="git-remote.html">git-remote(1)</a>.
10517 </p>
10518 </dd>
10519 <dt class="hdlist1">
10520 remote.&lt;name&gt;.skipFetchAll
10521 </dt>
10522 <dd>
10523 <p>
10524         If true, this remote will be skipped by default when updating
10525         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10526         <a href="git-remote.html">git-remote(1)</a>.
10527 </p>
10528 </dd>
10529 <dt class="hdlist1">
10530 remote.&lt;name&gt;.receivepack
10531 </dt>
10532 <dd>
10533 <p>
10534         The default program to execute on the remote side when pushing.  See
10535         option --receive-pack of <a href="git-push.html">git-push(1)</a>.
10536 </p>
10537 </dd>
10538 <dt class="hdlist1">
10539 remote.&lt;name&gt;.uploadpack
10540 </dt>
10541 <dd>
10542 <p>
10543         The default program to execute on the remote side when fetching.  See
10544         option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
10545 </p>
10546 </dd>
10547 <dt class="hdlist1">
10548 remote.&lt;name&gt;.tagOpt
10549 </dt>
10550 <dd>
10551 <p>
10552         Setting this value to --no-tags disables automatic tag following when
10553         fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
10554         tag from remote &lt;name&gt;, even if they are not reachable from remote
10555         branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
10556         override this setting. See options --tags and --no-tags of
10557         <a href="git-fetch.html">git-fetch(1)</a>.
10558 </p>
10559 </dd>
10560 <dt class="hdlist1">
10561 remote.&lt;name&gt;.vcs
10562 </dt>
10563 <dd>
10564 <p>
10565         Setting this to a value &lt;vcs&gt; will cause Git to interact with
10566         the remote with the git-remote-&lt;vcs&gt; helper.
10567 </p>
10568 </dd>
10569 <dt class="hdlist1">
10570 remote.&lt;name&gt;.prune
10571 </dt>
10572 <dd>
10573 <p>
10574         When set to true, fetching from this remote by default will also
10575         remove any remote-tracking references that no longer exist on the
10576         remote (as if the <code>--prune</code> option was given on the command line).
10577         Overrides <code>fetch.prune</code> settings, if any.
10578 </p>
10579 </dd>
10580 <dt class="hdlist1">
10581 remote.&lt;name&gt;.pruneTags
10582 </dt>
10583 <dd>
10584 <p>
10585         When set to true, fetching from this remote by default will also
10586         remove any local tags that no longer exist on the remote if pruning
10587         is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
10588         <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10589 </p>
10590 <div class="paragraph"><p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
10591 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
10592 </dd>
10593 <dt class="hdlist1">
10594 remote.&lt;name&gt;.promisor
10595 </dt>
10596 <dd>
10597 <p>
10598         When set to true, this remote will be used to fetch promisor
10599         objects.
10600 </p>
10601 </dd>
10602 <dt class="hdlist1">
10603 remote.&lt;name&gt;.partialclonefilter
10604 </dt>
10605 <dd>
10606 <p>
10607         The filter that will be applied when fetching from this promisor remote.
10608         Changing or clearing this value will only affect fetches for new commits.
10609         To fetch associated objects for commits already present in the local object
10610         database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.
10611 </p>
10612 </dd>
10613 <dt class="hdlist1">
10614 remotes.&lt;group&gt;
10615 </dt>
10616 <dd>
10617 <p>
10618         The list of remotes which are fetched by "git remote update
10619         &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.
10620 </p>
10621 </dd>
10622 <dt class="hdlist1">
10623 repack.useDeltaBaseOffset
10624 </dt>
10625 <dd>
10626 <p>
10627         By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
10628         delta-base offset. If you need to share your repository with
10629         Git older than version 1.4.4, either directly or via a dumb
10630         protocol such as http, then you need to set this option to
10631         "false" and repack. Access from old Git versions over the
10632         native protocol are unaffected by this option.
10633 </p>
10634 </dd>
10635 <dt class="hdlist1">
10636 repack.packKeptObjects
10637 </dt>
10638 <dd>
10639 <p>
10640         If set to true, makes <code>git repack</code> act as if
10641         <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
10642         details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10643         index is being written (either via <code>--write-bitmap-index</code> or
10644         <code>repack.writeBitmaps</code>).
10645 </p>
10646 </dd>
10647 <dt class="hdlist1">
10648 repack.useDeltaIslands
10649 </dt>
10650 <dd>
10651 <p>
10652         If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10653         was passed. Defaults to <code>false</code>.
10654 </p>
10655 </dd>
10656 <dt class="hdlist1">
10657 repack.writeBitmaps
10658 </dt>
10659 <dd>
10660 <p>
10661         When true, git will write a bitmap index when packing all
10662         objects to disk (e.g., when <code>git repack -a</code> is run).  This
10663         index can speed up the "counting objects" phase of subsequent
10664         packs created for clones and fetches, at the cost of some disk
10665         space and extra time spent on the initial repack.  This has
10666         no effect if multiple packfiles are created.
10667         Defaults to true on bare repos, false otherwise.
10668 </p>
10669 </dd>
10670 <dt class="hdlist1">
10671 repack.updateServerInfo
10672 </dt>
10673 <dd>
10674 <p>
10675         If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
10676         <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10677         when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.
10678 </p>
10679 </dd>
10680 <dt class="hdlist1">
10681 repack.cruftWindow
10682 </dt>
10683 <dt class="hdlist1">
10684 repack.cruftWindowMemory
10685 </dt>
10686 <dt class="hdlist1">
10687 repack.cruftDepth
10688 </dt>
10689 <dt class="hdlist1">
10690 repack.cruftThreads
10691 </dt>
10692 <dd>
10693 <p>
10694         Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
10695         a cruft pack and the respective parameters are not given over
10696         the command line. See similarly named <code>pack.*</code> configuration
10697         variables for defaults and meaning.
10698 </p>
10699 </dd>
10700 <dt class="hdlist1">
10701 rerere.autoUpdate
10702 </dt>
10703 <dd>
10704 <p>
10705         When set to true, <code>git-rerere</code> updates the index with the
10706         resulting contents after it cleanly resolves conflicts using
10707         previously recorded resolutions.  Defaults to false.
10708 </p>
10709 </dd>
10710 <dt class="hdlist1">
10711 rerere.enabled
10712 </dt>
10713 <dd>
10714 <p>
10715         Activate recording of resolved conflicts, so that identical
10716         conflict hunks can be resolved automatically, should they be
10717         encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
10718         enabled if there is an <code>rr-cache</code> directory under the
10719         <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
10720         repository.
10721 </p>
10722 </dd>
10723 <dt class="hdlist1">
10724 revert.reference
10725 </dt>
10726 <dd>
10727 <p>
10728         Setting this variable to true makes <code>git revert</code> behave
10729         as if the <code>--reference</code> option is given.
10730 </p>
10731 </dd>
10732 <dt class="hdlist1">
10733 safe.bareRepository
10734 </dt>
10735 <dd>
10736 <p>
10737         Specifies which bare repositories Git will work with. The currently
10738         supported values are:
10739 </p>
10740 <div class="ulist"><ul>
10741 <li>
10742 <p>
10743 <code>all</code>: Git works with all bare repositories. This is the default.
10744 </p>
10745 </li>
10746 <li>
10747 <p>
10748 <code>explicit</code>: Git only works with bare repositories specified via
10749   the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10750   environment variable (see <a href="git.html">git(1)</a>).
10751 </p>
10752 <div class="paragraph"><p>If you do not use bare repositories in your workflow, then it may be
10753 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10754 config. This will protect you from attacks that involve cloning a
10755 repository that contains a bare repository and running a Git command
10756 within that directory.</p></div>
10757 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10758 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with
10759 this value.</p></div>
10760 </li>
10761 </ul></div>
10762 </dd>
10763 <dt class="hdlist1">
10764 safe.directory
10765 </dt>
10766 <dd>
10767 <p>
10768         These config entries specify Git-tracked directories that are
10769         considered safe even if they are owned by someone other than the
10770         current user. By default, Git will refuse to even parse a Git
10771         config of a repository owned by someone else, let alone run its
10772         hooks, and this config setting allows users to specify exceptions,
10773         e.g. for intentionally shared repositories (see the <code>--shared</code>
10774         option in <a href="git-init.html">git-init(1)</a>).
10775 </p>
10776 <div class="paragraph"><p>This is a multi-valued setting, i.e. you can add more than one directory
10777 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10778 override any such directories specified in the system config), add a
10779 <code>safe.directory</code> entry with an empty value.</p></div>
10780 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10781 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with this
10782 value.</p></div>
10783 <div class="paragraph"><p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
10784 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
10785 path relative to Git&#8217;s (runtime) prefix.</p></div>
10786 <div class="paragraph"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10787 string <code>*</code>. This will allow all repositories to be treated as if their
10788 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10789 is set in system config and you want to re-enable this protection, then
10790 initialize your list with an empty value before listing the repositories
10791 that you deem safe.  Giving a directory with <code>/*</code> appended to it will
10792 allow access to all repositories under the named directory.</p></div>
10793 <div class="paragraph"><p>As explained, Git only allows you to access repositories owned by
10794 yourself, i.e. the user who is running Git, by default.  When Git
10795 is running as <em>root</em> in a non Windows platform that provides sudo,
10796 however, git checks the SUDO_UID environment variable that sudo creates
10797 and will allow access to the uid recorded as its value in addition to
10798 the id from <em>root</em>.
10799 This is to make it easy to perform a common sequence during installation
10800 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
10801 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
10802 which id the original user has.
10803 If that is not what you would prefer and want git to only trust
10804 repositories that are owned by root instead, then you can remove
10805 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p></div>
10806 </dd>
10807 <dt class="hdlist1">
10808 sendemail.identity
10809 </dt>
10810 <dd>
10811 <p>
10812         A configuration identity. When given, causes values in the
10813         <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
10814         values in the <em>sendemail</em> section. The default identity is
10815         the value of <code>sendemail.identity</code>.
10816 </p>
10817 </dd>
10818 <dt class="hdlist1">
10819 sendemail.smtpEncryption
10820 </dt>
10821 <dd>
10822 <p>
10823         See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
10824         setting is not subject to the <em>identity</em> mechanism.
10825 </p>
10826 </dd>
10827 <dt class="hdlist1">
10828 sendemail.smtpSSLCertPath
10829 </dt>
10830 <dd>
10831 <p>
10832         Path to ca-certificates (either a directory or a single file).
10833         Set it to an empty string to disable certificate verification.
10834 </p>
10835 </dd>
10836 <dt class="hdlist1">
10837 sendemail.&lt;identity&gt;.*
10838 </dt>
10839 <dd>
10840 <p>
10841         Identity-specific versions of the <em>sendemail.*</em> parameters
10842         found below, taking precedence over those when this
10843         identity is selected, through either the command-line or
10844         <code>sendemail.identity</code>.
10845 </p>
10846 </dd>
10847 <dt class="hdlist1">
10848 sendemail.multiEdit
10849 </dt>
10850 <dd>
10851 <p>
10852         If true (default), a single editor instance will be spawned to edit
10853         files you have to edit (patches when <code>--annotate</code> is used, and the
10854         summary when <code>--compose</code> is used). If false, files will be edited one
10855         after the other, spawning a new editor each time.
10856 </p>
10857 </dd>
10858 <dt class="hdlist1">
10859 sendemail.confirm
10860 </dt>
10861 <dd>
10862 <p>
10863         Sets the default for whether to confirm before sending. Must be
10864         one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
10865         in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
10866         values.
10867 </p>
10868 </dd>
10869 <dt class="hdlist1">
10870 sendemail.aliasesFile
10871 </dt>
10872 <dd>
10873 <p>
10874         To avoid typing long email addresses, point this to one or more
10875         email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.
10876 </p>
10877 </dd>
10878 <dt class="hdlist1">
10879 sendemail.aliasFileType
10880 </dt>
10881 <dd>
10882 <p>
10883         Format of the file(s) specified in sendemail.aliasesFile. Must be
10884         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.
10885 </p>
10886 <div class="paragraph"><p>What an alias file in each format looks like can be found in
10887 the documentation of the email program of the same name. The
10888 differences and limitations from the standard formats are
10889 described below:</p></div>
10890 <div class="openblock">
10891 <div class="content">
10892 <div class="dlist"><dl>
10893 <dt class="hdlist1">
10894 sendmail
10895 </dt>
10896 <dd>
10897 <div class="ulist"><ul>
10898 <li>
10899 <p>
10900 Quoted aliases and quoted addresses are not supported: lines that
10901         contain a <code>"</code> symbol are ignored.
10902 </p>
10903 </li>
10904 <li>
10905 <p>
10906 Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
10907         supported.
10908 </p>
10909 </li>
10910 <li>
10911 <p>
10912 File inclusion (<code>:include: /path/name</code>) is not supported.
10913 </p>
10914 </li>
10915 <li>
10916 <p>
10917 Warnings are printed on the standard error output for any
10918         explicitly unsupported constructs, and any other lines that are not
10919         recognized by the parser.
10920 </p>
10921 </li>
10922 </ul></div>
10923 </dd>
10924 </dl></div>
10925 </div></div>
10926 </dd>
10927 <dt class="hdlist1">
10928 sendemail.annotate
10929 </dt>
10930 <dt class="hdlist1">
10931 sendemail.bcc
10932 </dt>
10933 <dt class="hdlist1">
10934 sendemail.cc
10935 </dt>
10936 <dt class="hdlist1">
10937 sendemail.ccCmd
10938 </dt>
10939 <dt class="hdlist1">
10940 sendemail.chainReplyTo
10941 </dt>
10942 <dt class="hdlist1">
10943 sendemail.envelopeSender
10944 </dt>
10945 <dt class="hdlist1">
10946 sendemail.from
10947 </dt>
10948 <dt class="hdlist1">
10949 sendemail.headerCmd
10950 </dt>
10951 <dt class="hdlist1">
10952 sendemail.signedOffByCc
10953 </dt>
10954 <dt class="hdlist1">
10955 sendemail.smtpPass
10956 </dt>
10957 <dt class="hdlist1">
10958 sendemail.suppressCc
10959 </dt>
10960 <dt class="hdlist1">
10961 sendemail.suppressFrom
10962 </dt>
10963 <dt class="hdlist1">
10964 sendemail.to
10965 </dt>
10966 <dt class="hdlist1">
10967 sendemail.toCmd
10968 </dt>
10969 <dt class="hdlist1">
10970 sendemail.smtpDomain
10971 </dt>
10972 <dt class="hdlist1">
10973 sendemail.smtpServer
10974 </dt>
10975 <dt class="hdlist1">
10976 sendemail.smtpServerPort
10977 </dt>
10978 <dt class="hdlist1">
10979 sendemail.smtpServerOption
10980 </dt>
10981 <dt class="hdlist1">
10982 sendemail.smtpUser
10983 </dt>
10984 <dt class="hdlist1">
10985 sendemail.thread
10986 </dt>
10987 <dt class="hdlist1">
10988 sendemail.transferEncoding
10989 </dt>
10990 <dt class="hdlist1">
10991 sendemail.validate
10992 </dt>
10993 <dt class="hdlist1">
10994 sendemail.xmailer
10995 </dt>
10996 <dd>
10997 <p>
10998         These configuration variables all provide a default for
10999         <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
11000         documentation for details.
11001 </p>
11002 </dd>
11003 <dt class="hdlist1">
11004 sendemail.signedOffCc (deprecated)
11005 </dt>
11006 <dd>
11007 <p>
11008         Deprecated alias for <code>sendemail.signedOffByCc</code>.
11009 </p>
11010 </dd>
11011 <dt class="hdlist1">
11012 sendemail.smtpBatchSize
11013 </dt>
11014 <dd>
11015 <p>
11016         Number of messages to be sent per connection, after that a relogin
11017         will happen.  If the value is 0 or undefined, send all messages in
11018         one connection.
11019         See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
11020 </p>
11021 </dd>
11022 <dt class="hdlist1">
11023 sendemail.smtpReloginDelay
11024 </dt>
11025 <dd>
11026 <p>
11027         Seconds to wait before reconnecting to the smtp server.
11028         See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
11029 </p>
11030 </dd>
11031 <dt class="hdlist1">
11032 sendemail.forbidSendmailVariables
11033 </dt>
11034 <dd>
11035 <p>
11036         To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
11037         will abort with a warning if any configuration options for "sendmail"
11038         exist. Set this variable to bypass the check.
11039 </p>
11040 </dd>
11041 <dt class="hdlist1">
11042 sequence.editor
11043 </dt>
11044 <dd>
11045 <p>
11046         Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
11047         The value is meant to be interpreted by the shell when it is used.
11048         It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
11049         When not configured, the default commit message editor is used instead.
11050 </p>
11051 </dd>
11052 <dt class="hdlist1">
11053 showBranch.default
11054 </dt>
11055 <dd>
11056 <p>
11057         The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
11058         See <a href="git-show-branch.html">git-show-branch(1)</a>.
11059 </p>
11060 </dd>
11061 <dt class="hdlist1">
11062 sparse.expectFilesOutsideOfPatterns
11063 </dt>
11064 <dd>
11065 <p>
11066         Typically with sparse checkouts, files not matching any
11067         sparsity patterns are marked with a SKIP_WORKTREE bit in the
11068         index and are missing from the working tree.  Accordingly, Git
11069         will ordinarily check whether files with the SKIP_WORKTREE bit
11070         are in fact present in the working tree contrary to
11071         expectations.  If Git finds any, it marks those paths as
11072         present by clearing the relevant SKIP_WORKTREE bits.  This
11073         option can be used to tell Git that such
11074         present-despite-skipped files are expected and to stop
11075         checking for them.
11076 </p>
11077 <div class="paragraph"><p>The default is <code>false</code>, which allows Git to automatically recover
11078 from the list of files in the index and working tree falling out of
11079 sync.</p></div>
11080 <div class="paragraph"><p>Set this to <code>true</code> if you are in a setup where some external factor
11081 relieves Git of the responsibility for maintaining the consistency
11082 between the presence of working tree files and sparsity patterns.  For
11083 example, if you have a Git-aware virtual file system that has a robust
11084 mechanism for keeping the working tree and the sparsity patterns up to
11085 date based on access patterns.</p></div>
11086 <div class="paragraph"><p>Regardless of this setting, Git does not check for
11087 present-despite-skipped files unless sparse checkout is enabled, so
11088 this config option has no effect unless <code>core.sparseCheckout</code> is
11089 <code>true</code>.</p></div>
11090 </dd>
11091 <dt class="hdlist1">
11092 splitIndex.maxPercentChange
11093 </dt>
11094 <dd>
11095 <p>
11096         When the split index feature is used, this specifies the
11097         percent of entries the split index can contain compared to the
11098         total number of entries in both the split index and the shared
11099         index before a new shared index is written.
11100         The value should be between 0 and 100. If the value is 0, then
11101         a new shared index is always written; if it is 100, a new
11102         shared index is never written.
11103         By default, the value is 20, so a new shared index is written
11104         if the number of entries in the split index would be greater
11105         than 20 percent of the total number of entries.
11106         See <a href="git-update-index.html">git-update-index(1)</a>.
11107 </p>
11108 </dd>
11109 <dt class="hdlist1">
11110 splitIndex.sharedIndexExpire
11111 </dt>
11112 <dd>
11113 <p>
11114         When the split index feature is used, shared index files that
11115         were not modified since the time this variable specifies will
11116         be removed when a new shared index file is created. The value
11117         "now" expires all entries immediately, and "never" suppresses
11118         expiration altogether.
11119         The default value is "2.weeks.ago".
11120         Note that a shared index file is considered modified (for the
11121         purpose of expiration) each time a new split-index file is
11122         either created based on it or read from it.
11123         See <a href="git-update-index.html">git-update-index(1)</a>.
11124 </p>
11125 </dd>
11126 <dt class="hdlist1">
11127 ssh.variant
11128 </dt>
11129 <dd>
11130 <p>
11131         By default, Git determines the command line arguments to use
11132         based on the basename of the configured SSH command (configured
11133         using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
11134         the config setting <code>core.sshCommand</code>). If the basename is
11135         unrecognized, Git will attempt to detect support of OpenSSH
11136         options by first invoking the configured SSH command with the
11137         <code>-G</code> (print configuration) option and will subsequently use
11138         OpenSSH options (if that is successful) or no options besides
11139         the host and remote command (if it fails).
11140 </p>
11141 <div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this detection.
11142 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
11143 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
11144 The default auto-detection can be explicitly requested using the value
11145 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
11146 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
11147 <div class="paragraph"><p>The current command-line parameters used for each variant are as
11148 follows:</p></div>
11149 <div class="openblock">
11150 <div class="content">
11151 <div class="ulist"><ul>
11152 <li>
11153 <p>
11154 <code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command
11155 </p>
11156 </li>
11157 <li>
11158 <p>
11159 <code>simple</code> - [username@]host command
11160 </p>
11161 </li>
11162 <li>
11163 <p>
11164 <code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command
11165 </p>
11166 </li>
11167 <li>
11168 <p>
11169 <code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command
11170 </p>
11171 </li>
11172 </ul></div>
11173 </div></div>
11174 <div class="paragraph"><p>Except for the <code>simple</code> variant, command-line parameters are likely to
11175 change as git gains new features.</p></div>
11176 </dd>
11177 <dt class="hdlist1">
11178 stash.showIncludeUntracked
11179 </dt>
11180 <dd>
11181 <p>
11182         If this is set to true, the <code>git stash show</code> command will show
11183         the untracked files of a stash entry.  Defaults to false. See
11184         the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11185 </p>
11186 </dd>
11187 <dt class="hdlist1">
11188 stash.showPatch
11189 </dt>
11190 <dd>
11191 <p>
11192         If this is set to true, the <code>git stash show</code> command without an
11193         option will show the stash entry in patch form.  Defaults to false.
11194         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11195 </p>
11196 </dd>
11197 <dt class="hdlist1">
11198 stash.showStat
11199 </dt>
11200 <dd>
11201 <p>
11202         If this is set to true, the <code>git stash show</code> command without an
11203         option will show a diffstat of the stash entry.  Defaults to true.
11204         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11205 </p>
11206 </dd>
11207 <dt class="hdlist1">
11208 status.relativePaths
11209 </dt>
11210 <dd>
11211 <p>
11212         By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
11213         current directory. Setting this variable to <code>false</code> shows paths
11214         relative to the repository root (this was the default for Git
11215         prior to v1.5.4).
11216 </p>
11217 </dd>
11218 <dt class="hdlist1">
11219 status.short
11220 </dt>
11221 <dd>
11222 <p>
11223         Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
11224         The option --no-short takes precedence over this variable.
11225 </p>
11226 </dd>
11227 <dt class="hdlist1">
11228 status.branch
11229 </dt>
11230 <dd>
11231 <p>
11232         Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
11233         The option --no-branch takes precedence over this variable.
11234 </p>
11235 </dd>
11236 <dt class="hdlist1">
11237 status.aheadBehind
11238 </dt>
11239 <dd>
11240 <p>
11241         Set to true to enable <code>--ahead-behind</code> and false to enable
11242         <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
11243         non-porcelain status formats.  Defaults to true.
11244 </p>
11245 </dd>
11246 <dt class="hdlist1">
11247 status.displayCommentPrefix
11248 </dt>
11249 <dd>
11250 <p>
11251         If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
11252         prefix before each output line (starting with
11253         <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
11254         behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
11255         Defaults to false.
11256 </p>
11257 </dd>
11258 <dt class="hdlist1">
11259 status.renameLimit
11260 </dt>
11261 <dd>
11262 <p>
11263         The number of files to consider when performing rename detection
11264         in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
11265         the value of diff.renameLimit.
11266 </p>
11267 </dd>
11268 <dt class="hdlist1">
11269 status.renames
11270 </dt>
11271 <dd>
11272 <p>
11273         Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
11274         <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
11275         disabled. If set to "true", basic rename detection is enabled.
11276         If set to "copies" or "copy", Git will detect copies, as well.
11277         Defaults to the value of diff.renames.
11278 </p>
11279 </dd>
11280 <dt class="hdlist1">
11281 status.showStash
11282 </dt>
11283 <dd>
11284 <p>
11285         If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
11286         entries currently stashed away.
11287         Defaults to false.
11288 </p>
11289 </dd>
11290 <dt class="hdlist1">
11291 status.showUntrackedFiles
11292 </dt>
11293 <dd>
11294 <p>
11295         By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
11296         files which are not currently tracked by Git. Directories which
11297         contain only untracked files, are shown with the directory name
11298         only. Showing untracked files means that Git needs to lstat() all
11299         the files in the whole repository, which might be slow on some
11300         systems. So, this variable controls how the commands display
11301         the untracked files. Possible values are:
11302 </p>
11303 <div class="openblock">
11304 <div class="content">
11305 <div class="ulist"><ul>
11306 <li>
11307 <p>
11308 <code>no</code> - Show no untracked files.
11309 </p>
11310 </li>
11311 <li>
11312 <p>
11313 <code>normal</code> - Show untracked files and directories.
11314 </p>
11315 </li>
11316 <li>
11317 <p>
11318 <code>all</code> - Show also individual files in untracked directories.
11319 </p>
11320 </li>
11321 </ul></div>
11322 </div></div>
11323 <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
11324 All usual spellings for Boolean value <code>true</code> are taken as <code>normal</code>
11325 and <code>false</code> as <code>no</code>.
11326 This variable can be overridden with the -u|--untracked-files option
11327 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
11328 </dd>
11329 <dt class="hdlist1">
11330 status.submoduleSummary
11331 </dt>
11332 <dd>
11333 <p>
11334         Defaults to false.
11335         If this is set to a non-zero number or true (identical to -1 or an
11336         unlimited number), the submodule summary will be enabled and a
11337         summary of commits for modified submodules will be shown (see
11338         --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
11339         that the summary output command will be suppressed for all
11340         submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
11341         for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
11342         exception to that rule is that status and commit will show staged
11343         submodule changes. To
11344         also view the summary for ignored submodules you can either use
11345         the --ignore-submodules=dirty command-line option or the <em>git
11346         submodule summary</em> command, which shows a similar output but does
11347         not honor these settings.
11348 </p>
11349 </dd>
11350 <dt class="hdlist1">
11351 submodule.&lt;name&gt;.url
11352 </dt>
11353 <dd>
11354 <p>
11355         The URL for a submodule. This variable is copied from the .gitmodules
11356         file to the git config via <em>git submodule init</em>. The user can change
11357         the configured URL before obtaining the submodule via <em>git submodule
11358         update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
11359         set, the presence of this variable is used as a fallback to indicate
11360         whether the submodule is of interest to git commands.
11361         See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
11362 </p>
11363 </dd>
11364 <dt class="hdlist1">
11365 submodule.&lt;name&gt;.update
11366 </dt>
11367 <dd>
11368 <p>
11369         The method by which a submodule is updated by <em>git submodule update</em>,
11370         which is the only affected command, others such as
11371         <em>git checkout --recurse-submodules</em> are unaffected. It exists for
11372         historical reasons, when <em>git submodule</em> was the only command to
11373         interact with submodules; settings like <code>submodule.active</code>
11374         and <code>pull.rebase</code> are more specific. It is populated by
11375         <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
11376         See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.
11377 </p>
11378 </dd>
11379 <dt class="hdlist1">
11380 submodule.&lt;name&gt;.branch
11381 </dt>
11382 <dd>
11383 <p>
11384         The remote branch name for a submodule, used by <code>git submodule
11385         update --remote</code>.  Set this option to override the value found in
11386         the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
11387         <a href="gitmodules.html">gitmodules(5)</a> for details.
11388 </p>
11389 </dd>
11390 <dt class="hdlist1">
11391 submodule.&lt;name&gt;.fetchRecurseSubmodules
11392 </dt>
11393 <dd>
11394 <p>
11395         This option can be used to control recursive fetching of this
11396         submodule. It can be overridden by using the --[no-]recurse-submodules
11397         command-line option to "git fetch" and "git pull".
11398         This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
11399         file.
11400 </p>
11401 </dd>
11402 <dt class="hdlist1">
11403 submodule.&lt;name&gt;.ignore
11404 </dt>
11405 <dd>
11406 <p>
11407         Defines under what circumstances "git status" and the diff family show
11408         a submodule as modified. When set to "all", it will never be considered
11409         modified (but it will nonetheless show up in the output of status and
11410         commit when it has been staged), "dirty" will ignore all changes
11411         to the submodule&#8217;s work tree and
11412         takes only differences between the HEAD of the submodule and the commit
11413         recorded in the superproject into account. "untracked" will additionally
11414         let submodules with modified tracked files in their work tree show up.
11415         Using "none" (the default when this option is not set) also shows
11416         submodules that have untracked files in their work tree as changed.
11417         This setting overrides any setting made in .gitmodules for this submodule,
11418         both settings can be overridden on the command line by using the
11419         "--ignore-submodules" option. The <em>git submodule</em> commands are not
11420         affected by this setting.
11421 </p>
11422 </dd>
11423 <dt class="hdlist1">
11424 submodule.&lt;name&gt;.active
11425 </dt>
11426 <dd>
11427 <p>
11428         Boolean value indicating if the submodule is of interest to git
11429         commands.  This config option takes precedence over the
11430         submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
11431         details.
11432 </p>
11433 </dd>
11434 <dt class="hdlist1">
11435 submodule.active
11436 </dt>
11437 <dd>
11438 <p>
11439         A repeated field which contains a pathspec used to match against a
11440         submodule&#8217;s path to determine if the submodule is of interest to git
11441         commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.
11442 </p>
11443 </dd>
11444 <dt class="hdlist1">
11445 submodule.recurse
11446 </dt>
11447 <dd>
11448 <p>
11449         A boolean indicating if commands should enable the <code>--recurse-submodules</code>
11450         option by default. Defaults to false.
11451 </p>
11452 <div class="paragraph"><p>When set to true, it can be deactivated via the
11453 <code>--no-recurse-submodules</code> option. Note that some Git commands
11454 lacking this option may call some of the above commands affected by
11455 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
11456 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
11457 For these commands a workaround is to temporarily change the
11458 configuration value by using <code>git -c submodule.recurse=0</code>.</p></div>
11459 <div class="paragraph"><p>The following list shows the commands that accept
11460 <code>--recurse-submodules</code> and whether they are supported by this
11461 setting.</p></div>
11462 <div class="ulist"><ul>
11463 <li>
11464 <p>
11465 <code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
11466 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.
11467 </p>
11468 </li>
11469 <li>
11470 <p>
11471 <code>clone</code> and <code>ls-files</code> are not supported.
11472 </p>
11473 </li>
11474 <li>
11475 <p>
11476 <code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
11477 enabled
11478 </p>
11479 </li>
11480 </ul></div>
11481 </dd>
11482 <dt class="hdlist1">
11483 submodule.propagateBranches
11484 </dt>
11485 <dd>
11486 <p>
11487         [EXPERIMENTAL] A boolean that enables branching support when
11488         using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
11489         Enabling this will allow certain commands to accept
11490         <code>--recurse-submodules</code> and certain commands that already accept
11491         <code>--recurse-submodules</code> will now consider branches.
11492         Defaults to false.
11493 </p>
11494 </dd>
11495 <dt class="hdlist1">
11496 submodule.fetchJobs
11497 </dt>
11498 <dd>
11499 <p>
11500         Specifies how many submodules are fetched/cloned at the same time.
11501         A positive integer allows up to that number of submodules fetched
11502         in parallel. A value of 0 will give some reasonable default.
11503         If unset, it defaults to 1.
11504 </p>
11505 </dd>
11506 <dt class="hdlist1">
11507 submodule.alternateLocation
11508 </dt>
11509 <dd>
11510 <p>
11511         Specifies how the submodules obtain alternates when submodules are
11512         cloned. Possible values are <code>no</code>, <code>superproject</code>.
11513         By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
11514         value is set to <code>superproject</code> the submodule to be cloned computes
11515         its alternates location relative to the superprojects alternate.
11516 </p>
11517 </dd>
11518 <dt class="hdlist1">
11519 submodule.alternateErrorStrategy
11520 </dt>
11521 <dd>
11522 <p>
11523         Specifies how to treat errors with the alternates for a submodule
11524         as computed via <code>submodule.alternateLocation</code>. Possible values are
11525         <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
11526         or <code>info</code>, and if there is an error with the computed alternate, the
11527         clone proceeds as if no alternate was specified.
11528 </p>
11529 </dd>
11530 <dt class="hdlist1">
11531 tag.forceSignAnnotated
11532 </dt>
11533 <dd>
11534 <p>
11535         A boolean to specify whether annotated tags created should be GPG signed.
11536         If <code>--annotate</code> is specified on the command line, it takes
11537         precedence over this option.
11538 </p>
11539 </dd>
11540 <dt class="hdlist1">
11541 tag.sort
11542 </dt>
11543 <dd>
11544 <p>
11545         This variable controls the sort ordering of tags when displayed by
11546         <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
11547         value of this variable will be used as the default.
11548 </p>
11549 </dd>
11550 <dt class="hdlist1">
11551 tag.gpgSign
11552 </dt>
11553 <dd>
11554 <p>
11555         A boolean to specify whether all tags should be GPG signed.
11556         Use of this option when running in an automated script can
11557         result in a large number of tags being signed. It is therefore
11558         convenient to use an agent to avoid typing your gpg passphrase
11559         several times. Note that this option doesn&#8217;t affect tag signing
11560         behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.
11561 </p>
11562 </dd>
11563 <dt class="hdlist1">
11564 tar.umask
11565 </dt>
11566 <dd>
11567 <p>
11568         This variable can be used to restrict the permission bits of
11569         tar archive entries.  The default is 0002, which turns off the
11570         world write bit.  The special value "user" indicates that the
11571         archiving user&#8217;s umask will be used instead.  See umask(2) and
11572         <a href="git-archive.html">git-archive(1)</a>.
11573 </p>
11574 </dd>
11575 </dl></div>
11576 <div class="paragraph"><p>Trace2 config settings are only read from the system and global
11577 config files; repository local and worktree config files and <code>-c</code>
11578 command line arguments are not respected.</p></div>
11579 <div class="dlist"><dl>
11580 <dt class="hdlist1">
11581 trace2.normalTarget
11582 </dt>
11583 <dd>
11584 <p>
11585         This variable controls the normal target destination.
11586         It may be overridden by the <code>GIT_TRACE2</code> environment variable.
11587         The following table shows possible values.
11588 </p>
11589 </dd>
11590 <dt class="hdlist1">
11591 trace2.perfTarget
11592 </dt>
11593 <dd>
11594 <p>
11595         This variable controls the performance target destination.
11596         It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
11597         The following table shows possible values.
11598 </p>
11599 </dd>
11600 <dt class="hdlist1">
11601 trace2.eventTarget
11602 </dt>
11603 <dd>
11604 <p>
11605         This variable controls the event target destination.
11606         It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
11607         The following table shows possible values.
11608 </p>
11609 <div class="openblock">
11610 <div class="content">
11611 <div class="ulist"><ul>
11612 <li>
11613 <p>
11614 <code>0</code> or <code>false</code> - Disables the target.
11615 </p>
11616 </li>
11617 <li>
11618 <p>
11619 <code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.
11620 </p>
11621 </li>
11622 <li>
11623 <p>
11624 <code>[2-9]</code> - Writes to the already opened file descriptor.
11625 </p>
11626 </li>
11627 <li>
11628 <p>
11629 <code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
11630 already exists and is a directory, the traces will be written to files (one
11631 per process) underneath the given directory.
11632 </p>
11633 </li>
11634 <li>
11635 <p>
11636 <code>af_unix:[&lt;socket-type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
11637 Unix DomainSocket (on platforms that support them).  Socket
11638 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
11639 try both.
11640 </p>
11641 </li>
11642 </ul></div>
11643 </div></div>
11644 </dd>
11645 <dt class="hdlist1">
11646 trace2.normalBrief
11647 </dt>
11648 <dd>
11649 <p>
11650         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11651         omitted from normal output.  May be overridden by the
11652         <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.
11653 </p>
11654 </dd>
11655 <dt class="hdlist1">
11656 trace2.perfBrief
11657 </dt>
11658 <dd>
11659 <p>
11660         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11661         omitted from PERF output.  May be overridden by the
11662         <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.
11663 </p>
11664 </dd>
11665 <dt class="hdlist1">
11666 trace2.eventBrief
11667 </dt>
11668 <dd>
11669 <p>
11670         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11671         omitted from event output.  May be overridden by the
11672         <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.
11673 </p>
11674 </dd>
11675 <dt class="hdlist1">
11676 trace2.eventNesting
11677 </dt>
11678 <dd>
11679 <p>
11680         Integer.  Specifies desired depth of nested regions in the
11681         event output.  Regions deeper than this value will be
11682         omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
11683         environment variable.  Defaults to 2.
11684 </p>
11685 </dd>
11686 <dt class="hdlist1">
11687 trace2.configParams
11688 </dt>
11689 <dd>
11690 <p>
11691         A comma-separated list of patterns of "important" config
11692         settings that should be recorded in the trace2 output.
11693         For example, <code>core.*,remote.*.url</code> would cause the trace2
11694         output to contain events listing each configured remote.
11695         May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
11696         variable.  Unset by default.
11697 </p>
11698 </dd>
11699 <dt class="hdlist1">
11700 trace2.envVars
11701 </dt>
11702 <dd>
11703 <p>
11704         A comma-separated list of "important" environment variables that should
11705         be recorded in the trace2 output.  For example,
11706         <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
11707         contain events listing the overrides for HTTP user agent and the
11708         location of the Git configuration file (assuming any are set).  May be
11709         overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
11710         default.
11711 </p>
11712 </dd>
11713 <dt class="hdlist1">
11714 trace2.destinationDebug
11715 </dt>
11716 <dd>
11717 <p>
11718         Boolean.  When true Git will print error messages when a
11719         trace target destination cannot be opened for writing.
11720         By default, these errors are suppressed and tracing is
11721         silently disabled.  May be overridden by the
11722         <code>GIT_TRACE2_DST_DEBUG</code> environment variable.
11723 </p>
11724 </dd>
11725 <dt class="hdlist1">
11726 trace2.maxFiles
11727 </dt>
11728 <dd>
11729 <p>
11730         Integer.  When writing trace files to a target directory, do not
11731         write additional traces if doing so would exceed this many files. Instead,
11732         write a sentinel file that will block further tracing to this
11733         directory. Defaults to 0, which disables this check.
11734 </p>
11735 </dd>
11736 <dt class="hdlist1">
11737 transfer.credentialsInUrl
11738 </dt>
11739 <dd>
11740 <p>
11741         A configured URL can contain plaintext credentials in the form
11742         <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
11743         to warn or forbid the use of such configuration (in favor of
11744         using <a href="git-credential.html">git-credential(1)</a>). This will be used on
11745         <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>,
11746         and any other direct use of the configured URL.
11747 </p>
11748 <div class="paragraph"><p>Note that this is currently limited to detecting credentials in
11749 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
11750 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p></div>
11751 <div class="paragraph"><p>You might want to enable this to prevent inadvertent credentials
11752 exposure, e.g. because:</p></div>
11753 <div class="ulist"><ul>
11754 <li>
11755 <p>
11756 The OS or system where you&#8217;re running git may not provide a way or
11757   otherwise allow you to configure the permissions of the
11758   configuration file where the username and/or password are stored.
11759 </p>
11760 </li>
11761 <li>
11762 <p>
11763 Even if it does, having such data stored "at rest" might expose you
11764   in other ways, e.g. a backup process might copy the data to another
11765   system.
11766 </p>
11767 </li>
11768 <li>
11769 <p>
11770 The git programs will pass the full URL to one another as arguments
11771   on the command-line, meaning the credentials will be exposed to other
11772   unprivileged users on systems that allow them to see the full
11773   process list of other users. On linux the "hidepid" setting
11774   documented in procfs(5) allows for configuring this behavior.
11775 </p>
11776 <div class="paragraph"><p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
11777 concerned about credentials exposure due to storing sensitive
11778 data in git&#8217;s configuration files. If you do want to use this, set
11779 <code>transfer.credentialsInUrl</code> to one of these values:</p></div>
11780 </li>
11781 <li>
11782 <p>
11783 <code>allow</code> (default): Git will proceed with its activity without warning.
11784 </p>
11785 </li>
11786 <li>
11787 <p>
11788 <code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
11789   with a plaintext credential.
11790 </p>
11791 </li>
11792 <li>
11793 <p>
11794 <code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
11795   with a plaintext credential.
11796 </p>
11797 </li>
11798 </ul></div>
11799 </dd>
11800 <dt class="hdlist1">
11801 transfer.fsckObjects
11802 </dt>
11803 <dd>
11804 <p>
11805         When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
11806         not set, the value of this variable is used instead.
11807         Defaults to false.
11808 </p>
11809 <div class="paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
11810 object or a link to a nonexistent object. In addition, various other
11811 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
11812 and potential security issues like the existence of a <code>.GIT</code> directory
11813 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
11814 and v2.17.1 for details). Other sanity and security checks may be
11815 added in future releases.</p></div>
11816 <div class="paragraph"><p>On the receiving side, failing fsckObjects will make those objects
11817 unreachable, see "QUARANTINE ENVIRONMENT" in
11818 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
11819 instead be left unreferenced in the repository.</p></div>
11820 <div class="paragraph"><p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
11821 implementation it cannot be relied upon to leave the object store
11822 clean like <code>receive.fsckObjects</code> can.</p></div>
11823 <div class="paragraph"><p>As objects are unpacked they&#8217;re written to the object store, so there
11824 can be cases where malicious objects get introduced even though the
11825 "fetch" failed, only to have a subsequent "fetch" succeed because only
11826 new incoming objects are checked, not those that have already been
11827 written to the object store. That difference in behavior should not be
11828 relied upon. In the future, such objects may be quarantined for
11829 "fetch" as well.</p></div>
11830 <div class="paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
11831 environment if they&#8217;d like the same protection as "push". E.g. in the
11832 case of an internal mirror do the mirroring in two steps, one to fetch
11833 the untrusted objects, and then do a second "push" (which will use the
11834 quarantine) to another internal repo, and have internal clients
11835 consume this pushed-to repository, or embargo internal fetches and
11836 only allow them once a full "fsck" has run (and no new fetches have
11837 happened in the meantime).</p></div>
11838 </dd>
11839 <dt class="hdlist1">
11840 transfer.hideRefs
11841 </dt>
11842 <dd>
11843 <p>
11844         String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
11845         refs to omit from their initial advertisements.  Use more than
11846         one definition to specify multiple prefix strings. A ref that is
11847         under the hierarchies listed in the value of this variable is
11848         excluded, and is hidden when responding to <code>git push</code> or <code>git
11849         fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
11850         program-specific versions of this config.
11851 </p>
11852 <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
11853 explicitly exposing it, even if an earlier entry marked it as hidden.
11854 If you have multiple hideRefs values, later entries override earlier ones
11855 (and entries in more-specific config files override less-specific ones).</p></div>
11856 <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
11857 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
11858 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
11859 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
11860 <div class="paragraph"><p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
11861 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
11862 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
11863 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
11864 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
11865 <code>receive-pack</code>, on the other hand, will still advertise the object id the
11866 ref is pointing to without mentioning its name (a so-called ".have" line).</p></div>
11867 <div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
11868 objects via the techniques described in the "SECURITY" section of the
11869 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
11870 separate repository.</p></div>
11871 </dd>
11872 <dt class="hdlist1">
11873 transfer.unpackLimit
11874 </dt>
11875 <dd>
11876 <p>
11877         When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
11878         not set, the value of this variable is used instead.
11879         The default value is 100.
11880 </p>
11881 </dd>
11882 <dt class="hdlist1">
11883 transfer.advertiseSID
11884 </dt>
11885 <dd>
11886 <p>
11887         Boolean. When true, client and server processes will advertise their
11888         unique session IDs to their remote counterpart. Defaults to false.
11889 </p>
11890 </dd>
11891 <dt class="hdlist1">
11892 transfer.bundleURI
11893 </dt>
11894 <dd>
11895 <p>
11896         When <code>true</code>, local <code>git clone</code> commands will request bundle
11897         information from the remote server (if advertised) and download
11898         bundles before continuing the clone through the Git protocol.
11899         Defaults to <code>false</code>.
11900 </p>
11901 </dd>
11902 <dt class="hdlist1">
11903 transfer.advertiseObjectInfo
11904 </dt>
11905 <dd>
11906 <p>
11907         When <code>true</code>, the <code>object-info</code> capability is advertised by
11908         servers. Defaults to false.
11909 </p>
11910 </dd>
11911 <dt class="hdlist1">
11912 uploadarchive.allowUnreachable
11913 </dt>
11914 <dd>
11915 <p>
11916         If true, allow clients to use <code>git archive --remote</code> to request
11917         any tree, whether reachable from the ref tips or not. See the
11918         discussion in the "SECURITY" section of
11919         <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
11920         <code>false</code>.
11921 </p>
11922 </dd>
11923 <dt class="hdlist1">
11924 uploadpack.hideRefs
11925 </dt>
11926 <dd>
11927 <p>
11928         This variable is the same as <code>transfer.hideRefs</code>, but applies
11929         only to <code>upload-pack</code> (and so affects only fetches, not pushes).
11930         An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
11931         also <code>uploadpack.allowTipSHA1InWant</code>.
11932 </p>
11933 </dd>
11934 <dt class="hdlist1">
11935 uploadpack.allowTipSHA1InWant
11936 </dt>
11937 <dd>
11938 <p>
11939         When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
11940         to accept a fetch request that asks for an object at the tip
11941         of a hidden ref (by default, such a request is rejected).
11942         See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
11943         may be able to steal objects via the techniques described in the
11944         "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
11945         best to keep private data in a separate repository.
11946 </p>
11947 </dd>
11948 <dt class="hdlist1">
11949 uploadpack.allowReachableSHA1InWant
11950 </dt>
11951 <dd>
11952 <p>
11953         Allow <code>upload-pack</code> to accept a fetch request that asks for an
11954         object that is reachable from any ref tip. However, note that
11955         calculating object reachability is computationally expensive.
11956         Defaults to <code>false</code>.  Even if this is false, a client may be able
11957         to steal objects via the techniques described in the "SECURITY"
11958         section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
11959         keep private data in a separate repository.
11960 </p>
11961 </dd>
11962 <dt class="hdlist1">
11963 uploadpack.allowAnySHA1InWant
11964 </dt>
11965 <dd>
11966 <p>
11967         Allow <code>upload-pack</code> to accept a fetch request that asks for any
11968         object at all.
11969         Defaults to <code>false</code>.
11970 </p>
11971 </dd>
11972 <dt class="hdlist1">
11973 uploadpack.keepAlive
11974 </dt>
11975 <dd>
11976 <p>
11977         When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
11978         quiet period while <code>pack-objects</code> prepares the pack. Normally
11979         it would output progress information, but if <code>--quiet</code> was used
11980         for the fetch, <code>pack-objects</code> will output nothing at all until
11981         the pack data begins. Some clients and networks may consider
11982         the server to be hung and give up. Setting this option instructs
11983         <code>upload-pack</code> to send an empty keepalive packet every
11984         <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
11985         disables keepalive packets entirely. The default is 5 seconds.
11986 </p>
11987 </dd>
11988 <dt class="hdlist1">
11989 uploadpack.packObjectsHook
11990 </dt>
11991 <dd>
11992 <p>
11993         If this option is set, when <code>upload-pack</code> would run
11994         <code>git pack-objects</code> to create a packfile for a client, it will
11995         run this shell command instead.  The <code>pack-objects</code> command and
11996         arguments it <em>would</em> have run (including the <code>git pack-objects</code>
11997         at the beginning) are appended to the shell command. The stdin
11998         and stdout of the hook are treated as if <code>pack-objects</code> itself
11999         was run. I.e., <code>upload-pack</code> will feed input intended for
12000         <code>pack-objects</code> to the hook, and expects a completed packfile on
12001         stdout.
12002 </p>
12003 <div class="paragraph"><p>Note that this configuration variable is only respected when it is specified
12004 in protected configuration (see <a href="#SCOPES">[SCOPES]</a>). This is a safety measure
12005 against fetching from untrusted repositories.</p></div>
12006 </dd>
12007 <dt class="hdlist1">
12008 uploadpack.allowFilter
12009 </dt>
12010 <dd>
12011 <p>
12012         If this option is set, <code>upload-pack</code> will support partial
12013         clone and partial fetch object filtering.
12014 </p>
12015 </dd>
12016 <dt class="hdlist1">
12017 uploadpackfilter.allow
12018 </dt>
12019 <dd>
12020 <p>
12021         Provides a default value for unspecified object filters (see: the
12022         below configuration variable). If set to <code>true</code>, this will also
12023         enable all filters which get added in the future.
12024         Defaults to <code>true</code>.
12025 </p>
12026 </dd>
12027 <dt class="hdlist1">
12028 uploadpackfilter.&lt;filter&gt;.allow
12029 </dt>
12030 <dd>
12031 <p>
12032         Explicitly allow or ban the object filter corresponding to
12033         <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
12034         <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
12035         If using combined filters, both <code>combine</code> and all of the nested
12036         filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.
12037 </p>
12038 </dd>
12039 <dt class="hdlist1">
12040 uploadpackfilter.tree.maxDepth
12041 </dt>
12042 <dd>
12043 <p>
12044         Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
12045         <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
12046         <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
12047         variable had already been set. Has no effect if unset.
12048 </p>
12049 </dd>
12050 <dt class="hdlist1">
12051 uploadpack.allowRefInWant
12052 </dt>
12053 <dd>
12054 <p>
12055         If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
12056         feature of the protocol version 2 <code>fetch</code> command.  This feature
12057         is intended for the benefit of load-balanced servers which may
12058         not have the same view of what OIDs their refs point to due to
12059         replication delay.
12060 </p>
12061 </dd>
12062 <dt class="hdlist1">
12063 url.&lt;base&gt;.insteadOf
12064 </dt>
12065 <dd>
12066 <p>
12067         Any URL that starts with this value will be rewritten to
12068         start, instead, with &lt;base&gt;. In cases where some site serves a
12069         large number of repositories, and serves them with multiple
12070         access methods, and some users need to use different access
12071         methods, this feature allows people to specify any of the
12072         equivalent URLs and have Git automatically rewrite the URL to
12073         the best alternative for the particular user, even for a
12074         never-before-seen repository on the site.  When more than one
12075         insteadOf strings match a given URL, the longest match is used.
12076 </p>
12077 <div class="paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
12078 URL. If the rewrite changes the URL to use a custom protocol or remote
12079 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
12080 the request.  In particular, protocols you expect to use for submodules
12081 must be set to <code>always</code> rather than the default of <code>user</code>. See the
12082 description of <code>protocol.allow</code> above.</p></div>
12083 </dd>
12084 <dt class="hdlist1">
12085 url.&lt;base&gt;.pushInsteadOf
12086 </dt>
12087 <dd>
12088 <p>
12089         Any URL that starts with this value will not be pushed to;
12090         instead, it will be rewritten to start with &lt;base&gt;, and the
12091         resulting URL will be pushed to. In cases where some site serves
12092         a large number of repositories, and serves them with multiple
12093         access methods, some of which do not allow push, this feature
12094         allows people to specify a pull-only URL and have Git
12095         automatically use an appropriate URL to push, even for a
12096         never-before-seen repository on the site.  When more than one
12097         pushInsteadOf strings match a given URL, the longest match is
12098         used.  If a remote has an explicit pushurl, Git will ignore this
12099         setting for that remote.
12100 </p>
12101 </dd>
12102 <dt class="hdlist1">
12103 user.name
12104 </dt>
12105 <dt class="hdlist1">
12106 user.email
12107 </dt>
12108 <dt class="hdlist1">
12109 author.name
12110 </dt>
12111 <dt class="hdlist1">
12112 author.email
12113 </dt>
12114 <dt class="hdlist1">
12115 committer.name
12116 </dt>
12117 <dt class="hdlist1">
12118 committer.email
12119 </dt>
12120 <dd>
12121 <p>
12122         The <code>user.name</code> and <code>user.email</code> variables determine what ends
12123         up in the <code>author</code> and <code>committer</code> fields of commit
12124         objects.
12125         If you need the <code>author</code> or <code>committer</code> to be different, the
12126         <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
12127         <code>committer.email</code> variables can be set.
12128         All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
12129         <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
12130         <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.
12131 </p>
12132 <div class="paragraph"><p>Note that the <code>name</code> forms of these variables conventionally refer to
12133 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
12134 environment variables section of <a href="git.html">git(1)</a> for more information on
12135 these settings and the <code>credential.username</code> option if you&#8217;re looking
12136 for authentication credentials instead.</p></div>
12137 </dd>
12138 <dt class="hdlist1">
12139 user.useConfigOnly
12140 </dt>
12141 <dd>
12142 <p>
12143         Instruct Git to avoid trying to guess defaults for <code>user.email</code>
12144         and <code>user.name</code>, and instead retrieve the values only from the
12145         configuration. For example, if you have multiple email addresses
12146         and would like to use a different one for each repository, then
12147         with this configuration option set to <code>true</code> in the global config
12148         along with a name, Git will prompt you to set up an email before
12149         making new commits in a newly cloned repository.
12150         Defaults to <code>false</code>.
12151 </p>
12152 </dd>
12153 <dt class="hdlist1">
12154 user.signingKey
12155 </dt>
12156 <dd>
12157 <p>
12158         If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
12159         key you want it to automatically when creating a signed tag or
12160         commit, you can override the default selection with this variable.
12161         This option is passed unchanged to gpg&#8217;s --local-user parameter,
12162         so you may specify a key using any method that gpg supports.
12163         If gpg.format is set to <code>ssh</code> this can contain the path to either
12164         your private ssh key or the public key when ssh-agent is used.
12165         Alternatively it can contain a public key prefixed with <code>key::</code>
12166         directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
12167         needs to be available via ssh-agent. If not set Git will call
12168         gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
12169         first key available. For backward compatibility, a raw key which
12170         begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
12171         as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
12172         use the <code>key::</code> form instead.
12173 </p>
12174 </dd>
12175 <dt class="hdlist1">
12176 versionsort.prereleaseSuffix (deprecated)
12177 </dt>
12178 <dd>
12179 <p>
12180         Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
12181         <code>versionsort.suffix</code> is set.
12182 </p>
12183 </dd>
12184 <dt class="hdlist1">
12185 versionsort.suffix
12186 </dt>
12187 <dd>
12188 <p>
12189         Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
12190         with the same base version but different suffixes are still sorted
12191         lexicographically, resulting e.g. in prerelease tags appearing
12192         after the main release (e.g. "1.0-rc1" after "1.0").  This
12193         variable can be specified to determine the sorting order of tags
12194         with different suffixes.
12195 </p>
12196 <div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
12197 that suffix will appear before the corresponding main release.  E.g. if
12198 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
12199 "1.0".  If specified multiple times, once per suffix, then the order of
12200 suffixes in the configuration will determine the sorting order of tagnames
12201 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
12202 configuration, then all "1.0-preX" tags will be listed before any
12203 "1.0-rcX" tags.  The placement of the main release tag relative to tags
12204 with various suffixes can be determined by specifying the empty suffix
12205 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
12206 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
12207 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
12208 "v4.8-bfsX".</p></div>
12209 <div class="paragraph"><p>If more than one suffix matches the same tagname, then that tagname will
12210 be sorted according to the suffix which starts at the earliest position in
12211 the tagname.  If more than one different matching suffix starts at
12212 that earliest position, then that tagname will be sorted according to the
12213 longest of those suffixes.
12214 The sorting order between different suffixes is undefined if they are
12215 in multiple config files.</p></div>
12216 </dd>
12217 <dt class="hdlist1">
12218 web.browser
12219 </dt>
12220 <dd>
12221 <p>
12222         Specify a web browser that may be used by some commands.
12223         Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
12224         may use it.
12225 </p>
12226 </dd>
12227 <dt class="hdlist1">
12228 worktree.guessRemote
12229 </dt>
12230 <dd>
12231 <p>
12232         If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
12233         <code>--detach</code> is used, then <code>git worktree add</code> defaults to
12234         creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
12235         set to true, <code>worktree add</code> tries to find a remote-tracking
12236         branch whose name uniquely matches the new branch name.  If
12237         such a branch exists, it is checked out and set as "upstream"
12238         for the new branch.  If no such match can be found, it falls
12239         back to creating a new branch from the current HEAD.
12240 </p>
12241 </dd>
12242 </dl></div>
12243 </div>
12244 </div>
12245 </div>
12246 <div class="sect1">
12247 <h2 id="_bugs">BUGS</h2>
12248 <div class="sectionbody">
12249 <div class="paragraph"><p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
12250 will result in adding a multi-line key instead of a change, if the subsection
12251 is given with at least one uppercase character. For example when the config
12252 looks like</p></div>
12253 <div class="listingblock">
12254 <div class="content">
12255 <pre><code>  [section.subsection]
12256     key = value1</code></pre>
12257 </div></div>
12258 <div class="paragraph"><p>and running <code>git config section.Subsection.key value2</code> will result in</p></div>
12259 <div class="listingblock">
12260 <div class="content">
12261 <pre><code>  [section.subsection]
12262     key = value1
12263     key = value2</code></pre>
12264 </div></div>
12265 </div>
12266 </div>
12267 <div class="sect1">
12268 <h2 id="_git">GIT</h2>
12269 <div class="sectionbody">
12270 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
12271 </div>
12272 </div>
12273 </div>
12274 <div id="footnotes"><hr /></div>
12275 <div id="footer">
12276 <div id="footer-text">
12277 Last updated
12278  2024-05-16 11:09:25 PDT
12279 </div>
12280 </div>
12281 </body>
12282 </html>