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</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--comment=&lt;message&gt;] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] &lt;name&gt; [&lt;value&gt; [&lt;value-pattern&gt;]]
 753 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--comment=&lt;message&gt;] --add &lt;name&gt; &lt;value&gt;
 754 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--comment=&lt;message&gt;] [--fixed-value] --replace-all &lt;name&gt; &lt;value&gt; [&lt;value-pattern&gt;]
 755 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get &lt;name&gt; [&lt;value-pattern&gt;]
 756 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all &lt;name&gt; [&lt;value-pattern&gt;]
 757 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp &lt;name-regex&gt; [&lt;value-pattern&gt;]
 758 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [-z|--null] --get-urlmatch &lt;name&gt; &lt;URL&gt;
 759 <em>git config</em> [&lt;file-option&gt;] [--fixed-value] --unset &lt;name&gt; [&lt;value-pattern&gt;]
 760 <em>git config</em> [&lt;file-option&gt;] [--fixed-value] --unset-all &lt;name&gt; [&lt;value-pattern&gt;]
 761 <em>git config</em> [&lt;file-option&gt;] --rename-section &lt;old-name&gt; &lt;new-name&gt;
 762 <em>git config</em> [&lt;file-option&gt;] --remove-section &lt;name&gt;
 763 <em>git config</em> [&lt;file-option&gt;] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
 764 <em>git config</em> [&lt;file-option&gt;] --get-color &lt;name&gt; [&lt;default&gt;]
 765 <em>git config</em> [&lt;file-option&gt;] --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]
 766 <em>git config</em> [&lt;file-option&gt;] -e | --edit</pre>
 767 <div class="attribution">
 768 </div></div>
 769 </div>
 770 </div>
 771 <div class="sect1">
 772 <h2 id="_description">DESCRIPTION</h2>
 773 <div class="sectionbody">
 774 <div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is
 775 actually the section and the key separated by a dot, and the value will be
 776 escaped.</p></div>
 777 <div class="paragraph"><p>Multiple lines can be added to an option by using the <code>--add</code> option.
 778 If you want to update or unset an option which can occur on multiple
 779 lines, a <code>value-pattern</code> (which is an extended regular expression,
 780 unless the <code>--fixed-value</code> option is given) needs to be given.  Only the
 781 existing values that match the pattern are updated or unset.  If
 782 you want to handle the lines that do <strong>not</strong> match the pattern, just
 783 prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>),
 784 but note that this only works when the <code>--fixed-value</code> option is not
 785 in use.</p></div>
 786 <div class="paragraph"><p>The <code>--type=&lt;type&gt;</code> option instructs <em>git config</em> to ensure that incoming and
 787 outgoing values are canonicalize-able under the given &lt;type&gt;.  If no
 788 <code>--type=&lt;type&gt;</code> is given, no canonicalization will be performed. Callers may
 789 unset an existing <code>--type</code> specifier with <code>--no-type</code>.</p></div>
 790 <div class="paragraph"><p>When reading, the values are read from the system, global and
 791 repository local configuration files by default, and options
 792 <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code> and
 793 <code>--file &lt;filename&gt;</code> can be used to tell the command to read from only
 794 that location (see <a href="#FILES">[FILES]</a>).</p></div>
 795 <div class="paragraph"><p>When writing, the new value is written to the repository local
 796 configuration file by default, and options <code>--system</code>, <code>--global</code>,
 797 <code>--worktree</code>, <code>--file &lt;filename&gt;</code> can be used to tell the command to
 798 write to that location (you can say <code>--local</code> but that is the
 799 default).</p></div>
 800 <div class="paragraph"><p>This command will fail with non-zero status upon error.  Some exit
 801 codes are:</p></div>
 802 <div class="ulist"><ul>
 803 <li>
 804 <p>
 805 The section or key is invalid (ret=1),
 806 </p>
 807 </li>
 808 <li>
 809 <p>
 810 no section or name was provided (ret=2),
 811 </p>
 812 </li>
 813 <li>
 814 <p>
 815 the config file is invalid (ret=3),
 816 </p>
 817 </li>
 818 <li>
 819 <p>
 820 the config file cannot be written (ret=4),
 821 </p>
 822 </li>
 823 <li>
 824 <p>
 825 you try to unset an option which does not exist (ret=5),
 826 </p>
 827 </li>
 828 <li>
 829 <p>
 830 you try to unset/set an option for which multiple lines match (ret=5), or
 831 </p>
 832 </li>
 833 <li>
 834 <p>
 835 you try to use an invalid regexp (ret=6).
 836 </p>
 837 </li>
 838 </ul></div>
 839 <div class="paragraph"><p>On success, the command returns the exit code 0.</p></div>
 840 <div class="paragraph"><p>A list of all available configuration variables can be obtained using the
 841 <code>git help --config</code> command.</p></div>
 842 </div>
 843 </div>
 844 <div class="sect1">
 845 <h2 id="OPTIONS">OPTIONS</h2>
 846 <div class="sectionbody">
 847 <div class="dlist"><dl>
 848 <dt class="hdlist1">
 849 --replace-all
 850 </dt>
 851 <dd>
 852 <p>
 853         Default behavior is to replace at most one line. This replaces
 854         all lines matching the key (and optionally the <code>value-pattern</code>).
 855 </p>
 856 </dd>
 857 <dt class="hdlist1">
 858 --add
 859 </dt>
 860 <dd>
 861 <p>
 862         Adds a new line to the option without altering any existing
 863         values.  This is the same as providing <em>^$</em> as the <code>value-pattern</code>
 864         in <code>--replace-all</code>.
 865 </p>
 866 </dd>
 867 <dt class="hdlist1">
 868 --comment &lt;message&gt;
 869 </dt>
 870 <dd>
 871 <p>
 872         Append a comment at the end of new or modified lines.
 873 </p>
 874 <div class="literalblock">
 875 <div class="content">
 876 <pre><code>If _&lt;message&gt;_ begins with one or more whitespaces followed
 877 by "#", it is used as-is.  If it begins with "#", a space is
 878 prepended before it is used.  Otherwise, a string " # " (a
 879 space followed by a hash followed by a space) is prepended
 880 to it.  And the resulting string is placed immediately after
 881 the value defined for the variable.  The _&lt;message&gt;_ must
 882 not contain linefeed characters (no multi-line comments are
 883 permitted).</code></pre>
 884 </div></div>
 885 </dd>
 886 <dt class="hdlist1">
 887 --get
 888 </dt>
 889 <dd>
 890 <p>
 891         Get the value for a given key (optionally filtered by a regex
 892         matching the value). Returns error code 1 if the key was not
 893         found and the last value if multiple key values were found.
 894 </p>
 895 </dd>
 896 <dt class="hdlist1">
 897 --get-all
 898 </dt>
 899 <dd>
 900 <p>
 901         Like get, but returns all values for a multi-valued key.
 902 </p>
 903 </dd>
 904 <dt class="hdlist1">
 905 --get-regexp
 906 </dt>
 907 <dd>
 908 <p>
 909         Like --get-all, but interprets the name as a regular expression and
 910         writes out the key names.  Regular expression matching is currently
 911         case-sensitive and done against a canonicalized version of the key
 912         in which section and variable names are lowercased, but subsection
 913         names are not.
 914 </p>
 915 </dd>
 916 <dt class="hdlist1">
 917 --get-urlmatch &lt;name&gt; &lt;URL&gt;
 918 </dt>
 919 <dd>
 920 <p>
 921         When given a two-part &lt;name&gt; as &lt;section&gt;.&lt;key&gt;, the value for
 922         &lt;section&gt;.&lt;URL&gt;.&lt;key&gt; whose &lt;URL&gt; part matches the best to the
 923         given URL is returned (if no such key exists, the value for
 924         &lt;section&gt;.&lt;key&gt; is used as a fallback).  When given just the
 925         &lt;section&gt; as name, do so for all the keys in the section and
 926         list them.  Returns error code 1 if no value is found.
 927 </p>
 928 </dd>
 929 <dt class="hdlist1">
 930 --global
 931 </dt>
 932 <dd>
 933 <p>
 934         For writing options: write to global <code>~/.gitconfig</code> file
 935         rather than the repository <code>.git/config</code>, write to
 936         <code>$XDG_CONFIG_HOME/git/config</code> file if this file exists and the
 937         <code>~/.gitconfig</code> file doesn&#8217;t.
 938 </p>
 939 <div class="paragraph"><p>For reading options: read only from global <code>~/.gitconfig</code> and from
 940 <code>$XDG_CONFIG_HOME/git/config</code> rather than from all available files.</p></div>
 941 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 942 </dd>
 943 <dt class="hdlist1">
 944 --system
 945 </dt>
 946 <dd>
 947 <p>
 948         For writing options: write to system-wide
 949         <code>$(prefix)/etc/gitconfig</code> rather than the repository
 950         <code>.git/config</code>.
 951 </p>
 952 <div class="paragraph"><p>For reading options: read only from system-wide <code>$(prefix)/etc/gitconfig</code>
 953 rather than from all available files.</p></div>
 954 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 955 </dd>
 956 <dt class="hdlist1">
 957 --local
 958 </dt>
 959 <dd>
 960 <p>
 961         For writing options: write to the repository <code>.git/config</code> file.
 962         This is the default behavior.
 963 </p>
 964 <div class="paragraph"><p>For reading options: read only from the repository <code>.git/config</code> rather than
 965 from all available files.</p></div>
 966 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 967 </dd>
 968 <dt class="hdlist1">
 969 --worktree
 970 </dt>
 971 <dd>
 972 <p>
 973         Similar to <code>--local</code> except that <code>$GIT_DIR/config.worktree</code> is
 974         read from or written to if <code>extensions.worktreeConfig</code> is
 975         enabled. If not it&#8217;s the same as <code>--local</code>. Note that <code>$GIT_DIR</code>
 976         is equal to <code>$GIT_COMMON_DIR</code> for the main working tree, but is of
 977         the form <code>$GIT_DIR/worktrees/&lt;id&gt;/</code> for other working trees. See
 978         <a href="git-worktree.html">git-worktree(1)</a> to learn how to enable
 979         <code>extensions.worktreeConfig</code>.
 980 </p>
 981 </dd>
 982 <dt class="hdlist1">
 983 -f &lt;config-file&gt;
 984 </dt>
 985 <dt class="hdlist1">
 986 --file &lt;config-file&gt;
 987 </dt>
 988 <dd>
 989 <p>
 990         For writing options: write to the specified file rather than the
 991         repository <code>.git/config</code>.
 992 </p>
 993 <div class="paragraph"><p>For reading options: read only from the specified file rather than from all
 994 available files.</p></div>
 995 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 996 </dd>
 997 <dt class="hdlist1">
 998 --blob &lt;blob&gt;
 999 </dt>
1000 <dd>
1001 <p>
1002         Similar to <code>--file</code> but use the given blob instead of a file. E.g.
1003         you can use <em>master:.gitmodules</em> to read values from the file
1004         <em>.gitmodules</em> in the master branch. See "SPECIFYING REVISIONS"
1005         section in <a href="gitrevisions.html">gitrevisions(7)</a> for a more complete list of
1006         ways to spell blob names.
1007 </p>
1008 </dd>
1009 <dt class="hdlist1">
1010 --remove-section
1011 </dt>
1012 <dd>
1013 <p>
1014         Remove the given section from the configuration file.
1015 </p>
1016 </dd>
1017 <dt class="hdlist1">
1018 --rename-section
1019 </dt>
1020 <dd>
1021 <p>
1022         Rename the given section to a new name.
1023 </p>
1024 </dd>
1025 <dt class="hdlist1">
1026 --unset
1027 </dt>
1028 <dd>
1029 <p>
1030         Remove the line matching the key from config file.
1031 </p>
1032 </dd>
1033 <dt class="hdlist1">
1034 --unset-all
1035 </dt>
1036 <dd>
1037 <p>
1038         Remove all lines matching the key from config file.
1039 </p>
1040 </dd>
1041 <dt class="hdlist1">
1042 -l
1043 </dt>
1044 <dt class="hdlist1">
1045 --list
1046 </dt>
1047 <dd>
1048 <p>
1049         List all variables set in config file, along with their values.
1050 </p>
1051 </dd>
1052 <dt class="hdlist1">
1053 --fixed-value
1054 </dt>
1055 <dd>
1056 <p>
1057         When used with the <code>value-pattern</code> argument, treat <code>value-pattern</code> as
1058         an exact string instead of a regular expression. This will restrict
1059         the name/value pairs that are matched to only those where the value
1060         is exactly equal to the <code>value-pattern</code>.
1061 </p>
1062 </dd>
1063 <dt class="hdlist1">
1064 --type &lt;type&gt;
1065 </dt>
1066 <dd>
1067 <p>
1068   <em>git config</em> will ensure that any input or output is valid under the given
1069   type constraint(s), and will canonicalize outgoing values in <code>&lt;type&gt;</code>'s
1070   canonical form.
1071 </p>
1072 <div class="paragraph"><p>Valid <code>&lt;type&gt;</code>'s include:</p></div>
1073 <div class="ulist"><ul>
1074 <li>
1075 <p>
1076 <em>bool</em>: canonicalize values as either "true" or "false".
1077 </p>
1078 </li>
1079 <li>
1080 <p>
1081 <em>int</em>: canonicalize values as simple decimal numbers. An optional suffix of
1082   <em>k</em>, <em>m</em>, or <em>g</em> will cause the value to be multiplied by 1024, 1048576, or
1083   1073741824 upon input.
1084 </p>
1085 </li>
1086 <li>
1087 <p>
1088 <em>bool-or-int</em>: canonicalize according to either <em>bool</em> or <em>int</em>, as described
1089   above.
1090 </p>
1091 </li>
1092 <li>
1093 <p>
1094 <em>path</em>: canonicalize by expanding a leading <code>~</code> to the value of <code>$HOME</code> and
1095   <code>~user</code> to the home directory for the specified user. This specifier has no
1096   effect when setting the value (but you can use <code>git config section.variable
1097   ~/</code> from the command line to let your shell do the expansion.)
1098 </p>
1099 </li>
1100 <li>
1101 <p>
1102 <em>expiry-date</em>: canonicalize by converting from a fixed or relative date-string
1103   to a timestamp. This specifier has no effect when setting the value.
1104 </p>
1105 </li>
1106 <li>
1107 <p>
1108 <em>color</em>: When getting a value, canonicalize by converting to an ANSI color
1109   escape sequence. When setting a value, a sanity-check is performed to ensure
1110   that the given value is canonicalize-able as an ANSI color, but it is written
1111   as-is.
1112 </p>
1113 </li>
1114 </ul></div>
1115 </dd>
1116 <dt class="hdlist1">
1117 --bool
1118 </dt>
1119 <dt class="hdlist1">
1120 --int
1121 </dt>
1122 <dt class="hdlist1">
1123 --bool-or-int
1124 </dt>
1125 <dt class="hdlist1">
1126 --path
1127 </dt>
1128 <dt class="hdlist1">
1129 --expiry-date
1130 </dt>
1131 <dd>
1132 <p>
1133   Historical options for selecting a type specifier. Prefer instead <code>--type</code>
1134   (see above).
1135 </p>
1136 </dd>
1137 <dt class="hdlist1">
1138 --no-type
1139 </dt>
1140 <dd>
1141 <p>
1142   Un-sets the previously set type specifier (if one was previously set). This
1143   option requests that <em>git config</em> not canonicalize the retrieved variable.
1144   <code>--no-type</code> has no effect without <code>--type=&lt;type&gt;</code> or <code>--&lt;type&gt;</code>.
1145 </p>
1146 </dd>
1147 <dt class="hdlist1">
1148 -z
1149 </dt>
1150 <dt class="hdlist1">
1151 --null
1152 </dt>
1153 <dd>
1154 <p>
1155         For all options that output values and/or keys, always
1156         end values with the null character (instead of a
1157         newline). Use newline instead as a delimiter between
1158         key and value. This allows for secure parsing of the
1159         output without getting confused e.g. by values that
1160         contain line breaks.
1161 </p>
1162 </dd>
1163 <dt class="hdlist1">
1164 --name-only
1165 </dt>
1166 <dd>
1167 <p>
1168         Output only the names of config variables for <code>--list</code> or
1169         <code>--get-regexp</code>.
1170 </p>
1171 </dd>
1172 <dt class="hdlist1">
1173 --show-origin
1174 </dt>
1175 <dd>
1176 <p>
1177         Augment the output of all queried config options with the
1178         origin type (file, standard input, blob, command line) and
1179         the actual origin (config file path, ref, or blob id if
1180         applicable).
1181 </p>
1182 </dd>
1183 <dt class="hdlist1">
1184 --show-scope
1185 </dt>
1186 <dd>
1187 <p>
1188         Similar to <code>--show-origin</code> in that it augments the output of
1189         all queried config options with the scope of that value
1190         (worktree, local, global, system, command).
1191 </p>
1192 </dd>
1193 <dt class="hdlist1">
1194 --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]
1195 </dt>
1196 <dd>
1197 <p>
1198         Find the color setting for <code>&lt;name&gt;</code> (e.g. <code>color.diff</code>) and output
1199         "true" or "false".  <code>&lt;stdout-is-tty&gt;</code> should be either "true" or
1200         "false", and is taken into account when configuration says
1201         "auto".  If <code>&lt;stdout-is-tty&gt;</code> is missing, then checks the standard
1202         output of the command itself, and exits with status 0 if color
1203         is to be used, or exits with status 1 otherwise.
1204         When the color setting for <code>name</code> is undefined, the command uses
1205         <code>color.ui</code> as fallback.
1206 </p>
1207 </dd>
1208 <dt class="hdlist1">
1209 --get-color &lt;name&gt; [&lt;default&gt;]
1210 </dt>
1211 <dd>
1212 <p>
1213         Find the color configured for <code>name</code> (e.g. <code>color.diff.new</code>) and
1214         output it as the ANSI color escape sequence to the standard
1215         output.  The optional <code>default</code> parameter is used instead, if
1216         there is no color configured for <code>name</code>.
1217 </p>
1218 <div class="paragraph"><p><code>--type=color [--default=&lt;default&gt;]</code> is preferred over <code>--get-color</code>
1219 (but note that <code>--get-color</code> will omit the trailing newline printed by
1220 <code>--type=color</code>).</p></div>
1221 </dd>
1222 <dt class="hdlist1">
1223 -e
1224 </dt>
1225 <dt class="hdlist1">
1226 --edit
1227 </dt>
1228 <dd>
1229 <p>
1230         Opens an editor to modify the specified config file; either
1231         <code>--system</code>, <code>--global</code>, <code>--local</code> (default), <code>--worktree</code>, or
1232         <code>--file &lt;config-file&gt;</code>.
1233 </p>
1234 </dd>
1235 <dt class="hdlist1">
1236 --[no-]includes
1237 </dt>
1238 <dd>
1239 <p>
1240         Respect <code>include.*</code> directives in config files when looking up
1241         values. Defaults to <code>off</code> when a specific file is given (e.g.,
1242         using <code>--file</code>, <code>--global</code>, etc) and <code>on</code> when searching all
1243         config files.
1244 </p>
1245 </dd>
1246 <dt class="hdlist1">
1247 --default &lt;value&gt;
1248 </dt>
1249 <dd>
1250 <p>
1251   When using <code>--get</code>, and the requested variable is not found, behave as if
1252   &lt;value&gt; were the value assigned to that variable.
1253 </p>
1254 </dd>
1255 </dl></div>
1256 </div>
1257 </div>
1258 <div class="sect1">
1259 <h2 id="_configuration">CONFIGURATION</h2>
1260 <div class="sectionbody">
1261 <div class="paragraph"><p><code>pager.config</code> is only respected when listing configuration, i.e., when
1262 using <code>--list</code> or any of the <code>--get-*</code> which may return multiple results.
1263 The default is to use a pager.</p></div>
1264 </div>
1265 </div>
1266 <div class="sect1">
1267 <h2 id="FILES">FILES</h2>
1268 <div class="sectionbody">
1269 <div class="paragraph"><p>By default, <em>git config</em> will read configuration options from multiple
1270 files:</p></div>
1271 <div class="dlist"><dl>
1272 <dt class="hdlist1">
1273 $(prefix)/etc/gitconfig
1274 </dt>
1275 <dd>
1276 <p>
1277         System-wide configuration file.
1278 </p>
1279 </dd>
1280 <dt class="hdlist1">
1281 $XDG_CONFIG_HOME/git/config
1282 </dt>
1283 <dt class="hdlist1">
1284 ~/.gitconfig
1285 </dt>
1286 <dd>
1287 <p>
1288         User-specific configuration files. When the XDG_CONFIG_HOME environment
1289         variable is not set or empty, $HOME/.config/ is used as
1290         $XDG_CONFIG_HOME.
1291 </p>
1292 <div class="paragraph"><p>These are also called "global" configuration files. If both files exist, both
1293 files are read in the order given above.</p></div>
1294 </dd>
1295 <dt class="hdlist1">
1296 $GIT_DIR/config
1297 </dt>
1298 <dd>
1299 <p>
1300         Repository specific configuration file.
1301 </p>
1302 </dd>
1303 <dt class="hdlist1">
1304 $GIT_DIR/config.worktree
1305 </dt>
1306 <dd>
1307 <p>
1308         This is optional and is only searched when
1309         <code>extensions.worktreeConfig</code> is present in $GIT_DIR/config.
1310 </p>
1311 </dd>
1312 </dl></div>
1313 <div class="paragraph"><p>You may also provide additional configuration parameters when running any
1314 git command by using the <code>-c</code> option. See <a href="git.html">git(1)</a> for details.</p></div>
1315 <div class="paragraph"><p>Options will be read from all of these files that are available. If the
1316 global or the system-wide configuration files are missing or unreadable they
1317 will be ignored. If the repository configuration file is missing or unreadable,
1318 <em>git config</em> will exit with a non-zero error code. An error message is produced
1319 if the file is unreadable, but not if it is missing.</p></div>
1320 <div class="paragraph"><p>The files are read in the order given above, with last value found taking
1321 precedence over values read earlier.  When multiple values are taken then all
1322 values of a key from all files will be used.</p></div>
1323 <div class="paragraph"><p>By default, options are only written to the repository specific
1324 configuration file. Note that this also affects options like <code>--replace-all</code>
1325 and <code>--unset</code>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
1326 <div class="paragraph"><p>You can limit which configuration sources are read from or written to by
1327 specifying the path of a file with the <code>--file</code> option, or by specifying a
1328 configuration scope with <code>--system</code>, <code>--global</code>, <code>--local</code>, or <code>--worktree</code>.
1329 For more, see <a href="#OPTIONS">[OPTIONS]</a> above.</p></div>
1330 </div>
1331 </div>
1332 <div class="sect1">
1333 <h2 id="SCOPES">SCOPES</h2>
1334 <div class="sectionbody">
1335 <div class="paragraph"><p>Each configuration source falls within a configuration scope. The scopes
1336 are:</p></div>
1337 <div class="dlist"><dl>
1338 <dt class="hdlist1">
1339 system
1340 </dt>
1341 <dd>
1342 <p>
1343         $(prefix)/etc/gitconfig
1344 </p>
1345 </dd>
1346 <dt class="hdlist1">
1347 global
1348 </dt>
1349 <dd>
1350 <p>
1351         $XDG_CONFIG_HOME/git/config
1352 </p>
1353 <div class="paragraph"><p>~/.gitconfig</p></div>
1354 </dd>
1355 <dt class="hdlist1">
1356 local
1357 </dt>
1358 <dd>
1359 <p>
1360         $GIT_DIR/config
1361 </p>
1362 </dd>
1363 <dt class="hdlist1">
1364 worktree
1365 </dt>
1366 <dd>
1367 <p>
1368         $GIT_DIR/config.worktree
1369 </p>
1370 </dd>
1371 <dt class="hdlist1">
1372 command
1373 </dt>
1374 <dd>
1375 <p>
1376         GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see <a href="#ENVIRONMENT">[ENVIRONMENT]</a>
1377         below)
1378 </p>
1379 <div class="paragraph"><p>the <code>-c</code> option</p></div>
1380 </dd>
1381 </dl></div>
1382 <div class="paragraph"><p>With the exception of <em>command</em>, each scope corresponds to a command line
1383 option: <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code>.</p></div>
1384 <div class="paragraph"><p>When reading options, specifying a scope will only read options from the
1385 files within that scope. When writing options, specifying a scope will write
1386 to the files within that scope (instead of the repository specific
1387 configuration file). See <a href="#OPTIONS">[OPTIONS]</a> above for a complete description.</p></div>
1388 <div class="paragraph"><p>Most configuration options are respected regardless of the scope it is
1389 defined in, but some options are only respected in certain scopes. See the
1390 respective option&#8217;s documentation for the full details.</p></div>
1391 <div class="sect2">
1392 <h3 id="_protected_configuration">Protected configuration</h3>
1393 <div class="paragraph"><p>Protected configuration refers to the <em>system</em>, <em>global</em>, and <em>command</em> scopes.
1394 For security reasons, certain options are only respected when they are
1395 specified in protected configuration, and ignored otherwise.</p></div>
1396 <div class="paragraph"><p>Git treats these scopes as if they are controlled by the user or a trusted
1397 administrator. This is because an attacker who controls these scopes can do
1398 substantial harm without using Git, so it is assumed that the user&#8217;s environment
1399 protects these scopes against attackers.</p></div>
1400 </div>
1401 </div>
1402 </div>
1403 <div class="sect1">
1404 <h2 id="ENVIRONMENT">ENVIRONMENT</h2>
1405 <div class="sectionbody">
1406 <div class="dlist"><dl>
1407 <dt class="hdlist1">
1408 GIT_CONFIG_GLOBAL
1409 </dt>
1410 <dt class="hdlist1">
1411 GIT_CONFIG_SYSTEM
1412 </dt>
1413 <dd>
1414 <p>
1415         Take the configuration from the given files instead from global or
1416         system-level configuration. See <a href="git.html">git(1)</a> for details.
1417 </p>
1418 </dd>
1419 <dt class="hdlist1">
1420 GIT_CONFIG_NOSYSTEM
1421 </dt>
1422 <dd>
1423 <p>
1424         Whether to skip reading settings from the system-wide
1425         $(prefix)/etc/gitconfig file. See <a href="git.html">git(1)</a> for details.
1426 </p>
1427 </dd>
1428 </dl></div>
1429 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1430 <div class="dlist"><dl>
1431 <dt class="hdlist1">
1432 GIT_CONFIG_COUNT
1433 </dt>
1434 <dt class="hdlist1">
1435 GIT_CONFIG_KEY_&lt;n&gt;
1436 </dt>
1437 <dt class="hdlist1">
1438 GIT_CONFIG_VALUE_&lt;n&gt;
1439 </dt>
1440 <dd>
1441 <p>
1442         If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
1443         GIT_CONFIG_KEY_&lt;n&gt; and GIT_CONFIG_VALUE_&lt;n&gt; up to that number will be
1444         added to the process&#8217;s runtime configuration. The config pairs are
1445         zero-indexed. Any missing key or value is treated as an error. An empty
1446         GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
1447         pairs are processed. These environment variables will override values
1448         in configuration files, but will be overridden by any explicit options
1449         passed via <code>git -c</code>.
1450 </p>
1451 <div class="paragraph"><p>This is useful for cases where you want to spawn multiple git commands
1452 with a common configuration but cannot depend on a configuration file,
1453 for example when writing scripts.</p></div>
1454 </dd>
1455 <dt class="hdlist1">
1456 GIT_CONFIG
1457 </dt>
1458 <dd>
1459 <p>
1460         If no <code>--file</code> option is provided to <code>git config</code>, use the file
1461         given by <code>GIT_CONFIG</code> as if it were provided via <code>--file</code>. This
1462         variable has no effect on other Git commands, and is mostly for
1463         historical compatibility; there is generally no reason to use it
1464         instead of the <code>--file</code> option.
1465 </p>
1466 </dd>
1467 </dl></div>
1468 </div>
1469 </div>
1470 <div class="sect1">
1471 <h2 id="EXAMPLES">EXAMPLES</h2>
1472 <div class="sectionbody">
1473 <div class="paragraph"><p>Given a .git/config like this:</p></div>
1474 <div class="listingblock">
1475 <div class="content">
1476 <pre><code>#
1477 # This is the config file, and
1478 # a '#' or ';' character indicates
1479 # a comment
1480 #
1481
1482 ; core variables
1483 [core]
1484         ; Don't trust file modes
1485         filemode = false
1486
1487 ; Our diff algorithm
1488 [diff]
1489         external = /usr/local/bin/diff-wrapper
1490         renames = true
1491
1492 ; Proxy settings
1493 [core]
1494         gitproxy=proxy-command for kernel.org
1495         gitproxy=default-proxy ; for all the rest
1496
1497 ; HTTP
1498 [http]
1499         sslVerify
1500 [http "https://weak.example.com"]
1501         sslVerify = false
1502         cookieFile = /tmp/cookie.txt</code></pre>
1503 </div></div>
1504 <div class="paragraph"><p>you can set the filemode to true with</p></div>
1505 <div class="listingblock">
1506 <div class="content">
1507 <pre><code>% git config core.filemode true</code></pre>
1508 </div></div>
1509 <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
1510 what URL they apply to. Here is how to change the entry for kernel.org
1511 to "ssh".</p></div>
1512 <div class="listingblock">
1513 <div class="content">
1514 <pre><code>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</code></pre>
1515 </div></div>
1516 <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
1517 <div class="paragraph"><p>To delete the entry for renames, do</p></div>
1518 <div class="listingblock">
1519 <div class="content">
1520 <pre><code>% git config --unset diff.renames</code></pre>
1521 </div></div>
1522 <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
1523 you have to provide a regex matching the value of exactly one line.</p></div>
1524 <div class="paragraph"><p>To query the value for a given key, do</p></div>
1525 <div class="listingblock">
1526 <div class="content">
1527 <pre><code>% git config --get core.filemode</code></pre>
1528 </div></div>
1529 <div class="paragraph"><p>or</p></div>
1530 <div class="listingblock">
1531 <div class="content">
1532 <pre><code>% git config core.filemode</code></pre>
1533 </div></div>
1534 <div class="paragraph"><p>or, to query a multivar:</p></div>
1535 <div class="listingblock">
1536 <div class="content">
1537 <pre><code>% git config --get core.gitproxy "for kernel.org$"</code></pre>
1538 </div></div>
1539 <div class="paragraph"><p>If you want to know all the values for a multivar, do:</p></div>
1540 <div class="listingblock">
1541 <div class="content">
1542 <pre><code>% git config --get-all core.gitproxy</code></pre>
1543 </div></div>
1544 <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
1545 new one with</p></div>
1546 <div class="listingblock">
1547 <div class="content">
1548 <pre><code>% git config --replace-all core.gitproxy ssh</code></pre>
1549 </div></div>
1550 <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy,
1551 i.e. the one without a "for &#8230;" postfix, do something like this:</p></div>
1552 <div class="listingblock">
1553 <div class="content">
1554 <pre><code>% git config core.gitproxy ssh '! for '</code></pre>
1555 </div></div>
1556 <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div>
1557 <div class="listingblock">
1558 <div class="content">
1559 <pre><code>% git config section.key value '[!]'</code></pre>
1560 </div></div>
1561 <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
1562 <div class="listingblock">
1563 <div class="content">
1564 <pre><code>% git config --add core.gitproxy '"proxy-command" for example.com'</code></pre>
1565 </div></div>
1566 <div class="paragraph"><p>An example to use customized color from the configuration in your
1567 script:</p></div>
1568 <div class="listingblock">
1569 <div class="content">
1570 <pre><code>#!/bin/sh
1571 WS=$(git config --get-color color.diff.whitespace "blue reverse")
1572 RESET=$(git config --get-color "" "reset")
1573 echo "${WS}your whitespace color or blue reverse${RESET}"</code></pre>
1574 </div></div>
1575 <div class="paragraph"><p>For URLs in <code>https://weak.example.com</code>, <code>http.sslVerify</code> is set to
1576 false, while it is set to <code>true</code> for all others:</p></div>
1577 <div class="listingblock">
1578 <div class="content">
1579 <pre><code>% git config --type=bool --get-urlmatch http.sslverify https://good.example.com
1580 true
1581 % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com
1582 false
1583 % git config --get-urlmatch http https://weak.example.com
1584 http.cookieFile /tmp/cookie.txt
1585 http.sslverify false</code></pre>
1586 </div></div>
1587 </div>
1588 </div>
1589 <div class="sect1">
1590 <h2 id="_configuration_file">CONFIGURATION FILE</h2>
1591 <div class="sectionbody">
1592 <div class="paragraph"><p>The Git configuration file contains a number of variables that affect
1593 the Git commands' behavior. The files <code>.git/config</code> and optionally
1594 <code>config.worktree</code> (see the "CONFIGURATION FILE" section of
1595 <a href="git-worktree.html">git-worktree(1)</a>) in each repository are used to store the
1596 configuration for that repository, and <code>$HOME/.gitconfig</code> is used to
1597 store a per-user configuration as fallback values for the <code>.git/config</code>
1598 file. The file <code>/etc/gitconfig</code> can be used to store a system-wide
1599 default configuration.</p></div>
1600 <div class="paragraph"><p>The configuration variables are used by both the Git plumbing
1601 and the porcelain commands. The variables are divided into sections, wherein
1602 the fully qualified variable name of the variable itself is the last
1603 dot-separated segment and the section name is everything before the last
1604 dot. The variable names are case-insensitive, allow only alphanumeric
1605 characters and <code>-</code>, and must start with an alphabetic character.  Some
1606 variables may appear multiple times; we say then that the variable is
1607 multivalued.</p></div>
1608 <div class="sect2">
1609 <h3 id="_syntax">Syntax</h3>
1610 <div class="paragraph"><p>The syntax is fairly flexible and permissive.  Whitespace characters,
1611 which in this context are the space character (SP) and the horizontal
1612 tabulation (HT), are mostly ignored.  The <em>#</em> and <em>;</em> characters begin
1613 comments to the end of line.  Blank lines are ignored.</p></div>
1614 <div class="paragraph"><p>The file consists of sections and variables.  A section begins with
1615 the name of the section in square brackets and continues until the next
1616 section begins.  Section names are case-insensitive.  Only alphanumeric
1617 characters, <code>-</code> and <code>.</code> are allowed in section names.  Each variable
1618 must belong to some section, which means that there must be a section
1619 header before the first setting of a variable.</p></div>
1620 <div class="paragraph"><p>Sections can be further divided into subsections.  To begin a subsection
1621 put its name in double quotes, separated by space from the section name,
1622 in the section header, like in the example below:</p></div>
1623 <div class="listingblock">
1624 <div class="content">
1625 <pre><code>        [section "subsection"]</code></pre>
1626 </div></div>
1627 <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
1628 newline and the null byte. Doublequote <code>"</code> and backslash can be included
1629 by escaping them as <code>\"</code> and <code>\\</code>, respectively. Backslashes preceding
1630 other characters are dropped when reading; for example, <code>\t</code> is read as
1631 <code>t</code> and <code>\0</code> is read as <code>0</code>. Section headers cannot span multiple lines.
1632 Variables may belong directly to a section or to a given subsection. You
1633 can have <code>[section]</code> if you have <code>[section "subsection"]</code>, but you don&#8217;t
1634 need to.</p></div>
1635 <div class="paragraph"><p>There is also a deprecated <code>[section.subsection]</code> syntax. With this
1636 syntax, the subsection name is converted to lower-case and is also
1637 compared case sensitively. These subsection names follow the same
1638 restrictions as section names.</p></div>
1639 <div class="paragraph"><p>All the other lines (and the remainder of the line after the section
1640 header) are recognized as setting variables, in the form
1641 <em>name = value</em> (or just <em>name</em>, which is a short-hand to say that
1642 the variable is the boolean "true").
1643 The variable names are case-insensitive, allow only alphanumeric characters
1644 and <code>-</code>, and must start with an alphabetic character.</p></div>
1645 <div class="paragraph"><p>Whitespace characters surrounding <code>name</code>, <code>=</code> and <code>value</code> are discarded.
1646 Internal whitespace characters within <em>value</em> are retained verbatim.
1647 Comments starting with either <code>#</code> or <code>;</code> and extending to the end of line
1648 are discarded.  A line that defines a value can be continued to the next
1649 line by ending it with a backslash (<code>\</code>);  the backslash and the end-of-line
1650 characters are discarded.</p></div>
1651 <div class="paragraph"><p>If <code>value</code> needs to contain leading or trailing whitespace characters,
1652 it must be enclosed in double quotation marks (<code>"</code>).  Inside double quotation
1653 marks, double quote (<code>"</code>) and backslash (<code>\</code>) characters must be escaped:
1654 use <code>\"</code> for <code>"</code> and <code>\\</code> for <code>\</code>.</p></div>
1655 <div class="paragraph"><p>The following escape sequences (beside <code>\"</code> and <code>\\</code>) are recognized:
1656 <code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB)
1657 and <code>\b</code> for backspace (BS).  Other char escape sequences (including octal
1658 escape sequences) are invalid.</p></div>
1659 </div>
1660 <div class="sect2">
1661 <h3 id="_includes">Includes</h3>
1662 <div class="paragraph"><p>The <code>include</code> and <code>includeIf</code> sections allow you to include config
1663 directives from another source. These sections behave identically to
1664 each other with the exception that <code>includeIf</code> sections may be ignored
1665 if their condition does not evaluate to true; see "Conditional includes"
1666 below.</p></div>
1667 <div class="paragraph"><p>You can include a config file from another by setting the special
1668 <code>include.path</code> (or <code>includeIf.*.path</code>) variable to the name of the file
1669 to be included. The variable takes a pathname as its value, and is
1670 subject to tilde expansion. These variables can be given multiple times.</p></div>
1671 <div class="paragraph"><p>The contents of the included file are inserted immediately, as if they
1672 had been found at the location of the include directive. If the value of the
1673 variable is a relative path, the path is considered to
1674 be relative to the configuration file in which the include directive
1675 was found.  See below for examples.</p></div>
1676 </div>
1677 <div class="sect2">
1678 <h3 id="_conditional_includes">Conditional includes</h3>
1679 <div class="paragraph"><p>You can conditionally include a config file from another by setting an
1680 <code>includeIf.&lt;condition&gt;.path</code> variable to the name of the file to be
1681 included.</p></div>
1682 <div class="paragraph"><p>The condition starts with a keyword followed by a colon and some data
1683 whose format and meaning depends on the keyword. Supported keywords
1684 are:</p></div>
1685 <div class="dlist"><dl>
1686 <dt class="hdlist1">
1687 <code>gitdir</code>
1688 </dt>
1689 <dd>
1690 <p>
1691         The data that follows the keyword <code>gitdir:</code> is used as a glob
1692         pattern. If the location of the .git directory matches the
1693         pattern, the include condition is met.
1694 </p>
1695 <div class="paragraph"><p>The .git location may be auto-discovered, or come from <code>$GIT_DIR</code>
1696 environment variable. If the repository is auto-discovered via a .git
1697 file (e.g. from submodules, or a linked worktree), the .git location
1698 would be the final location where the .git directory is, not where the
1699 .git file is.</p></div>
1700 <div class="paragraph"><p>The pattern can contain standard globbing wildcards and two additional
1701 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components. Please
1702 refer to <a href="gitignore.html">gitignore(5)</a> for details. For convenience:</p></div>
1703 <div class="ulist"><ul>
1704 <li>
1705 <p>
1706 If the pattern starts with <code>~/</code>, <code>~</code> will be substituted with the
1707    content of the environment variable <code>HOME</code>.
1708 </p>
1709 </li>
1710 <li>
1711 <p>
1712 If the pattern starts with <code>./</code>, it is replaced with the directory
1713    containing the current config file.
1714 </p>
1715 </li>
1716 <li>
1717 <p>
1718 If the pattern does not start with either <code>~/</code>, <code>./</code> or <code>/</code>, <code>**/</code>
1719    will be automatically prepended. For example, the pattern <code>foo/bar</code>
1720    becomes <code>**/foo/bar</code> and would match <code>/any/path/to/foo/bar</code>.
1721 </p>
1722 </li>
1723 <li>
1724 <p>
1725 If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1726    example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it
1727    matches "foo" and everything inside, recursively.
1728 </p>
1729 </li>
1730 </ul></div>
1731 </dd>
1732 <dt class="hdlist1">
1733 <code>gitdir/i</code>
1734 </dt>
1735 <dd>
1736 <p>
1737         This is the same as <code>gitdir</code> except that matching is done
1738         case-insensitively (e.g. on case-insensitive file systems)
1739 </p>
1740 </dd>
1741 <dt class="hdlist1">
1742 <code>onbranch</code>
1743 </dt>
1744 <dd>
1745 <p>
1746         The data that follows the keyword <code>onbranch:</code> is taken to be a
1747         pattern with standard globbing wildcards and two additional
1748         ones, <code>**/</code> and <code>/**</code>, that can match multiple path components.
1749         If we are in a worktree where the name of the branch that is
1750         currently checked out matches the pattern, the include condition
1751         is met.
1752 </p>
1753 <div class="paragraph"><p>If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1754 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it matches
1755 all branches that begin with <code>foo/</code>. This is useful if your branches are
1756 organized hierarchically and you would like to apply a configuration to
1757 all the branches in that hierarchy.</p></div>
1758 </dd>
1759 <dt class="hdlist1">
1760 <code>hasconfig:remote.*.url:</code>
1761 </dt>
1762 <dd>
1763 <p>
1764         The data that follows this keyword is taken to
1765         be a pattern with standard globbing wildcards and two
1766         additional ones, <code>**/</code> and <code>/**</code>, that can match multiple
1767         components. The first time this keyword is seen, the rest of
1768         the config files will be scanned for remote URLs (without
1769         applying any values). If there exists at least one remote URL
1770         that matches this pattern, the include condition is met.
1771 </p>
1772 <div class="paragraph"><p>Files included by this option (directly or indirectly) are not allowed
1773 to contain remote URLs.</p></div>
1774 <div class="paragraph"><p>Note that unlike other includeIf conditions, resolving this condition
1775 relies on information that is not yet known at the point of reading the
1776 condition. A typical use case is this option being present as a
1777 system-level or global-level config, and the remote URL being in a
1778 local-level config; hence the need to scan ahead when resolving this
1779 condition. In order to avoid the chicken-and-egg problem in which
1780 potentially-included files can affect whether such files are potentially
1781 included, Git breaks the cycle by prohibiting these files from affecting
1782 the resolution of these conditions (thus, prohibiting them from
1783 declaring remote URLs).</p></div>
1784 <div class="paragraph"><p>As for the naming of this keyword, it is for forwards compatibility with
1785 a naming scheme that supports more variable-based include conditions,
1786 but currently Git only supports the exact keyword described above.</p></div>
1787 </dd>
1788 </dl></div>
1789 <div class="paragraph"><p>A few more notes on matching via <code>gitdir</code> and <code>gitdir/i</code>:</p></div>
1790 <div class="ulist"><ul>
1791 <li>
1792 <p>
1793 Symlinks in <code>$GIT_DIR</code> are not resolved before matching.
1794 </p>
1795 </li>
1796 <li>
1797 <p>
1798 Both the symlink &amp; realpath versions of paths will be matched
1799    outside of <code>$GIT_DIR</code>. E.g. if ~/git is a symlink to
1800    /mnt/storage/git, both <code>gitdir:~/git</code> and <code>gitdir:/mnt/storage/git</code>
1801    will match.
1802 </p>
1803 <div class="paragraph"><p>This was not the case in the initial release of this feature in
1804 v2.13.0, which only matched the realpath version. Configuration that
1805 wants to be compatible with the initial release of this feature needs
1806 to either specify only the realpath version, or both versions.</p></div>
1807 </li>
1808 <li>
1809 <p>
1810 Note that "../" is not special and will match literally, which is
1811    unlikely what you want.
1812 </p>
1813 </li>
1814 </ul></div>
1815 </div>
1816 <div class="sect2">
1817 <h3 id="_example">Example</h3>
1818 <div class="listingblock">
1819 <div class="content">
1820 <pre><code># Core variables
1821 [core]
1822         ; Don't trust file modes
1823         filemode = false
1824
1825 # Our diff algorithm
1826 [diff]
1827         external = /usr/local/bin/diff-wrapper
1828         renames = true
1829
1830 [branch "devel"]
1831         remote = origin
1832         merge = refs/heads/devel
1833
1834 # Proxy settings
1835 [core]
1836         gitProxy="ssh" for "kernel.org"
1837         gitProxy=default-proxy ; for the rest
1838
1839 [include]
1840         path = /path/to/foo.inc ; include by absolute path
1841         path = foo.inc ; find "foo.inc" relative to the current file
1842         path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
1843
1844 ; include if $GIT_DIR is /path/to/foo/.git
1845 [includeIf "gitdir:/path/to/foo/.git"]
1846         path = /path/to/foo.inc
1847
1848 ; include for all repositories inside /path/to/group
1849 [includeIf "gitdir:/path/to/group/"]
1850         path = /path/to/foo.inc
1851
1852 ; include for all repositories inside $HOME/to/group
1853 [includeIf "gitdir:~/to/group/"]
1854         path = /path/to/foo.inc
1855
1856 ; relative paths are always relative to the including
1857 ; file (if the condition is true); their location is not
1858 ; affected by the condition
1859 [includeIf "gitdir:/path/to/group/"]
1860         path = foo.inc
1861
1862 ; include only if we are in a worktree where foo-branch is
1863 ; currently checked out
1864 [includeIf "onbranch:foo-branch"]
1865         path = foo.inc
1866
1867 ; include only if a remote with the given URL exists (note
1868 ; that such a URL may be provided later in a file or in a
1869 ; file read after this file is read, as seen in this example)
1870 [includeIf "hasconfig:remote.*.url:https://example.com/**"]
1871         path = foo.inc
1872 [remote "origin"]
1873         url = https://example.com/git</code></pre>
1874 </div></div>
1875 </div>
1876 <div class="sect2">
1877 <h3 id="_values">Values</h3>
1878 <div class="paragraph"><p>Values of many variables are treated as a simple string, but there
1879 are variables that take values of specific types and there are rules
1880 as to how to spell them.</p></div>
1881 <div class="dlist"><dl>
1882 <dt class="hdlist1">
1883 boolean
1884 </dt>
1885 <dd>
1886 <p>
1887        When a variable is said to take a boolean value, many
1888        synonyms are accepted for <em>true</em> and <em>false</em>; these are all
1889        case-insensitive.
1890 </p>
1891 <div class="dlist"><dl>
1892 <dt class="hdlist1">
1893 true
1894 </dt>
1895 <dd>
1896 <p>
1897 Boolean true literals are <code>yes</code>, <code>on</code>, <code>true</code>,
1898                 and <code>1</code>.  Also, a variable defined without <code>= &lt;value&gt;</code>
1899                 is taken as true.
1900 </p>
1901 </dd>
1902 <dt class="hdlist1">
1903 false
1904 </dt>
1905 <dd>
1906 <p>
1907 Boolean false literals are <code>no</code>, <code>off</code>, <code>false</code>,
1908                 <code>0</code> and the empty string.
1909 </p>
1910 <div class="paragraph"><p>When converting a value to its canonical form using the <code>--type=bool</code> type
1911 specifier, <em>git config</em> will ensure that the output is "true" or
1912 "false" (spelled in lowercase).</p></div>
1913 </dd>
1914 </dl></div>
1915 </dd>
1916 <dt class="hdlist1">
1917 integer
1918 </dt>
1919 <dd>
1920 <p>
1921        The value for many variables that specify various sizes can
1922        be suffixed with <code>k</code>, <code>M</code>,&#8230; to mean "scale the number by
1923        1024", "by 1024x1024", etc.
1924 </p>
1925 </dd>
1926 <dt class="hdlist1">
1927 color
1928 </dt>
1929 <dd>
1930 <p>
1931        The value for a variable that takes a color is a list of
1932        colors (at most two, one for foreground and one for background)
1933        and attributes (as many as you want), separated by spaces.
1934 </p>
1935 <div class="paragraph"><p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>,
1936 <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code> and <code>default</code>.  The first
1937 color given is the foreground; the second is the background.  All the
1938 basic colors except <code>normal</code> and <code>default</code> have a bright variant that can
1939 be specified by prefixing the color with <code>bright</code>, like <code>brightred</code>.</p></div>
1940 <div class="paragraph"><p>The color <code>normal</code> makes no change to the color. It is the same as an
1941 empty string, but can be used as the foreground color when specifying a
1942 background color alone (for example, "normal red").</p></div>
1943 <div class="paragraph"><p>The color <code>default</code> explicitly resets the color to the terminal default,
1944 for example to specify a cleared background. Although it varies between
1945 terminals, this is usually not the same as setting to "white black".</p></div>
1946 <div class="paragraph"><p>Colors may also be given as numbers between 0 and 255; these use ANSI
1947 256-color mode (but note that not all terminals may support this).  If
1948 your terminal supports it, you may also specify 24-bit RGB values as
1949 hex, like <code>#ff0ab3</code>.</p></div>
1950 <div class="paragraph"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
1951 <code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters).
1952 The position of any attributes with respect to the colors
1953 (before, after, or in between), doesn&#8217;t matter. Specific attributes may
1954 be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>,
1955 <code>no-ul</code>, etc).</p></div>
1956 <div class="paragraph"><p>The pseudo-attribute <code>reset</code> resets all colors and attributes before
1957 applying the specified coloring. For example, <code>reset green</code> will result
1958 in a green foreground and default background without any active
1959 attributes.</p></div>
1960 <div class="paragraph"><p>An empty color string produces no color effect at all. This can be used
1961 to avoid coloring specific elements without disabling color entirely.</p></div>
1962 <div class="paragraph"><p>For git&#8217;s pre-defined color slots, the attributes are meant to be reset
1963 at the beginning of each item in the colored output. So setting
1964 <code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a
1965 plain <code>black</code>, even if the previous thing on the same output line (e.g.
1966 opening parenthesis before the list of branch names in <code>log --decorate</code>
1967 output) is set to be painted with <code>bold</code> or some other attribute.
1968 However, custom log formats may do more complicated and layered
1969 coloring, and the negated forms may be useful there.</p></div>
1970 </dd>
1971 <dt class="hdlist1">
1972 pathname
1973 </dt>
1974 <dd>
1975 <p>
1976         A variable that takes a pathname value can be given a
1977         string that begins with "<code>~/</code>" or "<code>~user/</code>", and the usual
1978         tilde expansion happens to such a string: <code>~/</code>
1979         is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the
1980         specified user&#8217;s home directory.
1981 </p>
1982 <div class="paragraph"><p>If a path starts with <code>%(prefix)/</code>, the remainder is interpreted as a
1983 path relative to Git&#8217;s "runtime prefix", i.e. relative to the location
1984 where Git itself was installed. For example, <code>%(prefix)/bin/</code> refers to
1985 the directory in which the Git executable itself lives. If Git was
1986 compiled without runtime prefix support, the compiled-in prefix will be
1987 substituted instead. In the unlikely event that a literal path needs to
1988 be specified that should <em>not</em> be expanded, it needs to be prefixed by
1989 <code>./</code>, like so: <code>./%(prefix)/bin</code>.</p></div>
1990 </dd>
1991 </dl></div>
1992 </div>
1993 <div class="sect2">
1994 <h3 id="_variables">Variables</h3>
1995 <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
1996 For command-specific variables, you will find a more detailed description
1997 in the appropriate manual page.</p></div>
1998 <div class="paragraph"><p>Other git-related tools may and do use their own variables.  When
1999 inventing new variables for use in your own tool, make sure their
2000 names do not conflict with those that are used by Git itself and
2001 other popular tools, and describe them in your documentation.</p></div>
2002 <div class="dlist"><dl>
2003 <dt class="hdlist1">
2004 add.ignoreErrors
2005 </dt>
2006 <dt class="hdlist1">
2007 add.ignore-errors (deprecated)
2008 </dt>
2009 <dd>
2010 <p>
2011         Tells <em>git add</em> to continue adding files when some files cannot be
2012         added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
2013         option of <a href="git-add.html">git-add(1)</a>.  <code>add.ignore-errors</code> is deprecated,
2014         as it does not follow the usual naming convention for configuration
2015         variables.
2016 </p>
2017 </dd>
2018 <dt class="hdlist1">
2019 add.interactive.useBuiltin
2020 </dt>
2021 <dd>
2022 <p>
2023         Unused configuration variable. Used in Git versions v2.25.0 to
2024         v2.36.0 to enable the built-in version of <a href="git-add.html">git-add(1)</a>'s
2025         interactive mode, which then became the default in Git
2026         versions v2.37.0 to v2.39.0.
2027 </p>
2028 </dd>
2029 <dt class="hdlist1">
2030 advice.*
2031 </dt>
2032 <dd>
2033 <p>
2034         These variables control various optional help messages designed to
2035         aid new users.  When left unconfigured, Git will give the message
2036         alongside instructions on how to squelch it.  You can tell Git
2037         that you do not need the help message by setting these to <code>false</code>:
2038 </p>
2039 <div class="openblock">
2040 <div class="content">
2041 <div class="dlist"><dl>
2042 <dt class="hdlist1">
2043 addEmbeddedRepo
2044 </dt>
2045 <dd>
2046 <p>
2047                 Shown when the user accidentally adds one
2048                 git repo inside of another.
2049 </p>
2050 </dd>
2051 <dt class="hdlist1">
2052 addEmptyPathspec
2053 </dt>
2054 <dd>
2055 <p>
2056                 Shown when the user runs <code>git add</code> without providing
2057                 the pathspec parameter.
2058 </p>
2059 </dd>
2060 <dt class="hdlist1">
2061 addIgnoredFile
2062 </dt>
2063 <dd>
2064 <p>
2065                 Shown when the user attempts to add an ignored file to
2066                 the index.
2067 </p>
2068 </dd>
2069 <dt class="hdlist1">
2070 amWorkDir
2071 </dt>
2072 <dd>
2073 <p>
2074                 Shown when <a href="git-am.html">git-am(1)</a> fails to apply a patch
2075                 file, to tell the user the location of the file.
2076 </p>
2077 </dd>
2078 <dt class="hdlist1">
2079 ambiguousFetchRefspec
2080 </dt>
2081 <dd>
2082 <p>
2083                 Shown when a fetch refspec for multiple remotes maps to
2084                 the same remote-tracking branch namespace and causes branch
2085                 tracking set-up to fail.
2086 </p>
2087 </dd>
2088 <dt class="hdlist1">
2089 checkoutAmbiguousRemoteBranchName
2090 </dt>
2091 <dd>
2092 <p>
2093                 Shown when the argument to
2094                 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
2095                 ambiguously resolves to a
2096                 remote tracking branch on more than one remote in
2097                 situations where an unambiguous argument would have
2098                 otherwise caused a remote-tracking branch to be
2099                 checked out. See the <code>checkout.defaultRemote</code>
2100                 configuration variable for how to set a given remote
2101                 to be used by default in some situations where this
2102                 advice would be printed.
2103 </p>
2104 </dd>
2105 <dt class="hdlist1">
2106 commitBeforeMerge
2107 </dt>
2108 <dd>
2109 <p>
2110                 Shown when <a href="git-merge.html">git-merge(1)</a> refuses to
2111                 merge to avoid overwriting local changes.
2112 </p>
2113 </dd>
2114 <dt class="hdlist1">
2115 detachedHead
2116 </dt>
2117 <dd>
2118 <p>
2119                 Shown when the user uses
2120                 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
2121                 to move to the detached HEAD state, to tell the user how
2122                 to create a local branch after the fact.
2123 </p>
2124 </dd>
2125 <dt class="hdlist1">
2126 diverging
2127 </dt>
2128 <dd>
2129 <p>
2130                 Shown when a fast-forward is not possible.
2131 </p>
2132 </dd>
2133 <dt class="hdlist1">
2134 fetchShowForcedUpdates
2135 </dt>
2136 <dd>
2137 <p>
2138                 Shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
2139                 to calculate forced updates after ref updates, or to warn
2140                 that the check is disabled.
2141 </p>
2142 </dd>
2143 <dt class="hdlist1">
2144 forceDeleteBranch
2145 </dt>
2146 <dd>
2147 <p>
2148                 Shown when the user tries to delete a not fully merged
2149                 branch without the force option set.
2150 </p>
2151 </dd>
2152 <dt class="hdlist1">
2153 ignoredHook
2154 </dt>
2155 <dd>
2156 <p>
2157                 Shown when a hook is ignored because the hook is not
2158                 set as executable.
2159 </p>
2160 </dd>
2161 <dt class="hdlist1">
2162 implicitIdentity
2163 </dt>
2164 <dd>
2165 <p>
2166                 Shown when the user&#8217;s information is guessed from the
2167                 system username and domain name, to tell the user how to
2168                 set their identity configuration.
2169 </p>
2170 </dd>
2171 <dt class="hdlist1">
2172 mergeConflict
2173 </dt>
2174 <dd>
2175 <p>
2176                 Shown when various commands stop because of conflicts.
2177 </p>
2178 </dd>
2179 <dt class="hdlist1">
2180 nestedTag
2181 </dt>
2182 <dd>
2183 <p>
2184                 Shown when a user attempts to recursively tag a tag object.
2185 </p>
2186 </dd>
2187 <dt class="hdlist1">
2188 pushAlreadyExists
2189 </dt>
2190 <dd>
2191 <p>
2192                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2193                 does not qualify for fast-forwarding (e.g., a tag.)
2194 </p>
2195 </dd>
2196 <dt class="hdlist1">
2197 pushFetchFirst
2198 </dt>
2199 <dd>
2200 <p>
2201                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2202                 tries to overwrite a remote ref that points at an
2203                 object we do not have.
2204 </p>
2205 </dd>
2206 <dt class="hdlist1">
2207 pushNeedsForce
2208 </dt>
2209 <dd>
2210 <p>
2211                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2212                 tries to overwrite a remote ref that points at an
2213                 object that is not a commit-ish, or make the remote
2214                 ref point at an object that is not a commit-ish.
2215 </p>
2216 </dd>
2217 <dt class="hdlist1">
2218 pushNonFFCurrent
2219 </dt>
2220 <dd>
2221 <p>
2222                 Shown when <a href="git-push.html">git-push(1)</a> fails due to a
2223                 non-fast-forward update to the current branch.
2224 </p>
2225 </dd>
2226 <dt class="hdlist1">
2227 pushNonFFMatching
2228 </dt>
2229 <dd>
2230 <p>
2231                 Shown when the user ran <a href="git-push.html">git-push(1)</a> and pushed
2232                 "matching refs" explicitly (i.e. used <code>:</code>, or
2233                 specified a refspec that isn&#8217;t the current branch) and
2234                 it resulted in a non-fast-forward error.
2235 </p>
2236 </dd>
2237 <dt class="hdlist1">
2238 pushRefNeedsUpdate
2239 </dt>
2240 <dd>
2241 <p>
2242                 Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
2243                 a branch when its remote-tracking ref has updates that we
2244                 do not have locally.
2245 </p>
2246 </dd>
2247 <dt class="hdlist1">
2248 pushUnqualifiedRefname
2249 </dt>
2250 <dd>
2251 <p>
2252                 Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
2253                 guess based on the source and destination refs what
2254                 remote ref namespace the source belongs in, but where
2255                 we can still suggest that the user push to either
2256                 <code>refs/heads/*</code> or <code>refs/tags/*</code> based on the type of the
2257                 source object.
2258 </p>
2259 </dd>
2260 <dt class="hdlist1">
2261 pushUpdateRejected
2262 </dt>
2263 <dd>
2264 <p>
2265                 Set this variable to <code>false</code> if you want to disable
2266                 <code>pushNonFFCurrent</code>, <code>pushNonFFMatching</code>, <code>pushAlreadyExists</code>,
2267                 <code>pushFetchFirst</code>, <code>pushNeedsForce</code>, and <code>pushRefNeedsUpdate</code>
2268                 simultaneously.
2269 </p>
2270 </dd>
2271 <dt class="hdlist1">
2272 refSyntax
2273 </dt>
2274 <dd>
2275 <p>
2276                 Shown when the user provides an illegal ref name, to
2277                 tell the user about the ref syntax documentation.
2278 </p>
2279 </dd>
2280 <dt class="hdlist1">
2281 resetNoRefresh
2282 </dt>
2283 <dd>
2284 <p>
2285                 Shown when <a href="git-reset.html">git-reset(1)</a> takes more than 2
2286                 seconds to refresh the index after reset, to tell the user
2287                 that they can use the <code>--no-refresh</code> option.
2288 </p>
2289 </dd>
2290 <dt class="hdlist1">
2291 resolveConflict
2292 </dt>
2293 <dd>
2294 <p>
2295                 Shown by various commands when conflicts
2296                 prevent the operation from being performed.
2297 </p>
2298 </dd>
2299 <dt class="hdlist1">
2300 rmHints
2301 </dt>
2302 <dd>
2303 <p>
2304                 Shown on failure in the output of <a href="git-rm.html">git-rm(1)</a>, to
2305                 give directions on how to proceed from the current state.
2306 </p>
2307 </dd>
2308 <dt class="hdlist1">
2309 sequencerInUse
2310 </dt>
2311 <dd>
2312 <p>
2313                 Shown when a sequencer command is already in progress.
2314 </p>
2315 </dd>
2316 <dt class="hdlist1">
2317 skippedCherryPicks
2318 </dt>
2319 <dd>
2320 <p>
2321                 Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
2322                 been cherry-picked onto the upstream branch.
2323 </p>
2324 </dd>
2325 <dt class="hdlist1">
2326 statusAheadBehind
2327 </dt>
2328 <dd>
2329 <p>
2330                 Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
2331                 counts for a local ref compared to its remote tracking ref,
2332                 and that calculation takes longer than expected. Will not
2333                 appear if <code>status.aheadBehind</code> is false or the option
2334                 <code>--no-ahead-behind</code> is given.
2335 </p>
2336 </dd>
2337 <dt class="hdlist1">
2338 statusHints
2339 </dt>
2340 <dd>
2341 <p>
2342                 Show directions on how to proceed from the current
2343                 state in the output of <a href="git-status.html">git-status(1)</a>, in
2344                 the template shown when writing commit messages in
2345                 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
2346                 by <a href="git-switch.html">git-switch(1)</a> or
2347                 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.
2348 </p>
2349 </dd>
2350 <dt class="hdlist1">
2351 statusUoption
2352 </dt>
2353 <dd>
2354 <p>
2355                 Shown when <a href="git-status.html">git-status(1)</a> takes more than 2
2356                 seconds to enumerate untracked files, to tell the user that
2357                 they can use the <code>-u</code> option.
2358 </p>
2359 </dd>
2360 <dt class="hdlist1">
2361 submoduleAlternateErrorStrategyDie
2362 </dt>
2363 <dd>
2364 <p>
2365                 Shown when a submodule.alternateErrorStrategy option
2366                 configured to "die" causes a fatal error.
2367 </p>
2368 </dd>
2369 <dt class="hdlist1">
2370 submoduleMergeConflict
2371 </dt>
2372 <dd>
2373 <p>
2374                 Advice shown when a non-trivial submodule merge conflict is
2375                 encountered.
2376 </p>
2377 </dd>
2378 <dt class="hdlist1">
2379 submodulesNotUpdated
2380 </dt>
2381 <dd>
2382 <p>
2383                 Shown when a user runs a submodule command that fails
2384                 because <code>git submodule update --init</code> was not run.
2385 </p>
2386 </dd>
2387 <dt class="hdlist1">
2388 suggestDetachingHead
2389 </dt>
2390 <dd>
2391 <p>
2392                 Shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
2393                 without the explicit <code>--detach</code> option.
2394 </p>
2395 </dd>
2396 <dt class="hdlist1">
2397 updateSparsePath
2398 </dt>
2399 <dd>
2400 <p>
2401                 Shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
2402                 is asked to update index entries outside the current sparse
2403                 checkout.
2404 </p>
2405 </dd>
2406 <dt class="hdlist1">
2407 waitingForEditor
2408 </dt>
2409 <dd>
2410 <p>
2411                 Shown when Git is waiting for editor input. Relevant
2412                 when e.g. the editor is not launched inside the terminal.
2413 </p>
2414 </dd>
2415 <dt class="hdlist1">
2416 worktreeAddOrphan
2417 </dt>
2418 <dd>
2419 <p>
2420                 Shown when the user tries to create a worktree from an
2421                 invalid reference, to tell the user how to create a new unborn
2422                 branch instead.
2423 </p>
2424 </dd>
2425 </dl></div>
2426 </div></div>
2427 </dd>
2428 <dt class="hdlist1">
2429 alias.*
2430 </dt>
2431 <dd>
2432 <p>
2433         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
2434         after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
2435         <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
2436         confusion and troubles with script usage, aliases that
2437         hide existing Git commands are ignored. Arguments are split by
2438         spaces, the usual shell quoting and escaping are supported.
2439         A quote pair or a backslash can be used to quote them.
2440 </p>
2441 <div class="paragraph"><p>Note that the first word of an alias does not necessarily have to be a
2442 command. It can be a command-line option that will be passed into the
2443 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
2444 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
2445 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
2446 running <code>git loud-rebase</code> would be equivalent to
2447 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
2448 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
2449 where the original command does not.</p></div>
2450 <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
2451 it will be treated as a shell command.  For example, defining
2452 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
2453 <code>git new</code> is equivalent to running the shell command
2454 <code>gitk --all --not ORIG_HEAD</code>.  Note that shell commands will be
2455 executed from the top-level directory of a repository, which may
2456 not necessarily be the current directory.
2457 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
2458 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
2459 </dd>
2460 <dt class="hdlist1">
2461 am.keepcr
2462 </dt>
2463 <dd>
2464 <p>
2465         If true, git-am will call git-mailsplit for patches in mbox format
2466         with parameter <code>--keep-cr</code>. In this case git-mailsplit will
2467         not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
2468         by giving <code>--no-keep-cr</code> from the command line.
2469         See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
2470 </p>
2471 </dd>
2472 <dt class="hdlist1">
2473 am.threeWay
2474 </dt>
2475 <dd>
2476 <p>
2477         By default, <code>git am</code> will fail if the patch does not apply cleanly. When
2478         set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
2479         the patch records the identity of blobs it is supposed to apply to and
2480         we have those blobs available locally (equivalent to giving the <code>--3way</code>
2481         option from the command line). Defaults to <code>false</code>.
2482         See <a href="git-am.html">git-am(1)</a>.
2483 </p>
2484 </dd>
2485 <dt class="hdlist1">
2486 apply.ignoreWhitespace
2487 </dt>
2488 <dd>
2489 <p>
2490         When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
2491         whitespace, in the same way as the <code>--ignore-space-change</code>
2492         option.
2493         When set to one of: no, none, never, false, it tells <em>git apply</em> to
2494         respect all whitespace differences.
2495         See <a href="git-apply.html">git-apply(1)</a>.
2496 </p>
2497 </dd>
2498 <dt class="hdlist1">
2499 apply.whitespace
2500 </dt>
2501 <dd>
2502 <p>
2503         Tells <em>git apply</em> how to handle whitespace, in the same way
2504         as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
2505 </p>
2506 </dd>
2507 <dt class="hdlist1">
2508 attr.tree
2509 </dt>
2510 <dd>
2511 <p>
2512         A reference to a tree in the repository from which to read attributes,
2513         instead of the <code>.gitattributes</code> file in the working tree. In a bare
2514         repository, this defaults to <code>HEAD:.gitattributes</code>. If the value does
2515         not resolve to a valid tree object, an empty tree is used instead.
2516         When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2517         command line option are used, this configuration variable has no effect.
2518 </p>
2519 </dd>
2520 <dt class="hdlist1">
2521 blame.blankBoundary
2522 </dt>
2523 <dd>
2524 <p>
2525         Show blank commit object name for boundary commits in
2526         <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.
2527 </p>
2528 </dd>
2529 <dt class="hdlist1">
2530 blame.coloring
2531 </dt>
2532 <dd>
2533 <p>
2534         This determines the coloring scheme to be applied to blame
2535         output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
2536         or <em>none</em> which is the default.
2537 </p>
2538 </dd>
2539 <dt class="hdlist1">
2540 blame.date
2541 </dt>
2542 <dd>
2543 <p>
2544         Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
2545         If unset the iso format is used. For supported values,
2546         see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.
2547 </p>
2548 </dd>
2549 <dt class="hdlist1">
2550 blame.showEmail
2551 </dt>
2552 <dd>
2553 <p>
2554         Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
2555         This option defaults to false.
2556 </p>
2557 </dd>
2558 <dt class="hdlist1">
2559 blame.showRoot
2560 </dt>
2561 <dd>
2562 <p>
2563         Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
2564         This option defaults to false.
2565 </p>
2566 </dd>
2567 <dt class="hdlist1">
2568 blame.ignoreRevsFile
2569 </dt>
2570 <dd>
2571 <p>
2572         Ignore revisions listed in the file, one unabbreviated object name per
2573         line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
2574         <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
2575         file names will reset the list of ignored revisions.  This option will
2576         be handled before the command line option <code>--ignore-revs-file</code>.
2577 </p>
2578 </dd>
2579 <dt class="hdlist1">
2580 blame.markUnblamableLines
2581 </dt>
2582 <dd>
2583 <p>
2584         Mark lines that were changed by an ignored revision that we could not
2585         attribute to another commit with a <em>*</em> in the output of
2586         <a href="git-blame.html">git-blame(1)</a>.
2587 </p>
2588 </dd>
2589 <dt class="hdlist1">
2590 blame.markIgnoredLines
2591 </dt>
2592 <dd>
2593 <p>
2594         Mark lines that were changed by an ignored revision that we attributed to
2595         another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.
2596 </p>
2597 </dd>
2598 <dt class="hdlist1">
2599 branch.autoSetupMerge
2600 </dt>
2601 <dd>
2602 <p>
2603         Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
2604         so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
2605         starting point branch. Note that even if this option is not set,
2606         this behavior can be chosen per-branch using the <code>--track</code>
2607         and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
2608         automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
2609         starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;        automatic setup is done when the starting point is either a
2610         local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
2611         has a tracking configuration, it is copied to the new
2612         branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
2613         is a remote-tracking branch and the new branch has the same name as the
2614         remote branch. This option defaults to true.
2615 </p>
2616 </dd>
2617 <dt class="hdlist1">
2618 branch.autoSetupRebase
2619 </dt>
2620 <dd>
2621 <p>
2622         When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
2623         that tracks another branch, this variable tells Git to set
2624         up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
2625         When <code>never</code>, rebase is never automatically set to true.
2626         When <code>local</code>, rebase is set to true for tracked branches of
2627         other local branches.
2628         When <code>remote</code>, rebase is set to true for tracked branches of
2629         remote-tracking branches.
2630         When <code>always</code>, rebase will be set to true for all tracking
2631         branches.
2632         See "branch.autoSetupMerge" for details on how to set up a
2633         branch to track another branch.
2634         This option defaults to never.
2635 </p>
2636 </dd>
2637 <dt class="hdlist1">
2638 branch.sort
2639 </dt>
2640 <dd>
2641 <p>
2642         This variable controls the sort ordering of branches when displayed by
2643         <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
2644         value of this variable will be used as the default.
2645         See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.
2646 </p>
2647 </dd>
2648 <dt class="hdlist1">
2649 branch.&lt;name&gt;.remote
2650 </dt>
2651 <dd>
2652 <p>
2653         When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
2654         which remote to fetch from or push to.  The remote to push to
2655         may be overridden with <code>remote.pushDefault</code> (for all branches).
2656         The remote to push to, for the current branch, may be further
2657         overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
2658         configured, or if you are not on any branch and there is more than
2659         one remote defined in the repository, it defaults to <code>origin</code> for
2660         fetching and <code>remote.pushDefault</code> for pushing.
2661         Additionally, <code>.</code> (a period) is the current local repository
2662         (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
2663 </p>
2664 </dd>
2665 <dt class="hdlist1">
2666 branch.&lt;name&gt;.pushRemote
2667 </dt>
2668 <dd>
2669 <p>
2670         When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
2671         pushing.  It also overrides <code>remote.pushDefault</code> for pushing
2672         from branch &lt;name&gt;.  When you pull from one place (e.g. your
2673         upstream) and push to another place (e.g. your own publishing
2674         repository), you would want to set <code>remote.pushDefault</code> to
2675         specify the remote to push to for all branches, and use this
2676         option to override it for a specific branch.
2677 </p>
2678 </dd>
2679 <dt class="hdlist1">
2680 branch.&lt;name&gt;.merge
2681 </dt>
2682 <dd>
2683 <p>
2684         Defines, together with branch.&lt;name&gt;.remote, the upstream branch
2685         for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
2686         branch to merge and can also affect <em>git push</em> (see push.default).
2687         When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
2688         refspec to be marked for merging in FETCH_HEAD. The value is
2689         handled like the remote part of a refspec, and must match a
2690         ref which is fetched from the remote given by
2691         "branch.&lt;name&gt;.remote".
2692         The merge information is used by <em>git pull</em> (which first calls
2693         <em>git fetch</em>) to lookup the default branch for merging. Without
2694         this option, <em>git pull</em> defaults to merge the first refspec fetched.
2695         Specify multiple values to get an octopus merge.
2696         If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
2697         another branch in the local repository, you can point
2698         branch.&lt;name&gt;.merge to the desired branch, and use the relative path
2699         setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
2700 </p>
2701 </dd>
2702 <dt class="hdlist1">
2703 branch.&lt;name&gt;.mergeOptions
2704 </dt>
2705 <dd>
2706 <p>
2707         Sets default options for merging into branch &lt;name&gt;. The syntax and
2708         supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
2709         option values containing whitespace characters are currently not
2710         supported.
2711 </p>
2712 </dd>
2713 <dt class="hdlist1">
2714 branch.&lt;name&gt;.rebase
2715 </dt>
2716 <dd>
2717 <p>
2718         When true, rebase the branch &lt;name&gt; on top of the fetched branch,
2719         instead of merging the default branch from the default remote when
2720         "git pull" is run. See "pull.rebase" for doing this in a non
2721         branch-specific manner.
2722 </p>
2723 <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>
2724 so that the local merge commits are included in the rebase (see
2725 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
2726 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
2727 mode.</p></div>
2728 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
2729 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
2730 for details).</p></div>
2731 </dd>
2732 <dt class="hdlist1">
2733 branch.&lt;name&gt;.description
2734 </dt>
2735 <dd>
2736 <p>
2737         Branch description, can be edited with
2738         <code>git branch --edit-description</code>. Branch description is
2739         automatically added to the format-patch cover letter or
2740         request-pull summary.
2741 </p>
2742 </dd>
2743 <dt class="hdlist1">
2744 browser.&lt;tool&gt;.cmd
2745 </dt>
2746 <dd>
2747 <p>
2748         Specify the command to invoke the specified browser. The
2749         specified command is evaluated in shell with the URLs passed
2750         as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
2751 </p>
2752 </dd>
2753 <dt class="hdlist1">
2754 browser.&lt;tool&gt;.path
2755 </dt>
2756 <dd>
2757 <p>
2758         Override the path for the given tool that may be used to
2759         browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
2760         working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
2761 </p>
2762 </dd>
2763 <dt class="hdlist1">
2764 bundle.*
2765 </dt>
2766 <dd>
2767 <p>
2768         The <code>bundle.*</code> keys may appear in a bundle list file found via the
2769         <code>git clone --bundle-uri</code> option. These keys currently have no effect
2770         if placed in a repository config file, though this will change in the
2771         future. See <a href="technical/bundle-uri.html">the bundle URI design
2772         document</a> for more details.
2773 </p>
2774 </dd>
2775 <dt class="hdlist1">
2776 bundle.version
2777 </dt>
2778 <dd>
2779 <p>
2780         This integer value advertises the version of the bundle list format
2781         used by the bundle list. Currently, the only accepted value is <code>1</code>.
2782 </p>
2783 </dd>
2784 <dt class="hdlist1">
2785 bundle.mode
2786 </dt>
2787 <dd>
2788 <p>
2789         This string value should be either <code>all</code> or <code>any</code>. This value describes
2790         whether all of the advertised bundles are required to unbundle a
2791         complete understanding of the bundled information (<code>all</code>) or if any one
2792         of the listed bundle URIs is sufficient (<code>any</code>).
2793 </p>
2794 </dd>
2795 <dt class="hdlist1">
2796 bundle.heuristic
2797 </dt>
2798 <dd>
2799 <p>
2800         If this string-valued key exists, then the bundle list is designed to
2801         work well with incremental <code>git fetch</code> commands. The heuristic signals
2802         that there are additional keys available for each bundle that help
2803         determine which subset of bundles the client should download. The
2804         only value currently understood is <code>creationToken</code>.
2805 </p>
2806 </dd>
2807 <dt class="hdlist1">
2808 bundle.&lt;id&gt;.*
2809 </dt>
2810 <dd>
2811 <p>
2812         The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
2813         bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.
2814 </p>
2815 </dd>
2816 <dt class="hdlist1">
2817 bundle.&lt;id&gt;.uri
2818 </dt>
2819 <dd>
2820 <p>
2821         This string value defines the URI by which Git can reach the contents
2822         of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.
2823 </p>
2824 </dd>
2825 <dt class="hdlist1">
2826 checkout.defaultRemote
2827 </dt>
2828 <dd>
2829 <p>
2830         When you run <code>git checkout &lt;something&gt;</code>
2831         or <code>git switch &lt;something&gt;</code> and only have one
2832         remote, it may implicitly fall back on checking out and
2833         tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
2834         as you have more than one remote with a <code>&lt;something&gt;</code>
2835         reference. This setting allows for setting the name of a
2836         preferred remote that should always win when it comes to
2837         disambiguation. The typical use-case is to set this to
2838         <code>origin</code>.
2839 </p>
2840 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
2841 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
2842 or <code>git switch &lt;something&gt;</code>
2843 will checkout the <code>&lt;something&gt;</code> branch on another remote,
2844 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
2845 remote branch. This setting might be used for other checkout-like
2846 commands or functionality in the future.</p></div>
2847 </dd>
2848 <dt class="hdlist1">
2849 checkout.guess
2850 </dt>
2851 <dd>
2852 <p>
2853         Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
2854         option in <code>git checkout</code> and <code>git switch</code>. See
2855         <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
2856 </p>
2857 </dd>
2858 <dt class="hdlist1">
2859 checkout.workers
2860 </dt>
2861 <dd>
2862 <p>
2863         The number of parallel workers to use when updating the working tree.
2864         The default is one, i.e. sequential execution. If set to a value less
2865         than one, Git will use as many workers as the number of logical cores
2866         available. This setting and <code>checkout.thresholdForParallelism</code> affect
2867         all commands that perform checkout. E.g. checkout, clone, reset,
2868         sparse-checkout, etc.
2869 </p>
2870 <div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories
2871 located on SSDs or over NFS. For repositories on spinning disks and/or machines
2872 with a small number of cores, the default sequential checkout often performs
2873 better. The size and compression level of a repository might also influence how
2874 well the parallel version performs.</p></div>
2875 </dd>
2876 <dt class="hdlist1">
2877 checkout.thresholdForParallelism
2878 </dt>
2879 <dd>
2880 <p>
2881         When running parallel checkout with a small number of files, the cost
2882         of subprocess spawning and inter-process communication might outweigh
2883         the parallelization gains. This setting allows you to define the minimum
2884         number of files for which parallel checkout should be attempted. The
2885         default is 100.
2886 </p>
2887 </dd>
2888 <dt class="hdlist1">
2889 clean.requireForce
2890 </dt>
2891 <dd>
2892 <p>
2893         A boolean to make git-clean refuse to delete files unless -f
2894         is given. Defaults to true.
2895 </p>
2896 </dd>
2897 <dt class="hdlist1">
2898 <code>clone.defaultRemoteName</code>
2899 </dt>
2900 <dd>
2901 <p>
2902         The name of the remote to create when cloning a repository.  Defaults to
2903         <code>origin</code>.
2904         It can be overridden by passing the <code>--origin</code> command-line
2905         option to <a href="git-clone.html">git-clone(1)</a>.
2906 </p>
2907 </dd>
2908 <dt class="hdlist1">
2909 <code>clone.rejectShallow</code>
2910 </dt>
2911 <dd>
2912 <p>
2913         Reject cloning a repository if it is a shallow one; this can be overridden by
2914         passing the <code>--reject-shallow</code> option on the command line.
2915         See <a href="git-clone.html">git-clone(1)</a>.
2916 </p>
2917 </dd>
2918 <dt class="hdlist1">
2919 <code>clone.filterSubmodules</code>
2920 </dt>
2921 <dd>
2922 <p>
2923         If a partial clone filter is provided (see <code>--filter</code> in
2924         <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
2925         the filter to submodules.
2926 </p>
2927 </dd>
2928 <dt class="hdlist1">
2929 color.advice
2930 </dt>
2931 <dd>
2932 <p>
2933         A boolean to enable/disable color in hints (e.g. when a push
2934         failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
2935         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
2936         are used only when the error output goes to a terminal. If
2937         unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
2938 </p>
2939 </dd>
2940 <dt class="hdlist1">
2941 color.advice.hint
2942 </dt>
2943 <dd>
2944 <p>
2945         Use customized color for hints.
2946 </p>
2947 </dd>
2948 <dt class="hdlist1">
2949 color.blame.highlightRecent
2950 </dt>
2951 <dd>
2952 <p>
2953         Specify the line annotation color for <code>git blame --color-by-age</code>
2954         depending upon the age of the line.
2955 </p>
2956 <div class="paragraph"><p>This setting should be set to a comma-separated list of color and
2957 date settings, starting and ending with a color, the dates should be
2958 set from oldest to newest. The metadata will be colored with the
2959 specified colors if the line was introduced before the given
2960 timestamp, overwriting older timestamped colors.</p></div>
2961 <div class="paragraph"><p>Instead of an absolute timestamp relative timestamps work as well,
2962 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
2963 <div class="paragraph"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
2964 colors everything older than one year blue, recent changes between
2965 one month and one year old are kept white, and lines introduced
2966 within the last month are colored red.</p></div>
2967 </dd>
2968 <dt class="hdlist1">
2969 color.blame.repeatedLines
2970 </dt>
2971 <dd>
2972 <p>
2973         Use the specified color to colorize line annotations for
2974         <code>git blame --color-lines</code>, if they come from the same commit as the
2975         preceding line. Defaults to cyan.
2976 </p>
2977 </dd>
2978 <dt class="hdlist1">
2979 color.branch
2980 </dt>
2981 <dd>
2982 <p>
2983         A boolean to enable/disable color in the output of
2984         <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
2985         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
2986         only when the output is to a terminal. If unset, then the
2987         value of <code>color.ui</code> is used (<code>auto</code> by default).
2988 </p>
2989 </dd>
2990 <dt class="hdlist1">
2991 color.branch.&lt;slot&gt;
2992 </dt>
2993 <dd>
2994 <p>
2995         Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
2996         <code>current</code> (the current branch), <code>local</code> (a local branch),
2997         <code>remote</code> (a remote-tracking branch in refs/remotes/),
2998         <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
2999         refs).
3000 </p>
3001 </dd>
3002 <dt class="hdlist1">
3003 color.diff
3004 </dt>
3005 <dd>
3006 <p>
3007         Whether to use ANSI escape sequences to add color to patches.
3008         If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
3009         <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
3010         for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
3011         commands will only use color when output is to the terminal.
3012         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
3013         default).
3014 </p>
3015 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
3016 <em>git-diff-&#42;</em> plumbing commands.  Can be overridden on the
3017 command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
3018 </dd>
3019 <dt class="hdlist1">
3020 color.diff.&lt;slot&gt;
3021 </dt>
3022 <dd>
3023 <p>
3024         Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
3025         which part of the patch to use the specified color, and is one
3026         of <code>context</code> (context text - <code>plain</code> is a historical synonym),
3027         <code>meta</code> (metainformation), <code>frag</code>
3028         (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
3029         <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
3030         (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
3031         <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
3032         <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
3033         <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
3034         setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
3035         <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
3036         <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).
3037 </p>
3038 </dd>
3039 <dt class="hdlist1">
3040 color.decorate.&lt;slot&gt;
3041 </dt>
3042 <dd>
3043 <p>
3044         Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
3045         of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
3046         branches, remote-tracking branches, tags, stash and HEAD, respectively
3047         and <code>grafted</code> for grafted commits.
3048 </p>
3049 </dd>
3050 <dt class="hdlist1">
3051 color.grep
3052 </dt>
3053 <dd>
3054 <p>
3055         When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
3056         <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
3057         when the output is written to the terminal.  If unset, then the
3058         value of <code>color.ui</code> is used (<code>auto</code> by default).
3059 </p>
3060 </dd>
3061 <dt class="hdlist1">
3062 color.grep.&lt;slot&gt;
3063 </dt>
3064 <dd>
3065 <p>
3066         Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
3067         part of the line to use the specified color, and is one of
3068 </p>
3069 <div class="openblock">
3070 <div class="content">
3071 <div class="dlist"><dl>
3072 <dt class="hdlist1">
3073 <code>context</code>
3074 </dt>
3075 <dd>
3076 <p>
3077         non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
3078 </p>
3079 </dd>
3080 <dt class="hdlist1">
3081 <code>filename</code>
3082 </dt>
3083 <dd>
3084 <p>
3085         filename prefix (when not using <code>-h</code>)
3086 </p>
3087 </dd>
3088 <dt class="hdlist1">
3089 <code>function</code>
3090 </dt>
3091 <dd>
3092 <p>
3093         function name lines (when using <code>-p</code>)
3094 </p>
3095 </dd>
3096 <dt class="hdlist1">
3097 <code>lineNumber</code>
3098 </dt>
3099 <dd>
3100 <p>
3101         line number prefix (when using <code>-n</code>)
3102 </p>
3103 </dd>
3104 <dt class="hdlist1">
3105 <code>column</code>
3106 </dt>
3107 <dd>
3108 <p>
3109         column number prefix (when using <code>--column</code>)
3110 </p>
3111 </dd>
3112 <dt class="hdlist1">
3113 <code>match</code>
3114 </dt>
3115 <dd>
3116 <p>
3117         matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
3118 </p>
3119 </dd>
3120 <dt class="hdlist1">
3121 <code>matchContext</code>
3122 </dt>
3123 <dd>
3124 <p>
3125         matching text in context lines
3126 </p>
3127 </dd>
3128 <dt class="hdlist1">
3129 <code>matchSelected</code>
3130 </dt>
3131 <dd>
3132 <p>
3133         matching text in selected lines. Also, used to customize the following
3134         <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.
3135 </p>
3136 </dd>
3137 <dt class="hdlist1">
3138 <code>selected</code>
3139 </dt>
3140 <dd>
3141 <p>
3142         non-matching text in selected lines. Also, used to customize the
3143         following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
3144         <code>--committer</code>.
3145 </p>
3146 </dd>
3147 <dt class="hdlist1">
3148 <code>separator</code>
3149 </dt>
3150 <dd>
3151 <p>
3152         separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
3153         and between hunks (<code>--</code>)
3154 </p>
3155 </dd>
3156 </dl></div>
3157 </div></div>
3158 </dd>
3159 <dt class="hdlist1">
3160 color.interactive
3161 </dt>
3162 <dd>
3163 <p>
3164         When set to <code>always</code>, always use colors for interactive prompts
3165         and displays (such as those used by "git-add --interactive" and
3166         "git-clean --interactive"). When false (or <code>never</code>), never.
3167         When set to <code>true</code> or <code>auto</code>, use colors only when the output is
3168         to the terminal. If unset, then the value of <code>color.ui</code> is
3169         used (<code>auto</code> by default).
3170 </p>
3171 </dd>
3172 <dt class="hdlist1">
3173 color.interactive.&lt;slot&gt;
3174 </dt>
3175 <dd>
3176 <p>
3177         Use customized color for <em>git add --interactive</em> and <em>git clean
3178         --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
3179         or <code>error</code>, for four distinct types of normal output from
3180         interactive commands.
3181 </p>
3182 </dd>
3183 <dt class="hdlist1">
3184 color.pager
3185 </dt>
3186 <dd>
3187 <p>
3188         A boolean to specify whether <code>auto</code> color modes should colorize
3189         output going to the pager. Defaults to true; set this to false
3190         if your pager does not understand ANSI color codes.
3191 </p>
3192 </dd>
3193 <dt class="hdlist1">
3194 color.push
3195 </dt>
3196 <dd>
3197 <p>
3198         A boolean to enable/disable color in push errors. May be set to
3199         <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3200         case colors are used only when the error output goes to a terminal.
3201         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3202 </p>
3203 </dd>
3204 <dt class="hdlist1">
3205 color.push.error
3206 </dt>
3207 <dd>
3208 <p>
3209         Use customized color for push errors.
3210 </p>
3211 </dd>
3212 <dt class="hdlist1">
3213 color.remote
3214 </dt>
3215 <dd>
3216 <p>
3217         If set, keywords at the start of the line are highlighted. The
3218         keywords are "error", "warning", "hint" and "success", and are
3219         matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
3220         <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
3221         <code>color.ui</code> is used (<code>auto</code> by default).
3222 </p>
3223 </dd>
3224 <dt class="hdlist1">
3225 color.remote.&lt;slot&gt;
3226 </dt>
3227 <dd>
3228 <p>
3229         Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
3230         <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
3231         corresponding keyword.
3232 </p>
3233 </dd>
3234 <dt class="hdlist1">
3235 color.showBranch
3236 </dt>
3237 <dd>
3238 <p>
3239         A boolean to enable/disable color in the output of
3240         <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
3241         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3242         only when the output is to a terminal. If unset, then the
3243         value of <code>color.ui</code> is used (<code>auto</code> by default).
3244 </p>
3245 </dd>
3246 <dt class="hdlist1">
3247 color.status
3248 </dt>
3249 <dd>
3250 <p>
3251         A boolean to enable/disable color in the output of
3252         <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
3253         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3254         only when the output is to a terminal. If unset, then the
3255         value of <code>color.ui</code> is used (<code>auto</code> by default).
3256 </p>
3257 </dd>
3258 <dt class="hdlist1">
3259 color.status.&lt;slot&gt;
3260 </dt>
3261 <dd>
3262 <p>
3263         Use customized color for status colorization. <code>&lt;slot&gt;</code> is
3264         one of <code>header</code> (the header text of the status message),
3265         <code>added</code> or <code>updated</code> (files which are added but not committed),
3266         <code>changed</code> (files which are changed but not added in the index),
3267         <code>untracked</code> (files which are not tracked by Git),
3268         <code>branch</code> (the current branch),
3269         <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
3270         to red),
3271         <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
3272         respectively, when branch and tracking information is displayed in the
3273         status short-format), or
3274         <code>unmerged</code> (files which have unmerged changes).
3275 </p>
3276 </dd>
3277 <dt class="hdlist1">
3278 color.transport
3279 </dt>
3280 <dd>
3281 <p>
3282         A boolean to enable/disable color when pushes are rejected. May be
3283         set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3284         case colors are used only when the error output goes to a terminal.
3285         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3286 </p>
3287 </dd>
3288 <dt class="hdlist1">
3289 color.transport.rejected
3290 </dt>
3291 <dd>
3292 <p>
3293         Use customized color when a push was rejected.
3294 </p>
3295 </dd>
3296 <dt class="hdlist1">
3297 color.ui
3298 </dt>
3299 <dd>
3300 <p>
3301         This variable determines the default value for variables such
3302         as <code>color.diff</code> and <code>color.grep</code> that control the use of color
3303         per command family. Its scope will expand as more commands learn
3304         configuration to set a default for the <code>--color</code> option.  Set it
3305         to <code>false</code> or <code>never</code> if you prefer Git commands not to use
3306         color unless enabled explicitly with some other configuration
3307         or the <code>--color</code> option. Set it to <code>always</code> if you want all
3308         output not intended for machine consumption to use color, to
3309         <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
3310         want such output to use color when written to the terminal.
3311 </p>
3312 </dd>
3313 <dt class="hdlist1">
3314 column.ui
3315 </dt>
3316 <dd>
3317 <p>
3318         Specify whether supported commands should output in columns.
3319         This variable consists of a list of tokens separated by spaces
3320         or commas:
3321 </p>
3322 <div class="paragraph"><p>These options control when the feature should be enabled
3323 (defaults to <em>never</em>):</p></div>
3324 <div class="openblock">
3325 <div class="content">
3326 <div class="dlist"><dl>
3327 <dt class="hdlist1">
3328 <code>always</code>
3329 </dt>
3330 <dd>
3331 <p>
3332         always show in columns
3333 </p>
3334 </dd>
3335 <dt class="hdlist1">
3336 <code>never</code>
3337 </dt>
3338 <dd>
3339 <p>
3340         never show in columns
3341 </p>
3342 </dd>
3343 <dt class="hdlist1">
3344 <code>auto</code>
3345 </dt>
3346 <dd>
3347 <p>
3348         show in columns if the output is to the terminal
3349 </p>
3350 </dd>
3351 </dl></div>
3352 </div></div>
3353 <div class="paragraph"><p>These options control layout (defaults to <em>column</em>).  Setting any
3354 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
3355 specified.</p></div>
3356 <div class="openblock">
3357 <div class="content">
3358 <div class="dlist"><dl>
3359 <dt class="hdlist1">
3360 <code>column</code>
3361 </dt>
3362 <dd>
3363 <p>
3364         fill columns before rows
3365 </p>
3366 </dd>
3367 <dt class="hdlist1">
3368 <code>row</code>
3369 </dt>
3370 <dd>
3371 <p>
3372         fill rows before columns
3373 </p>
3374 </dd>
3375 <dt class="hdlist1">
3376 <code>plain</code>
3377 </dt>
3378 <dd>
3379 <p>
3380         show in one column
3381 </p>
3382 </dd>
3383 </dl></div>
3384 </div></div>
3385 <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
3386 to <em>nodense</em>):</p></div>
3387 <div class="openblock">
3388 <div class="content">
3389 <div class="dlist"><dl>
3390 <dt class="hdlist1">
3391 <code>dense</code>
3392 </dt>
3393 <dd>
3394 <p>
3395         make unequal size columns to utilize more space
3396 </p>
3397 </dd>
3398 <dt class="hdlist1">
3399 <code>nodense</code>
3400 </dt>
3401 <dd>
3402 <p>
3403         make equal size columns
3404 </p>
3405 </dd>
3406 </dl></div>
3407 </div></div>
3408 </dd>
3409 <dt class="hdlist1">
3410 column.branch
3411 </dt>
3412 <dd>
3413 <p>
3414         Specify whether to output branch listing in <code>git branch</code> in columns.
3415         See <code>column.ui</code> for details.
3416 </p>
3417 </dd>
3418 <dt class="hdlist1">
3419 column.clean
3420 </dt>
3421 <dd>
3422 <p>
3423         Specify the layout when listing items in <code>git clean -i</code>, which always
3424         shows files and directories in columns. See <code>column.ui</code> for details.
3425 </p>
3426 </dd>
3427 <dt class="hdlist1">
3428 column.status
3429 </dt>
3430 <dd>
3431 <p>
3432         Specify whether to output untracked files in <code>git status</code> in columns.
3433         See <code>column.ui</code> for details.
3434 </p>
3435 </dd>
3436 <dt class="hdlist1">
3437 column.tag
3438 </dt>
3439 <dd>
3440 <p>
3441         Specify whether to output tag listings in <code>git tag</code> in columns.
3442         See <code>column.ui</code> for details.
3443 </p>
3444 </dd>
3445 <dt class="hdlist1">
3446 commit.cleanup
3447 </dt>
3448 <dd>
3449 <p>
3450         This setting overrides the default of the <code>--cleanup</code> option in
3451         <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
3452         default can be useful when you always want to keep lines that begin
3453         with the comment character <code>#</code> in your log message, in which case you
3454         would do <code>git config commit.cleanup whitespace</code> (note that you will
3455         have to remove the help lines that begin with <code>#</code> in the commit log
3456         template yourself, if you do this).
3457 </p>
3458 </dd>
3459 <dt class="hdlist1">
3460 commit.gpgSign
3461 </dt>
3462 <dd>
3463 <p>
3464         A boolean to specify whether all commits should be GPG signed.
3465         Use of this option when doing operations such as rebase can
3466         result in a large number of commits being signed. It may be
3467         convenient to use an agent to avoid typing your GPG passphrase
3468         several times.
3469 </p>
3470 </dd>
3471 <dt class="hdlist1">
3472 commit.status
3473 </dt>
3474 <dd>
3475 <p>
3476         A boolean to enable/disable inclusion of status information in the
3477         commit message template when using an editor to prepare the commit
3478         message.  Defaults to true.
3479 </p>
3480 </dd>
3481 <dt class="hdlist1">
3482 commit.template
3483 </dt>
3484 <dd>
3485 <p>
3486         Specify the pathname of a file to use as the template for
3487         new commit messages.
3488 </p>
3489 </dd>
3490 <dt class="hdlist1">
3491 commit.verbose
3492 </dt>
3493 <dd>
3494 <p>
3495         A boolean or int to specify the level of verbosity with <code>git commit</code>.
3496         See <a href="git-commit.html">git-commit(1)</a>.
3497 </p>
3498 </dd>
3499 <dt class="hdlist1">
3500 commitGraph.generationVersion
3501 </dt>
3502 <dd>
3503 <p>
3504         Specifies the type of generation number version to use when writing
3505         or reading the commit-graph file. If version 1 is specified, then
3506         the corrected commit dates will not be written or read. Defaults to
3507         2.
3508 </p>
3509 </dd>
3510 <dt class="hdlist1">
3511 commitGraph.maxNewFilters
3512 </dt>
3513 <dd>
3514 <p>
3515         Specifies the default value for the <code>--max-new-filters</code> option of <code>git
3516         commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).
3517 </p>
3518 </dd>
3519 <dt class="hdlist1">
3520 commitGraph.readChangedPaths
3521 </dt>
3522 <dd>
3523 <p>
3524         If true, then git will use the changed-path Bloom filters in the
3525         commit-graph file (if it exists, and they are present). Defaults to
3526         true. See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
3527 </p>
3528 </dd>
3529 <dt class="hdlist1">
3530 completion.commands
3531 </dt>
3532 <dd>
3533 <p>
3534         This is only used by git-completion.bash to add or remove
3535         commands from the list of completed commands. Normally only
3536         porcelain commands and a few select others are completed. You
3537         can add more commands, separated by space, in this
3538         variable. Prefixing the command with <em>-</em> will remove it from
3539         the existing list.
3540 </p>
3541 </dd>
3542 <dt class="hdlist1">
3543 core.fileMode
3544 </dt>
3545 <dd>
3546 <p>
3547         Tells Git if the executable bit of files in the working tree
3548         is to be honored.
3549 </p>
3550 <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
3551 marked as executable is checked out, or checks out a
3552 non-executable file with executable bit on.
3553 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
3554 to see if it handles the executable bit correctly
3555 and this variable is automatically set as necessary.</p></div>
3556 <div class="paragraph"><p>A repository, however, may be on a filesystem that handles
3557 the filemode correctly, and this variable is set to <em>true</em>
3558 when created, but later may be made accessible from another
3559 environment that loses the filemode (e.g. exporting ext4 via
3560 CIFS mount, visiting a Cygwin created repository with
3561 Git for Windows or Eclipse).
3562 In such a case it may be necessary to set this variable to <em>false</em>.
3563 See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
3564 <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
3565 </dd>
3566 <dt class="hdlist1">
3567 core.hideDotFiles
3568 </dt>
3569 <dd>
3570 <p>
3571         (Windows-only) If true, mark newly-created directories and files whose
3572         name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
3573         directory is hidden, but no other files starting with a dot.  The
3574         default mode is <em>dotGitOnly</em>.
3575 </p>
3576 </dd>
3577 <dt class="hdlist1">
3578 core.ignoreCase
3579 </dt>
3580 <dd>
3581 <p>
3582         Internal variable which enables various workarounds to enable
3583         Git to work better on filesystems that are not case sensitive,
3584         like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
3585         finds "makefile" when Git expects "Makefile", Git will assume
3586         it is really the same file, and continue to remember it as
3587         "Makefile".
3588 </p>
3589 <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>
3590 will probe and set core.ignoreCase true if appropriate when the repository
3591 is created.</p></div>
3592 <div class="paragraph"><p>Git relies on the proper configuration of this variable for your operating
3593 and file system. Modifying this value may result in unexpected behavior.</p></div>
3594 </dd>
3595 <dt class="hdlist1">
3596 core.precomposeUnicode
3597 </dt>
3598 <dd>
3599 <p>
3600         This option is only used by Mac OS implementation of Git.
3601         When core.precomposeUnicode=true, Git reverts the unicode decomposition
3602         of filenames done by Mac OS. This is useful when sharing a repository
3603         between Mac OS and Linux or Windows.
3604         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
3605         When false, file names are handled fully transparent by Git,
3606         which is backward compatible with older versions of Git.
3607 </p>
3608 </dd>
3609 <dt class="hdlist1">
3610 core.protectHFS
3611 </dt>
3612 <dd>
3613 <p>
3614         If set to true, do not allow checkout of paths that would
3615         be considered equivalent to <code>.git</code> on an HFS+ filesystem.
3616         Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
3617 </p>
3618 </dd>
3619 <dt class="hdlist1">
3620 core.protectNTFS
3621 </dt>
3622 <dd>
3623 <p>
3624         If set to true, do not allow checkout of paths that would
3625         cause problems with the NTFS filesystem, e.g. conflict with
3626         8.3 "short" names.
3627         Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
3628 </p>
3629 </dd>
3630 <dt class="hdlist1">
3631 core.fsmonitor
3632 </dt>
3633 <dd>
3634 <p>
3635         If set to true, enable the built-in file system monitor
3636         daemon for this working directory (<a href="git-fsmonitor&#45;&#45;daemon.html">git-fsmonitor&#45;&#45;daemon(1)</a>).
3637 </p>
3638 <div class="paragraph"><p>Like hook-based file system monitors, the built-in file system monitor
3639 can speed up Git commands that need to refresh the Git index
3640 (e.g. <code>git status</code>) in a working directory with many files.  The
3641 built-in monitor eliminates the need to install and maintain an
3642 external third-party tool.</p></div>
3643 <div class="paragraph"><p>The built-in file system monitor is currently available only on a
3644 limited set of supported platforms.  Currently, this includes Windows
3645 and MacOS.</p></div>
3646 <div class="literalblock">
3647 <div class="content">
3648 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor"
3649 hook command.</code></pre>
3650 </div></div>
3651 <div class="paragraph"><p>This hook command is used to identify all files that may have changed
3652 since the requested date/time. This information is used to speed up
3653 git by avoiding unnecessary scanning of files that have not changed.</p></div>
3654 <div class="paragraph"><p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p></div>
3655 <div class="paragraph"><p>Note that if you concurrently use multiple versions of Git, such
3656 as one version on the command line and another version in an IDE
3657 tool, that the definition of <code>core.fsmonitor</code> was extended to
3658 allow boolean values in addition to hook pathnames.  Git versions
3659 2.35.1 and prior will not understand the boolean values and will
3660 consider the "true" or "false" values as hook pathnames to be
3661 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
3662 V2 and will fall back to no fsmonitor (full scan).  Git versions
3663 prior to 2.26 default to hook protocol V1 and will silently
3664 assume there were no changes to report (no scan), so status
3665 commands may report incomplete results.  For this reason, it is
3666 best to upgrade all of your Git versions before using the built-in
3667 file system monitor.</p></div>
3668 </dd>
3669 <dt class="hdlist1">
3670 core.fsmonitorHookVersion
3671 </dt>
3672 <dd>
3673 <p>
3674         Sets the protocol version to be used when invoking the
3675         "fsmonitor" hook.
3676 </p>
3677 <div class="paragraph"><p>There are currently versions 1 and 2. When this is not set,
3678 version 2 will be tried first and if it fails then version 1
3679 will be tried. Version 1 uses a timestamp as input to determine
3680 which files have changes since that time but some monitors
3681 like Watchman have race conditions when used with a timestamp.
3682 Version 2 uses an opaque string so that the monitor can return
3683 something that can be used to determine what files have changed
3684 without race conditions.</p></div>
3685 </dd>
3686 <dt class="hdlist1">
3687 core.trustctime
3688 </dt>
3689 <dd>
3690 <p>
3691         If false, the ctime differences between the index and the
3692         working tree are ignored; useful when the inode change time
3693         is regularly modified by something outside Git (file system
3694         crawlers and some backup systems).
3695         See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
3696 </p>
3697 </dd>
3698 <dt class="hdlist1">
3699 core.splitIndex
3700 </dt>
3701 <dd>
3702 <p>
3703         If true, the split-index feature of the index will be used.
3704         See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
3705 </p>
3706 </dd>
3707 <dt class="hdlist1">
3708 core.untrackedCache
3709 </dt>
3710 <dd>
3711 <p>
3712         Determines what to do about the untracked cache feature of the
3713         index. It will be kept, if this variable is unset or set to
3714         <code>keep</code>. It will automatically be added if set to <code>true</code>. And
3715         it will automatically be removed, if set to <code>false</code>. Before
3716         setting it to <code>true</code>, you should check that mtime is working
3717         properly on your system.
3718         See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
3719         <code>feature.manyFiles</code> is enabled which sets this setting to
3720         <code>true</code> by default.
3721 </p>
3722 </dd>
3723 <dt class="hdlist1">
3724 core.checkStat
3725 </dt>
3726 <dd>
3727 <p>
3728         When missing or is set to <code>default</code>, many fields in the stat
3729         structure are checked to detect if a file has been modified
3730         since Git looked at it.  When this configuration variable is
3731         set to <code>minimal</code>, sub-second part of mtime and ctime, the
3732         uid and gid of the owner of the file, the inode number (and
3733         the device number, if Git was compiled to use it), are
3734         excluded from the check among these fields, leaving only the
3735         whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
3736         is set) and the filesize to be checked.
3737 </p>
3738 <div class="paragraph"><p>There are implementations of Git that do not leave usable values in
3739 some fields (e.g. JGit); by excluding these fields from the
3740 comparison, the <code>minimal</code> mode may help interoperability when the
3741 same repository is used by these other systems at the same time.</p></div>
3742 </dd>
3743 <dt class="hdlist1">
3744 core.quotePath
3745 </dt>
3746 <dd>
3747 <p>
3748         Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
3749         quote "unusual" characters in the pathname by enclosing the
3750         pathname in double-quotes and escaping those characters with
3751         backslashes in the same way C escapes control characters (e.g.
3752         <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
3753         values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
3754         UTF-8).  If this variable is set to false, bytes higher than
3755         0x80 are not considered "unusual" any more. Double-quotes,
3756         backslash and control characters are always escaped regardless
3757         of the setting of this variable.  A simple space character is
3758         not considered "unusual".  Many commands can output pathnames
3759         completely verbatim using the <code>-z</code> option. The default value
3760         is true.
3761 </p>
3762 </dd>
3763 <dt class="hdlist1">
3764 core.eol
3765 </dt>
3766 <dd>
3767 <p>
3768         Sets the line ending type to use in the working directory for
3769         files that are marked as text (either by having the <code>text</code>
3770         attribute set, or by having <code>text=auto</code> and Git auto-detecting
3771         the contents as text).
3772         Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
3773         native line ending.  The default value is <code>native</code>.  See
3774         <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
3775         conversion. Note that this value is ignored if <code>core.autocrlf</code>
3776         is set to <code>true</code> or <code>input</code>.
3777 </p>
3778 </dd>
3779 <dt class="hdlist1">
3780 core.safecrlf
3781 </dt>
3782 <dd>
3783 <p>
3784         If true, makes Git check if converting <code>CRLF</code> is reversible when
3785         end-of-line conversion is active.  Git will verify if a command
3786         modifies a file in the work tree either directly or indirectly.
3787         For example, committing a file followed by checking out the
3788         same file should yield the original file in the work tree.  If
3789         this is not the case for the current setting of
3790         <code>core.autocrlf</code>, Git will reject the file.  The variable can
3791         be set to "warn", in which case Git will only warn about an
3792         irreversible conversion but continue the operation.
3793 </p>
3794 <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
3795 When it is enabled, Git will convert CRLF to LF during commit and LF to
3796 CRLF during checkout.  A file that contains a mixture of LF and
3797 CRLF before the commit cannot be recreated by Git.  For text
3798 files this is the right thing to do: it corrects line endings
3799 such that we have only LF line endings in the repository.
3800 But for binary files that are accidentally classified as text the
3801 conversion can corrupt data.</p></div>
3802 <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
3803 setting the conversion type explicitly in .gitattributes.  Right
3804 after committing you still have the original file in your work
3805 tree and this file is not yet corrupted.  You can explicitly tell
3806 Git that this file is binary and Git will handle the file
3807 appropriately.</p></div>
3808 <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
3809 mixed line endings and the undesired effect of corrupting binary
3810 files cannot be distinguished.  In both cases CRLFs are removed
3811 in an irreversible way.  For text files this is the right thing
3812 to do because CRLFs are line endings, while for binary files
3813 converting CRLFs corrupts data.</p></div>
3814 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
3815 file identical to the original file for a different setting of
3816 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
3817 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
3818 and could later be checked out with <code>core.eol=crlf</code>, in which case the
3819 resulting file would contain <code>CRLF</code>, although the original file
3820 contained <code>LF</code>.  However, in both work trees the line endings would be
3821 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
3822 file with mixed line endings would be reported by the <code>core.safecrlf</code>
3823 mechanism.</p></div>
3824 </dd>
3825 <dt class="hdlist1">
3826 core.autocrlf
3827 </dt>
3828 <dd>
3829 <p>
3830         Setting this variable to "true" is the same as setting
3831         the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
3832         Set to true if you want to have <code>CRLF</code> line endings in your
3833         working directory and the repository has LF line endings.
3834         This variable can be set to <em>input</em>,
3835         in which case no output conversion is performed.
3836 </p>
3837 </dd>
3838 <dt class="hdlist1">
3839 core.checkRoundtripEncoding
3840 </dt>
3841 <dd>
3842 <p>
3843         A comma and/or whitespace separated list of encodings that Git
3844         performs UTF-8 round trip checks on if they are used in an
3845         <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
3846         The default value is <code>SHIFT-JIS</code>.
3847 </p>
3848 </dd>
3849 <dt class="hdlist1">
3850 core.symlinks
3851 </dt>
3852 <dd>
3853 <p>
3854         If false, symbolic links are checked out as small plain files that
3855         contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
3856         <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
3857         file. Useful on filesystems like FAT that do not support
3858         symbolic links.
3859 </p>
3860 <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>
3861 will probe and set core.symlinks false if appropriate when the repository
3862 is created.</p></div>
3863 </dd>
3864 <dt class="hdlist1">
3865 core.gitProxy
3866 </dt>
3867 <dd>
3868 <p>
3869         A "proxy command" to execute (as <em>command host port</em>) instead
3870         of establishing direct connection to the remote server when
3871         using the Git protocol for fetching. If the variable value is
3872         in the "COMMAND for DOMAIN" format, the command is applied only
3873         on hostnames ending with the specified domain string. This variable
3874         may be set multiple times and is matched in the given order;
3875         the first match wins.
3876 </p>
3877 <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
3878 (which always applies universally, without the special "for"
3879 handling).</p></div>
3880 <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
3881 specify that no proxy be used for a given domain pattern.
3882 This is useful for excluding servers inside a firewall from
3883 proxy use, while defaulting to a common proxy for external domains.</p></div>
3884 </dd>
3885 <dt class="hdlist1">
3886 core.sshCommand
3887 </dt>
3888 <dd>
3889 <p>
3890         If this variable is set, <code>git fetch</code> and <code>git push</code> will
3891         use the specified command instead of <code>ssh</code> when they need to
3892         connect to a remote system. The command is in the same form as
3893         the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
3894         when the environment variable is set.
3895 </p>
3896 </dd>
3897 <dt class="hdlist1">
3898 core.ignoreStat
3899 </dt>
3900 <dd>
3901 <p>
3902         If true, Git will avoid using lstat() calls to detect if files have
3903         changed by setting the "assume-unchanged" bit for those tracked files
3904         which it has updated identically in both the index and working tree.
3905 </p>
3906 <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
3907 the modified files explicitly (e.g. see <em>Examples</em> section in
3908 <a href="git-update-index.html">git-update-index(1)</a>).
3909 Git will not normally detect changes to those files.</p></div>
3910 <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
3911 CIFS/Microsoft Windows.</p></div>
3912 <div class="paragraph"><p>False by default.</p></div>
3913 </dd>
3914 <dt class="hdlist1">
3915 core.preferSymlinkRefs
3916 </dt>
3917 <dd>
3918 <p>
3919         Instead of the default "symref" format for HEAD
3920         and other symbolic reference files, use symbolic links.
3921         This is sometimes needed to work with old scripts that
3922         expect HEAD to be a symbolic link.
3923 </p>
3924 </dd>
3925 <dt class="hdlist1">
3926 core.alternateRefsCommand
3927 </dt>
3928 <dd>
3929 <p>
3930         When advertising tips of available history from an alternate, use the shell to
3931         execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
3932         first argument is the absolute path of the alternate. Output must contain one
3933         hex object id per line (i.e., the same as produced by <code>git for-each-ref
3934         --format='%(objectname)'</code>).
3935 </p>
3936 <div class="paragraph"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
3937 value, as it does not take a repository path as an argument (but you can wrap
3938 the command above in a shell script).</p></div>
3939 </dd>
3940 <dt class="hdlist1">
3941 core.alternateRefsPrefixes
3942 </dt>
3943 <dd>
3944 <p>
3945         When listing references from an alternate, list only references that begin
3946         with the given prefix. Prefixes match as if they were given as arguments to
3947         <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
3948         whitespace. If <code>core.alternateRefsCommand</code> is set, setting
3949         <code>core.alternateRefsPrefixes</code> has no effect.
3950 </p>
3951 </dd>
3952 <dt class="hdlist1">
3953 core.bare
3954 </dt>
3955 <dd>
3956 <p>
3957         If true this repository is assumed to be <em>bare</em> and has no
3958         working directory associated with it.  If this is the case a
3959         number of commands that require a working directory will be
3960         disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
3961 </p>
3962 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
3963 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
3964 repository that ends in "/.git" is assumed to be not bare (bare =
3965 false), while all other repositories are assumed to be bare (bare
3966 = true).</p></div>
3967 </dd>
3968 <dt class="hdlist1">
3969 core.worktree
3970 </dt>
3971 <dd>
3972 <p>
3973         Set the path to the root of the working tree.
3974         If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
3975         is ignored and not used for determining the root of working tree.
3976         This can be overridden by the <code>GIT_WORK_TREE</code> environment
3977         variable and the <code>--work-tree</code> command-line option.
3978         The value can be an absolute path or relative to the path to
3979         the .git directory, which is either specified by --git-dir
3980         or GIT_DIR, or automatically discovered.
3981         If --git-dir or GIT_DIR is specified but none of
3982         --work-tree, GIT_WORK_TREE and core.worktree is specified,
3983         the current working directory is regarded as the top level
3984         of your working tree.
3985 </p>
3986 <div class="paragraph"><p>Note that this variable is honored even when set in a configuration
3987 file in a ".git" subdirectory of a directory and its value differs
3988 from the latter directory (e.g. "/path/to/.git/config" has
3989 core.worktree set to "/different/path"), which is most likely a
3990 misconfiguration.  Running Git commands in the "/path/to" directory will
3991 still use "/different/path" as the root of the work tree and can cause
3992 confusion unless you know what you are doing (e.g. you are creating a
3993 read-only snapshot of the same index to a location different from the
3994 repository&#8217;s usual working tree).</p></div>
3995 </dd>
3996 <dt class="hdlist1">
3997 core.logAllRefUpdates
3998 </dt>
3999 <dd>
4000 <p>
4001         Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
4002         "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
4003         SHA-1, the date/time and the reason of the update, but
4004         only when the file exists.  If this configuration
4005         variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
4006         file is automatically created for branch heads (i.e. under
4007         <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
4008         note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
4009         If it is set to <code>always</code>, then a missing reflog is automatically
4010         created for any ref under <code>refs/</code>.
4011 </p>
4012 <div class="paragraph"><p>This information can be used to determine what commit
4013 was the tip of a branch "2 days ago".</p></div>
4014 <div class="paragraph"><p>This value is true by default in a repository that has
4015 a working directory associated with it, and false by
4016 default in a bare repository.</p></div>
4017 </dd>
4018 <dt class="hdlist1">
4019 core.repositoryFormatVersion
4020 </dt>
4021 <dd>
4022 <p>
4023         Internal variable identifying the repository format and layout
4024         version.
4025 </p>
4026 </dd>
4027 <dt class="hdlist1">
4028 core.sharedRepository
4029 </dt>
4030 <dd>
4031 <p>
4032         When <em>group</em> (or <em>true</em>), the repository is made shareable between
4033         several users in a group (making sure all the files and objects are
4034         group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
4035         repository will be readable by all users, additionally to being
4036         group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
4037         reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
4038         files in the repository will have this mode value. <em>0xxx</em> will override
4039         user&#8217;s umask value (whereas the other options will only override
4040         requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
4041         the repo read/write-able for the owner and group, but inaccessible to
4042         others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
4043         repository that is group-readable but not group-writable.
4044         See <a href="git-init.html">git-init(1)</a>. False by default.
4045 </p>
4046 </dd>
4047 <dt class="hdlist1">
4048 core.warnAmbiguousRefs
4049 </dt>
4050 <dd>
4051 <p>
4052         If true, Git will warn you if the ref name you passed it is ambiguous
4053         and might match multiple refs in the repository. True by default.
4054 </p>
4055 </dd>
4056 <dt class="hdlist1">
4057 core.compression
4058 </dt>
4059 <dd>
4060 <p>
4061         An integer -1..9, indicating a default compression level.
4062         -1 is the zlib default. 0 means no compression,
4063         and 1..9 are various speed/size tradeoffs, 9 being slowest.
4064         If set, this provides a default to other compression variables,
4065         such as <code>core.looseCompression</code> and <code>pack.compression</code>.
4066 </p>
4067 </dd>
4068 <dt class="hdlist1">
4069 core.looseCompression
4070 </dt>
4071 <dd>
4072 <p>
4073         An integer -1..9, indicating the compression level for objects that
4074         are not in a pack file. -1 is the zlib default. 0 means no
4075         compression, and 1..9 are various speed/size tradeoffs, 9 being
4076         slowest.  If not set,  defaults to core.compression.  If that is
4077         not set,  defaults to 1 (best speed).
4078 </p>
4079 </dd>
4080 <dt class="hdlist1">
4081 core.packedGitWindowSize
4082 </dt>
4083 <dd>
4084 <p>
4085         Number of bytes of a pack file to map into memory in a
4086         single mapping operation.  Larger window sizes may allow
4087         your system to process a smaller number of large pack files
4088         more quickly.  Smaller window sizes will negatively affect
4089         performance due to increased calls to the operating system&#8217;s
4090         memory manager, but may improve performance when accessing
4091         a large number of large pack files.
4092 </p>
4093 <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
4094 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
4095 be reasonable for all users/operating systems.  You probably do
4096 not need to adjust this value.</p></div>
4097 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4098 </dd>
4099 <dt class="hdlist1">
4100 core.packedGitLimit
4101 </dt>
4102 <dd>
4103 <p>
4104         Maximum number of bytes to map simultaneously into memory
4105         from pack files.  If Git needs to access more than this many
4106         bytes at once to complete an operation it will unmap existing
4107         regions to reclaim virtual address space within the process.
4108 </p>
4109 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
4110 unlimited) on 64 bit platforms.
4111 This should be reasonable for all users/operating systems, except on
4112 the largest projects.  You probably do not need to adjust this value.</p></div>
4113 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4114 </dd>
4115 <dt class="hdlist1">
4116 core.deltaBaseCacheLimit
4117 </dt>
4118 <dd>
4119 <p>
4120         Maximum number of bytes per thread to reserve for caching base objects
4121         that may be referenced by multiple deltified objects.  By storing the
4122         entire decompressed base objects in a cache Git is able
4123         to avoid unpacking and decompressing frequently used base
4124         objects multiple times.
4125 </p>
4126 <div class="paragraph"><p>Default is 96 MiB on all platforms.  This should be reasonable
4127 for all users/operating systems, except on the largest projects.
4128 You probably do not need to adjust this value.</p></div>
4129 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4130 </dd>
4131 <dt class="hdlist1">
4132 core.bigFileThreshold
4133 </dt>
4134 <dd>
4135 <p>
4136         The size of files considered "big", which as discussed below
4137         changes the behavior of numerous git commands, as well as how
4138         such files are stored within the repository. The default is
4139         512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
4140         supported.
4141 </p>
4142 <div class="paragraph"><p>Files above the configured limit will be:</p></div>
4143 <div class="ulist"><ul>
4144 <li>
4145 <p>
4146 Stored deflated in packfiles, without attempting delta compression.
4147 </p>
4148 <div class="paragraph"><p>The default limit is primarily set with this use-case in mind. With it,
4149 most projects will have their source code and other text files delta
4150 compressed, but not larger binary media files.</p></div>
4151 <div class="paragraph"><p>Storing large files without delta compression avoids excessive memory
4152 usage, at the slight expense of increased disk usage.</p></div>
4153 </li>
4154 <li>
4155 <p>
4156 Will be treated as if they were labeled "binary" (see
4157   <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
4158   <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.
4159 </p>
4160 </li>
4161 <li>
4162 <p>
4163 Will generally be streamed when written, which avoids excessive
4164 memory usage, at the cost of some fixed overhead. Commands that make
4165 use of this include <a href="git-archive.html">git-archive(1)</a>,
4166 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
4167 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.
4168 </p>
4169 </li>
4170 </ul></div>
4171 </dd>
4172 <dt class="hdlist1">
4173 core.excludesFile
4174 </dt>
4175 <dd>
4176 <p>
4177         Specifies the pathname to the file that contains patterns to
4178         describe paths that are not meant to be tracked, in addition
4179         to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
4180         Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
4181         If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
4182         is used instead. See <a href="gitignore.html">gitignore(5)</a>.
4183 </p>
4184 </dd>
4185 <dt class="hdlist1">
4186 core.askPass
4187 </dt>
4188 <dd>
4189 <p>
4190         Some commands (e.g. svn and http interfaces) that interactively
4191         ask for a password can be told to use an external program given
4192         via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
4193         environment variable. If not set, fall back to the value of the
4194         <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
4195         prompt. The external program shall be given a suitable prompt as
4196         command-line argument and write the password on its STDOUT.
4197 </p>
4198 </dd>
4199 <dt class="hdlist1">
4200 core.attributesFile
4201 </dt>
4202 <dd>
4203 <p>
4204         In addition to <code>.gitattributes</code> (per-directory) and
4205         <code>.git/info/attributes</code>, Git looks into this file for attributes
4206         (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
4207         way as for <code>core.excludesFile</code>. Its default value is
4208         <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
4209         set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
4210 </p>
4211 </dd>
4212 <dt class="hdlist1">
4213 core.hooksPath
4214 </dt>
4215 <dd>
4216 <p>
4217         By default Git will look for your hooks in the
4218         <code>$GIT_DIR/hooks</code> directory. Set this to different path,
4219         e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
4220         that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
4221         in <code>$GIT_DIR/hooks/pre-receive</code>.
4222 </p>
4223 <div class="paragraph"><p>The path can be either absolute or relative. A relative path is
4224 taken as relative to the directory where the hooks are run (see
4225 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
4226 <div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
4227 centrally configure your Git hooks instead of configuring them on a
4228 per-repository basis, or as a more flexible and centralized
4229 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
4230 default hooks.</p></div>
4231 </dd>
4232 <dt class="hdlist1">
4233 core.editor
4234 </dt>
4235 <dd>
4236 <p>
4237         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4238         messages by launching an editor use the value of this
4239         variable when it is set, and the environment variable
4240         <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.
4241 </p>
4242 </dd>
4243 <dt class="hdlist1">
4244 core.commentChar
4245 </dt>
4246 <dt class="hdlist1">
4247 core.commentString
4248 </dt>
4249 <dd>
4250 <p>
4251         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4252         messages consider a line that begins with this character
4253         commented, and removes them after the editor returns
4254         (default <em>#</em>).
4255 </p>
4256 <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
4257 the beginning character of any line in existing commit messages.</p></div>
4258 <div class="paragraph"><p>Note that these two variables are aliases of each other, and in modern
4259 versions of Git you are free to use a string (e.g., <code>//</code> or <code>⁑⁕⁑</code>) with
4260 <code>commentChar</code>. Versions of Git prior to v2.45.0 will ignore
4261 <code>commentString</code> but will reject a value of <code>commentChar</code> that consists
4262 of more than a single ASCII byte. If you plan to use your config with
4263 older and newer versions of Git, you may want to specify both:</p></div>
4264 <div class="literalblock">
4265 <div class="content">
4266 <pre><code>[core]
4267 # single character for older versions
4268 commentChar = "#"
4269 # string for newer versions (which will override commentChar
4270 # because it comes later in the file)
4271 commentString = "//"</code></pre>
4272 </div></div>
4273 </dd>
4274 <dt class="hdlist1">
4275 core.filesRefLockTimeout
4276 </dt>
4277 <dd>
4278 <p>
4279         The length of time, in milliseconds, to retry when trying to
4280         lock an individual reference. Value 0 means not to retry at
4281         all; -1 means to try indefinitely. Default is 100 (i.e.,
4282         retry for 100ms).
4283 </p>
4284 </dd>
4285 <dt class="hdlist1">
4286 core.packedRefsTimeout
4287 </dt>
4288 <dd>
4289 <p>
4290         The length of time, in milliseconds, to retry when trying to
4291         lock the <code>packed-refs</code> file. Value 0 means not to retry at
4292         all; -1 means to try indefinitely. Default is 1000 (i.e.,
4293         retry for 1 second).
4294 </p>
4295 </dd>
4296 <dt class="hdlist1">
4297 core.pager
4298 </dt>
4299 <dd>
4300 <p>
4301         Text viewer for use by Git commands (e.g., <em>less</em>).  The value
4302         is meant to be interpreted by the shell.  The order of preference
4303         is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
4304         configuration, then <code>$PAGER</code>, and then the default chosen at
4305         compile time (usually <em>less</em>).
4306 </p>
4307 <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
4308 (if <code>LESS</code> environment variable is set, Git does not change it at
4309 all).  If you want to selectively override Git&#8217;s default setting
4310 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
4311 be passed to the shell by Git, which will translate the final
4312 command to <code>LESS=FRX less -S</code>. The environment does not set the
4313 <code>S</code> option but the command line does, instructing less to truncate
4314 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
4315 deactivate the <code>F</code> option specified by the environment from the
4316 command-line, deactivating the "quit if one screen" behavior of
4317 <code>less</code>.  One can specifically activate some flags for particular
4318 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
4319 line truncation only for <code>git blame</code>.</p></div>
4320 <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
4321 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
4322 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
4323 </dd>
4324 <dt class="hdlist1">
4325 core.whitespace
4326 </dt>
4327 <dd>
4328 <p>
4329         A comma separated list of common whitespace problems to
4330         notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
4331         highlight them, and <em>git apply --whitespace=error</em> will
4332         consider them as errors.  You can prefix <code>-</code> to disable
4333         any of them (e.g. <code>-trailing-space</code>):
4334 </p>
4335 <div class="ulist"><ul>
4336 <li>
4337 <p>
4338 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
4339   as an error (enabled by default).
4340 </p>
4341 </li>
4342 <li>
4343 <p>
4344 <code>space-before-tab</code> treats a space character that appears immediately
4345   before a tab character in the initial indent part of the line as an
4346   error (enabled by default).
4347 </p>
4348 </li>
4349 <li>
4350 <p>
4351 <code>indent-with-non-tab</code> treats a line that is indented with space
4352   characters instead of the equivalent tabs as an error (not enabled by
4353   default).
4354 </p>
4355 </li>
4356 <li>
4357 <p>
4358 <code>tab-in-indent</code> treats a tab character in the initial indent part of
4359   the line as an error (not enabled by default).
4360 </p>
4361 </li>
4362 <li>
4363 <p>
4364 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
4365   (enabled by default).
4366 </p>
4367 </li>
4368 <li>
4369 <p>
4370 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
4371   <code>blank-at-eof</code>.
4372 </p>
4373 </li>
4374 <li>
4375 <p>
4376 <code>cr-at-eol</code> treats a carriage-return at the end of line as
4377   part of the line terminator, i.e. with it, <code>trailing-space</code>
4378   does not trigger if the character before such a carriage-return
4379   is not a whitespace (not enabled by default).
4380 </p>
4381 </li>
4382 <li>
4383 <p>
4384 <code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
4385   is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
4386   errors. The default tab width is 8. Allowed values are 1 to 63.
4387 </p>
4388 </li>
4389 </ul></div>
4390 </dd>
4391 <dt class="hdlist1">
4392 core.fsync
4393 </dt>
4394 <dd>
4395 <p>
4396         A comma-separated list of components of the repository that
4397         should be hardened via the core.fsyncMethod when created or
4398         modified.  You can disable hardening of any component by
4399         prefixing it with a <em>-</em>.  Items that are not hardened may be
4400         lost in the event of an unclean system shutdown. Unless you
4401         have special requirements, it is recommended that you leave
4402         this option empty or pick one of <code>committed</code>, <code>added</code>,
4403         or <code>all</code>.
4404 </p>
4405 <div class="paragraph"><p>When this configuration is encountered, the set of components starts with
4406 the platform default value, disabled components are removed, and additional
4407 components are added. <code>none</code> resets the state so that the platform default
4408 is ignored.</p></div>
4409 <div class="paragraph"><p>The empty string resets the fsync configuration to the platform
4410 default. The default on most platforms is equivalent to
4411 <code>core.fsync=committed,-loose-object</code>, which has good performance,
4412 but risks losing recent work in the event of an unclean system shutdown.</p></div>
4413 <div class="ulist"><ul>
4414 <li>
4415 <p>
4416 <code>none</code> clears the set of fsynced components.
4417 </p>
4418 </li>
4419 <li>
4420 <p>
4421 <code>loose-object</code> hardens objects added to the repo in loose-object form.
4422 </p>
4423 </li>
4424 <li>
4425 <p>
4426 <code>pack</code> hardens objects added to the repo in packfile form.
4427 </p>
4428 </li>
4429 <li>
4430 <p>
4431 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
4432 </p>
4433 </li>
4434 <li>
4435 <p>
4436 <code>commit-graph</code> hardens the commit-graph file.
4437 </p>
4438 </li>
4439 <li>
4440 <p>
4441 <code>index</code> hardens the index when it is modified.
4442 </p>
4443 </li>
4444 <li>
4445 <p>
4446 <code>objects</code> is an aggregate option that is equivalent to
4447   <code>loose-object,pack</code>.
4448 </p>
4449 </li>
4450 <li>
4451 <p>
4452 <code>reference</code> hardens references modified in the repo.
4453 </p>
4454 </li>
4455 <li>
4456 <p>
4457 <code>derived-metadata</code> is an aggregate option that is equivalent to
4458   <code>pack-metadata,commit-graph</code>.
4459 </p>
4460 </li>
4461 <li>
4462 <p>
4463 <code>committed</code> is an aggregate option that is currently equivalent to
4464   <code>objects</code>. This mode sacrifices some performance to ensure that work
4465   that is committed to the repository with <code>git commit</code> or similar commands
4466   is hardened.
4467 </p>
4468 </li>
4469 <li>
4470 <p>
4471 <code>added</code> is an aggregate option that is currently equivalent to
4472   <code>committed,index</code>. This mode sacrifices additional performance to
4473   ensure that the results of commands like <code>git add</code> and similar operations
4474   are hardened.
4475 </p>
4476 </li>
4477 <li>
4478 <p>
4479 <code>all</code> is an aggregate option that syncs all individual components above.
4480 </p>
4481 </li>
4482 </ul></div>
4483 </dd>
4484 <dt class="hdlist1">
4485 core.fsyncMethod
4486 </dt>
4487 <dd>
4488 <p>
4489         A value indicating the strategy Git will use to harden repository data
4490         using fsync and related primitives.
4491 </p>
4492 <div class="ulist"><ul>
4493 <li>
4494 <p>
4495 <code>fsync</code> uses the fsync() system call or platform equivalents.
4496 </p>
4497 </li>
4498 <li>
4499 <p>
4500 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
4501   filesystem and storage hardware, data added to the repository may not be
4502   durable in the event of a system crash. This is the default mode on macOS.
4503 </p>
4504 </li>
4505 <li>
4506 <p>
4507 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
4508   updates in the disk writeback cache and then does a single full fsync of
4509   a dummy file to trigger the disk cache flush at the end of the operation.
4510 </p>
4511 <div class="paragraph"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
4512 data is made durable as if <code>fsync</code> was specified. This mode is expected to
4513 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
4514 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
4515 </li>
4516 </ul></div>
4517 </dd>
4518 <dt class="hdlist1">
4519 core.fsyncObjectFiles
4520 </dt>
4521 <dd>
4522 <p>
4523         This boolean will enable <em>fsync()</em> when writing object files.
4524         This setting is deprecated. Use core.fsync instead.
4525 </p>
4526 <div class="paragraph"><p>This setting affects data added to the Git repository in loose-object
4527 form. When set to true, Git will issue an fsync or similar system call
4528 to flush caches so that loose-objects remain consistent in the face
4529 of a unclean system shutdown.</p></div>
4530 </dd>
4531 <dt class="hdlist1">
4532 core.preloadIndex
4533 </dt>
4534 <dd>
4535 <p>
4536         Enable parallel index preload for operations like <em>git diff</em>
4537 </p>
4538 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
4539 on filesystems like NFS that have weak caching semantics and thus
4540 relatively high IO latencies.  When enabled, Git will do the
4541 index comparison to the filesystem data in parallel, allowing
4542 overlapping IO&#8217;s.  Defaults to true.</p></div>
4543 </dd>
4544 <dt class="hdlist1">
4545 core.unsetenvvars
4546 </dt>
4547 <dd>
4548 <p>
4549         Windows-only: comma-separated list of environment variables'
4550         names that need to be unset before spawning any other process.
4551         Defaults to <code>PERL5LIB</code> to account for the fact that Git for
4552         Windows insists on using its own Perl interpreter.
4553 </p>
4554 </dd>
4555 <dt class="hdlist1">
4556 core.restrictinheritedhandles
4557 </dt>
4558 <dd>
4559 <p>
4560         Windows-only: override whether spawned processes inherit only standard
4561         file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
4562         <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
4563         Windows 7 and later, and <code>false</code> on older Windows versions.
4564 </p>
4565 </dd>
4566 <dt class="hdlist1">
4567 core.createObject
4568 </dt>
4569 <dd>
4570 <p>
4571         You can set this to <em>link</em>, in which case a hardlink followed by
4572         a delete of the source are used to make sure that object creation
4573         will not overwrite existing objects.
4574 </p>
4575 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
4576 Set this config setting to <em>rename</em> there; however, this will remove the
4577 check that makes sure that existing object files will not get overwritten.</p></div>
4578 </dd>
4579 <dt class="hdlist1">
4580 core.notesRef
4581 </dt>
4582 <dd>
4583 <p>
4584         When showing commit messages, also show notes which are stored in
4585         the given ref.  The ref must be fully qualified.  If the given
4586         ref does not exist, it is not an error but means that no
4587         notes should be printed.
4588 </p>
4589 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
4590 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p></div>
4591 </dd>
4592 <dt class="hdlist1">
4593 core.commitGraph
4594 </dt>
4595 <dd>
4596 <p>
4597         If true, then git will read the commit-graph file (if it exists)
4598         to parse the graph structure of commits. Defaults to true. See
4599         <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
4600 </p>
4601 </dd>
4602 <dt class="hdlist1">
4603 core.useReplaceRefs
4604 </dt>
4605 <dd>
4606 <p>
4607         If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
4608         option was given on the command line. See <a href="git.html">git(1)</a> and
4609         <a href="git-replace.html">git-replace(1)</a> for more information.
4610 </p>
4611 </dd>
4612 <dt class="hdlist1">
4613 core.multiPackIndex
4614 </dt>
4615 <dd>
4616 <p>
4617         Use the multi-pack-index file to track multiple packfiles using a
4618         single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
4619         information. Defaults to true.
4620 </p>
4621 </dd>
4622 <dt class="hdlist1">
4623 core.sparseCheckout
4624 </dt>
4625 <dd>
4626 <p>
4627         Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
4628         for more information.
4629 </p>
4630 </dd>
4631 <dt class="hdlist1">
4632 core.sparseCheckoutCone
4633 </dt>
4634 <dd>
4635 <p>
4636         Enables the "cone mode" of the sparse checkout feature. When the
4637         sparse-checkout file contains a limited set of patterns, this
4638         mode provides significant performance advantages. The "non-cone
4639         mode" can be requested to allow specifying more flexible
4640         patterns by setting this variable to <em>false</em>. See
4641         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.
4642 </p>
4643 </dd>
4644 <dt class="hdlist1">
4645 core.abbrev
4646 </dt>
4647 <dd>
4648 <p>
4649         Set the length object names are abbreviated to.  If
4650         unspecified or set to "auto", an appropriate value is
4651         computed based on the approximate number of packed objects
4652         in your repository, which hopefully is enough for
4653         abbreviated object names to stay unique for some time.
4654         If set to "no", no abbreviation is made and the object names
4655         are shown in their full length.
4656         The minimum length is 4.
4657 </p>
4658 </dd>
4659 <dt class="hdlist1">
4660 core.maxTreeDepth
4661 </dt>
4662 <dd>
4663 <p>
4664         The maximum depth Git is willing to recurse while traversing a
4665         tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
4666         to allow Git to abort cleanly, and should not generally need to
4667         be adjusted. The default is 4096.
4668 </p>
4669 </dd>
4670 <dt class="hdlist1">
4671 credential.helper
4672 </dt>
4673 <dd>
4674 <p>
4675         Specify an external helper to be called when a username or
4676         password credential is needed; the helper may consult external
4677         storage to avoid prompting the user for the credentials. This is
4678         normally the name of a credential helper with possible
4679         arguments, but may also be an absolute path with arguments or, if
4680         preceded by <code>!</code>, shell commands.
4681 </p>
4682 <div class="paragraph"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
4683 for details and examples.</p></div>
4684 </dd>
4685 <dt class="hdlist1">
4686 credential.useHttpPath
4687 </dt>
4688 <dd>
4689 <p>
4690         When acquiring credentials, consider the "path" component of an http
4691         or https URL to be important. Defaults to false. See
4692         <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
4693 </p>
4694 </dd>
4695 <dt class="hdlist1">
4696 credential.username
4697 </dt>
4698 <dd>
4699 <p>
4700         If no username is set for a network authentication, use this username
4701         by default. See credential.&lt;context&gt;.* below, and
4702         <a href="gitcredentials.html">gitcredentials(7)</a>.
4703 </p>
4704 </dd>
4705 <dt class="hdlist1">
4706 credential.&lt;url&gt;.*
4707 </dt>
4708 <dd>
4709 <p>
4710         Any of the credential.* options above can be applied selectively to
4711         some credentials. For example, "credential.https://example.com.username"
4712         would set the default username only for https connections to
4713         example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
4714         matched.
4715 </p>
4716 </dd>
4717 <dt class="hdlist1">
4718 credentialCache.ignoreSIGHUP
4719 </dt>
4720 <dd>
4721 <p>
4722         Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
4723 </p>
4724 </dd>
4725 <dt class="hdlist1">
4726 credentialStore.lockTimeoutMS
4727 </dt>
4728 <dd>
4729 <p>
4730         The length of time, in milliseconds, for git-credential-store to retry
4731         when trying to lock the credentials file. A value of 0 means not to retry at
4732         all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
4733         1s).
4734 </p>
4735 </dd>
4736 <dt class="hdlist1">
4737 diff.autoRefreshIndex
4738 </dt>
4739 <dd>
4740 <p>
4741         When using <em>git diff</em> to compare with work tree
4742         files, do not consider stat-only changes as changed.
4743         Instead, silently run <code>git update-index --refresh</code> to
4744         update the cached stat information for paths whose
4745         contents in the work tree match the contents in the
4746         index.  This option defaults to true.  Note that this
4747         affects only <em>git diff</em> Porcelain, and not lower level
4748         <em>diff</em> commands such as <em>git diff-files</em>.
4749 </p>
4750 </dd>
4751 <dt class="hdlist1">
4752 diff.dirstat
4753 </dt>
4754 <dd>
4755 <p>
4756         A comma separated list of <code>--dirstat</code> parameters specifying the
4757         default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
4758         and friends. The defaults can be overridden on the command line
4759         (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
4760         (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
4761         The following parameters are available:
4762 </p>
4763 <div class="openblock">
4764 <div class="content">
4765 <div class="dlist"><dl>
4766 <dt class="hdlist1">
4767 <code>changes</code>
4768 </dt>
4769 <dd>
4770 <p>
4771         Compute the dirstat numbers by counting the lines that have been
4772         removed from the source, or added to the destination. This ignores
4773         the amount of pure code movements within a file.  In other words,
4774         rearranging lines in a file is not counted as much as other changes.
4775         This is the default behavior when no parameter is given.
4776 </p>
4777 </dd>
4778 <dt class="hdlist1">
4779 <code>lines</code>
4780 </dt>
4781 <dd>
4782 <p>
4783         Compute the dirstat numbers by doing the regular line-based diff
4784         analysis, and summing the removed/added line counts. (For binary
4785         files, count 64-byte chunks instead, since binary files have no
4786         natural concept of lines). This is a more expensive <code>--dirstat</code>
4787         behavior than the <code>changes</code> behavior, but it does count rearranged
4788         lines within a file as much as other changes. The resulting output
4789         is consistent with what you get from the other <code>--*stat</code> options.
4790 </p>
4791 </dd>
4792 <dt class="hdlist1">
4793 <code>files</code>
4794 </dt>
4795 <dd>
4796 <p>
4797         Compute the dirstat numbers by counting the number of files changed.
4798         Each changed file counts equally in the dirstat analysis. This is
4799         the computationally cheapest <code>--dirstat</code> behavior, since it does
4800         not have to look at the file contents at all.
4801 </p>
4802 </dd>
4803 <dt class="hdlist1">
4804 <code>cumulative</code>
4805 </dt>
4806 <dd>
4807 <p>
4808         Count changes in a child directory for the parent directory as well.
4809         Note that when using <code>cumulative</code>, the sum of the percentages
4810         reported may exceed 100%. The default (non-cumulative) behavior can
4811         be specified with the <code>noncumulative</code> parameter.
4812 </p>
4813 </dd>
4814 <dt class="hdlist1">
4815 &lt;limit&gt;
4816 </dt>
4817 <dd>
4818 <p>
4819         An integer parameter specifies a cut-off percent (3% by default).
4820         Directories contributing less than this percentage of the changes
4821         are not shown in the output.
4822 </p>
4823 </dd>
4824 </dl></div>
4825 </div></div>
4826 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
4827 directories with less than 10% of the total amount of changed files,
4828 and accumulating child directory counts in the parent directories:
4829 <code>files,10,cumulative</code>.</p></div>
4830 </dd>
4831 <dt class="hdlist1">
4832 diff.statNameWidth
4833 </dt>
4834 <dd>
4835 <p>
4836         Limit the width of the filename part in --stat output. If set, applies
4837         to all commands generating --stat output except format-patch.
4838 </p>
4839 </dd>
4840 <dt class="hdlist1">
4841 diff.statGraphWidth
4842 </dt>
4843 <dd>
4844 <p>
4845         Limit the width of the graph part in --stat output. If set, applies
4846         to all commands generating --stat output except format-patch.
4847 </p>
4848 </dd>
4849 <dt class="hdlist1">
4850 diff.context
4851 </dt>
4852 <dd>
4853 <p>
4854         Generate diffs with &lt;n&gt; lines of context instead of the default
4855         of 3. This value is overridden by the -U option.
4856 </p>
4857 </dd>
4858 <dt class="hdlist1">
4859 diff.interHunkContext
4860 </dt>
4861 <dd>
4862 <p>
4863         Show the context between diff hunks, up to the specified number
4864         of lines, thereby fusing the hunks that are close to each other.
4865         This value serves as the default for the <code>--inter-hunk-context</code>
4866         command line option.
4867 </p>
4868 </dd>
4869 <dt class="hdlist1">
4870 diff.external
4871 </dt>
4872 <dd>
4873 <p>
4874         If this config variable is set, diff generation is not
4875         performed using the internal diff machinery, but using the
4876         given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
4877         environment variable.  The command is called with parameters
4878         as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
4879         you want to use an external diff program only on a subset of
4880         your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
4881 </p>
4882 </dd>
4883 <dt class="hdlist1">
4884 diff.ignoreSubmodules
4885 </dt>
4886 <dd>
4887 <p>
4888         Sets the default value of --ignore-submodules. Note that this
4889         affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
4890         commands such as <em>git diff-files</em>. <em>git checkout</em>
4891         and <em>git switch</em> also honor
4892         this setting when reporting uncommitted changes. Setting it to
4893         <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
4894         and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
4895         overridden by using the --ignore-submodules command-line option.
4896         The <em>git submodule</em> commands are not affected by this setting.
4897         By default this is set to untracked so that any untracked
4898         submodules are ignored.
4899 </p>
4900 </dd>
4901 <dt class="hdlist1">
4902 diff.mnemonicPrefix
4903 </dt>
4904 <dd>
4905 <p>
4906         If set, <em>git diff</em> uses a prefix pair that is different from the
4907         standard "a/" and "b/" depending on what is being compared.  When
4908         this configuration is in effect, reverse diff output also swaps
4909         the order of the prefixes:
4910 </p>
4911 <div class="dlist"><dl>
4912 <dt class="hdlist1">
4913 <code>git diff</code>
4914 </dt>
4915 <dd>
4916 <p>
4917         compares the (i)ndex and the (w)ork tree;
4918 </p>
4919 </dd>
4920 <dt class="hdlist1">
4921 <code>git diff HEAD</code>
4922 </dt>
4923 <dd>
4924 <p>
4925          compares a (c)ommit and the (w)ork tree;
4926 </p>
4927 </dd>
4928 <dt class="hdlist1">
4929 <code>git diff --cached</code>
4930 </dt>
4931 <dd>
4932 <p>
4933         compares a (c)ommit and the (i)ndex;
4934 </p>
4935 </dd>
4936 <dt class="hdlist1">
4937 <code>git diff HEAD:file1 file2</code>
4938 </dt>
4939 <dd>
4940 <p>
4941         compares an (o)bject and a (w)ork tree entity;
4942 </p>
4943 </dd>
4944 <dt class="hdlist1">
4945 <code>git diff --no-index a b</code>
4946 </dt>
4947 <dd>
4948 <p>
4949         compares two non-git things (1) and (2).
4950 </p>
4951 </dd>
4952 </dl></div>
4953 </dd>
4954 <dt class="hdlist1">
4955 diff.noPrefix
4956 </dt>
4957 <dd>
4958 <p>
4959         If set, <em>git diff</em> does not show any source or destination prefix.
4960 </p>
4961 </dd>
4962 <dt class="hdlist1">
4963 diff.srcPrefix
4964 </dt>
4965 <dd>
4966 <p>
4967         If set, <em>git diff</em> uses this source prefix. Defaults to "a/".
4968 </p>
4969 </dd>
4970 <dt class="hdlist1">
4971 diff.dstPrefix
4972 </dt>
4973 <dd>
4974 <p>
4975         If set, <em>git diff</em> uses this destination prefix. Defaults to "b/".
4976 </p>
4977 </dd>
4978 <dt class="hdlist1">
4979 diff.relative
4980 </dt>
4981 <dd>
4982 <p>
4983         If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
4984         and show pathnames relative to the current directory.
4985 </p>
4986 </dd>
4987 <dt class="hdlist1">
4988 diff.orderFile
4989 </dt>
4990 <dd>
4991 <p>
4992         File indicating how to order files within a diff.
4993         See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
4994         If <code>diff.orderFile</code> is a relative pathname, it is treated as
4995         relative to the top of the working tree.
4996 </p>
4997 </dd>
4998 <dt class="hdlist1">
4999 diff.renameLimit
5000 </dt>
5001 <dd>
5002 <p>
5003         The number of files to consider in the exhaustive portion of
5004         copy/rename detection; equivalent to the <em>git diff</em> option
5005         <code>-l</code>.  If not set, the default value is currently 1000.  This
5006         setting has no effect if rename detection is turned off.
5007 </p>
5008 </dd>
5009 <dt class="hdlist1">
5010 diff.renames
5011 </dt>
5012 <dd>
5013 <p>
5014         Whether and how Git detects renames.  If set to "false",
5015         rename detection is disabled. If set to "true", basic rename
5016         detection is enabled.  If set to "copies" or "copy", Git will
5017         detect copies, as well.  Defaults to true.  Note that this
5018         affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
5019         <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
5020         <a href="git-diff-files.html">git-diff-files(1)</a>.
5021 </p>
5022 </dd>
5023 <dt class="hdlist1">
5024 diff.suppressBlankEmpty
5025 </dt>
5026 <dd>
5027 <p>
5028         A boolean to inhibit the standard behavior of printing a space
5029         before each empty output line. Defaults to false.
5030 </p>
5031 </dd>
5032 <dt class="hdlist1">
5033 diff.submodule
5034 </dt>
5035 <dd>
5036 <p>
5037         Specify the format in which differences in submodules are
5038         shown.  The "short" format just shows the names of the commits
5039         at the beginning and end of the range. The "log" format lists
5040         the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
5041         does. The "diff" format shows an inline diff of the changed
5042         contents of the submodule. Defaults to "short".
5043 </p>
5044 </dd>
5045 <dt class="hdlist1">
5046 diff.wordRegex
5047 </dt>
5048 <dd>
5049 <p>
5050         A POSIX Extended Regular Expression used to determine what is a "word"
5051         when performing word-by-word difference calculations.  Character
5052         sequences that match the regular expression are "words", all other
5053         characters are <strong>ignorable</strong> whitespace.
5054 </p>
5055 </dd>
5056 <dt class="hdlist1">
5057 diff.&lt;driver&gt;.command
5058 </dt>
5059 <dd>
5060 <p>
5061         The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
5062         for details.
5063 </p>
5064 </dd>
5065 <dt class="hdlist1">
5066 diff.&lt;driver&gt;.xfuncname
5067 </dt>
5068 <dd>
5069 <p>
5070         The regular expression that the diff driver should use to
5071         recognize the hunk header.  A built-in pattern may also be used.
5072         See <a href="gitattributes.html">gitattributes(5)</a> for details.
5073 </p>
5074 </dd>
5075 <dt class="hdlist1">
5076 diff.&lt;driver&gt;.binary
5077 </dt>
5078 <dd>
5079 <p>
5080         Set this option to true to make the diff driver treat files as
5081         binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5082 </p>
5083 </dd>
5084 <dt class="hdlist1">
5085 diff.&lt;driver&gt;.textconv
5086 </dt>
5087 <dd>
5088 <p>
5089         The command that the diff driver should call to generate the
5090         text-converted version of a file.  The result of the
5091         conversion is used to generate a human-readable diff.  See
5092         <a href="gitattributes.html">gitattributes(5)</a> for details.
5093 </p>
5094 </dd>
5095 <dt class="hdlist1">
5096 diff.&lt;driver&gt;.wordRegex
5097 </dt>
5098 <dd>
5099 <p>
5100         The regular expression that the diff driver should use to
5101         split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
5102         details.
5103 </p>
5104 </dd>
5105 <dt class="hdlist1">
5106 diff.&lt;driver&gt;.cachetextconv
5107 </dt>
5108 <dd>
5109 <p>
5110         Set this option to true to make the diff driver cache the text
5111         conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5112 </p>
5113 <div class="dlist"><dl>
5114 <dt class="hdlist1">
5115 <code>araxis</code>
5116 </dt>
5117 <dd>
5118 <p>
5119 Use Araxis Merge (requires a graphical session)
5120 </p>
5121 </dd>
5122 <dt class="hdlist1">
5123 <code>bc</code>
5124 </dt>
5125 <dd>
5126 <p>
5127 Use Beyond Compare (requires a graphical session)
5128 </p>
5129 </dd>
5130 <dt class="hdlist1">
5131 <code>bc3</code>
5132 </dt>
5133 <dd>
5134 <p>
5135 Use Beyond Compare (requires a graphical session)
5136 </p>
5137 </dd>
5138 <dt class="hdlist1">
5139 <code>bc4</code>
5140 </dt>
5141 <dd>
5142 <p>
5143 Use Beyond Compare (requires a graphical session)
5144 </p>
5145 </dd>
5146 <dt class="hdlist1">
5147 <code>codecompare</code>
5148 </dt>
5149 <dd>
5150 <p>
5151 Use Code Compare (requires a graphical session)
5152 </p>
5153 </dd>
5154 <dt class="hdlist1">
5155 <code>deltawalker</code>
5156 </dt>
5157 <dd>
5158 <p>
5159 Use DeltaWalker (requires a graphical session)
5160 </p>
5161 </dd>
5162 <dt class="hdlist1">
5163 <code>diffmerge</code>
5164 </dt>
5165 <dd>
5166 <p>
5167 Use DiffMerge (requires a graphical session)
5168 </p>
5169 </dd>
5170 <dt class="hdlist1">
5171 <code>diffuse</code>
5172 </dt>
5173 <dd>
5174 <p>
5175 Use Diffuse (requires a graphical session)
5176 </p>
5177 </dd>
5178 <dt class="hdlist1">
5179 <code>ecmerge</code>
5180 </dt>
5181 <dd>
5182 <p>
5183 Use ECMerge (requires a graphical session)
5184 </p>
5185 </dd>
5186 <dt class="hdlist1">
5187 <code>emerge</code>
5188 </dt>
5189 <dd>
5190 <p>
5191 Use Emacs' Emerge
5192 </p>
5193 </dd>
5194 <dt class="hdlist1">
5195 <code>examdiff</code>
5196 </dt>
5197 <dd>
5198 <p>
5199 Use ExamDiff Pro (requires a graphical session)
5200 </p>
5201 </dd>
5202 <dt class="hdlist1">
5203 <code>guiffy</code>
5204 </dt>
5205 <dd>
5206 <p>
5207 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
5208 </p>
5209 </dd>
5210 <dt class="hdlist1">
5211 <code>gvimdiff</code>
5212 </dt>
5213 <dd>
5214 <p>
5215 Use gVim (requires a graphical session)
5216 </p>
5217 </dd>
5218 <dt class="hdlist1">
5219 <code>kdiff3</code>
5220 </dt>
5221 <dd>
5222 <p>
5223 Use KDiff3 (requires a graphical session)
5224 </p>
5225 </dd>
5226 <dt class="hdlist1">
5227 <code>kompare</code>
5228 </dt>
5229 <dd>
5230 <p>
5231 Use Kompare (requires a graphical session)
5232 </p>
5233 </dd>
5234 <dt class="hdlist1">
5235 <code>meld</code>
5236 </dt>
5237 <dd>
5238 <p>
5239 Use Meld (requires a graphical session)
5240 </p>
5241 </dd>
5242 <dt class="hdlist1">
5243 <code>nvimdiff</code>
5244 </dt>
5245 <dd>
5246 <p>
5247 Use Neovim
5248 </p>
5249 </dd>
5250 <dt class="hdlist1">
5251 <code>opendiff</code>
5252 </dt>
5253 <dd>
5254 <p>
5255 Use FileMerge (requires a graphical session)
5256 </p>
5257 </dd>
5258 <dt class="hdlist1">
5259 <code>p4merge</code>
5260 </dt>
5261 <dd>
5262 <p>
5263 Use HelixCore P4Merge (requires a graphical session)
5264 </p>
5265 </dd>
5266 <dt class="hdlist1">
5267 <code>smerge</code>
5268 </dt>
5269 <dd>
5270 <p>
5271 Use Sublime Merge (requires a graphical session)
5272 </p>
5273 </dd>
5274 <dt class="hdlist1">
5275 <code>tkdiff</code>
5276 </dt>
5277 <dd>
5278 <p>
5279 Use TkDiff (requires a graphical session)
5280 </p>
5281 </dd>
5282 <dt class="hdlist1">
5283 <code>vimdiff</code>
5284 </dt>
5285 <dd>
5286 <p>
5287 Use Vim
5288 </p>
5289 </dd>
5290 <dt class="hdlist1">
5291 <code>winmerge</code>
5292 </dt>
5293 <dd>
5294 <p>
5295 Use WinMerge (requires a graphical session)
5296 </p>
5297 </dd>
5298 <dt class="hdlist1">
5299 <code>xxdiff</code>
5300 </dt>
5301 <dd>
5302 <p>
5303 Use xxdiff (requires a graphical session)
5304 </p>
5305 </dd>
5306 </dl></div>
5307 </dd>
5308 <dt class="hdlist1">
5309 diff.indentHeuristic
5310 </dt>
5311 <dd>
5312 <p>
5313         Set this option to <code>false</code> to disable the default heuristics
5314         that shift diff hunk boundaries to make patches easier to read.
5315 </p>
5316 </dd>
5317 <dt class="hdlist1">
5318 diff.algorithm
5319 </dt>
5320 <dd>
5321 <p>
5322         Choose a diff algorithm.  The variants are as follows:
5323 </p>
5324 <div class="openblock">
5325 <div class="content">
5326 <div class="dlist"><dl>
5327 <dt class="hdlist1">
5328 <code>default</code>, <code>myers</code>
5329 </dt>
5330 <dd>
5331 <p>
5332         The basic greedy diff algorithm. Currently, this is the default.
5333 </p>
5334 </dd>
5335 <dt class="hdlist1">
5336 <code>minimal</code>
5337 </dt>
5338 <dd>
5339 <p>
5340         Spend extra time to make sure the smallest possible diff is
5341         produced.
5342 </p>
5343 </dd>
5344 <dt class="hdlist1">
5345 <code>patience</code>
5346 </dt>
5347 <dd>
5348 <p>
5349         Use "patience diff" algorithm when generating patches.
5350 </p>
5351 </dd>
5352 <dt class="hdlist1">
5353 <code>histogram</code>
5354 </dt>
5355 <dd>
5356 <p>
5357         This algorithm extends the patience algorithm to "support
5358         low-occurrence common elements".
5359 </p>
5360 </dd>
5361 </dl></div>
5362 </div></div>
5363 </dd>
5364 <dt class="hdlist1">
5365 diff.wsErrorHighlight
5366 </dt>
5367 <dd>
5368 <p>
5369         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5370         lines of the diff.  Multiple values are separated by comma,
5371         <code>none</code> resets previous values, <code>default</code> reset the list to
5372         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
5373         whitespace errors are colored with <code>color.diff.whitespace</code>.
5374         The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
5375         overrides this setting.
5376 </p>
5377 </dd>
5378 <dt class="hdlist1">
5379 diff.colorMoved
5380 </dt>
5381 <dd>
5382 <p>
5383         If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
5384         in a diff are colored differently, for details of valid modes
5385         see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
5386         true the default color mode will be used. When set to false,
5387         moved lines are not colored.
5388 </p>
5389 </dd>
5390 <dt class="hdlist1">
5391 diff.colorMovedWS
5392 </dt>
5393 <dd>
5394 <p>
5395         When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5396         this option controls the <code>&lt;mode&gt;</code> how spaces are treated.
5397         For details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.
5398 </p>
5399 </dd>
5400 <dt class="hdlist1">
5401 diff.tool
5402 </dt>
5403 <dd>
5404 <p>
5405         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
5406         This variable overrides the value configured in <code>merge.tool</code>.
5407         The list below shows the valid built-in values.
5408         Any other value is treated as a custom diff tool and requires
5409         that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
5410 </p>
5411 </dd>
5412 <dt class="hdlist1">
5413 diff.guitool
5414 </dt>
5415 <dd>
5416 <p>
5417         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
5418         the -g/--gui flag is specified. This variable overrides the value
5419         configured in <code>merge.guitool</code>. The list below shows the valid
5420         built-in values. Any other value is treated as a custom diff tool
5421         and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
5422         is defined.
5423 </p>
5424 </dd>
5425 <dt class="hdlist1">
5426 difftool.&lt;tool&gt;.cmd
5427 </dt>
5428 <dd>
5429 <p>
5430         Specify the command to invoke the specified diff tool.
5431         The specified command is evaluated in shell with the following
5432         variables available:  <em>LOCAL</em> is set to the name of the temporary
5433         file containing the contents of the diff pre-image and <em>REMOTE</em>
5434         is set to the name of the temporary file containing the contents
5435         of the diff post-image.
5436 </p>
5437 <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>
5438 </dd>
5439 <dt class="hdlist1">
5440 difftool.&lt;tool&gt;.path
5441 </dt>
5442 <dd>
5443 <p>
5444         Override the path for the given tool.  This is useful in case
5445         your tool is not in the PATH.
5446 </p>
5447 </dd>
5448 <dt class="hdlist1">
5449 difftool.trustExitCode
5450 </dt>
5451 <dd>
5452 <p>
5453         Exit difftool if the invoked diff tool returns a non-zero exit status.
5454 </p>
5455 <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>
5456 </dd>
5457 <dt class="hdlist1">
5458 difftool.prompt
5459 </dt>
5460 <dd>
5461 <p>
5462         Prompt before each invocation of the diff tool.
5463 </p>
5464 </dd>
5465 <dt class="hdlist1">
5466 difftool.guiDefault
5467 </dt>
5468 <dd>
5469 <p>
5470         Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5471         the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5472         depending on the presence of a <code>DISPLAY</code> environment variable value. The
5473         default is <code>false</code>, where the <code>--gui</code> argument must be provided
5474         explicitly for the <code>diff.guitool</code> to be used.
5475 </p>
5476 </dd>
5477 <dt class="hdlist1">
5478 extensions.objectFormat
5479 </dt>
5480 <dd>
5481 <p>
5482         Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
5483         <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
5484         this key unless <code>core.repositoryFormatVersion</code> is 1.
5485 </p>
5486 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5487 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
5488 work and will produce hard-to-diagnose issues.</p></div>
5489 </dd>
5490 <dt class="hdlist1">
5491 extensions.compatObjectFormat
5492 </dt>
5493 <dd>
5494 <p>
5495         Specify a compatitbility hash algorithm to use.  The acceptable values
5496         are <code>sha1</code> and <code>sha256</code>.  The value specified must be different from the
5497         value of extensions.objectFormat.  This allows client level
5498         interoperability between git repositories whose objectFormat matches
5499         this compatObjectFormat.  In particular when fully implemented the
5500         pushes and pulls from a repository in whose objectFormat matches
5501         compatObjectFormat.  As well as being able to use oids encoded in
5502         compatObjectFormat in addition to oids encoded with objectFormat to
5503         locally specify objects.
5504 </p>
5505 </dd>
5506 <dt class="hdlist1">
5507 extensions.refStorage
5508 </dt>
5509 <dd>
5510 <p>
5511         Specify the ref storage format to use. The acceptable values are:
5512 </p>
5513 <div class="ulist"><ul>
5514 <li>
5515 <p>
5516 <code>files</code> for loose files with packed-refs. This is the default.
5517 </p>
5518 </li>
5519 <li>
5520 <p>
5521 <code>reftable</code> for the reftable format. This format is experimental and its
5522   internals are subject to change.
5523 </p>
5524 <div class="paragraph"><p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p></div>
5525 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5526 <a href="git-clone.html">git-clone(1)</a>. Trying to change it after initialization will not
5527 work and will produce hard-to-diagnose issues.</p></div>
5528 </li>
5529 </ul></div>
5530 </dd>
5531 <dt class="hdlist1">
5532 extensions.worktreeConfig
5533 </dt>
5534 <dd>
5535 <p>
5536         If enabled, then worktrees will load config settings from the
5537         <code>$GIT_DIR/config.worktree</code> file in addition to the
5538         <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5539         <code>$GIT_DIR</code> are the same for the main working tree, while other
5540         working trees have <code>$GIT_DIR</code> equal to
5541         <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
5542         <code>config.worktree</code> file will override settings from any other
5543         config files.
5544 </p>
5545 <div class="paragraph"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5546 certain values from the common config file to the main working tree&#8217;s
5547 <code>config.worktree</code> file, if present:</p></div>
5548 <div class="ulist"><ul>
5549 <li>
5550 <p>
5551 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5552   <code>$GIT_COMMON_DIR/config.worktree</code>.
5553 </p>
5554 </li>
5555 <li>
5556 <p>
5557 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5558   to <code>$GIT_COMMON_DIR/config.worktree</code>.
5559 </p>
5560 <div class="paragraph"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5561 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5562 sparse-checkout settings for each worktree. By default, the <code>git
5563 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5564 these config values on a per-worktree basis, and uses the
5565 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5566 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
5567 details.</p></div>
5568 <div class="paragraph"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5569 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5570 </li>
5571 </ul></div>
5572 </dd>
5573 <dt class="hdlist1">
5574 fastimport.unpackLimit
5575 </dt>
5576 <dd>
5577 <p>
5578         If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
5579         is below this limit, then the objects will be unpacked into
5580         loose object files.  However, if the number of imported objects
5581         equals or exceeds this limit, then the pack will be stored as a
5582         pack.  Storing the pack from a fast-import can make the import
5583         operation complete faster, especially on slow filesystems.  If
5584         not set, the value of <code>transfer.unpackLimit</code> is used instead.
5585 </p>
5586 </dd>
5587 <dt class="hdlist1">
5588 feature.*
5589 </dt>
5590 <dd>
5591 <p>
5592         The config settings that start with <code>feature.</code> modify the defaults of
5593         a group of other config settings. These groups are created by the Git
5594         developer community as recommended defaults and are subject to change.
5595         In particular, new config options may be added with different defaults.
5596 </p>
5597 </dd>
5598 <dt class="hdlist1">
5599 feature.experimental
5600 </dt>
5601 <dd>
5602 <p>
5603         Enable config options that are new to Git, and are being considered for
5604         future defaults. Config settings included here may be added or removed
5605         with each release, including minor version updates. These settings may
5606         have unintended interactions since they are so new. Please enable this
5607         setting if you are interested in providing feedback on experimental
5608         features. The new default values are:
5609 </p>
5610 <div class="ulist"><ul>
5611 <li>
5612 <p>
5613 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5614 skipping more commits at a time, reducing the number of round trips.
5615 </p>
5616 </li>
5617 <li>
5618 <p>
5619 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5620 walking fewer objects.
5621 </p>
5622 </li>
5623 <li>
5624 <p>
5625 <code>pack.allowPackReuse=multi</code> may improve the time it takes to create a pack by
5626 reusing objects from multiple packs instead of just one.
5627 </p>
5628 </li>
5629 </ul></div>
5630 </dd>
5631 <dt class="hdlist1">
5632 feature.manyFiles
5633 </dt>
5634 <dd>
5635 <p>
5636         Enable config options that optimize for repos with many files in the
5637         working directory. With many files, commands such as <code>git status</code> and
5638         <code>git checkout</code> may be slow and these new defaults improve performance:
5639 </p>
5640 <div class="ulist"><ul>
5641 <li>
5642 <p>
5643 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5644   checksum. Note that this will cause Git versions earlier than 2.13.0 to
5645   refuse to parse the index and Git versions earlier than 2.40.0 will report
5646   a corrupted index during <code>git fsck</code>.
5647 </p>
5648 </li>
5649 <li>
5650 <p>
5651 <code>index.version=4</code> enables path-prefix compression in the index.
5652 </p>
5653 </li>
5654 <li>
5655 <p>
5656 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5657 that mtime is working on your machine.
5658 </p>
5659 </li>
5660 </ul></div>
5661 </dd>
5662 <dt class="hdlist1">
5663 fetch.recurseSubmodules
5664 </dt>
5665 <dd>
5666 <p>
5667         This option controls whether <code>git fetch</code> (and the underlying fetch
5668         in <code>git pull</code>) will recursively fetch into populated submodules.
5669         This option can be set either to a boolean value or to <em>on-demand</em>.
5670         Setting it to a boolean changes the behavior of fetch and pull to
5671         recurse unconditionally into submodules when set to true or to not
5672         recurse at all when set to false. When set to <em>on-demand</em>, fetch and
5673         pull will only recurse into a populated submodule when its
5674         superproject retrieves a commit that updates the submodule&#8217;s
5675         reference.
5676         Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
5677 </p>
5678 </dd>
5679 <dt class="hdlist1">
5680 fetch.fsckObjects
5681 </dt>
5682 <dd>
5683 <p>
5684         If it is set to true, git-fetch-pack will check all fetched
5685         objects. See <code>transfer.fsckObjects</code> for what&#8217;s
5686         checked. Defaults to false. If not set, the value of
5687         <code>transfer.fsckObjects</code> is used instead.
5688 </p>
5689 </dd>
5690 <dt class="hdlist1">
5691 fetch.fsck.&lt;msg-id&gt;
5692 </dt>
5693 <dd>
5694 <p>
5695         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
5696         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5697         the <code>fsck.&lt;msg-id&gt;</code> documentation for details.
5698 </p>
5699 </dd>
5700 <dt class="hdlist1">
5701 fetch.fsck.skipList
5702 </dt>
5703 <dd>
5704 <p>
5705         Acts like <code>fsck.skipList</code>, but is used by
5706         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5707         the <code>fsck.skipList</code> documentation for details.
5708 </p>
5709 </dd>
5710 <dt class="hdlist1">
5711 fetch.unpackLimit
5712 </dt>
5713 <dd>
5714 <p>
5715         If the number of objects fetched over the Git native
5716         transfer is below this
5717         limit, then the objects will be unpacked into loose object
5718         files. However if the number of received objects equals or
5719         exceeds this limit then the received pack will be stored as
5720         a pack, after adding any missing delta bases.  Storing the
5721         pack from a push can make the push operation complete faster,
5722         especially on slow filesystems.  If not set, the value of
5723         <code>transfer.unpackLimit</code> is used instead.
5724 </p>
5725 </dd>
5726 <dt class="hdlist1">
5727 fetch.prune
5728 </dt>
5729 <dd>
5730 <p>
5731         If true, fetch will automatically behave as if the <code>--prune</code>
5732         option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
5733         and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.
5734 </p>
5735 </dd>
5736 <dt class="hdlist1">
5737 fetch.pruneTags
5738 </dt>
5739 <dd>
5740 <p>
5741         If true, fetch will automatically behave as if the
5742         <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
5743         if not set already. This allows for setting both this option
5744         and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
5745         refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
5746         section of <a href="git-fetch.html">git-fetch(1)</a>.
5747 </p>
5748 </dd>
5749 <dt class="hdlist1">
5750 fetch.all
5751 </dt>
5752 <dd>
5753 <p>
5754         If true, fetch will attempt to update all available remotes.
5755         This behavior can be overridden by passing <code>--no-all</code> or by
5756         explicitly specifying one or more remote(s) to fetch from.
5757         Defaults to false.
5758 </p>
5759 </dd>
5760 <dt class="hdlist1">
5761 fetch.output
5762 </dt>
5763 <dd>
5764 <p>
5765         Control how ref update status is printed. Valid values are
5766         <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
5767         OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.
5768 </p>
5769 </dd>
5770 <dt class="hdlist1">
5771 fetch.negotiationAlgorithm
5772 </dt>
5773 <dd>
5774 <p>
5775         Control how information about the commits in the local repository
5776         is sent when negotiating the contents of the packfile to be sent by
5777         the server.  Set to "consecutive" to use an algorithm that walks
5778         over consecutive commits checking each one.  Set to "skipping" to
5779         use an algorithm that skips commits in an effort to converge
5780         faster, but may result in a larger-than-necessary packfile; or set
5781         to "noop" to not send any information at all, which will almost
5782         certainly result in a larger-than-necessary packfile, but will skip
5783         the negotiation step.  Set to "default" to override settings made
5784         previously and use the default behaviour.  The default is normally
5785         "consecutive", but if <code>feature.experimental</code> is true, then the
5786         default is "skipping".  Unknown values will cause <em>git fetch</em> to
5787         error out.
5788 </p>
5789 <div class="paragraph"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
5790 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
5791 </dd>
5792 <dt class="hdlist1">
5793 fetch.showForcedUpdates
5794 </dt>
5795 <dd>
5796 <p>
5797         Set to false to enable <code>--no-show-forced-updates</code> in
5798         <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
5799         Defaults to true.
5800 </p>
5801 </dd>
5802 <dt class="hdlist1">
5803 fetch.parallel
5804 </dt>
5805 <dd>
5806 <p>
5807         Specifies the maximal number of fetch operations to be run in parallel
5808         at a time (submodules, or remotes when the <code>--multiple</code> option of
5809         <a href="git-fetch.html">git-fetch(1)</a> is in effect).
5810 </p>
5811 <div class="paragraph"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
5812 <div class="paragraph"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
5813 config setting.</p></div>
5814 </dd>
5815 <dt class="hdlist1">
5816 fetch.writeCommitGraph
5817 </dt>
5818 <dd>
5819 <p>
5820         Set to true to write a commit-graph after every <code>git fetch</code> command
5821         that downloads a pack-file from a remote. Using the <code>--split</code> option,
5822         most executions will create a very small commit-graph file on top of
5823         the existing commit-graph file(s). Occasionally, these files will
5824         merge and the write may take longer. Having an updated commit-graph
5825         file helps performance of many Git commands, including <code>git merge-base</code>,
5826         <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
5827 </p>
5828 </dd>
5829 <dt class="hdlist1">
5830 fetch.bundleURI
5831 </dt>
5832 <dd>
5833 <p>
5834         This value stores a URI for downloading Git object data from a bundle
5835         URI before performing an incremental fetch from the origin Git server.
5836         This is similar to how the <code>--bundle-uri</code> option behaves in
5837         <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
5838         <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
5839         list that is organized for incremental fetches.
5840 </p>
5841 <div class="paragraph"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
5842 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
5843 the new bundle URI.</p></div>
5844 </dd>
5845 <dt class="hdlist1">
5846 fetch.bundleCreationToken
5847 </dt>
5848 <dd>
5849 <p>
5850         When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
5851         list that uses the "creationToken" heuristic, this config value
5852         stores the maximum <code>creationToken</code> value of the downloaded bundles.
5853         This value is used to prevent downloading bundles in the future
5854         if the advertised <code>creationToken</code> is not strictly larger than this
5855         value.
5856 </p>
5857 <div class="paragraph"><p>The creation token values are chosen by the provider serving the specific
5858 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
5859 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
5860 </dd>
5861 <dt class="hdlist1">
5862 filter.&lt;driver&gt;.clean
5863 </dt>
5864 <dd>
5865 <p>
5866         The command which is used to convert the content of a worktree
5867         file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
5868         details.
5869 </p>
5870 </dd>
5871 <dt class="hdlist1">
5872 filter.&lt;driver&gt;.smudge
5873 </dt>
5874 <dd>
5875 <p>
5876         The command which is used to convert the content of a blob
5877         object to a worktree file upon checkout.  See
5878         <a href="gitattributes.html">gitattributes(5)</a> for details.
5879 </p>
5880 </dd>
5881 <dt class="hdlist1">
5882 format.attach
5883 </dt>
5884 <dd>
5885 <p>
5886         Enable multipart/mixed attachments as the default for
5887         <em>format-patch</em>.  The value can also be a double quoted string
5888         which will enable attachments as the default and set the
5889         value as the boundary.  See the --attach option in
5890         <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
5891         value, set it to an empty string.
5892 </p>
5893 </dd>
5894 <dt class="hdlist1">
5895 format.from
5896 </dt>
5897 <dd>
5898 <p>
5899         Provides the default value for the <code>--from</code> option to format-patch.
5900         Accepts a boolean value, or a name and email address.  If false,
5901         format-patch defaults to <code>--no-from</code>, using commit authors directly in
5902         the "From:" field of patch mails.  If true, format-patch defaults to
5903         <code>--from</code>, using your committer identity in the "From:" field of patch
5904         mails and including a "From:" field in the body of the patch mail if
5905         different.  If set to a non-boolean value, format-patch uses that
5906         value instead of your committer identity.  Defaults to false.
5907 </p>
5908 </dd>
5909 <dt class="hdlist1">
5910 format.forceInBodyFrom
5911 </dt>
5912 <dd>
5913 <p>
5914         Provides the default value for the <code>--[no-]force-in-body-from</code>
5915         option to format-patch.  Defaults to false.
5916 </p>
5917 </dd>
5918 <dt class="hdlist1">
5919 format.numbered
5920 </dt>
5921 <dd>
5922 <p>
5923         A boolean which can enable or disable sequence numbers in patch
5924         subjects.  It defaults to "auto" which enables it only if there
5925         is more than one patch.  It can be enabled or disabled for all
5926         messages by setting it to "true" or "false".  See --numbered
5927         option in <a href="git-format-patch.html">git-format-patch(1)</a>.
5928 </p>
5929 </dd>
5930 <dt class="hdlist1">
5931 format.headers
5932 </dt>
5933 <dd>
5934 <p>
5935         Additional email headers to include in a patch to be submitted
5936         by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.
5937 </p>
5938 </dd>
5939 <dt class="hdlist1">
5940 format.to
5941 </dt>
5942 <dt class="hdlist1">
5943 format.cc
5944 </dt>
5945 <dd>
5946 <p>
5947         Additional recipients to include in a patch to be submitted
5948         by mail.  See the --to and --cc options in
5949         <a href="git-format-patch.html">git-format-patch(1)</a>.
5950 </p>
5951 </dd>
5952 <dt class="hdlist1">
5953 format.subjectPrefix
5954 </dt>
5955 <dd>
5956 <p>
5957         The default for format-patch is to output files with the <em>[PATCH]</em>
5958         subject prefix. Use this variable to change that prefix.
5959 </p>
5960 </dd>
5961 <dt class="hdlist1">
5962 format.coverFromDescription
5963 </dt>
5964 <dd>
5965 <p>
5966         The default mode for format-patch to determine which parts of
5967         the cover letter will be populated using the branch&#8217;s
5968         description. See the <code>--cover-from-description</code> option in
5969         <a href="git-format-patch.html">git-format-patch(1)</a>.
5970 </p>
5971 </dd>
5972 <dt class="hdlist1">
5973 format.signature
5974 </dt>
5975 <dd>
5976 <p>
5977         The default for format-patch is to output a signature containing
5978         the Git version number. Use this variable to change that default.
5979         Set this variable to the empty string ("") to suppress
5980         signature generation.
5981 </p>
5982 </dd>
5983 <dt class="hdlist1">
5984 format.signatureFile
5985 </dt>
5986 <dd>
5987 <p>
5988         Works just like format.signature except the contents of the
5989         file specified by this variable will be used as the signature.
5990 </p>
5991 </dd>
5992 <dt class="hdlist1">
5993 format.suffix
5994 </dt>
5995 <dd>
5996 <p>
5997         The default for format-patch is to output files with the suffix
5998         <code>.patch</code>. Use this variable to change that suffix (make sure to
5999         include the dot if you want it).
6000 </p>
6001 </dd>
6002 <dt class="hdlist1">
6003 format.encodeEmailHeaders
6004 </dt>
6005 <dd>
6006 <p>
6007         Encode email headers that have non-ASCII characters with
6008         "Q-encoding" (described in RFC 2047) for email transmission.
6009         Defaults to true.
6010 </p>
6011 </dd>
6012 <dt class="hdlist1">
6013 format.pretty
6014 </dt>
6015 <dd>
6016 <p>
6017         The default pretty format for log/show/whatchanged command.
6018         See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
6019         <a href="git-whatchanged.html">git-whatchanged(1)</a>.
6020 </p>
6021 </dd>
6022 <dt class="hdlist1">
6023 format.thread
6024 </dt>
6025 <dd>
6026 <p>
6027         The default threading style for <em>git format-patch</em>.  Can be
6028         a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
6029         makes every mail a reply to the head of the series,
6030         where the head is chosen from the cover letter, the
6031         <code>--in-reply-to</code>, and the first patch mail, in this order.
6032         <code>deep</code> threading makes every mail a reply to the previous one.
6033         A true boolean value is the same as <code>shallow</code>, and a false
6034         value disables threading.
6035 </p>
6036 </dd>
6037 <dt class="hdlist1">
6038 format.signOff
6039 </dt>
6040 <dd>
6041 <p>
6042         A boolean value which lets you enable the <code>-s/--signoff</code> option of
6043         format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
6044         patch should be a conscious act and means that you certify you have
6045         the rights to submit this work under the same open source license.
6046         Please see the <em>SubmittingPatches</em> document for further discussion.
6047 </p>
6048 </dd>
6049 <dt class="hdlist1">
6050 format.coverLetter
6051 </dt>
6052 <dd>
6053 <p>
6054         A boolean that controls whether to generate a cover-letter when
6055         format-patch is invoked, but in addition can be set to "auto", to
6056         generate a cover-letter only when there&#8217;s more than one patch.
6057         Default is false.
6058 </p>
6059 </dd>
6060 <dt class="hdlist1">
6061 format.outputDirectory
6062 </dt>
6063 <dd>
6064 <p>
6065         Set a custom directory to store the resulting files instead of the
6066         current working directory. All directory components will be created.
6067 </p>
6068 </dd>
6069 <dt class="hdlist1">
6070 format.filenameMaxLength
6071 </dt>
6072 <dd>
6073 <p>
6074         The maximum length of the output filenames generated by the
6075         <code>format-patch</code> command; defaults to 64.  Can be overridden
6076         by the <code>--filename-max-length=&lt;n&gt;</code> command line option.
6077 </p>
6078 </dd>
6079 <dt class="hdlist1">
6080 format.useAutoBase
6081 </dt>
6082 <dd>
6083 <p>
6084         A boolean value which lets you enable the <code>--base=auto</code> option of
6085         format-patch by default. Can also be set to "whenAble" to allow
6086         enabling <code>--base=auto</code> if a suitable base is available, but to skip
6087         adding base info otherwise without the format dying.
6088 </p>
6089 </dd>
6090 <dt class="hdlist1">
6091 format.notes
6092 </dt>
6093 <dd>
6094 <p>
6095         Provides the default value for the <code>--notes</code> option to
6096         format-patch. Accepts a boolean value, or a ref which specifies
6097         where to get notes. If false, format-patch defaults to
6098         <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
6099         set to a non-boolean value, format-patch defaults to
6100         <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
6101         to false.
6102 </p>
6103 <div class="paragraph"><p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
6104 instead.</p></div>
6105 <div class="paragraph"><p>This configuration can be specified multiple times in order to allow
6106 multiple notes refs to be included. In that case, it will behave
6107 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
6108 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
6109 also show notes from that notes ref and a value of <code>false</code> will negate
6110 previous configurations and not show notes.</p></div>
6111 <div class="paragraph"><p>For example,</p></div>
6112 <div class="listingblock">
6113 <div class="content">
6114 <pre><code>[format]
6115         notes = true
6116         notes = foo
6117         notes = false
6118         notes = bar</code></pre>
6119 </div></div>
6120 <div class="paragraph"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
6121 </dd>
6122 <dt class="hdlist1">
6123 format.mboxrd
6124 </dt>
6125 <dd>
6126 <p>
6127         A boolean value which enables the robust "mboxrd" format when
6128         <code>--stdout</code> is in use to escape "^&gt;+From " lines.
6129 </p>
6130 </dd>
6131 <dt class="hdlist1">
6132 format.noprefix
6133 </dt>
6134 <dd>
6135 <p>
6136         If set, do not show any source or destination prefix in patches.
6137         This is equivalent to the <code>diff.noprefix</code> option used by <code>git
6138         diff</code> (but which is not respected by <code>format-patch</code>). Note that
6139         by setting this, the receiver of any patches you generate will
6140         have to apply them using the <code>-p0</code> option.
6141 </p>
6142 </dd>
6143 <dt class="hdlist1">
6144 fsck.&lt;msg-id&gt;
6145 </dt>
6146 <dd>
6147 <p>
6148         During fsck git may find issues with legacy data which
6149         wouldn&#8217;t be generated by current versions of git, and which
6150         wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
6151         set. This feature is intended to support working with legacy
6152         repositories containing such data.
6153 </p>
6154 <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
6155 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
6156 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
6157 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
6158 same applies for the corresponding <code>receive.fsck.*</code> and
6159 <code>fetch.fsck.*</code>. variables.</p></div>
6160 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
6161 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
6162 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
6163 uniformly configure the same fsck settings in different circumstances,
6164 all three of them must be set to the same values.</p></div>
6165 <div class="paragraph"><p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
6166 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
6167 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
6168 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
6169 with the message ID, e.g. "missingEmail: invalid author/committer
6170 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
6171 will hide that issue.</p></div>
6172 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
6173 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6174 problematic objects share to be ignored, as doing the latter will
6175 allow new instances of the same breakages go unnoticed.</p></div>
6176 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
6177 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
6178 will only cause git to warn.</p></div>
6179 <div class="paragraph"><p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
6180 values of <code>&lt;msg-id&gt;</code>.</p></div>
6181 </dd>
6182 <dt class="hdlist1">
6183 fsck.skipList
6184 </dt>
6185 <dd>
6186 <p>
6187         The path to a list of object names (i.e. one unabbreviated SHA-1 per
6188         line) that are known to be broken in a non-fatal way and should
6189         be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
6190         lines, and any leading and trailing whitespace are ignored. Everything
6191         but a SHA-1 per line will error out on older versions.
6192 </p>
6193 <div class="paragraph"><p>This feature is useful when an established project should be accepted
6194 despite early commits containing errors that can be safely ignored,
6195 such as invalid committer email addresses.  Note: corrupt objects
6196 cannot be skipped with this setting.</p></div>
6197 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
6198 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6199 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6200 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6201 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
6202 uniformly configure the same fsck settings in different circumstances,
6203 all three of them must be set to the same values.</p></div>
6204 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
6205 list should be sorted. This was never a requirement; the object names
6206 could appear in any order, but when reading the list we tracked whether
6207 the list was sorted for the purposes of an internal binary search
6208 implementation, which could save itself some work with an already sorted
6209 list. Unless you had a humongous list there was no reason to go out of
6210 your way to pre-sort the list. After Git version 2.20 a hash implementation
6211 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
6212 </dd>
6213 <dt class="hdlist1">
6214 fsmonitor.allowRemote
6215 </dt>
6216 <dd>
6217 <p>
6218     By default, the fsmonitor daemon refuses to work with network-mounted
6219     repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6220     behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6221 </p>
6222 </dd>
6223 <dt class="hdlist1">
6224 fsmonitor.socketDir
6225 </dt>
6226 <dd>
6227 <p>
6228     This Mac OS-specific option, if set, specifies the directory in
6229     which to create the Unix domain socket used for communication
6230     between the fsmonitor daemon and various Git commands. The directory must
6231     reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
6232     is set to <code>true</code>.
6233 </p>
6234 </dd>
6235 <dt class="hdlist1">
6236 gc.aggressiveDepth
6237 </dt>
6238 <dd>
6239 <p>
6240         The depth parameter used in the delta compression
6241         algorithm used by <em>git gc --aggressive</em>.  This defaults
6242         to 50, which is the default for the <code>--depth</code> option when
6243         <code>--aggressive</code> isn&#8217;t in use.
6244 </p>
6245 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
6246 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6247 </dd>
6248 <dt class="hdlist1">
6249 gc.aggressiveWindow
6250 </dt>
6251 <dd>
6252 <p>
6253         The window size parameter used in the delta compression
6254         algorithm used by <em>git gc --aggressive</em>.  This defaults
6255         to 250, which is a much more aggressive window size than
6256         the default <code>--window</code> of 10.
6257 </p>
6258 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
6259 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6260 </dd>
6261 <dt class="hdlist1">
6262 gc.auto
6263 </dt>
6264 <dd>
6265 <p>
6266         When there are approximately more than this many loose
6267         objects in the repository, <code>git gc --auto</code> will pack them.
6268         Some Porcelain commands use this command to perform a
6269         light-weight garbage collection from time to time.  The
6270         default value is 6700.
6271 </p>
6272 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
6273 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
6274 otherwise use to determine if there&#8217;s work to do, such as
6275 <code>gc.autoPackLimit</code>.</p></div>
6276 </dd>
6277 <dt class="hdlist1">
6278 gc.autoPackLimit
6279 </dt>
6280 <dd>
6281 <p>
6282         When there are more than this many packs that are not
6283         marked with <code>*.keep</code> file in the repository, <code>git gc
6284         --auto</code> consolidates them into one larger pack.  The
6285         default value is 50.  Setting this to 0 disables it.
6286         Setting <code>gc.auto</code> to 0 will also disable this.
6287 </p>
6288 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6289 use, it&#8217;ll affect how the auto pack limit works.</p></div>
6290 </dd>
6291 <dt class="hdlist1">
6292 gc.autoDetach
6293 </dt>
6294 <dd>
6295 <p>
6296         Make <code>git gc --auto</code> return immediately and run in the background
6297         if the system supports it. Default is true.
6298 </p>
6299 </dd>
6300 <dt class="hdlist1">
6301 gc.bigPackThreshold
6302 </dt>
6303 <dd>
6304 <p>
6305         If non-zero, all non-cruft packs larger than this limit are kept
6306         when <code>git gc</code> is run. This is very similar to
6307         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6308         the threshold are kept, not just the largest pack. Defaults to
6309         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6310 </p>
6311 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6312 this configuration variable is ignored, all packs except the base pack
6313 will be repacked. After this the number of packs should go below
6314 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6315 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6316 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6317 will also be excluded (this is the equivalent of running <code>git gc</code> with
6318 <code>--keep-largest-pack</code>).</p></div>
6319 </dd>
6320 <dt class="hdlist1">
6321 gc.writeCommitGraph
6322 </dt>
6323 <dd>
6324 <p>
6325         If true, then gc will rewrite the commit-graph file when
6326         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6327         the commit-graph will be updated if housekeeping is
6328         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
6329         for details.
6330 </p>
6331 </dd>
6332 <dt class="hdlist1">
6333 gc.logExpiry
6334 </dt>
6335 <dd>
6336 <p>
6337         If the file gc.log exists, then <code>git gc --auto</code> will print
6338         its content and exit with status zero instead of running
6339         unless that file is more than <em>gc.logExpiry</em> old.  Default is
6340         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
6341         value.
6342 </p>
6343 </dd>
6344 <dt class="hdlist1">
6345 gc.packRefs
6346 </dt>
6347 <dd>
6348 <p>
6349         Running <code>git pack-refs</code> in a repository renders it
6350         unclonable by Git versions prior to 1.5.1.2 over dumb
6351         transports such as HTTP.  This variable determines whether
6352         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6353         to enable it within all non-bare repos or it can be set to a
6354         boolean value.  The default is <code>true</code>.
6355 </p>
6356 </dd>
6357 <dt class="hdlist1">
6358 gc.cruftPacks
6359 </dt>
6360 <dd>
6361 <p>
6362         Store unreachable objects in a cruft pack (see
6363         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
6364         is <code>true</code>.
6365 </p>
6366 </dd>
6367 <dt class="hdlist1">
6368 gc.maxCruftSize
6369 </dt>
6370 <dd>
6371 <p>
6372         Limit the size of new cruft packs when repacking. When
6373         specified in addition to <code>--max-cruft-size</code>, the command line
6374         option takes priority. See the <code>--max-cruft-size</code> option of
6375         <a href="git-repack.html">git-repack(1)</a>.
6376 </p>
6377 </dd>
6378 <dt class="hdlist1">
6379 gc.pruneExpire
6380 </dt>
6381 <dd>
6382 <p>
6383         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6384         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6385         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
6386         grace period with this config variable.  The value "now" may be
6387         used to disable this grace period and always prune unreachable
6388         objects immediately, or "never" may be used to suppress pruning.
6389         This feature helps prevent corruption when <em>git gc</em> runs
6390         concurrently with another process writing to the repository; see
6391         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
6392 </p>
6393 </dd>
6394 <dt class="hdlist1">
6395 gc.worktreePruneExpire
6396 </dt>
6397 <dd>
6398 <p>
6399         When <em>git gc</em> is run, it calls
6400         <em>git worktree prune --expire 3.months.ago</em>.
6401         This config variable can be used to set a different grace
6402         period. The value "now" may be used to disable the grace
6403         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
6404         may be used to suppress pruning.
6405 </p>
6406 </dd>
6407 <dt class="hdlist1">
6408 gc.reflogExpire
6409 </dt>
6410 <dt class="hdlist1">
6411 gc.&lt;pattern&gt;.reflogExpire
6412 </dt>
6413 <dd>
6414 <p>
6415         <em>git reflog expire</em> removes reflog entries older than
6416         this time; defaults to 90 days. The value "now" expires all
6417         entries immediately, and "never" suppresses expiration
6418         altogether. With "&lt;pattern&gt;" (e.g.
6419         "refs/stash") in the middle the setting applies only to
6420         the refs that match the &lt;pattern&gt;.
6421 </p>
6422 </dd>
6423 <dt class="hdlist1">
6424 gc.reflogExpireUnreachable
6425 </dt>
6426 <dt class="hdlist1">
6427 gc.&lt;pattern&gt;.reflogExpireUnreachable
6428 </dt>
6429 <dd>
6430 <p>
6431         <em>git reflog expire</em> removes reflog entries older than
6432         this time and are not reachable from the current tip;
6433         defaults to 30 days. The value "now" expires all entries
6434         immediately, and "never" suppresses expiration altogether.
6435         With "&lt;pattern&gt;" (e.g. "refs/stash")
6436         in the middle, the setting applies only to the refs that
6437         match the &lt;pattern&gt;.
6438 </p>
6439 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
6440 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6441 or rebase occurring.  Since these changes are not part of the current
6442 project most users will want to expire them sooner, which is why the
6443 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6444 </dd>
6445 <dt class="hdlist1">
6446 gc.recentObjectsHook
6447 </dt>
6448 <dd>
6449 <p>
6450         When considering whether or not to remove an object (either when
6451         generating a cruft pack or storing unreachable objects as
6452         loose), use the shell to execute the specified command(s).
6453         Interpret their output as object IDs which Git will consider as
6454         "recent", regardless of their age. By treating their mtimes as
6455         "now", any objects (and their descendants) mentioned in the
6456         output will be kept regardless of their true age.
6457 </p>
6458 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
6459 else. Objects which cannot be found in the repository are ignored.
6460 Multiple hooks are supported, but all must exit successfully, else the
6461 operation (either generating a cruft pack or unpacking unreachable
6462 objects) will be halted.</p></div>
6463 </dd>
6464 <dt class="hdlist1">
6465 gc.repackFilter
6466 </dt>
6467 <dd>
6468 <p>
6469         When repacking, use the specified filter to move certain
6470         objects into a separate packfile.  See the
6471         <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.
6472 </p>
6473 </dd>
6474 <dt class="hdlist1">
6475 gc.repackFilterTo
6476 </dt>
6477 <dd>
6478 <p>
6479         When repacking and using a filter, see <code>gc.repackFilter</code>, the
6480         specified location will be used to create the packfile
6481         containing the filtered out objects. <strong>WARNING:</strong> The
6482         specified location should be accessible, using for example the
6483         Git alternates mechanism, otherwise the repo could be
6484         considered corrupt by Git as it migh not be able to access the
6485         objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
6486         of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
6487         section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.
6488 </p>
6489 </dd>
6490 <dt class="hdlist1">
6491 gc.rerereResolved
6492 </dt>
6493 <dd>
6494 <p>
6495         Records of conflicted merge you resolved earlier are
6496         kept for this many days when <em>git rerere gc</em> is run.
6497         You can also use more human-readable "1.month.ago", etc.
6498         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6499 </p>
6500 </dd>
6501 <dt class="hdlist1">
6502 gc.rerereUnresolved
6503 </dt>
6504 <dd>
6505 <p>
6506         Records of conflicted merge you have not resolved are
6507         kept for this many days when <em>git rerere gc</em> is run.
6508         You can also use more human-readable "1.month.ago", etc.
6509         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6510 </p>
6511 </dd>
6512 <dt class="hdlist1">
6513 gitcvs.commitMsgAnnotation
6514 </dt>
6515 <dd>
6516 <p>
6517         Append this string to each commit message. Set to empty string
6518         to disable this feature. Defaults to "via git-CVS emulator".
6519 </p>
6520 </dd>
6521 <dt class="hdlist1">
6522 gitcvs.enabled
6523 </dt>
6524 <dd>
6525 <p>
6526         Whether the CVS server interface is enabled for this repository.
6527         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6528 </p>
6529 </dd>
6530 <dt class="hdlist1">
6531 gitcvs.logFile
6532 </dt>
6533 <dd>
6534 <p>
6535         Path to a log file where the CVS server interface well&#8230; logs
6536         various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6537 </p>
6538 </dd>
6539 <dt class="hdlist1">
6540 gitcvs.usecrlfattr
6541 </dt>
6542 <dd>
6543 <p>
6544         If true, the server will look up the end-of-line conversion
6545         attributes for files to determine the <code>-k</code> modes to use. If
6546         the attributes force Git to treat a file as text,
6547         the <code>-k</code> mode will be left blank so CVS clients will
6548         treat it as text. If they suppress text conversion, the file
6549         will be set with <em>-kb</em> mode, which suppresses any newline munging
6550         the client might otherwise do. If the attributes do not allow
6551         the file type to be determined, then <code>gitcvs.allBinary</code> is
6552         used. See <a href="gitattributes.html">gitattributes(5)</a>.
6553 </p>
6554 </dd>
6555 <dt class="hdlist1">
6556 gitcvs.allBinary
6557 </dt>
6558 <dd>
6559 <p>
6560         This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6561         the correct <em>-kb</em> mode to use. If true, all
6562         unresolved files are sent to the client in
6563         mode <em>-kb</em>. This causes the client to treat them
6564         as binary files, which suppresses any newline munging it
6565         otherwise might do. Alternatively, if it is set to "guess",
6566         then the contents of the file are examined to decide if
6567         it is binary, similar to <code>core.autocrlf</code>.
6568 </p>
6569 </dd>
6570 <dt class="hdlist1">
6571 gitcvs.dbName
6572 </dt>
6573 <dd>
6574 <p>
6575         Database used by git-cvsserver to cache revision information
6576         derived from the Git repository. The exact meaning depends on the
6577         used database driver, for SQLite (which is the default driver) this
6578         is a filename. Supports variable substitution (see
6579         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6580         Default: <em>%Ggitcvs.%m.sqlite</em>
6581 </p>
6582 </dd>
6583 <dt class="hdlist1">
6584 gitcvs.dbDriver
6585 </dt>
6586 <dd>
6587 <p>
6588         Used Perl DBI driver. You can specify any available driver
6589         for this here, but it might not work. git-cvsserver is tested
6590         with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6591         reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6592         May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6593         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6594 </p>
6595 </dd>
6596 <dt class="hdlist1">
6597 gitcvs.dbUser, gitcvs.dbPass
6598 </dt>
6599 <dd>
6600 <p>
6601         Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6602         since SQLite has no concept of database users and/or passwords.
6603         <em>gitcvs.dbUser</em> supports variable substitution (see
6604         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
6605 </p>
6606 </dd>
6607 <dt class="hdlist1">
6608 gitcvs.dbTableNamePrefix
6609 </dt>
6610 <dd>
6611 <p>
6612         Database table name prefix.  Prepended to the names of any
6613         database tables used, allowing a single database to be used
6614         for several repositories.  Supports variable substitution (see
6615         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
6616         characters will be replaced with underscores.
6617 </p>
6618 </dd>
6619 </dl></div>
6620 <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6621 <code>gitcvs.allBinary</code> can also be specified as
6622 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
6623 is one of "ext" and "pserver") to make them apply only for the given
6624 access method.</p></div>
6625 <div class="dlist"><dl>
6626 <dt class="hdlist1">
6627 gitweb.category
6628 </dt>
6629 <dt class="hdlist1">
6630 gitweb.description
6631 </dt>
6632 <dt class="hdlist1">
6633 gitweb.owner
6634 </dt>
6635 <dt class="hdlist1">
6636 gitweb.url
6637 </dt>
6638 <dd>
6639 <p>
6640         See <a href="gitweb.html">gitweb(1)</a> for description.
6641 </p>
6642 </dd>
6643 <dt class="hdlist1">
6644 gitweb.avatar
6645 </dt>
6646 <dt class="hdlist1">
6647 gitweb.blame
6648 </dt>
6649 <dt class="hdlist1">
6650 gitweb.grep
6651 </dt>
6652 <dt class="hdlist1">
6653 gitweb.highlight
6654 </dt>
6655 <dt class="hdlist1">
6656 gitweb.patches
6657 </dt>
6658 <dt class="hdlist1">
6659 gitweb.pickaxe
6660 </dt>
6661 <dt class="hdlist1">
6662 gitweb.remote_heads
6663 </dt>
6664 <dt class="hdlist1">
6665 gitweb.showSizes
6666 </dt>
6667 <dt class="hdlist1">
6668 gitweb.snapshot
6669 </dt>
6670 <dd>
6671 <p>
6672         See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
6673 </p>
6674 </dd>
6675 <dt class="hdlist1">
6676 gpg.program
6677 </dt>
6678 <dd>
6679 <p>
6680         Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
6681         making or verifying a PGP signature. The program must support the
6682         same command-line interface as GPG, namely, to verify a detached
6683         signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
6684         program is expected to signal a good signature by exiting with
6685         code 0.  To generate an ASCII-armored detached signature, the
6686         standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
6687         signed, and the program is expected to send the result to its
6688         standard output.
6689 </p>
6690 </dd>
6691 <dt class="hdlist1">
6692 gpg.format
6693 </dt>
6694 <dd>
6695 <p>
6696         Specifies which key format to use when signing with <code>--gpg-sign</code>.
6697         Default is "openpgp". Other possible values are "x509", "ssh".
6698 </p>
6699 <div class="paragraph"><p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
6700 based on the selected <code>gpg.format</code>.</p></div>
6701 </dd>
6702 <dt class="hdlist1">
6703 gpg.&lt;format&gt;.program
6704 </dt>
6705 <dd>
6706 <p>
6707         Use this to customize the program used for the signing format you
6708         chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
6709         be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
6710         value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".
6711 </p>
6712 </dd>
6713 <dt class="hdlist1">
6714 gpg.minTrustLevel
6715 </dt>
6716 <dd>
6717 <p>
6718         Specifies a minimum trust level for signature verification.  If
6719         this option is unset, then signature verification for merge
6720         operations requires a key with at least <code>marginal</code> trust.  Other
6721         operations that perform signature verification require a key
6722         with at least <code>undefined</code> trust.  Setting this option overrides
6723         the required trust-level for all operations.  Supported values,
6724         in increasing order of significance:
6725 </p>
6726 <div class="ulist"><ul>
6727 <li>
6728 <p>
6729 <code>undefined</code>
6730 </p>
6731 </li>
6732 <li>
6733 <p>
6734 <code>never</code>
6735 </p>
6736 </li>
6737 <li>
6738 <p>
6739 <code>marginal</code>
6740 </p>
6741 </li>
6742 <li>
6743 <p>
6744 <code>fully</code>
6745 </p>
6746 </li>
6747 <li>
6748 <p>
6749 <code>ultimate</code>
6750 </p>
6751 </li>
6752 </ul></div>
6753 </dd>
6754 <dt class="hdlist1">
6755 gpg.ssh.defaultKeyCommand
6756 </dt>
6757 <dd>
6758 <p>
6759         This command will be run when user.signingkey is not set and a ssh
6760         signature is requested. On successful exit a valid ssh public key
6761         prefixed with <code>key::</code> is expected in the first line of its output.
6762         This allows for a script doing a dynamic lookup of the correct public
6763         key when it is impractical to statically configure <code>user.signingKey</code>.
6764         For example when keys or SSH Certificates are rotated frequently or
6765         selection of the right key depends on external factors unknown to git.
6766 </p>
6767 </dd>
6768 <dt class="hdlist1">
6769 gpg.ssh.allowedSignersFile
6770 </dt>
6771 <dd>
6772 <p>
6773         A file containing ssh public keys which you are willing to trust.
6774         The file consists of one or more lines of principals followed by an ssh
6775         public key.
6776         e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
6777         See ssh-keygen(1) "ALLOWED SIGNERS" for details.
6778         The principal is only used to identify the key and is available when
6779         verifying a signature.
6780 </p>
6781 <div class="paragraph"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
6782 between valid signatures and trusted signatures the trust level of a signature
6783 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
6784 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
6785 <div class="paragraph"><p>This file can be set to a location outside of the repository and every developer
6786 maintains their own trust store. A central repository server could generate this
6787 file automatically from ssh keys with push access to verify the code against.
6788 In a corporate setting this file is probably generated at a global location
6789 from automation that already handles developer ssh keys.</p></div>
6790 <div class="paragraph"><p>A repository that only allows signed commits can store the file
6791 in the repository itself using a path relative to the top-level of the working tree.
6792 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
6793 <div class="paragraph"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
6794 valid-before options. Git will mark signatures as valid if the signing key was
6795 valid at the time of the signature&#8217;s creation. This allows users to change a
6796 signing key without invalidating all previously made signatures.</p></div>
6797 <div class="paragraph"><p>Using a SSH CA key with the cert-authority option
6798 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p></div>
6799 </dd>
6800 <dt class="hdlist1">
6801 gpg.ssh.revocationFile
6802 </dt>
6803 <dd>
6804 <p>
6805         Either a SSH KRL or a list of revoked public keys (without the principal prefix).
6806         See ssh-keygen(1) for details.
6807         If a public key is found in this file then it will always be treated
6808         as having trust level "never" and signatures will show as invalid.
6809 </p>
6810 </dd>
6811 <dt class="hdlist1">
6812 grep.lineNumber
6813 </dt>
6814 <dd>
6815 <p>
6816         If set to true, enable <code>-n</code> option by default.
6817 </p>
6818 </dd>
6819 <dt class="hdlist1">
6820 grep.column
6821 </dt>
6822 <dd>
6823 <p>
6824         If set to true, enable the <code>--column</code> option by default.
6825 </p>
6826 </dd>
6827 <dt class="hdlist1">
6828 grep.patternType
6829 </dt>
6830 <dd>
6831 <p>
6832         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
6833         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
6834         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
6835         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
6836         between <em>basic</em> and <em>extended</em>.
6837 </p>
6838 </dd>
6839 <dt class="hdlist1">
6840 grep.extendedRegexp
6841 </dt>
6842 <dd>
6843 <p>
6844         If set to true, enable <code>--extended-regexp</code> option by default. This
6845         option is ignored when the <code>grep.patternType</code> option is set to a value
6846         other than <em>default</em>.
6847 </p>
6848 </dd>
6849 <dt class="hdlist1">
6850 grep.threads
6851 </dt>
6852 <dd>
6853 <p>
6854         Number of grep worker threads to use. If unset (or set to 0), Git will
6855         use as many threads as the number of logical cores available.
6856 </p>
6857 </dd>
6858 <dt class="hdlist1">
6859 grep.fullName
6860 </dt>
6861 <dd>
6862 <p>
6863         If set to true, enable <code>--full-name</code> option by default.
6864 </p>
6865 </dd>
6866 <dt class="hdlist1">
6867 grep.fallbackToNoIndex
6868 </dt>
6869 <dd>
6870 <p>
6871         If set to true, fall back to <code>git grep --no-index</code> if <code>git grep</code>
6872         is executed outside of a git repository.  Defaults to false.
6873 </p>
6874 </dd>
6875 <dt class="hdlist1">
6876 gui.commitMsgWidth
6877 </dt>
6878 <dd>
6879 <p>
6880         Defines how wide the commit message window is in the
6881         <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
6882 </p>
6883 </dd>
6884 <dt class="hdlist1">
6885 gui.diffContext
6886 </dt>
6887 <dd>
6888 <p>
6889         Specifies how many context lines should be used in calls to diff
6890         made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
6891 </p>
6892 </dd>
6893 <dt class="hdlist1">
6894 gui.displayUntracked
6895 </dt>
6896 <dd>
6897 <p>
6898         Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
6899         in the file list. The default is "true".
6900 </p>
6901 </dd>
6902 <dt class="hdlist1">
6903 gui.encoding
6904 </dt>
6905 <dd>
6906 <p>
6907         Specifies the default character encoding to use for displaying of
6908         file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
6909         It can be overridden by setting the <em>encoding</em> attribute
6910         for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
6911         If this option is not set, the tools default to the
6912         locale encoding.
6913 </p>
6914 </dd>
6915 <dt class="hdlist1">
6916 gui.matchTrackingBranch
6917 </dt>
6918 <dd>
6919 <p>
6920         Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
6921         default to tracking remote branches with matching names or
6922         not. Default: "false".
6923 </p>
6924 </dd>
6925 <dt class="hdlist1">
6926 gui.newBranchTemplate
6927 </dt>
6928 <dd>
6929 <p>
6930         Is used as a suggested name when creating new branches using the
6931         <a href="git-gui.html">git-gui(1)</a>.
6932 </p>
6933 </dd>
6934 <dt class="hdlist1">
6935 gui.pruneDuringFetch
6936 </dt>
6937 <dd>
6938 <p>
6939         "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
6940         performing a fetch. The default value is "false".
6941 </p>
6942 </dd>
6943 <dt class="hdlist1">
6944 gui.trustmtime
6945 </dt>
6946 <dd>
6947 <p>
6948         Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
6949         timestamp or not. By default the timestamps are not trusted.
6950 </p>
6951 </dd>
6952 <dt class="hdlist1">
6953 gui.spellingDictionary
6954 </dt>
6955 <dd>
6956 <p>
6957         Specifies the dictionary used for spell checking commit messages in
6958         the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
6959         off.
6960 </p>
6961 </dd>
6962 <dt class="hdlist1">
6963 gui.fastCopyBlame
6964 </dt>
6965 <dd>
6966 <p>
6967         If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
6968         location detection. It makes blame significantly faster on huge
6969         repositories at the expense of less thorough copy detection.
6970 </p>
6971 </dd>
6972 <dt class="hdlist1">
6973 gui.copyBlameThreshold
6974 </dt>
6975 <dd>
6976 <p>
6977         Specifies the threshold to use in <em>git gui blame</em> original location
6978         detection, measured in alphanumeric characters. See the
6979         <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
6980 </p>
6981 </dd>
6982 <dt class="hdlist1">
6983 gui.blamehistoryctx
6984 </dt>
6985 <dd>
6986 <p>
6987         Specifies the radius of history context in days to show in
6988         <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
6989         Context</code> menu item is invoked from <em>git gui blame</em>. If this
6990         variable is set to zero, the whole history is shown.
6991 </p>
6992 </dd>
6993 <dt class="hdlist1">
6994 guitool.&lt;name&gt;.cmd
6995 </dt>
6996 <dd>
6997 <p>
6998         Specifies the shell command line to execute when the corresponding item
6999         of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
7000         mandatory for every tool. The command is executed from the root of
7001         the working directory, and in the environment it receives the name of
7002         the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
7003         <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
7004         the head is detached, <em>CUR_BRANCH</em> is empty).
7005 </p>
7006 </dd>
7007 <dt class="hdlist1">
7008 guitool.&lt;name&gt;.needsFile
7009 </dt>
7010 <dd>
7011 <p>
7012         Run the tool only if a diff is selected in the GUI. It guarantees
7013         that <em>FILENAME</em> is not empty.
7014 </p>
7015 </dd>
7016 <dt class="hdlist1">
7017 guitool.&lt;name&gt;.noConsole
7018 </dt>
7019 <dd>
7020 <p>
7021         Run the command silently, without creating a window to display its
7022         output.
7023 </p>
7024 </dd>
7025 <dt class="hdlist1">
7026 guitool.&lt;name&gt;.noRescan
7027 </dt>
7028 <dd>
7029 <p>
7030         Don&#8217;t rescan the working directory for changes after the tool
7031         finishes execution.
7032 </p>
7033 </dd>
7034 <dt class="hdlist1">
7035 guitool.&lt;name&gt;.confirm
7036 </dt>
7037 <dd>
7038 <p>
7039         Show a confirmation dialog before actually running the tool.
7040 </p>
7041 </dd>
7042 <dt class="hdlist1">
7043 guitool.&lt;name&gt;.argPrompt
7044 </dt>
7045 <dd>
7046 <p>
7047         Request a string argument from the user, and pass it to the tool
7048         through the <code>ARGS</code> environment variable. Since requesting an
7049         argument implies confirmation, the <em>confirm</em> option has no effect
7050         if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
7051         the dialog uses a built-in generic prompt; otherwise the exact
7052         value of the variable is used.
7053 </p>
7054 </dd>
7055 <dt class="hdlist1">
7056 guitool.&lt;name&gt;.revPrompt
7057 </dt>
7058 <dd>
7059 <p>
7060         Request a single valid revision from the user, and set the
7061         <code>REVISION</code> environment variable. In other aspects this option
7062         is similar to <em>argPrompt</em>, and can be used together with it.
7063 </p>
7064 </dd>
7065 <dt class="hdlist1">
7066 guitool.&lt;name&gt;.revUnmerged
7067 </dt>
7068 <dd>
7069 <p>
7070         Show only unmerged branches in the <em>revPrompt</em> subdialog.
7071         This is useful for tools similar to merge or rebase, but not
7072         for things like checkout or reset.
7073 </p>
7074 </dd>
7075 <dt class="hdlist1">
7076 guitool.&lt;name&gt;.title
7077 </dt>
7078 <dd>
7079 <p>
7080         Specifies the title to use for the prompt dialog. The default
7081         is the tool name.
7082 </p>
7083 </dd>
7084 <dt class="hdlist1">
7085 guitool.&lt;name&gt;.prompt
7086 </dt>
7087 <dd>
7088 <p>
7089         Specifies the general prompt string to display at the top of
7090         the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
7091         The default value includes the actual command.
7092 </p>
7093 </dd>
7094 <dt class="hdlist1">
7095 help.browser
7096 </dt>
7097 <dd>
7098 <p>
7099         Specify the browser that will be used to display help in the
7100         <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
7101 </p>
7102 </dd>
7103 <dt class="hdlist1">
7104 help.format
7105 </dt>
7106 <dd>
7107 <p>
7108         Override the default help format used by <a href="git-help.html">git-help(1)</a>.
7109         Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
7110         the default. <em>web</em> and <em>html</em> are the same.
7111 </p>
7112 </dd>
7113 <dt class="hdlist1">
7114 help.autoCorrect
7115 </dt>
7116 <dd>
7117 <p>
7118         If git detects typos and can identify exactly one valid command similar
7119         to the error, git will try to suggest the correct command or even
7120         run the suggestion automatically. Possible config values are:
7121 </p>
7122 <div class="ulist"><ul>
7123 <li>
7124 <p>
7125 0 (default): show the suggested command.
7126 </p>
7127 </li>
7128 <li>
7129 <p>
7130 positive number: run the suggested command after specified
7131 deciseconds (0.1 sec).
7132 </p>
7133 </li>
7134 <li>
7135 <p>
7136 "immediate": run the suggested command immediately.
7137 </p>
7138 </li>
7139 <li>
7140 <p>
7141 "prompt": show the suggestion and prompt for confirmation to run
7142 the command.
7143 </p>
7144 </li>
7145 <li>
7146 <p>
7147 "never": don&#8217;t run or show any suggested command.
7148 </p>
7149 </li>
7150 </ul></div>
7151 </dd>
7152 <dt class="hdlist1">
7153 help.htmlPath
7154 </dt>
7155 <dd>
7156 <p>
7157         Specify the path where the HTML documentation resides. File system paths
7158         and URLs are supported. HTML pages will be prefixed with this path when
7159         help is displayed in the <em>web</em> format. This defaults to the documentation
7160         path of your Git installation.
7161 </p>
7162 </dd>
7163 <dt class="hdlist1">
7164 http.proxy
7165 </dt>
7166 <dd>
7167 <p>
7168         Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
7169         <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
7170         addition to the syntax understood by curl, it is possible to specify a
7171         proxy string with a user name but no password, in which case git will
7172         attempt to acquire one in the same way it does for other credentials. See
7173         <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
7174         <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
7175         on a per-remote basis; see remote.&lt;name&gt;.proxy
7176 </p>
7177 </dd>
7178 <dt class="hdlist1">
7179 http.proxyAuthMethod
7180 </dt>
7181 <dd>
7182 <p>
7183         Set the method with which to authenticate against the HTTP proxy. This
7184         only takes effect if the configured proxy string contains a user name part
7185         (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
7186         overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
7187         Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
7188         variable.  Possible values are:
7189 </p>
7190 <div class="openblock">
7191 <div class="content">
7192 <div class="ulist"><ul>
7193 <li>
7194 <p>
7195 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
7196   assumed that the proxy answers an unauthenticated request with a 407
7197   status code and one or more Proxy-authenticate headers with supported
7198   authentication methods. This is the default.
7199 </p>
7200 </li>
7201 <li>
7202 <p>
7203 <code>basic</code> - HTTP Basic authentication
7204 </p>
7205 </li>
7206 <li>
7207 <p>
7208 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
7209   transmitted to the proxy in clear text
7210 </p>
7211 </li>
7212 <li>
7213 <p>
7214 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7215   of <code>curl(1)</code>)
7216 </p>
7217 </li>
7218 <li>
7219 <p>
7220 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7221 </p>
7222 </li>
7223 </ul></div>
7224 </div></div>
7225 </dd>
7226 <dt class="hdlist1">
7227 http.proxySSLCert
7228 </dt>
7229 <dd>
7230 <p>
7231         The pathname of a file that stores a client certificate to use to authenticate
7232         with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7233         variable.
7234 </p>
7235 </dd>
7236 <dt class="hdlist1">
7237 http.proxySSLKey
7238 </dt>
7239 <dd>
7240 <p>
7241         The pathname of a file that stores a private key to use to authenticate with
7242         an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7243         variable.
7244 </p>
7245 </dd>
7246 <dt class="hdlist1">
7247 http.proxySSLCertPasswordProtected
7248 </dt>
7249 <dd>
7250 <p>
7251         Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
7252         will prompt the user, possibly many times, if the certificate or private key
7253         is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7254         environment variable.
7255 </p>
7256 </dd>
7257 <dt class="hdlist1">
7258 http.proxySSLCAInfo
7259 </dt>
7260 <dd>
7261 <p>
7262         Pathname to the file containing the certificate bundle that should be used to
7263         verify the proxy with when using an HTTPS proxy. Can be overridden by the
7264         <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7265 </p>
7266 </dd>
7267 <dt class="hdlist1">
7268 http.emptyAuth
7269 </dt>
7270 <dd>
7271 <p>
7272         Attempt authentication without seeking a username or password.  This
7273         can be used to attempt GSS-Negotiate authentication without specifying
7274         a username in the URL, as libcurl normally requires a username for
7275         authentication.
7276 </p>
7277 </dd>
7278 <dt class="hdlist1">
7279 http.delegation
7280 </dt>
7281 <dd>
7282 <p>
7283         Control GSSAPI credential delegation. The delegation is disabled
7284         by default in libcurl since version 7.21.7. Set parameter to tell
7285         the server what it is allowed to delegate when it comes to user
7286         credentials. Used with GSS/kerberos. Possible values are:
7287 </p>
7288 <div class="openblock">
7289 <div class="content">
7290 <div class="ulist"><ul>
7291 <li>
7292 <p>
7293 <code>none</code> - Don&#8217;t allow any delegation.
7294 </p>
7295 </li>
7296 <li>
7297 <p>
7298 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7299   Kerberos service ticket, which is a matter of realm policy.
7300 </p>
7301 </li>
7302 <li>
7303 <p>
7304 <code>always</code> - Unconditionally allow the server to delegate.
7305 </p>
7306 </li>
7307 </ul></div>
7308 </div></div>
7309 </dd>
7310 <dt class="hdlist1">
7311 http.extraHeader
7312 </dt>
7313 <dd>
7314 <p>
7315         Pass an additional HTTP header when communicating with a server.  If
7316         more than one such entry exists, all of them are added as extra
7317         headers.  To allow overriding the settings inherited from the system
7318         config, an empty value will reset the extra headers to the empty list.
7319 </p>
7320 </dd>
7321 <dt class="hdlist1">
7322 http.cookieFile
7323 </dt>
7324 <dd>
7325 <p>
7326         The pathname of a file containing previously stored cookie lines,
7327         which should be used
7328         in the Git http session, if they match the server. The file format
7329         of the file to read cookies from should be plain HTTP headers or
7330         the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7331         NOTE that the file specified with http.cookieFile is used only as
7332         input unless http.saveCookies is set.
7333 </p>
7334 </dd>
7335 <dt class="hdlist1">
7336 http.saveCookies
7337 </dt>
7338 <dd>
7339 <p>
7340         If set, store cookies received during requests to the file specified by
7341         http.cookieFile. Has no effect if http.cookieFile is unset.
7342 </p>
7343 </dd>
7344 <dt class="hdlist1">
7345 http.version
7346 </dt>
7347 <dd>
7348 <p>
7349         Use the specified HTTP protocol version when communicating with a server.
7350         If you want to force the default. The available and default version depend
7351         on libcurl. Currently the possible values of
7352         this option are:
7353 </p>
7354 <div class="ulist"><ul>
7355 <li>
7356 <p>
7357 HTTP/2
7358 </p>
7359 </li>
7360 <li>
7361 <p>
7362 HTTP/1.1
7363 </p>
7364 </li>
7365 </ul></div>
7366 </dd>
7367 <dt class="hdlist1">
7368 http.curloptResolve
7369 </dt>
7370 <dd>
7371 <p>
7372         Hostname resolution information that will be used first by
7373         libcurl when sending HTTP requests.  This information should
7374         be in one of the following formats:
7375 </p>
7376 <div class="ulist"><ul>
7377 <li>
7378 <p>
7379 [+]HOST:PORT:ADDRESS[,ADDRESS]
7380 </p>
7381 </li>
7382 <li>
7383 <p>
7384 -HOST:PORT
7385 </p>
7386 </li>
7387 </ul></div>
7388 <div class="paragraph"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7389 to the provided <code>ADDRESS</code>(s). The second format clears all
7390 previous config values for that <code>HOST:PORT</code> combination.  To
7391 allow easy overriding of all the settings inherited from the
7392 system config, an empty value will reset all resolution
7393 information to the empty list.</p></div>
7394 </dd>
7395 <dt class="hdlist1">
7396 http.sslVersion
7397 </dt>
7398 <dd>
7399 <p>
7400         The SSL version to use when negotiating an SSL connection, if you
7401         want to force the default.  The available and default version
7402         depend on whether libcurl was built against NSS or OpenSSL and the
7403         particular configuration of the crypto library in use. Internally
7404         this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7405         documentation for more details on the format of this option and
7406         for the ssl version supported. Currently the possible values of
7407         this option are:
7408 </p>
7409 <div class="ulist"><ul>
7410 <li>
7411 <p>
7412 sslv2
7413 </p>
7414 </li>
7415 <li>
7416 <p>
7417 sslv3
7418 </p>
7419 </li>
7420 <li>
7421 <p>
7422 tlsv1
7423 </p>
7424 </li>
7425 <li>
7426 <p>
7427 tlsv1.0
7428 </p>
7429 </li>
7430 <li>
7431 <p>
7432 tlsv1.1
7433 </p>
7434 </li>
7435 <li>
7436 <p>
7437 tlsv1.2
7438 </p>
7439 </li>
7440 <li>
7441 <p>
7442 tlsv1.3
7443 </p>
7444 </li>
7445 </ul></div>
7446 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7447 To force git to use libcurl&#8217;s default ssl version and ignore any
7448 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7449 empty string.</p></div>
7450 </dd>
7451 <dt class="hdlist1">
7452 http.sslCipherList
7453 </dt>
7454 <dd>
7455 <p>
7456   A list of SSL ciphers to use when negotiating an SSL connection.
7457   The available ciphers depend on whether libcurl was built against
7458   NSS or OpenSSL and the particular configuration of the crypto
7459   library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7460   option; see the libcurl documentation for more details on the format
7461   of this list.
7462 </p>
7463 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7464 To force git to use libcurl&#8217;s default cipher list and ignore any
7465 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7466 empty string.</p></div>
7467 </dd>
7468 <dt class="hdlist1">
7469 http.sslVerify
7470 </dt>
7471 <dd>
7472 <p>
7473         Whether to verify the SSL certificate when fetching or pushing
7474         over HTTPS. Defaults to true. Can be overridden by the
7475         <code>GIT_SSL_NO_VERIFY</code> environment variable.
7476 </p>
7477 </dd>
7478 <dt class="hdlist1">
7479 http.sslCert
7480 </dt>
7481 <dd>
7482 <p>
7483         File containing the SSL certificate when fetching or pushing
7484         over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7485         variable.
7486 </p>
7487 </dd>
7488 <dt class="hdlist1">
7489 http.sslKey
7490 </dt>
7491 <dd>
7492 <p>
7493         File containing the SSL private key when fetching or pushing
7494         over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7495         variable.
7496 </p>
7497 </dd>
7498 <dt class="hdlist1">
7499 http.sslCertPasswordProtected
7500 </dt>
7501 <dd>
7502 <p>
7503         Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
7504         OpenSSL will prompt the user, possibly many times, if the
7505         certificate or private key is encrypted.  Can be overridden by the
7506         <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7507 </p>
7508 </dd>
7509 <dt class="hdlist1">
7510 http.sslCAInfo
7511 </dt>
7512 <dd>
7513 <p>
7514         File containing the certificates to verify the peer with when
7515         fetching or pushing over HTTPS. Can be overridden by the
7516         <code>GIT_SSL_CAINFO</code> environment variable.
7517 </p>
7518 </dd>
7519 <dt class="hdlist1">
7520 http.sslCAPath
7521 </dt>
7522 <dd>
7523 <p>
7524         Path containing files with the CA certificates to verify the peer
7525         with when fetching or pushing over HTTPS. Can be overridden
7526         by the <code>GIT_SSL_CAPATH</code> environment variable.
7527 </p>
7528 </dd>
7529 <dt class="hdlist1">
7530 http.sslBackend
7531 </dt>
7532 <dd>
7533 <p>
7534         Name of the SSL backend to use (e.g. "openssl" or "schannel").
7535         This option is ignored if cURL lacks support for choosing the SSL
7536         backend at runtime.
7537 </p>
7538 </dd>
7539 <dt class="hdlist1">
7540 http.schannelCheckRevoke
7541 </dt>
7542 <dd>
7543 <p>
7544         Used to enforce or disable certificate revocation checks in cURL
7545         when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
7546         unset. Only necessary to disable this if Git consistently errors
7547         and the message is about checking the revocation status of a
7548         certificate. This option is ignored if cURL lacks support for
7549         setting the relevant SSL option at runtime.
7550 </p>
7551 </dd>
7552 <dt class="hdlist1">
7553 http.schannelUseSSLCAInfo
7554 </dt>
7555 <dd>
7556 <p>
7557         As of cURL v7.60.0, the Secure Channel backend can use the
7558         certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7559         override the Windows Certificate Store. Since this is not desirable
7560         by default, Git will tell cURL not to use that bundle by default
7561         when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7562         unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7563 </p>
7564 </dd>
7565 <dt class="hdlist1">
7566 http.pinnedPubkey
7567 </dt>
7568 <dd>
7569 <p>
7570         Public key of the https service. It may either be the filename of
7571         a PEM or DER encoded public key file or a string starting with
7572         <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7573         public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7574         exit with an error if this option is set but not supported by
7575         cURL.
7576 </p>
7577 </dd>
7578 <dt class="hdlist1">
7579 http.sslTry
7580 </dt>
7581 <dd>
7582 <p>
7583         Attempt to use AUTH SSL/TLS and encrypted data transfers
7584         when connecting via regular FTP protocol. This might be needed
7585         if the FTP server requires it for security reasons or you wish
7586         to connect securely whenever remote FTP server supports it.
7587         Default is false since it might trigger certificate verification
7588         errors on misconfigured servers.
7589 </p>
7590 </dd>
7591 <dt class="hdlist1">
7592 http.maxRequests
7593 </dt>
7594 <dd>
7595 <p>
7596         How many HTTP requests to launch in parallel. Can be overridden
7597         by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7598 </p>
7599 </dd>
7600 <dt class="hdlist1">
7601 http.minSessions
7602 </dt>
7603 <dd>
7604 <p>
7605         The number of curl sessions (counted across slots) to be kept across
7606         requests. They will not be ended with curl_easy_cleanup() until
7607         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7608         value will be capped at 1. Defaults to 1.
7609 </p>
7610 </dd>
7611 <dt class="hdlist1">
7612 http.postBuffer
7613 </dt>
7614 <dd>
7615 <p>
7616         Maximum size in bytes of the buffer used by smart HTTP
7617         transports when POSTing data to the remote system.
7618         For requests larger than this buffer size, HTTP/1.1 and
7619         Transfer-Encoding: chunked is used to avoid creating a
7620         massive pack file locally.  Default is 1 MiB, which is
7621         sufficient for most requests.
7622 </p>
7623 <div class="paragraph"><p>Note that raising this limit is only effective for disabling chunked
7624 transfer encoding and therefore should be used only where the remote
7625 server or a proxy only supports HTTP/1.0 or is noncompliant with the
7626 HTTP standard.  Raising this is not, in general, an effective solution
7627 for most push problems, but can increase memory consumption
7628 significantly since the entire buffer is allocated even for small
7629 pushes.</p></div>
7630 </dd>
7631 <dt class="hdlist1">
7632 http.lowSpeedLimit, http.lowSpeedTime
7633 </dt>
7634 <dd>
7635 <p>
7636         If the HTTP transfer speed, in bytes per second, is less than
7637         <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
7638         the transfer is aborted.
7639         Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
7640         <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
7641 </p>
7642 </dd>
7643 <dt class="hdlist1">
7644 http.noEPSV
7645 </dt>
7646 <dd>
7647 <p>
7648         A boolean which disables using of EPSV ftp command by curl.
7649         This can be helpful with some "poor" ftp servers which don&#8217;t
7650         support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
7651         environment variable. Default is false (curl will use EPSV).
7652 </p>
7653 </dd>
7654 <dt class="hdlist1">
7655 http.userAgent
7656 </dt>
7657 <dd>
7658 <p>
7659         The HTTP USER_AGENT string presented to an HTTP server.  The default
7660         value represents the version of the Git client such as git/1.7.1.
7661         This option allows you to override this value to a more common value
7662         such as Mozilla/4.0.  This may be necessary, for instance, if
7663         connecting through a firewall that restricts HTTP connections to a set
7664         of common USER_AGENT strings (but not including those like git/1.7.1).
7665         Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
7666 </p>
7667 </dd>
7668 <dt class="hdlist1">
7669 http.followRedirects
7670 </dt>
7671 <dd>
7672 <p>
7673         Whether git should follow HTTP redirects. If set to <code>true</code>, git
7674         will transparently follow any redirect issued by a server it
7675         encounters. If set to <code>false</code>, git will treat all redirects as
7676         errors. If set to <code>initial</code>, git will follow redirects only for
7677         the initial request to a remote, but not for subsequent
7678         follow-up HTTP requests. Since git uses the redirected URL as
7679         the base for the follow-up requests, this is generally
7680         sufficient. The default is <code>initial</code>.
7681 </p>
7682 </dd>
7683 <dt class="hdlist1">
7684 http.&lt;url&gt;.*
7685 </dt>
7686 <dd>
7687 <p>
7688         Any of the http.* options above can be applied selectively to some URLs.
7689         For a config key to match a URL, each element of the config key is
7690         compared to that of the URL, in the following order:
7691 </p>
7692 <div class="openblock">
7693 <div class="content">
7694 <div class="olist arabic"><ol class="arabic">
7695 <li>
7696 <p>
7697 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
7698   must match exactly between the config key and the URL.
7699 </p>
7700 </li>
7701 <li>
7702 <p>
7703 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
7704   This field must match between the config key and the URL. It is
7705   possible to specify a <code>*</code> as part of the host name to match all subdomains
7706   at this level. <code>https://*.example.com/</code> for example would match
7707   <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
7708 </p>
7709 </li>
7710 <li>
7711 <p>
7712 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
7713   This field must match exactly between the config key and the URL.
7714   Omitted port numbers are automatically converted to the correct
7715   default for the scheme before matching.
7716 </p>
7717 </li>
7718 <li>
7719 <p>
7720 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
7721   path field of the config key must match the path field of the URL
7722   either exactly or as a prefix of slash-delimited path elements.  This means
7723   a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
7724   match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
7725   key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
7726   key with just path <code>foo/</code>).
7727 </p>
7728 </li>
7729 <li>
7730 <p>
7731 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
7732   the config key has a user name it must match the user name in the
7733   URL exactly. If the config key does not have a user name, that
7734   config key will match a URL with any user name (including none),
7735   but at a lower precedence than a config key with a user name.
7736 </p>
7737 </li>
7738 </ol></div>
7739 </div></div>
7740 <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
7741 a config key&#8217;s path is preferred to one that matches its user name. For example,
7742 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
7743 <code>https://example.com/foo</code> will be preferred over a config key match of
7744 <code>https://user@example.com</code>.</p></div>
7745 <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
7746 if embedded in the URL, is always ignored for matching purposes) so that
7747 equivalent URLs that are simply spelled differently will match properly.
7748 Environment variable settings always override any matches.  The URLs that are
7749 matched against are those given directly to Git commands.  This means any URLs
7750 visited as a result of a redirection do not participate in matching.</p></div>
7751 </dd>
7752 <dt class="hdlist1">
7753 i18n.commitEncoding
7754 </dt>
7755 <dd>
7756 <p>
7757         Character encoding the commit messages are stored in; Git itself
7758         does not care per se, but this information is necessary e.g. when
7759         importing commits from emails or in the gitk graphical history
7760         browser (and possibly in other places in the future or in other
7761         porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
7762 </p>
7763 </dd>
7764 <dt class="hdlist1">
7765 i18n.logOutputEncoding
7766 </dt>
7767 <dd>
7768 <p>
7769         Character encoding the commit messages are converted to when
7770         running <em>git log</em> and friends.
7771 </p>
7772 </dd>
7773 <dt class="hdlist1">
7774 imap.folder
7775 </dt>
7776 <dd>
7777 <p>
7778         The folder to drop the mails into, which is typically the Drafts
7779         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
7780         "[Gmail]/Drafts". Required.
7781 </p>
7782 </dd>
7783 <dt class="hdlist1">
7784 imap.tunnel
7785 </dt>
7786 <dd>
7787 <p>
7788         Command used to set up a tunnel to the IMAP server through which
7789         commands will be piped instead of using a direct network connection
7790         to the server. Required when imap.host is not set.
7791 </p>
7792 </dd>
7793 <dt class="hdlist1">
7794 imap.host
7795 </dt>
7796 <dd>
7797 <p>
7798         A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
7799         connections and an <code>imaps://</code> prefix for secure connections.
7800         Ignored when imap.tunnel is set, but required otherwise.
7801 </p>
7802 </dd>
7803 <dt class="hdlist1">
7804 imap.user
7805 </dt>
7806 <dd>
7807 <p>
7808         The username to use when logging in to the server.
7809 </p>
7810 </dd>
7811 <dt class="hdlist1">
7812 imap.pass
7813 </dt>
7814 <dd>
7815 <p>
7816         The password to use when logging in to the server.
7817 </p>
7818 </dd>
7819 <dt class="hdlist1">
7820 imap.port
7821 </dt>
7822 <dd>
7823 <p>
7824         An integer port number to connect to on the server.
7825         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
7826         Ignored when imap.tunnel is set.
7827 </p>
7828 </dd>
7829 <dt class="hdlist1">
7830 imap.sslverify
7831 </dt>
7832 <dd>
7833 <p>
7834         A boolean to enable/disable verification of the server certificate
7835         used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
7836         imap.tunnel is set.
7837 </p>
7838 </dd>
7839 <dt class="hdlist1">
7840 imap.preformattedHTML
7841 </dt>
7842 <dd>
7843 <p>
7844         A boolean to enable/disable the use of html encoding when sending
7845         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
7846         and have a content type of text/html.  Ironically, enabling this
7847         option causes Thunderbird to send the patch as a plain/text,
7848         format=fixed email.  Default is <code>false</code>.
7849 </p>
7850 </dd>
7851 <dt class="hdlist1">
7852 imap.authMethod
7853 </dt>
7854 <dd>
7855 <p>
7856         Specify the authentication method for authenticating with the IMAP server.
7857         If Git was built with the NO_CURL option, or if your curl version is older
7858         than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
7859         option, the only supported method is <em>CRAM-MD5</em>. If this is not set
7860         then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
7861 </p>
7862 </dd>
7863 <dt class="hdlist1">
7864 include.path
7865 </dt>
7866 <dt class="hdlist1">
7867 includeIf.&lt;condition&gt;.path
7868 </dt>
7869 <dd>
7870 <p>
7871         Special variables to include other configuration files. See
7872         the "CONFIGURATION FILE" section in the main
7873         <a href="git-config.html">git-config(1)</a> documentation,
7874         specifically the "Includes" and "Conditional Includes" subsections.
7875 </p>
7876 </dd>
7877 <dt class="hdlist1">
7878 index.recordEndOfIndexEntries
7879 </dt>
7880 <dd>
7881 <p>
7882         Specifies whether the index file should include an "End Of Index
7883         Entry" section. This reduces index load time on multiprocessor
7884         machines but produces a message "ignoring EOIE extension" when
7885         reading the index using Git versions before 2.20. Defaults to
7886         <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
7887         otherwise.
7888 </p>
7889 </dd>
7890 <dt class="hdlist1">
7891 index.recordOffsetTable
7892 </dt>
7893 <dd>
7894 <p>
7895         Specifies whether the index file should include an "Index Entry
7896         Offset Table" section. This reduces index load time on
7897         multiprocessor machines but produces a message "ignoring IEOT
7898         extension" when reading the index using Git versions before 2.20.
7899         Defaults to <em>true</em> if index.threads has been explicitly enabled,
7900         <em>false</em> otherwise.
7901 </p>
7902 </dd>
7903 <dt class="hdlist1">
7904 index.sparse
7905 </dt>
7906 <dd>
7907 <p>
7908         When enabled, write the index using sparse-directory entries. This
7909         has no effect unless <code>core.sparseCheckout</code> and
7910         <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
7911 </p>
7912 </dd>
7913 <dt class="hdlist1">
7914 index.threads
7915 </dt>
7916 <dd>
7917 <p>
7918         Specifies the number of threads to spawn when loading the index.
7919         This is meant to reduce index load time on multiprocessor machines.
7920         Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
7921         CPUs and set the number of threads accordingly. Specifying 1 or
7922         <em>false</em> will disable multithreading. Defaults to <em>true</em>.
7923 </p>
7924 </dd>
7925 <dt class="hdlist1">
7926 index.version
7927 </dt>
7928 <dd>
7929 <p>
7930         Specify the version with which new index files should be
7931         initialized.  This does not affect existing repositories.
7932         If <code>feature.manyFiles</code> is enabled, then the default is 4.
7933 </p>
7934 </dd>
7935 <dt class="hdlist1">
7936 index.skipHash
7937 </dt>
7938 <dd>
7939 <p>
7940         When enabled, do not compute the trailing hash for the index file.
7941         This accelerates Git commands that manipulate the index, such as
7942         <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
7943         checksum, write a trailing set of bytes with value zero, indicating
7944         that the computation was skipped.
7945 </p>
7946 <div class="paragraph"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
7947 refuse to parse the index and Git clients older than 2.40.0 will report an
7948 error during <code>git fsck</code>.</p></div>
7949 </dd>
7950 </dl></div>
7951 <div class="dlist"><dl>
7952 <dt class="hdlist1">
7953 <code>init.templateDir</code>
7954 </dt>
7955 <dd>
7956 <p>
7957         Specify the directory from which templates will be copied. (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
7958 </p>
7959 </dd>
7960 <dt class="hdlist1">
7961 <code>init.defaultBranch</code>
7962 </dt>
7963 <dd>
7964 <p>
7965         Allows overriding the default branch name e.g. when initializing
7966         a new repository.
7967 </p>
7968 </dd>
7969 <dt class="hdlist1">
7970 instaweb.browser
7971 </dt>
7972 <dd>
7973 <p>
7974         Specify the program that will be used to browse your working
7975         repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7976 </p>
7977 </dd>
7978 <dt class="hdlist1">
7979 instaweb.httpd
7980 </dt>
7981 <dd>
7982 <p>
7983         The HTTP daemon command-line to start gitweb on your working
7984         repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7985 </p>
7986 </dd>
7987 <dt class="hdlist1">
7988 instaweb.local
7989 </dt>
7990 <dd>
7991 <p>
7992         If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
7993         be bound to the local IP (127.0.0.1).
7994 </p>
7995 </dd>
7996 <dt class="hdlist1">
7997 instaweb.modulePath
7998 </dt>
7999 <dd>
8000 <p>
8001         The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
8002         instead of /usr/lib/apache2/modules.  Only used if httpd
8003         is Apache.
8004 </p>
8005 </dd>
8006 <dt class="hdlist1">
8007 instaweb.port
8008 </dt>
8009 <dd>
8010 <p>
8011         The port number to bind the gitweb httpd to. See
8012         <a href="git-instaweb.html">git-instaweb(1)</a>.
8013 </p>
8014 </dd>
8015 <dt class="hdlist1">
8016 interactive.singleKey
8017 </dt>
8018 <dd>
8019 <p>
8020         In interactive commands, allow the user to provide one-letter
8021         input with a single key (i.e., without hitting enter).
8022         Currently this is used by the <code>--patch</code> mode of
8023         <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
8024         <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
8025         <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>.
8026 </p>
8027 </dd>
8028 <dt class="hdlist1">
8029 interactive.diffFilter
8030 </dt>
8031 <dd>
8032 <p>
8033         When an interactive command (such as <code>git add --patch</code>) shows
8034         a colorized diff, git will pipe the diff through the shell
8035         command defined by this configuration variable. The command may
8036         mark up the diff further for human consumption, provided that it
8037         retains a one-to-one correspondence with the lines in the
8038         original diff. Defaults to disabled (no filtering).
8039 </p>
8040 </dd>
8041 <dt class="hdlist1">
8042 log.abbrevCommit
8043 </dt>
8044 <dd>
8045 <p>
8046         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8047         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
8048         override this option with <code>--no-abbrev-commit</code>.
8049 </p>
8050 </dd>
8051 <dt class="hdlist1">
8052 log.date
8053 </dt>
8054 <dd>
8055 <p>
8056         Set the default date-time mode for the <em>log</em> command.
8057         Setting a value for log.date is similar to using <em>git log</em>'s
8058         <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.
8059 </p>
8060 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
8061 "foo" will be used for the date format. Otherwise, "default" will
8062 be used.</p></div>
8063 </dd>
8064 <dt class="hdlist1">
8065 log.decorate
8066 </dt>
8067 <dd>
8068 <p>
8069         Print out the ref names of any commits that are shown by the log
8070         command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
8071         <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
8072         specified, the full ref name (including prefix) will be printed.
8073         If <em>auto</em> is specified, then if the output is going to a terminal,
8074         the ref names are shown as if <em>short</em> were given, otherwise no ref
8075         names are shown. This is the same as the <code>--decorate</code> option
8076         of the <code>git log</code>.
8077 </p>
8078 </dd>
8079 <dt class="hdlist1">
8080 log.initialDecorationSet
8081 </dt>
8082 <dd>
8083 <p>
8084         By default, <code>git log</code> only shows decorations for certain known ref
8085         namespaces. If <em>all</em> is specified, then show all refs as
8086         decorations.
8087 </p>
8088 </dd>
8089 <dt class="hdlist1">
8090 log.excludeDecoration
8091 </dt>
8092 <dd>
8093 <p>
8094         Exclude the specified patterns from the log decorations. This is
8095         similar to the <code>--decorate-refs-exclude</code> command-line option, but
8096         the config option can be overridden by the <code>--decorate-refs</code>
8097         option.
8098 </p>
8099 </dd>
8100 <dt class="hdlist1">
8101 log.diffMerges
8102 </dt>
8103 <dd>
8104 <p>
8105         Set diff format to be used when <code>--diff-merges=on</code> is
8106         specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
8107         details. Defaults to <code>separate</code>.
8108 </p>
8109 </dd>
8110 <dt class="hdlist1">
8111 log.follow
8112 </dt>
8113 <dd>
8114 <p>
8115         If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
8116         a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
8117         i.e. it cannot be used to follow multiple files and does not work well
8118         on non-linear history.
8119 </p>
8120 </dd>
8121 <dt class="hdlist1">
8122 log.graphColors
8123 </dt>
8124 <dd>
8125 <p>
8126         A list of colors, separated by commas, that can be used to draw
8127         history lines in <code>git log --graph</code>.
8128 </p>
8129 </dd>
8130 <dt class="hdlist1">
8131 log.showRoot
8132 </dt>
8133 <dd>
8134 <p>
8135         If true, the initial commit will be shown as a big creation event.
8136         This is equivalent to a diff against an empty tree.
8137         Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
8138         normally hide the root commit will now show it. True by default.
8139 </p>
8140 </dd>
8141 <dt class="hdlist1">
8142 log.showSignature
8143 </dt>
8144 <dd>
8145 <p>
8146         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8147         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
8148 </p>
8149 </dd>
8150 <dt class="hdlist1">
8151 log.mailmap
8152 </dt>
8153 <dd>
8154 <p>
8155         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8156         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
8157         assume <code>--no-use-mailmap</code>. True by default.
8158 </p>
8159 </dd>
8160 <dt class="hdlist1">
8161 lsrefs.unborn
8162 </dt>
8163 <dd>
8164 <p>
8165         May be "advertise" (the default), "allow", or "ignore". If "advertise",
8166         the server will respond to the client sending "unborn" (as described in
8167         <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
8168         protocol v2 capability advertisement. "allow" is the same as
8169         "advertise" except that the server will not advertise support for this
8170         feature; this is useful for load-balanced servers that cannot be
8171         updated atomically (for example), since the administrator could
8172         configure "allow", then after a delay, configure "advertise".
8173 </p>
8174 </dd>
8175 <dt class="hdlist1">
8176 mailinfo.scissors
8177 </dt>
8178 <dd>
8179 <p>
8180         If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
8181         <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
8182         was provided on the command-line. When active, this feature
8183         removes everything from the message body before a scissors
8184         line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
8185 </p>
8186 </dd>
8187 <dt class="hdlist1">
8188 mailmap.file
8189 </dt>
8190 <dd>
8191 <p>
8192         The location of an augmenting mailmap file. The default
8193         mailmap, located in the root of the repository, is loaded
8194         first, then the mailmap file pointed to by this variable.
8195         The location of the mailmap file may be in a repository
8196         subdirectory, or somewhere outside of the repository itself.
8197         See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
8198 </p>
8199 </dd>
8200 <dt class="hdlist1">
8201 mailmap.blob
8202 </dt>
8203 <dd>
8204 <p>
8205         Like <code>mailmap.file</code>, but consider the value as a reference to a
8206         blob in the repository. If both <code>mailmap.file</code> and
8207         <code>mailmap.blob</code> are given, both are parsed, with entries from
8208         <code>mailmap.file</code> taking precedence. In a bare repository, this
8209         defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8210         defaults to empty.
8211 </p>
8212 </dd>
8213 <dt class="hdlist1">
8214 maintenance.auto
8215 </dt>
8216 <dd>
8217 <p>
8218         This boolean config option controls whether some commands run
8219         <code>git maintenance run --auto</code> after doing their normal work. Defaults
8220         to true.
8221 </p>
8222 </dd>
8223 <dt class="hdlist1">
8224 maintenance.strategy
8225 </dt>
8226 <dd>
8227 <p>
8228         This string config option provides a way to specify one of a few
8229         recommended schedules for background maintenance. This only affects
8230         which tasks are run during <code>git maintenance run --schedule=X</code>
8231         commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
8232         Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
8233         then that value is used instead of the one provided by
8234         <code>maintenance.strategy</code>. The possible strategy strings are:
8235 </p>
8236 <div class="ulist"><ul>
8237 <li>
8238 <p>
8239 <code>none</code>: This default setting implies no tasks are run at any schedule.
8240 </p>
8241 </li>
8242 <li>
8243 <p>
8244 <code>incremental</code>: This setting optimizes for performing small maintenance
8245   activities that do not delete any data. This does not schedule the <code>gc</code>
8246   task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8247   <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8248   task weekly.
8249 </p>
8250 </li>
8251 </ul></div>
8252 </dd>
8253 <dt class="hdlist1">
8254 maintenance.&lt;task&gt;.enabled
8255 </dt>
8256 <dd>
8257 <p>
8258         This boolean config option controls whether the maintenance task
8259         with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
8260         <code>git maintenance run</code>. These config values are ignored if a
8261         <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8262         is true.
8263 </p>
8264 </dd>
8265 <dt class="hdlist1">
8266 maintenance.&lt;task&gt;.schedule
8267 </dt>
8268 <dd>
8269 <p>
8270         This config option controls whether or not the given <code>&lt;task&gt;</code> runs
8271         during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
8272         value must be one of "hourly", "daily", or "weekly".
8273 </p>
8274 </dd>
8275 <dt class="hdlist1">
8276 maintenance.commit-graph.auto
8277 </dt>
8278 <dd>
8279 <p>
8280         This integer config option controls how often the <code>commit-graph</code> task
8281         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8282         the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8283         negative value will force the task to run every time. Otherwise, a
8284         positive value implies the command should run when the number of
8285         reachable commits that are not in the commit-graph file is at least
8286         the value of <code>maintenance.commit-graph.auto</code>. The default value is
8287         100.
8288 </p>
8289 </dd>
8290 <dt class="hdlist1">
8291 maintenance.loose-objects.auto
8292 </dt>
8293 <dd>
8294 <p>
8295         This integer config option controls how often the <code>loose-objects</code> task
8296         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8297         the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8298         negative value will force the task to run every time. Otherwise, a
8299         positive value implies the command should run when the number of
8300         loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8301         The default value is 100.
8302 </p>
8303 </dd>
8304 <dt class="hdlist1">
8305 maintenance.incremental-repack.auto
8306 </dt>
8307 <dd>
8308 <p>
8309         This integer config option controls how often the <code>incremental-repack</code>
8310         task should be run as part of <code>git maintenance run --auto</code>. If zero,
8311         then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8312         option. A negative value will force the task to run every time.
8313         Otherwise, a positive value implies the command should run when the
8314         number of pack-files not in the multi-pack-index is at least the value
8315         of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8316 </p>
8317 </dd>
8318 <dt class="hdlist1">
8319 man.viewer
8320 </dt>
8321 <dd>
8322 <p>
8323         Specify the programs that may be used to display help in the
8324         <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8325 </p>
8326 </dd>
8327 <dt class="hdlist1">
8328 man.&lt;tool&gt;.cmd
8329 </dt>
8330 <dd>
8331 <p>
8332         Specify the command to invoke the specified man viewer. The
8333         specified command is evaluated in shell with the man page
8334         passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)
8335 </p>
8336 </dd>
8337 <dt class="hdlist1">
8338 man.&lt;tool&gt;.path
8339 </dt>
8340 <dd>
8341 <p>
8342         Override the path for the given tool that may be used to
8343         display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8344 </p>
8345 </dd>
8346 <dt class="hdlist1">
8347 merge.conflictStyle
8348 </dt>
8349 <dd>
8350 <p>
8351         Specify the style in which conflicted hunks are written out to
8352         working tree files upon merge.  The default is "merge", which
8353         shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
8354         a <code>=======</code> marker, changes made by the other side, and then
8355         a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
8356         marker and the original text before the <code>=======</code> marker.  The
8357         "merge" style tends to produce smaller conflict regions than diff3,
8358         both because of the exclusion of the original text, and because
8359         when a subset of lines match on the two sides, they are just pulled
8360         out of the conflict region.  Another alternate style, "zdiff3", is
8361         similar to diff3 but removes matching lines on the two sides from
8362         the conflict region when those matching lines appear near either
8363         the beginning or end of a conflict region.
8364 </p>
8365 </dd>
8366 <dt class="hdlist1">
8367 merge.defaultToUpstream
8368 </dt>
8369 <dd>
8370 <p>
8371         If merge is called without any commit argument, merge the upstream
8372         branches configured for the current branch by using their last
8373         observed values stored in their remote-tracking branches.
8374         The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
8375         branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
8376         are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
8377         to their corresponding remote-tracking branches, and the tips of
8378         these tracking branches are merged. Defaults to true.
8379 </p>
8380 </dd>
8381 <dt class="hdlist1">
8382 merge.ff
8383 </dt>
8384 <dd>
8385 <p>
8386         By default, Git does not create an extra merge commit when merging
8387         a commit that is a descendant of the current commit. Instead, the
8388         tip of the current branch is fast-forwarded. When set to <code>false</code>,
8389         this variable tells Git to create an extra merge commit in such
8390         a case (equivalent to giving the <code>--no-ff</code> option from the command
8391         line). When set to <code>only</code>, only such fast-forward merges are
8392         allowed (equivalent to giving the <code>--ff-only</code> option from the
8393         command line).
8394 </p>
8395 </dd>
8396 <dt class="hdlist1">
8397 merge.verifySignatures
8398 </dt>
8399 <dd>
8400 <p>
8401         If true, this is equivalent to the --verify-signatures command
8402         line option. See <a href="git-merge.html">git-merge(1)</a> for details.
8403 </p>
8404 </dd>
8405 <dt class="hdlist1">
8406 merge.branchdesc
8407 </dt>
8408 <dd>
8409 <p>
8410         In addition to branch names, populate the log message with
8411         the branch description text associated with them.  Defaults
8412         to false.
8413 </p>
8414 </dd>
8415 <dt class="hdlist1">
8416 merge.log
8417 </dt>
8418 <dd>
8419 <p>
8420         In addition to branch names, populate the log message with at
8421         most the specified number of one-line descriptions from the
8422         actual commits that are being merged.  Defaults to false, and
8423         true is a synonym for 20.
8424 </p>
8425 </dd>
8426 <dt class="hdlist1">
8427 merge.suppressDest
8428 </dt>
8429 <dd>
8430 <p>
8431         By adding a glob that matches the names of integration
8432         branches to this multi-valued configuration variable, the
8433         default merge message computed for merges into these
8434         integration branches will omit "into &lt;branch name&gt;" from
8435         its title.
8436 </p>
8437 <div class="paragraph"><p>An element with an empty value can be used to clear the list
8438 of globs accumulated from previous configuration entries.
8439 When there is no <code>merge.suppressDest</code> variable defined, the
8440 default value of <code>master</code> is used for backward compatibility.</p></div>
8441 </dd>
8442 <dt class="hdlist1">
8443 merge.renameLimit
8444 </dt>
8445 <dd>
8446 <p>
8447         The number of files to consider in the exhaustive portion of
8448         rename detection during a merge.  If not specified, defaults
8449         to the value of diff.renameLimit.  If neither
8450         merge.renameLimit nor diff.renameLimit are specified,
8451         currently defaults to 7000.  This setting has no effect if
8452         rename detection is turned off.
8453 </p>
8454 </dd>
8455 <dt class="hdlist1">
8456 merge.renames
8457 </dt>
8458 <dd>
8459 <p>
8460         Whether Git detects renames.  If set to "false", rename detection
8461         is disabled. If set to "true", basic rename detection is enabled.
8462         Defaults to the value of diff.renames.
8463 </p>
8464 </dd>
8465 <dt class="hdlist1">
8466 merge.directoryRenames
8467 </dt>
8468 <dd>
8469 <p>
8470         Whether Git detects directory renames, affecting what happens at
8471         merge time to new files added to a directory on one side of
8472         history when that directory was renamed on the other side of
8473         history.  If merge.directoryRenames is set to "false", directory
8474         rename detection is disabled, meaning that such new files will be
8475         left behind in the old directory.  If set to "true", directory
8476         rename detection is enabled, meaning that such new files will be
8477         moved into the new directory.  If set to "conflict", a conflict
8478         will be reported for such paths.  If merge.renames is false,
8479         merge.directoryRenames is ignored and treated as false.  Defaults
8480         to "conflict".
8481 </p>
8482 </dd>
8483 <dt class="hdlist1">
8484 merge.renormalize
8485 </dt>
8486 <dd>
8487 <p>
8488         Tell Git that canonical representation of files in the
8489         repository has changed over time (e.g. earlier commits record
8490         text files with CRLF line endings, but recent ones use LF line
8491         endings).  In such a repository, Git can convert the data
8492         recorded in commits to a canonical form before performing a
8493         merge to reduce unnecessary conflicts.  For more information,
8494         see section "Merging branches with differing checkin/checkout
8495         attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
8496 </p>
8497 </dd>
8498 <dt class="hdlist1">
8499 merge.stat
8500 </dt>
8501 <dd>
8502 <p>
8503         Whether to print the diffstat between ORIG_HEAD and the merge result
8504         at the end of the merge.  True by default.
8505 </p>
8506 </dd>
8507 <dt class="hdlist1">
8508 merge.autoStash
8509 </dt>
8510 <dd>
8511 <p>
8512         When set to true, automatically create a temporary stash entry
8513         before the operation begins, and apply it after the operation
8514         ends.  This means that you can run merge on a dirty worktree.
8515         However, use with care: the final stash application after a
8516         successful merge might result in non-trivial conflicts.
8517         This option can be overridden by the <code>--no-autostash</code> and
8518         <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
8519         Defaults to false.
8520 </p>
8521 </dd>
8522 <dt class="hdlist1">
8523 merge.tool
8524 </dt>
8525 <dd>
8526 <p>
8527         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
8528         The list below shows the valid built-in values.
8529         Any other value is treated as a custom merge tool and requires
8530         that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
8531 </p>
8532 </dd>
8533 <dt class="hdlist1">
8534 merge.guitool
8535 </dt>
8536 <dd>
8537 <p>
8538         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
8539         -g/--gui flag is specified. The list below shows the valid built-in values.
8540         Any other value is treated as a custom merge tool and requires that a
8541         corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.
8542 </p>
8543 <div class="dlist"><dl>
8544 <dt class="hdlist1">
8545 <code>araxis</code>
8546 </dt>
8547 <dd>
8548 <p>
8549 Use Araxis Merge (requires a graphical session)
8550 </p>
8551 </dd>
8552 <dt class="hdlist1">
8553 <code>bc</code>
8554 </dt>
8555 <dd>
8556 <p>
8557 Use Beyond Compare (requires a graphical session)
8558 </p>
8559 </dd>
8560 <dt class="hdlist1">
8561 <code>bc3</code>
8562 </dt>
8563 <dd>
8564 <p>
8565 Use Beyond Compare (requires a graphical session)
8566 </p>
8567 </dd>
8568 <dt class="hdlist1">
8569 <code>bc4</code>
8570 </dt>
8571 <dd>
8572 <p>
8573 Use Beyond Compare (requires a graphical session)
8574 </p>
8575 </dd>
8576 <dt class="hdlist1">
8577 <code>codecompare</code>
8578 </dt>
8579 <dd>
8580 <p>
8581 Use Code Compare (requires a graphical session)
8582 </p>
8583 </dd>
8584 <dt class="hdlist1">
8585 <code>deltawalker</code>
8586 </dt>
8587 <dd>
8588 <p>
8589 Use DeltaWalker (requires a graphical session)
8590 </p>
8591 </dd>
8592 <dt class="hdlist1">
8593 <code>diffmerge</code>
8594 </dt>
8595 <dd>
8596 <p>
8597 Use DiffMerge (requires a graphical session)
8598 </p>
8599 </dd>
8600 <dt class="hdlist1">
8601 <code>diffuse</code>
8602 </dt>
8603 <dd>
8604 <p>
8605 Use Diffuse (requires a graphical session)
8606 </p>
8607 </dd>
8608 <dt class="hdlist1">
8609 <code>ecmerge</code>
8610 </dt>
8611 <dd>
8612 <p>
8613 Use ECMerge (requires a graphical session)
8614 </p>
8615 </dd>
8616 <dt class="hdlist1">
8617 <code>emerge</code>
8618 </dt>
8619 <dd>
8620 <p>
8621 Use Emacs' Emerge
8622 </p>
8623 </dd>
8624 <dt class="hdlist1">
8625 <code>examdiff</code>
8626 </dt>
8627 <dd>
8628 <p>
8629 Use ExamDiff Pro (requires a graphical session)
8630 </p>
8631 </dd>
8632 <dt class="hdlist1">
8633 <code>guiffy</code>
8634 </dt>
8635 <dd>
8636 <p>
8637 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
8638 </p>
8639 </dd>
8640 <dt class="hdlist1">
8641 <code>gvimdiff</code>
8642 </dt>
8643 <dd>
8644 <p>
8645 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8646 </p>
8647 </dd>
8648 <dt class="hdlist1">
8649 <code>gvimdiff1</code>
8650 </dt>
8651 <dd>
8652 <p>
8653 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
8654 </p>
8655 </dd>
8656 <dt class="hdlist1">
8657 <code>gvimdiff2</code>
8658 </dt>
8659 <dd>
8660 <p>
8661 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
8662 </p>
8663 </dd>
8664 <dt class="hdlist1">
8665 <code>gvimdiff3</code>
8666 </dt>
8667 <dd>
8668 <p>
8669 Use gVim (requires a graphical session) where only the MERGED file is shown
8670 </p>
8671 </dd>
8672 <dt class="hdlist1">
8673 <code>kdiff3</code>
8674 </dt>
8675 <dd>
8676 <p>
8677 Use KDiff3 (requires a graphical session)
8678 </p>
8679 </dd>
8680 <dt class="hdlist1">
8681 <code>meld</code>
8682 </dt>
8683 <dd>
8684 <p>
8685 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
8686 </p>
8687 </dd>
8688 <dt class="hdlist1">
8689 <code>nvimdiff</code>
8690 </dt>
8691 <dd>
8692 <p>
8693 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8694 </p>
8695 </dd>
8696 <dt class="hdlist1">
8697 <code>nvimdiff1</code>
8698 </dt>
8699 <dd>
8700 <p>
8701 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
8702 </p>
8703 </dd>
8704 <dt class="hdlist1">
8705 <code>nvimdiff2</code>
8706 </dt>
8707 <dd>
8708 <p>
8709 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8710 </p>
8711 </dd>
8712 <dt class="hdlist1">
8713 <code>nvimdiff3</code>
8714 </dt>
8715 <dd>
8716 <p>
8717 Use Neovim where only the MERGED file is shown
8718 </p>
8719 </dd>
8720 <dt class="hdlist1">
8721 <code>opendiff</code>
8722 </dt>
8723 <dd>
8724 <p>
8725 Use FileMerge (requires a graphical session)
8726 </p>
8727 </dd>
8728 <dt class="hdlist1">
8729 <code>p4merge</code>
8730 </dt>
8731 <dd>
8732 <p>
8733 Use HelixCore P4Merge (requires a graphical session)
8734 </p>
8735 </dd>
8736 <dt class="hdlist1">
8737 <code>smerge</code>
8738 </dt>
8739 <dd>
8740 <p>
8741 Use Sublime Merge (requires a graphical session)
8742 </p>
8743 </dd>
8744 <dt class="hdlist1">
8745 <code>tkdiff</code>
8746 </dt>
8747 <dd>
8748 <p>
8749 Use TkDiff (requires a graphical session)
8750 </p>
8751 </dd>
8752 <dt class="hdlist1">
8753 <code>tortoisemerge</code>
8754 </dt>
8755 <dd>
8756 <p>
8757 Use TortoiseMerge (requires a graphical session)
8758 </p>
8759 </dd>
8760 <dt class="hdlist1">
8761 <code>vimdiff</code>
8762 </dt>
8763 <dd>
8764 <p>
8765 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8766 </p>
8767 </dd>
8768 <dt class="hdlist1">
8769 <code>vimdiff1</code>
8770 </dt>
8771 <dd>
8772 <p>
8773 Use Vim with a 2 panes layout (LOCAL and REMOTE)
8774 </p>
8775 </dd>
8776 <dt class="hdlist1">
8777 <code>vimdiff2</code>
8778 </dt>
8779 <dd>
8780 <p>
8781 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8782 </p>
8783 </dd>
8784 <dt class="hdlist1">
8785 <code>vimdiff3</code>
8786 </dt>
8787 <dd>
8788 <p>
8789 Use Vim where only the MERGED file is shown
8790 </p>
8791 </dd>
8792 <dt class="hdlist1">
8793 <code>winmerge</code>
8794 </dt>
8795 <dd>
8796 <p>
8797 Use WinMerge (requires a graphical session)
8798 </p>
8799 </dd>
8800 <dt class="hdlist1">
8801 <code>xxdiff</code>
8802 </dt>
8803 <dd>
8804 <p>
8805 Use xxdiff (requires a graphical session)
8806 </p>
8807 </dd>
8808 </dl></div>
8809 </dd>
8810 <dt class="hdlist1">
8811 merge.verbosity
8812 </dt>
8813 <dd>
8814 <p>
8815         Controls the amount of output shown by the recursive merge
8816         strategy.  Level 0 outputs nothing except a final error
8817         message if conflicts were detected. Level 1 outputs only
8818         conflicts, 2 outputs conflicts and file changes.  Level 5 and
8819         above outputs debugging information.  The default is level 2.
8820         Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
8821 </p>
8822 </dd>
8823 <dt class="hdlist1">
8824 merge.&lt;driver&gt;.name
8825 </dt>
8826 <dd>
8827 <p>
8828         Defines a human-readable name for a custom low-level
8829         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8830 </p>
8831 </dd>
8832 <dt class="hdlist1">
8833 merge.&lt;driver&gt;.driver
8834 </dt>
8835 <dd>
8836 <p>
8837         Defines the command that implements a custom low-level
8838         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8839 </p>
8840 </dd>
8841 <dt class="hdlist1">
8842 merge.&lt;driver&gt;.recursive
8843 </dt>
8844 <dd>
8845 <p>
8846         Names a low-level merge driver to be used when
8847         performing an internal merge between common ancestors.
8848         See <a href="gitattributes.html">gitattributes(5)</a> for details.
8849 </p>
8850 </dd>
8851 <dt class="hdlist1">
8852 mergetool.&lt;tool&gt;.path
8853 </dt>
8854 <dd>
8855 <p>
8856         Override the path for the given tool.  This is useful in case
8857         your tool is not in the PATH.
8858 </p>
8859 </dd>
8860 <dt class="hdlist1">
8861 mergetool.&lt;tool&gt;.cmd
8862 </dt>
8863 <dd>
8864 <p>
8865         Specify the command to invoke the specified merge tool.  The
8866         specified command is evaluated in shell with the following
8867         variables available: <em>BASE</em> is the name of a temporary file
8868         containing the common base of the files to be merged, if available;
8869         <em>LOCAL</em> is the name of a temporary file containing the contents of
8870         the file on the current branch; <em>REMOTE</em> is the name of a temporary
8871         file containing the contents of the file from the branch being
8872         merged; <em>MERGED</em> contains the name of the file to which the merge
8873         tool should write the results of a successful merge.
8874 </p>
8875 </dd>
8876 <dt class="hdlist1">
8877 mergetool.&lt;tool&gt;.hideResolved
8878 </dt>
8879 <dd>
8880 <p>
8881         Allows the user to override the global <code>mergetool.hideResolved</code> value
8882         for a specific tool. See <code>mergetool.hideResolved</code> for the full
8883         description.
8884 </p>
8885 </dd>
8886 <dt class="hdlist1">
8887 mergetool.&lt;tool&gt;.trustExitCode
8888 </dt>
8889 <dd>
8890 <p>
8891         For a custom merge command, specify whether the exit code of
8892         the merge command can be used to determine whether the merge was
8893         successful.  If this is not set to true then the merge target file
8894         timestamp is checked, and the merge is assumed to have been successful
8895         if the file has been updated; otherwise, the user is prompted to
8896         indicate the success of the merge.
8897 </p>
8898 </dd>
8899 <dt class="hdlist1">
8900 mergetool.meld.hasOutput
8901 </dt>
8902 <dd>
8903 <p>
8904         Older versions of <code>meld</code> do not support the <code>--output</code> option.
8905         Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
8906         by inspecting the output of <code>meld --help</code>.  Configuring
8907         <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
8908         use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
8909         to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
8910         and <code>false</code> avoids using <code>--output</code>.
8911 </p>
8912 </dd>
8913 <dt class="hdlist1">
8914 mergetool.meld.useAutoMerge
8915 </dt>
8916 <dd>
8917 <p>
8918         When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
8919         parts automatically, highlight the conflicting parts, and wait for
8920         user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
8921         Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
8922         Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
8923         is supported and will only use <code>--auto-merge</code> when available.  A
8924         value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
8925         default value.
8926 </p>
8927 </dd>
8928 <dt class="hdlist1">
8929 mergetool.&lt;vimdiff variant&gt;.layout
8930 </dt>
8931 <dd>
8932 <p>
8933         Configure the split window layout for vimdiff&#8217;s <code>&lt;variant&gt;</code>, which is any of <code>vimdiff</code>,
8934         <code>nvimdiff</code>, <code>gvimdiff</code>.
8935         Upon launching <code>git mergetool</code> with <code>--tool=&lt;variant&gt;</code> (or without <code>--tool</code>
8936         if <code>merge.tool</code> is configured as <code>&lt;variant&gt;</code>), Git will consult
8937         <code>mergetool.&lt;variant&gt;.layout</code> to determine the tool&#8217;s layout. If the
8938         variant-specific configuration is not available, <code>vimdiff</code>'s is used as
8939         fallback.  If that too is not available, a default layout with 4 windows
8940         will be used.  To configure the layout, see the <code>BACKEND SPECIFIC HINTS</code>
8941         section in <a href="git-mergetool.html">git-mergetool(1)</a>.
8942 </p>
8943 </dd>
8944 <dt class="hdlist1">
8945 mergetool.hideResolved
8946 </dt>
8947 <dd>
8948 <p>
8949         During a merge, Git will automatically resolve as many conflicts as
8950         possible and write the <em>MERGED</em> file containing conflict markers around
8951         any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
8952         represent the versions of the file from before Git&#8217;s conflict
8953         resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
8954         that only the unresolved conflicts are presented to the merge tool. Can
8955         be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
8956         configuration variable. Defaults to <code>false</code>.
8957 </p>
8958 </dd>
8959 <dt class="hdlist1">
8960 mergetool.keepBackup
8961 </dt>
8962 <dd>
8963 <p>
8964         After performing a merge, the original file with conflict markers
8965         can be saved as a file with a <code>.orig</code> extension.  If this variable
8966         is set to <code>false</code> then this file is not preserved.  Defaults to
8967         <code>true</code> (i.e. keep the backup files).
8968 </p>
8969 </dd>
8970 <dt class="hdlist1">
8971 mergetool.keepTemporaries
8972 </dt>
8973 <dd>
8974 <p>
8975         When invoking a custom merge tool, Git uses a set of temporary
8976         files to pass to the tool. If the tool returns an error and this
8977         variable is set to <code>true</code>, then these temporary files will be
8978         preserved; otherwise, they will be removed after the tool has
8979         exited. Defaults to <code>false</code>.
8980 </p>
8981 </dd>
8982 <dt class="hdlist1">
8983 mergetool.writeToTemp
8984 </dt>
8985 <dd>
8986 <p>
8987         Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
8988         conflicting files in the worktree by default.  Git will attempt
8989         to use a temporary directory for these files when set <code>true</code>.
8990         Defaults to <code>false</code>.
8991 </p>
8992 </dd>
8993 <dt class="hdlist1">
8994 mergetool.prompt
8995 </dt>
8996 <dd>
8997 <p>
8998         Prompt before each invocation of the merge resolution program.
8999 </p>
9000 </dd>
9001 <dt class="hdlist1">
9002 mergetool.guiDefault
9003 </dt>
9004 <dd>
9005 <p>
9006         Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
9007         specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
9008         or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
9009         variable value. The default is <code>false</code>, where the <code>--gui</code> argument
9010         must be provided explicitly for the <code>merge.guitool</code> to be used.
9011 </p>
9012 </dd>
9013 <dt class="hdlist1">
9014 notes.mergeStrategy
9015 </dt>
9016 <dd>
9017 <p>
9018         Which merge strategy to choose by default when resolving notes
9019         conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
9020         <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
9021         section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
9022 </p>
9023 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
9024 <a href="git-notes.html">git-notes(1)</a>.</p></div>
9025 </dd>
9026 <dt class="hdlist1">
9027 notes.&lt;name&gt;.mergeStrategy
9028 </dt>
9029 <dd>
9030 <p>
9031         Which merge strategy to choose when doing a notes merge into
9032         refs/notes/&lt;name&gt;.  This overrides the more general
9033         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
9034         <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
9035 </p>
9036 </dd>
9037 <dt class="hdlist1">
9038 notes.displayRef
9039 </dt>
9040 <dd>
9041 <p>
9042         Which ref (or refs, if a glob or specified more than once), in
9043         addition to the default set by <code>core.notesRef</code> or
9044         <code>GIT_NOTES_REF</code>, to read notes from when showing commit
9045         messages with the <em>git log</em> family of commands.
9046 </p>
9047 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
9048 environment variable, which must be a colon separated list of refs or
9049 globs.</p></div>
9050 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
9051 but a glob that does not match any refs is silently ignored.</p></div>
9052 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
9053 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
9054 those commands.</p></div>
9055 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
9056 GIT_NOTES_REF) is also implicitly added to the list of refs to be
9057 displayed.</p></div>
9058 </dd>
9059 <dt class="hdlist1">
9060 notes.rewrite.&lt;command&gt;
9061 </dt>
9062 <dd>
9063 <p>
9064         When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
9065         <code>rebase</code>), if this variable is <code>false</code>, git will not copy
9066         notes from the original to the rewritten commit.  Defaults to
9067         <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.
9068 </p>
9069 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
9070 environment variable, which must be a colon separated list of refs or
9071 globs.</p></div>
9072 </dd>
9073 <dt class="hdlist1">
9074 notes.rewriteMode
9075 </dt>
9076 <dd>
9077 <p>
9078         When copying notes during a rewrite (see the
9079         "notes.rewrite.&lt;command&gt;" option), determines what to do if
9080         the target commit already has a note.  Must be one of
9081         <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
9082         Defaults to <code>concatenate</code>.
9083 </p>
9084 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
9085 environment variable.</p></div>
9086 </dd>
9087 <dt class="hdlist1">
9088 notes.rewriteRef
9089 </dt>
9090 <dd>
9091 <p>
9092         When copying notes during a rewrite, specifies the (fully
9093         qualified) ref whose notes should be copied.  May be a glob,
9094         in which case notes in all matching refs will be copied.  You
9095         may also specify this configuration several times.
9096 </p>
9097 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
9098 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
9099 rewriting for the default commit notes.</p></div>
9100 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
9101 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
9102 </dd>
9103 <dt class="hdlist1">
9104 pack.window
9105 </dt>
9106 <dd>
9107 <p>
9108         The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9109         window size is given on the command line. Defaults to 10.
9110 </p>
9111 </dd>
9112 <dt class="hdlist1">
9113 pack.depth
9114 </dt>
9115 <dd>
9116 <p>
9117         The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9118         maximum depth is given on the command line. Defaults to 50.
9119         Maximum value is 4095.
9120 </p>
9121 </dd>
9122 <dt class="hdlist1">
9123 pack.windowMemory
9124 </dt>
9125 <dd>
9126 <p>
9127         The maximum size of memory that is consumed by each thread
9128         in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
9129         no limit is given on the command line.  The value can be
9130         suffixed with "k", "m", or "g".  When left unconfigured (or
9131         set explicitly to 0), there will be no limit.
9132 </p>
9133 </dd>
9134 <dt class="hdlist1">
9135 pack.compression
9136 </dt>
9137 <dd>
9138 <p>
9139         An integer -1..9, indicating the compression level for objects
9140         in a pack file. -1 is the zlib default. 0 means no
9141         compression, and 1..9 are various speed/size tradeoffs, 9 being
9142         slowest.  If not set,  defaults to core.compression.  If that is
9143         not set,  defaults to -1, the zlib default, which is "a default
9144         compromise between speed and compression (currently equivalent
9145         to level 6)."
9146 </p>
9147 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
9148 all existing objects. You can force recompression by passing the -F option
9149 to <a href="git-repack.html">git-repack(1)</a>.</p></div>
9150 </dd>
9151 <dt class="hdlist1">
9152 pack.allowPackReuse
9153 </dt>
9154 <dd>
9155 <p>
9156         When true or "single", and when reachability bitmaps are
9157         enabled, pack-objects will try to send parts of the bitmapped
9158         packfile verbatim. When "multi", and when a multi-pack
9159         reachability bitmap is available, pack-objects will try to send
9160         parts of all packs in the MIDX.
9161 </p>
9162 <div class="paragraph"><p>If only a single pack bitmap is available, and <code>pack.allowPackReuse</code>
9163 is set to "multi", reuse parts of just the bitmapped packfile. This
9164 can reduce memory and CPU usage to serve fetches, but might result in
9165 sending a slightly larger pack. Defaults to true.</p></div>
9166 </dd>
9167 <dt class="hdlist1">
9168 pack.island
9169 </dt>
9170 <dd>
9171 <p>
9172         An extended regular expression configuring a set of delta
9173         islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
9174         for details.
9175 </p>
9176 </dd>
9177 <dt class="hdlist1">
9178 pack.islandCore
9179 </dt>
9180 <dd>
9181 <p>
9182         Specify an island name which gets to have its objects be
9183         packed first. This creates a kind of pseudo-pack at the front
9184         of one pack, so that the objects from the specified island are
9185         hopefully faster to copy into any pack that should be served
9186         to a user requesting these objects. In practice this means
9187         that the island specified should likely correspond to what is
9188         the most commonly cloned in the repo. See also "DELTA ISLANDS"
9189         in <a href="git-pack-objects.html">git-pack-objects(1)</a>.
9190 </p>
9191 </dd>
9192 <dt class="hdlist1">
9193 pack.deltaCacheSize
9194 </dt>
9195 <dd>
9196 <p>
9197         The maximum memory in bytes used for caching deltas in
9198         <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
9199         This cache is used to speed up the writing object phase by not
9200         having to recompute the final delta result once the best match
9201         for all objects is found.  Repacking large repositories on machines
9202         which are tight with memory might be badly impacted by this though,
9203         especially if this cache pushes the system into swapping.
9204         A value of 0 means no limit. The smallest size of 1 byte may be
9205         used to virtually disable this cache. Defaults to 256 MiB.
9206 </p>
9207 </dd>
9208 <dt class="hdlist1">
9209 pack.deltaCacheLimit
9210 </dt>
9211 <dd>
9212 <p>
9213         The maximum size of a delta, that is cached in
9214         <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
9215         writing object phase by not having to recompute the final delta
9216         result once the best match for all objects is found.
9217         Defaults to 1000. Maximum value is 65535.
9218 </p>
9219 </dd>
9220 <dt class="hdlist1">
9221 pack.threads
9222 </dt>
9223 <dd>
9224 <p>
9225         Specifies the number of threads to spawn when searching for best
9226         delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
9227         be compiled with pthreads otherwise this option is ignored with a
9228         warning. This is meant to reduce packing time on multiprocessor
9229         machines. The required amount of memory for the delta search window
9230         is however multiplied by the number of threads.
9231         Specifying 0 will cause Git to auto-detect the number of CPUs
9232         and set the number of threads accordingly.
9233 </p>
9234 </dd>
9235 <dt class="hdlist1">
9236 pack.indexVersion
9237 </dt>
9238 <dd>
9239 <p>
9240         Specify the default pack index version.  Valid values are 1 for
9241         legacy pack index used by Git versions prior to 1.5.2, and 2 for
9242         the new pack index with capabilities for packs larger than 4 GB
9243         as well as proper protection against the repacking of corrupted
9244         packs.  Version 2 is the default.  Note that version 2 is enforced
9245         and this config option is ignored whenever the corresponding pack is
9246         larger than 2 GB.
9247 </p>
9248 <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9249 cloning or fetching over a non-native protocol (e.g. "http")
9250 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9251 other side may give you a repository that cannot be accessed with your
9252 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9253 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
9254 the <code>*.idx</code> file.</p></div>
9255 </dd>
9256 <dt class="hdlist1">
9257 pack.packSizeLimit
9258 </dt>
9259 <dd>
9260 <p>
9261         The maximum size of a pack.  This setting only affects
9262         packing to a file when repacking, i.e. the git:// protocol
9263         is unaffected.  It can be overridden by the <code>--max-pack-size</code>
9264         option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
9265         in the creation of multiple packfiles.
9266 </p>
9267 <div class="paragraph"><p>Note that this option is rarely useful, and may result in a larger total
9268 on-disk size (because Git will not store deltas between packs) and
9269 worse runtime performance (object lookup within multiple packs is
9270 slower than a single pack, and optimizations like reachability bitmaps
9271 cannot cope with multiple packs).</p></div>
9272 <div class="paragraph"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9273 filesystem does not support large files), this option may help. But if
9274 your goal is to transmit a packfile over a medium that supports limited
9275 sizes (e.g., removable media that cannot store the whole repository),
9276 you are likely better off creating a single large packfile and splitting
9277 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9278 <div class="paragraph"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9279 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9280 </dd>
9281 <dt class="hdlist1">
9282 pack.useBitmaps
9283 </dt>
9284 <dd>
9285 <p>
9286         When true, git will use pack bitmaps (if available) when packing
9287         to stdout (e.g., during the server side of a fetch). Defaults to
9288         true. You should not generally need to turn this off unless
9289         you are debugging pack bitmaps.
9290 </p>
9291 </dd>
9292 <dt class="hdlist1">
9293 pack.useBitmapBoundaryTraversal
9294 </dt>
9295 <dd>
9296 <p>
9297         When true, Git will use an experimental algorithm for computing
9298         reachability queries with bitmaps. Instead of building up
9299         complete bitmaps for all of the negated tips and then OR-ing
9300         them together, consider negated tips with existing bitmaps as
9301         additive (i.e. OR-ing them into the result if they exist,
9302         ignoring them otherwise), and build up a bitmap at the boundary
9303         instead.
9304 </p>
9305 <div class="paragraph"><p>When using this algorithm, Git may include too many objects as a result
9306 of not opening up trees belonging to certain UNINTERESTING commits. This
9307 inexactness matches the non-bitmap traversal algorithm.</p></div>
9308 <div class="paragraph"><p>In many cases, this can provide a speed-up over the exact algorithm,
9309 particularly when there is poor bitmap coverage of the negated side of
9310 the query.</p></div>
9311 </dd>
9312 <dt class="hdlist1">
9313 pack.useSparse
9314 </dt>
9315 <dd>
9316 <p>
9317         When true, git will default to using the <em>--sparse</em> option in
9318         <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9319         algorithm only walks trees that appear in paths that introduce new
9320         objects. This can have significant performance benefits when
9321         computing a pack to send a small change. However, it is possible
9322         that extra objects are added to the pack-file if the included
9323         commits contain certain types of direct renames. Default is
9324         <code>true</code>.
9325 </p>
9326 </dd>
9327 <dt class="hdlist1">
9328 pack.preferBitmapTips
9329 </dt>
9330 <dd>
9331 <p>
9332         When selecting which commits will receive bitmaps, prefer a
9333         commit at the tip of any reference that is a suffix of any value
9334         of this configuration over any other commits in the "selection
9335         window".
9336 </p>
9337 <div class="paragraph"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9338 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9339 necessarily be selected. This is because commits are selected for
9340 bitmaps from within a series of windows of variable length.</p></div>
9341 <div class="paragraph"><p>If a commit at the tip of any reference which is a suffix of any value
9342 of this configuration is seen in a window, it is immediately given
9343 preference over any other commit in that window.</p></div>
9344 </dd>
9345 <dt class="hdlist1">
9346 pack.writeBitmaps (deprecated)
9347 </dt>
9348 <dd>
9349 <p>
9350         This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9351 </p>
9352 </dd>
9353 <dt class="hdlist1">
9354 pack.writeBitmapHashCache
9355 </dt>
9356 <dd>
9357 <p>
9358         When true, git will include a "hash cache" section in the bitmap
9359         index (if one is written). This cache can be used to feed git&#8217;s
9360         delta heuristics, potentially leading to better deltas between
9361         bitmapped and non-bitmapped objects (e.g., when serving a fetch
9362         between an older, bitmapped pack and objects that have been
9363         pushed since the last gc). The downside is that it consumes 4
9364         bytes per object of disk space. Defaults to true.
9365 </p>
9366 <div class="paragraph"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9367 computed; instead, any namehashes stored in an existing bitmap are
9368 permuted into their appropriate location when writing a new bitmap.</p></div>
9369 </dd>
9370 <dt class="hdlist1">
9371 pack.writeBitmapLookupTable
9372 </dt>
9373 <dd>
9374 <p>
9375         When true, Git will include a "lookup table" section in the
9376         bitmap index (if one is written). This table is used to defer
9377         loading individual bitmaps as late as possible. This can be
9378         beneficial in repositories that have relatively large bitmap
9379         indexes. Defaults to false.
9380 </p>
9381 </dd>
9382 <dt class="hdlist1">
9383 pack.readReverseIndex
9384 </dt>
9385 <dd>
9386 <p>
9387         When true, git will read any .rev file(s) that may be available
9388         (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
9389         will be generated from scratch and stored in memory. Defaults to
9390         true.
9391 </p>
9392 </dd>
9393 <dt class="hdlist1">
9394 pack.writeReverseIndex
9395 </dt>
9396 <dd>
9397 <p>
9398         When true, git will write a corresponding .rev file (see:
9399         <a href="gitformat-pack.html">gitformat-pack(5)</a>)
9400         for each new packfile that it writes in all places except for
9401         <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
9402         Defaults to true.
9403 </p>
9404 </dd>
9405 <dt class="hdlist1">
9406 pager.&lt;cmd&gt;
9407 </dt>
9408 <dd>
9409 <p>
9410         If the value is boolean, turns on or off pagination of the
9411         output of a particular Git subcommand when writing to a tty.
9412         Otherwise, turns on pagination for the subcommand using the
9413         pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
9414         or <code>--no-pager</code> is specified on the command line, it takes
9415         precedence over this option.  To disable pagination for all
9416         commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9417 </p>
9418 </dd>
9419 <dt class="hdlist1">
9420 pretty.&lt;name&gt;
9421 </dt>
9422 <dd>
9423 <p>
9424         Alias for a --pretty= format string, as specified in
9425         <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
9426         as the built-in pretty formats could. For example,
9427         running <code>git config pretty.changelog "format:* %H %s"</code>
9428         would cause the invocation <code>git log --pretty=changelog</code>
9429         to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
9430         Note that an alias with the same name as a built-in format
9431         will be silently ignored.
9432 </p>
9433 </dd>
9434 <dt class="hdlist1">
9435 protocol.allow
9436 </dt>
9437 <dd>
9438 <p>
9439         If set, provide a user defined default policy for all protocols which
9440         don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
9441         if unset, known-safe protocols (http, https, git, ssh) have a
9442         default policy of <code>always</code>, known-dangerous protocols (ext) have a
9443         default policy of <code>never</code>, and all other protocols (including file)
9444         have a default policy of <code>user</code>.  Supported policies:
9445 </p>
9446 <div class="openblock">
9447 <div class="content">
9448 <div class="ulist"><ul>
9449 <li>
9450 <p>
9451 <code>always</code> - protocol is always able to be used.
9452 </p>
9453 </li>
9454 <li>
9455 <p>
9456 <code>never</code> - protocol is never able to be used.
9457 </p>
9458 </li>
9459 <li>
9460 <p>
9461 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9462   either unset or has a value of 1.  This policy should be used when you want a
9463   protocol to be directly usable by the user but don&#8217;t want it used by commands which
9464   execute clone/fetch/push commands without user input, e.g. recursive
9465   submodule initialization.
9466 </p>
9467 </li>
9468 </ul></div>
9469 </div></div>
9470 </dd>
9471 <dt class="hdlist1">
9472 protocol.&lt;name&gt;.allow
9473 </dt>
9474 <dd>
9475 <p>
9476         Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
9477         commands. See <code>protocol.allow</code> above for the available policies.
9478 </p>
9479 <div class="paragraph"><p>The protocol names currently used by git are:</p></div>
9480 <div class="openblock">
9481 <div class="content">
9482 <div class="ulist"><ul>
9483 <li>
9484 <p>
9485 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9486     or local paths)
9487 </p>
9488 </li>
9489 <li>
9490 <p>
9491 <code>git</code>: the anonymous git protocol over a direct TCP
9492     connection (or proxy, if configured)
9493 </p>
9494 </li>
9495 <li>
9496 <p>
9497 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9498     <code>ssh://</code>, etc).
9499 </p>
9500 </li>
9501 <li>
9502 <p>
9503 <code>http</code>: git over http, both "smart http" and "dumb http".
9504     Note that this does <em>not</em> include <code>https</code>; if you want to configure
9505     both, you must do so individually.
9506 </p>
9507 </li>
9508 <li>
9509 <p>
9510 any external helpers are named by their protocol (e.g., use
9511     <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9512 </p>
9513 </li>
9514 </ul></div>
9515 </div></div>
9516 </dd>
9517 <dt class="hdlist1">
9518 protocol.version
9519 </dt>
9520 <dd>
9521 <p>
9522         If set, clients will attempt to communicate with a server
9523         using the specified protocol version.  If the server does
9524         not support it, communication falls back to version 0.
9525         If unset, the default is <code>2</code>.
9526         Supported versions:
9527 </p>
9528 <div class="openblock">
9529 <div class="content">
9530 <div class="ulist"><ul>
9531 <li>
9532 <p>
9533 <code>0</code> - the original wire protocol.
9534 </p>
9535 </li>
9536 <li>
9537 <p>
9538 <code>1</code> - the original wire protocol with the addition of a version string
9539   in the initial response from the server.
9540 </p>
9541 </li>
9542 <li>
9543 <p>
9544 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.
9545 </p>
9546 </li>
9547 </ul></div>
9548 </div></div>
9549 </dd>
9550 <dt class="hdlist1">
9551 pull.ff
9552 </dt>
9553 <dd>
9554 <p>
9555         By default, Git does not create an extra merge commit when merging
9556         a commit that is a descendant of the current commit. Instead, the
9557         tip of the current branch is fast-forwarded. When set to <code>false</code>,
9558         this variable tells Git to create an extra merge commit in such
9559         a case (equivalent to giving the <code>--no-ff</code> option from the command
9560         line). When set to <code>only</code>, only such fast-forward merges are
9561         allowed (equivalent to giving the <code>--ff-only</code> option from the
9562         command line). This setting overrides <code>merge.ff</code> when pulling.
9563 </p>
9564 </dd>
9565 <dt class="hdlist1">
9566 pull.rebase
9567 </dt>
9568 <dd>
9569 <p>
9570         When true, rebase branches on top of the fetched branch, instead
9571         of merging the default branch from the default remote when "git
9572         pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
9573         per-branch basis.
9574 </p>
9575 <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>
9576 so that the local merge commits are included in the rebase (see
9577 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
9578 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9579 mode.</p></div>
9580 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9581 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
9582 for details).</p></div>
9583 </dd>
9584 <dt class="hdlist1">
9585 pull.octopus
9586 </dt>
9587 <dd>
9588 <p>
9589         The default merge strategy to use when pulling multiple branches
9590         at once.
9591 </p>
9592 </dd>
9593 <dt class="hdlist1">
9594 pull.twohead
9595 </dt>
9596 <dd>
9597 <p>
9598         The default merge strategy to use when pulling a single branch.
9599 </p>
9600 </dd>
9601 <dt class="hdlist1">
9602 push.autoSetupRemote
9603 </dt>
9604 <dd>
9605 <p>
9606         If set to "true" assume <code>--set-upstream</code> on default push when no
9607         upstream tracking exists for the current branch; this option
9608         takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9609         and <em>current</em>. It is useful if by default you want new branches
9610         to be pushed to the default remote (like the behavior of
9611         <em>push.default=current</em>) and you also want the upstream tracking
9612         to be set. Workflows most likely to benefit from this option are
9613         <em>simple</em> central workflows where all branches are expected to
9614         have the same name on the remote.
9615 </p>
9616 </dd>
9617 <dt class="hdlist1">
9618 push.default
9619 </dt>
9620 <dd>
9621 <p>
9622         Defines the action <code>git push</code> should take if no refspec is
9623         given (whether from the command-line, config, or elsewhere).
9624         Different values are well-suited for
9625         specific workflows; for instance, in a purely central workflow
9626         (i.e. the fetch source is equal to the push destination),
9627         <code>upstream</code> is probably what you want.  Possible values are:
9628 </p>
9629 <div class="openblock">
9630 <div class="content">
9631 <div class="ulist"><ul>
9632 <li>
9633 <p>
9634 <code>nothing</code> - do not push anything (error out) unless a refspec is
9635   given. This is primarily meant for people who want to
9636   avoid mistakes by always being explicit.
9637 </p>
9638 </li>
9639 <li>
9640 <p>
9641 <code>current</code> - push the current branch to update a branch with the same
9642   name on the receiving end.  Works in both central and non-central
9643   workflows.
9644 </p>
9645 </li>
9646 <li>
9647 <p>
9648 <code>upstream</code> - push the current branch back to the branch whose
9649   changes are usually integrated into the current branch (which is
9650   called <code>@{upstream}</code>).  This mode only makes sense if you are
9651   pushing to the same repository you would normally pull from
9652   (i.e. central workflow).
9653 </p>
9654 </li>
9655 <li>
9656 <p>
9657 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
9658 </p>
9659 </li>
9660 <li>
9661 <p>
9662 <code>simple</code> - push the current branch with the same name on the remote.
9663 </p>
9664 <div class="paragraph"><p>If you are working on a centralized workflow (pushing to the same repository you
9665 pull from, which is typically <code>origin</code>), then you need to configure an upstream
9666 branch with the same name.</p></div>
9667 <div class="paragraph"><p>This mode is the default since Git 2.0, and is the safest option suited for
9668 beginners.</p></div>
9669 </li>
9670 <li>
9671 <p>
9672 <code>matching</code> - push all branches having the same name on both ends.
9673   This makes the repository you are pushing to remember the set of
9674   branches that will be pushed out (e.g. if you always push <em>maint</em>
9675   and <em>master</em> there and no other branches, the repository you push
9676   to will have these two branches, and your local <em>maint</em> and
9677   <em>master</em> will be pushed there).
9678 </p>
9679 <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
9680 branches you would push out are ready to be pushed out before
9681 running <em>git push</em>, as the whole point of this mode is to allow you
9682 to push all of the branches in one go.  If you usually finish work
9683 on only one branch and push out the result, while other branches are
9684 unfinished, this mode is not for you.  Also this mode is not
9685 suitable for pushing into a shared central repository, as other
9686 people may add new branches there, or update the tip of existing
9687 branches outside your control.</p></div>
9688 <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
9689 new default).</p></div>
9690 </li>
9691 </ul></div>
9692 </div></div>
9693 </dd>
9694 <dt class="hdlist1">
9695 push.followTags
9696 </dt>
9697 <dd>
9698 <p>
9699         If set to true, enable <code>--follow-tags</code> option by default.  You
9700         may override this configuration at time of push by specifying
9701         <code>--no-follow-tags</code>.
9702 </p>
9703 </dd>
9704 <dt class="hdlist1">
9705 push.gpgSign
9706 </dt>
9707 <dd>
9708 <p>
9709         May be set to a boolean value, or the string <em>if-asked</em>. A true
9710         value causes all pushes to be GPG signed, as if <code>--signed</code> is
9711         passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
9712         pushes to be signed if the server supports it, as if
9713         <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
9714         override a value from a lower-priority config file. An explicit
9715         command-line flag always overrides this config option.
9716 </p>
9717 </dd>
9718 <dt class="hdlist1">
9719 push.pushOption
9720 </dt>
9721 <dd>
9722 <p>
9723         When no <code>--push-option=&lt;option&gt;</code> argument is given from the
9724         command line, <code>git push</code> behaves as if each &lt;value&gt; of
9725         this variable is given as <code>--push-option=&lt;value&gt;</code>.
9726 </p>
9727 <div class="paragraph"><p>This is a multi-valued variable, and an empty value can be used in a
9728 higher priority configuration file (e.g. <code>.git/config</code> in a
9729 repository) to clear the values inherited from a lower priority
9730 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
9731 <div class="listingblock">
9732 <div class="content">
9733 <pre><code>Example:
9734
9735 /etc/gitconfig
9736   push.pushoption = a
9737   push.pushoption = b
9738
9739 ~/.gitconfig
9740   push.pushoption = c
9741
9742 repo/.git/config
9743   push.pushoption =
9744   push.pushoption = b
9745
9746 This will result in only b (a and c are cleared).</code></pre>
9747 </div></div>
9748 </dd>
9749 <dt class="hdlist1">
9750 push.recurseSubmodules
9751 </dt>
9752 <dd>
9753 <p>
9754         May be "check", "on-demand", "only", or "no", with the same behavior
9755         as that of "push --recurse-submodules".
9756         If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
9757         set (in which case a <em>true</em> value means <em>on-demand</em>).
9758 </p>
9759 </dd>
9760 <dt class="hdlist1">
9761 push.useForceIfIncludes
9762 </dt>
9763 <dd>
9764 <p>
9765         If set to "true", it is equivalent to specifying
9766         <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
9767         in the command line. Adding <code>--no-force-if-includes</code> at the
9768         time of push overrides this configuration setting.
9769 </p>
9770 </dd>
9771 <dt class="hdlist1">
9772 push.negotiate
9773 </dt>
9774 <dd>
9775 <p>
9776         If set to "true", attempt to reduce the size of the packfile
9777         sent by rounds of negotiation in which the client and the
9778         server attempt to find commits in common. If "false", Git will
9779         rely solely on the server&#8217;s ref advertisement to find commits
9780         in common.
9781 </p>
9782 </dd>
9783 <dt class="hdlist1">
9784 push.useBitmaps
9785 </dt>
9786 <dd>
9787 <p>
9788         If set to "false", disable use of bitmaps for "git push" even if
9789         <code>pack.useBitmaps</code> is "true", without preventing other git operations
9790         from using bitmaps. Default is true.
9791 </p>
9792 </dd>
9793 <dt class="hdlist1">
9794 rebase.backend
9795 </dt>
9796 <dd>
9797 <p>
9798         Default backend to use for rebasing.  Possible choices are
9799         <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
9800         all remaining capabilities of the apply backend, this setting
9801         may become unused.
9802 </p>
9803 </dd>
9804 <dt class="hdlist1">
9805 rebase.stat
9806 </dt>
9807 <dd>
9808 <p>
9809         Whether to show a diffstat of what changed upstream since the last
9810         rebase. False by default.
9811 </p>
9812 </dd>
9813 <dt class="hdlist1">
9814 rebase.autoSquash
9815 </dt>
9816 <dd>
9817 <p>
9818         If set to true, enable the <code>--autosquash</code> option of
9819         <a href="git-rebase.html">git-rebase(1)</a> by default for interactive mode.
9820         This can be overridden with the <code>--no-autosquash</code> option.
9821 </p>
9822 </dd>
9823 <dt class="hdlist1">
9824 rebase.autoStash
9825 </dt>
9826 <dd>
9827 <p>
9828         When set to true, automatically create a temporary stash entry
9829         before the operation begins, and apply it after the operation
9830         ends.  This means that you can run rebase on a dirty worktree.
9831         However, use with care: the final stash application after a
9832         successful rebase might result in non-trivial conflicts.
9833         This option can be overridden by the <code>--no-autostash</code> and
9834         <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
9835         Defaults to false.
9836 </p>
9837 </dd>
9838 <dt class="hdlist1">
9839 rebase.updateRefs
9840 </dt>
9841 <dd>
9842 <p>
9843         If set to true enable <code>--update-refs</code> option by default.
9844 </p>
9845 </dd>
9846 <dt class="hdlist1">
9847 rebase.missingCommitsCheck
9848 </dt>
9849 <dd>
9850 <p>
9851         If set to "warn", git rebase -i will print a warning if some
9852         commits are removed (e.g. a line was deleted), however the
9853         rebase will still proceed. If set to "error", it will print
9854         the previous warning and stop the rebase, <em>git rebase
9855         --edit-todo</em> can then be used to correct the error. If set to
9856         "ignore", no checking is done.
9857         To drop a commit without warning or error, use the <code>drop</code>
9858         command in the todo list.
9859         Defaults to "ignore".
9860 </p>
9861 </dd>
9862 <dt class="hdlist1">
9863 rebase.instructionFormat
9864 </dt>
9865 <dd>
9866 <p>
9867         A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
9868         todo list during an interactive rebase.  The format will
9869         automatically have the commit hash prepended to the format.
9870 </p>
9871 </dd>
9872 <dt class="hdlist1">
9873 rebase.abbreviateCommands
9874 </dt>
9875 <dd>
9876 <p>
9877         If set to true, <code>git rebase</code> will use abbreviated command names in the
9878         todo list resulting in something like this:
9879 </p>
9880 <div class="listingblock">
9881 <div class="content">
9882 <pre><code>        p deadbee The oneline of the commit
9883         p fa1afe1 The oneline of the next commit
9884         ...</code></pre>
9885 </div></div>
9886 <div class="paragraph"><p>instead of:</p></div>
9887 <div class="listingblock">
9888 <div class="content">
9889 <pre><code>        pick deadbee The oneline of the commit
9890         pick fa1afe1 The oneline of the next commit
9891         ...</code></pre>
9892 </div></div>
9893 <div class="paragraph"><p>Defaults to false.</p></div>
9894 </dd>
9895 <dt class="hdlist1">
9896 rebase.rescheduleFailedExec
9897 </dt>
9898 <dd>
9899 <p>
9900         Automatically reschedule <code>exec</code> commands that failed. This only makes
9901         sense in interactive mode (or when an <code>--exec</code> option was provided).
9902         This is the same as specifying the <code>--reschedule-failed-exec</code> option.
9903 </p>
9904 </dd>
9905 <dt class="hdlist1">
9906 rebase.forkPoint
9907 </dt>
9908 <dd>
9909 <p>
9910         If set to false set <code>--no-fork-point</code> option by default.
9911 </p>
9912 </dd>
9913 <dt class="hdlist1">
9914 rebase.rebaseMerges
9915 </dt>
9916 <dd>
9917 <p>
9918         Whether and how to set the <code>--rebase-merges</code> option by default. Can
9919         be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
9920         true or to <code>no-rebase-cousins</code> is equivalent to
9921         <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
9922         equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
9923         equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
9924         command line, with or without an argument, overrides any
9925         <code>rebase.rebaseMerges</code> configuration.
9926 </p>
9927 </dd>
9928 <dt class="hdlist1">
9929 rebase.maxLabelLength
9930 </dt>
9931 <dd>
9932 <p>
9933         When generating label names from commit subjects, truncate the names to
9934         this length. By default, the names are truncated to a little less than
9935         <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
9936         corresponding loose refs).
9937 </p>
9938 </dd>
9939 <dt class="hdlist1">
9940 receive.advertiseAtomic
9941 </dt>
9942 <dd>
9943 <p>
9944         By default, git-receive-pack will advertise the atomic push
9945         capability to its clients. If you don&#8217;t want to advertise this
9946         capability, set this variable to false.
9947 </p>
9948 </dd>
9949 <dt class="hdlist1">
9950 receive.advertisePushOptions
9951 </dt>
9952 <dd>
9953 <p>
9954         When set to true, git-receive-pack will advertise the push options
9955         capability to its clients. False by default.
9956 </p>
9957 </dd>
9958 <dt class="hdlist1">
9959 receive.autogc
9960 </dt>
9961 <dd>
9962 <p>
9963         By default, git-receive-pack will run "git-gc --auto" after
9964         receiving data from git-push and updating refs.  You can stop
9965         it by setting this variable to false.
9966 </p>
9967 </dd>
9968 <dt class="hdlist1">
9969 receive.certNonceSeed
9970 </dt>
9971 <dd>
9972 <p>
9973         By setting this variable to a string, <code>git receive-pack</code>
9974         will accept a <code>git push --signed</code> and verify it by using
9975         a "nonce" protected by HMAC using this string as a secret
9976         key.
9977 </p>
9978 </dd>
9979 <dt class="hdlist1">
9980 receive.certNonceSlop
9981 </dt>
9982 <dd>
9983 <p>
9984         When a <code>git push --signed</code> sends a push certificate with a
9985         "nonce" that was issued by a receive-pack serving the same
9986         repository within this many seconds, export the "nonce"
9987         found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
9988         hooks (instead of what the receive-pack asked the sending
9989         side to include).  This may allow writing checks in
9990         <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
9991         checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
9992         that records by how many seconds the nonce is stale to
9993         decide if they want to accept the certificate, they only
9994         can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
9995 </p>
9996 </dd>
9997 <dt class="hdlist1">
9998 receive.fsckObjects
9999 </dt>
10000 <dd>
10001 <p>
10002         If it is set to true, git-receive-pack will check all received
10003         objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
10004         Defaults to false. If not set, the value of
10005         <code>transfer.fsckObjects</code> is used instead.
10006 </p>
10007 </dd>
10008 <dt class="hdlist1">
10009 receive.fsck.&lt;msg-id&gt;
10010 </dt>
10011 <dd>
10012 <p>
10013         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
10014         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
10015         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
10016         details.
10017 </p>
10018 </dd>
10019 <dt class="hdlist1">
10020 receive.fsck.skipList
10021 </dt>
10022 <dd>
10023 <p>
10024         Acts like <code>fsck.skipList</code>, but is used by
10025         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
10026         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
10027         details.
10028 </p>
10029 </dd>
10030 <dt class="hdlist1">
10031 receive.keepAlive
10032 </dt>
10033 <dd>
10034 <p>
10035         After receiving the pack from the client, <code>receive-pack</code> may
10036         produce no output (if <code>--quiet</code> was specified) while processing
10037         the pack, causing some networks to drop the TCP connection.
10038         With this option set, if <code>receive-pack</code> does not transmit
10039         any data in this phase for <code>receive.keepAlive</code> seconds, it will
10040         send a short keepalive packet.  The default is 5 seconds; set
10041         to 0 to disable keepalives entirely.
10042 </p>
10043 </dd>
10044 <dt class="hdlist1">
10045 receive.unpackLimit
10046 </dt>
10047 <dd>
10048 <p>
10049         If the number of objects received in a push is below this
10050         limit then the objects will be unpacked into loose object
10051         files. However if the number of received objects equals or
10052         exceeds this limit then the received pack will be stored as
10053         a pack, after adding any missing delta bases.  Storing the
10054         pack from a push can make the push operation complete faster,
10055         especially on slow filesystems.  If not set, the value of
10056         <code>transfer.unpackLimit</code> is used instead.
10057 </p>
10058 </dd>
10059 <dt class="hdlist1">
10060 receive.maxInputSize
10061 </dt>
10062 <dd>
10063 <p>
10064         If the size of the incoming pack stream is larger than this
10065         limit, then git-receive-pack will error out, instead of
10066         accepting the pack file. If not set or set to 0, then the size
10067         is unlimited.
10068 </p>
10069 </dd>
10070 <dt class="hdlist1">
10071 receive.denyDeletes
10072 </dt>
10073 <dd>
10074 <p>
10075         If set to true, git-receive-pack will deny a ref update that deletes
10076         the ref. Use this to prevent such a ref deletion via a push.
10077 </p>
10078 </dd>
10079 <dt class="hdlist1">
10080 receive.denyDeleteCurrent
10081 </dt>
10082 <dd>
10083 <p>
10084         If set to true, git-receive-pack will deny a ref update that
10085         deletes the currently checked out branch of a non-bare repository.
10086 </p>
10087 </dd>
10088 <dt class="hdlist1">
10089 receive.denyCurrentBranch
10090 </dt>
10091 <dd>
10092 <p>
10093         If set to true or "refuse", git-receive-pack will deny a ref update
10094         to the currently checked out branch of a non-bare repository.
10095         Such a push is potentially dangerous because it brings the HEAD
10096         out of sync with the index and working tree. If set to "warn",
10097         print a warning of such a push to stderr, but allow the push to
10098         proceed. If set to false or "ignore", allow such pushes with no
10099         message. Defaults to "refuse".
10100 </p>
10101 <div class="paragraph"><p>Another option is "updateInstead" which will update the working
10102 tree if pushing into the current branch.  This option is
10103 intended for synchronizing working directories when one side is not easily
10104 accessible via interactive ssh (e.g. a live web site, hence the requirement
10105 that the working directory be clean). This mode also comes in handy when
10106 developing inside a VM to test and fix code on different Operating Systems.</p></div>
10107 <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
10108 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
10109 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p></div>
10110 </dd>
10111 <dt class="hdlist1">
10112 receive.denyNonFastForwards
10113 </dt>
10114 <dd>
10115 <p>
10116         If set to true, git-receive-pack will deny a ref update which is
10117         not a fast-forward. Use this to prevent such an update via a push,
10118         even if that push is forced. This configuration variable is
10119         set when initializing a shared repository.
10120 </p>
10121 </dd>
10122 <dt class="hdlist1">
10123 receive.hideRefs
10124 </dt>
10125 <dd>
10126 <p>
10127         This variable is the same as <code>transfer.hideRefs</code>, but applies
10128         only to <code>receive-pack</code> (and so affects pushes, but not fetches).
10129         An attempt to update or delete a hidden ref by <code>git push</code> is
10130         rejected.
10131 </p>
10132 </dd>
10133 <dt class="hdlist1">
10134 receive.procReceiveRefs
10135 </dt>
10136 <dd>
10137 <p>
10138         This is a multi-valued variable that defines reference prefixes
10139         to match the commands in <code>receive-pack</code>.  Commands matching the
10140         prefixes will be executed by an external hook "proc-receive",
10141         instead of the internal <code>execute_commands</code> function.  If this
10142         variable is not defined, the "proc-receive" hook will never be
10143         used, and all commands will be executed by the internal
10144         <code>execute_commands</code> function.
10145 </p>
10146 <div class="paragraph"><p>For example, if this variable is set to "refs/for", pushing to reference
10147 such as "refs/for/master" will not create or update a reference named
10148 "refs/for/master", but may create or update a pull request directly by
10149 running the hook "proc-receive".</p></div>
10150 <div class="paragraph"><p>Optional modifiers can be provided in the beginning of the value to filter
10151 commands for specific actions: create (a), modify (m), delete (d).
10152 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
10153 E.g.:</p></div>
10154 <div class="literalblock">
10155 <div class="content">
10156 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
10157 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
10158 </div></div>
10159 </dd>
10160 <dt class="hdlist1">
10161 receive.updateServerInfo
10162 </dt>
10163 <dd>
10164 <p>
10165         If set to true, git-receive-pack will run git-update-server-info
10166         after receiving data from git-push and updating refs.
10167 </p>
10168 </dd>
10169 <dt class="hdlist1">
10170 receive.shallowUpdate
10171 </dt>
10172 <dd>
10173 <p>
10174         If set to true, .git/shallow can be updated when new refs
10175         require new shallow roots. Otherwise those refs are rejected.
10176 </p>
10177 </dd>
10178 <dt class="hdlist1">
10179 remote.pushDefault
10180 </dt>
10181 <dd>
10182 <p>
10183         The remote to push to by default.  Overrides
10184         <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
10185         <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
10186 </p>
10187 </dd>
10188 <dt class="hdlist1">
10189 remote.&lt;name&gt;.url
10190 </dt>
10191 <dd>
10192 <p>
10193         The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
10194         <a href="git-push.html">git-push(1)</a>.
10195 </p>
10196 </dd>
10197 <dt class="hdlist1">
10198 remote.&lt;name&gt;.pushurl
10199 </dt>
10200 <dd>
10201 <p>
10202         The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
10203 </p>
10204 </dd>
10205 <dt class="hdlist1">
10206 remote.&lt;name&gt;.proxy
10207 </dt>
10208 <dd>
10209 <p>
10210         For remotes that require curl (http, https and ftp), the URL to
10211         the proxy to use for that remote.  Set to the empty string to
10212         disable proxying for that remote.
10213 </p>
10214 </dd>
10215 <dt class="hdlist1">
10216 remote.&lt;name&gt;.proxyAuthMethod
10217 </dt>
10218 <dd>
10219 <p>
10220         For remotes that require curl (http, https and ftp), the method to use for
10221         authenticating against the proxy in use (probably set in
10222         <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
10223 </p>
10224 </dd>
10225 <dt class="hdlist1">
10226 remote.&lt;name&gt;.fetch
10227 </dt>
10228 <dd>
10229 <p>
10230         The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
10231         <a href="git-fetch.html">git-fetch(1)</a>.
10232 </p>
10233 </dd>
10234 <dt class="hdlist1">
10235 remote.&lt;name&gt;.push
10236 </dt>
10237 <dd>
10238 <p>
10239         The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
10240         <a href="git-push.html">git-push(1)</a>.
10241 </p>
10242 </dd>
10243 <dt class="hdlist1">
10244 remote.&lt;name&gt;.mirror
10245 </dt>
10246 <dd>
10247 <p>
10248         If true, pushing to this remote will automatically behave
10249         as if the <code>--mirror</code> option was given on the command line.
10250 </p>
10251 </dd>
10252 <dt class="hdlist1">
10253 remote.&lt;name&gt;.skipDefaultUpdate
10254 </dt>
10255 <dd>
10256 <p>
10257         If true, this remote will be skipped by default when updating
10258         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10259         <a href="git-remote.html">git-remote(1)</a>.
10260 </p>
10261 </dd>
10262 <dt class="hdlist1">
10263 remote.&lt;name&gt;.skipFetchAll
10264 </dt>
10265 <dd>
10266 <p>
10267         If true, this remote will be skipped by default when updating
10268         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10269         <a href="git-remote.html">git-remote(1)</a>.
10270 </p>
10271 </dd>
10272 <dt class="hdlist1">
10273 remote.&lt;name&gt;.receivepack
10274 </dt>
10275 <dd>
10276 <p>
10277         The default program to execute on the remote side when pushing.  See
10278         option --receive-pack of <a href="git-push.html">git-push(1)</a>.
10279 </p>
10280 </dd>
10281 <dt class="hdlist1">
10282 remote.&lt;name&gt;.uploadpack
10283 </dt>
10284 <dd>
10285 <p>
10286         The default program to execute on the remote side when fetching.  See
10287         option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
10288 </p>
10289 </dd>
10290 <dt class="hdlist1">
10291 remote.&lt;name&gt;.tagOpt
10292 </dt>
10293 <dd>
10294 <p>
10295         Setting this value to --no-tags disables automatic tag following when
10296         fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
10297         tag from remote &lt;name&gt;, even if they are not reachable from remote
10298         branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
10299         override this setting. See options --tags and --no-tags of
10300         <a href="git-fetch.html">git-fetch(1)</a>.
10301 </p>
10302 </dd>
10303 <dt class="hdlist1">
10304 remote.&lt;name&gt;.vcs
10305 </dt>
10306 <dd>
10307 <p>
10308         Setting this to a value &lt;vcs&gt; will cause Git to interact with
10309         the remote with the git-remote-&lt;vcs&gt; helper.
10310 </p>
10311 </dd>
10312 <dt class="hdlist1">
10313 remote.&lt;name&gt;.prune
10314 </dt>
10315 <dd>
10316 <p>
10317         When set to true, fetching from this remote by default will also
10318         remove any remote-tracking references that no longer exist on the
10319         remote (as if the <code>--prune</code> option was given on the command line).
10320         Overrides <code>fetch.prune</code> settings, if any.
10321 </p>
10322 </dd>
10323 <dt class="hdlist1">
10324 remote.&lt;name&gt;.pruneTags
10325 </dt>
10326 <dd>
10327 <p>
10328         When set to true, fetching from this remote by default will also
10329         remove any local tags that no longer exist on the remote if pruning
10330         is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
10331         <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10332 </p>
10333 <div class="paragraph"><p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
10334 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
10335 </dd>
10336 <dt class="hdlist1">
10337 remote.&lt;name&gt;.promisor
10338 </dt>
10339 <dd>
10340 <p>
10341         When set to true, this remote will be used to fetch promisor
10342         objects.
10343 </p>
10344 </dd>
10345 <dt class="hdlist1">
10346 remote.&lt;name&gt;.partialclonefilter
10347 </dt>
10348 <dd>
10349 <p>
10350         The filter that will be applied when fetching from this promisor remote.
10351         Changing or clearing this value will only affect fetches for new commits.
10352         To fetch associated objects for commits already present in the local object
10353         database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.
10354 </p>
10355 </dd>
10356 <dt class="hdlist1">
10357 remotes.&lt;group&gt;
10358 </dt>
10359 <dd>
10360 <p>
10361         The list of remotes which are fetched by "git remote update
10362         &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.
10363 </p>
10364 </dd>
10365 <dt class="hdlist1">
10366 repack.useDeltaBaseOffset
10367 </dt>
10368 <dd>
10369 <p>
10370         By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
10371         delta-base offset. If you need to share your repository with
10372         Git older than version 1.4.4, either directly or via a dumb
10373         protocol such as http, then you need to set this option to
10374         "false" and repack. Access from old Git versions over the
10375         native protocol are unaffected by this option.
10376 </p>
10377 </dd>
10378 <dt class="hdlist1">
10379 repack.packKeptObjects
10380 </dt>
10381 <dd>
10382 <p>
10383         If set to true, makes <code>git repack</code> act as if
10384         <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
10385         details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10386         index is being written (either via <code>--write-bitmap-index</code> or
10387         <code>repack.writeBitmaps</code>).
10388 </p>
10389 </dd>
10390 <dt class="hdlist1">
10391 repack.useDeltaIslands
10392 </dt>
10393 <dd>
10394 <p>
10395         If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10396         was passed. Defaults to <code>false</code>.
10397 </p>
10398 </dd>
10399 <dt class="hdlist1">
10400 repack.writeBitmaps
10401 </dt>
10402 <dd>
10403 <p>
10404         When true, git will write a bitmap index when packing all
10405         objects to disk (e.g., when <code>git repack -a</code> is run).  This
10406         index can speed up the "counting objects" phase of subsequent
10407         packs created for clones and fetches, at the cost of some disk
10408         space and extra time spent on the initial repack.  This has
10409         no effect if multiple packfiles are created.
10410         Defaults to true on bare repos, false otherwise.
10411 </p>
10412 </dd>
10413 <dt class="hdlist1">
10414 repack.updateServerInfo
10415 </dt>
10416 <dd>
10417 <p>
10418         If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
10419         <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10420         when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.
10421 </p>
10422 </dd>
10423 <dt class="hdlist1">
10424 repack.cruftWindow
10425 </dt>
10426 <dt class="hdlist1">
10427 repack.cruftWindowMemory
10428 </dt>
10429 <dt class="hdlist1">
10430 repack.cruftDepth
10431 </dt>
10432 <dt class="hdlist1">
10433 repack.cruftThreads
10434 </dt>
10435 <dd>
10436 <p>
10437         Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
10438         a cruft pack and the respective parameters are not given over
10439         the command line. See similarly named <code>pack.*</code> configuration
10440         variables for defaults and meaning.
10441 </p>
10442 </dd>
10443 <dt class="hdlist1">
10444 rerere.autoUpdate
10445 </dt>
10446 <dd>
10447 <p>
10448         When set to true, <code>git-rerere</code> updates the index with the
10449         resulting contents after it cleanly resolves conflicts using
10450         previously recorded resolutions.  Defaults to false.
10451 </p>
10452 </dd>
10453 <dt class="hdlist1">
10454 rerere.enabled
10455 </dt>
10456 <dd>
10457 <p>
10458         Activate recording of resolved conflicts, so that identical
10459         conflict hunks can be resolved automatically, should they be
10460         encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
10461         enabled if there is an <code>rr-cache</code> directory under the
10462         <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
10463         repository.
10464 </p>
10465 </dd>
10466 <dt class="hdlist1">
10467 revert.reference
10468 </dt>
10469 <dd>
10470 <p>
10471         Setting this variable to true makes <code>git revert</code> behave
10472         as if the <code>--reference</code> option is given.
10473 </p>
10474 </dd>
10475 <dt class="hdlist1">
10476 safe.bareRepository
10477 </dt>
10478 <dd>
10479 <p>
10480         Specifies which bare repositories Git will work with. The currently
10481         supported values are:
10482 </p>
10483 <div class="ulist"><ul>
10484 <li>
10485 <p>
10486 <code>all</code>: Git works with all bare repositories. This is the default.
10487 </p>
10488 </li>
10489 <li>
10490 <p>
10491 <code>explicit</code>: Git only works with bare repositories specified via
10492   the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10493   environment variable (see <a href="git.html">git(1)</a>).
10494 </p>
10495 <div class="paragraph"><p>If you do not use bare repositories in your workflow, then it may be
10496 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10497 config. This will protect you from attacks that involve cloning a
10498 repository that contains a bare repository and running a Git command
10499 within that directory.</p></div>
10500 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10501 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with
10502 this value.</p></div>
10503 </li>
10504 </ul></div>
10505 </dd>
10506 <dt class="hdlist1">
10507 safe.directory
10508 </dt>
10509 <dd>
10510 <p>
10511         These config entries specify Git-tracked directories that are
10512         considered safe even if they are owned by someone other than the
10513         current user. By default, Git will refuse to even parse a Git
10514         config of a repository owned by someone else, let alone run its
10515         hooks, and this config setting allows users to specify exceptions,
10516         e.g. for intentionally shared repositories (see the <code>--shared</code>
10517         option in <a href="git-init.html">git-init(1)</a>).
10518 </p>
10519 <div class="paragraph"><p>This is a multi-valued setting, i.e. you can add more than one directory
10520 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10521 override any such directories specified in the system config), add a
10522 <code>safe.directory</code> entry with an empty value.</p></div>
10523 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10524 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with this
10525 value.</p></div>
10526 <div class="paragraph"><p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
10527 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
10528 path relative to Git&#8217;s (runtime) prefix.</p></div>
10529 <div class="paragraph"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10530 string <code>*</code>. This will allow all repositories to be treated as if their
10531 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10532 is set in system config and you want to re-enable this protection, then
10533 initialize your list with an empty value before listing the repositories
10534 that you deem safe.</p></div>
10535 <div class="paragraph"><p>As explained, Git only allows you to access repositories owned by
10536 yourself, i.e. the user who is running Git, by default.  When Git
10537 is running as <em>root</em> in a non Windows platform that provides sudo,
10538 however, git checks the SUDO_UID environment variable that sudo creates
10539 and will allow access to the uid recorded as its value in addition to
10540 the id from <em>root</em>.
10541 This is to make it easy to perform a common sequence during installation
10542 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
10543 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
10544 which id the original user has.
10545 If that is not what you would prefer and want git to only trust
10546 repositories that are owned by root instead, then you can remove
10547 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p></div>
10548 </dd>
10549 <dt class="hdlist1">
10550 sendemail.identity
10551 </dt>
10552 <dd>
10553 <p>
10554         A configuration identity. When given, causes values in the
10555         <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
10556         values in the <em>sendemail</em> section. The default identity is
10557         the value of <code>sendemail.identity</code>.
10558 </p>
10559 </dd>
10560 <dt class="hdlist1">
10561 sendemail.smtpEncryption
10562 </dt>
10563 <dd>
10564 <p>
10565         See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
10566         setting is not subject to the <em>identity</em> mechanism.
10567 </p>
10568 </dd>
10569 <dt class="hdlist1">
10570 sendemail.smtpSSLCertPath
10571 </dt>
10572 <dd>
10573 <p>
10574         Path to ca-certificates (either a directory or a single file).
10575         Set it to an empty string to disable certificate verification.
10576 </p>
10577 </dd>
10578 <dt class="hdlist1">
10579 sendemail.&lt;identity&gt;.*
10580 </dt>
10581 <dd>
10582 <p>
10583         Identity-specific versions of the <em>sendemail.*</em> parameters
10584         found below, taking precedence over those when this
10585         identity is selected, through either the command-line or
10586         <code>sendemail.identity</code>.
10587 </p>
10588 </dd>
10589 <dt class="hdlist1">
10590 sendemail.multiEdit
10591 </dt>
10592 <dd>
10593 <p>
10594         If true (default), a single editor instance will be spawned to edit
10595         files you have to edit (patches when <code>--annotate</code> is used, and the
10596         summary when <code>--compose</code> is used). If false, files will be edited one
10597         after the other, spawning a new editor each time.
10598 </p>
10599 </dd>
10600 <dt class="hdlist1">
10601 sendemail.confirm
10602 </dt>
10603 <dd>
10604 <p>
10605         Sets the default for whether to confirm before sending. Must be
10606         one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
10607         in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
10608         values.
10609 </p>
10610 </dd>
10611 <dt class="hdlist1">
10612 sendemail.aliasesFile
10613 </dt>
10614 <dd>
10615 <p>
10616         To avoid typing long email addresses, point this to one or more
10617         email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.
10618 </p>
10619 </dd>
10620 <dt class="hdlist1">
10621 sendemail.aliasFileType
10622 </dt>
10623 <dd>
10624 <p>
10625         Format of the file(s) specified in sendemail.aliasesFile. Must be
10626         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.
10627 </p>
10628 <div class="paragraph"><p>What an alias file in each format looks like can be found in
10629 the documentation of the email program of the same name. The
10630 differences and limitations from the standard formats are
10631 described below:</p></div>
10632 <div class="openblock">
10633 <div class="content">
10634 <div class="dlist"><dl>
10635 <dt class="hdlist1">
10636 sendmail
10637 </dt>
10638 <dd>
10639 <div class="ulist"><ul>
10640 <li>
10641 <p>
10642 Quoted aliases and quoted addresses are not supported: lines that
10643         contain a <code>"</code> symbol are ignored.
10644 </p>
10645 </li>
10646 <li>
10647 <p>
10648 Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
10649         supported.
10650 </p>
10651 </li>
10652 <li>
10653 <p>
10654 File inclusion (<code>:include: /path/name</code>) is not supported.
10655 </p>
10656 </li>
10657 <li>
10658 <p>
10659 Warnings are printed on the standard error output for any
10660         explicitly unsupported constructs, and any other lines that are not
10661         recognized by the parser.
10662 </p>
10663 </li>
10664 </ul></div>
10665 </dd>
10666 </dl></div>
10667 </div></div>
10668 </dd>
10669 <dt class="hdlist1">
10670 sendemail.annotate
10671 </dt>
10672 <dt class="hdlist1">
10673 sendemail.bcc
10674 </dt>
10675 <dt class="hdlist1">
10676 sendemail.cc
10677 </dt>
10678 <dt class="hdlist1">
10679 sendemail.ccCmd
10680 </dt>
10681 <dt class="hdlist1">
10682 sendemail.chainReplyTo
10683 </dt>
10684 <dt class="hdlist1">
10685 sendemail.envelopeSender
10686 </dt>
10687 <dt class="hdlist1">
10688 sendemail.from
10689 </dt>
10690 <dt class="hdlist1">
10691 sendemail.headerCmd
10692 </dt>
10693 <dt class="hdlist1">
10694 sendemail.signedOffByCc
10695 </dt>
10696 <dt class="hdlist1">
10697 sendemail.smtpPass
10698 </dt>
10699 <dt class="hdlist1">
10700 sendemail.suppressCc
10701 </dt>
10702 <dt class="hdlist1">
10703 sendemail.suppressFrom
10704 </dt>
10705 <dt class="hdlist1">
10706 sendemail.to
10707 </dt>
10708 <dt class="hdlist1">
10709 sendemail.toCmd
10710 </dt>
10711 <dt class="hdlist1">
10712 sendemail.smtpDomain
10713 </dt>
10714 <dt class="hdlist1">
10715 sendemail.smtpServer
10716 </dt>
10717 <dt class="hdlist1">
10718 sendemail.smtpServerPort
10719 </dt>
10720 <dt class="hdlist1">
10721 sendemail.smtpServerOption
10722 </dt>
10723 <dt class="hdlist1">
10724 sendemail.smtpUser
10725 </dt>
10726 <dt class="hdlist1">
10727 sendemail.thread
10728 </dt>
10729 <dt class="hdlist1">
10730 sendemail.transferEncoding
10731 </dt>
10732 <dt class="hdlist1">
10733 sendemail.validate
10734 </dt>
10735 <dt class="hdlist1">
10736 sendemail.xmailer
10737 </dt>
10738 <dd>
10739 <p>
10740         These configuration variables all provide a default for
10741         <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
10742         documentation for details.
10743 </p>
10744 </dd>
10745 <dt class="hdlist1">
10746 sendemail.signedOffCc (deprecated)
10747 </dt>
10748 <dd>
10749 <p>
10750         Deprecated alias for <code>sendemail.signedOffByCc</code>.
10751 </p>
10752 </dd>
10753 <dt class="hdlist1">
10754 sendemail.smtpBatchSize
10755 </dt>
10756 <dd>
10757 <p>
10758         Number of messages to be sent per connection, after that a relogin
10759         will happen.  If the value is 0 or undefined, send all messages in
10760         one connection.
10761         See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10762 </p>
10763 </dd>
10764 <dt class="hdlist1">
10765 sendemail.smtpReloginDelay
10766 </dt>
10767 <dd>
10768 <p>
10769         Seconds to wait before reconnecting to the smtp server.
10770         See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10771 </p>
10772 </dd>
10773 <dt class="hdlist1">
10774 sendemail.forbidSendmailVariables
10775 </dt>
10776 <dd>
10777 <p>
10778         To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
10779         will abort with a warning if any configuration options for "sendmail"
10780         exist. Set this variable to bypass the check.
10781 </p>
10782 </dd>
10783 <dt class="hdlist1">
10784 sequence.editor
10785 </dt>
10786 <dd>
10787 <p>
10788         Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
10789         The value is meant to be interpreted by the shell when it is used.
10790         It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
10791         When not configured, the default commit message editor is used instead.
10792 </p>
10793 </dd>
10794 <dt class="hdlist1">
10795 showBranch.default
10796 </dt>
10797 <dd>
10798 <p>
10799         The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
10800         See <a href="git-show-branch.html">git-show-branch(1)</a>.
10801 </p>
10802 </dd>
10803 <dt class="hdlist1">
10804 sparse.expectFilesOutsideOfPatterns
10805 </dt>
10806 <dd>
10807 <p>
10808         Typically with sparse checkouts, files not matching any
10809         sparsity patterns are marked with a SKIP_WORKTREE bit in the
10810         index and are missing from the working tree.  Accordingly, Git
10811         will ordinarily check whether files with the SKIP_WORKTREE bit
10812         are in fact present in the working tree contrary to
10813         expectations.  If Git finds any, it marks those paths as
10814         present by clearing the relevant SKIP_WORKTREE bits.  This
10815         option can be used to tell Git that such
10816         present-despite-skipped files are expected and to stop
10817         checking for them.
10818 </p>
10819 <div class="paragraph"><p>The default is <code>false</code>, which allows Git to automatically recover
10820 from the list of files in the index and working tree falling out of
10821 sync.</p></div>
10822 <div class="paragraph"><p>Set this to <code>true</code> if you are in a setup where some external factor
10823 relieves Git of the responsibility for maintaining the consistency
10824 between the presence of working tree files and sparsity patterns.  For
10825 example, if you have a Git-aware virtual file system that has a robust
10826 mechanism for keeping the working tree and the sparsity patterns up to
10827 date based on access patterns.</p></div>
10828 <div class="paragraph"><p>Regardless of this setting, Git does not check for
10829 present-despite-skipped files unless sparse checkout is enabled, so
10830 this config option has no effect unless <code>core.sparseCheckout</code> is
10831 <code>true</code>.</p></div>
10832 </dd>
10833 <dt class="hdlist1">
10834 splitIndex.maxPercentChange
10835 </dt>
10836 <dd>
10837 <p>
10838         When the split index feature is used, this specifies the
10839         percent of entries the split index can contain compared to the
10840         total number of entries in both the split index and the shared
10841         index before a new shared index is written.
10842         The value should be between 0 and 100. If the value is 0, then
10843         a new shared index is always written; if it is 100, a new
10844         shared index is never written.
10845         By default, the value is 20, so a new shared index is written
10846         if the number of entries in the split index would be greater
10847         than 20 percent of the total number of entries.
10848         See <a href="git-update-index.html">git-update-index(1)</a>.
10849 </p>
10850 </dd>
10851 <dt class="hdlist1">
10852 splitIndex.sharedIndexExpire
10853 </dt>
10854 <dd>
10855 <p>
10856         When the split index feature is used, shared index files that
10857         were not modified since the time this variable specifies will
10858         be removed when a new shared index file is created. The value
10859         "now" expires all entries immediately, and "never" suppresses
10860         expiration altogether.
10861         The default value is "2.weeks.ago".
10862         Note that a shared index file is considered modified (for the
10863         purpose of expiration) each time a new split-index file is
10864         either created based on it or read from it.
10865         See <a href="git-update-index.html">git-update-index(1)</a>.
10866 </p>
10867 </dd>
10868 <dt class="hdlist1">
10869 ssh.variant
10870 </dt>
10871 <dd>
10872 <p>
10873         By default, Git determines the command line arguments to use
10874         based on the basename of the configured SSH command (configured
10875         using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
10876         the config setting <code>core.sshCommand</code>). If the basename is
10877         unrecognized, Git will attempt to detect support of OpenSSH
10878         options by first invoking the configured SSH command with the
10879         <code>-G</code> (print configuration) option and will subsequently use
10880         OpenSSH options (if that is successful) or no options besides
10881         the host and remote command (if it fails).
10882 </p>
10883 <div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this detection.
10884 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
10885 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
10886 The default auto-detection can be explicitly requested using the value
10887 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
10888 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
10889 <div class="paragraph"><p>The current command-line parameters used for each variant are as
10890 follows:</p></div>
10891 <div class="openblock">
10892 <div class="content">
10893 <div class="ulist"><ul>
10894 <li>
10895 <p>
10896 <code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command
10897 </p>
10898 </li>
10899 <li>
10900 <p>
10901 <code>simple</code> - [username@]host command
10902 </p>
10903 </li>
10904 <li>
10905 <p>
10906 <code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command
10907 </p>
10908 </li>
10909 <li>
10910 <p>
10911 <code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command
10912 </p>
10913 </li>
10914 </ul></div>
10915 </div></div>
10916 <div class="paragraph"><p>Except for the <code>simple</code> variant, command-line parameters are likely to
10917 change as git gains new features.</p></div>
10918 </dd>
10919 <dt class="hdlist1">
10920 stash.showIncludeUntracked
10921 </dt>
10922 <dd>
10923 <p>
10924         If this is set to true, the <code>git stash show</code> command will show
10925         the untracked files of a stash entry.  Defaults to false. See
10926         the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10927 </p>
10928 </dd>
10929 <dt class="hdlist1">
10930 stash.showPatch
10931 </dt>
10932 <dd>
10933 <p>
10934         If this is set to true, the <code>git stash show</code> command without an
10935         option will show the stash entry in patch form.  Defaults to false.
10936         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10937 </p>
10938 </dd>
10939 <dt class="hdlist1">
10940 stash.showStat
10941 </dt>
10942 <dd>
10943 <p>
10944         If this is set to true, the <code>git stash show</code> command without an
10945         option will show a diffstat of the stash entry.  Defaults to true.
10946         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10947 </p>
10948 </dd>
10949 <dt class="hdlist1">
10950 status.relativePaths
10951 </dt>
10952 <dd>
10953 <p>
10954         By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
10955         current directory. Setting this variable to <code>false</code> shows paths
10956         relative to the repository root (this was the default for Git
10957         prior to v1.5.4).
10958 </p>
10959 </dd>
10960 <dt class="hdlist1">
10961 status.short
10962 </dt>
10963 <dd>
10964 <p>
10965         Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
10966         The option --no-short takes precedence over this variable.
10967 </p>
10968 </dd>
10969 <dt class="hdlist1">
10970 status.branch
10971 </dt>
10972 <dd>
10973 <p>
10974         Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
10975         The option --no-branch takes precedence over this variable.
10976 </p>
10977 </dd>
10978 <dt class="hdlist1">
10979 status.aheadBehind
10980 </dt>
10981 <dd>
10982 <p>
10983         Set to true to enable <code>--ahead-behind</code> and false to enable
10984         <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
10985         non-porcelain status formats.  Defaults to true.
10986 </p>
10987 </dd>
10988 <dt class="hdlist1">
10989 status.displayCommentPrefix
10990 </dt>
10991 <dd>
10992 <p>
10993         If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
10994         prefix before each output line (starting with
10995         <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
10996         behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
10997         Defaults to false.
10998 </p>
10999 </dd>
11000 <dt class="hdlist1">
11001 status.renameLimit
11002 </dt>
11003 <dd>
11004 <p>
11005         The number of files to consider when performing rename detection
11006         in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
11007         the value of diff.renameLimit.
11008 </p>
11009 </dd>
11010 <dt class="hdlist1">
11011 status.renames
11012 </dt>
11013 <dd>
11014 <p>
11015         Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
11016         <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
11017         disabled. If set to "true", basic rename detection is enabled.
11018         If set to "copies" or "copy", Git will detect copies, as well.
11019         Defaults to the value of diff.renames.
11020 </p>
11021 </dd>
11022 <dt class="hdlist1">
11023 status.showStash
11024 </dt>
11025 <dd>
11026 <p>
11027         If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
11028         entries currently stashed away.
11029         Defaults to false.
11030 </p>
11031 </dd>
11032 <dt class="hdlist1">
11033 status.showUntrackedFiles
11034 </dt>
11035 <dd>
11036 <p>
11037         By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
11038         files which are not currently tracked by Git. Directories which
11039         contain only untracked files, are shown with the directory name
11040         only. Showing untracked files means that Git needs to lstat() all
11041         the files in the whole repository, which might be slow on some
11042         systems. So, this variable controls how the commands display
11043         the untracked files. Possible values are:
11044 </p>
11045 <div class="openblock">
11046 <div class="content">
11047 <div class="ulist"><ul>
11048 <li>
11049 <p>
11050 <code>no</code> - Show no untracked files.
11051 </p>
11052 </li>
11053 <li>
11054 <p>
11055 <code>normal</code> - Show untracked files and directories.
11056 </p>
11057 </li>
11058 <li>
11059 <p>
11060 <code>all</code> - Show also individual files in untracked directories.
11061 </p>
11062 </li>
11063 </ul></div>
11064 </div></div>
11065 <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
11066 All usual spellings for Boolean value <code>true</code> are taken as <code>normal</code>
11067 and <code>false</code> as <code>no</code>.
11068 This variable can be overridden with the -u|--untracked-files option
11069 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
11070 </dd>
11071 <dt class="hdlist1">
11072 status.submoduleSummary
11073 </dt>
11074 <dd>
11075 <p>
11076         Defaults to false.
11077         If this is set to a non-zero number or true (identical to -1 or an
11078         unlimited number), the submodule summary will be enabled and a
11079         summary of commits for modified submodules will be shown (see
11080         --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
11081         that the summary output command will be suppressed for all
11082         submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
11083         for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
11084         exception to that rule is that status and commit will show staged
11085         submodule changes. To
11086         also view the summary for ignored submodules you can either use
11087         the --ignore-submodules=dirty command-line option or the <em>git
11088         submodule summary</em> command, which shows a similar output but does
11089         not honor these settings.
11090 </p>
11091 </dd>
11092 <dt class="hdlist1">
11093 submodule.&lt;name&gt;.url
11094 </dt>
11095 <dd>
11096 <p>
11097         The URL for a submodule. This variable is copied from the .gitmodules
11098         file to the git config via <em>git submodule init</em>. The user can change
11099         the configured URL before obtaining the submodule via <em>git submodule
11100         update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
11101         set, the presence of this variable is used as a fallback to indicate
11102         whether the submodule is of interest to git commands.
11103         See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
11104 </p>
11105 </dd>
11106 <dt class="hdlist1">
11107 submodule.&lt;name&gt;.update
11108 </dt>
11109 <dd>
11110 <p>
11111         The method by which a submodule is updated by <em>git submodule update</em>,
11112         which is the only affected command, others such as
11113         <em>git checkout --recurse-submodules</em> are unaffected. It exists for
11114         historical reasons, when <em>git submodule</em> was the only command to
11115         interact with submodules; settings like <code>submodule.active</code>
11116         and <code>pull.rebase</code> are more specific. It is populated by
11117         <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
11118         See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.
11119 </p>
11120 </dd>
11121 <dt class="hdlist1">
11122 submodule.&lt;name&gt;.branch
11123 </dt>
11124 <dd>
11125 <p>
11126         The remote branch name for a submodule, used by <code>git submodule
11127         update --remote</code>.  Set this option to override the value found in
11128         the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
11129         <a href="gitmodules.html">gitmodules(5)</a> for details.
11130 </p>
11131 </dd>
11132 <dt class="hdlist1">
11133 submodule.&lt;name&gt;.fetchRecurseSubmodules
11134 </dt>
11135 <dd>
11136 <p>
11137         This option can be used to control recursive fetching of this
11138         submodule. It can be overridden by using the --[no-]recurse-submodules
11139         command-line option to "git fetch" and "git pull".
11140         This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
11141         file.
11142 </p>
11143 </dd>
11144 <dt class="hdlist1">
11145 submodule.&lt;name&gt;.ignore
11146 </dt>
11147 <dd>
11148 <p>
11149         Defines under what circumstances "git status" and the diff family show
11150         a submodule as modified. When set to "all", it will never be considered
11151         modified (but it will nonetheless show up in the output of status and
11152         commit when it has been staged), "dirty" will ignore all changes
11153         to the submodule&#8217;s work tree and
11154         takes only differences between the HEAD of the submodule and the commit
11155         recorded in the superproject into account. "untracked" will additionally
11156         let submodules with modified tracked files in their work tree show up.
11157         Using "none" (the default when this option is not set) also shows
11158         submodules that have untracked files in their work tree as changed.
11159         This setting overrides any setting made in .gitmodules for this submodule,
11160         both settings can be overridden on the command line by using the
11161         "--ignore-submodules" option. The <em>git submodule</em> commands are not
11162         affected by this setting.
11163 </p>
11164 </dd>
11165 <dt class="hdlist1">
11166 submodule.&lt;name&gt;.active
11167 </dt>
11168 <dd>
11169 <p>
11170         Boolean value indicating if the submodule is of interest to git
11171         commands.  This config option takes precedence over the
11172         submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
11173         details.
11174 </p>
11175 </dd>
11176 <dt class="hdlist1">
11177 submodule.active
11178 </dt>
11179 <dd>
11180 <p>
11181         A repeated field which contains a pathspec used to match against a
11182         submodule&#8217;s path to determine if the submodule is of interest to git
11183         commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.
11184 </p>
11185 </dd>
11186 <dt class="hdlist1">
11187 submodule.recurse
11188 </dt>
11189 <dd>
11190 <p>
11191         A boolean indicating if commands should enable the <code>--recurse-submodules</code>
11192         option by default. Defaults to false.
11193 </p>
11194 <div class="paragraph"><p>When set to true, it can be deactivated via the
11195 <code>--no-recurse-submodules</code> option. Note that some Git commands
11196 lacking this option may call some of the above commands affected by
11197 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
11198 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
11199 For these commands a workaround is to temporarily change the
11200 configuration value by using <code>git -c submodule.recurse=0</code>.</p></div>
11201 <div class="paragraph"><p>The following list shows the commands that accept
11202 <code>--recurse-submodules</code> and whether they are supported by this
11203 setting.</p></div>
11204 <div class="ulist"><ul>
11205 <li>
11206 <p>
11207 <code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
11208 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.
11209 </p>
11210 </li>
11211 <li>
11212 <p>
11213 <code>clone</code> and <code>ls-files</code> are not supported.
11214 </p>
11215 </li>
11216 <li>
11217 <p>
11218 <code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
11219 enabled
11220 </p>
11221 </li>
11222 </ul></div>
11223 </dd>
11224 <dt class="hdlist1">
11225 submodule.propagateBranches
11226 </dt>
11227 <dd>
11228 <p>
11229         [EXPERIMENTAL] A boolean that enables branching support when
11230         using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
11231         Enabling this will allow certain commands to accept
11232         <code>--recurse-submodules</code> and certain commands that already accept
11233         <code>--recurse-submodules</code> will now consider branches.
11234         Defaults to false.
11235 </p>
11236 </dd>
11237 <dt class="hdlist1">
11238 submodule.fetchJobs
11239 </dt>
11240 <dd>
11241 <p>
11242         Specifies how many submodules are fetched/cloned at the same time.
11243         A positive integer allows up to that number of submodules fetched
11244         in parallel. A value of 0 will give some reasonable default.
11245         If unset, it defaults to 1.
11246 </p>
11247 </dd>
11248 <dt class="hdlist1">
11249 submodule.alternateLocation
11250 </dt>
11251 <dd>
11252 <p>
11253         Specifies how the submodules obtain alternates when submodules are
11254         cloned. Possible values are <code>no</code>, <code>superproject</code>.
11255         By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
11256         value is set to <code>superproject</code> the submodule to be cloned computes
11257         its alternates location relative to the superprojects alternate.
11258 </p>
11259 </dd>
11260 <dt class="hdlist1">
11261 submodule.alternateErrorStrategy
11262 </dt>
11263 <dd>
11264 <p>
11265         Specifies how to treat errors with the alternates for a submodule
11266         as computed via <code>submodule.alternateLocation</code>. Possible values are
11267         <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
11268         or <code>info</code>, and if there is an error with the computed alternate, the
11269         clone proceeds as if no alternate was specified.
11270 </p>
11271 </dd>
11272 <dt class="hdlist1">
11273 tag.forceSignAnnotated
11274 </dt>
11275 <dd>
11276 <p>
11277         A boolean to specify whether annotated tags created should be GPG signed.
11278         If <code>--annotate</code> is specified on the command line, it takes
11279         precedence over this option.
11280 </p>
11281 </dd>
11282 <dt class="hdlist1">
11283 tag.sort
11284 </dt>
11285 <dd>
11286 <p>
11287         This variable controls the sort ordering of tags when displayed by
11288         <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
11289         value of this variable will be used as the default.
11290 </p>
11291 </dd>
11292 <dt class="hdlist1">
11293 tag.gpgSign
11294 </dt>
11295 <dd>
11296 <p>
11297         A boolean to specify whether all tags should be GPG signed.
11298         Use of this option when running in an automated script can
11299         result in a large number of tags being signed. It is therefore
11300         convenient to use an agent to avoid typing your gpg passphrase
11301         several times. Note that this option doesn&#8217;t affect tag signing
11302         behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.
11303 </p>
11304 </dd>
11305 <dt class="hdlist1">
11306 tar.umask
11307 </dt>
11308 <dd>
11309 <p>
11310         This variable can be used to restrict the permission bits of
11311         tar archive entries.  The default is 0002, which turns off the
11312         world write bit.  The special value "user" indicates that the
11313         archiving user&#8217;s umask will be used instead.  See umask(2) and
11314         <a href="git-archive.html">git-archive(1)</a>.
11315 </p>
11316 </dd>
11317 </dl></div>
11318 <div class="paragraph"><p>Trace2 config settings are only read from the system and global
11319 config files; repository local and worktree config files and <code>-c</code>
11320 command line arguments are not respected.</p></div>
11321 <div class="dlist"><dl>
11322 <dt class="hdlist1">
11323 trace2.normalTarget
11324 </dt>
11325 <dd>
11326 <p>
11327         This variable controls the normal target destination.
11328         It may be overridden by the <code>GIT_TRACE2</code> environment variable.
11329         The following table shows possible values.
11330 </p>
11331 </dd>
11332 <dt class="hdlist1">
11333 trace2.perfTarget
11334 </dt>
11335 <dd>
11336 <p>
11337         This variable controls the performance target destination.
11338         It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
11339         The following table shows possible values.
11340 </p>
11341 </dd>
11342 <dt class="hdlist1">
11343 trace2.eventTarget
11344 </dt>
11345 <dd>
11346 <p>
11347         This variable controls the event target destination.
11348         It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
11349         The following table shows possible values.
11350 </p>
11351 <div class="openblock">
11352 <div class="content">
11353 <div class="ulist"><ul>
11354 <li>
11355 <p>
11356 <code>0</code> or <code>false</code> - Disables the target.
11357 </p>
11358 </li>
11359 <li>
11360 <p>
11361 <code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.
11362 </p>
11363 </li>
11364 <li>
11365 <p>
11366 <code>[2-9]</code> - Writes to the already opened file descriptor.
11367 </p>
11368 </li>
11369 <li>
11370 <p>
11371 <code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
11372 already exists and is a directory, the traces will be written to files (one
11373 per process) underneath the given directory.
11374 </p>
11375 </li>
11376 <li>
11377 <p>
11378 <code>af_unix:[&lt;socket-type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
11379 Unix DomainSocket (on platforms that support them).  Socket
11380 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
11381 try both.
11382 </p>
11383 </li>
11384 </ul></div>
11385 </div></div>
11386 </dd>
11387 <dt class="hdlist1">
11388 trace2.normalBrief
11389 </dt>
11390 <dd>
11391 <p>
11392         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11393         omitted from normal output.  May be overridden by the
11394         <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.
11395 </p>
11396 </dd>
11397 <dt class="hdlist1">
11398 trace2.perfBrief
11399 </dt>
11400 <dd>
11401 <p>
11402         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11403         omitted from PERF output.  May be overridden by the
11404         <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.
11405 </p>
11406 </dd>
11407 <dt class="hdlist1">
11408 trace2.eventBrief
11409 </dt>
11410 <dd>
11411 <p>
11412         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11413         omitted from event output.  May be overridden by the
11414         <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.
11415 </p>
11416 </dd>
11417 <dt class="hdlist1">
11418 trace2.eventNesting
11419 </dt>
11420 <dd>
11421 <p>
11422         Integer.  Specifies desired depth of nested regions in the
11423         event output.  Regions deeper than this value will be
11424         omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
11425         environment variable.  Defaults to 2.
11426 </p>
11427 </dd>
11428 <dt class="hdlist1">
11429 trace2.configParams
11430 </dt>
11431 <dd>
11432 <p>
11433         A comma-separated list of patterns of "important" config
11434         settings that should be recorded in the trace2 output.
11435         For example, <code>core.*,remote.*.url</code> would cause the trace2
11436         output to contain events listing each configured remote.
11437         May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
11438         variable.  Unset by default.
11439 </p>
11440 </dd>
11441 <dt class="hdlist1">
11442 trace2.envVars
11443 </dt>
11444 <dd>
11445 <p>
11446         A comma-separated list of "important" environment variables that should
11447         be recorded in the trace2 output.  For example,
11448         <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
11449         contain events listing the overrides for HTTP user agent and the
11450         location of the Git configuration file (assuming any are set).  May be
11451         overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
11452         default.
11453 </p>
11454 </dd>
11455 <dt class="hdlist1">
11456 trace2.destinationDebug
11457 </dt>
11458 <dd>
11459 <p>
11460         Boolean.  When true Git will print error messages when a
11461         trace target destination cannot be opened for writing.
11462         By default, these errors are suppressed and tracing is
11463         silently disabled.  May be overridden by the
11464         <code>GIT_TRACE2_DST_DEBUG</code> environment variable.
11465 </p>
11466 </dd>
11467 <dt class="hdlist1">
11468 trace2.maxFiles
11469 </dt>
11470 <dd>
11471 <p>
11472         Integer.  When writing trace files to a target directory, do not
11473         write additional traces if doing so would exceed this many files. Instead,
11474         write a sentinel file that will block further tracing to this
11475         directory. Defaults to 0, which disables this check.
11476 </p>
11477 </dd>
11478 <dt class="hdlist1">
11479 transfer.credentialsInUrl
11480 </dt>
11481 <dd>
11482 <p>
11483         A configured URL can contain plaintext credentials in the form
11484         <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
11485         to warn or forbid the use of such configuration (in favor of
11486         using <a href="git-credential.html">git-credential(1)</a>). This will be used on
11487         <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>,
11488         and any other direct use of the configured URL.
11489 </p>
11490 <div class="paragraph"><p>Note that this is currently limited to detecting credentials in
11491 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
11492 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p></div>
11493 <div class="paragraph"><p>You might want to enable this to prevent inadvertent credentials
11494 exposure, e.g. because:</p></div>
11495 <div class="ulist"><ul>
11496 <li>
11497 <p>
11498 The OS or system where you&#8217;re running git may not provide a way or
11499   otherwise allow you to configure the permissions of the
11500   configuration file where the username and/or password are stored.
11501 </p>
11502 </li>
11503 <li>
11504 <p>
11505 Even if it does, having such data stored "at rest" might expose you
11506   in other ways, e.g. a backup process might copy the data to another
11507   system.
11508 </p>
11509 </li>
11510 <li>
11511 <p>
11512 The git programs will pass the full URL to one another as arguments
11513   on the command-line, meaning the credentials will be exposed to other
11514   unprivileged users on systems that allow them to see the full
11515   process list of other users. On linux the "hidepid" setting
11516   documented in procfs(5) allows for configuring this behavior.
11517 </p>
11518 <div class="paragraph"><p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
11519 concerned about credentials exposure due to storing sensitive
11520 data in git&#8217;s configuration files. If you do want to use this, set
11521 <code>transfer.credentialsInUrl</code> to one of these values:</p></div>
11522 </li>
11523 <li>
11524 <p>
11525 <code>allow</code> (default): Git will proceed with its activity without warning.
11526 </p>
11527 </li>
11528 <li>
11529 <p>
11530 <code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
11531   with a plaintext credential.
11532 </p>
11533 </li>
11534 <li>
11535 <p>
11536 <code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
11537   with a plaintext credential.
11538 </p>
11539 </li>
11540 </ul></div>
11541 </dd>
11542 <dt class="hdlist1">
11543 transfer.fsckObjects
11544 </dt>
11545 <dd>
11546 <p>
11547         When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
11548         not set, the value of this variable is used instead.
11549         Defaults to false.
11550 </p>
11551 <div class="paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
11552 object or a link to a nonexistent object. In addition, various other
11553 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
11554 and potential security issues like the existence of a <code>.GIT</code> directory
11555 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
11556 and v2.17.1 for details). Other sanity and security checks may be
11557 added in future releases.</p></div>
11558 <div class="paragraph"><p>On the receiving side, failing fsckObjects will make those objects
11559 unreachable, see "QUARANTINE ENVIRONMENT" in
11560 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
11561 instead be left unreferenced in the repository.</p></div>
11562 <div class="paragraph"><p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
11563 implementation it cannot be relied upon to leave the object store
11564 clean like <code>receive.fsckObjects</code> can.</p></div>
11565 <div class="paragraph"><p>As objects are unpacked they&#8217;re written to the object store, so there
11566 can be cases where malicious objects get introduced even though the
11567 "fetch" failed, only to have a subsequent "fetch" succeed because only
11568 new incoming objects are checked, not those that have already been
11569 written to the object store. That difference in behavior should not be
11570 relied upon. In the future, such objects may be quarantined for
11571 "fetch" as well.</p></div>
11572 <div class="paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
11573 environment if they&#8217;d like the same protection as "push". E.g. in the
11574 case of an internal mirror do the mirroring in two steps, one to fetch
11575 the untrusted objects, and then do a second "push" (which will use the
11576 quarantine) to another internal repo, and have internal clients
11577 consume this pushed-to repository, or embargo internal fetches and
11578 only allow them once a full "fsck" has run (and no new fetches have
11579 happened in the meantime).</p></div>
11580 </dd>
11581 <dt class="hdlist1">
11582 transfer.hideRefs
11583 </dt>
11584 <dd>
11585 <p>
11586         String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
11587         refs to omit from their initial advertisements.  Use more than
11588         one definition to specify multiple prefix strings. A ref that is
11589         under the hierarchies listed in the value of this variable is
11590         excluded, and is hidden when responding to <code>git push</code> or <code>git
11591         fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
11592         program-specific versions of this config.
11593 </p>
11594 <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
11595 explicitly exposing it, even if an earlier entry marked it as hidden.
11596 If you have multiple hideRefs values, later entries override earlier ones
11597 (and entries in more-specific config files override less-specific ones).</p></div>
11598 <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
11599 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
11600 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
11601 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
11602 <div class="paragraph"><p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
11603 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
11604 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
11605 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
11606 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
11607 <code>receive-pack</code>, on the other hand, will still advertise the object id the
11608 ref is pointing to without mentioning its name (a so-called ".have" line).</p></div>
11609 <div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
11610 objects via the techniques described in the "SECURITY" section of the
11611 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
11612 separate repository.</p></div>
11613 </dd>
11614 <dt class="hdlist1">
11615 transfer.unpackLimit
11616 </dt>
11617 <dd>
11618 <p>
11619         When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
11620         not set, the value of this variable is used instead.
11621         The default value is 100.
11622 </p>
11623 </dd>
11624 <dt class="hdlist1">
11625 transfer.advertiseSID
11626 </dt>
11627 <dd>
11628 <p>
11629         Boolean. When true, client and server processes will advertise their
11630         unique session IDs to their remote counterpart. Defaults to false.
11631 </p>
11632 </dd>
11633 <dt class="hdlist1">
11634 transfer.bundleURI
11635 </dt>
11636 <dd>
11637 <p>
11638         When <code>true</code>, local <code>git clone</code> commands will request bundle
11639         information from the remote server (if advertised) and download
11640         bundles before continuing the clone through the Git protocol.
11641         Defaults to <code>false</code>.
11642 </p>
11643 </dd>
11644 <dt class="hdlist1">
11645 transfer.advertiseObjectInfo
11646 </dt>
11647 <dd>
11648 <p>
11649         When <code>true</code>, the <code>object-info</code> capability is advertised by
11650         servers. Defaults to false.
11651 </p>
11652 </dd>
11653 <dt class="hdlist1">
11654 uploadarchive.allowUnreachable
11655 </dt>
11656 <dd>
11657 <p>
11658         If true, allow clients to use <code>git archive --remote</code> to request
11659         any tree, whether reachable from the ref tips or not. See the
11660         discussion in the "SECURITY" section of
11661         <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
11662         <code>false</code>.
11663 </p>
11664 </dd>
11665 <dt class="hdlist1">
11666 uploadpack.hideRefs
11667 </dt>
11668 <dd>
11669 <p>
11670         This variable is the same as <code>transfer.hideRefs</code>, but applies
11671         only to <code>upload-pack</code> (and so affects only fetches, not pushes).
11672         An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
11673         also <code>uploadpack.allowTipSHA1InWant</code>.
11674 </p>
11675 </dd>
11676 <dt class="hdlist1">
11677 uploadpack.allowTipSHA1InWant
11678 </dt>
11679 <dd>
11680 <p>
11681         When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
11682         to accept a fetch request that asks for an object at the tip
11683         of a hidden ref (by default, such a request is rejected).
11684         See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
11685         may be able to steal objects via the techniques described in the
11686         "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
11687         best to keep private data in a separate repository.
11688 </p>
11689 </dd>
11690 <dt class="hdlist1">
11691 uploadpack.allowReachableSHA1InWant
11692 </dt>
11693 <dd>
11694 <p>
11695         Allow <code>upload-pack</code> to accept a fetch request that asks for an
11696         object that is reachable from any ref tip. However, note that
11697         calculating object reachability is computationally expensive.
11698         Defaults to <code>false</code>.  Even if this is false, a client may be able
11699         to steal objects via the techniques described in the "SECURITY"
11700         section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
11701         keep private data in a separate repository.
11702 </p>
11703 </dd>
11704 <dt class="hdlist1">
11705 uploadpack.allowAnySHA1InWant
11706 </dt>
11707 <dd>
11708 <p>
11709         Allow <code>upload-pack</code> to accept a fetch request that asks for any
11710         object at all.
11711         Defaults to <code>false</code>.
11712 </p>
11713 </dd>
11714 <dt class="hdlist1">
11715 uploadpack.keepAlive
11716 </dt>
11717 <dd>
11718 <p>
11719         When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
11720         quiet period while <code>pack-objects</code> prepares the pack. Normally
11721         it would output progress information, but if <code>--quiet</code> was used
11722         for the fetch, <code>pack-objects</code> will output nothing at all until
11723         the pack data begins. Some clients and networks may consider
11724         the server to be hung and give up. Setting this option instructs
11725         <code>upload-pack</code> to send an empty keepalive packet every
11726         <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
11727         disables keepalive packets entirely. The default is 5 seconds.
11728 </p>
11729 </dd>
11730 <dt class="hdlist1">
11731 uploadpack.packObjectsHook
11732 </dt>
11733 <dd>
11734 <p>
11735         If this option is set, when <code>upload-pack</code> would run
11736         <code>git pack-objects</code> to create a packfile for a client, it will
11737         run this shell command instead.  The <code>pack-objects</code> command and
11738         arguments it <em>would</em> have run (including the <code>git pack-objects</code>
11739         at the beginning) are appended to the shell command. The stdin
11740         and stdout of the hook are treated as if <code>pack-objects</code> itself
11741         was run. I.e., <code>upload-pack</code> will feed input intended for
11742         <code>pack-objects</code> to the hook, and expects a completed packfile on
11743         stdout.
11744 </p>
11745 <div class="paragraph"><p>Note that this configuration variable is only respected when it is specified
11746 in protected configuration (see <a href="#SCOPES">[SCOPES]</a>). This is a safety measure
11747 against fetching from untrusted repositories.</p></div>
11748 </dd>
11749 <dt class="hdlist1">
11750 uploadpack.allowFilter
11751 </dt>
11752 <dd>
11753 <p>
11754         If this option is set, <code>upload-pack</code> will support partial
11755         clone and partial fetch object filtering.
11756 </p>
11757 </dd>
11758 <dt class="hdlist1">
11759 uploadpackfilter.allow
11760 </dt>
11761 <dd>
11762 <p>
11763         Provides a default value for unspecified object filters (see: the
11764         below configuration variable). If set to <code>true</code>, this will also
11765         enable all filters which get added in the future.
11766         Defaults to <code>true</code>.
11767 </p>
11768 </dd>
11769 <dt class="hdlist1">
11770 uploadpackfilter.&lt;filter&gt;.allow
11771 </dt>
11772 <dd>
11773 <p>
11774         Explicitly allow or ban the object filter corresponding to
11775         <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
11776         <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
11777         If using combined filters, both <code>combine</code> and all of the nested
11778         filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.
11779 </p>
11780 </dd>
11781 <dt class="hdlist1">
11782 uploadpackfilter.tree.maxDepth
11783 </dt>
11784 <dd>
11785 <p>
11786         Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
11787         <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
11788         <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
11789         variable had already been set. Has no effect if unset.
11790 </p>
11791 </dd>
11792 <dt class="hdlist1">
11793 uploadpack.allowRefInWant
11794 </dt>
11795 <dd>
11796 <p>
11797         If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
11798         feature of the protocol version 2 <code>fetch</code> command.  This feature
11799         is intended for the benefit of load-balanced servers which may
11800         not have the same view of what OIDs their refs point to due to
11801         replication delay.
11802 </p>
11803 </dd>
11804 <dt class="hdlist1">
11805 url.&lt;base&gt;.insteadOf
11806 </dt>
11807 <dd>
11808 <p>
11809         Any URL that starts with this value will be rewritten to
11810         start, instead, with &lt;base&gt;. In cases where some site serves a
11811         large number of repositories, and serves them with multiple
11812         access methods, and some users need to use different access
11813         methods, this feature allows people to specify any of the
11814         equivalent URLs and have Git automatically rewrite the URL to
11815         the best alternative for the particular user, even for a
11816         never-before-seen repository on the site.  When more than one
11817         insteadOf strings match a given URL, the longest match is used.
11818 </p>
11819 <div class="paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
11820 URL. If the rewrite changes the URL to use a custom protocol or remote
11821 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
11822 the request.  In particular, protocols you expect to use for submodules
11823 must be set to <code>always</code> rather than the default of <code>user</code>. See the
11824 description of <code>protocol.allow</code> above.</p></div>
11825 </dd>
11826 <dt class="hdlist1">
11827 url.&lt;base&gt;.pushInsteadOf
11828 </dt>
11829 <dd>
11830 <p>
11831         Any URL that starts with this value will not be pushed to;
11832         instead, it will be rewritten to start with &lt;base&gt;, and the
11833         resulting URL will be pushed to. In cases where some site serves
11834         a large number of repositories, and serves them with multiple
11835         access methods, some of which do not allow push, this feature
11836         allows people to specify a pull-only URL and have Git
11837         automatically use an appropriate URL to push, even for a
11838         never-before-seen repository on the site.  When more than one
11839         pushInsteadOf strings match a given URL, the longest match is
11840         used.  If a remote has an explicit pushurl, Git will ignore this
11841         setting for that remote.
11842 </p>
11843 </dd>
11844 <dt class="hdlist1">
11845 user.name
11846 </dt>
11847 <dt class="hdlist1">
11848 user.email
11849 </dt>
11850 <dt class="hdlist1">
11851 author.name
11852 </dt>
11853 <dt class="hdlist1">
11854 author.email
11855 </dt>
11856 <dt class="hdlist1">
11857 committer.name
11858 </dt>
11859 <dt class="hdlist1">
11860 committer.email
11861 </dt>
11862 <dd>
11863 <p>
11864         The <code>user.name</code> and <code>user.email</code> variables determine what ends
11865         up in the <code>author</code> and <code>committer</code> fields of commit
11866         objects.
11867         If you need the <code>author</code> or <code>committer</code> to be different, the
11868         <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
11869         <code>committer.email</code> variables can be set.
11870         All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
11871         <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
11872         <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.
11873 </p>
11874 <div class="paragraph"><p>Note that the <code>name</code> forms of these variables conventionally refer to
11875 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
11876 environment variables section of <a href="git.html">git(1)</a> for more information on
11877 these settings and the <code>credential.username</code> option if you&#8217;re looking
11878 for authentication credentials instead.</p></div>
11879 </dd>
11880 <dt class="hdlist1">
11881 user.useConfigOnly
11882 </dt>
11883 <dd>
11884 <p>
11885         Instruct Git to avoid trying to guess defaults for <code>user.email</code>
11886         and <code>user.name</code>, and instead retrieve the values only from the
11887         configuration. For example, if you have multiple email addresses
11888         and would like to use a different one for each repository, then
11889         with this configuration option set to <code>true</code> in the global config
11890         along with a name, Git will prompt you to set up an email before
11891         making new commits in a newly cloned repository.
11892         Defaults to <code>false</code>.
11893 </p>
11894 </dd>
11895 <dt class="hdlist1">
11896 user.signingKey
11897 </dt>
11898 <dd>
11899 <p>
11900         If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
11901         key you want it to automatically when creating a signed tag or
11902         commit, you can override the default selection with this variable.
11903         This option is passed unchanged to gpg&#8217;s --local-user parameter,
11904         so you may specify a key using any method that gpg supports.
11905         If gpg.format is set to <code>ssh</code> this can contain the path to either
11906         your private ssh key or the public key when ssh-agent is used.
11907         Alternatively it can contain a public key prefixed with <code>key::</code>
11908         directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
11909         needs to be available via ssh-agent. If not set Git will call
11910         gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
11911         first key available. For backward compatibility, a raw key which
11912         begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
11913         as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
11914         use the <code>key::</code> form instead.
11915 </p>
11916 </dd>
11917 <dt class="hdlist1">
11918 versionsort.prereleaseSuffix (deprecated)
11919 </dt>
11920 <dd>
11921 <p>
11922         Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
11923         <code>versionsort.suffix</code> is set.
11924 </p>
11925 </dd>
11926 <dt class="hdlist1">
11927 versionsort.suffix
11928 </dt>
11929 <dd>
11930 <p>
11931         Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
11932         with the same base version but different suffixes are still sorted
11933         lexicographically, resulting e.g. in prerelease tags appearing
11934         after the main release (e.g. "1.0-rc1" after "1.0").  This
11935         variable can be specified to determine the sorting order of tags
11936         with different suffixes.
11937 </p>
11938 <div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
11939 that suffix will appear before the corresponding main release.  E.g. if
11940 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
11941 "1.0".  If specified multiple times, once per suffix, then the order of
11942 suffixes in the configuration will determine the sorting order of tagnames
11943 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
11944 configuration, then all "1.0-preX" tags will be listed before any
11945 "1.0-rcX" tags.  The placement of the main release tag relative to tags
11946 with various suffixes can be determined by specifying the empty suffix
11947 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
11948 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
11949 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
11950 "v4.8-bfsX".</p></div>
11951 <div class="paragraph"><p>If more than one suffix matches the same tagname, then that tagname will
11952 be sorted according to the suffix which starts at the earliest position in
11953 the tagname.  If more than one different matching suffix starts at
11954 that earliest position, then that tagname will be sorted according to the
11955 longest of those suffixes.
11956 The sorting order between different suffixes is undefined if they are
11957 in multiple config files.</p></div>
11958 </dd>
11959 <dt class="hdlist1">
11960 web.browser
11961 </dt>
11962 <dd>
11963 <p>
11964         Specify a web browser that may be used by some commands.
11965         Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
11966         may use it.
11967 </p>
11968 </dd>
11969 <dt class="hdlist1">
11970 worktree.guessRemote
11971 </dt>
11972 <dd>
11973 <p>
11974         If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
11975         <code>--detach</code> is used, then <code>git worktree add</code> defaults to
11976         creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
11977         set to true, <code>worktree add</code> tries to find a remote-tracking
11978         branch whose name uniquely matches the new branch name.  If
11979         such a branch exists, it is checked out and set as "upstream"
11980         for the new branch.  If no such match can be found, it falls
11981         back to creating a new branch from the current HEAD.
11982 </p>
11983 </dd>
11984 </dl></div>
11985 </div>
11986 </div>
11987 </div>
11988 <div class="sect1">
11989 <h2 id="_bugs">BUGS</h2>
11990 <div class="sectionbody">
11991 <div class="paragraph"><p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
11992 will result in adding a multi-line key instead of a change, if the subsection
11993 is given with at least one uppercase character. For example when the config
11994 looks like</p></div>
11995 <div class="listingblock">
11996 <div class="content">
11997 <pre><code>  [section.subsection]
11998     key = value1</code></pre>
11999 </div></div>
12000 <div class="paragraph"><p>and running <code>git config section.Subsection.key value2</code> will result in</p></div>
12001 <div class="listingblock">
12002 <div class="content">
12003 <pre><code>  [section.subsection]
12004     key = value1
12005     key = value2</code></pre>
12006 </div></div>
12007 </div>
12008 </div>
12009 <div class="sect1">
12010 <h2 id="_git">GIT</h2>
12011 <div class="sectionbody">
12012 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
12013 </div>
12014 </div>
12015 </div>
12016 <div id="footnotes"><hr /></div>
12017 <div id="footer">
12018 <div id="footer-text">
12019 Last updated
12020  2024-04-05 11:03:41 PDT
12021 </div>
12022 </div>
12023 </body>
12024 </html>