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 advice.*
2129 </dt>
2130 <dd>
2131 <p>
2132         These variables control various optional help messages designed to
2133         aid new users.  When left unconfigured, Git will give the message
2134         alongside instructions on how to squelch it.  You can tell Git
2135         that you do not need the help message by setting these to <code>false</code>:
2136 </p>
2137 <div class="openblock">
2138 <div class="content">
2139 <div class="dlist"><dl>
2140 <dt class="hdlist1">
2141 addEmbeddedRepo
2142 </dt>
2143 <dd>
2144 <p>
2145                 Shown when the user accidentally adds one
2146                 git repo inside of another.
2147 </p>
2148 </dd>
2149 <dt class="hdlist1">
2150 addEmptyPathspec
2151 </dt>
2152 <dd>
2153 <p>
2154                 Shown when the user runs <code>git add</code> without providing
2155                 the pathspec parameter.
2156 </p>
2157 </dd>
2158 <dt class="hdlist1">
2159 addIgnoredFile
2160 </dt>
2161 <dd>
2162 <p>
2163                 Shown when the user attempts to add an ignored file to
2164                 the index.
2165 </p>
2166 </dd>
2167 <dt class="hdlist1">
2168 amWorkDir
2169 </dt>
2170 <dd>
2171 <p>
2172                 Shown when <a href="git-am.html">git-am(1)</a> fails to apply a patch
2173                 file, to tell the user the location of the file.
2174 </p>
2175 </dd>
2176 <dt class="hdlist1">
2177 ambiguousFetchRefspec
2178 </dt>
2179 <dd>
2180 <p>
2181                 Shown when a fetch refspec for multiple remotes maps to
2182                 the same remote-tracking branch namespace and causes branch
2183                 tracking set-up to fail.
2184 </p>
2185 </dd>
2186 <dt class="hdlist1">
2187 checkoutAmbiguousRemoteBranchName
2188 </dt>
2189 <dd>
2190 <p>
2191                 Shown when the argument to
2192                 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
2193                 ambiguously resolves to a
2194                 remote tracking branch on more than one remote in
2195                 situations where an unambiguous argument would have
2196                 otherwise caused a remote-tracking branch to be
2197                 checked out. See the <code>checkout.defaultRemote</code>
2198                 configuration variable for how to set a given remote
2199                 to be used by default in some situations where this
2200                 advice would be printed.
2201 </p>
2202 </dd>
2203 <dt class="hdlist1">
2204 commitBeforeMerge
2205 </dt>
2206 <dd>
2207 <p>
2208                 Shown when <a href="git-merge.html">git-merge(1)</a> refuses to
2209                 merge to avoid overwriting local changes.
2210 </p>
2211 </dd>
2212 <dt class="hdlist1">
2213 detachedHead
2214 </dt>
2215 <dd>
2216 <p>
2217                 Shown when the user uses
2218                 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
2219                 to move to the detached HEAD state, to tell the user how
2220                 to create a local branch after the fact.
2221 </p>
2222 </dd>
2223 <dt class="hdlist1">
2224 diverging
2225 </dt>
2226 <dd>
2227 <p>
2228                 Shown when a fast-forward is not possible.
2229 </p>
2230 </dd>
2231 <dt class="hdlist1">
2232 fetchShowForcedUpdates
2233 </dt>
2234 <dd>
2235 <p>
2236                 Shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
2237                 to calculate forced updates after ref updates, or to warn
2238                 that the check is disabled.
2239 </p>
2240 </dd>
2241 <dt class="hdlist1">
2242 forceDeleteBranch
2243 </dt>
2244 <dd>
2245 <p>
2246                 Shown when the user tries to delete a not fully merged
2247                 branch without the force option set.
2248 </p>
2249 </dd>
2250 <dt class="hdlist1">
2251 ignoredHook
2252 </dt>
2253 <dd>
2254 <p>
2255                 Shown when a hook is ignored because the hook is not
2256                 set as executable.
2257 </p>
2258 </dd>
2259 <dt class="hdlist1">
2260 implicitIdentity
2261 </dt>
2262 <dd>
2263 <p>
2264                 Shown when the user&#8217;s information is guessed from the
2265                 system username and domain name, to tell the user how to
2266                 set their identity configuration.
2267 </p>
2268 </dd>
2269 <dt class="hdlist1">
2270 mergeConflict
2271 </dt>
2272 <dd>
2273 <p>
2274                 Shown when various commands stop because of conflicts.
2275 </p>
2276 </dd>
2277 <dt class="hdlist1">
2278 nestedTag
2279 </dt>
2280 <dd>
2281 <p>
2282                 Shown when a user attempts to recursively tag a tag object.
2283 </p>
2284 </dd>
2285 <dt class="hdlist1">
2286 pushAlreadyExists
2287 </dt>
2288 <dd>
2289 <p>
2290                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2291                 does not qualify for fast-forwarding (e.g., a tag.)
2292 </p>
2293 </dd>
2294 <dt class="hdlist1">
2295 pushFetchFirst
2296 </dt>
2297 <dd>
2298 <p>
2299                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2300                 tries to overwrite a remote ref that points at an
2301                 object we do not have.
2302 </p>
2303 </dd>
2304 <dt class="hdlist1">
2305 pushNeedsForce
2306 </dt>
2307 <dd>
2308 <p>
2309                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2310                 tries to overwrite a remote ref that points at an
2311                 object that is not a commit-ish, or make the remote
2312                 ref point at an object that is not a commit-ish.
2313 </p>
2314 </dd>
2315 <dt class="hdlist1">
2316 pushNonFFCurrent
2317 </dt>
2318 <dd>
2319 <p>
2320                 Shown when <a href="git-push.html">git-push(1)</a> fails due to a
2321                 non-fast-forward update to the current branch.
2322 </p>
2323 </dd>
2324 <dt class="hdlist1">
2325 pushNonFFMatching
2326 </dt>
2327 <dd>
2328 <p>
2329                 Shown when the user ran <a href="git-push.html">git-push(1)</a> and pushed
2330                 "matching refs" explicitly (i.e. used <code>:</code>, or
2331                 specified a refspec that isn&#8217;t the current branch) and
2332                 it resulted in a non-fast-forward error.
2333 </p>
2334 </dd>
2335 <dt class="hdlist1">
2336 pushRefNeedsUpdate
2337 </dt>
2338 <dd>
2339 <p>
2340                 Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
2341                 a branch when its remote-tracking ref has updates that we
2342                 do not have locally.
2343 </p>
2344 </dd>
2345 <dt class="hdlist1">
2346 pushUnqualifiedRefname
2347 </dt>
2348 <dd>
2349 <p>
2350                 Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
2351                 guess based on the source and destination refs what
2352                 remote ref namespace the source belongs in, but where
2353                 we can still suggest that the user push to either
2354                 <code>refs/heads/*</code> or <code>refs/tags/*</code> based on the type of the
2355                 source object.
2356 </p>
2357 </dd>
2358 <dt class="hdlist1">
2359 pushUpdateRejected
2360 </dt>
2361 <dd>
2362 <p>
2363                 Set this variable to <code>false</code> if you want to disable
2364                 <code>pushNonFFCurrent</code>, <code>pushNonFFMatching</code>, <code>pushAlreadyExists</code>,
2365                 <code>pushFetchFirst</code>, <code>pushNeedsForce</code>, and <code>pushRefNeedsUpdate</code>
2366                 simultaneously.
2367 </p>
2368 </dd>
2369 <dt class="hdlist1">
2370 rebaseTodoError
2371 </dt>
2372 <dd>
2373 <p>
2374                 Shown when there is an error after editing the rebase todo list.
2375 </p>
2376 </dd>
2377 <dt class="hdlist1">
2378 refSyntax
2379 </dt>
2380 <dd>
2381 <p>
2382                 Shown when the user provides an illegal ref name, to
2383                 tell the user about the ref syntax documentation.
2384 </p>
2385 </dd>
2386 <dt class="hdlist1">
2387 resetNoRefresh
2388 </dt>
2389 <dd>
2390 <p>
2391                 Shown when <a href="git-reset.html">git-reset(1)</a> takes more than 2
2392                 seconds to refresh the index after reset, to tell the user
2393                 that they can use the <code>--no-refresh</code> option.
2394 </p>
2395 </dd>
2396 <dt class="hdlist1">
2397 resolveConflict
2398 </dt>
2399 <dd>
2400 <p>
2401                 Shown by various commands when conflicts
2402                 prevent the operation from being performed.
2403 </p>
2404 </dd>
2405 <dt class="hdlist1">
2406 rmHints
2407 </dt>
2408 <dd>
2409 <p>
2410                 Shown on failure in the output of <a href="git-rm.html">git-rm(1)</a>, to
2411                 give directions on how to proceed from the current state.
2412 </p>
2413 </dd>
2414 <dt class="hdlist1">
2415 sequencerInUse
2416 </dt>
2417 <dd>
2418 <p>
2419                 Shown when a sequencer command is already in progress.
2420 </p>
2421 </dd>
2422 <dt class="hdlist1">
2423 skippedCherryPicks
2424 </dt>
2425 <dd>
2426 <p>
2427                 Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
2428                 been cherry-picked onto the upstream branch.
2429 </p>
2430 </dd>
2431 <dt class="hdlist1">
2432 sparseIndexExpanded
2433 </dt>
2434 <dd>
2435 <p>
2436                 Shown when a sparse index is expanded to a full index, which is likely
2437                 due to an unexpected set of files existing outside of the
2438                 sparse-checkout.
2439 </p>
2440 </dd>
2441 <dt class="hdlist1">
2442 statusAheadBehind
2443 </dt>
2444 <dd>
2445 <p>
2446                 Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
2447                 counts for a local ref compared to its remote tracking ref,
2448                 and that calculation takes longer than expected. Will not
2449                 appear if <code>status.aheadBehind</code> is false or the option
2450                 <code>--no-ahead-behind</code> is given.
2451 </p>
2452 </dd>
2453 <dt class="hdlist1">
2454 statusHints
2455 </dt>
2456 <dd>
2457 <p>
2458                 Show directions on how to proceed from the current
2459                 state in the output of <a href="git-status.html">git-status(1)</a>, in
2460                 the template shown when writing commit messages in
2461                 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
2462                 by <a href="git-switch.html">git-switch(1)</a> or
2463                 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.
2464 </p>
2465 </dd>
2466 <dt class="hdlist1">
2467 statusUoption
2468 </dt>
2469 <dd>
2470 <p>
2471                 Shown when <a href="git-status.html">git-status(1)</a> takes more than 2
2472                 seconds to enumerate untracked files, to tell the user that
2473                 they can use the <code>-u</code> option.
2474 </p>
2475 </dd>
2476 <dt class="hdlist1">
2477 submoduleAlternateErrorStrategyDie
2478 </dt>
2479 <dd>
2480 <p>
2481                 Shown when a submodule.alternateErrorStrategy option
2482                 configured to "die" causes a fatal error.
2483 </p>
2484 </dd>
2485 <dt class="hdlist1">
2486 submoduleMergeConflict
2487 </dt>
2488 <dd>
2489 <p>
2490                 Advice shown when a non-trivial submodule merge conflict is
2491                 encountered.
2492 </p>
2493 </dd>
2494 <dt class="hdlist1">
2495 submodulesNotUpdated
2496 </dt>
2497 <dd>
2498 <p>
2499                 Shown when a user runs a submodule command that fails
2500                 because <code>git submodule update --init</code> was not run.
2501 </p>
2502 </dd>
2503 <dt class="hdlist1">
2504 suggestDetachingHead
2505 </dt>
2506 <dd>
2507 <p>
2508                 Shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
2509                 without the explicit <code>--detach</code> option.
2510 </p>
2511 </dd>
2512 <dt class="hdlist1">
2513 updateSparsePath
2514 </dt>
2515 <dd>
2516 <p>
2517                 Shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
2518                 is asked to update index entries outside the current sparse
2519                 checkout.
2520 </p>
2521 </dd>
2522 <dt class="hdlist1">
2523 waitingForEditor
2524 </dt>
2525 <dd>
2526 <p>
2527                 Shown when Git is waiting for editor input. Relevant
2528                 when e.g. the editor is not launched inside the terminal.
2529 </p>
2530 </dd>
2531 <dt class="hdlist1">
2532 worktreeAddOrphan
2533 </dt>
2534 <dd>
2535 <p>
2536                 Shown when the user tries to create a worktree from an
2537                 invalid reference, to tell the user how to create a new unborn
2538                 branch instead.
2539 </p>
2540 </dd>
2541 </dl></div>
2542 </div></div>
2543 </dd>
2544 <dt class="hdlist1">
2545 alias.*
2546 </dt>
2547 <dd>
2548 <p>
2549         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
2550         after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
2551         <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
2552         confusion and troubles with script usage, aliases that
2553         hide existing Git commands are ignored. Arguments are split by
2554         spaces, the usual shell quoting and escaping are supported.
2555         A quote pair or a backslash can be used to quote them.
2556 </p>
2557 <div class="paragraph"><p>Note that the first word of an alias does not necessarily have to be a
2558 command. It can be a command-line option that will be passed into the
2559 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
2560 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
2561 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
2562 running <code>git loud-rebase</code> would be equivalent to
2563 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
2564 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
2565 where the original command does not.</p></div>
2566 <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
2567 it will be treated as a shell command.  For example, defining
2568 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
2569 <code>git new</code> is equivalent to running the shell command
2570 <code>gitk --all --not ORIG_HEAD</code>.  Note:</p></div>
2571 <div class="ulist"><ul>
2572 <li>
2573 <p>
2574 Shell commands will be executed from the top-level directory of a
2575   repository, which may not necessarily be the current directory.
2576 </p>
2577 </li>
2578 <li>
2579 <p>
2580 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
2581   from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.
2582 </p>
2583 </li>
2584 <li>
2585 <p>
2586 Shell command aliases always receive any extra arguments provided to
2587   the Git command-line as positional arguments.
2588 </p>
2589 <div class="ulist"><ul>
2590 <li>
2591 <p>
2592 Care should be taken if your shell alias is a "one-liner" script
2593    with multiple commands (e.g. in a pipeline), references multiple
2594    arguments, or is otherwise not able to handle positional arguments
2595    added at the end.  For example: <code>alias.cmd = "!echo $1 | grep $2"</code>
2596    called as <code>git cmd 1 2</code> will be executed as <em>echo $1 | grep $2
2597    1 2</em>, which is not what you want.
2598 </p>
2599 </li>
2600 <li>
2601 <p>
2602 A convenient way to deal with this is to write your script
2603    operations in an inline function that is then called with any
2604    arguments from the command-line.  For example `alias.cmd = "!c() {
2605    echo $1 | grep $2 ; }; c" will correctly execute the prior example.
2606 </p>
2607 </li>
2608 <li>
2609 <p>
2610 Setting <code>GIT_TRACE=1</code> can help you debug the command being run for
2611    your alias.
2612 </p>
2613 </li>
2614 </ul></div>
2615 </li>
2616 </ul></div>
2617 </dd>
2618 <dt class="hdlist1">
2619 am.keepcr
2620 </dt>
2621 <dd>
2622 <p>
2623         If true, git-am will call git-mailsplit for patches in mbox format
2624         with parameter <code>--keep-cr</code>. In this case git-mailsplit will
2625         not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
2626         by giving <code>--no-keep-cr</code> from the command line.
2627         See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
2628 </p>
2629 </dd>
2630 <dt class="hdlist1">
2631 am.threeWay
2632 </dt>
2633 <dd>
2634 <p>
2635         By default, <code>git am</code> will fail if the patch does not apply cleanly. When
2636         set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
2637         the patch records the identity of blobs it is supposed to apply to and
2638         we have those blobs available locally (equivalent to giving the <code>--3way</code>
2639         option from the command line). Defaults to <code>false</code>.
2640         See <a href="git-am.html">git-am(1)</a>.
2641 </p>
2642 </dd>
2643 <dt class="hdlist1">
2644 apply.ignoreWhitespace
2645 </dt>
2646 <dd>
2647 <p>
2648         When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
2649         whitespace, in the same way as the <code>--ignore-space-change</code>
2650         option.
2651         When set to one of: no, none, never, false, it tells <em>git apply</em> to
2652         respect all whitespace differences.
2653         See <a href="git-apply.html">git-apply(1)</a>.
2654 </p>
2655 </dd>
2656 <dt class="hdlist1">
2657 apply.whitespace
2658 </dt>
2659 <dd>
2660 <p>
2661         Tells <em>git apply</em> how to handle whitespace, in the same way
2662         as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
2663 </p>
2664 </dd>
2665 <dt class="hdlist1">
2666 attr.tree
2667 </dt>
2668 <dd>
2669 <p>
2670         A reference to a tree in the repository from which to read attributes,
2671         instead of the <code>.gitattributes</code> file in the working tree. If the value
2672         does not resolve to a valid tree object, an empty tree is used instead.
2673         When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2674         command line option are used, this configuration variable has no effect.
2675 </p>
2676 </dd>
2677 </dl></div>
2678 <div class="admonitionblock">
2679 <table><tr>
2680 <td class="icon">
2681 <div class="title">Note</div>
2682 </td>
2683 <td class="content">The configuration options in <code>bitmapPseudoMerge.*</code> are considered
2684 EXPERIMENTAL and may be subject to change or be removed entirely in the
2685 future. For more information about the pseudo-merge bitmap feature, see
2686 the "Pseudo-merge bitmaps" section of <a href="gitpacking.html">gitpacking(7)</a>.</td>
2687 </tr></table>
2688 </div>
2689 <div class="dlist"><dl>
2690 <dt class="hdlist1">
2691 bitmapPseudoMerge.&lt;name&gt;.pattern
2692 </dt>
2693 <dd>
2694 <p>
2695         Regular expression used to match reference names. Commits
2696         pointed to by references matching this pattern (and meeting
2697         the below criteria, like <code>bitmapPseudoMerge.&lt;name&gt;.sampleRate</code>
2698         and <code>bitmapPseudoMerge.&lt;name&gt;.threshold</code>) will be considered
2699         for inclusion in a pseudo-merge bitmap.
2700 </p>
2701 <div class="paragraph"><p>Commits are grouped into pseudo-merge groups based on whether or not
2702 any reference(s) that point at a given commit match the pattern, which
2703 is an extended regular expression.</p></div>
2704 <div class="paragraph"><p>Within a pseudo-merge group, commits may be further grouped into
2705 sub-groups based on the capture groups in the pattern. These
2706 sub-groupings are formed from the regular expressions by concatenating
2707 any capture groups from the regular expression, with a <em>-</em> dash in
2708 between.</p></div>
2709 <div class="paragraph"><p>For example, if the pattern is <code>refs/tags/</code>, then all tags (provided
2710 they meet the below criteria) will be considered candidates for the
2711 same pseudo-merge group. However, if the pattern is instead
2712 <code>refs/remotes/([0-9])+/tags/</code>, then tags from different remotes will
2713 be grouped into separate pseudo-merge groups, based on the remote
2714 number.</p></div>
2715 </dd>
2716 <dt class="hdlist1">
2717 bitmapPseudoMerge.&lt;name&gt;.decay
2718 </dt>
2719 <dd>
2720 <p>
2721         Determines the rate at which consecutive pseudo-merge bitmap
2722         groups decrease in size. Must be non-negative. This parameter
2723         can be thought of as <code>k</code> in the function <code>f(n) = C * n^-k</code>,
2724         where <code>f(n)</code> is the size of the `n`th group.
2725 </p>
2726 <div class="paragraph"><p>Setting the decay rate equal to <code>0</code> will cause all groups to be the
2727 same size. Setting the decay rate equal to <code>1</code> will cause the <code>n`th
2728 group to be `1/n</code> the size of the initial group.  Higher values of the
2729 decay rate cause consecutive groups to shrink at an increasing rate.
2730 The default is <code>1</code>.</p></div>
2731 <div class="paragraph"><p>If all groups are the same size, it is possible that groups containing
2732 newer commits will be able to be used less often than earlier groups,
2733 since it is more likely that the references pointing at newer commits
2734 will be updated more often than a reference pointing at an old commit.</p></div>
2735 </dd>
2736 <dt class="hdlist1">
2737 bitmapPseudoMerge.&lt;name&gt;.sampleRate
2738 </dt>
2739 <dd>
2740 <p>
2741         Determines the proportion of non-bitmapped commits (among
2742         reference tips) which are selected for inclusion in an
2743         unstable pseudo-merge bitmap. Must be between <code>0</code> and <code>1</code>
2744         (inclusive). The default is <code>1</code>.
2745 </p>
2746 </dd>
2747 <dt class="hdlist1">
2748 bitmapPseudoMerge.&lt;name&gt;.threshold
2749 </dt>
2750 <dd>
2751 <p>
2752         Determines the minimum age of non-bitmapped commits (among
2753         reference tips, as above) which are candidates for inclusion
2754         in an unstable pseudo-merge bitmap. The default is
2755         <code>1.week.ago</code>.
2756 </p>
2757 </dd>
2758 <dt class="hdlist1">
2759 bitmapPseudoMerge.&lt;name&gt;.maxMerges
2760 </dt>
2761 <dd>
2762 <p>
2763         Determines the maximum number of pseudo-merge commits among
2764         which commits may be distributed.
2765 </p>
2766 <div class="paragraph"><p>For pseudo-merge groups whose pattern does not contain any capture
2767 groups, this setting is applied for all commits matching the regular
2768 expression. For patterns that have one or more capture groups, this
2769 setting is applied for each distinct capture group.</p></div>
2770 <div class="paragraph"><p>For example, if your capture group is <code>refs/tags/</code>, then this setting
2771 will distribute all tags into a maximum of <code>maxMerges</code> pseudo-merge
2772 commits. However, if your capture group is, say,
2773 <code>refs/remotes/([0-9]+)/tags/</code>, then this setting will be applied to
2774 each remote&#8217;s set of tags individually.</p></div>
2775 <div class="paragraph"><p>Must be non-negative. The default value is 64.</p></div>
2776 </dd>
2777 <dt class="hdlist1">
2778 bitmapPseudoMerge.&lt;name&gt;.stableThreshold
2779 </dt>
2780 <dd>
2781 <p>
2782         Determines the minimum age of commits (among reference tips,
2783         as above, however stable commits are still considered
2784         candidates even when they have been covered by a bitmap) which
2785         are candidates for a stable a pseudo-merge bitmap. The default
2786         is <code>1.month.ago</code>.
2787 </p>
2788 <div class="paragraph"><p>Setting this threshold to a smaller value (e.g., 1.week.ago) will cause
2789 more stable groups to be generated (which impose a one-time generation
2790 cost) but those groups will likely become stale over time. Using a
2791 larger value incurs the opposite penalty (fewer stable groups which are
2792 more useful).</p></div>
2793 </dd>
2794 <dt class="hdlist1">
2795 bitmapPseudoMerge.&lt;name&gt;.stableSize
2796 </dt>
2797 <dd>
2798 <p>
2799         Determines the size (in number of commits) of a stable
2800         psuedo-merge bitmap. The default is <code>512</code>.
2801 </p>
2802 </dd>
2803 <dt class="hdlist1">
2804 blame.blankBoundary
2805 </dt>
2806 <dd>
2807 <p>
2808         Show blank commit object name for boundary commits in
2809         <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.
2810 </p>
2811 </dd>
2812 <dt class="hdlist1">
2813 blame.coloring
2814 </dt>
2815 <dd>
2816 <p>
2817         This determines the coloring scheme to be applied to blame
2818         output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
2819         or <em>none</em> which is the default.
2820 </p>
2821 </dd>
2822 <dt class="hdlist1">
2823 blame.date
2824 </dt>
2825 <dd>
2826 <p>
2827         Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
2828         If unset the iso format is used. For supported values,
2829         see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.
2830 </p>
2831 </dd>
2832 <dt class="hdlist1">
2833 blame.showEmail
2834 </dt>
2835 <dd>
2836 <p>
2837         Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
2838         This option defaults to false.
2839 </p>
2840 </dd>
2841 <dt class="hdlist1">
2842 blame.showRoot
2843 </dt>
2844 <dd>
2845 <p>
2846         Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
2847         This option defaults to false.
2848 </p>
2849 </dd>
2850 <dt class="hdlist1">
2851 blame.ignoreRevsFile
2852 </dt>
2853 <dd>
2854 <p>
2855         Ignore revisions listed in the file, one unabbreviated object name per
2856         line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
2857         <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
2858         file names will reset the list of ignored revisions.  This option will
2859         be handled before the command line option <code>--ignore-revs-file</code>.
2860 </p>
2861 </dd>
2862 <dt class="hdlist1">
2863 blame.markUnblamableLines
2864 </dt>
2865 <dd>
2866 <p>
2867         Mark lines that were changed by an ignored revision that we could not
2868         attribute to another commit with a <em>*</em> in the output of
2869         <a href="git-blame.html">git-blame(1)</a>.
2870 </p>
2871 </dd>
2872 <dt class="hdlist1">
2873 blame.markIgnoredLines
2874 </dt>
2875 <dd>
2876 <p>
2877         Mark lines that were changed by an ignored revision that we attributed to
2878         another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.
2879 </p>
2880 </dd>
2881 <dt class="hdlist1">
2882 branch.autoSetupMerge
2883 </dt>
2884 <dd>
2885 <p>
2886         Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
2887         so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
2888         starting point branch. Note that even if this option is not set,
2889         this behavior can be chosen per-branch using the <code>--track</code>
2890         and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
2891         automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
2892         starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;        automatic setup is done when the starting point is either a
2893         local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
2894         has a tracking configuration, it is copied to the new
2895         branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
2896         is a remote-tracking branch and the new branch has the same name as the
2897         remote branch. This option defaults to true.
2898 </p>
2899 </dd>
2900 <dt class="hdlist1">
2901 branch.autoSetupRebase
2902 </dt>
2903 <dd>
2904 <p>
2905         When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
2906         that tracks another branch, this variable tells Git to set
2907         up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
2908         When <code>never</code>, rebase is never automatically set to true.
2909         When <code>local</code>, rebase is set to true for tracked branches of
2910         other local branches.
2911         When <code>remote</code>, rebase is set to true for tracked branches of
2912         remote-tracking branches.
2913         When <code>always</code>, rebase will be set to true for all tracking
2914         branches.
2915         See "branch.autoSetupMerge" for details on how to set up a
2916         branch to track another branch.
2917         This option defaults to never.
2918 </p>
2919 </dd>
2920 <dt class="hdlist1">
2921 branch.sort
2922 </dt>
2923 <dd>
2924 <p>
2925         This variable controls the sort ordering of branches when displayed by
2926         <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
2927         value of this variable will be used as the default.
2928         See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.
2929 </p>
2930 </dd>
2931 <dt class="hdlist1">
2932 branch.&lt;name&gt;.remote
2933 </dt>
2934 <dd>
2935 <p>
2936         When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
2937         which remote to fetch from or push to.  The remote to push to
2938         may be overridden with <code>remote.pushDefault</code> (for all branches).
2939         The remote to push to, for the current branch, may be further
2940         overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
2941         configured, or if you are not on any branch and there is more than
2942         one remote defined in the repository, it defaults to <code>origin</code> for
2943         fetching and <code>remote.pushDefault</code> for pushing.
2944         Additionally, <code>.</code> (a period) is the current local repository
2945         (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
2946 </p>
2947 </dd>
2948 <dt class="hdlist1">
2949 branch.&lt;name&gt;.pushRemote
2950 </dt>
2951 <dd>
2952 <p>
2953         When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
2954         pushing.  It also overrides <code>remote.pushDefault</code> for pushing
2955         from branch &lt;name&gt;.  When you pull from one place (e.g. your
2956         upstream) and push to another place (e.g. your own publishing
2957         repository), you would want to set <code>remote.pushDefault</code> to
2958         specify the remote to push to for all branches, and use this
2959         option to override it for a specific branch.
2960 </p>
2961 </dd>
2962 <dt class="hdlist1">
2963 branch.&lt;name&gt;.merge
2964 </dt>
2965 <dd>
2966 <p>
2967         Defines, together with branch.&lt;name&gt;.remote, the upstream branch
2968         for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
2969         branch to merge and can also affect <em>git push</em> (see push.default).
2970         When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
2971         refspec to be marked for merging in FETCH_HEAD. The value is
2972         handled like the remote part of a refspec, and must match a
2973         ref which is fetched from the remote given by
2974         "branch.&lt;name&gt;.remote".
2975         The merge information is used by <em>git pull</em> (which first calls
2976         <em>git fetch</em>) to lookup the default branch for merging. Without
2977         this option, <em>git pull</em> defaults to merge the first refspec fetched.
2978         Specify multiple values to get an octopus merge.
2979         If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
2980         another branch in the local repository, you can point
2981         branch.&lt;name&gt;.merge to the desired branch, and use the relative path
2982         setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
2983 </p>
2984 </dd>
2985 <dt class="hdlist1">
2986 branch.&lt;name&gt;.mergeOptions
2987 </dt>
2988 <dd>
2989 <p>
2990         Sets default options for merging into branch &lt;name&gt;. The syntax and
2991         supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
2992         option values containing whitespace characters are currently not
2993         supported.
2994 </p>
2995 </dd>
2996 <dt class="hdlist1">
2997 branch.&lt;name&gt;.rebase
2998 </dt>
2999 <dd>
3000 <p>
3001         When true, rebase the branch &lt;name&gt; on top of the fetched branch,
3002         instead of merging the default branch from the default remote when
3003         "git pull" is run. See "pull.rebase" for doing this in a non
3004         branch-specific manner.
3005 </p>
3006 <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>
3007 so that the local merge commits are included in the rebase (see
3008 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
3009 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
3010 mode.</p></div>
3011 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
3012 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
3013 for details).</p></div>
3014 </dd>
3015 <dt class="hdlist1">
3016 branch.&lt;name&gt;.description
3017 </dt>
3018 <dd>
3019 <p>
3020         Branch description, can be edited with
3021         <code>git branch --edit-description</code>. Branch description is
3022         automatically added to the format-patch cover letter or
3023         request-pull summary.
3024 </p>
3025 </dd>
3026 <dt class="hdlist1">
3027 browser.&lt;tool&gt;.cmd
3028 </dt>
3029 <dd>
3030 <p>
3031         Specify the command to invoke the specified browser. The
3032         specified command is evaluated in shell with the URLs passed
3033         as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
3034 </p>
3035 </dd>
3036 <dt class="hdlist1">
3037 browser.&lt;tool&gt;.path
3038 </dt>
3039 <dd>
3040 <p>
3041         Override the path for the given tool that may be used to
3042         browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
3043         working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
3044 </p>
3045 </dd>
3046 <dt class="hdlist1">
3047 bundle.*
3048 </dt>
3049 <dd>
3050 <p>
3051         The <code>bundle.*</code> keys may appear in a bundle list file found via the
3052         <code>git clone --bundle-uri</code> option. These keys currently have no effect
3053         if placed in a repository config file, though this will change in the
3054         future. See <a href="technical/bundle-uri.html">the bundle URI design
3055         document</a> for more details.
3056 </p>
3057 </dd>
3058 <dt class="hdlist1">
3059 bundle.version
3060 </dt>
3061 <dd>
3062 <p>
3063         This integer value advertises the version of the bundle list format
3064         used by the bundle list. Currently, the only accepted value is <code>1</code>.
3065 </p>
3066 </dd>
3067 <dt class="hdlist1">
3068 bundle.mode
3069 </dt>
3070 <dd>
3071 <p>
3072         This string value should be either <code>all</code> or <code>any</code>. This value describes
3073         whether all of the advertised bundles are required to unbundle a
3074         complete understanding of the bundled information (<code>all</code>) or if any one
3075         of the listed bundle URIs is sufficient (<code>any</code>).
3076 </p>
3077 </dd>
3078 <dt class="hdlist1">
3079 bundle.heuristic
3080 </dt>
3081 <dd>
3082 <p>
3083         If this string-valued key exists, then the bundle list is designed to
3084         work well with incremental <code>git fetch</code> commands. The heuristic signals
3085         that there are additional keys available for each bundle that help
3086         determine which subset of bundles the client should download. The
3087         only value currently understood is <code>creationToken</code>.
3088 </p>
3089 </dd>
3090 <dt class="hdlist1">
3091 bundle.&lt;id&gt;.*
3092 </dt>
3093 <dd>
3094 <p>
3095         The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
3096         bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.
3097 </p>
3098 </dd>
3099 <dt class="hdlist1">
3100 bundle.&lt;id&gt;.uri
3101 </dt>
3102 <dd>
3103 <p>
3104         This string value defines the URI by which Git can reach the contents
3105         of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.
3106 </p>
3107 </dd>
3108 <dt class="hdlist1">
3109 checkout.defaultRemote
3110 </dt>
3111 <dd>
3112 <p>
3113         When you run <code>git checkout &lt;something&gt;</code>
3114         or <code>git switch &lt;something&gt;</code> and only have one
3115         remote, it may implicitly fall back on checking out and
3116         tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
3117         as you have more than one remote with a <code>&lt;something&gt;</code>
3118         reference. This setting allows for setting the name of a
3119         preferred remote that should always win when it comes to
3120         disambiguation. The typical use-case is to set this to
3121         <code>origin</code>.
3122 </p>
3123 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
3124 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
3125 or <code>git switch &lt;something&gt;</code>
3126 will checkout the <code>&lt;something&gt;</code> branch on another remote,
3127 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
3128 remote branch. This setting might be used for other checkout-like
3129 commands or functionality in the future.</p></div>
3130 </dd>
3131 <dt class="hdlist1">
3132 checkout.guess
3133 </dt>
3134 <dd>
3135 <p>
3136         Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
3137         option in <code>git checkout</code> and <code>git switch</code>. See
3138         <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
3139 </p>
3140 </dd>
3141 <dt class="hdlist1">
3142 checkout.workers
3143 </dt>
3144 <dd>
3145 <p>
3146         The number of parallel workers to use when updating the working tree.
3147         The default is one, i.e. sequential execution. If set to a value less
3148         than one, Git will use as many workers as the number of logical cores
3149         available. This setting and <code>checkout.thresholdForParallelism</code> affect
3150         all commands that perform checkout. E.g. checkout, clone, reset,
3151         sparse-checkout, etc.
3152 </p>
3153 <div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories
3154 located on SSDs or over NFS. For repositories on spinning disks and/or machines
3155 with a small number of cores, the default sequential checkout often performs
3156 better. The size and compression level of a repository might also influence how
3157 well the parallel version performs.</p></div>
3158 </dd>
3159 <dt class="hdlist1">
3160 checkout.thresholdForParallelism
3161 </dt>
3162 <dd>
3163 <p>
3164         When running parallel checkout with a small number of files, the cost
3165         of subprocess spawning and inter-process communication might outweigh
3166         the parallelization gains. This setting allows you to define the minimum
3167         number of files for which parallel checkout should be attempted. The
3168         default is 100.
3169 </p>
3170 </dd>
3171 <dt class="hdlist1">
3172 clean.requireForce
3173 </dt>
3174 <dd>
3175 <p>
3176         A boolean to make git-clean refuse to delete files unless -f
3177         is given. Defaults to true.
3178 </p>
3179 </dd>
3180 <dt class="hdlist1">
3181 <code>clone.defaultRemoteName</code>
3182 </dt>
3183 <dd>
3184 <p>
3185         The name of the remote to create when cloning a repository.  Defaults to
3186         <code>origin</code>.
3187         It can be overridden by passing the <code>--origin</code> command-line
3188         option to <a href="git-clone.html">git-clone(1)</a>.
3189 </p>
3190 </dd>
3191 <dt class="hdlist1">
3192 <code>clone.rejectShallow</code>
3193 </dt>
3194 <dd>
3195 <p>
3196         Reject cloning a repository if it is a shallow one; this can be overridden by
3197         passing the <code>--reject-shallow</code> option on the command line.
3198         See <a href="git-clone.html">git-clone(1)</a>.
3199 </p>
3200 </dd>
3201 <dt class="hdlist1">
3202 <code>clone.filterSubmodules</code>
3203 </dt>
3204 <dd>
3205 <p>
3206         If a partial clone filter is provided (see <code>--filter</code> in
3207         <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
3208         the filter to submodules.
3209 </p>
3210 </dd>
3211 <dt class="hdlist1">
3212 color.advice
3213 </dt>
3214 <dd>
3215 <p>
3216         A boolean to enable/disable color in hints (e.g. when a push
3217         failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
3218         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
3219         are used only when the error output goes to a terminal. If
3220         unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3221 </p>
3222 </dd>
3223 <dt class="hdlist1">
3224 color.advice.hint
3225 </dt>
3226 <dd>
3227 <p>
3228         Use customized color for hints.
3229 </p>
3230 </dd>
3231 <dt class="hdlist1">
3232 color.blame.highlightRecent
3233 </dt>
3234 <dd>
3235 <p>
3236         Specify the line annotation color for <code>git blame --color-by-age</code>
3237         depending upon the age of the line.
3238 </p>
3239 <div class="paragraph"><p>This setting should be set to a comma-separated list of color and
3240 date settings, starting and ending with a color, the dates should be
3241 set from oldest to newest. The metadata will be colored with the
3242 specified colors if the line was introduced before the given
3243 timestamp, overwriting older timestamped colors.</p></div>
3244 <div class="paragraph"><p>Instead of an absolute timestamp relative timestamps work as well,
3245 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
3246 <div class="paragraph"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
3247 colors everything older than one year blue, recent changes between
3248 one month and one year old are kept white, and lines introduced
3249 within the last month are colored red.</p></div>
3250 </dd>
3251 <dt class="hdlist1">
3252 color.blame.repeatedLines
3253 </dt>
3254 <dd>
3255 <p>
3256         Use the specified color to colorize line annotations for
3257         <code>git blame --color-lines</code>, if they come from the same commit as the
3258         preceding line. Defaults to cyan.
3259 </p>
3260 </dd>
3261 <dt class="hdlist1">
3262 color.branch
3263 </dt>
3264 <dd>
3265 <p>
3266         A boolean to enable/disable color in the output of
3267         <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
3268         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3269         only when the output is to a terminal. If unset, then the
3270         value of <code>color.ui</code> is used (<code>auto</code> by default).
3271 </p>
3272 </dd>
3273 <dt class="hdlist1">
3274 color.branch.&lt;slot&gt;
3275 </dt>
3276 <dd>
3277 <p>
3278         Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
3279         <code>current</code> (the current branch), <code>local</code> (a local branch),
3280         <code>remote</code> (a remote-tracking branch in refs/remotes/),
3281         <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
3282         refs).
3283 </p>
3284 </dd>
3285 <dt class="hdlist1">
3286 color.diff
3287 </dt>
3288 <dd>
3289 <p>
3290         Whether to use ANSI escape sequences to add color to patches.
3291         If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
3292         <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
3293         for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
3294         commands will only use color when output is to the terminal.
3295         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
3296         default).
3297 </p>
3298 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
3299 <em>git-diff-&#42;</em> plumbing commands.  Can be overridden on the
3300 command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
3301 </dd>
3302 <dt class="hdlist1">
3303 color.diff.&lt;slot&gt;
3304 </dt>
3305 <dd>
3306 <p>
3307         Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
3308         which part of the patch to use the specified color, and is one
3309         of <code>context</code> (context text - <code>plain</code> is a historical synonym),
3310         <code>meta</code> (metainformation), <code>frag</code>
3311         (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
3312         <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
3313         (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
3314         <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
3315         <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
3316         <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
3317         setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
3318         <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
3319         <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).
3320 </p>
3321 </dd>
3322 <dt class="hdlist1">
3323 color.decorate.&lt;slot&gt;
3324 </dt>
3325 <dd>
3326 <p>
3327         Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
3328         of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
3329         branches, remote-tracking branches, tags, stash and HEAD, respectively
3330         and <code>grafted</code> for grafted commits.
3331 </p>
3332 </dd>
3333 <dt class="hdlist1">
3334 color.grep
3335 </dt>
3336 <dd>
3337 <p>
3338         When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
3339         <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
3340         when the output is written to the terminal.  If unset, then the
3341         value of <code>color.ui</code> is used (<code>auto</code> by default).
3342 </p>
3343 </dd>
3344 <dt class="hdlist1">
3345 color.grep.&lt;slot&gt;
3346 </dt>
3347 <dd>
3348 <p>
3349         Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
3350         part of the line to use the specified color, and is one of
3351 </p>
3352 <div class="openblock">
3353 <div class="content">
3354 <div class="dlist"><dl>
3355 <dt class="hdlist1">
3356 <code>context</code>
3357 </dt>
3358 <dd>
3359 <p>
3360         non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
3361 </p>
3362 </dd>
3363 <dt class="hdlist1">
3364 <code>filename</code>
3365 </dt>
3366 <dd>
3367 <p>
3368         filename prefix (when not using <code>-h</code>)
3369 </p>
3370 </dd>
3371 <dt class="hdlist1">
3372 <code>function</code>
3373 </dt>
3374 <dd>
3375 <p>
3376         function name lines (when using <code>-p</code>)
3377 </p>
3378 </dd>
3379 <dt class="hdlist1">
3380 <code>lineNumber</code>
3381 </dt>
3382 <dd>
3383 <p>
3384         line number prefix (when using <code>-n</code>)
3385 </p>
3386 </dd>
3387 <dt class="hdlist1">
3388 <code>column</code>
3389 </dt>
3390 <dd>
3391 <p>
3392         column number prefix (when using <code>--column</code>)
3393 </p>
3394 </dd>
3395 <dt class="hdlist1">
3396 <code>match</code>
3397 </dt>
3398 <dd>
3399 <p>
3400         matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
3401 </p>
3402 </dd>
3403 <dt class="hdlist1">
3404 <code>matchContext</code>
3405 </dt>
3406 <dd>
3407 <p>
3408         matching text in context lines
3409 </p>
3410 </dd>
3411 <dt class="hdlist1">
3412 <code>matchSelected</code>
3413 </dt>
3414 <dd>
3415 <p>
3416         matching text in selected lines. Also, used to customize the following
3417         <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.
3418 </p>
3419 </dd>
3420 <dt class="hdlist1">
3421 <code>selected</code>
3422 </dt>
3423 <dd>
3424 <p>
3425         non-matching text in selected lines. Also, used to customize the
3426         following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
3427         <code>--committer</code>.
3428 </p>
3429 </dd>
3430 <dt class="hdlist1">
3431 <code>separator</code>
3432 </dt>
3433 <dd>
3434 <p>
3435         separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
3436         and between hunks (<code>--</code>)
3437 </p>
3438 </dd>
3439 </dl></div>
3440 </div></div>
3441 </dd>
3442 <dt class="hdlist1">
3443 color.interactive
3444 </dt>
3445 <dd>
3446 <p>
3447         When set to <code>always</code>, always use colors for interactive prompts
3448         and displays (such as those used by "git-add --interactive" and
3449         "git-clean --interactive"). When false (or <code>never</code>), never.
3450         When set to <code>true</code> or <code>auto</code>, use colors only when the output is
3451         to the terminal. If unset, then the value of <code>color.ui</code> is
3452         used (<code>auto</code> by default).
3453 </p>
3454 </dd>
3455 <dt class="hdlist1">
3456 color.interactive.&lt;slot&gt;
3457 </dt>
3458 <dd>
3459 <p>
3460         Use customized color for <em>git add --interactive</em> and <em>git clean
3461         --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
3462         or <code>error</code>, for four distinct types of normal output from
3463         interactive commands.
3464 </p>
3465 </dd>
3466 <dt class="hdlist1">
3467 color.pager
3468 </dt>
3469 <dd>
3470 <p>
3471         A boolean to specify whether <code>auto</code> color modes should colorize
3472         output going to the pager. Defaults to true; set this to false
3473         if your pager does not understand ANSI color codes.
3474 </p>
3475 </dd>
3476 <dt class="hdlist1">
3477 color.push
3478 </dt>
3479 <dd>
3480 <p>
3481         A boolean to enable/disable color in push errors. May be set to
3482         <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3483         case colors are used only when the error output goes to a terminal.
3484         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3485 </p>
3486 </dd>
3487 <dt class="hdlist1">
3488 color.push.error
3489 </dt>
3490 <dd>
3491 <p>
3492         Use customized color for push errors.
3493 </p>
3494 </dd>
3495 <dt class="hdlist1">
3496 color.remote
3497 </dt>
3498 <dd>
3499 <p>
3500         If set, keywords at the start of the line are highlighted. The
3501         keywords are "error", "warning", "hint" and "success", and are
3502         matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
3503         <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
3504         <code>color.ui</code> is used (<code>auto</code> by default).
3505 </p>
3506 </dd>
3507 <dt class="hdlist1">
3508 color.remote.&lt;slot&gt;
3509 </dt>
3510 <dd>
3511 <p>
3512         Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
3513         <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
3514         corresponding keyword.
3515 </p>
3516 </dd>
3517 <dt class="hdlist1">
3518 color.showBranch
3519 </dt>
3520 <dd>
3521 <p>
3522         A boolean to enable/disable color in the output of
3523         <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
3524         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3525         only when the output is to a terminal. If unset, then the
3526         value of <code>color.ui</code> is used (<code>auto</code> by default).
3527 </p>
3528 </dd>
3529 <dt class="hdlist1">
3530 color.status
3531 </dt>
3532 <dd>
3533 <p>
3534         A boolean to enable/disable color in the output of
3535         <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
3536         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3537         only when the output is to a terminal. If unset, then the
3538         value of <code>color.ui</code> is used (<code>auto</code> by default).
3539 </p>
3540 </dd>
3541 <dt class="hdlist1">
3542 color.status.&lt;slot&gt;
3543 </dt>
3544 <dd>
3545 <p>
3546         Use customized color for status colorization. <code>&lt;slot&gt;</code> is
3547         one of <code>header</code> (the header text of the status message),
3548         <code>added</code> or <code>updated</code> (files which are added but not committed),
3549         <code>changed</code> (files which are changed but not added in the index),
3550         <code>untracked</code> (files which are not tracked by Git),
3551         <code>branch</code> (the current branch),
3552         <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
3553         to red),
3554         <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
3555         respectively, when branch and tracking information is displayed in the
3556         status short-format), or
3557         <code>unmerged</code> (files which have unmerged changes).
3558 </p>
3559 </dd>
3560 <dt class="hdlist1">
3561 color.transport
3562 </dt>
3563 <dd>
3564 <p>
3565         A boolean to enable/disable color when pushes are rejected. May be
3566         set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3567         case colors are used only when the error output goes to a terminal.
3568         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3569 </p>
3570 </dd>
3571 <dt class="hdlist1">
3572 color.transport.rejected
3573 </dt>
3574 <dd>
3575 <p>
3576         Use customized color when a push was rejected.
3577 </p>
3578 </dd>
3579 <dt class="hdlist1">
3580 color.ui
3581 </dt>
3582 <dd>
3583 <p>
3584         This variable determines the default value for variables such
3585         as <code>color.diff</code> and <code>color.grep</code> that control the use of color
3586         per command family. Its scope will expand as more commands learn
3587         configuration to set a default for the <code>--color</code> option.  Set it
3588         to <code>false</code> or <code>never</code> if you prefer Git commands not to use
3589         color unless enabled explicitly with some other configuration
3590         or the <code>--color</code> option. Set it to <code>always</code> if you want all
3591         output not intended for machine consumption to use color, to
3592         <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
3593         want such output to use color when written to the terminal.
3594 </p>
3595 </dd>
3596 <dt class="hdlist1">
3597 column.ui
3598 </dt>
3599 <dd>
3600 <p>
3601         Specify whether supported commands should output in columns.
3602         This variable consists of a list of tokens separated by spaces
3603         or commas:
3604 </p>
3605 <div class="paragraph"><p>These options control when the feature should be enabled
3606 (defaults to <em>never</em>):</p></div>
3607 <div class="openblock">
3608 <div class="content">
3609 <div class="dlist"><dl>
3610 <dt class="hdlist1">
3611 <code>always</code>
3612 </dt>
3613 <dd>
3614 <p>
3615         always show in columns
3616 </p>
3617 </dd>
3618 <dt class="hdlist1">
3619 <code>never</code>
3620 </dt>
3621 <dd>
3622 <p>
3623         never show in columns
3624 </p>
3625 </dd>
3626 <dt class="hdlist1">
3627 <code>auto</code>
3628 </dt>
3629 <dd>
3630 <p>
3631         show in columns if the output is to the terminal
3632 </p>
3633 </dd>
3634 </dl></div>
3635 </div></div>
3636 <div class="paragraph"><p>These options control layout (defaults to <em>column</em>).  Setting any
3637 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
3638 specified.</p></div>
3639 <div class="openblock">
3640 <div class="content">
3641 <div class="dlist"><dl>
3642 <dt class="hdlist1">
3643 <code>column</code>
3644 </dt>
3645 <dd>
3646 <p>
3647         fill columns before rows
3648 </p>
3649 </dd>
3650 <dt class="hdlist1">
3651 <code>row</code>
3652 </dt>
3653 <dd>
3654 <p>
3655         fill rows before columns
3656 </p>
3657 </dd>
3658 <dt class="hdlist1">
3659 <code>plain</code>
3660 </dt>
3661 <dd>
3662 <p>
3663         show in one column
3664 </p>
3665 </dd>
3666 </dl></div>
3667 </div></div>
3668 <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
3669 to <em>nodense</em>):</p></div>
3670 <div class="openblock">
3671 <div class="content">
3672 <div class="dlist"><dl>
3673 <dt class="hdlist1">
3674 <code>dense</code>
3675 </dt>
3676 <dd>
3677 <p>
3678         make unequal size columns to utilize more space
3679 </p>
3680 </dd>
3681 <dt class="hdlist1">
3682 <code>nodense</code>
3683 </dt>
3684 <dd>
3685 <p>
3686         make equal size columns
3687 </p>
3688 </dd>
3689 </dl></div>
3690 </div></div>
3691 </dd>
3692 <dt class="hdlist1">
3693 column.branch
3694 </dt>
3695 <dd>
3696 <p>
3697         Specify whether to output branch listing in <code>git branch</code> in columns.
3698         See <code>column.ui</code> for details.
3699 </p>
3700 </dd>
3701 <dt class="hdlist1">
3702 column.clean
3703 </dt>
3704 <dd>
3705 <p>
3706         Specify the layout when listing items in <code>git clean -i</code>, which always
3707         shows files and directories in columns. See <code>column.ui</code> for details.
3708 </p>
3709 </dd>
3710 <dt class="hdlist1">
3711 column.status
3712 </dt>
3713 <dd>
3714 <p>
3715         Specify whether to output untracked files in <code>git status</code> in columns.
3716         See <code>column.ui</code> for details.
3717 </p>
3718 </dd>
3719 <dt class="hdlist1">
3720 column.tag
3721 </dt>
3722 <dd>
3723 <p>
3724         Specify whether to output tag listings in <code>git tag</code> in columns.
3725         See <code>column.ui</code> for details.
3726 </p>
3727 </dd>
3728 <dt class="hdlist1">
3729 commit.cleanup
3730 </dt>
3731 <dd>
3732 <p>
3733         This setting overrides the default of the <code>--cleanup</code> option in
3734         <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
3735         default can be useful when you always want to keep lines that begin
3736         with the comment character <code>#</code> in your log message, in which case you
3737         would do <code>git config commit.cleanup whitespace</code> (note that you will
3738         have to remove the help lines that begin with <code>#</code> in the commit log
3739         template yourself, if you do this).
3740 </p>
3741 </dd>
3742 <dt class="hdlist1">
3743 commit.gpgSign
3744 </dt>
3745 <dd>
3746 <p>
3747         A boolean to specify whether all commits should be GPG signed.
3748         Use of this option when doing operations such as rebase can
3749         result in a large number of commits being signed. It may be
3750         convenient to use an agent to avoid typing your GPG passphrase
3751         several times.
3752 </p>
3753 </dd>
3754 <dt class="hdlist1">
3755 commit.status
3756 </dt>
3757 <dd>
3758 <p>
3759         A boolean to enable/disable inclusion of status information in the
3760         commit message template when using an editor to prepare the commit
3761         message.  Defaults to true.
3762 </p>
3763 </dd>
3764 <dt class="hdlist1">
3765 commit.template
3766 </dt>
3767 <dd>
3768 <p>
3769         Specify the pathname of a file to use as the template for
3770         new commit messages.
3771 </p>
3772 </dd>
3773 <dt class="hdlist1">
3774 commit.verbose
3775 </dt>
3776 <dd>
3777 <p>
3778         A boolean or int to specify the level of verbosity with <code>git commit</code>.
3779         See <a href="git-commit.html">git-commit(1)</a>.
3780 </p>
3781 </dd>
3782 <dt class="hdlist1">
3783 commitGraph.generationVersion
3784 </dt>
3785 <dd>
3786 <p>
3787         Specifies the type of generation number version to use when writing
3788         or reading the commit-graph file. If version 1 is specified, then
3789         the corrected commit dates will not be written or read. Defaults to
3790         2.
3791 </p>
3792 </dd>
3793 <dt class="hdlist1">
3794 commitGraph.maxNewFilters
3795 </dt>
3796 <dd>
3797 <p>
3798         Specifies the default value for the <code>--max-new-filters</code> option of <code>git
3799         commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).
3800 </p>
3801 </dd>
3802 <dt class="hdlist1">
3803 commitGraph.readChangedPaths
3804 </dt>
3805 <dd>
3806 <p>
3807         Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if true, and
3808         commitGraph.changedPathsVersion=0 if false. (If commitGraph.changedPathVersion
3809         is also set, commitGraph.changedPathsVersion takes precedence.)
3810 </p>
3811 </dd>
3812 <dt class="hdlist1">
3813 commitGraph.changedPathsVersion
3814 </dt>
3815 <dd>
3816 <p>
3817         Specifies the version of the changed-path Bloom filters that Git will read and
3818         write. May be -1, 0, 1, or 2. Note that values greater than 1 may be
3819         incompatible with older versions of Git which do not yet understand
3820         those versions. Use caution when operating in a mixed-version
3821         environment.
3822 </p>
3823 <div class="paragraph"><p>Defaults to -1.</p></div>
3824 <div class="paragraph"><p>If -1, Git will use the version of the changed-path Bloom filters in the
3825 repository, defaulting to 1 if there are none.</p></div>
3826 <div class="paragraph"><p>If 0, Git will not read any Bloom filters, and will write version 1 Bloom
3827 filters when instructed to write.</p></div>
3828 <div class="paragraph"><p>If 1, Git will only read version 1 Bloom filters, and will write version 1
3829 Bloom filters.</p></div>
3830 <div class="paragraph"><p>If 2, Git will only read version 2 Bloom filters, and will write version 2
3831 Bloom filters.</p></div>
3832 <div class="paragraph"><p>See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.</p></div>
3833 </dd>
3834 <dt class="hdlist1">
3835 completion.commands
3836 </dt>
3837 <dd>
3838 <p>
3839         This is only used by git-completion.bash to add or remove
3840         commands from the list of completed commands. Normally only
3841         porcelain commands and a few select others are completed. You
3842         can add more commands, separated by space, in this
3843         variable. Prefixing the command with <em>-</em> will remove it from
3844         the existing list.
3845 </p>
3846 </dd>
3847 <dt class="hdlist1">
3848 core.fileMode
3849 </dt>
3850 <dd>
3851 <p>
3852         Tells Git if the executable bit of files in the working tree
3853         is to be honored.
3854 </p>
3855 <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
3856 marked as executable is checked out, or checks out a
3857 non-executable file with executable bit on.
3858 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
3859 to see if it handles the executable bit correctly
3860 and this variable is automatically set as necessary.</p></div>
3861 <div class="paragraph"><p>A repository, however, may be on a filesystem that handles
3862 the filemode correctly, and this variable is set to <em>true</em>
3863 when created, but later may be made accessible from another
3864 environment that loses the filemode (e.g. exporting ext4 via
3865 CIFS mount, visiting a Cygwin created repository with
3866 Git for Windows or Eclipse).
3867 In such a case it may be necessary to set this variable to <em>false</em>.
3868 See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
3869 <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
3870 </dd>
3871 <dt class="hdlist1">
3872 core.hideDotFiles
3873 </dt>
3874 <dd>
3875 <p>
3876         (Windows-only) If true, mark newly-created directories and files whose
3877         name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
3878         directory is hidden, but no other files starting with a dot.  The
3879         default mode is <em>dotGitOnly</em>.
3880 </p>
3881 </dd>
3882 <dt class="hdlist1">
3883 core.ignoreCase
3884 </dt>
3885 <dd>
3886 <p>
3887         Internal variable which enables various workarounds to enable
3888         Git to work better on filesystems that are not case sensitive,
3889         like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
3890         finds "makefile" when Git expects "Makefile", Git will assume
3891         it is really the same file, and continue to remember it as
3892         "Makefile".
3893 </p>
3894 <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>
3895 will probe and set core.ignoreCase true if appropriate when the repository
3896 is created.</p></div>
3897 <div class="paragraph"><p>Git relies on the proper configuration of this variable for your operating
3898 and file system. Modifying this value may result in unexpected behavior.</p></div>
3899 </dd>
3900 <dt class="hdlist1">
3901 core.precomposeUnicode
3902 </dt>
3903 <dd>
3904 <p>
3905         This option is only used by Mac OS implementation of Git.
3906         When core.precomposeUnicode=true, Git reverts the unicode decomposition
3907         of filenames done by Mac OS. This is useful when sharing a repository
3908         between Mac OS and Linux or Windows.
3909         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
3910         When false, file names are handled fully transparent by Git,
3911         which is backward compatible with older versions of Git.
3912 </p>
3913 </dd>
3914 <dt class="hdlist1">
3915 core.protectHFS
3916 </dt>
3917 <dd>
3918 <p>
3919         If set to true, do not allow checkout of paths that would
3920         be considered equivalent to <code>.git</code> on an HFS+ filesystem.
3921         Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
3922 </p>
3923 </dd>
3924 <dt class="hdlist1">
3925 core.protectNTFS
3926 </dt>
3927 <dd>
3928 <p>
3929         If set to true, do not allow checkout of paths that would
3930         cause problems with the NTFS filesystem, e.g. conflict with
3931         8.3 "short" names.
3932         Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
3933 </p>
3934 </dd>
3935 <dt class="hdlist1">
3936 core.fsmonitor
3937 </dt>
3938 <dd>
3939 <p>
3940         If set to true, enable the built-in file system monitor
3941         daemon for this working directory (<a href="git-fsmonitor&#45;&#45;daemon.html">git-fsmonitor&#45;&#45;daemon(1)</a>).
3942 </p>
3943 <div class="paragraph"><p>Like hook-based file system monitors, the built-in file system monitor
3944 can speed up Git commands that need to refresh the Git index
3945 (e.g. <code>git status</code>) in a working directory with many files.  The
3946 built-in monitor eliminates the need to install and maintain an
3947 external third-party tool.</p></div>
3948 <div class="paragraph"><p>The built-in file system monitor is currently available only on a
3949 limited set of supported platforms.  Currently, this includes Windows
3950 and MacOS.</p></div>
3951 <div class="literalblock">
3952 <div class="content">
3953 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor"
3954 hook command.</code></pre>
3955 </div></div>
3956 <div class="paragraph"><p>This hook command is used to identify all files that may have changed
3957 since the requested date/time. This information is used to speed up
3958 git by avoiding unnecessary scanning of files that have not changed.</p></div>
3959 <div class="paragraph"><p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p></div>
3960 <div class="paragraph"><p>Note that if you concurrently use multiple versions of Git, such
3961 as one version on the command line and another version in an IDE
3962 tool, that the definition of <code>core.fsmonitor</code> was extended to
3963 allow boolean values in addition to hook pathnames.  Git versions
3964 2.35.1 and prior will not understand the boolean values and will
3965 consider the "true" or "false" values as hook pathnames to be
3966 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
3967 V2 and will fall back to no fsmonitor (full scan).  Git versions
3968 prior to 2.26 default to hook protocol V1 and will silently
3969 assume there were no changes to report (no scan), so status
3970 commands may report incomplete results.  For this reason, it is
3971 best to upgrade all of your Git versions before using the built-in
3972 file system monitor.</p></div>
3973 </dd>
3974 <dt class="hdlist1">
3975 core.fsmonitorHookVersion
3976 </dt>
3977 <dd>
3978 <p>
3979         Sets the protocol version to be used when invoking the
3980         "fsmonitor" hook.
3981 </p>
3982 <div class="paragraph"><p>There are currently versions 1 and 2. When this is not set,
3983 version 2 will be tried first and if it fails then version 1
3984 will be tried. Version 1 uses a timestamp as input to determine
3985 which files have changes since that time but some monitors
3986 like Watchman have race conditions when used with a timestamp.
3987 Version 2 uses an opaque string so that the monitor can return
3988 something that can be used to determine what files have changed
3989 without race conditions.</p></div>
3990 </dd>
3991 <dt class="hdlist1">
3992 core.trustctime
3993 </dt>
3994 <dd>
3995 <p>
3996         If false, the ctime differences between the index and the
3997         working tree are ignored; useful when the inode change time
3998         is regularly modified by something outside Git (file system
3999         crawlers and some backup systems).
4000         See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
4001 </p>
4002 </dd>
4003 <dt class="hdlist1">
4004 core.splitIndex
4005 </dt>
4006 <dd>
4007 <p>
4008         If true, the split-index feature of the index will be used.
4009         See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
4010 </p>
4011 </dd>
4012 <dt class="hdlist1">
4013 core.untrackedCache
4014 </dt>
4015 <dd>
4016 <p>
4017         Determines what to do about the untracked cache feature of the
4018         index. It will be kept, if this variable is unset or set to
4019         <code>keep</code>. It will automatically be added if set to <code>true</code>. And
4020         it will automatically be removed, if set to <code>false</code>. Before
4021         setting it to <code>true</code>, you should check that mtime is working
4022         properly on your system.
4023         See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
4024         <code>feature.manyFiles</code> is enabled which sets this setting to
4025         <code>true</code> by default.
4026 </p>
4027 </dd>
4028 <dt class="hdlist1">
4029 core.checkStat
4030 </dt>
4031 <dd>
4032 <p>
4033         When missing or is set to <code>default</code>, many fields in the stat
4034         structure are checked to detect if a file has been modified
4035         since Git looked at it.  When this configuration variable is
4036         set to <code>minimal</code>, sub-second part of mtime and ctime, the
4037         uid and gid of the owner of the file, the inode number (and
4038         the device number, if Git was compiled to use it), are
4039         excluded from the check among these fields, leaving only the
4040         whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
4041         is set) and the filesize to be checked.
4042 </p>
4043 <div class="paragraph"><p>There are implementations of Git that do not leave usable values in
4044 some fields (e.g. JGit); by excluding these fields from the
4045 comparison, the <code>minimal</code> mode may help interoperability when the
4046 same repository is used by these other systems at the same time.</p></div>
4047 </dd>
4048 <dt class="hdlist1">
4049 core.quotePath
4050 </dt>
4051 <dd>
4052 <p>
4053         Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
4054         quote "unusual" characters in the pathname by enclosing the
4055         pathname in double-quotes and escaping those characters with
4056         backslashes in the same way C escapes control characters (e.g.
4057         <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
4058         values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
4059         UTF-8).  If this variable is set to false, bytes higher than
4060         0x80 are not considered "unusual" any more. Double-quotes,
4061         backslash and control characters are always escaped regardless
4062         of the setting of this variable.  A simple space character is
4063         not considered "unusual".  Many commands can output pathnames
4064         completely verbatim using the <code>-z</code> option. The default value
4065         is true.
4066 </p>
4067 </dd>
4068 <dt class="hdlist1">
4069 core.eol
4070 </dt>
4071 <dd>
4072 <p>
4073         Sets the line ending type to use in the working directory for
4074         files that are marked as text (either by having the <code>text</code>
4075         attribute set, or by having <code>text=auto</code> and Git auto-detecting
4076         the contents as text).
4077         Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
4078         native line ending.  The default value is <code>native</code>.  See
4079         <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
4080         conversion. Note that this value is ignored if <code>core.autocrlf</code>
4081         is set to <code>true</code> or <code>input</code>.
4082 </p>
4083 </dd>
4084 <dt class="hdlist1">
4085 core.safecrlf
4086 </dt>
4087 <dd>
4088 <p>
4089         If true, makes Git check if converting <code>CRLF</code> is reversible when
4090         end-of-line conversion is active.  Git will verify if a command
4091         modifies a file in the work tree either directly or indirectly.
4092         For example, committing a file followed by checking out the
4093         same file should yield the original file in the work tree.  If
4094         this is not the case for the current setting of
4095         <code>core.autocrlf</code>, Git will reject the file.  The variable can
4096         be set to "warn", in which case Git will only warn about an
4097         irreversible conversion but continue the operation.
4098 </p>
4099 <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
4100 When it is enabled, Git will convert CRLF to LF during commit and LF to
4101 CRLF during checkout.  A file that contains a mixture of LF and
4102 CRLF before the commit cannot be recreated by Git.  For text
4103 files this is the right thing to do: it corrects line endings
4104 such that we have only LF line endings in the repository.
4105 But for binary files that are accidentally classified as text the
4106 conversion can corrupt data.</p></div>
4107 <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
4108 setting the conversion type explicitly in .gitattributes.  Right
4109 after committing you still have the original file in your work
4110 tree and this file is not yet corrupted.  You can explicitly tell
4111 Git that this file is binary and Git will handle the file
4112 appropriately.</p></div>
4113 <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
4114 mixed line endings and the undesired effect of corrupting binary
4115 files cannot be distinguished.  In both cases CRLFs are removed
4116 in an irreversible way.  For text files this is the right thing
4117 to do because CRLFs are line endings, while for binary files
4118 converting CRLFs corrupts data.</p></div>
4119 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
4120 file identical to the original file for a different setting of
4121 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
4122 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
4123 and could later be checked out with <code>core.eol=crlf</code>, in which case the
4124 resulting file would contain <code>CRLF</code>, although the original file
4125 contained <code>LF</code>.  However, in both work trees the line endings would be
4126 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
4127 file with mixed line endings would be reported by the <code>core.safecrlf</code>
4128 mechanism.</p></div>
4129 </dd>
4130 <dt class="hdlist1">
4131 core.autocrlf
4132 </dt>
4133 <dd>
4134 <p>
4135         Setting this variable to "true" is the same as setting
4136         the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
4137         Set to true if you want to have <code>CRLF</code> line endings in your
4138         working directory and the repository has LF line endings.
4139         This variable can be set to <em>input</em>,
4140         in which case no output conversion is performed.
4141 </p>
4142 </dd>
4143 <dt class="hdlist1">
4144 core.checkRoundtripEncoding
4145 </dt>
4146 <dd>
4147 <p>
4148         A comma and/or whitespace separated list of encodings that Git
4149         performs UTF-8 round trip checks on if they are used in an
4150         <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
4151         The default value is <code>SHIFT-JIS</code>.
4152 </p>
4153 </dd>
4154 <dt class="hdlist1">
4155 core.symlinks
4156 </dt>
4157 <dd>
4158 <p>
4159         If false, symbolic links are checked out as small plain files that
4160         contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
4161         <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
4162         file. Useful on filesystems like FAT that do not support
4163         symbolic links.
4164 </p>
4165 <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>
4166 will probe and set core.symlinks false if appropriate when the repository
4167 is created.</p></div>
4168 </dd>
4169 <dt class="hdlist1">
4170 core.gitProxy
4171 </dt>
4172 <dd>
4173 <p>
4174         A "proxy command" to execute (as <em>command host port</em>) instead
4175         of establishing direct connection to the remote server when
4176         using the Git protocol for fetching. If the variable value is
4177         in the "COMMAND for DOMAIN" format, the command is applied only
4178         on hostnames ending with the specified domain string. This variable
4179         may be set multiple times and is matched in the given order;
4180         the first match wins.
4181 </p>
4182 <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
4183 (which always applies universally, without the special "for"
4184 handling).</p></div>
4185 <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
4186 specify that no proxy be used for a given domain pattern.
4187 This is useful for excluding servers inside a firewall from
4188 proxy use, while defaulting to a common proxy for external domains.</p></div>
4189 </dd>
4190 <dt class="hdlist1">
4191 core.sshCommand
4192 </dt>
4193 <dd>
4194 <p>
4195         If this variable is set, <code>git fetch</code> and <code>git push</code> will
4196         use the specified command instead of <code>ssh</code> when they need to
4197         connect to a remote system. The command is in the same form as
4198         the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
4199         when the environment variable is set.
4200 </p>
4201 </dd>
4202 <dt class="hdlist1">
4203 core.ignoreStat
4204 </dt>
4205 <dd>
4206 <p>
4207         If true, Git will avoid using lstat() calls to detect if files have
4208         changed by setting the "assume-unchanged" bit for those tracked files
4209         which it has updated identically in both the index and working tree.
4210 </p>
4211 <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
4212 the modified files explicitly (e.g. see <em>Examples</em> section in
4213 <a href="git-update-index.html">git-update-index(1)</a>).
4214 Git will not normally detect changes to those files.</p></div>
4215 <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
4216 CIFS/Microsoft Windows.</p></div>
4217 <div class="paragraph"><p>False by default.</p></div>
4218 </dd>
4219 <dt class="hdlist1">
4220 core.preferSymlinkRefs
4221 </dt>
4222 <dd>
4223 <p>
4224         Instead of the default "symref" format for HEAD
4225         and other symbolic reference files, use symbolic links.
4226         This is sometimes needed to work with old scripts that
4227         expect HEAD to be a symbolic link.
4228 </p>
4229 </dd>
4230 <dt class="hdlist1">
4231 core.alternateRefsCommand
4232 </dt>
4233 <dd>
4234 <p>
4235         When advertising tips of available history from an alternate, use the shell to
4236         execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
4237         first argument is the absolute path of the alternate. Output must contain one
4238         hex object id per line (i.e., the same as produced by <code>git for-each-ref
4239         --format='%(objectname)'</code>).
4240 </p>
4241 <div class="paragraph"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
4242 value, as it does not take a repository path as an argument (but you can wrap
4243 the command above in a shell script).</p></div>
4244 </dd>
4245 <dt class="hdlist1">
4246 core.alternateRefsPrefixes
4247 </dt>
4248 <dd>
4249 <p>
4250         When listing references from an alternate, list only references that begin
4251         with the given prefix. Prefixes match as if they were given as arguments to
4252         <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
4253         whitespace. If <code>core.alternateRefsCommand</code> is set, setting
4254         <code>core.alternateRefsPrefixes</code> has no effect.
4255 </p>
4256 </dd>
4257 <dt class="hdlist1">
4258 core.bare
4259 </dt>
4260 <dd>
4261 <p>
4262         If true this repository is assumed to be <em>bare</em> and has no
4263         working directory associated with it.  If this is the case a
4264         number of commands that require a working directory will be
4265         disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
4266 </p>
4267 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
4268 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
4269 repository that ends in "/.git" is assumed to be not bare (bare =
4270 false), while all other repositories are assumed to be bare (bare
4271 = true).</p></div>
4272 </dd>
4273 <dt class="hdlist1">
4274 core.worktree
4275 </dt>
4276 <dd>
4277 <p>
4278         Set the path to the root of the working tree.
4279         If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
4280         is ignored and not used for determining the root of working tree.
4281         This can be overridden by the <code>GIT_WORK_TREE</code> environment
4282         variable and the <code>--work-tree</code> command-line option.
4283         The value can be an absolute path or relative to the path to
4284         the .git directory, which is either specified by --git-dir
4285         or GIT_DIR, or automatically discovered.
4286         If --git-dir or GIT_DIR is specified but none of
4287         --work-tree, GIT_WORK_TREE and core.worktree is specified,
4288         the current working directory is regarded as the top level
4289         of your working tree.
4290 </p>
4291 <div class="paragraph"><p>Note that this variable is honored even when set in a configuration
4292 file in a ".git" subdirectory of a directory and its value differs
4293 from the latter directory (e.g. "/path/to/.git/config" has
4294 core.worktree set to "/different/path"), which is most likely a
4295 misconfiguration.  Running Git commands in the "/path/to" directory will
4296 still use "/different/path" as the root of the work tree and can cause
4297 confusion unless you know what you are doing (e.g. you are creating a
4298 read-only snapshot of the same index to a location different from the
4299 repository&#8217;s usual working tree).</p></div>
4300 </dd>
4301 <dt class="hdlist1">
4302 core.logAllRefUpdates
4303 </dt>
4304 <dd>
4305 <p>
4306         Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
4307         "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
4308         SHA-1, the date/time and the reason of the update, but
4309         only when the file exists.  If this configuration
4310         variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
4311         file is automatically created for branch heads (i.e. under
4312         <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
4313         note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
4314         If it is set to <code>always</code>, then a missing reflog is automatically
4315         created for any ref under <code>refs/</code>.
4316 </p>
4317 <div class="paragraph"><p>This information can be used to determine what commit
4318 was the tip of a branch "2 days ago".</p></div>
4319 <div class="paragraph"><p>This value is true by default in a repository that has
4320 a working directory associated with it, and false by
4321 default in a bare repository.</p></div>
4322 </dd>
4323 <dt class="hdlist1">
4324 core.repositoryFormatVersion
4325 </dt>
4326 <dd>
4327 <p>
4328         Internal variable identifying the repository format and layout
4329         version.
4330 </p>
4331 </dd>
4332 <dt class="hdlist1">
4333 core.sharedRepository
4334 </dt>
4335 <dd>
4336 <p>
4337         When <em>group</em> (or <em>true</em>), the repository is made shareable between
4338         several users in a group (making sure all the files and objects are
4339         group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
4340         repository will be readable by all users, additionally to being
4341         group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
4342         reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
4343         files in the repository will have this mode value. <em>0xxx</em> will override
4344         user&#8217;s umask value (whereas the other options will only override
4345         requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
4346         the repo read/write-able for the owner and group, but inaccessible to
4347         others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
4348         repository that is group-readable but not group-writable.
4349         See <a href="git-init.html">git-init(1)</a>. False by default.
4350 </p>
4351 </dd>
4352 <dt class="hdlist1">
4353 core.warnAmbiguousRefs
4354 </dt>
4355 <dd>
4356 <p>
4357         If true, Git will warn you if the ref name you passed it is ambiguous
4358         and might match multiple refs in the repository. True by default.
4359 </p>
4360 </dd>
4361 <dt class="hdlist1">
4362 core.compression
4363 </dt>
4364 <dd>
4365 <p>
4366         An integer -1..9, indicating a default compression level.
4367         -1 is the zlib default. 0 means no compression,
4368         and 1..9 are various speed/size tradeoffs, 9 being slowest.
4369         If set, this provides a default to other compression variables,
4370         such as <code>core.looseCompression</code> and <code>pack.compression</code>.
4371 </p>
4372 </dd>
4373 <dt class="hdlist1">
4374 core.looseCompression
4375 </dt>
4376 <dd>
4377 <p>
4378         An integer -1..9, indicating the compression level for objects that
4379         are not in a pack file. -1 is the zlib default. 0 means no
4380         compression, and 1..9 are various speed/size tradeoffs, 9 being
4381         slowest.  If not set,  defaults to core.compression.  If that is
4382         not set,  defaults to 1 (best speed).
4383 </p>
4384 </dd>
4385 <dt class="hdlist1">
4386 core.packedGitWindowSize
4387 </dt>
4388 <dd>
4389 <p>
4390         Number of bytes of a pack file to map into memory in a
4391         single mapping operation.  Larger window sizes may allow
4392         your system to process a smaller number of large pack files
4393         more quickly.  Smaller window sizes will negatively affect
4394         performance due to increased calls to the operating system&#8217;s
4395         memory manager, but may improve performance when accessing
4396         a large number of large pack files.
4397 </p>
4398 <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
4399 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
4400 be reasonable for all users/operating systems.  You probably do
4401 not need to adjust this value.</p></div>
4402 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4403 </dd>
4404 <dt class="hdlist1">
4405 core.packedGitLimit
4406 </dt>
4407 <dd>
4408 <p>
4409         Maximum number of bytes to map simultaneously into memory
4410         from pack files.  If Git needs to access more than this many
4411         bytes at once to complete an operation it will unmap existing
4412         regions to reclaim virtual address space within the process.
4413 </p>
4414 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
4415 unlimited) on 64 bit platforms.
4416 This should be reasonable for all users/operating systems, except on
4417 the largest projects.  You probably do not need to adjust this value.</p></div>
4418 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4419 </dd>
4420 <dt class="hdlist1">
4421 core.deltaBaseCacheLimit
4422 </dt>
4423 <dd>
4424 <p>
4425         Maximum number of bytes per thread to reserve for caching base objects
4426         that may be referenced by multiple deltified objects.  By storing the
4427         entire decompressed base objects in a cache Git is able
4428         to avoid unpacking and decompressing frequently used base
4429         objects multiple times.
4430 </p>
4431 <div class="paragraph"><p>Default is 96 MiB on all platforms.  This should be reasonable
4432 for all users/operating systems, except on the largest projects.
4433 You probably do not need to adjust this value.</p></div>
4434 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4435 </dd>
4436 <dt class="hdlist1">
4437 core.bigFileThreshold
4438 </dt>
4439 <dd>
4440 <p>
4441         The size of files considered "big", which as discussed below
4442         changes the behavior of numerous git commands, as well as how
4443         such files are stored within the repository. The default is
4444         512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
4445         supported.
4446 </p>
4447 <div class="paragraph"><p>Files above the configured limit will be:</p></div>
4448 <div class="ulist"><ul>
4449 <li>
4450 <p>
4451 Stored deflated in packfiles, without attempting delta compression.
4452 </p>
4453 <div class="paragraph"><p>The default limit is primarily set with this use-case in mind. With it,
4454 most projects will have their source code and other text files delta
4455 compressed, but not larger binary media files.</p></div>
4456 <div class="paragraph"><p>Storing large files without delta compression avoids excessive memory
4457 usage, at the slight expense of increased disk usage.</p></div>
4458 </li>
4459 <li>
4460 <p>
4461 Will be treated as if they were labeled "binary" (see
4462   <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
4463   <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.
4464 </p>
4465 </li>
4466 <li>
4467 <p>
4468 Will generally be streamed when written, which avoids excessive
4469 memory usage, at the cost of some fixed overhead. Commands that make
4470 use of this include <a href="git-archive.html">git-archive(1)</a>,
4471 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
4472 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.
4473 </p>
4474 </li>
4475 </ul></div>
4476 </dd>
4477 <dt class="hdlist1">
4478 core.excludesFile
4479 </dt>
4480 <dd>
4481 <p>
4482         Specifies the pathname to the file that contains patterns to
4483         describe paths that are not meant to be tracked, in addition
4484         to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
4485         Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
4486         If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
4487         is used instead. See <a href="gitignore.html">gitignore(5)</a>.
4488 </p>
4489 </dd>
4490 <dt class="hdlist1">
4491 core.askPass
4492 </dt>
4493 <dd>
4494 <p>
4495         Some commands (e.g. svn and http interfaces) that interactively
4496         ask for a password can be told to use an external program given
4497         via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
4498         environment variable. If not set, fall back to the value of the
4499         <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
4500         prompt. The external program shall be given a suitable prompt as
4501         command-line argument and write the password on its STDOUT.
4502 </p>
4503 </dd>
4504 <dt class="hdlist1">
4505 core.attributesFile
4506 </dt>
4507 <dd>
4508 <p>
4509         In addition to <code>.gitattributes</code> (per-directory) and
4510         <code>.git/info/attributes</code>, Git looks into this file for attributes
4511         (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
4512         way as for <code>core.excludesFile</code>. Its default value is
4513         <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
4514         set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
4515 </p>
4516 </dd>
4517 <dt class="hdlist1">
4518 core.hooksPath
4519 </dt>
4520 <dd>
4521 <p>
4522         By default Git will look for your hooks in the
4523         <code>$GIT_DIR/hooks</code> directory. Set this to different path,
4524         e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
4525         that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
4526         in <code>$GIT_DIR/hooks/pre-receive</code>.
4527 </p>
4528 <div class="paragraph"><p>The path can be either absolute or relative. A relative path is
4529 taken as relative to the directory where the hooks are run (see
4530 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
4531 <div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
4532 centrally configure your Git hooks instead of configuring them on a
4533 per-repository basis, or as a more flexible and centralized
4534 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
4535 default hooks.</p></div>
4536 </dd>
4537 <dt class="hdlist1">
4538 core.editor
4539 </dt>
4540 <dd>
4541 <p>
4542         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4543         messages by launching an editor use the value of this
4544         variable when it is set, and the environment variable
4545         <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.
4546 </p>
4547 </dd>
4548 <dt class="hdlist1">
4549 core.commentChar
4550 </dt>
4551 <dt class="hdlist1">
4552 core.commentString
4553 </dt>
4554 <dd>
4555 <p>
4556         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4557         messages consider a line that begins with this character
4558         commented, and removes them after the editor returns
4559         (default <em>#</em>).
4560 </p>
4561 <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
4562 the beginning character of any line in existing commit messages.</p></div>
4563 <div class="paragraph"><p>Note that these two variables are aliases of each other, and in modern
4564 versions of Git you are free to use a string (e.g., <code>//</code> or <code>⁑⁕⁑</code>) with
4565 <code>commentChar</code>. Versions of Git prior to v2.45.0 will ignore
4566 <code>commentString</code> but will reject a value of <code>commentChar</code> that consists
4567 of more than a single ASCII byte. If you plan to use your config with
4568 older and newer versions of Git, you may want to specify both:</p></div>
4569 <div class="literalblock">
4570 <div class="content">
4571 <pre><code>[core]
4572 # single character for older versions
4573 commentChar = "#"
4574 # string for newer versions (which will override commentChar
4575 # because it comes later in the file)
4576 commentString = "//"</code></pre>
4577 </div></div>
4578 </dd>
4579 <dt class="hdlist1">
4580 core.filesRefLockTimeout
4581 </dt>
4582 <dd>
4583 <p>
4584         The length of time, in milliseconds, to retry when trying to
4585         lock an individual reference. Value 0 means not to retry at
4586         all; -1 means to try indefinitely. Default is 100 (i.e.,
4587         retry for 100ms).
4588 </p>
4589 </dd>
4590 <dt class="hdlist1">
4591 core.packedRefsTimeout
4592 </dt>
4593 <dd>
4594 <p>
4595         The length of time, in milliseconds, to retry when trying to
4596         lock the <code>packed-refs</code> file. Value 0 means not to retry at
4597         all; -1 means to try indefinitely. Default is 1000 (i.e.,
4598         retry for 1 second).
4599 </p>
4600 </dd>
4601 <dt class="hdlist1">
4602 core.pager
4603 </dt>
4604 <dd>
4605 <p>
4606         Text viewer for use by Git commands (e.g., <em>less</em>).  The value
4607         is meant to be interpreted by the shell.  The order of preference
4608         is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
4609         configuration, then <code>$PAGER</code>, and then the default chosen at
4610         compile time (usually <em>less</em>).
4611 </p>
4612 <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
4613 (if <code>LESS</code> environment variable is set, Git does not change it at
4614 all).  If you want to selectively override Git&#8217;s default setting
4615 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
4616 be passed to the shell by Git, which will translate the final
4617 command to <code>LESS=FRX less -S</code>. The environment does not set the
4618 <code>S</code> option but the command line does, instructing less to truncate
4619 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
4620 deactivate the <code>F</code> option specified by the environment from the
4621 command-line, deactivating the "quit if one screen" behavior of
4622 <code>less</code>.  One can specifically activate some flags for particular
4623 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
4624 line truncation only for <code>git blame</code>.</p></div>
4625 <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
4626 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
4627 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
4628 </dd>
4629 <dt class="hdlist1">
4630 core.whitespace
4631 </dt>
4632 <dd>
4633 <p>
4634         A comma separated list of common whitespace problems to
4635         notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
4636         highlight them, and <em>git apply --whitespace=error</em> will
4637         consider them as errors.  You can prefix <code>-</code> to disable
4638         any of them (e.g. <code>-trailing-space</code>):
4639 </p>
4640 <div class="ulist"><ul>
4641 <li>
4642 <p>
4643 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
4644   as an error (enabled by default).
4645 </p>
4646 </li>
4647 <li>
4648 <p>
4649 <code>space-before-tab</code> treats a space character that appears immediately
4650   before a tab character in the initial indent part of the line as an
4651   error (enabled by default).
4652 </p>
4653 </li>
4654 <li>
4655 <p>
4656 <code>indent-with-non-tab</code> treats a line that is indented with space
4657   characters instead of the equivalent tabs as an error (not enabled by
4658   default).
4659 </p>
4660 </li>
4661 <li>
4662 <p>
4663 <code>tab-in-indent</code> treats a tab character in the initial indent part of
4664   the line as an error (not enabled by default).
4665 </p>
4666 </li>
4667 <li>
4668 <p>
4669 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
4670   (enabled by default).
4671 </p>
4672 </li>
4673 <li>
4674 <p>
4675 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
4676   <code>blank-at-eof</code>.
4677 </p>
4678 </li>
4679 <li>
4680 <p>
4681 <code>cr-at-eol</code> treats a carriage-return at the end of line as
4682   part of the line terminator, i.e. with it, <code>trailing-space</code>
4683   does not trigger if the character before such a carriage-return
4684   is not a whitespace (not enabled by default).
4685 </p>
4686 </li>
4687 <li>
4688 <p>
4689 <code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
4690   is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
4691   errors. The default tab width is 8. Allowed values are 1 to 63.
4692 </p>
4693 </li>
4694 </ul></div>
4695 </dd>
4696 <dt class="hdlist1">
4697 core.fsync
4698 </dt>
4699 <dd>
4700 <p>
4701         A comma-separated list of components of the repository that
4702         should be hardened via the core.fsyncMethod when created or
4703         modified.  You can disable hardening of any component by
4704         prefixing it with a <em>-</em>.  Items that are not hardened may be
4705         lost in the event of an unclean system shutdown. Unless you
4706         have special requirements, it is recommended that you leave
4707         this option empty or pick one of <code>committed</code>, <code>added</code>,
4708         or <code>all</code>.
4709 </p>
4710 <div class="paragraph"><p>When this configuration is encountered, the set of components starts with
4711 the platform default value, disabled components are removed, and additional
4712 components are added. <code>none</code> resets the state so that the platform default
4713 is ignored.</p></div>
4714 <div class="paragraph"><p>The empty string resets the fsync configuration to the platform
4715 default. The default on most platforms is equivalent to
4716 <code>core.fsync=committed,-loose-object</code>, which has good performance,
4717 but risks losing recent work in the event of an unclean system shutdown.</p></div>
4718 <div class="ulist"><ul>
4719 <li>
4720 <p>
4721 <code>none</code> clears the set of fsynced components.
4722 </p>
4723 </li>
4724 <li>
4725 <p>
4726 <code>loose-object</code> hardens objects added to the repo in loose-object form.
4727 </p>
4728 </li>
4729 <li>
4730 <p>
4731 <code>pack</code> hardens objects added to the repo in packfile form.
4732 </p>
4733 </li>
4734 <li>
4735 <p>
4736 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
4737 </p>
4738 </li>
4739 <li>
4740 <p>
4741 <code>commit-graph</code> hardens the commit-graph file.
4742 </p>
4743 </li>
4744 <li>
4745 <p>
4746 <code>index</code> hardens the index when it is modified.
4747 </p>
4748 </li>
4749 <li>
4750 <p>
4751 <code>objects</code> is an aggregate option that is equivalent to
4752   <code>loose-object,pack</code>.
4753 </p>
4754 </li>
4755 <li>
4756 <p>
4757 <code>reference</code> hardens references modified in the repo.
4758 </p>
4759 </li>
4760 <li>
4761 <p>
4762 <code>derived-metadata</code> is an aggregate option that is equivalent to
4763   <code>pack-metadata,commit-graph</code>.
4764 </p>
4765 </li>
4766 <li>
4767 <p>
4768 <code>committed</code> is an aggregate option that is currently equivalent to
4769   <code>objects</code>. This mode sacrifices some performance to ensure that work
4770   that is committed to the repository with <code>git commit</code> or similar commands
4771   is hardened.
4772 </p>
4773 </li>
4774 <li>
4775 <p>
4776 <code>added</code> is an aggregate option that is currently equivalent to
4777   <code>committed,index</code>. This mode sacrifices additional performance to
4778   ensure that the results of commands like <code>git add</code> and similar operations
4779   are hardened.
4780 </p>
4781 </li>
4782 <li>
4783 <p>
4784 <code>all</code> is an aggregate option that syncs all individual components above.
4785 </p>
4786 </li>
4787 </ul></div>
4788 </dd>
4789 <dt class="hdlist1">
4790 core.fsyncMethod
4791 </dt>
4792 <dd>
4793 <p>
4794         A value indicating the strategy Git will use to harden repository data
4795         using fsync and related primitives.
4796 </p>
4797 <div class="ulist"><ul>
4798 <li>
4799 <p>
4800 <code>fsync</code> uses the fsync() system call or platform equivalents.
4801 </p>
4802 </li>
4803 <li>
4804 <p>
4805 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
4806   filesystem and storage hardware, data added to the repository may not be
4807   durable in the event of a system crash. This is the default mode on macOS.
4808 </p>
4809 </li>
4810 <li>
4811 <p>
4812 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
4813   updates in the disk writeback cache and then does a single full fsync of
4814   a dummy file to trigger the disk cache flush at the end of the operation.
4815 </p>
4816 <div class="paragraph"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
4817 data is made durable as if <code>fsync</code> was specified. This mode is expected to
4818 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
4819 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
4820 </li>
4821 </ul></div>
4822 </dd>
4823 <dt class="hdlist1">
4824 core.fsyncObjectFiles
4825 </dt>
4826 <dd>
4827 <p>
4828         This boolean will enable <em>fsync()</em> when writing object files.
4829         This setting is deprecated. Use core.fsync instead.
4830 </p>
4831 <div class="paragraph"><p>This setting affects data added to the Git repository in loose-object
4832 form. When set to true, Git will issue an fsync or similar system call
4833 to flush caches so that loose-objects remain consistent in the face
4834 of a unclean system shutdown.</p></div>
4835 </dd>
4836 <dt class="hdlist1">
4837 core.preloadIndex
4838 </dt>
4839 <dd>
4840 <p>
4841         Enable parallel index preload for operations like <em>git diff</em>
4842 </p>
4843 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
4844 on filesystems like NFS that have weak caching semantics and thus
4845 relatively high IO latencies.  When enabled, Git will do the
4846 index comparison to the filesystem data in parallel, allowing
4847 overlapping IO&#8217;s.  Defaults to true.</p></div>
4848 </dd>
4849 <dt class="hdlist1">
4850 core.unsetenvvars
4851 </dt>
4852 <dd>
4853 <p>
4854         Windows-only: comma-separated list of environment variables'
4855         names that need to be unset before spawning any other process.
4856         Defaults to <code>PERL5LIB</code> to account for the fact that Git for
4857         Windows insists on using its own Perl interpreter.
4858 </p>
4859 </dd>
4860 <dt class="hdlist1">
4861 core.restrictinheritedhandles
4862 </dt>
4863 <dd>
4864 <p>
4865         Windows-only: override whether spawned processes inherit only standard
4866         file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
4867         <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
4868         Windows 7 and later, and <code>false</code> on older Windows versions.
4869 </p>
4870 </dd>
4871 <dt class="hdlist1">
4872 core.createObject
4873 </dt>
4874 <dd>
4875 <p>
4876         You can set this to <em>link</em>, in which case a hardlink followed by
4877         a delete of the source are used to make sure that object creation
4878         will not overwrite existing objects.
4879 </p>
4880 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
4881 Set this config setting to <em>rename</em> there; however, this will remove the
4882 check that makes sure that existing object files will not get overwritten.</p></div>
4883 </dd>
4884 <dt class="hdlist1">
4885 core.notesRef
4886 </dt>
4887 <dd>
4888 <p>
4889         When showing commit messages, also show notes which are stored in
4890         the given ref.  The ref must be fully qualified.  If the given
4891         ref does not exist, it is not an error but means that no
4892         notes should be printed.
4893 </p>
4894 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
4895 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p></div>
4896 </dd>
4897 <dt class="hdlist1">
4898 core.commitGraph
4899 </dt>
4900 <dd>
4901 <p>
4902         If true, then git will read the commit-graph file (if it exists)
4903         to parse the graph structure of commits. Defaults to true. See
4904         <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
4905 </p>
4906 </dd>
4907 <dt class="hdlist1">
4908 core.useReplaceRefs
4909 </dt>
4910 <dd>
4911 <p>
4912         If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
4913         option was given on the command line. See <a href="git.html">git(1)</a> and
4914         <a href="git-replace.html">git-replace(1)</a> for more information.
4915 </p>
4916 </dd>
4917 <dt class="hdlist1">
4918 core.multiPackIndex
4919 </dt>
4920 <dd>
4921 <p>
4922         Use the multi-pack-index file to track multiple packfiles using a
4923         single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
4924         information. Defaults to true.
4925 </p>
4926 </dd>
4927 <dt class="hdlist1">
4928 core.sparseCheckout
4929 </dt>
4930 <dd>
4931 <p>
4932         Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
4933         for more information.
4934 </p>
4935 </dd>
4936 <dt class="hdlist1">
4937 core.sparseCheckoutCone
4938 </dt>
4939 <dd>
4940 <p>
4941         Enables the "cone mode" of the sparse checkout feature. When the
4942         sparse-checkout file contains a limited set of patterns, this
4943         mode provides significant performance advantages. The "non-cone
4944         mode" can be requested to allow specifying more flexible
4945         patterns by setting this variable to <em>false</em>. See
4946         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.
4947 </p>
4948 </dd>
4949 <dt class="hdlist1">
4950 core.abbrev
4951 </dt>
4952 <dd>
4953 <p>
4954         Set the length object names are abbreviated to.  If
4955         unspecified or set to "auto", an appropriate value is
4956         computed based on the approximate number of packed objects
4957         in your repository, which hopefully is enough for
4958         abbreviated object names to stay unique for some time.
4959         If set to "no", no abbreviation is made and the object names
4960         are shown in their full length.
4961         The minimum length is 4.
4962 </p>
4963 </dd>
4964 <dt class="hdlist1">
4965 core.maxTreeDepth
4966 </dt>
4967 <dd>
4968 <p>
4969         The maximum depth Git is willing to recurse while traversing a
4970         tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
4971         to allow Git to abort cleanly, and should not generally need to
4972         be adjusted. The default is 4096.
4973 </p>
4974 </dd>
4975 <dt class="hdlist1">
4976 credential.helper
4977 </dt>
4978 <dd>
4979 <p>
4980         Specify an external helper to be called when a username or
4981         password credential is needed; the helper may consult external
4982         storage to avoid prompting the user for the credentials. This is
4983         normally the name of a credential helper with possible
4984         arguments, but may also be an absolute path with arguments or, if
4985         preceded by <code>!</code>, shell commands.
4986 </p>
4987 <div class="paragraph"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
4988 for details and examples.</p></div>
4989 </dd>
4990 <dt class="hdlist1">
4991 credential.useHttpPath
4992 </dt>
4993 <dd>
4994 <p>
4995         When acquiring credentials, consider the "path" component of an http
4996         or https URL to be important. Defaults to false. See
4997         <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
4998 </p>
4999 </dd>
5000 <dt class="hdlist1">
5001 credential.username
5002 </dt>
5003 <dd>
5004 <p>
5005         If no username is set for a network authentication, use this username
5006         by default. See credential.&lt;context&gt;.* below, and
5007         <a href="gitcredentials.html">gitcredentials(7)</a>.
5008 </p>
5009 </dd>
5010 <dt class="hdlist1">
5011 credential.&lt;url&gt;.*
5012 </dt>
5013 <dd>
5014 <p>
5015         Any of the credential.* options above can be applied selectively to
5016         some credentials. For example, "credential.https://example.com.username"
5017         would set the default username only for https connections to
5018         example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
5019         matched.
5020 </p>
5021 </dd>
5022 <dt class="hdlist1">
5023 credentialCache.ignoreSIGHUP
5024 </dt>
5025 <dd>
5026 <p>
5027         Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
5028 </p>
5029 </dd>
5030 <dt class="hdlist1">
5031 credentialStore.lockTimeoutMS
5032 </dt>
5033 <dd>
5034 <p>
5035         The length of time, in milliseconds, for git-credential-store to retry
5036         when trying to lock the credentials file. A value of 0 means not to retry at
5037         all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
5038         1s).
5039 </p>
5040 </dd>
5041 <dt class="hdlist1">
5042 diff.autoRefreshIndex
5043 </dt>
5044 <dd>
5045 <p>
5046         When using <em>git diff</em> to compare with work tree
5047         files, do not consider stat-only changes as changed.
5048         Instead, silently run <code>git update-index --refresh</code> to
5049         update the cached stat information for paths whose
5050         contents in the work tree match the contents in the
5051         index.  This option defaults to true.  Note that this
5052         affects only <em>git diff</em> Porcelain, and not lower level
5053         <em>diff</em> commands such as <em>git diff-files</em>.
5054 </p>
5055 </dd>
5056 <dt class="hdlist1">
5057 diff.dirstat
5058 </dt>
5059 <dd>
5060 <p>
5061         A comma separated list of <code>--dirstat</code> parameters specifying the
5062         default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
5063         and friends. The defaults can be overridden on the command line
5064         (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
5065         (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
5066         The following parameters are available:
5067 </p>
5068 <div class="openblock">
5069 <div class="content">
5070 <div class="dlist"><dl>
5071 <dt class="hdlist1">
5072 <code>changes</code>
5073 </dt>
5074 <dd>
5075 <p>
5076         Compute the dirstat numbers by counting the lines that have been
5077         removed from the source, or added to the destination. This ignores
5078         the amount of pure code movements within a file.  In other words,
5079         rearranging lines in a file is not counted as much as other changes.
5080         This is the default behavior when no parameter is given.
5081 </p>
5082 </dd>
5083 <dt class="hdlist1">
5084 <code>lines</code>
5085 </dt>
5086 <dd>
5087 <p>
5088         Compute the dirstat numbers by doing the regular line-based diff
5089         analysis, and summing the removed/added line counts. (For binary
5090         files, count 64-byte chunks instead, since binary files have no
5091         natural concept of lines). This is a more expensive <code>--dirstat</code>
5092         behavior than the <code>changes</code> behavior, but it does count rearranged
5093         lines within a file as much as other changes. The resulting output
5094         is consistent with what you get from the other <code>--*stat</code> options.
5095 </p>
5096 </dd>
5097 <dt class="hdlist1">
5098 <code>files</code>
5099 </dt>
5100 <dd>
5101 <p>
5102         Compute the dirstat numbers by counting the number of files changed.
5103         Each changed file counts equally in the dirstat analysis. This is
5104         the computationally cheapest <code>--dirstat</code> behavior, since it does
5105         not have to look at the file contents at all.
5106 </p>
5107 </dd>
5108 <dt class="hdlist1">
5109 <code>cumulative</code>
5110 </dt>
5111 <dd>
5112 <p>
5113         Count changes in a child directory for the parent directory as well.
5114         Note that when using <code>cumulative</code>, the sum of the percentages
5115         reported may exceed 100%. The default (non-cumulative) behavior can
5116         be specified with the <code>noncumulative</code> parameter.
5117 </p>
5118 </dd>
5119 <dt class="hdlist1">
5120 &lt;limit&gt;
5121 </dt>
5122 <dd>
5123 <p>
5124         An integer parameter specifies a cut-off percent (3% by default).
5125         Directories contributing less than this percentage of the changes
5126         are not shown in the output.
5127 </p>
5128 </dd>
5129 </dl></div>
5130 </div></div>
5131 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
5132 directories with less than 10% of the total amount of changed files,
5133 and accumulating child directory counts in the parent directories:
5134 <code>files,10,cumulative</code>.</p></div>
5135 </dd>
5136 <dt class="hdlist1">
5137 diff.statNameWidth
5138 </dt>
5139 <dd>
5140 <p>
5141         Limit the width of the filename part in --stat output. If set, applies
5142         to all commands generating --stat output except format-patch.
5143 </p>
5144 </dd>
5145 <dt class="hdlist1">
5146 diff.statGraphWidth
5147 </dt>
5148 <dd>
5149 <p>
5150         Limit the width of the graph part in --stat output. If set, applies
5151         to all commands generating --stat output except format-patch.
5152 </p>
5153 </dd>
5154 <dt class="hdlist1">
5155 diff.context
5156 </dt>
5157 <dd>
5158 <p>
5159         Generate diffs with &lt;n&gt; lines of context instead of the default
5160         of 3. This value is overridden by the -U option.
5161 </p>
5162 </dd>
5163 <dt class="hdlist1">
5164 diff.interHunkContext
5165 </dt>
5166 <dd>
5167 <p>
5168         Show the context between diff hunks, up to the specified number
5169         of lines, thereby fusing the hunks that are close to each other.
5170         This value serves as the default for the <code>--inter-hunk-context</code>
5171         command line option.
5172 </p>
5173 </dd>
5174 <dt class="hdlist1">
5175 diff.external
5176 </dt>
5177 <dd>
5178 <p>
5179         If this config variable is set, diff generation is not
5180         performed using the internal diff machinery, but using the
5181         given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
5182         environment variable.  The command is called with parameters
5183         as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
5184         you want to use an external diff program only on a subset of
5185         your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
5186 </p>
5187 </dd>
5188 <dt class="hdlist1">
5189 diff.trustExitCode
5190 </dt>
5191 <dd>
5192 <p>
5193         If this boolean value is set to true then the
5194         <code>diff.external</code> command is expected to return exit code
5195         0 if it considers the input files to be equal or 1 if it
5196         considers them to be different, like <code>diff(1)</code>.
5197         If it is set to false, which is the default, then the command
5198         is expected to return exit code 0 regardless of equality.
5199         Any other exit code causes Git to report a fatal error.
5200 </p>
5201 </dd>
5202 <dt class="hdlist1">
5203 diff.ignoreSubmodules
5204 </dt>
5205 <dd>
5206 <p>
5207         Sets the default value of --ignore-submodules. Note that this
5208         affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
5209         commands such as <em>git diff-files</em>. <em>git checkout</em>
5210         and <em>git switch</em> also honor
5211         this setting when reporting uncommitted changes. Setting it to
5212         <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
5213         and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
5214         overridden by using the --ignore-submodules command-line option.
5215         The <em>git submodule</em> commands are not affected by this setting.
5216         By default this is set to untracked so that any untracked
5217         submodules are ignored.
5218 </p>
5219 </dd>
5220 <dt class="hdlist1">
5221 diff.mnemonicPrefix
5222 </dt>
5223 <dd>
5224 <p>
5225         If set, <em>git diff</em> uses a prefix pair that is different from the
5226         standard "a/" and "b/" depending on what is being compared.  When
5227         this configuration is in effect, reverse diff output also swaps
5228         the order of the prefixes:
5229 </p>
5230 <div class="dlist"><dl>
5231 <dt class="hdlist1">
5232 <code>git diff</code>
5233 </dt>
5234 <dd>
5235 <p>
5236         compares the (i)ndex and the (w)ork tree;
5237 </p>
5238 </dd>
5239 <dt class="hdlist1">
5240 <code>git diff HEAD</code>
5241 </dt>
5242 <dd>
5243 <p>
5244          compares a (c)ommit and the (w)ork tree;
5245 </p>
5246 </dd>
5247 <dt class="hdlist1">
5248 <code>git diff --cached</code>
5249 </dt>
5250 <dd>
5251 <p>
5252         compares a (c)ommit and the (i)ndex;
5253 </p>
5254 </dd>
5255 <dt class="hdlist1">
5256 <code>git diff HEAD:file1 file2</code>
5257 </dt>
5258 <dd>
5259 <p>
5260         compares an (o)bject and a (w)ork tree entity;
5261 </p>
5262 </dd>
5263 <dt class="hdlist1">
5264 <code>git diff --no-index a b</code>
5265 </dt>
5266 <dd>
5267 <p>
5268         compares two non-git things (1) and (2).
5269 </p>
5270 </dd>
5271 </dl></div>
5272 </dd>
5273 <dt class="hdlist1">
5274 diff.noPrefix
5275 </dt>
5276 <dd>
5277 <p>
5278         If set, <em>git diff</em> does not show any source or destination prefix.
5279 </p>
5280 </dd>
5281 <dt class="hdlist1">
5282 diff.srcPrefix
5283 </dt>
5284 <dd>
5285 <p>
5286         If set, <em>git diff</em> uses this source prefix. Defaults to "a/".
5287 </p>
5288 </dd>
5289 <dt class="hdlist1">
5290 diff.dstPrefix
5291 </dt>
5292 <dd>
5293 <p>
5294         If set, <em>git diff</em> uses this destination prefix. Defaults to "b/".
5295 </p>
5296 </dd>
5297 <dt class="hdlist1">
5298 diff.relative
5299 </dt>
5300 <dd>
5301 <p>
5302         If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
5303         and show pathnames relative to the current directory.
5304 </p>
5305 </dd>
5306 <dt class="hdlist1">
5307 diff.orderFile
5308 </dt>
5309 <dd>
5310 <p>
5311         File indicating how to order files within a diff.
5312         See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
5313         If <code>diff.orderFile</code> is a relative pathname, it is treated as
5314         relative to the top of the working tree.
5315 </p>
5316 </dd>
5317 <dt class="hdlist1">
5318 diff.renameLimit
5319 </dt>
5320 <dd>
5321 <p>
5322         The number of files to consider in the exhaustive portion of
5323         copy/rename detection; equivalent to the <em>git diff</em> option
5324         <code>-l</code>.  If not set, the default value is currently 1000.  This
5325         setting has no effect if rename detection is turned off.
5326 </p>
5327 </dd>
5328 <dt class="hdlist1">
5329 diff.renames
5330 </dt>
5331 <dd>
5332 <p>
5333         Whether and how Git detects renames.  If set to "false",
5334         rename detection is disabled. If set to "true", basic rename
5335         detection is enabled.  If set to "copies" or "copy", Git will
5336         detect copies, as well.  Defaults to true.  Note that this
5337         affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
5338         <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
5339         <a href="git-diff-files.html">git-diff-files(1)</a>.
5340 </p>
5341 </dd>
5342 <dt class="hdlist1">
5343 diff.suppressBlankEmpty
5344 </dt>
5345 <dd>
5346 <p>
5347         A boolean to inhibit the standard behavior of printing a space
5348         before each empty output line. Defaults to false.
5349 </p>
5350 </dd>
5351 <dt class="hdlist1">
5352 diff.submodule
5353 </dt>
5354 <dd>
5355 <p>
5356         Specify the format in which differences in submodules are
5357         shown.  The "short" format just shows the names of the commits
5358         at the beginning and end of the range. The "log" format lists
5359         the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
5360         does. The "diff" format shows an inline diff of the changed
5361         contents of the submodule. Defaults to "short".
5362 </p>
5363 </dd>
5364 <dt class="hdlist1">
5365 diff.wordRegex
5366 </dt>
5367 <dd>
5368 <p>
5369         A POSIX Extended Regular Expression used to determine what is a "word"
5370         when performing word-by-word difference calculations.  Character
5371         sequences that match the regular expression are "words", all other
5372         characters are <strong>ignorable</strong> whitespace.
5373 </p>
5374 </dd>
5375 <dt class="hdlist1">
5376 diff.&lt;driver&gt;.command
5377 </dt>
5378 <dd>
5379 <p>
5380         The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
5381         for details.
5382 </p>
5383 </dd>
5384 <dt class="hdlist1">
5385 diff.&lt;driver&gt;.trustExitCode
5386 </dt>
5387 <dd>
5388 <p>
5389         If this boolean value is set to true then the
5390         <code>diff.&lt;driver&gt;.command</code> command is expected to return exit code
5391         0 if it considers the input files to be equal or 1 if it
5392         considers them to be different, like <code>diff(1)</code>.
5393         If it is set to false, which is the default, then the command
5394         is expected to return exit code 0 regardless of equality.
5395         Any other exit code causes Git to report a fatal error.
5396 </p>
5397 </dd>
5398 <dt class="hdlist1">
5399 diff.&lt;driver&gt;.xfuncname
5400 </dt>
5401 <dd>
5402 <p>
5403         The regular expression that the diff driver should use to
5404         recognize the hunk header.  A built-in pattern may also be used.
5405         See <a href="gitattributes.html">gitattributes(5)</a> for details.
5406 </p>
5407 </dd>
5408 <dt class="hdlist1">
5409 diff.&lt;driver&gt;.binary
5410 </dt>
5411 <dd>
5412 <p>
5413         Set this option to true to make the diff driver treat files as
5414         binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5415 </p>
5416 </dd>
5417 <dt class="hdlist1">
5418 diff.&lt;driver&gt;.textconv
5419 </dt>
5420 <dd>
5421 <p>
5422         The command that the diff driver should call to generate the
5423         text-converted version of a file.  The result of the
5424         conversion is used to generate a human-readable diff.  See
5425         <a href="gitattributes.html">gitattributes(5)</a> for details.
5426 </p>
5427 </dd>
5428 <dt class="hdlist1">
5429 diff.&lt;driver&gt;.wordRegex
5430 </dt>
5431 <dd>
5432 <p>
5433         The regular expression that the diff driver should use to
5434         split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
5435         details.
5436 </p>
5437 </dd>
5438 <dt class="hdlist1">
5439 diff.&lt;driver&gt;.cachetextconv
5440 </dt>
5441 <dd>
5442 <p>
5443         Set this option to true to make the diff driver cache the text
5444         conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5445 </p>
5446 <div class="dlist"><dl>
5447 <dt class="hdlist1">
5448 <code>araxis</code>
5449 </dt>
5450 <dd>
5451 <p>
5452 Use Araxis Merge (requires a graphical session)
5453 </p>
5454 </dd>
5455 <dt class="hdlist1">
5456 <code>bc</code>
5457 </dt>
5458 <dd>
5459 <p>
5460 Use Beyond Compare (requires a graphical session)
5461 </p>
5462 </dd>
5463 <dt class="hdlist1">
5464 <code>bc3</code>
5465 </dt>
5466 <dd>
5467 <p>
5468 Use Beyond Compare (requires a graphical session)
5469 </p>
5470 </dd>
5471 <dt class="hdlist1">
5472 <code>bc4</code>
5473 </dt>
5474 <dd>
5475 <p>
5476 Use Beyond Compare (requires a graphical session)
5477 </p>
5478 </dd>
5479 <dt class="hdlist1">
5480 <code>codecompare</code>
5481 </dt>
5482 <dd>
5483 <p>
5484 Use Code Compare (requires a graphical session)
5485 </p>
5486 </dd>
5487 <dt class="hdlist1">
5488 <code>deltawalker</code>
5489 </dt>
5490 <dd>
5491 <p>
5492 Use DeltaWalker (requires a graphical session)
5493 </p>
5494 </dd>
5495 <dt class="hdlist1">
5496 <code>diffmerge</code>
5497 </dt>
5498 <dd>
5499 <p>
5500 Use DiffMerge (requires a graphical session)
5501 </p>
5502 </dd>
5503 <dt class="hdlist1">
5504 <code>diffuse</code>
5505 </dt>
5506 <dd>
5507 <p>
5508 Use Diffuse (requires a graphical session)
5509 </p>
5510 </dd>
5511 <dt class="hdlist1">
5512 <code>ecmerge</code>
5513 </dt>
5514 <dd>
5515 <p>
5516 Use ECMerge (requires a graphical session)
5517 </p>
5518 </dd>
5519 <dt class="hdlist1">
5520 <code>emerge</code>
5521 </dt>
5522 <dd>
5523 <p>
5524 Use Emacs' Emerge
5525 </p>
5526 </dd>
5527 <dt class="hdlist1">
5528 <code>examdiff</code>
5529 </dt>
5530 <dd>
5531 <p>
5532 Use ExamDiff Pro (requires a graphical session)
5533 </p>
5534 </dd>
5535 <dt class="hdlist1">
5536 <code>guiffy</code>
5537 </dt>
5538 <dd>
5539 <p>
5540 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
5541 </p>
5542 </dd>
5543 <dt class="hdlist1">
5544 <code>gvimdiff</code>
5545 </dt>
5546 <dd>
5547 <p>
5548 Use gVim (requires a graphical session)
5549 </p>
5550 </dd>
5551 <dt class="hdlist1">
5552 <code>kdiff3</code>
5553 </dt>
5554 <dd>
5555 <p>
5556 Use KDiff3 (requires a graphical session)
5557 </p>
5558 </dd>
5559 <dt class="hdlist1">
5560 <code>kompare</code>
5561 </dt>
5562 <dd>
5563 <p>
5564 Use Kompare (requires a graphical session)
5565 </p>
5566 </dd>
5567 <dt class="hdlist1">
5568 <code>meld</code>
5569 </dt>
5570 <dd>
5571 <p>
5572 Use Meld (requires a graphical session)
5573 </p>
5574 </dd>
5575 <dt class="hdlist1">
5576 <code>nvimdiff</code>
5577 </dt>
5578 <dd>
5579 <p>
5580 Use Neovim
5581 </p>
5582 </dd>
5583 <dt class="hdlist1">
5584 <code>opendiff</code>
5585 </dt>
5586 <dd>
5587 <p>
5588 Use FileMerge (requires a graphical session)
5589 </p>
5590 </dd>
5591 <dt class="hdlist1">
5592 <code>p4merge</code>
5593 </dt>
5594 <dd>
5595 <p>
5596 Use HelixCore P4Merge (requires a graphical session)
5597 </p>
5598 </dd>
5599 <dt class="hdlist1">
5600 <code>smerge</code>
5601 </dt>
5602 <dd>
5603 <p>
5604 Use Sublime Merge (requires a graphical session)
5605 </p>
5606 </dd>
5607 <dt class="hdlist1">
5608 <code>tkdiff</code>
5609 </dt>
5610 <dd>
5611 <p>
5612 Use TkDiff (requires a graphical session)
5613 </p>
5614 </dd>
5615 <dt class="hdlist1">
5616 <code>vimdiff</code>
5617 </dt>
5618 <dd>
5619 <p>
5620 Use Vim
5621 </p>
5622 </dd>
5623 <dt class="hdlist1">
5624 <code>winmerge</code>
5625 </dt>
5626 <dd>
5627 <p>
5628 Use WinMerge (requires a graphical session)
5629 </p>
5630 </dd>
5631 <dt class="hdlist1">
5632 <code>xxdiff</code>
5633 </dt>
5634 <dd>
5635 <p>
5636 Use xxdiff (requires a graphical session)
5637 </p>
5638 </dd>
5639 </dl></div>
5640 </dd>
5641 <dt class="hdlist1">
5642 diff.indentHeuristic
5643 </dt>
5644 <dd>
5645 <p>
5646         Set this option to <code>false</code> to disable the default heuristics
5647         that shift diff hunk boundaries to make patches easier to read.
5648 </p>
5649 </dd>
5650 <dt class="hdlist1">
5651 diff.algorithm
5652 </dt>
5653 <dd>
5654 <p>
5655         Choose a diff algorithm.  The variants are as follows:
5656 </p>
5657 <div class="openblock">
5658 <div class="content">
5659 <div class="dlist"><dl>
5660 <dt class="hdlist1">
5661 <code>default</code>, <code>myers</code>
5662 </dt>
5663 <dd>
5664 <p>
5665         The basic greedy diff algorithm. Currently, this is the default.
5666 </p>
5667 </dd>
5668 <dt class="hdlist1">
5669 <code>minimal</code>
5670 </dt>
5671 <dd>
5672 <p>
5673         Spend extra time to make sure the smallest possible diff is
5674         produced.
5675 </p>
5676 </dd>
5677 <dt class="hdlist1">
5678 <code>patience</code>
5679 </dt>
5680 <dd>
5681 <p>
5682         Use "patience diff" algorithm when generating patches.
5683 </p>
5684 </dd>
5685 <dt class="hdlist1">
5686 <code>histogram</code>
5687 </dt>
5688 <dd>
5689 <p>
5690         This algorithm extends the patience algorithm to "support
5691         low-occurrence common elements".
5692 </p>
5693 </dd>
5694 </dl></div>
5695 </div></div>
5696 </dd>
5697 <dt class="hdlist1">
5698 diff.wsErrorHighlight
5699 </dt>
5700 <dd>
5701 <p>
5702         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5703         lines of the diff.  Multiple values are separated by comma,
5704         <code>none</code> resets previous values, <code>default</code> reset the list to
5705         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
5706         whitespace errors are colored with <code>color.diff.whitespace</code>.
5707         The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
5708         overrides this setting.
5709 </p>
5710 </dd>
5711 <dt class="hdlist1">
5712 diff.colorMoved
5713 </dt>
5714 <dd>
5715 <p>
5716         If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
5717         in a diff are colored differently, for details of valid modes
5718         see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
5719         true the default color mode will be used. When set to false,
5720         moved lines are not colored.
5721 </p>
5722 </dd>
5723 <dt class="hdlist1">
5724 diff.colorMovedWS
5725 </dt>
5726 <dd>
5727 <p>
5728         When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5729         this option controls the <code>&lt;mode&gt;</code> how spaces are treated.
5730         For details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.
5731 </p>
5732 </dd>
5733 <dt class="hdlist1">
5734 diff.tool
5735 </dt>
5736 <dd>
5737 <p>
5738         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
5739         This variable overrides the value configured in <code>merge.tool</code>.
5740         The list below shows the valid built-in values.
5741         Any other value is treated as a custom diff tool and requires
5742         that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
5743 </p>
5744 </dd>
5745 <dt class="hdlist1">
5746 diff.guitool
5747 </dt>
5748 <dd>
5749 <p>
5750         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
5751         the -g/--gui flag is specified. This variable overrides the value
5752         configured in <code>merge.guitool</code>. The list below shows the valid
5753         built-in values. Any other value is treated as a custom diff tool
5754         and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
5755         is defined.
5756 </p>
5757 </dd>
5758 <dt class="hdlist1">
5759 difftool.&lt;tool&gt;.cmd
5760 </dt>
5761 <dd>
5762 <p>
5763         Specify the command to invoke the specified diff tool.
5764         The specified command is evaluated in shell with the following
5765         variables available:  <em>LOCAL</em> is set to the name of the temporary
5766         file containing the contents of the diff pre-image and <em>REMOTE</em>
5767         is set to the name of the temporary file containing the contents
5768         of the diff post-image.
5769 </p>
5770 <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>
5771 </dd>
5772 <dt class="hdlist1">
5773 difftool.&lt;tool&gt;.path
5774 </dt>
5775 <dd>
5776 <p>
5777         Override the path for the given tool.  This is useful in case
5778         your tool is not in the PATH.
5779 </p>
5780 </dd>
5781 <dt class="hdlist1">
5782 difftool.trustExitCode
5783 </dt>
5784 <dd>
5785 <p>
5786         Exit difftool if the invoked diff tool returns a non-zero exit status.
5787 </p>
5788 <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>
5789 </dd>
5790 <dt class="hdlist1">
5791 difftool.prompt
5792 </dt>
5793 <dd>
5794 <p>
5795         Prompt before each invocation of the diff tool.
5796 </p>
5797 </dd>
5798 <dt class="hdlist1">
5799 difftool.guiDefault
5800 </dt>
5801 <dd>
5802 <p>
5803         Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5804         the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5805         depending on the presence of a <code>DISPLAY</code> environment variable value. The
5806         default is <code>false</code>, where the <code>--gui</code> argument must be provided
5807         explicitly for the <code>diff.guitool</code> to be used.
5808 </p>
5809 </dd>
5810 <dt class="hdlist1">
5811 extensions.objectFormat
5812 </dt>
5813 <dd>
5814 <p>
5815         Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
5816         <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
5817         this key unless <code>core.repositoryFormatVersion</code> is 1.
5818 </p>
5819 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5820 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
5821 work and will produce hard-to-diagnose issues.</p></div>
5822 </dd>
5823 <dt class="hdlist1">
5824 extensions.compatObjectFormat
5825 </dt>
5826 <dd>
5827 <p>
5828         Specify a compatitbility hash algorithm to use.  The acceptable values
5829         are <code>sha1</code> and <code>sha256</code>.  The value specified must be different from the
5830         value of extensions.objectFormat.  This allows client level
5831         interoperability between git repositories whose objectFormat matches
5832         this compatObjectFormat.  In particular when fully implemented the
5833         pushes and pulls from a repository in whose objectFormat matches
5834         compatObjectFormat.  As well as being able to use oids encoded in
5835         compatObjectFormat in addition to oids encoded with objectFormat to
5836         locally specify objects.
5837 </p>
5838 </dd>
5839 <dt class="hdlist1">
5840 extensions.refStorage
5841 </dt>
5842 <dd>
5843 <p>
5844         Specify the ref storage format to use. The acceptable values are:
5845 </p>
5846 <div class="ulist"><ul>
5847 <li>
5848 <p>
5849 <code>files</code> for loose files with packed-refs. This is the default.
5850 </p>
5851 </li>
5852 <li>
5853 <p>
5854 <code>reftable</code> for the reftable format. This format is experimental and its
5855   internals are subject to change.
5856 </p>
5857 <div class="paragraph"><p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p></div>
5858 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5859 <a href="git-clone.html">git-clone(1)</a>. Trying to change it after initialization will not
5860 work and will produce hard-to-diagnose issues.</p></div>
5861 </li>
5862 </ul></div>
5863 </dd>
5864 <dt class="hdlist1">
5865 extensions.worktreeConfig
5866 </dt>
5867 <dd>
5868 <p>
5869         If enabled, then worktrees will load config settings from the
5870         <code>$GIT_DIR/config.worktree</code> file in addition to the
5871         <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5872         <code>$GIT_DIR</code> are the same for the main working tree, while other
5873         working trees have <code>$GIT_DIR</code> equal to
5874         <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
5875         <code>config.worktree</code> file will override settings from any other
5876         config files.
5877 </p>
5878 <div class="paragraph"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5879 certain values from the common config file to the main working tree&#8217;s
5880 <code>config.worktree</code> file, if present:</p></div>
5881 <div class="ulist"><ul>
5882 <li>
5883 <p>
5884 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5885   <code>$GIT_COMMON_DIR/config.worktree</code>.
5886 </p>
5887 </li>
5888 <li>
5889 <p>
5890 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5891   to <code>$GIT_COMMON_DIR/config.worktree</code>.
5892 </p>
5893 <div class="paragraph"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5894 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5895 sparse-checkout settings for each worktree. By default, the <code>git
5896 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5897 these config values on a per-worktree basis, and uses the
5898 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5899 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
5900 details.</p></div>
5901 <div class="paragraph"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5902 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5903 </li>
5904 </ul></div>
5905 </dd>
5906 <dt class="hdlist1">
5907 fastimport.unpackLimit
5908 </dt>
5909 <dd>
5910 <p>
5911         If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
5912         is below this limit, then the objects will be unpacked into
5913         loose object files.  However, if the number of imported objects
5914         equals or exceeds this limit, then the pack will be stored as a
5915         pack.  Storing the pack from a fast-import can make the import
5916         operation complete faster, especially on slow filesystems.  If
5917         not set, the value of <code>transfer.unpackLimit</code> is used instead.
5918 </p>
5919 </dd>
5920 <dt class="hdlist1">
5921 feature.*
5922 </dt>
5923 <dd>
5924 <p>
5925         The config settings that start with <code>feature.</code> modify the defaults of
5926         a group of other config settings. These groups are created by the Git
5927         developer community as recommended defaults and are subject to change.
5928         In particular, new config options may be added with different defaults.
5929 </p>
5930 </dd>
5931 <dt class="hdlist1">
5932 feature.experimental
5933 </dt>
5934 <dd>
5935 <p>
5936         Enable config options that are new to Git, and are being considered for
5937         future defaults. Config settings included here may be added or removed
5938         with each release, including minor version updates. These settings may
5939         have unintended interactions since they are so new. Please enable this
5940         setting if you are interested in providing feedback on experimental
5941         features. The new default values are:
5942 </p>
5943 <div class="ulist"><ul>
5944 <li>
5945 <p>
5946 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5947 skipping more commits at a time, reducing the number of round trips.
5948 </p>
5949 </li>
5950 <li>
5951 <p>
5952 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5953 walking fewer objects.
5954 </p>
5955 </li>
5956 <li>
5957 <p>
5958 <code>pack.allowPackReuse=multi</code> may improve the time it takes to create a pack by
5959 reusing objects from multiple packs instead of just one.
5960 </p>
5961 </li>
5962 </ul></div>
5963 </dd>
5964 <dt class="hdlist1">
5965 feature.manyFiles
5966 </dt>
5967 <dd>
5968 <p>
5969         Enable config options that optimize for repos with many files in the
5970         working directory. With many files, commands such as <code>git status</code> and
5971         <code>git checkout</code> may be slow and these new defaults improve performance:
5972 </p>
5973 <div class="ulist"><ul>
5974 <li>
5975 <p>
5976 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5977   checksum. Note that this will cause Git versions earlier than 2.13.0 to
5978   refuse to parse the index and Git versions earlier than 2.40.0 will report
5979   a corrupted index during <code>git fsck</code>.
5980 </p>
5981 </li>
5982 <li>
5983 <p>
5984 <code>index.version=4</code> enables path-prefix compression in the index.
5985 </p>
5986 </li>
5987 <li>
5988 <p>
5989 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5990 that mtime is working on your machine.
5991 </p>
5992 </li>
5993 </ul></div>
5994 </dd>
5995 <dt class="hdlist1">
5996 fetch.recurseSubmodules
5997 </dt>
5998 <dd>
5999 <p>
6000         This option controls whether <code>git fetch</code> (and the underlying fetch
6001         in <code>git pull</code>) will recursively fetch into populated submodules.
6002         This option can be set either to a boolean value or to <em>on-demand</em>.
6003         Setting it to a boolean changes the behavior of fetch and pull to
6004         recurse unconditionally into submodules when set to true or to not
6005         recurse at all when set to false. When set to <em>on-demand</em>, fetch and
6006         pull will only recurse into a populated submodule when its
6007         superproject retrieves a commit that updates the submodule&#8217;s
6008         reference.
6009         Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
6010 </p>
6011 </dd>
6012 <dt class="hdlist1">
6013 fetch.fsckObjects
6014 </dt>
6015 <dd>
6016 <p>
6017         If it is set to true, git-fetch-pack will check all fetched
6018         objects. See <code>transfer.fsckObjects</code> for what&#8217;s
6019         checked. Defaults to false. If not set, the value of
6020         <code>transfer.fsckObjects</code> is used instead.
6021 </p>
6022 </dd>
6023 <dt class="hdlist1">
6024 fetch.fsck.&lt;msg-id&gt;
6025 </dt>
6026 <dd>
6027 <p>
6028         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
6029         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
6030         the <code>fsck.&lt;msg-id&gt;</code> documentation for details.
6031 </p>
6032 </dd>
6033 <dt class="hdlist1">
6034 fetch.fsck.skipList
6035 </dt>
6036 <dd>
6037 <p>
6038         Acts like <code>fsck.skipList</code>, but is used by
6039         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
6040         the <code>fsck.skipList</code> documentation for details.
6041 </p>
6042 </dd>
6043 <dt class="hdlist1">
6044 fetch.unpackLimit
6045 </dt>
6046 <dd>
6047 <p>
6048         If the number of objects fetched over the Git native
6049         transfer is below this
6050         limit, then the objects will be unpacked into loose object
6051         files. However if the number of received objects equals or
6052         exceeds this limit then the received pack will be stored as
6053         a pack, after adding any missing delta bases.  Storing the
6054         pack from a push can make the push operation complete faster,
6055         especially on slow filesystems.  If not set, the value of
6056         <code>transfer.unpackLimit</code> is used instead.
6057 </p>
6058 </dd>
6059 <dt class="hdlist1">
6060 fetch.prune
6061 </dt>
6062 <dd>
6063 <p>
6064         If true, fetch will automatically behave as if the <code>--prune</code>
6065         option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
6066         and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.
6067 </p>
6068 </dd>
6069 <dt class="hdlist1">
6070 fetch.pruneTags
6071 </dt>
6072 <dd>
6073 <p>
6074         If true, fetch will automatically behave as if the
6075         <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
6076         if not set already. This allows for setting both this option
6077         and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
6078         refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
6079         section of <a href="git-fetch.html">git-fetch(1)</a>.
6080 </p>
6081 </dd>
6082 <dt class="hdlist1">
6083 fetch.all
6084 </dt>
6085 <dd>
6086 <p>
6087         If true, fetch will attempt to update all available remotes.
6088         This behavior can be overridden by passing <code>--no-all</code> or by
6089         explicitly specifying one or more remote(s) to fetch from.
6090         Defaults to false.
6091 </p>
6092 </dd>
6093 <dt class="hdlist1">
6094 fetch.output
6095 </dt>
6096 <dd>
6097 <p>
6098         Control how ref update status is printed. Valid values are
6099         <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
6100         OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.
6101 </p>
6102 </dd>
6103 <dt class="hdlist1">
6104 fetch.negotiationAlgorithm
6105 </dt>
6106 <dd>
6107 <p>
6108         Control how information about the commits in the local repository
6109         is sent when negotiating the contents of the packfile to be sent by
6110         the server.  Set to "consecutive" to use an algorithm that walks
6111         over consecutive commits checking each one.  Set to "skipping" to
6112         use an algorithm that skips commits in an effort to converge
6113         faster, but may result in a larger-than-necessary packfile; or set
6114         to "noop" to not send any information at all, which will almost
6115         certainly result in a larger-than-necessary packfile, but will skip
6116         the negotiation step.  Set to "default" to override settings made
6117         previously and use the default behaviour.  The default is normally
6118         "consecutive", but if <code>feature.experimental</code> is true, then the
6119         default is "skipping".  Unknown values will cause <em>git fetch</em> to
6120         error out.
6121 </p>
6122 <div class="paragraph"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
6123 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
6124 </dd>
6125 <dt class="hdlist1">
6126 fetch.showForcedUpdates
6127 </dt>
6128 <dd>
6129 <p>
6130         Set to false to enable <code>--no-show-forced-updates</code> in
6131         <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
6132         Defaults to true.
6133 </p>
6134 </dd>
6135 <dt class="hdlist1">
6136 fetch.parallel
6137 </dt>
6138 <dd>
6139 <p>
6140         Specifies the maximal number of fetch operations to be run in parallel
6141         at a time (submodules, or remotes when the <code>--multiple</code> option of
6142         <a href="git-fetch.html">git-fetch(1)</a> is in effect).
6143 </p>
6144 <div class="paragraph"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
6145 <div class="paragraph"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
6146 config setting.</p></div>
6147 </dd>
6148 <dt class="hdlist1">
6149 fetch.writeCommitGraph
6150 </dt>
6151 <dd>
6152 <p>
6153         Set to true to write a commit-graph after every <code>git fetch</code> command
6154         that downloads a pack-file from a remote. Using the <code>--split</code> option,
6155         most executions will create a very small commit-graph file on top of
6156         the existing commit-graph file(s). Occasionally, these files will
6157         merge and the write may take longer. Having an updated commit-graph
6158         file helps performance of many Git commands, including <code>git merge-base</code>,
6159         <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
6160 </p>
6161 </dd>
6162 <dt class="hdlist1">
6163 fetch.bundleURI
6164 </dt>
6165 <dd>
6166 <p>
6167         This value stores a URI for downloading Git object data from a bundle
6168         URI before performing an incremental fetch from the origin Git server.
6169         This is similar to how the <code>--bundle-uri</code> option behaves in
6170         <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
6171         <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
6172         list that is organized for incremental fetches.
6173 </p>
6174 <div class="paragraph"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
6175 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
6176 the new bundle URI.</p></div>
6177 </dd>
6178 <dt class="hdlist1">
6179 fetch.bundleCreationToken
6180 </dt>
6181 <dd>
6182 <p>
6183         When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
6184         list that uses the "creationToken" heuristic, this config value
6185         stores the maximum <code>creationToken</code> value of the downloaded bundles.
6186         This value is used to prevent downloading bundles in the future
6187         if the advertised <code>creationToken</code> is not strictly larger than this
6188         value.
6189 </p>
6190 <div class="paragraph"><p>The creation token values are chosen by the provider serving the specific
6191 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
6192 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
6193 </dd>
6194 <dt class="hdlist1">
6195 filter.&lt;driver&gt;.clean
6196 </dt>
6197 <dd>
6198 <p>
6199         The command which is used to convert the content of a worktree
6200         file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
6201         details.
6202 </p>
6203 </dd>
6204 <dt class="hdlist1">
6205 filter.&lt;driver&gt;.smudge
6206 </dt>
6207 <dd>
6208 <p>
6209         The command which is used to convert the content of a blob
6210         object to a worktree file upon checkout.  See
6211         <a href="gitattributes.html">gitattributes(5)</a> for details.
6212 </p>
6213 </dd>
6214 <dt class="hdlist1">
6215 format.attach
6216 </dt>
6217 <dd>
6218 <p>
6219         Enable multipart/mixed attachments as the default for
6220         <em>format-patch</em>.  The value can also be a double quoted string
6221         which will enable attachments as the default and set the
6222         value as the boundary.  See the --attach option in
6223         <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
6224         value, set it to an empty string.
6225 </p>
6226 </dd>
6227 <dt class="hdlist1">
6228 format.from
6229 </dt>
6230 <dd>
6231 <p>
6232         Provides the default value for the <code>--from</code> option to format-patch.
6233         Accepts a boolean value, or a name and email address.  If false,
6234         format-patch defaults to <code>--no-from</code>, using commit authors directly in
6235         the "From:" field of patch mails.  If true, format-patch defaults to
6236         <code>--from</code>, using your committer identity in the "From:" field of patch
6237         mails and including a "From:" field in the body of the patch mail if
6238         different.  If set to a non-boolean value, format-patch uses that
6239         value instead of your committer identity.  Defaults to false.
6240 </p>
6241 </dd>
6242 <dt class="hdlist1">
6243 format.forceInBodyFrom
6244 </dt>
6245 <dd>
6246 <p>
6247         Provides the default value for the <code>--[no-]force-in-body-from</code>
6248         option to format-patch.  Defaults to false.
6249 </p>
6250 </dd>
6251 <dt class="hdlist1">
6252 format.numbered
6253 </dt>
6254 <dd>
6255 <p>
6256         A boolean which can enable or disable sequence numbers in patch
6257         subjects.  It defaults to "auto" which enables it only if there
6258         is more than one patch.  It can be enabled or disabled for all
6259         messages by setting it to "true" or "false".  See --numbered
6260         option in <a href="git-format-patch.html">git-format-patch(1)</a>.
6261 </p>
6262 </dd>
6263 <dt class="hdlist1">
6264 format.headers
6265 </dt>
6266 <dd>
6267 <p>
6268         Additional email headers to include in a patch to be submitted
6269         by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.
6270 </p>
6271 </dd>
6272 <dt class="hdlist1">
6273 format.to
6274 </dt>
6275 <dt class="hdlist1">
6276 format.cc
6277 </dt>
6278 <dd>
6279 <p>
6280         Additional recipients to include in a patch to be submitted
6281         by mail.  See the --to and --cc options in
6282         <a href="git-format-patch.html">git-format-patch(1)</a>.
6283 </p>
6284 </dd>
6285 <dt class="hdlist1">
6286 format.subjectPrefix
6287 </dt>
6288 <dd>
6289 <p>
6290         The default for format-patch is to output files with the <em>[PATCH]</em>
6291         subject prefix. Use this variable to change that prefix.
6292 </p>
6293 </dd>
6294 <dt class="hdlist1">
6295 format.coverFromDescription
6296 </dt>
6297 <dd>
6298 <p>
6299         The default mode for format-patch to determine which parts of
6300         the cover letter will be populated using the branch&#8217;s
6301         description. See the <code>--cover-from-description</code> option in
6302         <a href="git-format-patch.html">git-format-patch(1)</a>.
6303 </p>
6304 </dd>
6305 <dt class="hdlist1">
6306 format.signature
6307 </dt>
6308 <dd>
6309 <p>
6310         The default for format-patch is to output a signature containing
6311         the Git version number. Use this variable to change that default.
6312         Set this variable to the empty string ("") to suppress
6313         signature generation.
6314 </p>
6315 </dd>
6316 <dt class="hdlist1">
6317 format.signatureFile
6318 </dt>
6319 <dd>
6320 <p>
6321         Works just like format.signature except the contents of the
6322         file specified by this variable will be used as the signature.
6323 </p>
6324 </dd>
6325 <dt class="hdlist1">
6326 format.suffix
6327 </dt>
6328 <dd>
6329 <p>
6330         The default for format-patch is to output files with the suffix
6331         <code>.patch</code>. Use this variable to change that suffix (make sure to
6332         include the dot if you want it).
6333 </p>
6334 </dd>
6335 <dt class="hdlist1">
6336 format.encodeEmailHeaders
6337 </dt>
6338 <dd>
6339 <p>
6340         Encode email headers that have non-ASCII characters with
6341         "Q-encoding" (described in RFC 2047) for email transmission.
6342         Defaults to true.
6343 </p>
6344 </dd>
6345 <dt class="hdlist1">
6346 format.pretty
6347 </dt>
6348 <dd>
6349 <p>
6350         The default pretty format for log/show/whatchanged command.
6351         See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
6352         <a href="git-whatchanged.html">git-whatchanged(1)</a>.
6353 </p>
6354 </dd>
6355 <dt class="hdlist1">
6356 format.thread
6357 </dt>
6358 <dd>
6359 <p>
6360         The default threading style for <em>git format-patch</em>.  Can be
6361         a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
6362         makes every mail a reply to the head of the series,
6363         where the head is chosen from the cover letter, the
6364         <code>--in-reply-to</code>, and the first patch mail, in this order.
6365         <code>deep</code> threading makes every mail a reply to the previous one.
6366         A true boolean value is the same as <code>shallow</code>, and a false
6367         value disables threading.
6368 </p>
6369 </dd>
6370 <dt class="hdlist1">
6371 format.signOff
6372 </dt>
6373 <dd>
6374 <p>
6375         A boolean value which lets you enable the <code>-s/--signoff</code> option of
6376         format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
6377         patch should be a conscious act and means that you certify you have
6378         the rights to submit this work under the same open source license.
6379         Please see the <em>SubmittingPatches</em> document for further discussion.
6380 </p>
6381 </dd>
6382 <dt class="hdlist1">
6383 format.coverLetter
6384 </dt>
6385 <dd>
6386 <p>
6387         A boolean that controls whether to generate a cover-letter when
6388         format-patch is invoked, but in addition can be set to "auto", to
6389         generate a cover-letter only when there&#8217;s more than one patch.
6390         Default is false.
6391 </p>
6392 </dd>
6393 <dt class="hdlist1">
6394 format.outputDirectory
6395 </dt>
6396 <dd>
6397 <p>
6398         Set a custom directory to store the resulting files instead of the
6399         current working directory. All directory components will be created.
6400 </p>
6401 </dd>
6402 <dt class="hdlist1">
6403 format.filenameMaxLength
6404 </dt>
6405 <dd>
6406 <p>
6407         The maximum length of the output filenames generated by the
6408         <code>format-patch</code> command; defaults to 64.  Can be overridden
6409         by the <code>--filename-max-length=&lt;n&gt;</code> command line option.
6410 </p>
6411 </dd>
6412 <dt class="hdlist1">
6413 format.useAutoBase
6414 </dt>
6415 <dd>
6416 <p>
6417         A boolean value which lets you enable the <code>--base=auto</code> option of
6418         format-patch by default. Can also be set to "whenAble" to allow
6419         enabling <code>--base=auto</code> if a suitable base is available, but to skip
6420         adding base info otherwise without the format dying.
6421 </p>
6422 </dd>
6423 <dt class="hdlist1">
6424 format.notes
6425 </dt>
6426 <dd>
6427 <p>
6428         Provides the default value for the <code>--notes</code> option to
6429         format-patch. Accepts a boolean value, or a ref which specifies
6430         where to get notes. If false, format-patch defaults to
6431         <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
6432         set to a non-boolean value, format-patch defaults to
6433         <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
6434         to false.
6435 </p>
6436 <div class="paragraph"><p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
6437 instead.</p></div>
6438 <div class="paragraph"><p>This configuration can be specified multiple times in order to allow
6439 multiple notes refs to be included. In that case, it will behave
6440 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
6441 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
6442 also show notes from that notes ref and a value of <code>false</code> will negate
6443 previous configurations and not show notes.</p></div>
6444 <div class="paragraph"><p>For example,</p></div>
6445 <div class="listingblock">
6446 <div class="content">
6447 <pre><code>[format]
6448         notes = true
6449         notes = foo
6450         notes = false
6451         notes = bar</code></pre>
6452 </div></div>
6453 <div class="paragraph"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
6454 </dd>
6455 <dt class="hdlist1">
6456 format.mboxrd
6457 </dt>
6458 <dd>
6459 <p>
6460         A boolean value which enables the robust "mboxrd" format when
6461         <code>--stdout</code> is in use to escape "^&gt;+From " lines.
6462 </p>
6463 </dd>
6464 <dt class="hdlist1">
6465 format.noprefix
6466 </dt>
6467 <dd>
6468 <p>
6469         If set, do not show any source or destination prefix in patches.
6470         This is equivalent to the <code>diff.noprefix</code> option used by <code>git
6471         diff</code> (but which is not respected by <code>format-patch</code>). Note that
6472         by setting this, the receiver of any patches you generate will
6473         have to apply them using the <code>-p0</code> option.
6474 </p>
6475 </dd>
6476 <dt class="hdlist1">
6477 fsck.&lt;msg-id&gt;
6478 </dt>
6479 <dd>
6480 <p>
6481         During fsck git may find issues with legacy data which
6482         wouldn&#8217;t be generated by current versions of git, and which
6483         wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
6484         set. This feature is intended to support working with legacy
6485         repositories containing such data.
6486 </p>
6487 <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
6488 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
6489 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
6490 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
6491 same applies for the corresponding <code>receive.fsck.*</code> and
6492 <code>fetch.fsck.*</code>. variables.</p></div>
6493 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
6494 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
6495 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
6496 uniformly configure the same fsck settings in different circumstances,
6497 all three of them must be set to the same values.</p></div>
6498 <div class="paragraph"><p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
6499 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
6500 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
6501 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
6502 with the message ID, e.g. "missingEmail: invalid author/committer
6503 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
6504 will hide that issue.</p></div>
6505 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
6506 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6507 problematic objects share to be ignored, as doing the latter will
6508 allow new instances of the same breakages go unnoticed.</p></div>
6509 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
6510 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
6511 will only cause git to warn.</p></div>
6512 <div class="paragraph"><p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
6513 values of <code>&lt;msg-id&gt;</code>.</p></div>
6514 </dd>
6515 <dt class="hdlist1">
6516 fsck.skipList
6517 </dt>
6518 <dd>
6519 <p>
6520         The path to a list of object names (i.e. one unabbreviated SHA-1 per
6521         line) that are known to be broken in a non-fatal way and should
6522         be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
6523         lines, and any leading and trailing whitespace are ignored. Everything
6524         but a SHA-1 per line will error out on older versions.
6525 </p>
6526 <div class="paragraph"><p>This feature is useful when an established project should be accepted
6527 despite early commits containing errors that can be safely ignored,
6528 such as invalid committer email addresses.  Note: corrupt objects
6529 cannot be skipped with this setting.</p></div>
6530 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
6531 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6532 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6533 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6534 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
6535 uniformly configure the same fsck settings in different circumstances,
6536 all three of them must be set to the same values.</p></div>
6537 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
6538 list should be sorted. This was never a requirement; the object names
6539 could appear in any order, but when reading the list we tracked whether
6540 the list was sorted for the purposes of an internal binary search
6541 implementation, which could save itself some work with an already sorted
6542 list. Unless you had a humongous list there was no reason to go out of
6543 your way to pre-sort the list. After Git version 2.20 a hash implementation
6544 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
6545 </dd>
6546 <dt class="hdlist1">
6547 fsmonitor.allowRemote
6548 </dt>
6549 <dd>
6550 <p>
6551     By default, the fsmonitor daemon refuses to work with network-mounted
6552     repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6553     behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6554 </p>
6555 </dd>
6556 <dt class="hdlist1">
6557 fsmonitor.socketDir
6558 </dt>
6559 <dd>
6560 <p>
6561     This Mac OS-specific option, if set, specifies the directory in
6562     which to create the Unix domain socket used for communication
6563     between the fsmonitor daemon and various Git commands. The directory must
6564     reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
6565     is set to <code>true</code>.
6566 </p>
6567 </dd>
6568 <dt class="hdlist1">
6569 gc.aggressiveDepth
6570 </dt>
6571 <dd>
6572 <p>
6573         The depth parameter used in the delta compression
6574         algorithm used by <em>git gc --aggressive</em>.  This defaults
6575         to 50, which is the default for the <code>--depth</code> option when
6576         <code>--aggressive</code> isn&#8217;t in use.
6577 </p>
6578 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
6579 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6580 </dd>
6581 <dt class="hdlist1">
6582 gc.aggressiveWindow
6583 </dt>
6584 <dd>
6585 <p>
6586         The window size parameter used in the delta compression
6587         algorithm used by <em>git gc --aggressive</em>.  This defaults
6588         to 250, which is a much more aggressive window size than
6589         the default <code>--window</code> of 10.
6590 </p>
6591 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
6592 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6593 </dd>
6594 <dt class="hdlist1">
6595 gc.auto
6596 </dt>
6597 <dd>
6598 <p>
6599         When there are approximately more than this many loose
6600         objects in the repository, <code>git gc --auto</code> will pack them.
6601         Some Porcelain commands use this command to perform a
6602         light-weight garbage collection from time to time.  The
6603         default value is 6700.
6604 </p>
6605 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
6606 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
6607 otherwise use to determine if there&#8217;s work to do, such as
6608 <code>gc.autoPackLimit</code>.</p></div>
6609 </dd>
6610 <dt class="hdlist1">
6611 gc.autoPackLimit
6612 </dt>
6613 <dd>
6614 <p>
6615         When there are more than this many packs that are not
6616         marked with <code>*.keep</code> file in the repository, <code>git gc
6617         --auto</code> consolidates them into one larger pack.  The
6618         default value is 50.  Setting this to 0 disables it.
6619         Setting <code>gc.auto</code> to 0 will also disable this.
6620 </p>
6621 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6622 use, it&#8217;ll affect how the auto pack limit works.</p></div>
6623 </dd>
6624 <dt class="hdlist1">
6625 gc.autoDetach
6626 </dt>
6627 <dd>
6628 <p>
6629         Make <code>git gc --auto</code> return immediately and run in the background
6630         if the system supports it. Default is true.
6631 </p>
6632 </dd>
6633 <dt class="hdlist1">
6634 gc.bigPackThreshold
6635 </dt>
6636 <dd>
6637 <p>
6638         If non-zero, all non-cruft packs larger than this limit are kept
6639         when <code>git gc</code> is run. This is very similar to
6640         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6641         the threshold are kept, not just the largest pack. Defaults to
6642         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6643 </p>
6644 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6645 this configuration variable is ignored, all packs except the base pack
6646 will be repacked. After this the number of packs should go below
6647 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6648 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6649 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6650 will also be excluded (this is the equivalent of running <code>git gc</code> with
6651 <code>--keep-largest-pack</code>).</p></div>
6652 </dd>
6653 <dt class="hdlist1">
6654 gc.writeCommitGraph
6655 </dt>
6656 <dd>
6657 <p>
6658         If true, then gc will rewrite the commit-graph file when
6659         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6660         the commit-graph will be updated if housekeeping is
6661         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
6662         for details.
6663 </p>
6664 </dd>
6665 <dt class="hdlist1">
6666 gc.logExpiry
6667 </dt>
6668 <dd>
6669 <p>
6670         If the file gc.log exists, then <code>git gc --auto</code> will print
6671         its content and exit with status zero instead of running
6672         unless that file is more than <em>gc.logExpiry</em> old.  Default is
6673         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
6674         value.
6675 </p>
6676 </dd>
6677 <dt class="hdlist1">
6678 gc.packRefs
6679 </dt>
6680 <dd>
6681 <p>
6682         Running <code>git pack-refs</code> in a repository renders it
6683         unclonable by Git versions prior to 1.5.1.2 over dumb
6684         transports such as HTTP.  This variable determines whether
6685         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6686         to enable it within all non-bare repos or it can be set to a
6687         boolean value.  The default is <code>true</code>.
6688 </p>
6689 </dd>
6690 <dt class="hdlist1">
6691 gc.cruftPacks
6692 </dt>
6693 <dd>
6694 <p>
6695         Store unreachable objects in a cruft pack (see
6696         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
6697         is <code>true</code>.
6698 </p>
6699 </dd>
6700 <dt class="hdlist1">
6701 gc.maxCruftSize
6702 </dt>
6703 <dd>
6704 <p>
6705         Limit the size of new cruft packs when repacking. When
6706         specified in addition to <code>--max-cruft-size</code>, the command line
6707         option takes priority. See the <code>--max-cruft-size</code> option of
6708         <a href="git-repack.html">git-repack(1)</a>.
6709 </p>
6710 </dd>
6711 <dt class="hdlist1">
6712 gc.pruneExpire
6713 </dt>
6714 <dd>
6715 <p>
6716         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6717         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6718         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
6719         grace period with this config variable.  The value "now" may be
6720         used to disable this grace period and always prune unreachable
6721         objects immediately, or "never" may be used to suppress pruning.
6722         This feature helps prevent corruption when <em>git gc</em> runs
6723         concurrently with another process writing to the repository; see
6724         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
6725 </p>
6726 </dd>
6727 <dt class="hdlist1">
6728 gc.worktreePruneExpire
6729 </dt>
6730 <dd>
6731 <p>
6732         When <em>git gc</em> is run, it calls
6733         <em>git worktree prune --expire 3.months.ago</em>.
6734         This config variable can be used to set a different grace
6735         period. The value "now" may be used to disable the grace
6736         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
6737         may be used to suppress pruning.
6738 </p>
6739 </dd>
6740 <dt class="hdlist1">
6741 gc.reflogExpire
6742 </dt>
6743 <dt class="hdlist1">
6744 gc.&lt;pattern&gt;.reflogExpire
6745 </dt>
6746 <dd>
6747 <p>
6748         <em>git reflog expire</em> removes reflog entries older than
6749         this time; defaults to 90 days. The value "now" expires all
6750         entries immediately, and "never" suppresses expiration
6751         altogether. With "&lt;pattern&gt;" (e.g.
6752         "refs/stash") in the middle the setting applies only to
6753         the refs that match the &lt;pattern&gt;.
6754 </p>
6755 </dd>
6756 <dt class="hdlist1">
6757 gc.reflogExpireUnreachable
6758 </dt>
6759 <dt class="hdlist1">
6760 gc.&lt;pattern&gt;.reflogExpireUnreachable
6761 </dt>
6762 <dd>
6763 <p>
6764         <em>git reflog expire</em> removes reflog entries older than
6765         this time and are not reachable from the current tip;
6766         defaults to 30 days. The value "now" expires all entries
6767         immediately, and "never" suppresses expiration altogether.
6768         With "&lt;pattern&gt;" (e.g. "refs/stash")
6769         in the middle, the setting applies only to the refs that
6770         match the &lt;pattern&gt;.
6771 </p>
6772 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
6773 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6774 or rebase occurring.  Since these changes are not part of the current
6775 project most users will want to expire them sooner, which is why the
6776 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6777 </dd>
6778 <dt class="hdlist1">
6779 gc.recentObjectsHook
6780 </dt>
6781 <dd>
6782 <p>
6783         When considering whether or not to remove an object (either when
6784         generating a cruft pack or storing unreachable objects as
6785         loose), use the shell to execute the specified command(s).
6786         Interpret their output as object IDs which Git will consider as
6787         "recent", regardless of their age. By treating their mtimes as
6788         "now", any objects (and their descendants) mentioned in the
6789         output will be kept regardless of their true age.
6790 </p>
6791 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
6792 else. Objects which cannot be found in the repository are ignored.
6793 Multiple hooks are supported, but all must exit successfully, else the
6794 operation (either generating a cruft pack or unpacking unreachable
6795 objects) will be halted.</p></div>
6796 </dd>
6797 <dt class="hdlist1">
6798 gc.repackFilter
6799 </dt>
6800 <dd>
6801 <p>
6802         When repacking, use the specified filter to move certain
6803         objects into a separate packfile.  See the
6804         <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.
6805 </p>
6806 </dd>
6807 <dt class="hdlist1">
6808 gc.repackFilterTo
6809 </dt>
6810 <dd>
6811 <p>
6812         When repacking and using a filter, see <code>gc.repackFilter</code>, the
6813         specified location will be used to create the packfile
6814         containing the filtered out objects. <strong>WARNING:</strong> The
6815         specified location should be accessible, using for example the
6816         Git alternates mechanism, otherwise the repo could be
6817         considered corrupt by Git as it migh not be able to access the
6818         objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
6819         of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
6820         section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.
6821 </p>
6822 </dd>
6823 <dt class="hdlist1">
6824 gc.rerereResolved
6825 </dt>
6826 <dd>
6827 <p>
6828         Records of conflicted merge you resolved earlier are
6829         kept for this many days when <em>git rerere gc</em> is run.
6830         You can also use more human-readable "1.month.ago", etc.
6831         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6832 </p>
6833 </dd>
6834 <dt class="hdlist1">
6835 gc.rerereUnresolved
6836 </dt>
6837 <dd>
6838 <p>
6839         Records of conflicted merge you have not resolved are
6840         kept for this many days when <em>git rerere gc</em> is run.
6841         You can also use more human-readable "1.month.ago", etc.
6842         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6843 </p>
6844 </dd>
6845 <dt class="hdlist1">
6846 gitcvs.commitMsgAnnotation
6847 </dt>
6848 <dd>
6849 <p>
6850         Append this string to each commit message. Set to empty string
6851         to disable this feature. Defaults to "via git-CVS emulator".
6852 </p>
6853 </dd>
6854 <dt class="hdlist1">
6855 gitcvs.enabled
6856 </dt>
6857 <dd>
6858 <p>
6859         Whether the CVS server interface is enabled for this repository.
6860         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6861 </p>
6862 </dd>
6863 <dt class="hdlist1">
6864 gitcvs.logFile
6865 </dt>
6866 <dd>
6867 <p>
6868         Path to a log file where the CVS server interface well&#8230; logs
6869         various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6870 </p>
6871 </dd>
6872 <dt class="hdlist1">
6873 gitcvs.usecrlfattr
6874 </dt>
6875 <dd>
6876 <p>
6877         If true, the server will look up the end-of-line conversion
6878         attributes for files to determine the <code>-k</code> modes to use. If
6879         the attributes force Git to treat a file as text,
6880         the <code>-k</code> mode will be left blank so CVS clients will
6881         treat it as text. If they suppress text conversion, the file
6882         will be set with <em>-kb</em> mode, which suppresses any newline munging
6883         the client might otherwise do. If the attributes do not allow
6884         the file type to be determined, then <code>gitcvs.allBinary</code> is
6885         used. See <a href="gitattributes.html">gitattributes(5)</a>.
6886 </p>
6887 </dd>
6888 <dt class="hdlist1">
6889 gitcvs.allBinary
6890 </dt>
6891 <dd>
6892 <p>
6893         This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6894         the correct <em>-kb</em> mode to use. If true, all
6895         unresolved files are sent to the client in
6896         mode <em>-kb</em>. This causes the client to treat them
6897         as binary files, which suppresses any newline munging it
6898         otherwise might do. Alternatively, if it is set to "guess",
6899         then the contents of the file are examined to decide if
6900         it is binary, similar to <code>core.autocrlf</code>.
6901 </p>
6902 </dd>
6903 <dt class="hdlist1">
6904 gitcvs.dbName
6905 </dt>
6906 <dd>
6907 <p>
6908         Database used by git-cvsserver to cache revision information
6909         derived from the Git repository. The exact meaning depends on the
6910         used database driver, for SQLite (which is the default driver) this
6911         is a filename. Supports variable substitution (see
6912         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6913         Default: <em>%Ggitcvs.%m.sqlite</em>
6914 </p>
6915 </dd>
6916 <dt class="hdlist1">
6917 gitcvs.dbDriver
6918 </dt>
6919 <dd>
6920 <p>
6921         Used Perl DBI driver. You can specify any available driver
6922         for this here, but it might not work. git-cvsserver is tested
6923         with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6924         reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6925         May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6926         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6927 </p>
6928 </dd>
6929 <dt class="hdlist1">
6930 gitcvs.dbUser, gitcvs.dbPass
6931 </dt>
6932 <dd>
6933 <p>
6934         Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6935         since SQLite has no concept of database users and/or passwords.
6936         <em>gitcvs.dbUser</em> supports variable substitution (see
6937         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
6938 </p>
6939 </dd>
6940 <dt class="hdlist1">
6941 gitcvs.dbTableNamePrefix
6942 </dt>
6943 <dd>
6944 <p>
6945         Database table name prefix.  Prepended to the names of any
6946         database tables used, allowing a single database to be used
6947         for several repositories.  Supports variable substitution (see
6948         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
6949         characters will be replaced with underscores.
6950 </p>
6951 </dd>
6952 </dl></div>
6953 <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6954 <code>gitcvs.allBinary</code> can also be specified as
6955 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
6956 is one of "ext" and "pserver") to make them apply only for the given
6957 access method.</p></div>
6958 <div class="dlist"><dl>
6959 <dt class="hdlist1">
6960 gitweb.category
6961 </dt>
6962 <dt class="hdlist1">
6963 gitweb.description
6964 </dt>
6965 <dt class="hdlist1">
6966 gitweb.owner
6967 </dt>
6968 <dt class="hdlist1">
6969 gitweb.url
6970 </dt>
6971 <dd>
6972 <p>
6973         See <a href="gitweb.html">gitweb(1)</a> for description.
6974 </p>
6975 </dd>
6976 <dt class="hdlist1">
6977 gitweb.avatar
6978 </dt>
6979 <dt class="hdlist1">
6980 gitweb.blame
6981 </dt>
6982 <dt class="hdlist1">
6983 gitweb.grep
6984 </dt>
6985 <dt class="hdlist1">
6986 gitweb.highlight
6987 </dt>
6988 <dt class="hdlist1">
6989 gitweb.patches
6990 </dt>
6991 <dt class="hdlist1">
6992 gitweb.pickaxe
6993 </dt>
6994 <dt class="hdlist1">
6995 gitweb.remote_heads
6996 </dt>
6997 <dt class="hdlist1">
6998 gitweb.showSizes
6999 </dt>
7000 <dt class="hdlist1">
7001 gitweb.snapshot
7002 </dt>
7003 <dd>
7004 <p>
7005         See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
7006 </p>
7007 </dd>
7008 <dt class="hdlist1">
7009 gpg.program
7010 </dt>
7011 <dd>
7012 <p>
7013         Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
7014         making or verifying a PGP signature. The program must support the
7015         same command-line interface as GPG, namely, to verify a detached
7016         signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
7017         program is expected to signal a good signature by exiting with
7018         code 0.  To generate an ASCII-armored detached signature, the
7019         standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
7020         signed, and the program is expected to send the result to its
7021         standard output.
7022 </p>
7023 </dd>
7024 <dt class="hdlist1">
7025 gpg.format
7026 </dt>
7027 <dd>
7028 <p>
7029         Specifies which key format to use when signing with <code>--gpg-sign</code>.
7030         Default is "openpgp". Other possible values are "x509", "ssh".
7031 </p>
7032 <div class="paragraph"><p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
7033 based on the selected <code>gpg.format</code>.</p></div>
7034 </dd>
7035 <dt class="hdlist1">
7036 gpg.&lt;format&gt;.program
7037 </dt>
7038 <dd>
7039 <p>
7040         Use this to customize the program used for the signing format you
7041         chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
7042         be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
7043         value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".
7044 </p>
7045 </dd>
7046 <dt class="hdlist1">
7047 gpg.minTrustLevel
7048 </dt>
7049 <dd>
7050 <p>
7051         Specifies a minimum trust level for signature verification.  If
7052         this option is unset, then signature verification for merge
7053         operations requires a key with at least <code>marginal</code> trust.  Other
7054         operations that perform signature verification require a key
7055         with at least <code>undefined</code> trust.  Setting this option overrides
7056         the required trust-level for all operations.  Supported values,
7057         in increasing order of significance:
7058 </p>
7059 <div class="ulist"><ul>
7060 <li>
7061 <p>
7062 <code>undefined</code>
7063 </p>
7064 </li>
7065 <li>
7066 <p>
7067 <code>never</code>
7068 </p>
7069 </li>
7070 <li>
7071 <p>
7072 <code>marginal</code>
7073 </p>
7074 </li>
7075 <li>
7076 <p>
7077 <code>fully</code>
7078 </p>
7079 </li>
7080 <li>
7081 <p>
7082 <code>ultimate</code>
7083 </p>
7084 </li>
7085 </ul></div>
7086 </dd>
7087 <dt class="hdlist1">
7088 gpg.ssh.defaultKeyCommand
7089 </dt>
7090 <dd>
7091 <p>
7092         This command will be run when user.signingkey is not set and a ssh
7093         signature is requested. On successful exit a valid ssh public key
7094         prefixed with <code>key::</code> is expected in the first line of its output.
7095         This allows for a script doing a dynamic lookup of the correct public
7096         key when it is impractical to statically configure <code>user.signingKey</code>.
7097         For example when keys or SSH Certificates are rotated frequently or
7098         selection of the right key depends on external factors unknown to git.
7099 </p>
7100 </dd>
7101 <dt class="hdlist1">
7102 gpg.ssh.allowedSignersFile
7103 </dt>
7104 <dd>
7105 <p>
7106         A file containing ssh public keys which you are willing to trust.
7107         The file consists of one or more lines of principals followed by an ssh
7108         public key.
7109         e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
7110         See ssh-keygen(1) "ALLOWED SIGNERS" for details.
7111         The principal is only used to identify the key and is available when
7112         verifying a signature.
7113 </p>
7114 <div class="paragraph"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
7115 between valid signatures and trusted signatures the trust level of a signature
7116 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
7117 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
7118 <div class="paragraph"><p>This file can be set to a location outside of the repository and every developer
7119 maintains their own trust store. A central repository server could generate this
7120 file automatically from ssh keys with push access to verify the code against.
7121 In a corporate setting this file is probably generated at a global location
7122 from automation that already handles developer ssh keys.</p></div>
7123 <div class="paragraph"><p>A repository that only allows signed commits can store the file
7124 in the repository itself using a path relative to the top-level of the working tree.
7125 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
7126 <div class="paragraph"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
7127 valid-before options. Git will mark signatures as valid if the signing key was
7128 valid at the time of the signature&#8217;s creation. This allows users to change a
7129 signing key without invalidating all previously made signatures.</p></div>
7130 <div class="paragraph"><p>Using a SSH CA key with the cert-authority option
7131 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p></div>
7132 </dd>
7133 <dt class="hdlist1">
7134 gpg.ssh.revocationFile
7135 </dt>
7136 <dd>
7137 <p>
7138         Either a SSH KRL or a list of revoked public keys (without the principal prefix).
7139         See ssh-keygen(1) for details.
7140         If a public key is found in this file then it will always be treated
7141         as having trust level "never" and signatures will show as invalid.
7142 </p>
7143 </dd>
7144 <dt class="hdlist1">
7145 grep.lineNumber
7146 </dt>
7147 <dd>
7148 <p>
7149         If set to true, enable <code>-n</code> option by default.
7150 </p>
7151 </dd>
7152 <dt class="hdlist1">
7153 grep.column
7154 </dt>
7155 <dd>
7156 <p>
7157         If set to true, enable the <code>--column</code> option by default.
7158 </p>
7159 </dd>
7160 <dt class="hdlist1">
7161 grep.patternType
7162 </dt>
7163 <dd>
7164 <p>
7165         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
7166         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
7167         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
7168         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
7169         between <em>basic</em> and <em>extended</em>.
7170 </p>
7171 </dd>
7172 <dt class="hdlist1">
7173 grep.extendedRegexp
7174 </dt>
7175 <dd>
7176 <p>
7177         If set to true, enable <code>--extended-regexp</code> option by default. This
7178         option is ignored when the <code>grep.patternType</code> option is set to a value
7179         other than <em>default</em>.
7180 </p>
7181 </dd>
7182 <dt class="hdlist1">
7183 grep.threads
7184 </dt>
7185 <dd>
7186 <p>
7187         Number of grep worker threads to use. If unset (or set to 0), Git will
7188         use as many threads as the number of logical cores available.
7189 </p>
7190 </dd>
7191 <dt class="hdlist1">
7192 grep.fullName
7193 </dt>
7194 <dd>
7195 <p>
7196         If set to true, enable <code>--full-name</code> option by default.
7197 </p>
7198 </dd>
7199 <dt class="hdlist1">
7200 grep.fallbackToNoIndex
7201 </dt>
7202 <dd>
7203 <p>
7204         If set to true, fall back to <code>git grep --no-index</code> if <code>git grep</code>
7205         is executed outside of a git repository.  Defaults to false.
7206 </p>
7207 </dd>
7208 <dt class="hdlist1">
7209 gui.commitMsgWidth
7210 </dt>
7211 <dd>
7212 <p>
7213         Defines how wide the commit message window is in the
7214         <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
7215 </p>
7216 </dd>
7217 <dt class="hdlist1">
7218 gui.diffContext
7219 </dt>
7220 <dd>
7221 <p>
7222         Specifies how many context lines should be used in calls to diff
7223         made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
7224 </p>
7225 </dd>
7226 <dt class="hdlist1">
7227 gui.displayUntracked
7228 </dt>
7229 <dd>
7230 <p>
7231         Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
7232         in the file list. The default is "true".
7233 </p>
7234 </dd>
7235 <dt class="hdlist1">
7236 gui.encoding
7237 </dt>
7238 <dd>
7239 <p>
7240         Specifies the default character encoding to use for displaying of
7241         file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
7242         It can be overridden by setting the <em>encoding</em> attribute
7243         for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
7244         If this option is not set, the tools default to the
7245         locale encoding.
7246 </p>
7247 </dd>
7248 <dt class="hdlist1">
7249 gui.matchTrackingBranch
7250 </dt>
7251 <dd>
7252 <p>
7253         Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
7254         default to tracking remote branches with matching names or
7255         not. Default: "false".
7256 </p>
7257 </dd>
7258 <dt class="hdlist1">
7259 gui.newBranchTemplate
7260 </dt>
7261 <dd>
7262 <p>
7263         Is used as a suggested name when creating new branches using the
7264         <a href="git-gui.html">git-gui(1)</a>.
7265 </p>
7266 </dd>
7267 <dt class="hdlist1">
7268 gui.pruneDuringFetch
7269 </dt>
7270 <dd>
7271 <p>
7272         "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
7273         performing a fetch. The default value is "false".
7274 </p>
7275 </dd>
7276 <dt class="hdlist1">
7277 gui.trustmtime
7278 </dt>
7279 <dd>
7280 <p>
7281         Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
7282         timestamp or not. By default the timestamps are not trusted.
7283 </p>
7284 </dd>
7285 <dt class="hdlist1">
7286 gui.spellingDictionary
7287 </dt>
7288 <dd>
7289 <p>
7290         Specifies the dictionary used for spell checking commit messages in
7291         the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
7292         off.
7293 </p>
7294 </dd>
7295 <dt class="hdlist1">
7296 gui.fastCopyBlame
7297 </dt>
7298 <dd>
7299 <p>
7300         If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
7301         location detection. It makes blame significantly faster on huge
7302         repositories at the expense of less thorough copy detection.
7303 </p>
7304 </dd>
7305 <dt class="hdlist1">
7306 gui.copyBlameThreshold
7307 </dt>
7308 <dd>
7309 <p>
7310         Specifies the threshold to use in <em>git gui blame</em> original location
7311         detection, measured in alphanumeric characters. See the
7312         <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
7313 </p>
7314 </dd>
7315 <dt class="hdlist1">
7316 gui.blamehistoryctx
7317 </dt>
7318 <dd>
7319 <p>
7320         Specifies the radius of history context in days to show in
7321         <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
7322         Context</code> menu item is invoked from <em>git gui blame</em>. If this
7323         variable is set to zero, the whole history is shown.
7324 </p>
7325 </dd>
7326 <dt class="hdlist1">
7327 guitool.&lt;name&gt;.cmd
7328 </dt>
7329 <dd>
7330 <p>
7331         Specifies the shell command line to execute when the corresponding item
7332         of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
7333         mandatory for every tool. The command is executed from the root of
7334         the working directory, and in the environment it receives the name of
7335         the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
7336         <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
7337         the head is detached, <em>CUR_BRANCH</em> is empty).
7338 </p>
7339 </dd>
7340 <dt class="hdlist1">
7341 guitool.&lt;name&gt;.needsFile
7342 </dt>
7343 <dd>
7344 <p>
7345         Run the tool only if a diff is selected in the GUI. It guarantees
7346         that <em>FILENAME</em> is not empty.
7347 </p>
7348 </dd>
7349 <dt class="hdlist1">
7350 guitool.&lt;name&gt;.noConsole
7351 </dt>
7352 <dd>
7353 <p>
7354         Run the command silently, without creating a window to display its
7355         output.
7356 </p>
7357 </dd>
7358 <dt class="hdlist1">
7359 guitool.&lt;name&gt;.noRescan
7360 </dt>
7361 <dd>
7362 <p>
7363         Don&#8217;t rescan the working directory for changes after the tool
7364         finishes execution.
7365 </p>
7366 </dd>
7367 <dt class="hdlist1">
7368 guitool.&lt;name&gt;.confirm
7369 </dt>
7370 <dd>
7371 <p>
7372         Show a confirmation dialog before actually running the tool.
7373 </p>
7374 </dd>
7375 <dt class="hdlist1">
7376 guitool.&lt;name&gt;.argPrompt
7377 </dt>
7378 <dd>
7379 <p>
7380         Request a string argument from the user, and pass it to the tool
7381         through the <code>ARGS</code> environment variable. Since requesting an
7382         argument implies confirmation, the <em>confirm</em> option has no effect
7383         if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
7384         the dialog uses a built-in generic prompt; otherwise the exact
7385         value of the variable is used.
7386 </p>
7387 </dd>
7388 <dt class="hdlist1">
7389 guitool.&lt;name&gt;.revPrompt
7390 </dt>
7391 <dd>
7392 <p>
7393         Request a single valid revision from the user, and set the
7394         <code>REVISION</code> environment variable. In other aspects this option
7395         is similar to <em>argPrompt</em>, and can be used together with it.
7396 </p>
7397 </dd>
7398 <dt class="hdlist1">
7399 guitool.&lt;name&gt;.revUnmerged
7400 </dt>
7401 <dd>
7402 <p>
7403         Show only unmerged branches in the <em>revPrompt</em> subdialog.
7404         This is useful for tools similar to merge or rebase, but not
7405         for things like checkout or reset.
7406 </p>
7407 </dd>
7408 <dt class="hdlist1">
7409 guitool.&lt;name&gt;.title
7410 </dt>
7411 <dd>
7412 <p>
7413         Specifies the title to use for the prompt dialog. The default
7414         is the tool name.
7415 </p>
7416 </dd>
7417 <dt class="hdlist1">
7418 guitool.&lt;name&gt;.prompt
7419 </dt>
7420 <dd>
7421 <p>
7422         Specifies the general prompt string to display at the top of
7423         the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
7424         The default value includes the actual command.
7425 </p>
7426 </dd>
7427 <dt class="hdlist1">
7428 help.browser
7429 </dt>
7430 <dd>
7431 <p>
7432         Specify the browser that will be used to display help in the
7433         <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
7434 </p>
7435 </dd>
7436 <dt class="hdlist1">
7437 help.format
7438 </dt>
7439 <dd>
7440 <p>
7441         Override the default help format used by <a href="git-help.html">git-help(1)</a>.
7442         Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
7443         the default. <em>web</em> and <em>html</em> are the same.
7444 </p>
7445 </dd>
7446 <dt class="hdlist1">
7447 help.autoCorrect
7448 </dt>
7449 <dd>
7450 <p>
7451         If git detects typos and can identify exactly one valid command similar
7452         to the error, git will try to suggest the correct command or even
7453         run the suggestion automatically. Possible config values are:
7454 </p>
7455 <div class="ulist"><ul>
7456 <li>
7457 <p>
7458 0 (default): show the suggested command.
7459 </p>
7460 </li>
7461 <li>
7462 <p>
7463 positive number: run the suggested command after specified
7464 deciseconds (0.1 sec).
7465 </p>
7466 </li>
7467 <li>
7468 <p>
7469 "immediate": run the suggested command immediately.
7470 </p>
7471 </li>
7472 <li>
7473 <p>
7474 "prompt": show the suggestion and prompt for confirmation to run
7475 the command.
7476 </p>
7477 </li>
7478 <li>
7479 <p>
7480 "never": don&#8217;t run or show any suggested command.
7481 </p>
7482 </li>
7483 </ul></div>
7484 </dd>
7485 <dt class="hdlist1">
7486 help.htmlPath
7487 </dt>
7488 <dd>
7489 <p>
7490         Specify the path where the HTML documentation resides. File system paths
7491         and URLs are supported. HTML pages will be prefixed with this path when
7492         help is displayed in the <em>web</em> format. This defaults to the documentation
7493         path of your Git installation.
7494 </p>
7495 </dd>
7496 <dt class="hdlist1">
7497 http.proxy
7498 </dt>
7499 <dd>
7500 <p>
7501         Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
7502         <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
7503         addition to the syntax understood by curl, it is possible to specify a
7504         proxy string with a user name but no password, in which case git will
7505         attempt to acquire one in the same way it does for other credentials. See
7506         <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
7507         <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
7508         on a per-remote basis; see remote.&lt;name&gt;.proxy
7509 </p>
7510 <div class="paragraph"><p>Any proxy, however configured, must be completely transparent and must not
7511 modify, transform, or buffer the request or response in any way.  Proxies which
7512 are not completely transparent are known to cause various forms of breakage
7513 with Git.</p></div>
7514 </dd>
7515 <dt class="hdlist1">
7516 http.proxyAuthMethod
7517 </dt>
7518 <dd>
7519 <p>
7520         Set the method with which to authenticate against the HTTP proxy. This
7521         only takes effect if the configured proxy string contains a user name part
7522         (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
7523         overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
7524         Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
7525         variable.  Possible values are:
7526 </p>
7527 <div class="openblock">
7528 <div class="content">
7529 <div class="ulist"><ul>
7530 <li>
7531 <p>
7532 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
7533   assumed that the proxy answers an unauthenticated request with a 407
7534   status code and one or more Proxy-authenticate headers with supported
7535   authentication methods. This is the default.
7536 </p>
7537 </li>
7538 <li>
7539 <p>
7540 <code>basic</code> - HTTP Basic authentication
7541 </p>
7542 </li>
7543 <li>
7544 <p>
7545 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
7546   transmitted to the proxy in clear text
7547 </p>
7548 </li>
7549 <li>
7550 <p>
7551 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7552   of <code>curl(1)</code>)
7553 </p>
7554 </li>
7555 <li>
7556 <p>
7557 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7558 </p>
7559 </li>
7560 </ul></div>
7561 </div></div>
7562 </dd>
7563 <dt class="hdlist1">
7564 http.proxySSLCert
7565 </dt>
7566 <dd>
7567 <p>
7568         The pathname of a file that stores a client certificate to use to authenticate
7569         with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7570         variable.
7571 </p>
7572 </dd>
7573 <dt class="hdlist1">
7574 http.proxySSLKey
7575 </dt>
7576 <dd>
7577 <p>
7578         The pathname of a file that stores a private key to use to authenticate with
7579         an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7580         variable.
7581 </p>
7582 </dd>
7583 <dt class="hdlist1">
7584 http.proxySSLCertPasswordProtected
7585 </dt>
7586 <dd>
7587 <p>
7588         Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
7589         will prompt the user, possibly many times, if the certificate or private key
7590         is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7591         environment variable.
7592 </p>
7593 </dd>
7594 <dt class="hdlist1">
7595 http.proxySSLCAInfo
7596 </dt>
7597 <dd>
7598 <p>
7599         Pathname to the file containing the certificate bundle that should be used to
7600         verify the proxy with when using an HTTPS proxy. Can be overridden by the
7601         <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7602 </p>
7603 </dd>
7604 <dt class="hdlist1">
7605 http.emptyAuth
7606 </dt>
7607 <dd>
7608 <p>
7609         Attempt authentication without seeking a username or password.  This
7610         can be used to attempt GSS-Negotiate authentication without specifying
7611         a username in the URL, as libcurl normally requires a username for
7612         authentication.
7613 </p>
7614 </dd>
7615 <dt class="hdlist1">
7616 http.proactiveAuth
7617 </dt>
7618 <dd>
7619 <p>
7620         Attempt authentication without first making an unauthenticated attempt and
7621         receiving a 401 response. This can be used to ensure that all requests are
7622         authenticated. If <code>http.emptyAuth</code> is set to true, this value has no effect.
7623 </p>
7624 <div class="paragraph"><p>If the credential helper used specifies an authentication scheme (i.e., via the
7625 <code>authtype</code> field), that value will be used; if a username and password is
7626 provided without a scheme, then Basic authentication is used.  The value of the
7627 option determines the scheme requested from the helper. Possible values are:</p></div>
7628 <div class="openblock">
7629 <div class="content">
7630 <div class="ulist"><ul>
7631 <li>
7632 <p>
7633 <code>basic</code> - Request Basic authentication from the helper.
7634 </p>
7635 </li>
7636 <li>
7637 <p>
7638 <code>auto</code> - Allow the helper to pick an appropriate scheme.
7639 </p>
7640 </li>
7641 <li>
7642 <p>
7643 <code>none</code> - Disable proactive authentication.
7644 </p>
7645 </li>
7646 </ul></div>
7647 </div></div>
7648 <div class="paragraph"><p>Note that TLS should always be used with this configuration, since otherwise it
7649 is easy to accidentally expose plaintext credentials if Basic authentication
7650 is selected.</p></div>
7651 </dd>
7652 <dt class="hdlist1">
7653 http.delegation
7654 </dt>
7655 <dd>
7656 <p>
7657         Control GSSAPI credential delegation. The delegation is disabled
7658         by default in libcurl since version 7.21.7. Set parameter to tell
7659         the server what it is allowed to delegate when it comes to user
7660         credentials. Used with GSS/kerberos. Possible values are:
7661 </p>
7662 <div class="openblock">
7663 <div class="content">
7664 <div class="ulist"><ul>
7665 <li>
7666 <p>
7667 <code>none</code> - Don&#8217;t allow any delegation.
7668 </p>
7669 </li>
7670 <li>
7671 <p>
7672 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7673   Kerberos service ticket, which is a matter of realm policy.
7674 </p>
7675 </li>
7676 <li>
7677 <p>
7678 <code>always</code> - Unconditionally allow the server to delegate.
7679 </p>
7680 </li>
7681 </ul></div>
7682 </div></div>
7683 </dd>
7684 <dt class="hdlist1">
7685 http.extraHeader
7686 </dt>
7687 <dd>
7688 <p>
7689         Pass an additional HTTP header when communicating with a server.  If
7690         more than one such entry exists, all of them are added as extra
7691         headers.  To allow overriding the settings inherited from the system
7692         config, an empty value will reset the extra headers to the empty list.
7693 </p>
7694 </dd>
7695 <dt class="hdlist1">
7696 http.cookieFile
7697 </dt>
7698 <dd>
7699 <p>
7700         The pathname of a file containing previously stored cookie lines,
7701         which should be used
7702         in the Git http session, if they match the server. The file format
7703         of the file to read cookies from should be plain HTTP headers or
7704         the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7705         Set it to an empty string, to accept only new cookies from
7706         the server and send them back in successive requests within same
7707         connection.
7708         NOTE that the file specified with http.cookieFile is used only as
7709         input unless http.saveCookies is set.
7710 </p>
7711 </dd>
7712 <dt class="hdlist1">
7713 http.saveCookies
7714 </dt>
7715 <dd>
7716 <p>
7717         If set, store cookies received during requests to the file specified by
7718         http.cookieFile. Has no effect if http.cookieFile is unset, or set to
7719         an empty string.
7720 </p>
7721 </dd>
7722 <dt class="hdlist1">
7723 http.version
7724 </dt>
7725 <dd>
7726 <p>
7727         Use the specified HTTP protocol version when communicating with a server.
7728         If you want to force the default. The available and default version depend
7729         on libcurl. Currently the possible values of
7730         this option are:
7731 </p>
7732 <div class="ulist"><ul>
7733 <li>
7734 <p>
7735 HTTP/2
7736 </p>
7737 </li>
7738 <li>
7739 <p>
7740 HTTP/1.1
7741 </p>
7742 </li>
7743 </ul></div>
7744 </dd>
7745 <dt class="hdlist1">
7746 http.curloptResolve
7747 </dt>
7748 <dd>
7749 <p>
7750         Hostname resolution information that will be used first by
7751         libcurl when sending HTTP requests.  This information should
7752         be in one of the following formats:
7753 </p>
7754 <div class="ulist"><ul>
7755 <li>
7756 <p>
7757 [+]HOST:PORT:ADDRESS[,ADDRESS]
7758 </p>
7759 </li>
7760 <li>
7761 <p>
7762 -HOST:PORT
7763 </p>
7764 </li>
7765 </ul></div>
7766 <div class="paragraph"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7767 to the provided <code>ADDRESS</code>(s). The second format clears all
7768 previous config values for that <code>HOST:PORT</code> combination.  To
7769 allow easy overriding of all the settings inherited from the
7770 system config, an empty value will reset all resolution
7771 information to the empty list.</p></div>
7772 </dd>
7773 <dt class="hdlist1">
7774 http.sslVersion
7775 </dt>
7776 <dd>
7777 <p>
7778         The SSL version to use when negotiating an SSL connection, if you
7779         want to force the default.  The available and default version
7780         depend on whether libcurl was built against NSS or OpenSSL and the
7781         particular configuration of the crypto library in use. Internally
7782         this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7783         documentation for more details on the format of this option and
7784         for the ssl version supported. Currently the possible values of
7785         this option are:
7786 </p>
7787 <div class="ulist"><ul>
7788 <li>
7789 <p>
7790 sslv2
7791 </p>
7792 </li>
7793 <li>
7794 <p>
7795 sslv3
7796 </p>
7797 </li>
7798 <li>
7799 <p>
7800 tlsv1
7801 </p>
7802 </li>
7803 <li>
7804 <p>
7805 tlsv1.0
7806 </p>
7807 </li>
7808 <li>
7809 <p>
7810 tlsv1.1
7811 </p>
7812 </li>
7813 <li>
7814 <p>
7815 tlsv1.2
7816 </p>
7817 </li>
7818 <li>
7819 <p>
7820 tlsv1.3
7821 </p>
7822 </li>
7823 </ul></div>
7824 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7825 To force git to use libcurl&#8217;s default ssl version and ignore any
7826 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7827 empty string.</p></div>
7828 </dd>
7829 <dt class="hdlist1">
7830 http.sslCipherList
7831 </dt>
7832 <dd>
7833 <p>
7834   A list of SSL ciphers to use when negotiating an SSL connection.
7835   The available ciphers depend on whether libcurl was built against
7836   NSS or OpenSSL and the particular configuration of the crypto
7837   library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7838   option; see the libcurl documentation for more details on the format
7839   of this list.
7840 </p>
7841 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7842 To force git to use libcurl&#8217;s default cipher list and ignore any
7843 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7844 empty string.</p></div>
7845 </dd>
7846 <dt class="hdlist1">
7847 http.sslVerify
7848 </dt>
7849 <dd>
7850 <p>
7851         Whether to verify the SSL certificate when fetching or pushing
7852         over HTTPS. Defaults to true. Can be overridden by the
7853         <code>GIT_SSL_NO_VERIFY</code> environment variable.
7854 </p>
7855 </dd>
7856 <dt class="hdlist1">
7857 http.sslCert
7858 </dt>
7859 <dd>
7860 <p>
7861         File containing the SSL certificate when fetching or pushing
7862         over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7863         variable.
7864 </p>
7865 </dd>
7866 <dt class="hdlist1">
7867 http.sslKey
7868 </dt>
7869 <dd>
7870 <p>
7871         File containing the SSL private key when fetching or pushing
7872         over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7873         variable.
7874 </p>
7875 </dd>
7876 <dt class="hdlist1">
7877 http.sslCertPasswordProtected
7878 </dt>
7879 <dd>
7880 <p>
7881         Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
7882         OpenSSL will prompt the user, possibly many times, if the
7883         certificate or private key is encrypted.  Can be overridden by the
7884         <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7885 </p>
7886 </dd>
7887 <dt class="hdlist1">
7888 http.sslCAInfo
7889 </dt>
7890 <dd>
7891 <p>
7892         File containing the certificates to verify the peer with when
7893         fetching or pushing over HTTPS. Can be overridden by the
7894         <code>GIT_SSL_CAINFO</code> environment variable.
7895 </p>
7896 </dd>
7897 <dt class="hdlist1">
7898 http.sslCAPath
7899 </dt>
7900 <dd>
7901 <p>
7902         Path containing files with the CA certificates to verify the peer
7903         with when fetching or pushing over HTTPS. Can be overridden
7904         by the <code>GIT_SSL_CAPATH</code> environment variable.
7905 </p>
7906 </dd>
7907 <dt class="hdlist1">
7908 http.sslBackend
7909 </dt>
7910 <dd>
7911 <p>
7912         Name of the SSL backend to use (e.g. "openssl" or "schannel").
7913         This option is ignored if cURL lacks support for choosing the SSL
7914         backend at runtime.
7915 </p>
7916 </dd>
7917 <dt class="hdlist1">
7918 http.schannelCheckRevoke
7919 </dt>
7920 <dd>
7921 <p>
7922         Used to enforce or disable certificate revocation checks in cURL
7923         when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
7924         unset. Only necessary to disable this if Git consistently errors
7925         and the message is about checking the revocation status of a
7926         certificate. This option is ignored if cURL lacks support for
7927         setting the relevant SSL option at runtime.
7928 </p>
7929 </dd>
7930 <dt class="hdlist1">
7931 http.schannelUseSSLCAInfo
7932 </dt>
7933 <dd>
7934 <p>
7935         As of cURL v7.60.0, the Secure Channel backend can use the
7936         certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7937         override the Windows Certificate Store. Since this is not desirable
7938         by default, Git will tell cURL not to use that bundle by default
7939         when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7940         unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7941 </p>
7942 </dd>
7943 <dt class="hdlist1">
7944 http.pinnedPubkey
7945 </dt>
7946 <dd>
7947 <p>
7948         Public key of the https service. It may either be the filename of
7949         a PEM or DER encoded public key file or a string starting with
7950         <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7951         public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7952         exit with an error if this option is set but not supported by
7953         cURL.
7954 </p>
7955 </dd>
7956 <dt class="hdlist1">
7957 http.sslTry
7958 </dt>
7959 <dd>
7960 <p>
7961         Attempt to use AUTH SSL/TLS and encrypted data transfers
7962         when connecting via regular FTP protocol. This might be needed
7963         if the FTP server requires it for security reasons or you wish
7964         to connect securely whenever remote FTP server supports it.
7965         Default is false since it might trigger certificate verification
7966         errors on misconfigured servers.
7967 </p>
7968 </dd>
7969 <dt class="hdlist1">
7970 http.maxRequests
7971 </dt>
7972 <dd>
7973 <p>
7974         How many HTTP requests to launch in parallel. Can be overridden
7975         by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7976 </p>
7977 </dd>
7978 <dt class="hdlist1">
7979 http.minSessions
7980 </dt>
7981 <dd>
7982 <p>
7983         The number of curl sessions (counted across slots) to be kept across
7984         requests. They will not be ended with curl_easy_cleanup() until
7985         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7986         value will be capped at 1. Defaults to 1.
7987 </p>
7988 </dd>
7989 <dt class="hdlist1">
7990 http.postBuffer
7991 </dt>
7992 <dd>
7993 <p>
7994         Maximum size in bytes of the buffer used by smart HTTP
7995         transports when POSTing data to the remote system.
7996         For requests larger than this buffer size, HTTP/1.1 and
7997         Transfer-Encoding: chunked is used to avoid creating a
7998         massive pack file locally.  Default is 1 MiB, which is
7999         sufficient for most requests.
8000 </p>
8001 <div class="paragraph"><p>Note that raising this limit is only effective for disabling chunked
8002 transfer encoding and therefore should be used only where the remote
8003 server or a proxy only supports HTTP/1.0 or is noncompliant with the
8004 HTTP standard.  Raising this is not, in general, an effective solution
8005 for most push problems, but can increase memory consumption
8006 significantly since the entire buffer is allocated even for small
8007 pushes.</p></div>
8008 </dd>
8009 <dt class="hdlist1">
8010 http.lowSpeedLimit, http.lowSpeedTime
8011 </dt>
8012 <dd>
8013 <p>
8014         If the HTTP transfer speed, in bytes per second, is less than
8015         <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
8016         the transfer is aborted.
8017         Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
8018         <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
8019 </p>
8020 </dd>
8021 <dt class="hdlist1">
8022 http.noEPSV
8023 </dt>
8024 <dd>
8025 <p>
8026         A boolean which disables using of EPSV ftp command by curl.
8027         This can be helpful with some "poor" ftp servers which don&#8217;t
8028         support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
8029         environment variable. Default is false (curl will use EPSV).
8030 </p>
8031 </dd>
8032 <dt class="hdlist1">
8033 http.userAgent
8034 </dt>
8035 <dd>
8036 <p>
8037         The HTTP USER_AGENT string presented to an HTTP server.  The default
8038         value represents the version of the Git client such as git/1.7.1.
8039         This option allows you to override this value to a more common value
8040         such as Mozilla/4.0.  This may be necessary, for instance, if
8041         connecting through a firewall that restricts HTTP connections to a set
8042         of common USER_AGENT strings (but not including those like git/1.7.1).
8043         Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
8044 </p>
8045 </dd>
8046 <dt class="hdlist1">
8047 http.followRedirects
8048 </dt>
8049 <dd>
8050 <p>
8051         Whether git should follow HTTP redirects. If set to <code>true</code>, git
8052         will transparently follow any redirect issued by a server it
8053         encounters. If set to <code>false</code>, git will treat all redirects as
8054         errors. If set to <code>initial</code>, git will follow redirects only for
8055         the initial request to a remote, but not for subsequent
8056         follow-up HTTP requests. Since git uses the redirected URL as
8057         the base for the follow-up requests, this is generally
8058         sufficient. The default is <code>initial</code>.
8059 </p>
8060 </dd>
8061 <dt class="hdlist1">
8062 http.&lt;url&gt;.*
8063 </dt>
8064 <dd>
8065 <p>
8066         Any of the http.* options above can be applied selectively to some URLs.
8067         For a config key to match a URL, each element of the config key is
8068         compared to that of the URL, in the following order:
8069 </p>
8070 <div class="openblock">
8071 <div class="content">
8072 <div class="olist arabic"><ol class="arabic">
8073 <li>
8074 <p>
8075 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
8076   must match exactly between the config key and the URL.
8077 </p>
8078 </li>
8079 <li>
8080 <p>
8081 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
8082   This field must match between the config key and the URL. It is
8083   possible to specify a <code>*</code> as part of the host name to match all subdomains
8084   at this level. <code>https://*.example.com/</code> for example would match
8085   <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
8086 </p>
8087 </li>
8088 <li>
8089 <p>
8090 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
8091   This field must match exactly between the config key and the URL.
8092   Omitted port numbers are automatically converted to the correct
8093   default for the scheme before matching.
8094 </p>
8095 </li>
8096 <li>
8097 <p>
8098 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
8099   path field of the config key must match the path field of the URL
8100   either exactly or as a prefix of slash-delimited path elements.  This means
8101   a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
8102   match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
8103   key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
8104   key with just path <code>foo/</code>).
8105 </p>
8106 </li>
8107 <li>
8108 <p>
8109 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
8110   the config key has a user name it must match the user name in the
8111   URL exactly. If the config key does not have a user name, that
8112   config key will match a URL with any user name (including none),
8113   but at a lower precedence than a config key with a user name.
8114 </p>
8115 </li>
8116 </ol></div>
8117 </div></div>
8118 <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
8119 a config key&#8217;s path is preferred to one that matches its user name. For example,
8120 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
8121 <code>https://example.com/foo</code> will be preferred over a config key match of
8122 <code>https://user@example.com</code>.</p></div>
8123 <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
8124 if embedded in the URL, is always ignored for matching purposes) so that
8125 equivalent URLs that are simply spelled differently will match properly.
8126 Environment variable settings always override any matches.  The URLs that are
8127 matched against are those given directly to Git commands.  This means any URLs
8128 visited as a result of a redirection do not participate in matching.</p></div>
8129 </dd>
8130 <dt class="hdlist1">
8131 i18n.commitEncoding
8132 </dt>
8133 <dd>
8134 <p>
8135         Character encoding the commit messages are stored in; Git itself
8136         does not care per se, but this information is necessary e.g. when
8137         importing commits from emails or in the gitk graphical history
8138         browser (and possibly in other places in the future or in other
8139         porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
8140 </p>
8141 </dd>
8142 <dt class="hdlist1">
8143 i18n.logOutputEncoding
8144 </dt>
8145 <dd>
8146 <p>
8147         Character encoding the commit messages are converted to when
8148         running <em>git log</em> and friends.
8149 </p>
8150 </dd>
8151 <dt class="hdlist1">
8152 imap.folder
8153 </dt>
8154 <dd>
8155 <p>
8156         The folder to drop the mails into, which is typically the Drafts
8157         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
8158         "[Gmail]/Drafts". Required.
8159 </p>
8160 </dd>
8161 <dt class="hdlist1">
8162 imap.tunnel
8163 </dt>
8164 <dd>
8165 <p>
8166         Command used to set up a tunnel to the IMAP server through which
8167         commands will be piped instead of using a direct network connection
8168         to the server. Required when imap.host is not set.
8169 </p>
8170 </dd>
8171 <dt class="hdlist1">
8172 imap.host
8173 </dt>
8174 <dd>
8175 <p>
8176         A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
8177         connections and an <code>imaps://</code> prefix for secure connections.
8178         Ignored when imap.tunnel is set, but required otherwise.
8179 </p>
8180 </dd>
8181 <dt class="hdlist1">
8182 imap.user
8183 </dt>
8184 <dd>
8185 <p>
8186         The username to use when logging in to the server.
8187 </p>
8188 </dd>
8189 <dt class="hdlist1">
8190 imap.pass
8191 </dt>
8192 <dd>
8193 <p>
8194         The password to use when logging in to the server.
8195 </p>
8196 </dd>
8197 <dt class="hdlist1">
8198 imap.port
8199 </dt>
8200 <dd>
8201 <p>
8202         An integer port number to connect to on the server.
8203         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
8204         Ignored when imap.tunnel is set.
8205 </p>
8206 </dd>
8207 <dt class="hdlist1">
8208 imap.sslverify
8209 </dt>
8210 <dd>
8211 <p>
8212         A boolean to enable/disable verification of the server certificate
8213         used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
8214         imap.tunnel is set.
8215 </p>
8216 </dd>
8217 <dt class="hdlist1">
8218 imap.preformattedHTML
8219 </dt>
8220 <dd>
8221 <p>
8222         A boolean to enable/disable the use of html encoding when sending
8223         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
8224         and have a content type of text/html.  Ironically, enabling this
8225         option causes Thunderbird to send the patch as a plain/text,
8226         format=fixed email.  Default is <code>false</code>.
8227 </p>
8228 </dd>
8229 <dt class="hdlist1">
8230 imap.authMethod
8231 </dt>
8232 <dd>
8233 <p>
8234         Specify the authentication method for authenticating with the IMAP server.
8235         If Git was built with the NO_CURL option, or if your curl version is older
8236         than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
8237         option, the only supported method is <em>CRAM-MD5</em>. If this is not set
8238         then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
8239 </p>
8240 </dd>
8241 <dt class="hdlist1">
8242 include.path
8243 </dt>
8244 <dt class="hdlist1">
8245 includeIf.&lt;condition&gt;.path
8246 </dt>
8247 <dd>
8248 <p>
8249         Special variables to include other configuration files. See
8250         the "CONFIGURATION FILE" section in the main
8251         <a href="git-config.html">git-config(1)</a> documentation,
8252         specifically the "Includes" and "Conditional Includes" subsections.
8253 </p>
8254 </dd>
8255 <dt class="hdlist1">
8256 index.recordEndOfIndexEntries
8257 </dt>
8258 <dd>
8259 <p>
8260         Specifies whether the index file should include an "End Of Index
8261         Entry" section. This reduces index load time on multiprocessor
8262         machines but produces a message "ignoring EOIE extension" when
8263         reading the index using Git versions before 2.20. Defaults to
8264         <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
8265         otherwise.
8266 </p>
8267 </dd>
8268 <dt class="hdlist1">
8269 index.recordOffsetTable
8270 </dt>
8271 <dd>
8272 <p>
8273         Specifies whether the index file should include an "Index Entry
8274         Offset Table" section. This reduces index load time on
8275         multiprocessor machines but produces a message "ignoring IEOT
8276         extension" when reading the index using Git versions before 2.20.
8277         Defaults to <em>true</em> if index.threads has been explicitly enabled,
8278         <em>false</em> otherwise.
8279 </p>
8280 </dd>
8281 <dt class="hdlist1">
8282 index.sparse
8283 </dt>
8284 <dd>
8285 <p>
8286         When enabled, write the index using sparse-directory entries. This
8287         has no effect unless <code>core.sparseCheckout</code> and
8288         <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
8289 </p>
8290 </dd>
8291 <dt class="hdlist1">
8292 index.threads
8293 </dt>
8294 <dd>
8295 <p>
8296         Specifies the number of threads to spawn when loading the index.
8297         This is meant to reduce index load time on multiprocessor machines.
8298         Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
8299         CPUs and set the number of threads accordingly. Specifying 1 or
8300         <em>false</em> will disable multithreading. Defaults to <em>true</em>.
8301 </p>
8302 </dd>
8303 <dt class="hdlist1">
8304 index.version
8305 </dt>
8306 <dd>
8307 <p>
8308         Specify the version with which new index files should be
8309         initialized.  This does not affect existing repositories.
8310         If <code>feature.manyFiles</code> is enabled, then the default is 4.
8311 </p>
8312 </dd>
8313 <dt class="hdlist1">
8314 index.skipHash
8315 </dt>
8316 <dd>
8317 <p>
8318         When enabled, do not compute the trailing hash for the index file.
8319         This accelerates Git commands that manipulate the index, such as
8320         <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
8321         checksum, write a trailing set of bytes with value zero, indicating
8322         that the computation was skipped.
8323 </p>
8324 <div class="paragraph"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
8325 refuse to parse the index and Git clients older than 2.40.0 will report an
8326 error during <code>git fsck</code>.</p></div>
8327 </dd>
8328 </dl></div>
8329 <div class="dlist"><dl>
8330 <dt class="hdlist1">
8331 <code>init.templateDir</code>
8332 </dt>
8333 <dd>
8334 <p>
8335         Specify the directory from which templates will be copied. (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
8336 </p>
8337 </dd>
8338 <dt class="hdlist1">
8339 <code>init.defaultBranch</code>
8340 </dt>
8341 <dd>
8342 <p>
8343         Allows overriding the default branch name e.g. when initializing
8344         a new repository.
8345 </p>
8346 </dd>
8347 <dt class="hdlist1">
8348 instaweb.browser
8349 </dt>
8350 <dd>
8351 <p>
8352         Specify the program that will be used to browse your working
8353         repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
8354 </p>
8355 </dd>
8356 <dt class="hdlist1">
8357 instaweb.httpd
8358 </dt>
8359 <dd>
8360 <p>
8361         The HTTP daemon command-line to start gitweb on your working
8362         repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
8363 </p>
8364 </dd>
8365 <dt class="hdlist1">
8366 instaweb.local
8367 </dt>
8368 <dd>
8369 <p>
8370         If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
8371         be bound to the local IP (127.0.0.1).
8372 </p>
8373 </dd>
8374 <dt class="hdlist1">
8375 instaweb.modulePath
8376 </dt>
8377 <dd>
8378 <p>
8379         The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
8380         instead of /usr/lib/apache2/modules.  Only used if httpd
8381         is Apache.
8382 </p>
8383 </dd>
8384 <dt class="hdlist1">
8385 instaweb.port
8386 </dt>
8387 <dd>
8388 <p>
8389         The port number to bind the gitweb httpd to. See
8390         <a href="git-instaweb.html">git-instaweb(1)</a>.
8391 </p>
8392 </dd>
8393 <dt class="hdlist1">
8394 interactive.singleKey
8395 </dt>
8396 <dd>
8397 <p>
8398         When set to true, allow the user to provide one-letter input
8399         with a single key (i.e., without hitting the Enter key) in
8400         interactive commands.  This is currently used by the <code>--patch</code>
8401         mode of <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
8402         <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
8403         <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>.
8404 </p>
8405 </dd>
8406 <dt class="hdlist1">
8407 interactive.diffFilter
8408 </dt>
8409 <dd>
8410 <p>
8411         When an interactive command (such as <code>git add --patch</code>) shows
8412         a colorized diff, git will pipe the diff through the shell
8413         command defined by this configuration variable. The command may
8414         mark up the diff further for human consumption, provided that it
8415         retains a one-to-one correspondence with the lines in the
8416         original diff. Defaults to disabled (no filtering).
8417 </p>
8418 </dd>
8419 <dt class="hdlist1">
8420 log.abbrevCommit
8421 </dt>
8422 <dd>
8423 <p>
8424         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8425         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
8426         override this option with <code>--no-abbrev-commit</code>.
8427 </p>
8428 </dd>
8429 <dt class="hdlist1">
8430 log.date
8431 </dt>
8432 <dd>
8433 <p>
8434         Set the default date-time mode for the <em>log</em> command.
8435         Setting a value for log.date is similar to using <em>git log</em>'s
8436         <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.
8437 </p>
8438 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
8439 "foo" will be used for the date format. Otherwise, "default" will
8440 be used.</p></div>
8441 </dd>
8442 <dt class="hdlist1">
8443 log.decorate
8444 </dt>
8445 <dd>
8446 <p>
8447         Print out the ref names of any commits that are shown by the log
8448         command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
8449         <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
8450         specified, the full ref name (including prefix) will be printed.
8451         If <em>auto</em> is specified, then if the output is going to a terminal,
8452         the ref names are shown as if <em>short</em> were given, otherwise no ref
8453         names are shown. This is the same as the <code>--decorate</code> option
8454         of the <code>git log</code>.
8455 </p>
8456 </dd>
8457 <dt class="hdlist1">
8458 log.initialDecorationSet
8459 </dt>
8460 <dd>
8461 <p>
8462         By default, <code>git log</code> only shows decorations for certain known ref
8463         namespaces. If <em>all</em> is specified, then show all refs as
8464         decorations.
8465 </p>
8466 </dd>
8467 <dt class="hdlist1">
8468 log.excludeDecoration
8469 </dt>
8470 <dd>
8471 <p>
8472         Exclude the specified patterns from the log decorations. This is
8473         similar to the <code>--decorate-refs-exclude</code> command-line option, but
8474         the config option can be overridden by the <code>--decorate-refs</code>
8475         option.
8476 </p>
8477 </dd>
8478 <dt class="hdlist1">
8479 log.diffMerges
8480 </dt>
8481 <dd>
8482 <p>
8483         Set diff format to be used when <code>--diff-merges=on</code> is
8484         specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
8485         details. Defaults to <code>separate</code>.
8486 </p>
8487 </dd>
8488 <dt class="hdlist1">
8489 log.follow
8490 </dt>
8491 <dd>
8492 <p>
8493         If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
8494         a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
8495         i.e. it cannot be used to follow multiple files and does not work well
8496         on non-linear history.
8497 </p>
8498 </dd>
8499 <dt class="hdlist1">
8500 log.graphColors
8501 </dt>
8502 <dd>
8503 <p>
8504         A list of colors, separated by commas, that can be used to draw
8505         history lines in <code>git log --graph</code>.
8506 </p>
8507 </dd>
8508 <dt class="hdlist1">
8509 log.showRoot
8510 </dt>
8511 <dd>
8512 <p>
8513         If true, the initial commit will be shown as a big creation event.
8514         This is equivalent to a diff against an empty tree.
8515         Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
8516         normally hide the root commit will now show it. True by default.
8517 </p>
8518 </dd>
8519 <dt class="hdlist1">
8520 log.showSignature
8521 </dt>
8522 <dd>
8523 <p>
8524         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8525         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
8526 </p>
8527 </dd>
8528 <dt class="hdlist1">
8529 log.mailmap
8530 </dt>
8531 <dd>
8532 <p>
8533         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8534         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
8535         assume <code>--no-use-mailmap</code>. True by default.
8536 </p>
8537 </dd>
8538 <dt class="hdlist1">
8539 lsrefs.unborn
8540 </dt>
8541 <dd>
8542 <p>
8543         May be "advertise" (the default), "allow", or "ignore". If "advertise",
8544         the server will respond to the client sending "unborn" (as described in
8545         <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
8546         protocol v2 capability advertisement. "allow" is the same as
8547         "advertise" except that the server will not advertise support for this
8548         feature; this is useful for load-balanced servers that cannot be
8549         updated atomically (for example), since the administrator could
8550         configure "allow", then after a delay, configure "advertise".
8551 </p>
8552 </dd>
8553 <dt class="hdlist1">
8554 mailinfo.scissors
8555 </dt>
8556 <dd>
8557 <p>
8558         If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
8559         <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
8560         was provided on the command-line. When active, this feature
8561         removes everything from the message body before a scissors
8562         line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
8563 </p>
8564 </dd>
8565 <dt class="hdlist1">
8566 mailmap.file
8567 </dt>
8568 <dd>
8569 <p>
8570         The location of an augmenting mailmap file. The default
8571         mailmap, located in the root of the repository, is loaded
8572         first, then the mailmap file pointed to by this variable.
8573         The location of the mailmap file may be in a repository
8574         subdirectory, or somewhere outside of the repository itself.
8575         See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
8576 </p>
8577 </dd>
8578 <dt class="hdlist1">
8579 mailmap.blob
8580 </dt>
8581 <dd>
8582 <p>
8583         Like <code>mailmap.file</code>, but consider the value as a reference to a
8584         blob in the repository. If both <code>mailmap.file</code> and
8585         <code>mailmap.blob</code> are given, both are parsed, with entries from
8586         <code>mailmap.file</code> taking precedence. In a bare repository, this
8587         defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8588         defaults to empty.
8589 </p>
8590 </dd>
8591 <dt class="hdlist1">
8592 maintenance.auto
8593 </dt>
8594 <dd>
8595 <p>
8596         This boolean config option controls whether some commands run
8597         <code>git maintenance run --auto</code> after doing their normal work. Defaults
8598         to true.
8599 </p>
8600 </dd>
8601 <dt class="hdlist1">
8602 maintenance.strategy
8603 </dt>
8604 <dd>
8605 <p>
8606         This string config option provides a way to specify one of a few
8607         recommended schedules for background maintenance. This only affects
8608         which tasks are run during <code>git maintenance run --schedule=X</code>
8609         commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
8610         Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
8611         then that value is used instead of the one provided by
8612         <code>maintenance.strategy</code>. The possible strategy strings are:
8613 </p>
8614 <div class="ulist"><ul>
8615 <li>
8616 <p>
8617 <code>none</code>: This default setting implies no tasks are run at any schedule.
8618 </p>
8619 </li>
8620 <li>
8621 <p>
8622 <code>incremental</code>: This setting optimizes for performing small maintenance
8623   activities that do not delete any data. This does not schedule the <code>gc</code>
8624   task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8625   <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8626   task weekly.
8627 </p>
8628 </li>
8629 </ul></div>
8630 </dd>
8631 <dt class="hdlist1">
8632 maintenance.&lt;task&gt;.enabled
8633 </dt>
8634 <dd>
8635 <p>
8636         This boolean config option controls whether the maintenance task
8637         with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
8638         <code>git maintenance run</code>. These config values are ignored if a
8639         <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8640         is true.
8641 </p>
8642 </dd>
8643 <dt class="hdlist1">
8644 maintenance.&lt;task&gt;.schedule
8645 </dt>
8646 <dd>
8647 <p>
8648         This config option controls whether or not the given <code>&lt;task&gt;</code> runs
8649         during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
8650         value must be one of "hourly", "daily", or "weekly".
8651 </p>
8652 </dd>
8653 <dt class="hdlist1">
8654 maintenance.commit-graph.auto
8655 </dt>
8656 <dd>
8657 <p>
8658         This integer config option controls how often the <code>commit-graph</code> task
8659         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8660         the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8661         negative value will force the task to run every time. Otherwise, a
8662         positive value implies the command should run when the number of
8663         reachable commits that are not in the commit-graph file is at least
8664         the value of <code>maintenance.commit-graph.auto</code>. The default value is
8665         100.
8666 </p>
8667 </dd>
8668 <dt class="hdlist1">
8669 maintenance.loose-objects.auto
8670 </dt>
8671 <dd>
8672 <p>
8673         This integer config option controls how often the <code>loose-objects</code> task
8674         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8675         the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8676         negative value will force the task to run every time. Otherwise, a
8677         positive value implies the command should run when the number of
8678         loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8679         The default value is 100.
8680 </p>
8681 </dd>
8682 <dt class="hdlist1">
8683 maintenance.incremental-repack.auto
8684 </dt>
8685 <dd>
8686 <p>
8687         This integer config option controls how often the <code>incremental-repack</code>
8688         task should be run as part of <code>git maintenance run --auto</code>. If zero,
8689         then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8690         option. A negative value will force the task to run every time.
8691         Otherwise, a positive value implies the command should run when the
8692         number of pack-files not in the multi-pack-index is at least the value
8693         of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8694 </p>
8695 </dd>
8696 <dt class="hdlist1">
8697 man.viewer
8698 </dt>
8699 <dd>
8700 <p>
8701         Specify the programs that may be used to display help in the
8702         <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8703 </p>
8704 </dd>
8705 <dt class="hdlist1">
8706 man.&lt;tool&gt;.cmd
8707 </dt>
8708 <dd>
8709 <p>
8710         Specify the command to invoke the specified man viewer. The
8711         specified command is evaluated in shell with the man page
8712         passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)
8713 </p>
8714 </dd>
8715 <dt class="hdlist1">
8716 man.&lt;tool&gt;.path
8717 </dt>
8718 <dd>
8719 <p>
8720         Override the path for the given tool that may be used to
8721         display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8722 </p>
8723 </dd>
8724 <dt class="hdlist1">
8725 merge.conflictStyle
8726 </dt>
8727 <dd>
8728 <p>
8729         Specify the style in which conflicted hunks are written out to
8730         working tree files upon merge.  The default is "merge", which
8731         shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
8732         a <code>=======</code> marker, changes made by the other side, and then
8733         a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
8734         marker and the original text before the <code>=======</code> marker.  The
8735         "merge" style tends to produce smaller conflict regions than diff3,
8736         both because of the exclusion of the original text, and because
8737         when a subset of lines match on the two sides, they are just pulled
8738         out of the conflict region.  Another alternate style, "zdiff3", is
8739         similar to diff3 but removes matching lines on the two sides from
8740         the conflict region when those matching lines appear near either
8741         the beginning or end of a conflict region.
8742 </p>
8743 </dd>
8744 <dt class="hdlist1">
8745 merge.defaultToUpstream
8746 </dt>
8747 <dd>
8748 <p>
8749         If merge is called without any commit argument, merge the upstream
8750         branches configured for the current branch by using their last
8751         observed values stored in their remote-tracking branches.
8752         The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
8753         branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
8754         are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
8755         to their corresponding remote-tracking branches, and the tips of
8756         these tracking branches are merged. Defaults to true.
8757 </p>
8758 </dd>
8759 <dt class="hdlist1">
8760 merge.ff
8761 </dt>
8762 <dd>
8763 <p>
8764         By default, Git does not create an extra merge commit when merging
8765         a commit that is a descendant of the current commit. Instead, the
8766         tip of the current branch is fast-forwarded. When set to <code>false</code>,
8767         this variable tells Git to create an extra merge commit in such
8768         a case (equivalent to giving the <code>--no-ff</code> option from the command
8769         line). When set to <code>only</code>, only such fast-forward merges are
8770         allowed (equivalent to giving the <code>--ff-only</code> option from the
8771         command line).
8772 </p>
8773 </dd>
8774 <dt class="hdlist1">
8775 merge.verifySignatures
8776 </dt>
8777 <dd>
8778 <p>
8779         If true, this is equivalent to the --verify-signatures command
8780         line option. See <a href="git-merge.html">git-merge(1)</a> for details.
8781 </p>
8782 </dd>
8783 <dt class="hdlist1">
8784 merge.branchdesc
8785 </dt>
8786 <dd>
8787 <p>
8788         In addition to branch names, populate the log message with
8789         the branch description text associated with them.  Defaults
8790         to false.
8791 </p>
8792 </dd>
8793 <dt class="hdlist1">
8794 merge.log
8795 </dt>
8796 <dd>
8797 <p>
8798         In addition to branch names, populate the log message with at
8799         most the specified number of one-line descriptions from the
8800         actual commits that are being merged.  Defaults to false, and
8801         true is a synonym for 20.
8802 </p>
8803 </dd>
8804 <dt class="hdlist1">
8805 merge.suppressDest
8806 </dt>
8807 <dd>
8808 <p>
8809         By adding a glob that matches the names of integration
8810         branches to this multi-valued configuration variable, the
8811         default merge message computed for merges into these
8812         integration branches will omit "into &lt;branch name&gt;" from
8813         its title.
8814 </p>
8815 <div class="paragraph"><p>An element with an empty value can be used to clear the list
8816 of globs accumulated from previous configuration entries.
8817 When there is no <code>merge.suppressDest</code> variable defined, the
8818 default value of <code>master</code> is used for backward compatibility.</p></div>
8819 </dd>
8820 <dt class="hdlist1">
8821 merge.renameLimit
8822 </dt>
8823 <dd>
8824 <p>
8825         The number of files to consider in the exhaustive portion of
8826         rename detection during a merge.  If not specified, defaults
8827         to the value of diff.renameLimit.  If neither
8828         merge.renameLimit nor diff.renameLimit are specified,
8829         currently defaults to 7000.  This setting has no effect if
8830         rename detection is turned off.
8831 </p>
8832 </dd>
8833 <dt class="hdlist1">
8834 merge.renames
8835 </dt>
8836 <dd>
8837 <p>
8838         Whether Git detects renames.  If set to "false", rename detection
8839         is disabled. If set to "true", basic rename detection is enabled.
8840         Defaults to the value of diff.renames.
8841 </p>
8842 </dd>
8843 <dt class="hdlist1">
8844 merge.directoryRenames
8845 </dt>
8846 <dd>
8847 <p>
8848         Whether Git detects directory renames, affecting what happens at
8849         merge time to new files added to a directory on one side of
8850         history when that directory was renamed on the other side of
8851         history.  If merge.directoryRenames is set to "false", directory
8852         rename detection is disabled, meaning that such new files will be
8853         left behind in the old directory.  If set to "true", directory
8854         rename detection is enabled, meaning that such new files will be
8855         moved into the new directory.  If set to "conflict", a conflict
8856         will be reported for such paths.  If merge.renames is false,
8857         merge.directoryRenames is ignored and treated as false.  Defaults
8858         to "conflict".
8859 </p>
8860 </dd>
8861 <dt class="hdlist1">
8862 merge.renormalize
8863 </dt>
8864 <dd>
8865 <p>
8866         Tell Git that canonical representation of files in the
8867         repository has changed over time (e.g. earlier commits record
8868         text files with CRLF line endings, but recent ones use LF line
8869         endings).  In such a repository, Git can convert the data
8870         recorded in commits to a canonical form before performing a
8871         merge to reduce unnecessary conflicts.  For more information,
8872         see section "Merging branches with differing checkin/checkout
8873         attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
8874 </p>
8875 </dd>
8876 <dt class="hdlist1">
8877 merge.stat
8878 </dt>
8879 <dd>
8880 <p>
8881         Whether to print the diffstat between ORIG_HEAD and the merge result
8882         at the end of the merge.  True by default.
8883 </p>
8884 </dd>
8885 <dt class="hdlist1">
8886 merge.autoStash
8887 </dt>
8888 <dd>
8889 <p>
8890         When set to true, automatically create a temporary stash entry
8891         before the operation begins, and apply it after the operation
8892         ends.  This means that you can run merge on a dirty worktree.
8893         However, use with care: the final stash application after a
8894         successful merge might result in non-trivial conflicts.
8895         This option can be overridden by the <code>--no-autostash</code> and
8896         <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
8897         Defaults to false.
8898 </p>
8899 </dd>
8900 <dt class="hdlist1">
8901 merge.tool
8902 </dt>
8903 <dd>
8904 <p>
8905         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
8906         The list below shows the valid built-in values.
8907         Any other value is treated as a custom merge tool and requires
8908         that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
8909 </p>
8910 </dd>
8911 <dt class="hdlist1">
8912 merge.guitool
8913 </dt>
8914 <dd>
8915 <p>
8916         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
8917         -g/--gui flag is specified. The list below shows the valid built-in values.
8918         Any other value is treated as a custom merge tool and requires that a
8919         corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.
8920 </p>
8921 <div class="dlist"><dl>
8922 <dt class="hdlist1">
8923 <code>araxis</code>
8924 </dt>
8925 <dd>
8926 <p>
8927 Use Araxis Merge (requires a graphical session)
8928 </p>
8929 </dd>
8930 <dt class="hdlist1">
8931 <code>bc</code>
8932 </dt>
8933 <dd>
8934 <p>
8935 Use Beyond Compare (requires a graphical session)
8936 </p>
8937 </dd>
8938 <dt class="hdlist1">
8939 <code>bc3</code>
8940 </dt>
8941 <dd>
8942 <p>
8943 Use Beyond Compare (requires a graphical session)
8944 </p>
8945 </dd>
8946 <dt class="hdlist1">
8947 <code>bc4</code>
8948 </dt>
8949 <dd>
8950 <p>
8951 Use Beyond Compare (requires a graphical session)
8952 </p>
8953 </dd>
8954 <dt class="hdlist1">
8955 <code>codecompare</code>
8956 </dt>
8957 <dd>
8958 <p>
8959 Use Code Compare (requires a graphical session)
8960 </p>
8961 </dd>
8962 <dt class="hdlist1">
8963 <code>deltawalker</code>
8964 </dt>
8965 <dd>
8966 <p>
8967 Use DeltaWalker (requires a graphical session)
8968 </p>
8969 </dd>
8970 <dt class="hdlist1">
8971 <code>diffmerge</code>
8972 </dt>
8973 <dd>
8974 <p>
8975 Use DiffMerge (requires a graphical session)
8976 </p>
8977 </dd>
8978 <dt class="hdlist1">
8979 <code>diffuse</code>
8980 </dt>
8981 <dd>
8982 <p>
8983 Use Diffuse (requires a graphical session)
8984 </p>
8985 </dd>
8986 <dt class="hdlist1">
8987 <code>ecmerge</code>
8988 </dt>
8989 <dd>
8990 <p>
8991 Use ECMerge (requires a graphical session)
8992 </p>
8993 </dd>
8994 <dt class="hdlist1">
8995 <code>emerge</code>
8996 </dt>
8997 <dd>
8998 <p>
8999 Use Emacs' Emerge
9000 </p>
9001 </dd>
9002 <dt class="hdlist1">
9003 <code>examdiff</code>
9004 </dt>
9005 <dd>
9006 <p>
9007 Use ExamDiff Pro (requires a graphical session)
9008 </p>
9009 </dd>
9010 <dt class="hdlist1">
9011 <code>guiffy</code>
9012 </dt>
9013 <dd>
9014 <p>
9015 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
9016 </p>
9017 </dd>
9018 <dt class="hdlist1">
9019 <code>gvimdiff</code>
9020 </dt>
9021 <dd>
9022 <p>
9023 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
9024 </p>
9025 </dd>
9026 <dt class="hdlist1">
9027 <code>gvimdiff1</code>
9028 </dt>
9029 <dd>
9030 <p>
9031 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
9032 </p>
9033 </dd>
9034 <dt class="hdlist1">
9035 <code>gvimdiff2</code>
9036 </dt>
9037 <dd>
9038 <p>
9039 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
9040 </p>
9041 </dd>
9042 <dt class="hdlist1">
9043 <code>gvimdiff3</code>
9044 </dt>
9045 <dd>
9046 <p>
9047 Use gVim (requires a graphical session) where only the MERGED file is shown
9048 </p>
9049 </dd>
9050 <dt class="hdlist1">
9051 <code>kdiff3</code>
9052 </dt>
9053 <dd>
9054 <p>
9055 Use KDiff3 (requires a graphical session)
9056 </p>
9057 </dd>
9058 <dt class="hdlist1">
9059 <code>meld</code>
9060 </dt>
9061 <dd>
9062 <p>
9063 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
9064 </p>
9065 </dd>
9066 <dt class="hdlist1">
9067 <code>nvimdiff</code>
9068 </dt>
9069 <dd>
9070 <p>
9071 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
9072 </p>
9073 </dd>
9074 <dt class="hdlist1">
9075 <code>nvimdiff1</code>
9076 </dt>
9077 <dd>
9078 <p>
9079 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
9080 </p>
9081 </dd>
9082 <dt class="hdlist1">
9083 <code>nvimdiff2</code>
9084 </dt>
9085 <dd>
9086 <p>
9087 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
9088 </p>
9089 </dd>
9090 <dt class="hdlist1">
9091 <code>nvimdiff3</code>
9092 </dt>
9093 <dd>
9094 <p>
9095 Use Neovim where only the MERGED file is shown
9096 </p>
9097 </dd>
9098 <dt class="hdlist1">
9099 <code>opendiff</code>
9100 </dt>
9101 <dd>
9102 <p>
9103 Use FileMerge (requires a graphical session)
9104 </p>
9105 </dd>
9106 <dt class="hdlist1">
9107 <code>p4merge</code>
9108 </dt>
9109 <dd>
9110 <p>
9111 Use HelixCore P4Merge (requires a graphical session)
9112 </p>
9113 </dd>
9114 <dt class="hdlist1">
9115 <code>smerge</code>
9116 </dt>
9117 <dd>
9118 <p>
9119 Use Sublime Merge (requires a graphical session)
9120 </p>
9121 </dd>
9122 <dt class="hdlist1">
9123 <code>tkdiff</code>
9124 </dt>
9125 <dd>
9126 <p>
9127 Use TkDiff (requires a graphical session)
9128 </p>
9129 </dd>
9130 <dt class="hdlist1">
9131 <code>tortoisemerge</code>
9132 </dt>
9133 <dd>
9134 <p>
9135 Use TortoiseMerge (requires a graphical session)
9136 </p>
9137 </dd>
9138 <dt class="hdlist1">
9139 <code>vimdiff</code>
9140 </dt>
9141 <dd>
9142 <p>
9143 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
9144 </p>
9145 </dd>
9146 <dt class="hdlist1">
9147 <code>vimdiff1</code>
9148 </dt>
9149 <dd>
9150 <p>
9151 Use Vim with a 2 panes layout (LOCAL and REMOTE)
9152 </p>
9153 </dd>
9154 <dt class="hdlist1">
9155 <code>vimdiff2</code>
9156 </dt>
9157 <dd>
9158 <p>
9159 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
9160 </p>
9161 </dd>
9162 <dt class="hdlist1">
9163 <code>vimdiff3</code>
9164 </dt>
9165 <dd>
9166 <p>
9167 Use Vim where only the MERGED file is shown
9168 </p>
9169 </dd>
9170 <dt class="hdlist1">
9171 <code>winmerge</code>
9172 </dt>
9173 <dd>
9174 <p>
9175 Use WinMerge (requires a graphical session)
9176 </p>
9177 </dd>
9178 <dt class="hdlist1">
9179 <code>xxdiff</code>
9180 </dt>
9181 <dd>
9182 <p>
9183 Use xxdiff (requires a graphical session)
9184 </p>
9185 </dd>
9186 </dl></div>
9187 </dd>
9188 <dt class="hdlist1">
9189 merge.verbosity
9190 </dt>
9191 <dd>
9192 <p>
9193         Controls the amount of output shown by the recursive merge
9194         strategy.  Level 0 outputs nothing except a final error
9195         message if conflicts were detected. Level 1 outputs only
9196         conflicts, 2 outputs conflicts and file changes.  Level 5 and
9197         above outputs debugging information.  The default is level 2.
9198         Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
9199 </p>
9200 </dd>
9201 <dt class="hdlist1">
9202 merge.&lt;driver&gt;.name
9203 </dt>
9204 <dd>
9205 <p>
9206         Defines a human-readable name for a custom low-level
9207         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
9208 </p>
9209 </dd>
9210 <dt class="hdlist1">
9211 merge.&lt;driver&gt;.driver
9212 </dt>
9213 <dd>
9214 <p>
9215         Defines the command that implements a custom low-level
9216         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
9217 </p>
9218 </dd>
9219 <dt class="hdlist1">
9220 merge.&lt;driver&gt;.recursive
9221 </dt>
9222 <dd>
9223 <p>
9224         Names a low-level merge driver to be used when
9225         performing an internal merge between common ancestors.
9226         See <a href="gitattributes.html">gitattributes(5)</a> for details.
9227 </p>
9228 </dd>
9229 <dt class="hdlist1">
9230 mergetool.&lt;tool&gt;.path
9231 </dt>
9232 <dd>
9233 <p>
9234         Override the path for the given tool.  This is useful in case
9235         your tool is not in the PATH.
9236 </p>
9237 </dd>
9238 <dt class="hdlist1">
9239 mergetool.&lt;tool&gt;.cmd
9240 </dt>
9241 <dd>
9242 <p>
9243         Specify the command to invoke the specified merge tool.  The
9244         specified command is evaluated in shell with the following
9245         variables available: <em>BASE</em> is the name of a temporary file
9246         containing the common base of the files to be merged, if available;
9247         <em>LOCAL</em> is the name of a temporary file containing the contents of
9248         the file on the current branch; <em>REMOTE</em> is the name of a temporary
9249         file containing the contents of the file from the branch being
9250         merged; <em>MERGED</em> contains the name of the file to which the merge
9251         tool should write the results of a successful merge.
9252 </p>
9253 </dd>
9254 <dt class="hdlist1">
9255 mergetool.&lt;tool&gt;.hideResolved
9256 </dt>
9257 <dd>
9258 <p>
9259         Allows the user to override the global <code>mergetool.hideResolved</code> value
9260         for a specific tool. See <code>mergetool.hideResolved</code> for the full
9261         description.
9262 </p>
9263 </dd>
9264 <dt class="hdlist1">
9265 mergetool.&lt;tool&gt;.trustExitCode
9266 </dt>
9267 <dd>
9268 <p>
9269         For a custom merge command, specify whether the exit code of
9270         the merge command can be used to determine whether the merge was
9271         successful.  If this is not set to true then the merge target file
9272         timestamp is checked, and the merge is assumed to have been successful
9273         if the file has been updated; otherwise, the user is prompted to
9274         indicate the success of the merge.
9275 </p>
9276 </dd>
9277 <dt class="hdlist1">
9278 mergetool.meld.hasOutput
9279 </dt>
9280 <dd>
9281 <p>
9282         Older versions of <code>meld</code> do not support the <code>--output</code> option.
9283         Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
9284         by inspecting the output of <code>meld --help</code>.  Configuring
9285         <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
9286         use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
9287         to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
9288         and <code>false</code> avoids using <code>--output</code>.
9289 </p>
9290 </dd>
9291 <dt class="hdlist1">
9292 mergetool.meld.useAutoMerge
9293 </dt>
9294 <dd>
9295 <p>
9296         When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
9297         parts automatically, highlight the conflicting parts, and wait for
9298         user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
9299         Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
9300         Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
9301         is supported and will only use <code>--auto-merge</code> when available.  A
9302         value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
9303         default value.
9304 </p>
9305 </dd>
9306 <dt class="hdlist1">
9307 mergetool.&lt;vimdiff variant&gt;.layout
9308 </dt>
9309 <dd>
9310 <p>
9311         Configure the split window layout for vimdiff&#8217;s <code>&lt;variant&gt;</code>, which is any of <code>vimdiff</code>,
9312         <code>nvimdiff</code>, <code>gvimdiff</code>.
9313         Upon launching <code>git mergetool</code> with <code>--tool=&lt;variant&gt;</code> (or without <code>--tool</code>
9314         if <code>merge.tool</code> is configured as <code>&lt;variant&gt;</code>), Git will consult
9315         <code>mergetool.&lt;variant&gt;.layout</code> to determine the tool&#8217;s layout. If the
9316         variant-specific configuration is not available, <code>vimdiff</code>'s is used as
9317         fallback.  If that too is not available, a default layout with 4 windows
9318         will be used.  To configure the layout, see the <code>BACKEND SPECIFIC HINTS</code>
9319         section in <a href="git-mergetool.html">git-mergetool(1)</a>.
9320 </p>
9321 </dd>
9322 <dt class="hdlist1">
9323 mergetool.hideResolved
9324 </dt>
9325 <dd>
9326 <p>
9327         During a merge, Git will automatically resolve as many conflicts as
9328         possible and write the <em>MERGED</em> file containing conflict markers around
9329         any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
9330         represent the versions of the file from before Git&#8217;s conflict
9331         resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
9332         that only the unresolved conflicts are presented to the merge tool. Can
9333         be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
9334         configuration variable. Defaults to <code>false</code>.
9335 </p>
9336 </dd>
9337 <dt class="hdlist1">
9338 mergetool.keepBackup
9339 </dt>
9340 <dd>
9341 <p>
9342         After performing a merge, the original file with conflict markers
9343         can be saved as a file with a <code>.orig</code> extension.  If this variable
9344         is set to <code>false</code> then this file is not preserved.  Defaults to
9345         <code>true</code> (i.e. keep the backup files).
9346 </p>
9347 </dd>
9348 <dt class="hdlist1">
9349 mergetool.keepTemporaries
9350 </dt>
9351 <dd>
9352 <p>
9353         When invoking a custom merge tool, Git uses a set of temporary
9354         files to pass to the tool. If the tool returns an error and this
9355         variable is set to <code>true</code>, then these temporary files will be
9356         preserved; otherwise, they will be removed after the tool has
9357         exited. Defaults to <code>false</code>.
9358 </p>
9359 </dd>
9360 <dt class="hdlist1">
9361 mergetool.writeToTemp
9362 </dt>
9363 <dd>
9364 <p>
9365         Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
9366         conflicting files in the worktree by default.  Git will attempt
9367         to use a temporary directory for these files when set <code>true</code>.
9368         Defaults to <code>false</code>.
9369 </p>
9370 </dd>
9371 <dt class="hdlist1">
9372 mergetool.prompt
9373 </dt>
9374 <dd>
9375 <p>
9376         Prompt before each invocation of the merge resolution program.
9377 </p>
9378 </dd>
9379 <dt class="hdlist1">
9380 mergetool.guiDefault
9381 </dt>
9382 <dd>
9383 <p>
9384         Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
9385         specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
9386         or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
9387         variable value. The default is <code>false</code>, where the <code>--gui</code> argument
9388         must be provided explicitly for the <code>merge.guitool</code> to be used.
9389 </p>
9390 </dd>
9391 <dt class="hdlist1">
9392 notes.mergeStrategy
9393 </dt>
9394 <dd>
9395 <p>
9396         Which merge strategy to choose by default when resolving notes
9397         conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
9398         <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
9399         section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
9400 </p>
9401 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
9402 <a href="git-notes.html">git-notes(1)</a>.</p></div>
9403 </dd>
9404 <dt class="hdlist1">
9405 notes.&lt;name&gt;.mergeStrategy
9406 </dt>
9407 <dd>
9408 <p>
9409         Which merge strategy to choose when doing a notes merge into
9410         refs/notes/&lt;name&gt;.  This overrides the more general
9411         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
9412         <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
9413 </p>
9414 </dd>
9415 <dt class="hdlist1">
9416 notes.displayRef
9417 </dt>
9418 <dd>
9419 <p>
9420         Which ref (or refs, if a glob or specified more than once), in
9421         addition to the default set by <code>core.notesRef</code> or
9422         <code>GIT_NOTES_REF</code>, to read notes from when showing commit
9423         messages with the <em>git log</em> family of commands.
9424 </p>
9425 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
9426 environment variable, which must be a colon separated list of refs or
9427 globs.</p></div>
9428 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
9429 but a glob that does not match any refs is silently ignored.</p></div>
9430 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
9431 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
9432 those commands.</p></div>
9433 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
9434 GIT_NOTES_REF) is also implicitly added to the list of refs to be
9435 displayed.</p></div>
9436 </dd>
9437 <dt class="hdlist1">
9438 notes.rewrite.&lt;command&gt;
9439 </dt>
9440 <dd>
9441 <p>
9442         When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
9443         <code>rebase</code>), if this variable is <code>false</code>, git will not copy
9444         notes from the original to the rewritten commit.  Defaults to
9445         <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.
9446 </p>
9447 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
9448 environment variable, which must be a colon separated list of refs or
9449 globs.</p></div>
9450 </dd>
9451 <dt class="hdlist1">
9452 notes.rewriteMode
9453 </dt>
9454 <dd>
9455 <p>
9456         When copying notes during a rewrite (see the
9457         "notes.rewrite.&lt;command&gt;" option), determines what to do if
9458         the target commit already has a note.  Must be one of
9459         <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
9460         Defaults to <code>concatenate</code>.
9461 </p>
9462 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
9463 environment variable.</p></div>
9464 </dd>
9465 <dt class="hdlist1">
9466 notes.rewriteRef
9467 </dt>
9468 <dd>
9469 <p>
9470         When copying notes during a rewrite, specifies the (fully
9471         qualified) ref whose notes should be copied.  May be a glob,
9472         in which case notes in all matching refs will be copied.  You
9473         may also specify this configuration several times.
9474 </p>
9475 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
9476 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
9477 rewriting for the default commit notes.</p></div>
9478 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
9479 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
9480 </dd>
9481 <dt class="hdlist1">
9482 pack.window
9483 </dt>
9484 <dd>
9485 <p>
9486         The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9487         window size is given on the command line. Defaults to 10.
9488 </p>
9489 </dd>
9490 <dt class="hdlist1">
9491 pack.depth
9492 </dt>
9493 <dd>
9494 <p>
9495         The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9496         maximum depth is given on the command line. Defaults to 50.
9497         Maximum value is 4095.
9498 </p>
9499 </dd>
9500 <dt class="hdlist1">
9501 pack.windowMemory
9502 </dt>
9503 <dd>
9504 <p>
9505         The maximum size of memory that is consumed by each thread
9506         in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
9507         no limit is given on the command line.  The value can be
9508         suffixed with "k", "m", or "g".  When left unconfigured (or
9509         set explicitly to 0), there will be no limit.
9510 </p>
9511 </dd>
9512 <dt class="hdlist1">
9513 pack.compression
9514 </dt>
9515 <dd>
9516 <p>
9517         An integer -1..9, indicating the compression level for objects
9518         in a pack file. -1 is the zlib default. 0 means no
9519         compression, and 1..9 are various speed/size tradeoffs, 9 being
9520         slowest.  If not set,  defaults to core.compression.  If that is
9521         not set,  defaults to -1, the zlib default, which is "a default
9522         compromise between speed and compression (currently equivalent
9523         to level 6)."
9524 </p>
9525 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
9526 all existing objects. You can force recompression by passing the -F option
9527 to <a href="git-repack.html">git-repack(1)</a>.</p></div>
9528 </dd>
9529 <dt class="hdlist1">
9530 pack.allowPackReuse
9531 </dt>
9532 <dd>
9533 <p>
9534         When true or "single", and when reachability bitmaps are
9535         enabled, pack-objects will try to send parts of the bitmapped
9536         packfile verbatim. When "multi", and when a multi-pack
9537         reachability bitmap is available, pack-objects will try to send
9538         parts of all packs in the MIDX.
9539 </p>
9540 <div class="paragraph"><p>If only a single pack bitmap is available, and <code>pack.allowPackReuse</code>
9541 is set to "multi", reuse parts of just the bitmapped packfile. This
9542 can reduce memory and CPU usage to serve fetches, but might result in
9543 sending a slightly larger pack. Defaults to true.</p></div>
9544 </dd>
9545 <dt class="hdlist1">
9546 pack.island
9547 </dt>
9548 <dd>
9549 <p>
9550         An extended regular expression configuring a set of delta
9551         islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
9552         for details.
9553 </p>
9554 </dd>
9555 <dt class="hdlist1">
9556 pack.islandCore
9557 </dt>
9558 <dd>
9559 <p>
9560         Specify an island name which gets to have its objects be
9561         packed first. This creates a kind of pseudo-pack at the front
9562         of one pack, so that the objects from the specified island are
9563         hopefully faster to copy into any pack that should be served
9564         to a user requesting these objects. In practice this means
9565         that the island specified should likely correspond to what is
9566         the most commonly cloned in the repo. See also "DELTA ISLANDS"
9567         in <a href="git-pack-objects.html">git-pack-objects(1)</a>.
9568 </p>
9569 </dd>
9570 <dt class="hdlist1">
9571 pack.deltaCacheSize
9572 </dt>
9573 <dd>
9574 <p>
9575         The maximum memory in bytes used for caching deltas in
9576         <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
9577         This cache is used to speed up the writing object phase by not
9578         having to recompute the final delta result once the best match
9579         for all objects is found.  Repacking large repositories on machines
9580         which are tight with memory might be badly impacted by this though,
9581         especially if this cache pushes the system into swapping.
9582         A value of 0 means no limit. The smallest size of 1 byte may be
9583         used to virtually disable this cache. Defaults to 256 MiB.
9584 </p>
9585 </dd>
9586 <dt class="hdlist1">
9587 pack.deltaCacheLimit
9588 </dt>
9589 <dd>
9590 <p>
9591         The maximum size of a delta, that is cached in
9592         <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
9593         writing object phase by not having to recompute the final delta
9594         result once the best match for all objects is found.
9595         Defaults to 1000. Maximum value is 65535.
9596 </p>
9597 </dd>
9598 <dt class="hdlist1">
9599 pack.threads
9600 </dt>
9601 <dd>
9602 <p>
9603         Specifies the number of threads to spawn when searching for best
9604         delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
9605         be compiled with pthreads otherwise this option is ignored with a
9606         warning. This is meant to reduce packing time on multiprocessor
9607         machines. The required amount of memory for the delta search window
9608         is however multiplied by the number of threads.
9609         Specifying 0 will cause Git to auto-detect the number of CPUs
9610         and set the number of threads accordingly.
9611 </p>
9612 </dd>
9613 <dt class="hdlist1">
9614 pack.indexVersion
9615 </dt>
9616 <dd>
9617 <p>
9618         Specify the default pack index version.  Valid values are 1 for
9619         legacy pack index used by Git versions prior to 1.5.2, and 2 for
9620         the new pack index with capabilities for packs larger than 4 GB
9621         as well as proper protection against the repacking of corrupted
9622         packs.  Version 2 is the default.  Note that version 2 is enforced
9623         and this config option is ignored whenever the corresponding pack is
9624         larger than 2 GB.
9625 </p>
9626 <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9627 cloning or fetching over a non-native protocol (e.g. "http")
9628 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9629 other side may give you a repository that cannot be accessed with your
9630 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9631 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
9632 the <code>*.idx</code> file.</p></div>
9633 </dd>
9634 <dt class="hdlist1">
9635 pack.packSizeLimit
9636 </dt>
9637 <dd>
9638 <p>
9639         The maximum size of a pack.  This setting only affects
9640         packing to a file when repacking, i.e. the git:// protocol
9641         is unaffected.  It can be overridden by the <code>--max-pack-size</code>
9642         option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
9643         in the creation of multiple packfiles.
9644 </p>
9645 <div class="paragraph"><p>Note that this option is rarely useful, and may result in a larger total
9646 on-disk size (because Git will not store deltas between packs) and
9647 worse runtime performance (object lookup within multiple packs is
9648 slower than a single pack, and optimizations like reachability bitmaps
9649 cannot cope with multiple packs).</p></div>
9650 <div class="paragraph"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9651 filesystem does not support large files), this option may help. But if
9652 your goal is to transmit a packfile over a medium that supports limited
9653 sizes (e.g., removable media that cannot store the whole repository),
9654 you are likely better off creating a single large packfile and splitting
9655 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9656 <div class="paragraph"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9657 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9658 </dd>
9659 <dt class="hdlist1">
9660 pack.useBitmaps
9661 </dt>
9662 <dd>
9663 <p>
9664         When true, git will use pack bitmaps (if available) when packing
9665         to stdout (e.g., during the server side of a fetch). Defaults to
9666         true. You should not generally need to turn this off unless
9667         you are debugging pack bitmaps.
9668 </p>
9669 </dd>
9670 <dt class="hdlist1">
9671 pack.useBitmapBoundaryTraversal
9672 </dt>
9673 <dd>
9674 <p>
9675         When true, Git will use an experimental algorithm for computing
9676         reachability queries with bitmaps. Instead of building up
9677         complete bitmaps for all of the negated tips and then OR-ing
9678         them together, consider negated tips with existing bitmaps as
9679         additive (i.e. OR-ing them into the result if they exist,
9680         ignoring them otherwise), and build up a bitmap at the boundary
9681         instead.
9682 </p>
9683 <div class="paragraph"><p>When using this algorithm, Git may include too many objects as a result
9684 of not opening up trees belonging to certain UNINTERESTING commits. This
9685 inexactness matches the non-bitmap traversal algorithm.</p></div>
9686 <div class="paragraph"><p>In many cases, this can provide a speed-up over the exact algorithm,
9687 particularly when there is poor bitmap coverage of the negated side of
9688 the query.</p></div>
9689 </dd>
9690 <dt class="hdlist1">
9691 pack.useSparse
9692 </dt>
9693 <dd>
9694 <p>
9695         When true, git will default to using the <em>--sparse</em> option in
9696         <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9697         algorithm only walks trees that appear in paths that introduce new
9698         objects. This can have significant performance benefits when
9699         computing a pack to send a small change. However, it is possible
9700         that extra objects are added to the pack-file if the included
9701         commits contain certain types of direct renames. Default is
9702         <code>true</code>.
9703 </p>
9704 </dd>
9705 <dt class="hdlist1">
9706 pack.preferBitmapTips
9707 </dt>
9708 <dd>
9709 <p>
9710         When selecting which commits will receive bitmaps, prefer a
9711         commit at the tip of any reference that is a suffix of any value
9712         of this configuration over any other commits in the "selection
9713         window".
9714 </p>
9715 <div class="paragraph"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9716 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9717 necessarily be selected. This is because commits are selected for
9718 bitmaps from within a series of windows of variable length.</p></div>
9719 <div class="paragraph"><p>If a commit at the tip of any reference which is a suffix of any value
9720 of this configuration is seen in a window, it is immediately given
9721 preference over any other commit in that window.</p></div>
9722 </dd>
9723 <dt class="hdlist1">
9724 pack.writeBitmaps (deprecated)
9725 </dt>
9726 <dd>
9727 <p>
9728         This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9729 </p>
9730 </dd>
9731 <dt class="hdlist1">
9732 pack.writeBitmapHashCache
9733 </dt>
9734 <dd>
9735 <p>
9736         When true, git will include a "hash cache" section in the bitmap
9737         index (if one is written). This cache can be used to feed git&#8217;s
9738         delta heuristics, potentially leading to better deltas between
9739         bitmapped and non-bitmapped objects (e.g., when serving a fetch
9740         between an older, bitmapped pack and objects that have been
9741         pushed since the last gc). The downside is that it consumes 4
9742         bytes per object of disk space. Defaults to true.
9743 </p>
9744 <div class="paragraph"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9745 computed; instead, any namehashes stored in an existing bitmap are
9746 permuted into their appropriate location when writing a new bitmap.</p></div>
9747 </dd>
9748 <dt class="hdlist1">
9749 pack.writeBitmapLookupTable
9750 </dt>
9751 <dd>
9752 <p>
9753         When true, Git will include a "lookup table" section in the
9754         bitmap index (if one is written). This table is used to defer
9755         loading individual bitmaps as late as possible. This can be
9756         beneficial in repositories that have relatively large bitmap
9757         indexes. Defaults to false.
9758 </p>
9759 </dd>
9760 <dt class="hdlist1">
9761 pack.readReverseIndex
9762 </dt>
9763 <dd>
9764 <p>
9765         When true, git will read any .rev file(s) that may be available
9766         (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
9767         will be generated from scratch and stored in memory. Defaults to
9768         true.
9769 </p>
9770 </dd>
9771 <dt class="hdlist1">
9772 pack.writeReverseIndex
9773 </dt>
9774 <dd>
9775 <p>
9776         When true, git will write a corresponding .rev file (see:
9777         <a href="gitformat-pack.html">gitformat-pack(5)</a>)
9778         for each new packfile that it writes in all places except for
9779         <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
9780         Defaults to true.
9781 </p>
9782 </dd>
9783 <dt class="hdlist1">
9784 pager.&lt;cmd&gt;
9785 </dt>
9786 <dd>
9787 <p>
9788         If the value is boolean, turns on or off pagination of the
9789         output of a particular Git subcommand when writing to a tty.
9790         Otherwise, turns on pagination for the subcommand using the
9791         pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
9792         or <code>--no-pager</code> is specified on the command line, it takes
9793         precedence over this option.  To disable pagination for all
9794         commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9795 </p>
9796 </dd>
9797 <dt class="hdlist1">
9798 pretty.&lt;name&gt;
9799 </dt>
9800 <dd>
9801 <p>
9802         Alias for a --pretty= format string, as specified in
9803         <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
9804         as the built-in pretty formats could. For example,
9805         running <code>git config pretty.changelog "format:* %H %s"</code>
9806         would cause the invocation <code>git log --pretty=changelog</code>
9807         to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
9808         Note that an alias with the same name as a built-in format
9809         will be silently ignored.
9810 </p>
9811 </dd>
9812 <dt class="hdlist1">
9813 promisor.quiet
9814 </dt>
9815 <dd>
9816 <p>
9817         If set to "true" assume <code>--quiet</code> when fetching additional
9818         objects for a partial clone.
9819 </p>
9820 </dd>
9821 <dt class="hdlist1">
9822 protocol.allow
9823 </dt>
9824 <dd>
9825 <p>
9826         If set, provide a user defined default policy for all protocols which
9827         don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
9828         if unset, known-safe protocols (http, https, git, ssh) have a
9829         default policy of <code>always</code>, known-dangerous protocols (ext) have a
9830         default policy of <code>never</code>, and all other protocols (including file)
9831         have a default policy of <code>user</code>.  Supported policies:
9832 </p>
9833 <div class="openblock">
9834 <div class="content">
9835 <div class="ulist"><ul>
9836 <li>
9837 <p>
9838 <code>always</code> - protocol is always able to be used.
9839 </p>
9840 </li>
9841 <li>
9842 <p>
9843 <code>never</code> - protocol is never able to be used.
9844 </p>
9845 </li>
9846 <li>
9847 <p>
9848 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9849   either unset or has a value of 1.  This policy should be used when you want a
9850   protocol to be directly usable by the user but don&#8217;t want it used by commands which
9851   execute clone/fetch/push commands without user input, e.g. recursive
9852   submodule initialization.
9853 </p>
9854 </li>
9855 </ul></div>
9856 </div></div>
9857 </dd>
9858 <dt class="hdlist1">
9859 protocol.&lt;name&gt;.allow
9860 </dt>
9861 <dd>
9862 <p>
9863         Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
9864         commands. See <code>protocol.allow</code> above for the available policies.
9865 </p>
9866 <div class="paragraph"><p>The protocol names currently used by git are:</p></div>
9867 <div class="openblock">
9868 <div class="content">
9869 <div class="ulist"><ul>
9870 <li>
9871 <p>
9872 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9873     or local paths)
9874 </p>
9875 </li>
9876 <li>
9877 <p>
9878 <code>git</code>: the anonymous git protocol over a direct TCP
9879     connection (or proxy, if configured)
9880 </p>
9881 </li>
9882 <li>
9883 <p>
9884 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9885     <code>ssh://</code>, etc).
9886 </p>
9887 </li>
9888 <li>
9889 <p>
9890 <code>http</code>: git over http, both "smart http" and "dumb http".
9891     Note that this does <em>not</em> include <code>https</code>; if you want to configure
9892     both, you must do so individually.
9893 </p>
9894 </li>
9895 <li>
9896 <p>
9897 any external helpers are named by their protocol (e.g., use
9898     <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9899 </p>
9900 </li>
9901 </ul></div>
9902 </div></div>
9903 </dd>
9904 <dt class="hdlist1">
9905 protocol.version
9906 </dt>
9907 <dd>
9908 <p>
9909         If set, clients will attempt to communicate with a server
9910         using the specified protocol version.  If the server does
9911         not support it, communication falls back to version 0.
9912         If unset, the default is <code>2</code>.
9913         Supported versions:
9914 </p>
9915 <div class="openblock">
9916 <div class="content">
9917 <div class="ulist"><ul>
9918 <li>
9919 <p>
9920 <code>0</code> - the original wire protocol.
9921 </p>
9922 </li>
9923 <li>
9924 <p>
9925 <code>1</code> - the original wire protocol with the addition of a version string
9926   in the initial response from the server.
9927 </p>
9928 </li>
9929 <li>
9930 <p>
9931 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.
9932 </p>
9933 </li>
9934 </ul></div>
9935 </div></div>
9936 </dd>
9937 <dt class="hdlist1">
9938 pull.ff
9939 </dt>
9940 <dd>
9941 <p>
9942         By default, Git does not create an extra merge commit when merging
9943         a commit that is a descendant of the current commit. Instead, the
9944         tip of the current branch is fast-forwarded. When set to <code>false</code>,
9945         this variable tells Git to create an extra merge commit in such
9946         a case (equivalent to giving the <code>--no-ff</code> option from the command
9947         line). When set to <code>only</code>, only such fast-forward merges are
9948         allowed (equivalent to giving the <code>--ff-only</code> option from the
9949         command line). This setting overrides <code>merge.ff</code> when pulling.
9950 </p>
9951 </dd>
9952 <dt class="hdlist1">
9953 pull.rebase
9954 </dt>
9955 <dd>
9956 <p>
9957         When true, rebase branches on top of the fetched branch, instead
9958         of merging the default branch from the default remote when "git
9959         pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
9960         per-branch basis.
9961 </p>
9962 <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>
9963 so that the local merge commits are included in the rebase (see
9964 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
9965 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9966 mode.</p></div>
9967 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9968 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
9969 for details).</p></div>
9970 </dd>
9971 <dt class="hdlist1">
9972 pull.octopus
9973 </dt>
9974 <dd>
9975 <p>
9976         The default merge strategy to use when pulling multiple branches
9977         at once.
9978 </p>
9979 </dd>
9980 <dt class="hdlist1">
9981 pull.twohead
9982 </dt>
9983 <dd>
9984 <p>
9985         The default merge strategy to use when pulling a single branch.
9986 </p>
9987 </dd>
9988 <dt class="hdlist1">
9989 push.autoSetupRemote
9990 </dt>
9991 <dd>
9992 <p>
9993         If set to "true" assume <code>--set-upstream</code> on default push when no
9994         upstream tracking exists for the current branch; this option
9995         takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9996         and <em>current</em>. It is useful if by default you want new branches
9997         to be pushed to the default remote (like the behavior of
9998         <em>push.default=current</em>) and you also want the upstream tracking
9999         to be set. Workflows most likely to benefit from this option are
10000         <em>simple</em> central workflows where all branches are expected to
10001         have the same name on the remote.
10002 </p>
10003 </dd>
10004 <dt class="hdlist1">
10005 push.default
10006 </dt>
10007 <dd>
10008 <p>
10009         Defines the action <code>git push</code> should take if no refspec is
10010         given (whether from the command-line, config, or elsewhere).
10011         Different values are well-suited for
10012         specific workflows; for instance, in a purely central workflow
10013         (i.e. the fetch source is equal to the push destination),
10014         <code>upstream</code> is probably what you want.  Possible values are:
10015 </p>
10016 <div class="openblock">
10017 <div class="content">
10018 <div class="ulist"><ul>
10019 <li>
10020 <p>
10021 <code>nothing</code> - do not push anything (error out) unless a refspec is
10022   given. This is primarily meant for people who want to
10023   avoid mistakes by always being explicit.
10024 </p>
10025 </li>
10026 <li>
10027 <p>
10028 <code>current</code> - push the current branch to update a branch with the same
10029   name on the receiving end.  Works in both central and non-central
10030   workflows.
10031 </p>
10032 </li>
10033 <li>
10034 <p>
10035 <code>upstream</code> - push the current branch back to the branch whose
10036   changes are usually integrated into the current branch (which is
10037   called <code>@{upstream}</code>).  This mode only makes sense if you are
10038   pushing to the same repository you would normally pull from
10039   (i.e. central workflow).
10040 </p>
10041 </li>
10042 <li>
10043 <p>
10044 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
10045 </p>
10046 </li>
10047 <li>
10048 <p>
10049 <code>simple</code> - push the current branch with the same name on the remote.
10050 </p>
10051 <div class="paragraph"><p>If you are working on a centralized workflow (pushing to the same repository you
10052 pull from, which is typically <code>origin</code>), then you need to configure an upstream
10053 branch with the same name.</p></div>
10054 <div class="paragraph"><p>This mode is the default since Git 2.0, and is the safest option suited for
10055 beginners.</p></div>
10056 </li>
10057 <li>
10058 <p>
10059 <code>matching</code> - push all branches having the same name on both ends.
10060   This makes the repository you are pushing to remember the set of
10061   branches that will be pushed out (e.g. if you always push <em>maint</em>
10062   and <em>master</em> there and no other branches, the repository you push
10063   to will have these two branches, and your local <em>maint</em> and
10064   <em>master</em> will be pushed there).
10065 </p>
10066 <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
10067 branches you would push out are ready to be pushed out before
10068 running <em>git push</em>, as the whole point of this mode is to allow you
10069 to push all of the branches in one go.  If you usually finish work
10070 on only one branch and push out the result, while other branches are
10071 unfinished, this mode is not for you.  Also this mode is not
10072 suitable for pushing into a shared central repository, as other
10073 people may add new branches there, or update the tip of existing
10074 branches outside your control.</p></div>
10075 <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
10076 new default).</p></div>
10077 </li>
10078 </ul></div>
10079 </div></div>
10080 </dd>
10081 <dt class="hdlist1">
10082 push.followTags
10083 </dt>
10084 <dd>
10085 <p>
10086         If set to true, enable <code>--follow-tags</code> option by default.  You
10087         may override this configuration at time of push by specifying
10088         <code>--no-follow-tags</code>.
10089 </p>
10090 </dd>
10091 <dt class="hdlist1">
10092 push.gpgSign
10093 </dt>
10094 <dd>
10095 <p>
10096         May be set to a boolean value, or the string <em>if-asked</em>. A true
10097         value causes all pushes to be GPG signed, as if <code>--signed</code> is
10098         passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
10099         pushes to be signed if the server supports it, as if
10100         <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
10101         override a value from a lower-priority config file. An explicit
10102         command-line flag always overrides this config option.
10103 </p>
10104 </dd>
10105 <dt class="hdlist1">
10106 push.pushOption
10107 </dt>
10108 <dd>
10109 <p>
10110         When no <code>--push-option=&lt;option&gt;</code> argument is given from the
10111         command line, <code>git push</code> behaves as if each &lt;value&gt; of
10112         this variable is given as <code>--push-option=&lt;value&gt;</code>.
10113 </p>
10114 <div class="paragraph"><p>This is a multi-valued variable, and an empty value can be used in a
10115 higher priority configuration file (e.g. <code>.git/config</code> in a
10116 repository) to clear the values inherited from a lower priority
10117 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
10118 <div class="listingblock">
10119 <div class="content">
10120 <pre><code>Example:
10121
10122 /etc/gitconfig
10123   push.pushoption = a
10124   push.pushoption = b
10125
10126 ~/.gitconfig
10127   push.pushoption = c
10128
10129 repo/.git/config
10130   push.pushoption =
10131   push.pushoption = b
10132
10133 This will result in only b (a and c are cleared).</code></pre>
10134 </div></div>
10135 </dd>
10136 <dt class="hdlist1">
10137 push.recurseSubmodules
10138 </dt>
10139 <dd>
10140 <p>
10141         May be "check", "on-demand", "only", or "no", with the same behavior
10142         as that of "push --recurse-submodules".
10143         If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
10144         set (in which case a <em>true</em> value means <em>on-demand</em>).
10145 </p>
10146 </dd>
10147 <dt class="hdlist1">
10148 push.useForceIfIncludes
10149 </dt>
10150 <dd>
10151 <p>
10152         If set to "true", it is equivalent to specifying
10153         <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
10154         in the command line. Adding <code>--no-force-if-includes</code> at the
10155         time of push overrides this configuration setting.
10156 </p>
10157 </dd>
10158 <dt class="hdlist1">
10159 push.negotiate
10160 </dt>
10161 <dd>
10162 <p>
10163         If set to "true", attempt to reduce the size of the packfile
10164         sent by rounds of negotiation in which the client and the
10165         server attempt to find commits in common. If "false", Git will
10166         rely solely on the server&#8217;s ref advertisement to find commits
10167         in common.
10168 </p>
10169 </dd>
10170 <dt class="hdlist1">
10171 push.useBitmaps
10172 </dt>
10173 <dd>
10174 <p>
10175         If set to "false", disable use of bitmaps for "git push" even if
10176         <code>pack.useBitmaps</code> is "true", without preventing other git operations
10177         from using bitmaps. Default is true.
10178 </p>
10179 </dd>
10180 <dt class="hdlist1">
10181 rebase.backend
10182 </dt>
10183 <dd>
10184 <p>
10185         Default backend to use for rebasing.  Possible choices are
10186         <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
10187         all remaining capabilities of the apply backend, this setting
10188         may become unused.
10189 </p>
10190 </dd>
10191 <dt class="hdlist1">
10192 rebase.stat
10193 </dt>
10194 <dd>
10195 <p>
10196         Whether to show a diffstat of what changed upstream since the last
10197         rebase. False by default.
10198 </p>
10199 </dd>
10200 <dt class="hdlist1">
10201 rebase.autoSquash
10202 </dt>
10203 <dd>
10204 <p>
10205         If set to true, enable the <code>--autosquash</code> option of
10206         <a href="git-rebase.html">git-rebase(1)</a> by default for interactive mode.
10207         This can be overridden with the <code>--no-autosquash</code> option.
10208 </p>
10209 </dd>
10210 <dt class="hdlist1">
10211 rebase.autoStash
10212 </dt>
10213 <dd>
10214 <p>
10215         When set to true, automatically create a temporary stash entry
10216         before the operation begins, and apply it after the operation
10217         ends.  This means that you can run rebase on a dirty worktree.
10218         However, use with care: the final stash application after a
10219         successful rebase might result in non-trivial conflicts.
10220         This option can be overridden by the <code>--no-autostash</code> and
10221         <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
10222         Defaults to false.
10223 </p>
10224 </dd>
10225 <dt class="hdlist1">
10226 rebase.updateRefs
10227 </dt>
10228 <dd>
10229 <p>
10230         If set to true enable <code>--update-refs</code> option by default.
10231 </p>
10232 </dd>
10233 <dt class="hdlist1">
10234 rebase.missingCommitsCheck
10235 </dt>
10236 <dd>
10237 <p>
10238         If set to "warn", git rebase -i will print a warning if some
10239         commits are removed (e.g. a line was deleted), however the
10240         rebase will still proceed. If set to "error", it will print
10241         the previous warning and stop the rebase, <em>git rebase
10242         --edit-todo</em> can then be used to correct the error. If set to
10243         "ignore", no checking is done.
10244         To drop a commit without warning or error, use the <code>drop</code>
10245         command in the todo list.
10246         Defaults to "ignore".
10247 </p>
10248 </dd>
10249 <dt class="hdlist1">
10250 rebase.instructionFormat
10251 </dt>
10252 <dd>
10253 <p>
10254         A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
10255         todo list during an interactive rebase.  The format will
10256         automatically have the commit hash prepended to the format.
10257 </p>
10258 </dd>
10259 <dt class="hdlist1">
10260 rebase.abbreviateCommands
10261 </dt>
10262 <dd>
10263 <p>
10264         If set to true, <code>git rebase</code> will use abbreviated command names in the
10265         todo list resulting in something like this:
10266 </p>
10267 <div class="listingblock">
10268 <div class="content">
10269 <pre><code>        p deadbee The oneline of the commit
10270         p fa1afe1 The oneline of the next commit
10271         ...</code></pre>
10272 </div></div>
10273 <div class="paragraph"><p>instead of:</p></div>
10274 <div class="listingblock">
10275 <div class="content">
10276 <pre><code>        pick deadbee The oneline of the commit
10277         pick fa1afe1 The oneline of the next commit
10278         ...</code></pre>
10279 </div></div>
10280 <div class="paragraph"><p>Defaults to false.</p></div>
10281 </dd>
10282 <dt class="hdlist1">
10283 rebase.rescheduleFailedExec
10284 </dt>
10285 <dd>
10286 <p>
10287         Automatically reschedule <code>exec</code> commands that failed. This only makes
10288         sense in interactive mode (or when an <code>--exec</code> option was provided).
10289         This is the same as specifying the <code>--reschedule-failed-exec</code> option.
10290 </p>
10291 </dd>
10292 <dt class="hdlist1">
10293 rebase.forkPoint
10294 </dt>
10295 <dd>
10296 <p>
10297         If set to false set <code>--no-fork-point</code> option by default.
10298 </p>
10299 </dd>
10300 <dt class="hdlist1">
10301 rebase.rebaseMerges
10302 </dt>
10303 <dd>
10304 <p>
10305         Whether and how to set the <code>--rebase-merges</code> option by default. Can
10306         be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
10307         true or to <code>no-rebase-cousins</code> is equivalent to
10308         <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
10309         equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
10310         equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
10311         command line, with or without an argument, overrides any
10312         <code>rebase.rebaseMerges</code> configuration.
10313 </p>
10314 </dd>
10315 <dt class="hdlist1">
10316 rebase.maxLabelLength
10317 </dt>
10318 <dd>
10319 <p>
10320         When generating label names from commit subjects, truncate the names to
10321         this length. By default, the names are truncated to a little less than
10322         <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
10323         corresponding loose refs).
10324 </p>
10325 </dd>
10326 <dt class="hdlist1">
10327 receive.advertiseAtomic
10328 </dt>
10329 <dd>
10330 <p>
10331         By default, git-receive-pack will advertise the atomic push
10332         capability to its clients. If you don&#8217;t want to advertise this
10333         capability, set this variable to false.
10334 </p>
10335 </dd>
10336 <dt class="hdlist1">
10337 receive.advertisePushOptions
10338 </dt>
10339 <dd>
10340 <p>
10341         When set to true, git-receive-pack will advertise the push options
10342         capability to its clients. False by default.
10343 </p>
10344 </dd>
10345 <dt class="hdlist1">
10346 receive.autogc
10347 </dt>
10348 <dd>
10349 <p>
10350         By default, git-receive-pack will run "git maintenance run --auto" after
10351         receiving data from git-push and updating refs.  You can stop
10352         it by setting this variable to false.
10353 </p>
10354 </dd>
10355 <dt class="hdlist1">
10356 receive.certNonceSeed
10357 </dt>
10358 <dd>
10359 <p>
10360         By setting this variable to a string, <code>git receive-pack</code>
10361         will accept a <code>git push --signed</code> and verify it by using
10362         a "nonce" protected by HMAC using this string as a secret
10363         key.
10364 </p>
10365 </dd>
10366 <dt class="hdlist1">
10367 receive.certNonceSlop
10368 </dt>
10369 <dd>
10370 <p>
10371         When a <code>git push --signed</code> sends a push certificate with a
10372         "nonce" that was issued by a receive-pack serving the same
10373         repository within this many seconds, export the "nonce"
10374         found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
10375         hooks (instead of what the receive-pack asked the sending
10376         side to include).  This may allow writing checks in
10377         <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
10378         checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
10379         that records by how many seconds the nonce is stale to
10380         decide if they want to accept the certificate, they only
10381         can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
10382 </p>
10383 </dd>
10384 <dt class="hdlist1">
10385 receive.fsckObjects
10386 </dt>
10387 <dd>
10388 <p>
10389         If it is set to true, git-receive-pack will check all received
10390         objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
10391         Defaults to false. If not set, the value of
10392         <code>transfer.fsckObjects</code> is used instead.
10393 </p>
10394 </dd>
10395 <dt class="hdlist1">
10396 receive.fsck.&lt;msg-id&gt;
10397 </dt>
10398 <dd>
10399 <p>
10400         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
10401         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
10402         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
10403         details.
10404 </p>
10405 </dd>
10406 <dt class="hdlist1">
10407 receive.fsck.skipList
10408 </dt>
10409 <dd>
10410 <p>
10411         Acts like <code>fsck.skipList</code>, but is used by
10412         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
10413         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
10414         details.
10415 </p>
10416 </dd>
10417 <dt class="hdlist1">
10418 receive.keepAlive
10419 </dt>
10420 <dd>
10421 <p>
10422         After receiving the pack from the client, <code>receive-pack</code> may
10423         produce no output (if <code>--quiet</code> was specified) while processing
10424         the pack, causing some networks to drop the TCP connection.
10425         With this option set, if <code>receive-pack</code> does not transmit
10426         any data in this phase for <code>receive.keepAlive</code> seconds, it will
10427         send a short keepalive packet.  The default is 5 seconds; set
10428         to 0 to disable keepalives entirely.
10429 </p>
10430 </dd>
10431 <dt class="hdlist1">
10432 receive.unpackLimit
10433 </dt>
10434 <dd>
10435 <p>
10436         If the number of objects received in a push is below this
10437         limit then the objects will be unpacked into loose object
10438         files. However if the number of received objects equals or
10439         exceeds this limit then the received pack will be stored as
10440         a pack, after adding any missing delta bases.  Storing the
10441         pack from a push can make the push operation complete faster,
10442         especially on slow filesystems.  If not set, the value of
10443         <code>transfer.unpackLimit</code> is used instead.
10444 </p>
10445 </dd>
10446 <dt class="hdlist1">
10447 receive.maxInputSize
10448 </dt>
10449 <dd>
10450 <p>
10451         If the size of the incoming pack stream is larger than this
10452         limit, then git-receive-pack will error out, instead of
10453         accepting the pack file. If not set or set to 0, then the size
10454         is unlimited.
10455 </p>
10456 </dd>
10457 <dt class="hdlist1">
10458 receive.denyDeletes
10459 </dt>
10460 <dd>
10461 <p>
10462         If set to true, git-receive-pack will deny a ref update that deletes
10463         the ref. Use this to prevent such a ref deletion via a push.
10464 </p>
10465 </dd>
10466 <dt class="hdlist1">
10467 receive.denyDeleteCurrent
10468 </dt>
10469 <dd>
10470 <p>
10471         If set to true, git-receive-pack will deny a ref update that
10472         deletes the currently checked out branch of a non-bare repository.
10473 </p>
10474 </dd>
10475 <dt class="hdlist1">
10476 receive.denyCurrentBranch
10477 </dt>
10478 <dd>
10479 <p>
10480         If set to true or "refuse", git-receive-pack will deny a ref update
10481         to the currently checked out branch of a non-bare repository.
10482         Such a push is potentially dangerous because it brings the HEAD
10483         out of sync with the index and working tree. If set to "warn",
10484         print a warning of such a push to stderr, but allow the push to
10485         proceed. If set to false or "ignore", allow such pushes with no
10486         message. Defaults to "refuse".
10487 </p>
10488 <div class="paragraph"><p>Another option is "updateInstead" which will update the working
10489 tree if pushing into the current branch.  This option is
10490 intended for synchronizing working directories when one side is not easily
10491 accessible via interactive ssh (e.g. a live web site, hence the requirement
10492 that the working directory be clean). This mode also comes in handy when
10493 developing inside a VM to test and fix code on different Operating Systems.</p></div>
10494 <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
10495 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
10496 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p></div>
10497 </dd>
10498 <dt class="hdlist1">
10499 receive.denyNonFastForwards
10500 </dt>
10501 <dd>
10502 <p>
10503         If set to true, git-receive-pack will deny a ref update which is
10504         not a fast-forward. Use this to prevent such an update via a push,
10505         even if that push is forced. This configuration variable is
10506         set when initializing a shared repository.
10507 </p>
10508 </dd>
10509 <dt class="hdlist1">
10510 receive.hideRefs
10511 </dt>
10512 <dd>
10513 <p>
10514         This variable is the same as <code>transfer.hideRefs</code>, but applies
10515         only to <code>receive-pack</code> (and so affects pushes, but not fetches).
10516         An attempt to update or delete a hidden ref by <code>git push</code> is
10517         rejected.
10518 </p>
10519 </dd>
10520 <dt class="hdlist1">
10521 receive.procReceiveRefs
10522 </dt>
10523 <dd>
10524 <p>
10525         This is a multi-valued variable that defines reference prefixes
10526         to match the commands in <code>receive-pack</code>.  Commands matching the
10527         prefixes will be executed by an external hook "proc-receive",
10528         instead of the internal <code>execute_commands</code> function.  If this
10529         variable is not defined, the "proc-receive" hook will never be
10530         used, and all commands will be executed by the internal
10531         <code>execute_commands</code> function.
10532 </p>
10533 <div class="paragraph"><p>For example, if this variable is set to "refs/for", pushing to reference
10534 such as "refs/for/master" will not create or update a reference named
10535 "refs/for/master", but may create or update a pull request directly by
10536 running the hook "proc-receive".</p></div>
10537 <div class="paragraph"><p>Optional modifiers can be provided in the beginning of the value to filter
10538 commands for specific actions: create (a), modify (m), delete (d).
10539 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
10540 E.g.:</p></div>
10541 <div class="literalblock">
10542 <div class="content">
10543 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
10544 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
10545 </div></div>
10546 </dd>
10547 <dt class="hdlist1">
10548 receive.updateServerInfo
10549 </dt>
10550 <dd>
10551 <p>
10552         If set to true, git-receive-pack will run git-update-server-info
10553         after receiving data from git-push and updating refs.
10554 </p>
10555 </dd>
10556 <dt class="hdlist1">
10557 receive.shallowUpdate
10558 </dt>
10559 <dd>
10560 <p>
10561         If set to true, .git/shallow can be updated when new refs
10562         require new shallow roots. Otherwise those refs are rejected.
10563 </p>
10564 </dd>
10565 <dt class="hdlist1">
10566 reftable.blockSize
10567 </dt>
10568 <dd>
10569 <p>
10570         The size in bytes used by the reftable backend when writing blocks.
10571         The block size is determined by the writer, and does not have to be a
10572         power of 2. The block size must be larger than the longest reference
10573         name or log entry used in the repository, as references cannot span
10574         blocks.
10575 </p>
10576 <div class="paragraph"><p>Powers of two that are friendly to the virtual memory system or
10577 filesystem (such as 4kB or 8kB) are recommended. Larger sizes (64kB) can
10578 yield better compression, with a possible increased cost incurred by
10579 readers during access.</p></div>
10580 <div class="paragraph"><p>The largest block size is <code>16777215</code> bytes (15.99 MiB). The default value is
10581 <code>4096</code> bytes (4kB). A value of <code>0</code> will use the default value.</p></div>
10582 </dd>
10583 <dt class="hdlist1">
10584 reftable.restartInterval
10585 </dt>
10586 <dd>
10587 <p>
10588         The interval at which to create restart points. The reftable backend
10589         determines the restart points at file creation. Every 16 may be
10590         more suitable for smaller block sizes (4k or 8k), every 64 for larger
10591         block sizes (64k).
10592 </p>
10593 <div class="paragraph"><p>More frequent restart points reduces prefix compression and increases
10594 space consumed by the restart table, both of which increase file size.</p></div>
10595 <div class="paragraph"><p>Less frequent restart points makes prefix compression more effective,
10596 decreasing overall file size, with increased penalties for readers
10597 walking through more records after the binary search step.</p></div>
10598 <div class="paragraph"><p>A maximum of <code>65535</code> restart points per block is supported.</p></div>
10599 <div class="paragraph"><p>The default value is to create restart points every 16 records. A value of <code>0</code>
10600 will use the default value.</p></div>
10601 </dd>
10602 <dt class="hdlist1">
10603 reftable.indexObjects
10604 </dt>
10605 <dd>
10606 <p>
10607         Whether the reftable backend shall write object blocks. Object blocks
10608         are a reverse mapping of object ID to the references pointing to them.
10609 </p>
10610 <div class="paragraph"><p>The default value is <code>true</code>.</p></div>
10611 </dd>
10612 <dt class="hdlist1">
10613 reftable.geometricFactor
10614 </dt>
10615 <dd>
10616 <p>
10617         Whenever the reftable backend appends a new table to the stack, it
10618         performs auto compaction to ensure that there is only a handful of
10619         tables. The backend does this by ensuring that tables form a geometric
10620         sequence regarding the respective sizes of each table.
10621 </p>
10622 <div class="paragraph"><p>By default, the geometric sequence uses a factor of 2, meaning that for any
10623 table, the next-biggest table must at least be twice as big. A maximum factor
10624 of 256 is supported.</p></div>
10625 </dd>
10626 <dt class="hdlist1">
10627 remote.pushDefault
10628 </dt>
10629 <dd>
10630 <p>
10631         The remote to push to by default.  Overrides
10632         <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
10633         <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
10634 </p>
10635 </dd>
10636 <dt class="hdlist1">
10637 remote.&lt;name&gt;.url
10638 </dt>
10639 <dd>
10640 <p>
10641         The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
10642         <a href="git-push.html">git-push(1)</a>. A configured remote can have multiple URLs;
10643         in this case the first is used for fetching, and all are used
10644         for pushing (assuming no <code>remote.&lt;name&gt;.pushurl</code> is defined).
10645         Setting this key to the empty string clears the list of urls,
10646         allowing you to override earlier config.
10647 </p>
10648 </dd>
10649 <dt class="hdlist1">
10650 remote.&lt;name&gt;.pushurl
10651 </dt>
10652 <dd>
10653 <p>
10654         The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
10655         If a <code>pushurl</code> option is present in a configured remote, it
10656         is used for pushing instead of <code>remote.&lt;name&gt;.url</code>. A configured
10657         remote can have multiple push URLs; in this case a push goes to
10658         all of them. Setting this key to the empty string clears the
10659         list of urls, allowing you to override earlier config.
10660 </p>
10661 </dd>
10662 <dt class="hdlist1">
10663 remote.&lt;name&gt;.proxy
10664 </dt>
10665 <dd>
10666 <p>
10667         For remotes that require curl (http, https and ftp), the URL to
10668         the proxy to use for that remote.  Set to the empty string to
10669         disable proxying for that remote.
10670 </p>
10671 </dd>
10672 <dt class="hdlist1">
10673 remote.&lt;name&gt;.proxyAuthMethod
10674 </dt>
10675 <dd>
10676 <p>
10677         For remotes that require curl (http, https and ftp), the method to use for
10678         authenticating against the proxy in use (probably set in
10679         <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
10680 </p>
10681 </dd>
10682 <dt class="hdlist1">
10683 remote.&lt;name&gt;.fetch
10684 </dt>
10685 <dd>
10686 <p>
10687         The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
10688         <a href="git-fetch.html">git-fetch(1)</a>.
10689 </p>
10690 </dd>
10691 <dt class="hdlist1">
10692 remote.&lt;name&gt;.push
10693 </dt>
10694 <dd>
10695 <p>
10696         The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
10697         <a href="git-push.html">git-push(1)</a>.
10698 </p>
10699 </dd>
10700 <dt class="hdlist1">
10701 remote.&lt;name&gt;.mirror
10702 </dt>
10703 <dd>
10704 <p>
10705         If true, pushing to this remote will automatically behave
10706         as if the <code>--mirror</code> option was given on the command line.
10707 </p>
10708 </dd>
10709 <dt class="hdlist1">
10710 remote.&lt;name&gt;.skipDefaultUpdate
10711 </dt>
10712 <dd>
10713 <p>
10714         If true, this remote will be skipped by default when updating
10715         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10716         <a href="git-remote.html">git-remote(1)</a>.
10717 </p>
10718 </dd>
10719 <dt class="hdlist1">
10720 remote.&lt;name&gt;.skipFetchAll
10721 </dt>
10722 <dd>
10723 <p>
10724         If true, this remote will be skipped by default when updating
10725         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10726         <a href="git-remote.html">git-remote(1)</a>.
10727 </p>
10728 </dd>
10729 <dt class="hdlist1">
10730 remote.&lt;name&gt;.receivepack
10731 </dt>
10732 <dd>
10733 <p>
10734         The default program to execute on the remote side when pushing.  See
10735         option --receive-pack of <a href="git-push.html">git-push(1)</a>.
10736 </p>
10737 </dd>
10738 <dt class="hdlist1">
10739 remote.&lt;name&gt;.uploadpack
10740 </dt>
10741 <dd>
10742 <p>
10743         The default program to execute on the remote side when fetching.  See
10744         option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
10745 </p>
10746 </dd>
10747 <dt class="hdlist1">
10748 remote.&lt;name&gt;.tagOpt
10749 </dt>
10750 <dd>
10751 <p>
10752         Setting this value to --no-tags disables automatic tag following when
10753         fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
10754         tag from remote &lt;name&gt;, even if they are not reachable from remote
10755         branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
10756         override this setting. See options --tags and --no-tags of
10757         <a href="git-fetch.html">git-fetch(1)</a>.
10758 </p>
10759 </dd>
10760 <dt class="hdlist1">
10761 remote.&lt;name&gt;.vcs
10762 </dt>
10763 <dd>
10764 <p>
10765         Setting this to a value &lt;vcs&gt; will cause Git to interact with
10766         the remote with the git-remote-&lt;vcs&gt; helper.
10767 </p>
10768 </dd>
10769 <dt class="hdlist1">
10770 remote.&lt;name&gt;.prune
10771 </dt>
10772 <dd>
10773 <p>
10774         When set to true, fetching from this remote by default will also
10775         remove any remote-tracking references that no longer exist on the
10776         remote (as if the <code>--prune</code> option was given on the command line).
10777         Overrides <code>fetch.prune</code> settings, if any.
10778 </p>
10779 </dd>
10780 <dt class="hdlist1">
10781 remote.&lt;name&gt;.pruneTags
10782 </dt>
10783 <dd>
10784 <p>
10785         When set to true, fetching from this remote by default will also
10786         remove any local tags that no longer exist on the remote if pruning
10787         is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
10788         <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10789 </p>
10790 <div class="paragraph"><p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
10791 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
10792 </dd>
10793 <dt class="hdlist1">
10794 remote.&lt;name&gt;.promisor
10795 </dt>
10796 <dd>
10797 <p>
10798         When set to true, this remote will be used to fetch promisor
10799         objects.
10800 </p>
10801 </dd>
10802 <dt class="hdlist1">
10803 remote.&lt;name&gt;.partialclonefilter
10804 </dt>
10805 <dd>
10806 <p>
10807         The filter that will be applied when fetching from this promisor remote.
10808         Changing or clearing this value will only affect fetches for new commits.
10809         To fetch associated objects for commits already present in the local object
10810         database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.
10811 </p>
10812 </dd>
10813 <dt class="hdlist1">
10814 remotes.&lt;group&gt;
10815 </dt>
10816 <dd>
10817 <p>
10818         The list of remotes which are fetched by "git remote update
10819         &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.
10820 </p>
10821 </dd>
10822 <dt class="hdlist1">
10823 repack.useDeltaBaseOffset
10824 </dt>
10825 <dd>
10826 <p>
10827         By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
10828         delta-base offset. If you need to share your repository with
10829         Git older than version 1.4.4, either directly or via a dumb
10830         protocol such as http, then you need to set this option to
10831         "false" and repack. Access from old Git versions over the
10832         native protocol are unaffected by this option.
10833 </p>
10834 </dd>
10835 <dt class="hdlist1">
10836 repack.packKeptObjects
10837 </dt>
10838 <dd>
10839 <p>
10840         If set to true, makes <code>git repack</code> act as if
10841         <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
10842         details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10843         index is being written (either via <code>--write-bitmap-index</code> or
10844         <code>repack.writeBitmaps</code>).
10845 </p>
10846 </dd>
10847 <dt class="hdlist1">
10848 repack.useDeltaIslands
10849 </dt>
10850 <dd>
10851 <p>
10852         If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10853         was passed. Defaults to <code>false</code>.
10854 </p>
10855 </dd>
10856 <dt class="hdlist1">
10857 repack.writeBitmaps
10858 </dt>
10859 <dd>
10860 <p>
10861         When true, git will write a bitmap index when packing all
10862         objects to disk (e.g., when <code>git repack -a</code> is run).  This
10863         index can speed up the "counting objects" phase of subsequent
10864         packs created for clones and fetches, at the cost of some disk
10865         space and extra time spent on the initial repack.  This has
10866         no effect if multiple packfiles are created.
10867         Defaults to true on bare repos, false otherwise.
10868 </p>
10869 </dd>
10870 <dt class="hdlist1">
10871 repack.updateServerInfo
10872 </dt>
10873 <dd>
10874 <p>
10875         If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
10876         <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10877         when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.
10878 </p>
10879 </dd>
10880 <dt class="hdlist1">
10881 repack.cruftWindow
10882 </dt>
10883 <dt class="hdlist1">
10884 repack.cruftWindowMemory
10885 </dt>
10886 <dt class="hdlist1">
10887 repack.cruftDepth
10888 </dt>
10889 <dt class="hdlist1">
10890 repack.cruftThreads
10891 </dt>
10892 <dd>
10893 <p>
10894         Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
10895         a cruft pack and the respective parameters are not given over
10896         the command line. See similarly named <code>pack.*</code> configuration
10897         variables for defaults and meaning.
10898 </p>
10899 </dd>
10900 <dt class="hdlist1">
10901 rerere.autoUpdate
10902 </dt>
10903 <dd>
10904 <p>
10905         When set to true, <code>git-rerere</code> updates the index with the
10906         resulting contents after it cleanly resolves conflicts using
10907         previously recorded resolutions.  Defaults to false.
10908 </p>
10909 </dd>
10910 <dt class="hdlist1">
10911 rerere.enabled
10912 </dt>
10913 <dd>
10914 <p>
10915         Activate recording of resolved conflicts, so that identical
10916         conflict hunks can be resolved automatically, should they be
10917         encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
10918         enabled if there is an <code>rr-cache</code> directory under the
10919         <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
10920         repository.
10921 </p>
10922 </dd>
10923 <dt class="hdlist1">
10924 revert.reference
10925 </dt>
10926 <dd>
10927 <p>
10928         Setting this variable to true makes <code>git revert</code> behave
10929         as if the <code>--reference</code> option is given.
10930 </p>
10931 </dd>
10932 <dt class="hdlist1">
10933 safe.bareRepository
10934 </dt>
10935 <dd>
10936 <p>
10937         Specifies which bare repositories Git will work with. The currently
10938         supported values are:
10939 </p>
10940 <div class="ulist"><ul>
10941 <li>
10942 <p>
10943 <code>all</code>: Git works with all bare repositories. This is the default.
10944 </p>
10945 </li>
10946 <li>
10947 <p>
10948 <code>explicit</code>: Git only works with bare repositories specified via
10949   the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10950   environment variable (see <a href="git.html">git(1)</a>).
10951 </p>
10952 <div class="paragraph"><p>If you do not use bare repositories in your workflow, then it may be
10953 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10954 config. This will protect you from attacks that involve cloning a
10955 repository that contains a bare repository and running a Git command
10956 within that directory.</p></div>
10957 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10958 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with
10959 this value.</p></div>
10960 </li>
10961 </ul></div>
10962 </dd>
10963 <dt class="hdlist1">
10964 safe.directory
10965 </dt>
10966 <dd>
10967 <p>
10968         These config entries specify Git-tracked directories that are
10969         considered safe even if they are owned by someone other than the
10970         current user. By default, Git will refuse to even parse a Git
10971         config of a repository owned by someone else, let alone run its
10972         hooks, and this config setting allows users to specify exceptions,
10973         e.g. for intentionally shared repositories (see the <code>--shared</code>
10974         option in <a href="git-init.html">git-init(1)</a>).
10975 </p>
10976 <div class="paragraph"><p>This is a multi-valued setting, i.e. you can add more than one directory
10977 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10978 override any such directories specified in the system config), add a
10979 <code>safe.directory</code> entry with an empty value.</p></div>
10980 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10981 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with this
10982 value.</p></div>
10983 <div class="paragraph"><p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
10984 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
10985 path relative to Git&#8217;s (runtime) prefix.</p></div>
10986 <div class="paragraph"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10987 string <code>*</code>. This will allow all repositories to be treated as if their
10988 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10989 is set in system config and you want to re-enable this protection, then
10990 initialize your list with an empty value before listing the repositories
10991 that you deem safe.  Giving a directory with <code>/*</code> appended to it will
10992 allow access to all repositories under the named directory.</p></div>
10993 <div class="paragraph"><p>As explained, Git only allows you to access repositories owned by
10994 yourself, i.e. the user who is running Git, by default.  When Git
10995 is running as <em>root</em> in a non Windows platform that provides sudo,
10996 however, git checks the SUDO_UID environment variable that sudo creates
10997 and will allow access to the uid recorded as its value in addition to
10998 the id from <em>root</em>.
10999 This is to make it easy to perform a common sequence during installation
11000 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
11001 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
11002 which id the original user has.
11003 If that is not what you would prefer and want git to only trust
11004 repositories that are owned by root instead, then you can remove
11005 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p></div>
11006 </dd>
11007 <dt class="hdlist1">
11008 sendemail.identity
11009 </dt>
11010 <dd>
11011 <p>
11012         A configuration identity. When given, causes values in the
11013         <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
11014         values in the <em>sendemail</em> section. The default identity is
11015         the value of <code>sendemail.identity</code>.
11016 </p>
11017 </dd>
11018 <dt class="hdlist1">
11019 sendemail.smtpEncryption
11020 </dt>
11021 <dd>
11022 <p>
11023         See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
11024         setting is not subject to the <em>identity</em> mechanism.
11025 </p>
11026 </dd>
11027 <dt class="hdlist1">
11028 sendemail.smtpSSLCertPath
11029 </dt>
11030 <dd>
11031 <p>
11032         Path to ca-certificates (either a directory or a single file).
11033         Set it to an empty string to disable certificate verification.
11034 </p>
11035 </dd>
11036 <dt class="hdlist1">
11037 sendemail.&lt;identity&gt;.*
11038 </dt>
11039 <dd>
11040 <p>
11041         Identity-specific versions of the <em>sendemail.*</em> parameters
11042         found below, taking precedence over those when this
11043         identity is selected, through either the command-line or
11044         <code>sendemail.identity</code>.
11045 </p>
11046 </dd>
11047 <dt class="hdlist1">
11048 sendemail.multiEdit
11049 </dt>
11050 <dd>
11051 <p>
11052         If true (default), a single editor instance will be spawned to edit
11053         files you have to edit (patches when <code>--annotate</code> is used, and the
11054         summary when <code>--compose</code> is used). If false, files will be edited one
11055         after the other, spawning a new editor each time.
11056 </p>
11057 </dd>
11058 <dt class="hdlist1">
11059 sendemail.confirm
11060 </dt>
11061 <dd>
11062 <p>
11063         Sets the default for whether to confirm before sending. Must be
11064         one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
11065         in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
11066         values.
11067 </p>
11068 </dd>
11069 <dt class="hdlist1">
11070 sendemail.aliasesFile
11071 </dt>
11072 <dd>
11073 <p>
11074         To avoid typing long email addresses, point this to one or more
11075         email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.
11076 </p>
11077 </dd>
11078 <dt class="hdlist1">
11079 sendemail.aliasFileType
11080 </dt>
11081 <dd>
11082 <p>
11083         Format of the file(s) specified in sendemail.aliasesFile. Must be
11084         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.
11085 </p>
11086 <div class="paragraph"><p>What an alias file in each format looks like can be found in
11087 the documentation of the email program of the same name. The
11088 differences and limitations from the standard formats are
11089 described below:</p></div>
11090 <div class="openblock">
11091 <div class="content">
11092 <div class="dlist"><dl>
11093 <dt class="hdlist1">
11094 sendmail
11095 </dt>
11096 <dd>
11097 <div class="ulist"><ul>
11098 <li>
11099 <p>
11100 Quoted aliases and quoted addresses are not supported: lines that
11101         contain a <code>"</code> symbol are ignored.
11102 </p>
11103 </li>
11104 <li>
11105 <p>
11106 Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
11107         supported.
11108 </p>
11109 </li>
11110 <li>
11111 <p>
11112 File inclusion (<code>:include: /path/name</code>) is not supported.
11113 </p>
11114 </li>
11115 <li>
11116 <p>
11117 Warnings are printed on the standard error output for any
11118         explicitly unsupported constructs, and any other lines that are not
11119         recognized by the parser.
11120 </p>
11121 </li>
11122 </ul></div>
11123 </dd>
11124 </dl></div>
11125 </div></div>
11126 </dd>
11127 <dt class="hdlist1">
11128 sendemail.annotate
11129 </dt>
11130 <dt class="hdlist1">
11131 sendemail.bcc
11132 </dt>
11133 <dt class="hdlist1">
11134 sendemail.cc
11135 </dt>
11136 <dt class="hdlist1">
11137 sendemail.ccCmd
11138 </dt>
11139 <dt class="hdlist1">
11140 sendemail.chainReplyTo
11141 </dt>
11142 <dt class="hdlist1">
11143 sendemail.envelopeSender
11144 </dt>
11145 <dt class="hdlist1">
11146 sendemail.from
11147 </dt>
11148 <dt class="hdlist1">
11149 sendemail.headerCmd
11150 </dt>
11151 <dt class="hdlist1">
11152 sendemail.signedOffByCc
11153 </dt>
11154 <dt class="hdlist1">
11155 sendemail.smtpPass
11156 </dt>
11157 <dt class="hdlist1">
11158 sendemail.suppressCc
11159 </dt>
11160 <dt class="hdlist1">
11161 sendemail.suppressFrom
11162 </dt>
11163 <dt class="hdlist1">
11164 sendemail.to
11165 </dt>
11166 <dt class="hdlist1">
11167 sendemail.toCmd
11168 </dt>
11169 <dt class="hdlist1">
11170 sendemail.smtpDomain
11171 </dt>
11172 <dt class="hdlist1">
11173 sendemail.smtpServer
11174 </dt>
11175 <dt class="hdlist1">
11176 sendemail.smtpServerPort
11177 </dt>
11178 <dt class="hdlist1">
11179 sendemail.smtpServerOption
11180 </dt>
11181 <dt class="hdlist1">
11182 sendemail.smtpUser
11183 </dt>
11184 <dt class="hdlist1">
11185 sendemail.thread
11186 </dt>
11187 <dt class="hdlist1">
11188 sendemail.transferEncoding
11189 </dt>
11190 <dt class="hdlist1">
11191 sendemail.validate
11192 </dt>
11193 <dt class="hdlist1">
11194 sendemail.xmailer
11195 </dt>
11196 <dd>
11197 <p>
11198         These configuration variables all provide a default for
11199         <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
11200         documentation for details.
11201 </p>
11202 </dd>
11203 <dt class="hdlist1">
11204 sendemail.signedOffCc (deprecated)
11205 </dt>
11206 <dd>
11207 <p>
11208         Deprecated alias for <code>sendemail.signedOffByCc</code>.
11209 </p>
11210 </dd>
11211 <dt class="hdlist1">
11212 sendemail.smtpBatchSize
11213 </dt>
11214 <dd>
11215 <p>
11216         Number of messages to be sent per connection, after that a relogin
11217         will happen.  If the value is 0 or undefined, send all messages in
11218         one connection.
11219         See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
11220 </p>
11221 </dd>
11222 <dt class="hdlist1">
11223 sendemail.smtpReloginDelay
11224 </dt>
11225 <dd>
11226 <p>
11227         Seconds to wait before reconnecting to the smtp server.
11228         See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
11229 </p>
11230 </dd>
11231 <dt class="hdlist1">
11232 sendemail.forbidSendmailVariables
11233 </dt>
11234 <dd>
11235 <p>
11236         To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
11237         will abort with a warning if any configuration options for "sendmail"
11238         exist. Set this variable to bypass the check.
11239 </p>
11240 </dd>
11241 <dt class="hdlist1">
11242 sequence.editor
11243 </dt>
11244 <dd>
11245 <p>
11246         Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
11247         The value is meant to be interpreted by the shell when it is used.
11248         It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
11249         When not configured, the default commit message editor is used instead.
11250 </p>
11251 </dd>
11252 <dt class="hdlist1">
11253 showBranch.default
11254 </dt>
11255 <dd>
11256 <p>
11257         The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
11258         See <a href="git-show-branch.html">git-show-branch(1)</a>.
11259 </p>
11260 </dd>
11261 <dt class="hdlist1">
11262 sparse.expectFilesOutsideOfPatterns
11263 </dt>
11264 <dd>
11265 <p>
11266         Typically with sparse checkouts, files not matching any
11267         sparsity patterns are marked with a SKIP_WORKTREE bit in the
11268         index and are missing from the working tree.  Accordingly, Git
11269         will ordinarily check whether files with the SKIP_WORKTREE bit
11270         are in fact present in the working tree contrary to
11271         expectations.  If Git finds any, it marks those paths as
11272         present by clearing the relevant SKIP_WORKTREE bits.  This
11273         option can be used to tell Git that such
11274         present-despite-skipped files are expected and to stop
11275         checking for them.
11276 </p>
11277 <div class="paragraph"><p>The default is <code>false</code>, which allows Git to automatically recover
11278 from the list of files in the index and working tree falling out of
11279 sync.</p></div>
11280 <div class="paragraph"><p>Set this to <code>true</code> if you are in a setup where some external factor
11281 relieves Git of the responsibility for maintaining the consistency
11282 between the presence of working tree files and sparsity patterns.  For
11283 example, if you have a Git-aware virtual file system that has a robust
11284 mechanism for keeping the working tree and the sparsity patterns up to
11285 date based on access patterns.</p></div>
11286 <div class="paragraph"><p>Regardless of this setting, Git does not check for
11287 present-despite-skipped files unless sparse checkout is enabled, so
11288 this config option has no effect unless <code>core.sparseCheckout</code> is
11289 <code>true</code>.</p></div>
11290 </dd>
11291 <dt class="hdlist1">
11292 splitIndex.maxPercentChange
11293 </dt>
11294 <dd>
11295 <p>
11296         When the split index feature is used, this specifies the
11297         percent of entries the split index can contain compared to the
11298         total number of entries in both the split index and the shared
11299         index before a new shared index is written.
11300         The value should be between 0 and 100. If the value is 0, then
11301         a new shared index is always written; if it is 100, a new
11302         shared index is never written.
11303         By default, the value is 20, so a new shared index is written
11304         if the number of entries in the split index would be greater
11305         than 20 percent of the total number of entries.
11306         See <a href="git-update-index.html">git-update-index(1)</a>.
11307 </p>
11308 </dd>
11309 <dt class="hdlist1">
11310 splitIndex.sharedIndexExpire
11311 </dt>
11312 <dd>
11313 <p>
11314         When the split index feature is used, shared index files that
11315         were not modified since the time this variable specifies will
11316         be removed when a new shared index file is created. The value
11317         "now" expires all entries immediately, and "never" suppresses
11318         expiration altogether.
11319         The default value is "2.weeks.ago".
11320         Note that a shared index file is considered modified (for the
11321         purpose of expiration) each time a new split-index file is
11322         either created based on it or read from it.
11323         See <a href="git-update-index.html">git-update-index(1)</a>.
11324 </p>
11325 </dd>
11326 <dt class="hdlist1">
11327 ssh.variant
11328 </dt>
11329 <dd>
11330 <p>
11331         By default, Git determines the command line arguments to use
11332         based on the basename of the configured SSH command (configured
11333         using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
11334         the config setting <code>core.sshCommand</code>). If the basename is
11335         unrecognized, Git will attempt to detect support of OpenSSH
11336         options by first invoking the configured SSH command with the
11337         <code>-G</code> (print configuration) option and will subsequently use
11338         OpenSSH options (if that is successful) or no options besides
11339         the host and remote command (if it fails).
11340 </p>
11341 <div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this detection.
11342 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
11343 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
11344 The default auto-detection can be explicitly requested using the value
11345 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
11346 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
11347 <div class="paragraph"><p>The current command-line parameters used for each variant are as
11348 follows:</p></div>
11349 <div class="openblock">
11350 <div class="content">
11351 <div class="ulist"><ul>
11352 <li>
11353 <p>
11354 <code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command
11355 </p>
11356 </li>
11357 <li>
11358 <p>
11359 <code>simple</code> - [username@]host command
11360 </p>
11361 </li>
11362 <li>
11363 <p>
11364 <code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command
11365 </p>
11366 </li>
11367 <li>
11368 <p>
11369 <code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command
11370 </p>
11371 </li>
11372 </ul></div>
11373 </div></div>
11374 <div class="paragraph"><p>Except for the <code>simple</code> variant, command-line parameters are likely to
11375 change as git gains new features.</p></div>
11376 </dd>
11377 <dt class="hdlist1">
11378 stash.showIncludeUntracked
11379 </dt>
11380 <dd>
11381 <p>
11382         If this is set to true, the <code>git stash show</code> command will show
11383         the untracked files of a stash entry.  Defaults to false. See
11384         the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11385 </p>
11386 </dd>
11387 <dt class="hdlist1">
11388 stash.showPatch
11389 </dt>
11390 <dd>
11391 <p>
11392         If this is set to true, the <code>git stash show</code> command without an
11393         option will show the stash entry in patch form.  Defaults to false.
11394         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11395 </p>
11396 </dd>
11397 <dt class="hdlist1">
11398 stash.showStat
11399 </dt>
11400 <dd>
11401 <p>
11402         If this is set to true, the <code>git stash show</code> command without an
11403         option will show a diffstat of the stash entry.  Defaults to true.
11404         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11405 </p>
11406 </dd>
11407 <dt class="hdlist1">
11408 status.relativePaths
11409 </dt>
11410 <dd>
11411 <p>
11412         By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
11413         current directory. Setting this variable to <code>false</code> shows paths
11414         relative to the repository root (this was the default for Git
11415         prior to v1.5.4).
11416 </p>
11417 </dd>
11418 <dt class="hdlist1">
11419 status.short
11420 </dt>
11421 <dd>
11422 <p>
11423         Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
11424         The option --no-short takes precedence over this variable.
11425 </p>
11426 </dd>
11427 <dt class="hdlist1">
11428 status.branch
11429 </dt>
11430 <dd>
11431 <p>
11432         Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
11433         The option --no-branch takes precedence over this variable.
11434 </p>
11435 </dd>
11436 <dt class="hdlist1">
11437 status.aheadBehind
11438 </dt>
11439 <dd>
11440 <p>
11441         Set to true to enable <code>--ahead-behind</code> and false to enable
11442         <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
11443         non-porcelain status formats.  Defaults to true.
11444 </p>
11445 </dd>
11446 <dt class="hdlist1">
11447 status.displayCommentPrefix
11448 </dt>
11449 <dd>
11450 <p>
11451         If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
11452         prefix before each output line (starting with
11453         <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
11454         behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
11455         Defaults to false.
11456 </p>
11457 </dd>
11458 <dt class="hdlist1">
11459 status.renameLimit
11460 </dt>
11461 <dd>
11462 <p>
11463         The number of files to consider when performing rename detection
11464         in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
11465         the value of diff.renameLimit.
11466 </p>
11467 </dd>
11468 <dt class="hdlist1">
11469 status.renames
11470 </dt>
11471 <dd>
11472 <p>
11473         Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
11474         <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
11475         disabled. If set to "true", basic rename detection is enabled.
11476         If set to "copies" or "copy", Git will detect copies, as well.
11477         Defaults to the value of diff.renames.
11478 </p>
11479 </dd>
11480 <dt class="hdlist1">
11481 status.showStash
11482 </dt>
11483 <dd>
11484 <p>
11485         If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
11486         entries currently stashed away.
11487         Defaults to false.
11488 </p>
11489 </dd>
11490 <dt class="hdlist1">
11491 status.showUntrackedFiles
11492 </dt>
11493 <dd>
11494 <p>
11495         By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
11496         files which are not currently tracked by Git. Directories which
11497         contain only untracked files, are shown with the directory name
11498         only. Showing untracked files means that Git needs to lstat() all
11499         the files in the whole repository, which might be slow on some
11500         systems. So, this variable controls how the commands display
11501         the untracked files. Possible values are:
11502 </p>
11503 <div class="openblock">
11504 <div class="content">
11505 <div class="ulist"><ul>
11506 <li>
11507 <p>
11508 <code>no</code> - Show no untracked files.
11509 </p>
11510 </li>
11511 <li>
11512 <p>
11513 <code>normal</code> - Show untracked files and directories.
11514 </p>
11515 </li>
11516 <li>
11517 <p>
11518 <code>all</code> - Show also individual files in untracked directories.
11519 </p>
11520 </li>
11521 </ul></div>
11522 </div></div>
11523 <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
11524 All usual spellings for Boolean value <code>true</code> are taken as <code>normal</code>
11525 and <code>false</code> as <code>no</code>.
11526 This variable can be overridden with the -u|--untracked-files option
11527 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
11528 </dd>
11529 <dt class="hdlist1">
11530 status.submoduleSummary
11531 </dt>
11532 <dd>
11533 <p>
11534         Defaults to false.
11535         If this is set to a non-zero number or true (identical to -1 or an
11536         unlimited number), the submodule summary will be enabled and a
11537         summary of commits for modified submodules will be shown (see
11538         --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
11539         that the summary output command will be suppressed for all
11540         submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
11541         for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
11542         exception to that rule is that status and commit will show staged
11543         submodule changes. To
11544         also view the summary for ignored submodules you can either use
11545         the --ignore-submodules=dirty command-line option or the <em>git
11546         submodule summary</em> command, which shows a similar output but does
11547         not honor these settings.
11548 </p>
11549 </dd>
11550 <dt class="hdlist1">
11551 submodule.&lt;name&gt;.url
11552 </dt>
11553 <dd>
11554 <p>
11555         The URL for a submodule. This variable is copied from the .gitmodules
11556         file to the git config via <em>git submodule init</em>. The user can change
11557         the configured URL before obtaining the submodule via <em>git submodule
11558         update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
11559         set, the presence of this variable is used as a fallback to indicate
11560         whether the submodule is of interest to git commands.
11561         See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
11562 </p>
11563 </dd>
11564 <dt class="hdlist1">
11565 submodule.&lt;name&gt;.update
11566 </dt>
11567 <dd>
11568 <p>
11569         The method by which a submodule is updated by <em>git submodule update</em>,
11570         which is the only affected command, others such as
11571         <em>git checkout --recurse-submodules</em> are unaffected. It exists for
11572         historical reasons, when <em>git submodule</em> was the only command to
11573         interact with submodules; settings like <code>submodule.active</code>
11574         and <code>pull.rebase</code> are more specific. It is populated by
11575         <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
11576         See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.
11577 </p>
11578 </dd>
11579 <dt class="hdlist1">
11580 submodule.&lt;name&gt;.branch
11581 </dt>
11582 <dd>
11583 <p>
11584         The remote branch name for a submodule, used by <code>git submodule
11585         update --remote</code>.  Set this option to override the value found in
11586         the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
11587         <a href="gitmodules.html">gitmodules(5)</a> for details.
11588 </p>
11589 </dd>
11590 <dt class="hdlist1">
11591 submodule.&lt;name&gt;.fetchRecurseSubmodules
11592 </dt>
11593 <dd>
11594 <p>
11595         This option can be used to control recursive fetching of this
11596         submodule. It can be overridden by using the --[no-]recurse-submodules
11597         command-line option to "git fetch" and "git pull".
11598         This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
11599         file.
11600 </p>
11601 </dd>
11602 <dt class="hdlist1">
11603 submodule.&lt;name&gt;.ignore
11604 </dt>
11605 <dd>
11606 <p>
11607         Defines under what circumstances "git status" and the diff family show
11608         a submodule as modified. When set to "all", it will never be considered
11609         modified (but it will nonetheless show up in the output of status and
11610         commit when it has been staged), "dirty" will ignore all changes
11611         to the submodule&#8217;s work tree and
11612         takes only differences between the HEAD of the submodule and the commit
11613         recorded in the superproject into account. "untracked" will additionally
11614         let submodules with modified tracked files in their work tree show up.
11615         Using "none" (the default when this option is not set) also shows
11616         submodules that have untracked files in their work tree as changed.
11617         This setting overrides any setting made in .gitmodules for this submodule,
11618         both settings can be overridden on the command line by using the
11619         "--ignore-submodules" option. The <em>git submodule</em> commands are not
11620         affected by this setting.
11621 </p>
11622 </dd>
11623 <dt class="hdlist1">
11624 submodule.&lt;name&gt;.active
11625 </dt>
11626 <dd>
11627 <p>
11628         Boolean value indicating if the submodule is of interest to git
11629         commands.  This config option takes precedence over the
11630         submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
11631         details.
11632 </p>
11633 </dd>
11634 <dt class="hdlist1">
11635 submodule.active
11636 </dt>
11637 <dd>
11638 <p>
11639         A repeated field which contains a pathspec used to match against a
11640         submodule&#8217;s path to determine if the submodule is of interest to git
11641         commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.
11642 </p>
11643 </dd>
11644 <dt class="hdlist1">
11645 submodule.recurse
11646 </dt>
11647 <dd>
11648 <p>
11649         A boolean indicating if commands should enable the <code>--recurse-submodules</code>
11650         option by default. Defaults to false.
11651 </p>
11652 <div class="paragraph"><p>When set to true, it can be deactivated via the
11653 <code>--no-recurse-submodules</code> option. Note that some Git commands
11654 lacking this option may call some of the above commands affected by
11655 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
11656 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
11657 For these commands a workaround is to temporarily change the
11658 configuration value by using <code>git -c submodule.recurse=0</code>.</p></div>
11659 <div class="paragraph"><p>The following list shows the commands that accept
11660 <code>--recurse-submodules</code> and whether they are supported by this
11661 setting.</p></div>
11662 <div class="ulist"><ul>
11663 <li>
11664 <p>
11665 <code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
11666 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.
11667 </p>
11668 </li>
11669 <li>
11670 <p>
11671 <code>clone</code> and <code>ls-files</code> are not supported.
11672 </p>
11673 </li>
11674 <li>
11675 <p>
11676 <code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
11677 enabled
11678 </p>
11679 </li>
11680 </ul></div>
11681 </dd>
11682 <dt class="hdlist1">
11683 submodule.propagateBranches
11684 </dt>
11685 <dd>
11686 <p>
11687         [EXPERIMENTAL] A boolean that enables branching support when
11688         using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
11689         Enabling this will allow certain commands to accept
11690         <code>--recurse-submodules</code> and certain commands that already accept
11691         <code>--recurse-submodules</code> will now consider branches.
11692         Defaults to false.
11693 </p>
11694 </dd>
11695 <dt class="hdlist1">
11696 submodule.fetchJobs
11697 </dt>
11698 <dd>
11699 <p>
11700         Specifies how many submodules are fetched/cloned at the same time.
11701         A positive integer allows up to that number of submodules fetched
11702         in parallel. A value of 0 will give some reasonable default.
11703         If unset, it defaults to 1.
11704 </p>
11705 </dd>
11706 <dt class="hdlist1">
11707 submodule.alternateLocation
11708 </dt>
11709 <dd>
11710 <p>
11711         Specifies how the submodules obtain alternates when submodules are
11712         cloned. Possible values are <code>no</code>, <code>superproject</code>.
11713         By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
11714         value is set to <code>superproject</code> the submodule to be cloned computes
11715         its alternates location relative to the superprojects alternate.
11716 </p>
11717 </dd>
11718 <dt class="hdlist1">
11719 submodule.alternateErrorStrategy
11720 </dt>
11721 <dd>
11722 <p>
11723         Specifies how to treat errors with the alternates for a submodule
11724         as computed via <code>submodule.alternateLocation</code>. Possible values are
11725         <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
11726         or <code>info</code>, and if there is an error with the computed alternate, the
11727         clone proceeds as if no alternate was specified.
11728 </p>
11729 </dd>
11730 <dt class="hdlist1">
11731 tag.forceSignAnnotated
11732 </dt>
11733 <dd>
11734 <p>
11735         A boolean to specify whether annotated tags created should be GPG signed.
11736         If <code>--annotate</code> is specified on the command line, it takes
11737         precedence over this option.
11738 </p>
11739 </dd>
11740 <dt class="hdlist1">
11741 tag.sort
11742 </dt>
11743 <dd>
11744 <p>
11745         This variable controls the sort ordering of tags when displayed by
11746         <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
11747         value of this variable will be used as the default.
11748 </p>
11749 </dd>
11750 <dt class="hdlist1">
11751 tag.gpgSign
11752 </dt>
11753 <dd>
11754 <p>
11755         A boolean to specify whether all tags should be GPG signed.
11756         Use of this option when running in an automated script can
11757         result in a large number of tags being signed. It is therefore
11758         convenient to use an agent to avoid typing your gpg passphrase
11759         several times. Note that this option doesn&#8217;t affect tag signing
11760         behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.
11761 </p>
11762 </dd>
11763 <dt class="hdlist1">
11764 tar.umask
11765 </dt>
11766 <dd>
11767 <p>
11768         This variable can be used to restrict the permission bits of
11769         tar archive entries.  The default is 0002, which turns off the
11770         world write bit.  The special value "user" indicates that the
11771         archiving user&#8217;s umask will be used instead.  See umask(2) and
11772         <a href="git-archive.html">git-archive(1)</a>.
11773 </p>
11774 </dd>
11775 </dl></div>
11776 <div class="paragraph"><p>Trace2 config settings are only read from the system and global
11777 config files; repository local and worktree config files and <code>-c</code>
11778 command line arguments are not respected.</p></div>
11779 <div class="dlist"><dl>
11780 <dt class="hdlist1">
11781 trace2.normalTarget
11782 </dt>
11783 <dd>
11784 <p>
11785         This variable controls the normal target destination.
11786         It may be overridden by the <code>GIT_TRACE2</code> environment variable.
11787         The following table shows possible values.
11788 </p>
11789 </dd>
11790 <dt class="hdlist1">
11791 trace2.perfTarget
11792 </dt>
11793 <dd>
11794 <p>
11795         This variable controls the performance target destination.
11796         It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
11797         The following table shows possible values.
11798 </p>
11799 </dd>
11800 <dt class="hdlist1">
11801 trace2.eventTarget
11802 </dt>
11803 <dd>
11804 <p>
11805         This variable controls the event target destination.
11806         It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
11807         The following table shows possible values.
11808 </p>
11809 <div class="openblock">
11810 <div class="content">
11811 <div class="ulist"><ul>
11812 <li>
11813 <p>
11814 <code>0</code> or <code>false</code> - Disables the target.
11815 </p>
11816 </li>
11817 <li>
11818 <p>
11819 <code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.
11820 </p>
11821 </li>
11822 <li>
11823 <p>
11824 <code>[2-9]</code> - Writes to the already opened file descriptor.
11825 </p>
11826 </li>
11827 <li>
11828 <p>
11829 <code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
11830 already exists and is a directory, the traces will be written to files (one
11831 per process) underneath the given directory.
11832 </p>
11833 </li>
11834 <li>
11835 <p>
11836 <code>af_unix:[&lt;socket-type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
11837 Unix DomainSocket (on platforms that support them).  Socket
11838 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
11839 try both.
11840 </p>
11841 </li>
11842 </ul></div>
11843 </div></div>
11844 </dd>
11845 <dt class="hdlist1">
11846 trace2.normalBrief
11847 </dt>
11848 <dd>
11849 <p>
11850         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11851         omitted from normal output.  May be overridden by the
11852         <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.
11853 </p>
11854 </dd>
11855 <dt class="hdlist1">
11856 trace2.perfBrief
11857 </dt>
11858 <dd>
11859 <p>
11860         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11861         omitted from PERF output.  May be overridden by the
11862         <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.
11863 </p>
11864 </dd>
11865 <dt class="hdlist1">
11866 trace2.eventBrief
11867 </dt>
11868 <dd>
11869 <p>
11870         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11871         omitted from event output.  May be overridden by the
11872         <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.
11873 </p>
11874 </dd>
11875 <dt class="hdlist1">
11876 trace2.eventNesting
11877 </dt>
11878 <dd>
11879 <p>
11880         Integer.  Specifies desired depth of nested regions in the
11881         event output.  Regions deeper than this value will be
11882         omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
11883         environment variable.  Defaults to 2.
11884 </p>
11885 </dd>
11886 <dt class="hdlist1">
11887 trace2.configParams
11888 </dt>
11889 <dd>
11890 <p>
11891         A comma-separated list of patterns of "important" config
11892         settings that should be recorded in the trace2 output.
11893         For example, <code>core.*,remote.*.url</code> would cause the trace2
11894         output to contain events listing each configured remote.
11895         May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
11896         variable.  Unset by default.
11897 </p>
11898 </dd>
11899 <dt class="hdlist1">
11900 trace2.envVars
11901 </dt>
11902 <dd>
11903 <p>
11904         A comma-separated list of "important" environment variables that should
11905         be recorded in the trace2 output.  For example,
11906         <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
11907         contain events listing the overrides for HTTP user agent and the
11908         location of the Git configuration file (assuming any are set).  May be
11909         overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
11910         default.
11911 </p>
11912 </dd>
11913 <dt class="hdlist1">
11914 trace2.destinationDebug
11915 </dt>
11916 <dd>
11917 <p>
11918         Boolean.  When true Git will print error messages when a
11919         trace target destination cannot be opened for writing.
11920         By default, these errors are suppressed and tracing is
11921         silently disabled.  May be overridden by the
11922         <code>GIT_TRACE2_DST_DEBUG</code> environment variable.
11923 </p>
11924 </dd>
11925 <dt class="hdlist1">
11926 trace2.maxFiles
11927 </dt>
11928 <dd>
11929 <p>
11930         Integer.  When writing trace files to a target directory, do not
11931         write additional traces if doing so would exceed this many files. Instead,
11932         write a sentinel file that will block further tracing to this
11933         directory. Defaults to 0, which disables this check.
11934 </p>
11935 </dd>
11936 <dt class="hdlist1">
11937 transfer.credentialsInUrl
11938 </dt>
11939 <dd>
11940 <p>
11941         A configured URL can contain plaintext credentials in the form
11942         <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
11943         to warn or forbid the use of such configuration (in favor of
11944         using <a href="git-credential.html">git-credential(1)</a>). This will be used on
11945         <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>,
11946         and any other direct use of the configured URL.
11947 </p>
11948 <div class="paragraph"><p>Note that this is currently limited to detecting credentials in
11949 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
11950 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p></div>
11951 <div class="paragraph"><p>You might want to enable this to prevent inadvertent credentials
11952 exposure, e.g. because:</p></div>
11953 <div class="ulist"><ul>
11954 <li>
11955 <p>
11956 The OS or system where you&#8217;re running git may not provide a way or
11957   otherwise allow you to configure the permissions of the
11958   configuration file where the username and/or password are stored.
11959 </p>
11960 </li>
11961 <li>
11962 <p>
11963 Even if it does, having such data stored "at rest" might expose you
11964   in other ways, e.g. a backup process might copy the data to another
11965   system.
11966 </p>
11967 </li>
11968 <li>
11969 <p>
11970 The git programs will pass the full URL to one another as arguments
11971   on the command-line, meaning the credentials will be exposed to other
11972   unprivileged users on systems that allow them to see the full
11973   process list of other users. On linux the "hidepid" setting
11974   documented in procfs(5) allows for configuring this behavior.
11975 </p>
11976 <div class="paragraph"><p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
11977 concerned about credentials exposure due to storing sensitive
11978 data in git&#8217;s configuration files. If you do want to use this, set
11979 <code>transfer.credentialsInUrl</code> to one of these values:</p></div>
11980 </li>
11981 <li>
11982 <p>
11983 <code>allow</code> (default): Git will proceed with its activity without warning.
11984 </p>
11985 </li>
11986 <li>
11987 <p>
11988 <code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
11989   with a plaintext credential.
11990 </p>
11991 </li>
11992 <li>
11993 <p>
11994 <code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
11995   with a plaintext credential.
11996 </p>
11997 </li>
11998 </ul></div>
11999 </dd>
12000 <dt class="hdlist1">
12001 transfer.fsckObjects
12002 </dt>
12003 <dd>
12004 <p>
12005         When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
12006         not set, the value of this variable is used instead.
12007         Defaults to false.
12008 </p>
12009 <div class="paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
12010 object or a link to a nonexistent object. In addition, various other
12011 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
12012 and potential security issues like the existence of a <code>.GIT</code> directory
12013 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
12014 and v2.17.1 for details). Other sanity and security checks may be
12015 added in future releases.</p></div>
12016 <div class="paragraph"><p>On the receiving side, failing fsckObjects will make those objects
12017 unreachable, see "QUARANTINE ENVIRONMENT" in
12018 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
12019 instead be left unreferenced in the repository.</p></div>
12020 <div class="paragraph"><p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
12021 implementation it cannot be relied upon to leave the object store
12022 clean like <code>receive.fsckObjects</code> can.</p></div>
12023 <div class="paragraph"><p>As objects are unpacked they&#8217;re written to the object store, so there
12024 can be cases where malicious objects get introduced even though the
12025 "fetch" failed, only to have a subsequent "fetch" succeed because only
12026 new incoming objects are checked, not those that have already been
12027 written to the object store. That difference in behavior should not be
12028 relied upon. In the future, such objects may be quarantined for
12029 "fetch" as well.</p></div>
12030 <div class="paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
12031 environment if they&#8217;d like the same protection as "push". E.g. in the
12032 case of an internal mirror do the mirroring in two steps, one to fetch
12033 the untrusted objects, and then do a second "push" (which will use the
12034 quarantine) to another internal repo, and have internal clients
12035 consume this pushed-to repository, or embargo internal fetches and
12036 only allow them once a full "fsck" has run (and no new fetches have
12037 happened in the meantime).</p></div>
12038 </dd>
12039 <dt class="hdlist1">
12040 transfer.hideRefs
12041 </dt>
12042 <dd>
12043 <p>
12044         String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
12045         refs to omit from their initial advertisements.  Use more than
12046         one definition to specify multiple prefix strings. A ref that is
12047         under the hierarchies listed in the value of this variable is
12048         excluded, and is hidden when responding to <code>git push</code> or <code>git
12049         fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
12050         program-specific versions of this config.
12051 </p>
12052 <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
12053 explicitly exposing it, even if an earlier entry marked it as hidden.
12054 If you have multiple hideRefs values, later entries override earlier ones
12055 (and entries in more-specific config files override less-specific ones).</p></div>
12056 <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
12057 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
12058 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
12059 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
12060 <div class="paragraph"><p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
12061 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
12062 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
12063 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
12064 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
12065 <code>receive-pack</code>, on the other hand, will still advertise the object id the
12066 ref is pointing to without mentioning its name (a so-called ".have" line).</p></div>
12067 <div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
12068 objects via the techniques described in the "SECURITY" section of the
12069 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
12070 separate repository.</p></div>
12071 </dd>
12072 <dt class="hdlist1">
12073 transfer.unpackLimit
12074 </dt>
12075 <dd>
12076 <p>
12077         When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
12078         not set, the value of this variable is used instead.
12079         The default value is 100.
12080 </p>
12081 </dd>
12082 <dt class="hdlist1">
12083 transfer.advertiseSID
12084 </dt>
12085 <dd>
12086 <p>
12087         Boolean. When true, client and server processes will advertise their
12088         unique session IDs to their remote counterpart. Defaults to false.
12089 </p>
12090 </dd>
12091 <dt class="hdlist1">
12092 transfer.bundleURI
12093 </dt>
12094 <dd>
12095 <p>
12096         When <code>true</code>, local <code>git clone</code> commands will request bundle
12097         information from the remote server (if advertised) and download
12098         bundles before continuing the clone through the Git protocol.
12099         Defaults to <code>false</code>.
12100 </p>
12101 </dd>
12102 <dt class="hdlist1">
12103 transfer.advertiseObjectInfo
12104 </dt>
12105 <dd>
12106 <p>
12107         When <code>true</code>, the <code>object-info</code> capability is advertised by
12108         servers. Defaults to false.
12109 </p>
12110 </dd>
12111 <dt class="hdlist1">
12112 uploadarchive.allowUnreachable
12113 </dt>
12114 <dd>
12115 <p>
12116         If true, allow clients to use <code>git archive --remote</code> to request
12117         any tree, whether reachable from the ref tips or not. See the
12118         discussion in the "SECURITY" section of
12119         <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
12120         <code>false</code>.
12121 </p>
12122 </dd>
12123 <dt class="hdlist1">
12124 uploadpack.hideRefs
12125 </dt>
12126 <dd>
12127 <p>
12128         This variable is the same as <code>transfer.hideRefs</code>, but applies
12129         only to <code>upload-pack</code> (and so affects only fetches, not pushes).
12130         An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
12131         also <code>uploadpack.allowTipSHA1InWant</code>.
12132 </p>
12133 </dd>
12134 <dt class="hdlist1">
12135 uploadpack.allowTipSHA1InWant
12136 </dt>
12137 <dd>
12138 <p>
12139         When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
12140         to accept a fetch request that asks for an object at the tip
12141         of a hidden ref (by default, such a request is rejected).
12142         See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
12143         may be able to steal objects via the techniques described in the
12144         "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
12145         best to keep private data in a separate repository.
12146 </p>
12147 </dd>
12148 <dt class="hdlist1">
12149 uploadpack.allowReachableSHA1InWant
12150 </dt>
12151 <dd>
12152 <p>
12153         Allow <code>upload-pack</code> to accept a fetch request that asks for an
12154         object that is reachable from any ref tip. However, note that
12155         calculating object reachability is computationally expensive.
12156         Defaults to <code>false</code>.  Even if this is false, a client may be able
12157         to steal objects via the techniques described in the "SECURITY"
12158         section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
12159         keep private data in a separate repository.
12160 </p>
12161 </dd>
12162 <dt class="hdlist1">
12163 uploadpack.allowAnySHA1InWant
12164 </dt>
12165 <dd>
12166 <p>
12167         Allow <code>upload-pack</code> to accept a fetch request that asks for any
12168         object at all.
12169         Defaults to <code>false</code>.
12170 </p>
12171 </dd>
12172 <dt class="hdlist1">
12173 uploadpack.keepAlive
12174 </dt>
12175 <dd>
12176 <p>
12177         When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
12178         quiet period while <code>pack-objects</code> prepares the pack. Normally
12179         it would output progress information, but if <code>--quiet</code> was used
12180         for the fetch, <code>pack-objects</code> will output nothing at all until
12181         the pack data begins. Some clients and networks may consider
12182         the server to be hung and give up. Setting this option instructs
12183         <code>upload-pack</code> to send an empty keepalive packet every
12184         <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
12185         disables keepalive packets entirely. The default is 5 seconds.
12186 </p>
12187 </dd>
12188 <dt class="hdlist1">
12189 uploadpack.packObjectsHook
12190 </dt>
12191 <dd>
12192 <p>
12193         If this option is set, when <code>upload-pack</code> would run
12194         <code>git pack-objects</code> to create a packfile for a client, it will
12195         run this shell command instead.  The <code>pack-objects</code> command and
12196         arguments it <em>would</em> have run (including the <code>git pack-objects</code>
12197         at the beginning) are appended to the shell command. The stdin
12198         and stdout of the hook are treated as if <code>pack-objects</code> itself
12199         was run. I.e., <code>upload-pack</code> will feed input intended for
12200         <code>pack-objects</code> to the hook, and expects a completed packfile on
12201         stdout.
12202 </p>
12203 <div class="paragraph"><p>Note that this configuration variable is only respected when it is specified
12204 in protected configuration (see <a href="#SCOPES">[SCOPES]</a>). This is a safety measure
12205 against fetching from untrusted repositories.</p></div>
12206 </dd>
12207 <dt class="hdlist1">
12208 uploadpack.allowFilter
12209 </dt>
12210 <dd>
12211 <p>
12212         If this option is set, <code>upload-pack</code> will support partial
12213         clone and partial fetch object filtering.
12214 </p>
12215 </dd>
12216 <dt class="hdlist1">
12217 uploadpackfilter.allow
12218 </dt>
12219 <dd>
12220 <p>
12221         Provides a default value for unspecified object filters (see: the
12222         below configuration variable). If set to <code>true</code>, this will also
12223         enable all filters which get added in the future.
12224         Defaults to <code>true</code>.
12225 </p>
12226 </dd>
12227 <dt class="hdlist1">
12228 uploadpackfilter.&lt;filter&gt;.allow
12229 </dt>
12230 <dd>
12231 <p>
12232         Explicitly allow or ban the object filter corresponding to
12233         <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
12234         <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
12235         If using combined filters, both <code>combine</code> and all of the nested
12236         filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.
12237 </p>
12238 </dd>
12239 <dt class="hdlist1">
12240 uploadpackfilter.tree.maxDepth
12241 </dt>
12242 <dd>
12243 <p>
12244         Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
12245         <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
12246         <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
12247         variable had already been set. Has no effect if unset.
12248 </p>
12249 </dd>
12250 <dt class="hdlist1">
12251 uploadpack.allowRefInWant
12252 </dt>
12253 <dd>
12254 <p>
12255         If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
12256         feature of the protocol version 2 <code>fetch</code> command.  This feature
12257         is intended for the benefit of load-balanced servers which may
12258         not have the same view of what OIDs their refs point to due to
12259         replication delay.
12260 </p>
12261 </dd>
12262 <dt class="hdlist1">
12263 url.&lt;base&gt;.insteadOf
12264 </dt>
12265 <dd>
12266 <p>
12267         Any URL that starts with this value will be rewritten to
12268         start, instead, with &lt;base&gt;. In cases where some site serves a
12269         large number of repositories, and serves them with multiple
12270         access methods, and some users need to use different access
12271         methods, this feature allows people to specify any of the
12272         equivalent URLs and have Git automatically rewrite the URL to
12273         the best alternative for the particular user, even for a
12274         never-before-seen repository on the site.  When more than one
12275         insteadOf strings match a given URL, the longest match is used.
12276 </p>
12277 <div class="paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
12278 URL. If the rewrite changes the URL to use a custom protocol or remote
12279 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
12280 the request.  In particular, protocols you expect to use for submodules
12281 must be set to <code>always</code> rather than the default of <code>user</code>. See the
12282 description of <code>protocol.allow</code> above.</p></div>
12283 </dd>
12284 <dt class="hdlist1">
12285 url.&lt;base&gt;.pushInsteadOf
12286 </dt>
12287 <dd>
12288 <p>
12289         Any URL that starts with this value will not be pushed to;
12290         instead, it will be rewritten to start with &lt;base&gt;, and the
12291         resulting URL will be pushed to. In cases where some site serves
12292         a large number of repositories, and serves them with multiple
12293         access methods, some of which do not allow push, this feature
12294         allows people to specify a pull-only URL and have Git
12295         automatically use an appropriate URL to push, even for a
12296         never-before-seen repository on the site.  When more than one
12297         pushInsteadOf strings match a given URL, the longest match is
12298         used.  If a remote has an explicit pushurl, Git will ignore this
12299         setting for that remote.
12300 </p>
12301 </dd>
12302 <dt class="hdlist1">
12303 user.name
12304 </dt>
12305 <dt class="hdlist1">
12306 user.email
12307 </dt>
12308 <dt class="hdlist1">
12309 author.name
12310 </dt>
12311 <dt class="hdlist1">
12312 author.email
12313 </dt>
12314 <dt class="hdlist1">
12315 committer.name
12316 </dt>
12317 <dt class="hdlist1">
12318 committer.email
12319 </dt>
12320 <dd>
12321 <p>
12322         The <code>user.name</code> and <code>user.email</code> variables determine what ends
12323         up in the <code>author</code> and <code>committer</code> fields of commit
12324         objects.
12325         If you need the <code>author</code> or <code>committer</code> to be different, the
12326         <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
12327         <code>committer.email</code> variables can be set.
12328         All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
12329         <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
12330         <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.
12331 </p>
12332 <div class="paragraph"><p>Note that the <code>name</code> forms of these variables conventionally refer to
12333 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
12334 environment variables section of <a href="git.html">git(1)</a> for more information on
12335 these settings and the <code>credential.username</code> option if you&#8217;re looking
12336 for authentication credentials instead.</p></div>
12337 </dd>
12338 <dt class="hdlist1">
12339 user.useConfigOnly
12340 </dt>
12341 <dd>
12342 <p>
12343         Instruct Git to avoid trying to guess defaults for <code>user.email</code>
12344         and <code>user.name</code>, and instead retrieve the values only from the
12345         configuration. For example, if you have multiple email addresses
12346         and would like to use a different one for each repository, then
12347         with this configuration option set to <code>true</code> in the global config
12348         along with a name, Git will prompt you to set up an email before
12349         making new commits in a newly cloned repository.
12350         Defaults to <code>false</code>.
12351 </p>
12352 </dd>
12353 <dt class="hdlist1">
12354 user.signingKey
12355 </dt>
12356 <dd>
12357 <p>
12358         If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
12359         key you want it to automatically when creating a signed tag or
12360         commit, you can override the default selection with this variable.
12361         This option is passed unchanged to gpg&#8217;s --local-user parameter,
12362         so you may specify a key using any method that gpg supports.
12363         If gpg.format is set to <code>ssh</code> this can contain the path to either
12364         your private ssh key or the public key when ssh-agent is used.
12365         Alternatively it can contain a public key prefixed with <code>key::</code>
12366         directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
12367         needs to be available via ssh-agent. If not set Git will call
12368         gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
12369         first key available. For backward compatibility, a raw key which
12370         begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
12371         as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
12372         use the <code>key::</code> form instead.
12373 </p>
12374 </dd>
12375 <dt class="hdlist1">
12376 versionsort.prereleaseSuffix (deprecated)
12377 </dt>
12378 <dd>
12379 <p>
12380         Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
12381         <code>versionsort.suffix</code> is set.
12382 </p>
12383 </dd>
12384 <dt class="hdlist1">
12385 versionsort.suffix
12386 </dt>
12387 <dd>
12388 <p>
12389         Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
12390         with the same base version but different suffixes are still sorted
12391         lexicographically, resulting e.g. in prerelease tags appearing
12392         after the main release (e.g. "1.0-rc1" after "1.0").  This
12393         variable can be specified to determine the sorting order of tags
12394         with different suffixes.
12395 </p>
12396 <div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
12397 that suffix will appear before the corresponding main release.  E.g. if
12398 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
12399 "1.0".  If specified multiple times, once per suffix, then the order of
12400 suffixes in the configuration will determine the sorting order of tagnames
12401 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
12402 configuration, then all "1.0-preX" tags will be listed before any
12403 "1.0-rcX" tags.  The placement of the main release tag relative to tags
12404 with various suffixes can be determined by specifying the empty suffix
12405 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
12406 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
12407 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
12408 "v4.8-bfsX".</p></div>
12409 <div class="paragraph"><p>If more than one suffix matches the same tagname, then that tagname will
12410 be sorted according to the suffix which starts at the earliest position in
12411 the tagname.  If more than one different matching suffix starts at
12412 that earliest position, then that tagname will be sorted according to the
12413 longest of those suffixes.
12414 The sorting order between different suffixes is undefined if they are
12415 in multiple config files.</p></div>
12416 </dd>
12417 <dt class="hdlist1">
12418 web.browser
12419 </dt>
12420 <dd>
12421 <p>
12422         Specify a web browser that may be used by some commands.
12423         Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
12424         may use it.
12425 </p>
12426 </dd>
12427 <dt class="hdlist1">
12428 worktree.guessRemote
12429 </dt>
12430 <dd>
12431 <p>
12432         If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
12433         <code>--detach</code> is used, then <code>git worktree add</code> defaults to
12434         creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
12435         set to true, <code>worktree add</code> tries to find a remote-tracking
12436         branch whose name uniquely matches the new branch name.  If
12437         such a branch exists, it is checked out and set as "upstream"
12438         for the new branch.  If no such match can be found, it falls
12439         back to creating a new branch from the current HEAD.
12440 </p>
12441 </dd>
12442 </dl></div>
12443 </div>
12444 </div>
12445 </div>
12446 <div class="sect1">
12447 <h2 id="_bugs">BUGS</h2>
12448 <div class="sectionbody">
12449 <div class="paragraph"><p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
12450 will result in adding a multi-line key instead of a change, if the subsection
12451 is given with at least one uppercase character. For example when the config
12452 looks like</p></div>
12453 <div class="listingblock">
12454 <div class="content">
12455 <pre><code>  [section.subsection]
12456     key = value1</code></pre>
12457 </div></div>
12458 <div class="paragraph"><p>and running <code>git config section.Subsection.key value2</code> will result in</p></div>
12459 <div class="listingblock">
12460 <div class="content">
12461 <pre><code>  [section.subsection]
12462     key = value1
12463     key = value2</code></pre>
12464 </div></div>
12465 </div>
12466 </div>
12467 <div class="sect1">
12468 <h2 id="_git">GIT</h2>
12469 <div class="sectionbody">
12470 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
12471 </div>
12472 </div>
12473 </div>
12474 <div id="footnotes"><hr /></div>
12475 <div id="footer">
12476 <div id="footer-text">
12477 Last updated
12478  2024-05-16 11:09:25 PDT
12479 </div>
12480 </div>
12481 </body>
12482 </html>