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;] [--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;] --add &lt;name&gt; &lt;value&gt;
 754 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&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 --get
 869 </dt>
 870 <dd>
 871 <p>
 872         Get the value for a given key (optionally filtered by a regex
 873         matching the value). Returns error code 1 if the key was not
 874         found and the last value if multiple key values were found.
 875 </p>
 876 </dd>
 877 <dt class="hdlist1">
 878 --get-all
 879 </dt>
 880 <dd>
 881 <p>
 882         Like get, but returns all values for a multi-valued key.
 883 </p>
 884 </dd>
 885 <dt class="hdlist1">
 886 --get-regexp
 887 </dt>
 888 <dd>
 889 <p>
 890         Like --get-all, but interprets the name as a regular expression and
 891         writes out the key names.  Regular expression matching is currently
 892         case-sensitive and done against a canonicalized version of the key
 893         in which section and variable names are lowercased, but subsection
 894         names are not.
 895 </p>
 896 </dd>
 897 <dt class="hdlist1">
 898 --get-urlmatch &lt;name&gt; &lt;URL&gt;
 899 </dt>
 900 <dd>
 901 <p>
 902         When given a two-part name section.key, the value for
 903         section.&lt;URL&gt;.key whose &lt;URL&gt; part matches the best to the
 904         given URL is returned (if no such key exists, the value for
 905         section.key is used as a fallback).  When given just the
 906         section as name, do so for all the keys in the section and
 907         list them.  Returns error code 1 if no value is found.
 908 </p>
 909 </dd>
 910 <dt class="hdlist1">
 911 --global
 912 </dt>
 913 <dd>
 914 <p>
 915         For writing options: write to global <code>~/.gitconfig</code> file
 916         rather than the repository <code>.git/config</code>, write to
 917         <code>$XDG_CONFIG_HOME/git/config</code> file if this file exists and the
 918         <code>~/.gitconfig</code> file doesn&#8217;t.
 919 </p>
 920 <div class="paragraph"><p>For reading options: read only from global <code>~/.gitconfig</code> and from
 921 <code>$XDG_CONFIG_HOME/git/config</code> rather than from all available files.</p></div>
 922 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 923 </dd>
 924 <dt class="hdlist1">
 925 --system
 926 </dt>
 927 <dd>
 928 <p>
 929         For writing options: write to system-wide
 930         <code>$(prefix)/etc/gitconfig</code> rather than the repository
 931         <code>.git/config</code>.
 932 </p>
 933 <div class="paragraph"><p>For reading options: read only from system-wide <code>$(prefix)/etc/gitconfig</code>
 934 rather than from all available files.</p></div>
 935 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 936 </dd>
 937 <dt class="hdlist1">
 938 --local
 939 </dt>
 940 <dd>
 941 <p>
 942         For writing options: write to the repository <code>.git/config</code> file.
 943         This is the default behavior.
 944 </p>
 945 <div class="paragraph"><p>For reading options: read only from the repository <code>.git/config</code> rather than
 946 from all available files.</p></div>
 947 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 948 </dd>
 949 <dt class="hdlist1">
 950 --worktree
 951 </dt>
 952 <dd>
 953 <p>
 954         Similar to <code>--local</code> except that <code>$GIT_DIR/config.worktree</code> is
 955         read from or written to if <code>extensions.worktreeConfig</code> is
 956         enabled. If not it&#8217;s the same as <code>--local</code>. Note that <code>$GIT_DIR</code>
 957         is equal to <code>$GIT_COMMON_DIR</code> for the main working tree, but is of
 958         the form <code>$GIT_DIR/worktrees/&lt;id&gt;/</code> for other working trees. See
 959         <a href="git-worktree.html">git-worktree(1)</a> to learn how to enable
 960         <code>extensions.worktreeConfig</code>.
 961 </p>
 962 </dd>
 963 <dt class="hdlist1">
 964 -f &lt;config-file&gt;
 965 </dt>
 966 <dt class="hdlist1">
 967 --file &lt;config-file&gt;
 968 </dt>
 969 <dd>
 970 <p>
 971         For writing options: write to the specified file rather than the
 972         repository <code>.git/config</code>.
 973 </p>
 974 <div class="paragraph"><p>For reading options: read only from the specified file rather than from all
 975 available files.</p></div>
 976 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 977 </dd>
 978 <dt class="hdlist1">
 979 --blob &lt;blob&gt;
 980 </dt>
 981 <dd>
 982 <p>
 983         Similar to <code>--file</code> but use the given blob instead of a file. E.g.
 984         you can use <em>master:.gitmodules</em> to read values from the file
 985         <em>.gitmodules</em> in the master branch. See "SPECIFYING REVISIONS"
 986         section in <a href="gitrevisions.html">gitrevisions(7)</a> for a more complete list of
 987         ways to spell blob names.
 988 </p>
 989 </dd>
 990 <dt class="hdlist1">
 991 --remove-section
 992 </dt>
 993 <dd>
 994 <p>
 995         Remove the given section from the configuration file.
 996 </p>
 997 </dd>
 998 <dt class="hdlist1">
 999 --rename-section
1000 </dt>
1001 <dd>
1002 <p>
1003         Rename the given section to a new name.
1004 </p>
1005 </dd>
1006 <dt class="hdlist1">
1007 --unset
1008 </dt>
1009 <dd>
1010 <p>
1011         Remove the line matching the key from config file.
1012 </p>
1013 </dd>
1014 <dt class="hdlist1">
1015 --unset-all
1016 </dt>
1017 <dd>
1018 <p>
1019         Remove all lines matching the key from config file.
1020 </p>
1021 </dd>
1022 <dt class="hdlist1">
1023 -l
1024 </dt>
1025 <dt class="hdlist1">
1026 --list
1027 </dt>
1028 <dd>
1029 <p>
1030         List all variables set in config file, along with their values.
1031 </p>
1032 </dd>
1033 <dt class="hdlist1">
1034 --fixed-value
1035 </dt>
1036 <dd>
1037 <p>
1038         When used with the <code>value-pattern</code> argument, treat <code>value-pattern</code> as
1039         an exact string instead of a regular expression. This will restrict
1040         the name/value pairs that are matched to only those where the value
1041         is exactly equal to the <code>value-pattern</code>.
1042 </p>
1043 </dd>
1044 <dt class="hdlist1">
1045 --type &lt;type&gt;
1046 </dt>
1047 <dd>
1048 <p>
1049   <em>git config</em> will ensure that any input or output is valid under the given
1050   type constraint(s), and will canonicalize outgoing values in <code>&lt;type&gt;</code>'s
1051   canonical form.
1052 </p>
1053 <div class="paragraph"><p>Valid <code>&lt;type&gt;</code>'s include:</p></div>
1054 <div class="ulist"><ul>
1055 <li>
1056 <p>
1057 <em>bool</em>: canonicalize values as either "true" or "false".
1058 </p>
1059 </li>
1060 <li>
1061 <p>
1062 <em>int</em>: canonicalize values as simple decimal numbers. An optional suffix of
1063   <em>k</em>, <em>m</em>, or <em>g</em> will cause the value to be multiplied by 1024, 1048576, or
1064   1073741824 upon input.
1065 </p>
1066 </li>
1067 <li>
1068 <p>
1069 <em>bool-or-int</em>: canonicalize according to either <em>bool</em> or <em>int</em>, as described
1070   above.
1071 </p>
1072 </li>
1073 <li>
1074 <p>
1075 <em>path</em>: canonicalize by expanding a leading <code>~</code> to the value of <code>$HOME</code> and
1076   <code>~user</code> to the home directory for the specified user. This specifier has no
1077   effect when setting the value (but you can use <code>git config section.variable
1078   ~/</code> from the command line to let your shell do the expansion.)
1079 </p>
1080 </li>
1081 <li>
1082 <p>
1083 <em>expiry-date</em>: canonicalize by converting from a fixed or relative date-string
1084   to a timestamp. This specifier has no effect when setting the value.
1085 </p>
1086 </li>
1087 <li>
1088 <p>
1089 <em>color</em>: When getting a value, canonicalize by converting to an ANSI color
1090   escape sequence. When setting a value, a sanity-check is performed to ensure
1091   that the given value is canonicalize-able as an ANSI color, but it is written
1092   as-is.
1093 </p>
1094 </li>
1095 </ul></div>
1096 </dd>
1097 <dt class="hdlist1">
1098 --bool
1099 </dt>
1100 <dt class="hdlist1">
1101 --int
1102 </dt>
1103 <dt class="hdlist1">
1104 --bool-or-int
1105 </dt>
1106 <dt class="hdlist1">
1107 --path
1108 </dt>
1109 <dt class="hdlist1">
1110 --expiry-date
1111 </dt>
1112 <dd>
1113 <p>
1114   Historical options for selecting a type specifier. Prefer instead <code>--type</code>
1115   (see above).
1116 </p>
1117 </dd>
1118 <dt class="hdlist1">
1119 --no-type
1120 </dt>
1121 <dd>
1122 <p>
1123   Un-sets the previously set type specifier (if one was previously set). This
1124   option requests that <em>git config</em> not canonicalize the retrieved variable.
1125   <code>--no-type</code> has no effect without <code>--type=&lt;type&gt;</code> or <code>--&lt;type&gt;</code>.
1126 </p>
1127 </dd>
1128 <dt class="hdlist1">
1129 -z
1130 </dt>
1131 <dt class="hdlist1">
1132 --null
1133 </dt>
1134 <dd>
1135 <p>
1136         For all options that output values and/or keys, always
1137         end values with the null character (instead of a
1138         newline). Use newline instead as a delimiter between
1139         key and value. This allows for secure parsing of the
1140         output without getting confused e.g. by values that
1141         contain line breaks.
1142 </p>
1143 </dd>
1144 <dt class="hdlist1">
1145 --name-only
1146 </dt>
1147 <dd>
1148 <p>
1149         Output only the names of config variables for <code>--list</code> or
1150         <code>--get-regexp</code>.
1151 </p>
1152 </dd>
1153 <dt class="hdlist1">
1154 --show-origin
1155 </dt>
1156 <dd>
1157 <p>
1158         Augment the output of all queried config options with the
1159         origin type (file, standard input, blob, command line) and
1160         the actual origin (config file path, ref, or blob id if
1161         applicable).
1162 </p>
1163 </dd>
1164 <dt class="hdlist1">
1165 --show-scope
1166 </dt>
1167 <dd>
1168 <p>
1169         Similar to <code>--show-origin</code> in that it augments the output of
1170         all queried config options with the scope of that value
1171         (worktree, local, global, system, command).
1172 </p>
1173 </dd>
1174 <dt class="hdlist1">
1175 --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]
1176 </dt>
1177 <dd>
1178 <p>
1179         Find the color setting for <code>&lt;name&gt;</code> (e.g. <code>color.diff</code>) and output
1180         "true" or "false".  <code>&lt;stdout-is-tty&gt;</code> should be either "true" or
1181         "false", and is taken into account when configuration says
1182         "auto".  If <code>&lt;stdout-is-tty&gt;</code> is missing, then checks the standard
1183         output of the command itself, and exits with status 0 if color
1184         is to be used, or exits with status 1 otherwise.
1185         When the color setting for <code>name</code> is undefined, the command uses
1186         <code>color.ui</code> as fallback.
1187 </p>
1188 </dd>
1189 <dt class="hdlist1">
1190 --get-color &lt;name&gt; [&lt;default&gt;]
1191 </dt>
1192 <dd>
1193 <p>
1194         Find the color configured for <code>name</code> (e.g. <code>color.diff.new</code>) and
1195         output it as the ANSI color escape sequence to the standard
1196         output.  The optional <code>default</code> parameter is used instead, if
1197         there is no color configured for <code>name</code>.
1198 </p>
1199 <div class="paragraph"><p><code>--type=color [--default=&lt;default&gt;]</code> is preferred over <code>--get-color</code>
1200 (but note that <code>--get-color</code> will omit the trailing newline printed by
1201 <code>--type=color</code>).</p></div>
1202 </dd>
1203 <dt class="hdlist1">
1204 -e
1205 </dt>
1206 <dt class="hdlist1">
1207 --edit
1208 </dt>
1209 <dd>
1210 <p>
1211         Opens an editor to modify the specified config file; either
1212         <code>--system</code>, <code>--global</code>, or repository (default).
1213 </p>
1214 </dd>
1215 <dt class="hdlist1">
1216 --[no-]includes
1217 </dt>
1218 <dd>
1219 <p>
1220         Respect <code>include.*</code> directives in config files when looking up
1221         values. Defaults to <code>off</code> when a specific file is given (e.g.,
1222         using <code>--file</code>, <code>--global</code>, etc) and <code>on</code> when searching all
1223         config files.
1224 </p>
1225 </dd>
1226 <dt class="hdlist1">
1227 --default &lt;value&gt;
1228 </dt>
1229 <dd>
1230 <p>
1231   When using <code>--get</code>, and the requested variable is not found, behave as if
1232   &lt;value&gt; were the value assigned to the that variable.
1233 </p>
1234 </dd>
1235 </dl></div>
1236 </div>
1237 </div>
1238 <div class="sect1">
1239 <h2 id="_configuration">CONFIGURATION</h2>
1240 <div class="sectionbody">
1241 <div class="paragraph"><p><code>pager.config</code> is only respected when listing configuration, i.e., when
1242 using <code>--list</code> or any of the <code>--get-*</code> which may return multiple results.
1243 The default is to use a pager.</p></div>
1244 </div>
1245 </div>
1246 <div class="sect1">
1247 <h2 id="FILES">FILES</h2>
1248 <div class="sectionbody">
1249 <div class="paragraph"><p>By default, <em>git config</em> will read configuration options from multiple
1250 files:</p></div>
1251 <div class="dlist"><dl>
1252 <dt class="hdlist1">
1253 $(prefix)/etc/gitconfig
1254 </dt>
1255 <dd>
1256 <p>
1257         System-wide configuration file.
1258 </p>
1259 </dd>
1260 <dt class="hdlist1">
1261 $XDG_CONFIG_HOME/git/config
1262 </dt>
1263 <dt class="hdlist1">
1264 ~/.gitconfig
1265 </dt>
1266 <dd>
1267 <p>
1268         User-specific configuration files. When the XDG_CONFIG_HOME environment
1269         variable is not set or empty, $HOME/.config/ is used as
1270         $XDG_CONFIG_HOME.
1271 </p>
1272 <div class="paragraph"><p>These are also called "global" configuration files. If both files exist, both
1273 files are read in the order given above.</p></div>
1274 </dd>
1275 <dt class="hdlist1">
1276 $GIT_DIR/config
1277 </dt>
1278 <dd>
1279 <p>
1280         Repository specific configuration file.
1281 </p>
1282 </dd>
1283 <dt class="hdlist1">
1284 $GIT_DIR/config.worktree
1285 </dt>
1286 <dd>
1287 <p>
1288         This is optional and is only searched when
1289         <code>extensions.worktreeConfig</code> is present in $GIT_DIR/config.
1290 </p>
1291 </dd>
1292 </dl></div>
1293 <div class="paragraph"><p>You may also provide additional configuration parameters when running any
1294 git command by using the <code>-c</code> option. See <a href="git.html">git(1)</a> for details.</p></div>
1295 <div class="paragraph"><p>Options will be read from all of these files that are available. If the
1296 global or the system-wide configuration files are missing or unreadable they
1297 will be ignored. If the repository configuration file is missing or unreadable,
1298 <em>git config</em> will exit with a non-zero error code. An error message is produced
1299 if the file is unreadable, but not if it is missing.</p></div>
1300 <div class="paragraph"><p>The files are read in the order given above, with last value found taking
1301 precedence over values read earlier.  When multiple values are taken then all
1302 values of a key from all files will be used.</p></div>
1303 <div class="paragraph"><p>By default, options are only written to the repository specific
1304 configuration file. Note that this also affects options like <code>--replace-all</code>
1305 and <code>--unset</code>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
1306 <div class="paragraph"><p>You can limit which configuration sources are read from or written to by
1307 specifying the path of a file with the <code>--file</code> option, or by specifying a
1308 configuration scope with <code>--system</code>, <code>--global</code>, <code>--local</code>, or <code>--worktree</code>.
1309 For more, see <a href="#OPTIONS">[OPTIONS]</a> above.</p></div>
1310 </div>
1311 </div>
1312 <div class="sect1">
1313 <h2 id="SCOPES">SCOPES</h2>
1314 <div class="sectionbody">
1315 <div class="paragraph"><p>Each configuration source falls within a configuration scope. The scopes
1316 are:</p></div>
1317 <div class="dlist"><dl>
1318 <dt class="hdlist1">
1319 system
1320 </dt>
1321 <dd>
1322 <p>
1323         $(prefix)/etc/gitconfig
1324 </p>
1325 </dd>
1326 <dt class="hdlist1">
1327 global
1328 </dt>
1329 <dd>
1330 <p>
1331         $XDG_CONFIG_HOME/git/config
1332 </p>
1333 <div class="paragraph"><p>~/.gitconfig</p></div>
1334 </dd>
1335 <dt class="hdlist1">
1336 local
1337 </dt>
1338 <dd>
1339 <p>
1340         $GIT_DIR/config
1341 </p>
1342 </dd>
1343 <dt class="hdlist1">
1344 worktree
1345 </dt>
1346 <dd>
1347 <p>
1348         $GIT_DIR/config.worktree
1349 </p>
1350 </dd>
1351 <dt class="hdlist1">
1352 command
1353 </dt>
1354 <dd>
1355 <p>
1356         GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see <a href="#ENVIRONMENT">[ENVIRONMENT]</a>
1357         below)
1358 </p>
1359 <div class="paragraph"><p>the <code>-c</code> option</p></div>
1360 </dd>
1361 </dl></div>
1362 <div class="paragraph"><p>With the exception of <em>command</em>, each scope corresponds to a command line
1363 option: <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code>.</p></div>
1364 <div class="paragraph"><p>When reading options, specifying a scope will only read options from the
1365 files within that scope. When writing options, specifying a scope will write
1366 to the files within that scope (instead of the repository specific
1367 configuration file). See <a href="#OPTIONS">[OPTIONS]</a> above for a complete description.</p></div>
1368 <div class="paragraph"><p>Most configuration options are respected regardless of the scope it is
1369 defined in, but some options are only respected in certain scopes. See the
1370 respective option&#8217;s documentation for the full details.</p></div>
1371 <div class="sect2">
1372 <h3 id="_protected_configuration">Protected configuration</h3>
1373 <div class="paragraph"><p>Protected configuration refers to the <em>system</em>, <em>global</em>, and <em>command</em> scopes.
1374 For security reasons, certain options are only respected when they are
1375 specified in protected configuration, and ignored otherwise.</p></div>
1376 <div class="paragraph"><p>Git treats these scopes as if they are controlled by the user or a trusted
1377 administrator. This is because an attacker who controls these scopes can do
1378 substantial harm without using Git, so it is assumed that the user&#8217;s environment
1379 protects these scopes against attackers.</p></div>
1380 </div>
1381 </div>
1382 </div>
1383 <div class="sect1">
1384 <h2 id="ENVIRONMENT">ENVIRONMENT</h2>
1385 <div class="sectionbody">
1386 <div class="dlist"><dl>
1387 <dt class="hdlist1">
1388 GIT_CONFIG_GLOBAL
1389 </dt>
1390 <dt class="hdlist1">
1391 GIT_CONFIG_SYSTEM
1392 </dt>
1393 <dd>
1394 <p>
1395         Take the configuration from the given files instead from global or
1396         system-level configuration. See <a href="git.html">git(1)</a> for details.
1397 </p>
1398 </dd>
1399 <dt class="hdlist1">
1400 GIT_CONFIG_NOSYSTEM
1401 </dt>
1402 <dd>
1403 <p>
1404         Whether to skip reading settings from the system-wide
1405         $(prefix)/etc/gitconfig file. See <a href="git.html">git(1)</a> for details.
1406 </p>
1407 </dd>
1408 </dl></div>
1409 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1410 <div class="dlist"><dl>
1411 <dt class="hdlist1">
1412 GIT_CONFIG_COUNT
1413 </dt>
1414 <dt class="hdlist1">
1415 GIT_CONFIG_KEY_&lt;n&gt;
1416 </dt>
1417 <dt class="hdlist1">
1418 GIT_CONFIG_VALUE_&lt;n&gt;
1419 </dt>
1420 <dd>
1421 <p>
1422         If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
1423         GIT_CONFIG_KEY_&lt;n&gt; and GIT_CONFIG_VALUE_&lt;n&gt; up to that number will be
1424         added to the process&#8217;s runtime configuration. The config pairs are
1425         zero-indexed. Any missing key or value is treated as an error. An empty
1426         GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
1427         pairs are processed. These environment variables will override values
1428         in configuration files, but will be overridden by any explicit options
1429         passed via <code>git -c</code>.
1430 </p>
1431 <div class="paragraph"><p>This is useful for cases where you want to spawn multiple git commands
1432 with a common configuration but cannot depend on a configuration file,
1433 for example when writing scripts.</p></div>
1434 </dd>
1435 <dt class="hdlist1">
1436 GIT_CONFIG
1437 </dt>
1438 <dd>
1439 <p>
1440         If no <code>--file</code> option is provided to <code>git config</code>, use the file
1441         given by <code>GIT_CONFIG</code> as if it were provided via <code>--file</code>. This
1442         variable has no effect on other Git commands, and is mostly for
1443         historical compatibility; there is generally no reason to use it
1444         instead of the <code>--file</code> option.
1445 </p>
1446 </dd>
1447 </dl></div>
1448 </div>
1449 </div>
1450 <div class="sect1">
1451 <h2 id="EXAMPLES">EXAMPLES</h2>
1452 <div class="sectionbody">
1453 <div class="paragraph"><p>Given a .git/config like this:</p></div>
1454 <div class="listingblock">
1455 <div class="content">
1456 <pre><code>#
1457 # This is the config file, and
1458 # a '#' or ';' character indicates
1459 # a comment
1460 #
1461
1462 ; core variables
1463 [core]
1464         ; Don't trust file modes
1465         filemode = false
1466
1467 ; Our diff algorithm
1468 [diff]
1469         external = /usr/local/bin/diff-wrapper
1470         renames = true
1471
1472 ; Proxy settings
1473 [core]
1474         gitproxy=proxy-command for kernel.org
1475         gitproxy=default-proxy ; for all the rest
1476
1477 ; HTTP
1478 [http]
1479         sslVerify
1480 [http "https://weak.example.com"]
1481         sslVerify = false
1482         cookieFile = /tmp/cookie.txt</code></pre>
1483 </div></div>
1484 <div class="paragraph"><p>you can set the filemode to true with</p></div>
1485 <div class="listingblock">
1486 <div class="content">
1487 <pre><code>% git config core.filemode true</code></pre>
1488 </div></div>
1489 <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
1490 what URL they apply to. Here is how to change the entry for kernel.org
1491 to "ssh".</p></div>
1492 <div class="listingblock">
1493 <div class="content">
1494 <pre><code>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</code></pre>
1495 </div></div>
1496 <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
1497 <div class="paragraph"><p>To delete the entry for renames, do</p></div>
1498 <div class="listingblock">
1499 <div class="content">
1500 <pre><code>% git config --unset diff.renames</code></pre>
1501 </div></div>
1502 <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
1503 you have to provide a regex matching the value of exactly one line.</p></div>
1504 <div class="paragraph"><p>To query the value for a given key, do</p></div>
1505 <div class="listingblock">
1506 <div class="content">
1507 <pre><code>% git config --get core.filemode</code></pre>
1508 </div></div>
1509 <div class="paragraph"><p>or</p></div>
1510 <div class="listingblock">
1511 <div class="content">
1512 <pre><code>% git config core.filemode</code></pre>
1513 </div></div>
1514 <div class="paragraph"><p>or, to query a multivar:</p></div>
1515 <div class="listingblock">
1516 <div class="content">
1517 <pre><code>% git config --get core.gitproxy "for kernel.org$"</code></pre>
1518 </div></div>
1519 <div class="paragraph"><p>If you want to know all the values for a multivar, do:</p></div>
1520 <div class="listingblock">
1521 <div class="content">
1522 <pre><code>% git config --get-all core.gitproxy</code></pre>
1523 </div></div>
1524 <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
1525 new one with</p></div>
1526 <div class="listingblock">
1527 <div class="content">
1528 <pre><code>% git config --replace-all core.gitproxy ssh</code></pre>
1529 </div></div>
1530 <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy,
1531 i.e. the one without a "for &#8230;" postfix, do something like this:</p></div>
1532 <div class="listingblock">
1533 <div class="content">
1534 <pre><code>% git config core.gitproxy ssh '! for '</code></pre>
1535 </div></div>
1536 <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div>
1537 <div class="listingblock">
1538 <div class="content">
1539 <pre><code>% git config section.key value '[!]'</code></pre>
1540 </div></div>
1541 <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
1542 <div class="listingblock">
1543 <div class="content">
1544 <pre><code>% git config --add core.gitproxy '"proxy-command" for example.com'</code></pre>
1545 </div></div>
1546 <div class="paragraph"><p>An example to use customized color from the configuration in your
1547 script:</p></div>
1548 <div class="listingblock">
1549 <div class="content">
1550 <pre><code>#!/bin/sh
1551 WS=$(git config --get-color color.diff.whitespace "blue reverse")
1552 RESET=$(git config --get-color "" "reset")
1553 echo "${WS}your whitespace color or blue reverse${RESET}"</code></pre>
1554 </div></div>
1555 <div class="paragraph"><p>For URLs in <code>https://weak.example.com</code>, <code>http.sslVerify</code> is set to
1556 false, while it is set to <code>true</code> for all others:</p></div>
1557 <div class="listingblock">
1558 <div class="content">
1559 <pre><code>% git config --type=bool --get-urlmatch http.sslverify https://good.example.com
1560 true
1561 % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com
1562 false
1563 % git config --get-urlmatch http https://weak.example.com
1564 http.cookieFile /tmp/cookie.txt
1565 http.sslverify false</code></pre>
1566 </div></div>
1567 </div>
1568 </div>
1569 <div class="sect1">
1570 <h2 id="_configuration_file">CONFIGURATION FILE</h2>
1571 <div class="sectionbody">
1572 <div class="paragraph"><p>The Git configuration file contains a number of variables that affect
1573 the Git commands' behavior. The files <code>.git/config</code> and optionally
1574 <code>config.worktree</code> (see the "CONFIGURATION FILE" section of
1575 <a href="git-worktree.html">git-worktree(1)</a>) in each repository are used to store the
1576 configuration for that repository, and <code>$HOME/.gitconfig</code> is used to
1577 store a per-user configuration as fallback values for the <code>.git/config</code>
1578 file. The file <code>/etc/gitconfig</code> can be used to store a system-wide
1579 default configuration.</p></div>
1580 <div class="paragraph"><p>The configuration variables are used by both the Git plumbing
1581 and the porcelain commands. The variables are divided into sections, wherein
1582 the fully qualified variable name of the variable itself is the last
1583 dot-separated segment and the section name is everything before the last
1584 dot. The variable names are case-insensitive, allow only alphanumeric
1585 characters and <code>-</code>, and must start with an alphabetic character.  Some
1586 variables may appear multiple times; we say then that the variable is
1587 multivalued.</p></div>
1588 <div class="sect2">
1589 <h3 id="_syntax">Syntax</h3>
1590 <div class="paragraph"><p>The syntax is fairly flexible and permissive; whitespaces are mostly
1591 ignored.  The <em>#</em> and <em>;</em> characters begin comments to the end of line,
1592 blank lines are ignored.</p></div>
1593 <div class="paragraph"><p>The file consists of sections and variables.  A section begins with
1594 the name of the section in square brackets and continues until the next
1595 section begins.  Section names are case-insensitive.  Only alphanumeric
1596 characters, <code>-</code> and <code>.</code> are allowed in section names.  Each variable
1597 must belong to some section, which means that there must be a section
1598 header before the first setting of a variable.</p></div>
1599 <div class="paragraph"><p>Sections can be further divided into subsections.  To begin a subsection
1600 put its name in double quotes, separated by space from the section name,
1601 in the section header, like in the example below:</p></div>
1602 <div class="listingblock">
1603 <div class="content">
1604 <pre><code>        [section "subsection"]</code></pre>
1605 </div></div>
1606 <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
1607 newline and the null byte. Doublequote <code>"</code> and backslash can be included
1608 by escaping them as <code>\"</code> and <code>\\</code>, respectively. Backslashes preceding
1609 other characters are dropped when reading; for example, <code>\t</code> is read as
1610 <code>t</code> and <code>\0</code> is read as <code>0</code>. Section headers cannot span multiple lines.
1611 Variables may belong directly to a section or to a given subsection. You
1612 can have <code>[section]</code> if you have <code>[section "subsection"]</code>, but you don&#8217;t
1613 need to.</p></div>
1614 <div class="paragraph"><p>There is also a deprecated <code>[section.subsection]</code> syntax. With this
1615 syntax, the subsection name is converted to lower-case and is also
1616 compared case sensitively. These subsection names follow the same
1617 restrictions as section names.</p></div>
1618 <div class="paragraph"><p>All the other lines (and the remainder of the line after the section
1619 header) are recognized as setting variables, in the form
1620 <em>name = value</em> (or just <em>name</em>, which is a short-hand to say that
1621 the variable is the boolean "true").
1622 The variable names are case-insensitive, allow only alphanumeric characters
1623 and <code>-</code>, and must start with an alphabetic character.</p></div>
1624 <div class="paragraph"><p>A line that defines a value can be continued to the next line by
1625 ending it with a <code>\</code>; the backslash and the end-of-line are
1626 stripped.  Leading whitespaces after <em>name =</em>, the remainder of the
1627 line after the first comment character <em>#</em> or <em>;</em>, and trailing
1628 whitespaces of the line are discarded unless they are enclosed in
1629 double quotes.  Internal whitespaces within the value are retained
1630 verbatim.</p></div>
1631 <div class="paragraph"><p>Inside double quotes, double quote <code>"</code> and backslash <code>\</code> characters
1632 must be escaped: use <code>\"</code> for <code>"</code> and <code>\\</code> for <code>\</code>.</p></div>
1633 <div class="paragraph"><p>The following escape sequences (beside <code>\"</code> and <code>\\</code>) are recognized:
1634 <code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB)
1635 and <code>\b</code> for backspace (BS).  Other char escape sequences (including octal
1636 escape sequences) are invalid.</p></div>
1637 </div>
1638 <div class="sect2">
1639 <h3 id="_includes">Includes</h3>
1640 <div class="paragraph"><p>The <code>include</code> and <code>includeIf</code> sections allow you to include config
1641 directives from another source. These sections behave identically to
1642 each other with the exception that <code>includeIf</code> sections may be ignored
1643 if their condition does not evaluate to true; see "Conditional includes"
1644 below.</p></div>
1645 <div class="paragraph"><p>You can include a config file from another by setting the special
1646 <code>include.path</code> (or <code>includeIf.*.path</code>) variable to the name of the file
1647 to be included. The variable takes a pathname as its value, and is
1648 subject to tilde expansion. These variables can be given multiple times.</p></div>
1649 <div class="paragraph"><p>The contents of the included file are inserted immediately, as if they
1650 had been found at the location of the include directive. If the value of the
1651 variable is a relative path, the path is considered to
1652 be relative to the configuration file in which the include directive
1653 was found.  See below for examples.</p></div>
1654 </div>
1655 <div class="sect2">
1656 <h3 id="_conditional_includes">Conditional includes</h3>
1657 <div class="paragraph"><p>You can conditionally include a config file from another by setting an
1658 <code>includeIf.&lt;condition&gt;.path</code> variable to the name of the file to be
1659 included.</p></div>
1660 <div class="paragraph"><p>The condition starts with a keyword followed by a colon and some data
1661 whose format and meaning depends on the keyword. Supported keywords
1662 are:</p></div>
1663 <div class="dlist"><dl>
1664 <dt class="hdlist1">
1665 <code>gitdir</code>
1666 </dt>
1667 <dd>
1668 <p>
1669         The data that follows the keyword <code>gitdir:</code> is used as a glob
1670         pattern. If the location of the .git directory matches the
1671         pattern, the include condition is met.
1672 </p>
1673 <div class="paragraph"><p>The .git location may be auto-discovered, or come from <code>$GIT_DIR</code>
1674 environment variable. If the repository is auto-discovered via a .git
1675 file (e.g. from submodules, or a linked worktree), the .git location
1676 would be the final location where the .git directory is, not where the
1677 .git file is.</p></div>
1678 <div class="paragraph"><p>The pattern can contain standard globbing wildcards and two additional
1679 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components. Please
1680 refer to <a href="gitignore.html">gitignore(5)</a> for details. For convenience:</p></div>
1681 <div class="ulist"><ul>
1682 <li>
1683 <p>
1684 If the pattern starts with <code>~/</code>, <code>~</code> will be substituted with the
1685    content of the environment variable <code>HOME</code>.
1686 </p>
1687 </li>
1688 <li>
1689 <p>
1690 If the pattern starts with <code>./</code>, it is replaced with the directory
1691    containing the current config file.
1692 </p>
1693 </li>
1694 <li>
1695 <p>
1696 If the pattern does not start with either <code>~/</code>, <code>./</code> or <code>/</code>, <code>**/</code>
1697    will be automatically prepended. For example, the pattern <code>foo/bar</code>
1698    becomes <code>**/foo/bar</code> and would match <code>/any/path/to/foo/bar</code>.
1699 </p>
1700 </li>
1701 <li>
1702 <p>
1703 If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1704    example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it
1705    matches "foo" and everything inside, recursively.
1706 </p>
1707 </li>
1708 </ul></div>
1709 </dd>
1710 <dt class="hdlist1">
1711 <code>gitdir/i</code>
1712 </dt>
1713 <dd>
1714 <p>
1715         This is the same as <code>gitdir</code> except that matching is done
1716         case-insensitively (e.g. on case-insensitive file systems)
1717 </p>
1718 </dd>
1719 <dt class="hdlist1">
1720 <code>onbranch</code>
1721 </dt>
1722 <dd>
1723 <p>
1724         The data that follows the keyword <code>onbranch:</code> is taken to be a
1725         pattern with standard globbing wildcards and two additional
1726         ones, <code>**/</code> and <code>/**</code>, that can match multiple path components.
1727         If we are in a worktree where the name of the branch that is
1728         currently checked out matches the pattern, the include condition
1729         is met.
1730 </p>
1731 <div class="paragraph"><p>If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1732 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it matches
1733 all branches that begin with <code>foo/</code>. This is useful if your branches are
1734 organized hierarchically and you would like to apply a configuration to
1735 all the branches in that hierarchy.</p></div>
1736 </dd>
1737 <dt class="hdlist1">
1738 <code>hasconfig:remote.*.url:</code>
1739 </dt>
1740 <dd>
1741 <p>
1742         The data that follows this keyword is taken to
1743         be a pattern with standard globbing wildcards and two
1744         additional ones, <code>**/</code> and <code>/**</code>, that can match multiple
1745         components. The first time this keyword is seen, the rest of
1746         the config files will be scanned for remote URLs (without
1747         applying any values). If there exists at least one remote URL
1748         that matches this pattern, the include condition is met.
1749 </p>
1750 <div class="paragraph"><p>Files included by this option (directly or indirectly) are not allowed
1751 to contain remote URLs.</p></div>
1752 <div class="paragraph"><p>Note that unlike other includeIf conditions, resolving this condition
1753 relies on information that is not yet known at the point of reading the
1754 condition. A typical use case is this option being present as a
1755 system-level or global-level config, and the remote URL being in a
1756 local-level config; hence the need to scan ahead when resolving this
1757 condition. In order to avoid the chicken-and-egg problem in which
1758 potentially-included files can affect whether such files are potentially
1759 included, Git breaks the cycle by prohibiting these files from affecting
1760 the resolution of these conditions (thus, prohibiting them from
1761 declaring remote URLs).</p></div>
1762 <div class="paragraph"><p>As for the naming of this keyword, it is for forwards compatibility with
1763 a naming scheme that supports more variable-based include conditions,
1764 but currently Git only supports the exact keyword described above.</p></div>
1765 </dd>
1766 </dl></div>
1767 <div class="paragraph"><p>A few more notes on matching via <code>gitdir</code> and <code>gitdir/i</code>:</p></div>
1768 <div class="ulist"><ul>
1769 <li>
1770 <p>
1771 Symlinks in <code>$GIT_DIR</code> are not resolved before matching.
1772 </p>
1773 </li>
1774 <li>
1775 <p>
1776 Both the symlink &amp; realpath versions of paths will be matched
1777    outside of <code>$GIT_DIR</code>. E.g. if ~/git is a symlink to
1778    /mnt/storage/git, both <code>gitdir:~/git</code> and <code>gitdir:/mnt/storage/git</code>
1779    will match.
1780 </p>
1781 <div class="paragraph"><p>This was not the case in the initial release of this feature in
1782 v2.13.0, which only matched the realpath version. Configuration that
1783 wants to be compatible with the initial release of this feature needs
1784 to either specify only the realpath version, or both versions.</p></div>
1785 </li>
1786 <li>
1787 <p>
1788 Note that "../" is not special and will match literally, which is
1789    unlikely what you want.
1790 </p>
1791 </li>
1792 </ul></div>
1793 </div>
1794 <div class="sect2">
1795 <h3 id="_example">Example</h3>
1796 <div class="listingblock">
1797 <div class="content">
1798 <pre><code># Core variables
1799 [core]
1800         ; Don't trust file modes
1801         filemode = false
1802
1803 # Our diff algorithm
1804 [diff]
1805         external = /usr/local/bin/diff-wrapper
1806         renames = true
1807
1808 [branch "devel"]
1809         remote = origin
1810         merge = refs/heads/devel
1811
1812 # Proxy settings
1813 [core]
1814         gitProxy="ssh" for "kernel.org"
1815         gitProxy=default-proxy ; for the rest
1816
1817 [include]
1818         path = /path/to/foo.inc ; include by absolute path
1819         path = foo.inc ; find "foo.inc" relative to the current file
1820         path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
1821
1822 ; include if $GIT_DIR is /path/to/foo/.git
1823 [includeIf "gitdir:/path/to/foo/.git"]
1824         path = /path/to/foo.inc
1825
1826 ; include for all repositories inside /path/to/group
1827 [includeIf "gitdir:/path/to/group/"]
1828         path = /path/to/foo.inc
1829
1830 ; include for all repositories inside $HOME/to/group
1831 [includeIf "gitdir:~/to/group/"]
1832         path = /path/to/foo.inc
1833
1834 ; relative paths are always relative to the including
1835 ; file (if the condition is true); their location is not
1836 ; affected by the condition
1837 [includeIf "gitdir:/path/to/group/"]
1838         path = foo.inc
1839
1840 ; include only if we are in a worktree where foo-branch is
1841 ; currently checked out
1842 [includeIf "onbranch:foo-branch"]
1843         path = foo.inc
1844
1845 ; include only if a remote with the given URL exists (note
1846 ; that such a URL may be provided later in a file or in a
1847 ; file read after this file is read, as seen in this example)
1848 [includeIf "hasconfig:remote.*.url:https://example.com/**"]
1849         path = foo.inc
1850 [remote "origin"]
1851         url = https://example.com/git</code></pre>
1852 </div></div>
1853 </div>
1854 <div class="sect2">
1855 <h3 id="_values">Values</h3>
1856 <div class="paragraph"><p>Values of many variables are treated as a simple string, but there
1857 are variables that take values of specific types and there are rules
1858 as to how to spell them.</p></div>
1859 <div class="dlist"><dl>
1860 <dt class="hdlist1">
1861 boolean
1862 </dt>
1863 <dd>
1864 <p>
1865        When a variable is said to take a boolean value, many
1866        synonyms are accepted for <em>true</em> and <em>false</em>; these are all
1867        case-insensitive.
1868 </p>
1869 <div class="dlist"><dl>
1870 <dt class="hdlist1">
1871 true
1872 </dt>
1873 <dd>
1874 <p>
1875 Boolean true literals are <code>yes</code>, <code>on</code>, <code>true</code>,
1876                 and <code>1</code>.  Also, a variable defined without <code>= &lt;value&gt;</code>
1877                 is taken as true.
1878 </p>
1879 </dd>
1880 <dt class="hdlist1">
1881 false
1882 </dt>
1883 <dd>
1884 <p>
1885 Boolean false literals are <code>no</code>, <code>off</code>, <code>false</code>,
1886                 <code>0</code> and the empty string.
1887 </p>
1888 <div class="paragraph"><p>When converting a value to its canonical form using the <code>--type=bool</code> type
1889 specifier, <em>git config</em> will ensure that the output is "true" or
1890 "false" (spelled in lowercase).</p></div>
1891 </dd>
1892 </dl></div>
1893 </dd>
1894 <dt class="hdlist1">
1895 integer
1896 </dt>
1897 <dd>
1898 <p>
1899        The value for many variables that specify various sizes can
1900        be suffixed with <code>k</code>, <code>M</code>,&#8230; to mean "scale the number by
1901        1024", "by 1024x1024", etc.
1902 </p>
1903 </dd>
1904 <dt class="hdlist1">
1905 color
1906 </dt>
1907 <dd>
1908 <p>
1909        The value for a variable that takes a color is a list of
1910        colors (at most two, one for foreground and one for background)
1911        and attributes (as many as you want), separated by spaces.
1912 </p>
1913 <div class="paragraph"><p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>,
1914 <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code> and <code>default</code>.  The first
1915 color given is the foreground; the second is the background.  All the
1916 basic colors except <code>normal</code> and <code>default</code> have a bright variant that can
1917 be specified by prefixing the color with <code>bright</code>, like <code>brightred</code>.</p></div>
1918 <div class="paragraph"><p>The color <code>normal</code> makes no change to the color. It is the same as an
1919 empty string, but can be used as the foreground color when specifying a
1920 background color alone (for example, "normal red").</p></div>
1921 <div class="paragraph"><p>The color <code>default</code> explicitly resets the color to the terminal default,
1922 for example to specify a cleared background. Although it varies between
1923 terminals, this is usually not the same as setting to "white black".</p></div>
1924 <div class="paragraph"><p>Colors may also be given as numbers between 0 and 255; these use ANSI
1925 256-color mode (but note that not all terminals may support this).  If
1926 your terminal supports it, you may also specify 24-bit RGB values as
1927 hex, like <code>#ff0ab3</code>.</p></div>
1928 <div class="paragraph"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
1929 <code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters).
1930 The position of any attributes with respect to the colors
1931 (before, after, or in between), doesn&#8217;t matter. Specific attributes may
1932 be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>,
1933 <code>no-ul</code>, etc).</p></div>
1934 <div class="paragraph"><p>The pseudo-attribute <code>reset</code> resets all colors and attributes before
1935 applying the specified coloring. For example, <code>reset green</code> will result
1936 in a green foreground and default background without any active
1937 attributes.</p></div>
1938 <div class="paragraph"><p>An empty color string produces no color effect at all. This can be used
1939 to avoid coloring specific elements without disabling color entirely.</p></div>
1940 <div class="paragraph"><p>For git&#8217;s pre-defined color slots, the attributes are meant to be reset
1941 at the beginning of each item in the colored output. So setting
1942 <code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a
1943 plain <code>black</code>, even if the previous thing on the same output line (e.g.
1944 opening parenthesis before the list of branch names in <code>log --decorate</code>
1945 output) is set to be painted with <code>bold</code> or some other attribute.
1946 However, custom log formats may do more complicated and layered
1947 coloring, and the negated forms may be useful there.</p></div>
1948 </dd>
1949 <dt class="hdlist1">
1950 pathname
1951 </dt>
1952 <dd>
1953 <p>
1954         A variable that takes a pathname value can be given a
1955         string that begins with "<code>~/</code>" or "<code>~user/</code>", and the usual
1956         tilde expansion happens to such a string: <code>~/</code>
1957         is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the
1958         specified user&#8217;s home directory.
1959 </p>
1960 <div class="paragraph"><p>If a path starts with <code>%(prefix)/</code>, the remainder is interpreted as a
1961 path relative to Git&#8217;s "runtime prefix", i.e. relative to the location
1962 where Git itself was installed. For example, <code>%(prefix)/bin/</code> refers to
1963 the directory in which the Git executable itself lives. If Git was
1964 compiled without runtime prefix support, the compiled-in prefix will be
1965 substituted instead. In the unlikely event that a literal path needs to
1966 be specified that should <em>not</em> be expanded, it needs to be prefixed by
1967 <code>./</code>, like so: <code>./%(prefix)/bin</code>.</p></div>
1968 </dd>
1969 </dl></div>
1970 </div>
1971 <div class="sect2">
1972 <h3 id="_variables">Variables</h3>
1973 <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
1974 For command-specific variables, you will find a more detailed description
1975 in the appropriate manual page.</p></div>
1976 <div class="paragraph"><p>Other git-related tools may and do use their own variables.  When
1977 inventing new variables for use in your own tool, make sure their
1978 names do not conflict with those that are used by Git itself and
1979 other popular tools, and describe them in your documentation.</p></div>
1980 <div class="dlist"><dl>
1981 <dt class="hdlist1">
1982 advice.*
1983 </dt>
1984 <dd>
1985 <p>
1986         These variables control various optional help messages designed to
1987         aid new users. All <em>advice.*</em> variables default to <em>true</em>, and you
1988         can tell Git that you do not need help by setting these to <em>false</em>:
1989 </p>
1990 <div class="openblock">
1991 <div class="content">
1992 <div class="dlist"><dl>
1993 <dt class="hdlist1">
1994 ambiguousFetchRefspec
1995 </dt>
1996 <dd>
1997 <p>
1998                 Advice shown when a fetch refspec for multiple remotes maps to
1999                 the same remote-tracking branch namespace and causes branch
2000                 tracking set-up to fail.
2001 </p>
2002 </dd>
2003 <dt class="hdlist1">
2004 fetchShowForcedUpdates
2005 </dt>
2006 <dd>
2007 <p>
2008                 Advice shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
2009                 to calculate forced updates after ref updates, or to warn
2010                 that the check is disabled.
2011 </p>
2012 </dd>
2013 <dt class="hdlist1">
2014 pushUpdateRejected
2015 </dt>
2016 <dd>
2017 <p>
2018                 Set this variable to <em>false</em> if you want to disable
2019                 <em>pushNonFFCurrent</em>, <em>pushNonFFMatching</em>, <em>pushAlreadyExists</em>,
2020                 <em>pushFetchFirst</em>, <em>pushNeedsForce</em>, and <em>pushRefNeedsUpdate</em>
2021                 simultaneously.
2022 </p>
2023 </dd>
2024 <dt class="hdlist1">
2025 pushNonFFCurrent
2026 </dt>
2027 <dd>
2028 <p>
2029                 Advice shown when <a href="git-push.html">git-push(1)</a> fails due to a
2030                 non-fast-forward update to the current branch.
2031 </p>
2032 </dd>
2033 <dt class="hdlist1">
2034 pushNonFFMatching
2035 </dt>
2036 <dd>
2037 <p>
2038                 Advice shown when you ran <a href="git-push.html">git-push(1)</a> and pushed
2039                 <em>matching refs</em> explicitly (i.e. you used <em>:</em>, or
2040                 specified a refspec that isn&#8217;t your current branch) and
2041                 it resulted in a non-fast-forward error.
2042 </p>
2043 </dd>
2044 <dt class="hdlist1">
2045 pushAlreadyExists
2046 </dt>
2047 <dd>
2048 <p>
2049                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2050                 does not qualify for fast-forwarding (e.g., a tag.)
2051 </p>
2052 </dd>
2053 <dt class="hdlist1">
2054 pushFetchFirst
2055 </dt>
2056 <dd>
2057 <p>
2058                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2059                 tries to overwrite a remote ref that points at an
2060                 object we do not have.
2061 </p>
2062 </dd>
2063 <dt class="hdlist1">
2064 pushNeedsForce
2065 </dt>
2066 <dd>
2067 <p>
2068                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2069                 tries to overwrite a remote ref that points at an
2070                 object that is not a commit-ish, or make the remote
2071                 ref point at an object that is not a commit-ish.
2072 </p>
2073 </dd>
2074 <dt class="hdlist1">
2075 pushUnqualifiedRefname
2076 </dt>
2077 <dd>
2078 <p>
2079                 Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
2080                 guess based on the source and destination refs what
2081                 remote ref namespace the source belongs in, but where
2082                 we can still suggest that the user push to either
2083                 refs/heads/* or refs/tags/* based on the type of the
2084                 source object.
2085 </p>
2086 </dd>
2087 <dt class="hdlist1">
2088 pushRefNeedsUpdate
2089 </dt>
2090 <dd>
2091 <p>
2092                 Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
2093                 a branch when its remote-tracking ref has updates that we
2094                 do not have locally.
2095 </p>
2096 </dd>
2097 <dt class="hdlist1">
2098 skippedCherryPicks
2099 </dt>
2100 <dd>
2101 <p>
2102                 Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
2103                 been cherry-picked onto the upstream branch.
2104 </p>
2105 </dd>
2106 <dt class="hdlist1">
2107 statusAheadBehind
2108 </dt>
2109 <dd>
2110 <p>
2111                 Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
2112                 counts for a local ref compared to its remote tracking ref,
2113                 and that calculation takes longer than expected. Will not
2114                 appear if <code>status.aheadBehind</code> is false or the option
2115                 <code>--no-ahead-behind</code> is given.
2116 </p>
2117 </dd>
2118 <dt class="hdlist1">
2119 statusHints
2120 </dt>
2121 <dd>
2122 <p>
2123                 Show directions on how to proceed from the current
2124                 state in the output of <a href="git-status.html">git-status(1)</a>, in
2125                 the template shown when writing commit messages in
2126                 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
2127                 by <a href="git-switch.html">git-switch(1)</a> or
2128                 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.
2129 </p>
2130 </dd>
2131 <dt class="hdlist1">
2132 statusUoption
2133 </dt>
2134 <dd>
2135 <p>
2136                 Advise to consider using the <code>-u</code> option to <a href="git-status.html">git-status(1)</a>
2137                 when the command takes more than 2 seconds to enumerate untracked
2138                 files.
2139 </p>
2140 </dd>
2141 <dt class="hdlist1">
2142 commitBeforeMerge
2143 </dt>
2144 <dd>
2145 <p>
2146                 Advice shown when <a href="git-merge.html">git-merge(1)</a> refuses to
2147                 merge to avoid overwriting local changes.
2148 </p>
2149 </dd>
2150 <dt class="hdlist1">
2151 resetNoRefresh
2152 </dt>
2153 <dd>
2154 <p>
2155                 Advice to consider using the <code>--no-refresh</code> option to
2156                 <a href="git-reset.html">git-reset(1)</a> when the command takes more than 2 seconds
2157                 to refresh the index after reset.
2158 </p>
2159 </dd>
2160 <dt class="hdlist1">
2161 resolveConflict
2162 </dt>
2163 <dd>
2164 <p>
2165                 Advice shown by various commands when conflicts
2166                 prevent the operation from being performed.
2167 </p>
2168 </dd>
2169 <dt class="hdlist1">
2170 sequencerInUse
2171 </dt>
2172 <dd>
2173 <p>
2174                 Advice shown when a sequencer command is already in progress.
2175 </p>
2176 </dd>
2177 <dt class="hdlist1">
2178 implicitIdentity
2179 </dt>
2180 <dd>
2181 <p>
2182                 Advice on how to set your identity configuration when
2183                 your information is guessed from the system username and
2184                 domain name.
2185 </p>
2186 </dd>
2187 <dt class="hdlist1">
2188 detachedHead
2189 </dt>
2190 <dd>
2191 <p>
2192                 Advice shown when you used
2193                 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
2194                 to move to the detached HEAD state, to instruct how to
2195                 create a local branch after the fact.
2196 </p>
2197 </dd>
2198 <dt class="hdlist1">
2199 suggestDetachingHead
2200 </dt>
2201 <dd>
2202 <p>
2203                 Advice shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
2204                 without the explicit <code>--detach</code> option.
2205 </p>
2206 </dd>
2207 <dt class="hdlist1">
2208 checkoutAmbiguousRemoteBranchName
2209 </dt>
2210 <dd>
2211 <p>
2212                 Advice shown when the argument to
2213                 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
2214                 ambiguously resolves to a
2215                 remote tracking branch on more than one remote in
2216                 situations where an unambiguous argument would have
2217                 otherwise caused a remote-tracking branch to be
2218                 checked out. See the <code>checkout.defaultRemote</code>
2219                 configuration variable for how to set a given remote
2220                 to be used by default in some situations where this
2221                 advice would be printed.
2222 </p>
2223 </dd>
2224 <dt class="hdlist1">
2225 amWorkDir
2226 </dt>
2227 <dd>
2228 <p>
2229                 Advice that shows the location of the patch file when
2230                 <a href="git-am.html">git-am(1)</a> fails to apply it.
2231 </p>
2232 </dd>
2233 <dt class="hdlist1">
2234 rmHints
2235 </dt>
2236 <dd>
2237 <p>
2238                 In case of failure in the output of <a href="git-rm.html">git-rm(1)</a>,
2239                 show directions on how to proceed from the current state.
2240 </p>
2241 </dd>
2242 <dt class="hdlist1">
2243 addEmbeddedRepo
2244 </dt>
2245 <dd>
2246 <p>
2247                 Advice on what to do when you&#8217;ve accidentally added one
2248                 git repo inside of another.
2249 </p>
2250 </dd>
2251 <dt class="hdlist1">
2252 ignoredHook
2253 </dt>
2254 <dd>
2255 <p>
2256                 Advice shown if a hook is ignored because the hook is not
2257                 set as executable.
2258 </p>
2259 </dd>
2260 <dt class="hdlist1">
2261 waitingForEditor
2262 </dt>
2263 <dd>
2264 <p>
2265                 Print a message to the terminal whenever Git is waiting for
2266                 editor input from the user.
2267 </p>
2268 </dd>
2269 <dt class="hdlist1">
2270 nestedTag
2271 </dt>
2272 <dd>
2273 <p>
2274                 Advice shown if a user attempts to recursively tag a tag object.
2275 </p>
2276 </dd>
2277 <dt class="hdlist1">
2278 submoduleAlternateErrorStrategyDie
2279 </dt>
2280 <dd>
2281 <p>
2282                 Advice shown when a submodule.alternateErrorStrategy option
2283                 configured to "die" causes a fatal error.
2284 </p>
2285 </dd>
2286 <dt class="hdlist1">
2287 submodulesNotUpdated
2288 </dt>
2289 <dd>
2290 <p>
2291                 Advice shown when a user runs a submodule command that fails
2292                 because <code>git submodule update --init</code> was not run.
2293 </p>
2294 </dd>
2295 <dt class="hdlist1">
2296 addIgnoredFile
2297 </dt>
2298 <dd>
2299 <p>
2300                 Advice shown if a user attempts to add an ignored file to
2301                 the index.
2302 </p>
2303 </dd>
2304 <dt class="hdlist1">
2305 addEmptyPathspec
2306 </dt>
2307 <dd>
2308 <p>
2309                 Advice shown if a user runs the add command without providing
2310                 the pathspec parameter.
2311 </p>
2312 </dd>
2313 <dt class="hdlist1">
2314 updateSparsePath
2315 </dt>
2316 <dd>
2317 <p>
2318                 Advice shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
2319                 is asked to update index entries outside the current sparse
2320                 checkout.
2321 </p>
2322 </dd>
2323 <dt class="hdlist1">
2324 diverging
2325 </dt>
2326 <dd>
2327 <p>
2328                 Advice shown when a fast-forward is not possible.
2329 </p>
2330 </dd>
2331 <dt class="hdlist1">
2332 worktreeAddOrphan
2333 </dt>
2334 <dd>
2335 <p>
2336                 Advice shown when a user tries to create a worktree from an
2337                 invalid reference, to instruct how to create a new orphan
2338                 branch instead.
2339 </p>
2340 </dd>
2341 </dl></div>
2342 </div></div>
2343 </dd>
2344 <dt class="hdlist1">
2345 attr.tree
2346 </dt>
2347 <dd>
2348 <p>
2349         A reference to a tree in the repository from which to read attributes,
2350         instead of the <code>.gitattributes</code> file in the working tree. In a bare
2351         repository, this defaults to <code>HEAD:.gitattributes</code>. If the value does
2352         not resolve to a valid tree object, an empty tree is used instead.
2353         When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2354         command line option are used, this configuration variable has no effect.
2355 </p>
2356 </dd>
2357 <dt class="hdlist1">
2358 core.fileMode
2359 </dt>
2360 <dd>
2361 <p>
2362         Tells Git if the executable bit of files in the working tree
2363         is to be honored.
2364 </p>
2365 <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
2366 marked as executable is checked out, or checks out a
2367 non-executable file with executable bit on.
2368 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
2369 to see if it handles the executable bit correctly
2370 and this variable is automatically set as necessary.</p></div>
2371 <div class="paragraph"><p>A repository, however, may be on a filesystem that handles
2372 the filemode correctly, and this variable is set to <em>true</em>
2373 when created, but later may be made accessible from another
2374 environment that loses the filemode (e.g. exporting ext4 via
2375 CIFS mount, visiting a Cygwin created repository with
2376 Git for Windows or Eclipse).
2377 In such a case it may be necessary to set this variable to <em>false</em>.
2378 See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
2379 <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
2380 </dd>
2381 <dt class="hdlist1">
2382 core.hideDotFiles
2383 </dt>
2384 <dd>
2385 <p>
2386         (Windows-only) If true, mark newly-created directories and files whose
2387         name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
2388         directory is hidden, but no other files starting with a dot.  The
2389         default mode is <em>dotGitOnly</em>.
2390 </p>
2391 </dd>
2392 <dt class="hdlist1">
2393 core.ignoreCase
2394 </dt>
2395 <dd>
2396 <p>
2397         Internal variable which enables various workarounds to enable
2398         Git to work better on filesystems that are not case sensitive,
2399         like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
2400         finds "makefile" when Git expects "Makefile", Git will assume
2401         it is really the same file, and continue to remember it as
2402         "Makefile".
2403 </p>
2404 <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>
2405 will probe and set core.ignoreCase true if appropriate when the repository
2406 is created.</p></div>
2407 <div class="paragraph"><p>Git relies on the proper configuration of this variable for your operating
2408 and file system. Modifying this value may result in unexpected behavior.</p></div>
2409 </dd>
2410 <dt class="hdlist1">
2411 core.precomposeUnicode
2412 </dt>
2413 <dd>
2414 <p>
2415         This option is only used by Mac OS implementation of Git.
2416         When core.precomposeUnicode=true, Git reverts the unicode decomposition
2417         of filenames done by Mac OS. This is useful when sharing a repository
2418         between Mac OS and Linux or Windows.
2419         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
2420         When false, file names are handled fully transparent by Git,
2421         which is backward compatible with older versions of Git.
2422 </p>
2423 </dd>
2424 <dt class="hdlist1">
2425 core.protectHFS
2426 </dt>
2427 <dd>
2428 <p>
2429         If set to true, do not allow checkout of paths that would
2430         be considered equivalent to <code>.git</code> on an HFS+ filesystem.
2431         Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
2432 </p>
2433 </dd>
2434 <dt class="hdlist1">
2435 core.protectNTFS
2436 </dt>
2437 <dd>
2438 <p>
2439         If set to true, do not allow checkout of paths that would
2440         cause problems with the NTFS filesystem, e.g. conflict with
2441         8.3 "short" names.
2442         Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
2443 </p>
2444 </dd>
2445 <dt class="hdlist1">
2446 core.fsmonitor
2447 </dt>
2448 <dd>
2449 <p>
2450         If set to true, enable the built-in file system monitor
2451         daemon for this working directory (<a href="git-fsmonitor&#45;&#45;daemon.html">git-fsmonitor&#45;&#45;daemon(1)</a>).
2452 </p>
2453 <div class="paragraph"><p>Like hook-based file system monitors, the built-in file system monitor
2454 can speed up Git commands that need to refresh the Git index
2455 (e.g. <code>git status</code>) in a working directory with many files.  The
2456 built-in monitor eliminates the need to install and maintain an
2457 external third-party tool.</p></div>
2458 <div class="paragraph"><p>The built-in file system monitor is currently available only on a
2459 limited set of supported platforms.  Currently, this includes Windows
2460 and MacOS.</p></div>
2461 <div class="literalblock">
2462 <div class="content">
2463 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor"
2464 hook command.</code></pre>
2465 </div></div>
2466 <div class="paragraph"><p>This hook command is used to identify all files that may have changed
2467 since the requested date/time. This information is used to speed up
2468 git by avoiding unnecessary scanning of files that have not changed.</p></div>
2469 <div class="paragraph"><p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p></div>
2470 <div class="paragraph"><p>Note that if you concurrently use multiple versions of Git, such
2471 as one version on the command line and another version in an IDE
2472 tool, that the definition of <code>core.fsmonitor</code> was extended to
2473 allow boolean values in addition to hook pathnames.  Git versions
2474 2.35.1 and prior will not understand the boolean values and will
2475 consider the "true" or "false" values as hook pathnames to be
2476 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
2477 V2 and will fall back to no fsmonitor (full scan).  Git versions
2478 prior to 2.26 default to hook protocol V1 and will silently
2479 assume there were no changes to report (no scan), so status
2480 commands may report incomplete results.  For this reason, it is
2481 best to upgrade all of your Git versions before using the built-in
2482 file system monitor.</p></div>
2483 </dd>
2484 <dt class="hdlist1">
2485 core.fsmonitorHookVersion
2486 </dt>
2487 <dd>
2488 <p>
2489         Sets the protocol version to be used when invoking the
2490         "fsmonitor" hook.
2491 </p>
2492 <div class="paragraph"><p>There are currently versions 1 and 2. When this is not set,
2493 version 2 will be tried first and if it fails then version 1
2494 will be tried. Version 1 uses a timestamp as input to determine
2495 which files have changes since that time but some monitors
2496 like Watchman have race conditions when used with a timestamp.
2497 Version 2 uses an opaque string so that the monitor can return
2498 something that can be used to determine what files have changed
2499 without race conditions.</p></div>
2500 </dd>
2501 <dt class="hdlist1">
2502 core.trustctime
2503 </dt>
2504 <dd>
2505 <p>
2506         If false, the ctime differences between the index and the
2507         working tree are ignored; useful when the inode change time
2508         is regularly modified by something outside Git (file system
2509         crawlers and some backup systems).
2510         See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
2511 </p>
2512 </dd>
2513 <dt class="hdlist1">
2514 core.splitIndex
2515 </dt>
2516 <dd>
2517 <p>
2518         If true, the split-index feature of the index will be used.
2519         See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
2520 </p>
2521 </dd>
2522 <dt class="hdlist1">
2523 core.untrackedCache
2524 </dt>
2525 <dd>
2526 <p>
2527         Determines what to do about the untracked cache feature of the
2528         index. It will be kept, if this variable is unset or set to
2529         <code>keep</code>. It will automatically be added if set to <code>true</code>. And
2530         it will automatically be removed, if set to <code>false</code>. Before
2531         setting it to <code>true</code>, you should check that mtime is working
2532         properly on your system.
2533         See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
2534         <code>feature.manyFiles</code> is enabled which sets this setting to
2535         <code>true</code> by default.
2536 </p>
2537 </dd>
2538 <dt class="hdlist1">
2539 core.checkStat
2540 </dt>
2541 <dd>
2542 <p>
2543         When missing or is set to <code>default</code>, many fields in the stat
2544         structure are checked to detect if a file has been modified
2545         since Git looked at it.  When this configuration variable is
2546         set to <code>minimal</code>, sub-second part of mtime and ctime, the
2547         uid and gid of the owner of the file, the inode number (and
2548         the device number, if Git was compiled to use it), are
2549         excluded from the check among these fields, leaving only the
2550         whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
2551         is set) and the filesize to be checked.
2552 </p>
2553 <div class="paragraph"><p>There are implementations of Git that do not leave usable values in
2554 some fields (e.g. JGit); by excluding these fields from the
2555 comparison, the <code>minimal</code> mode may help interoperability when the
2556 same repository is used by these other systems at the same time.</p></div>
2557 </dd>
2558 <dt class="hdlist1">
2559 core.quotePath
2560 </dt>
2561 <dd>
2562 <p>
2563         Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
2564         quote "unusual" characters in the pathname by enclosing the
2565         pathname in double-quotes and escaping those characters with
2566         backslashes in the same way C escapes control characters (e.g.
2567         <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
2568         values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
2569         UTF-8).  If this variable is set to false, bytes higher than
2570         0x80 are not considered "unusual" any more. Double-quotes,
2571         backslash and control characters are always escaped regardless
2572         of the setting of this variable.  A simple space character is
2573         not considered "unusual".  Many commands can output pathnames
2574         completely verbatim using the <code>-z</code> option. The default value
2575         is true.
2576 </p>
2577 </dd>
2578 <dt class="hdlist1">
2579 core.eol
2580 </dt>
2581 <dd>
2582 <p>
2583         Sets the line ending type to use in the working directory for
2584         files that are marked as text (either by having the <code>text</code>
2585         attribute set, or by having <code>text=auto</code> and Git auto-detecting
2586         the contents as text).
2587         Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
2588         native line ending.  The default value is <code>native</code>.  See
2589         <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
2590         conversion. Note that this value is ignored if <code>core.autocrlf</code>
2591         is set to <code>true</code> or <code>input</code>.
2592 </p>
2593 </dd>
2594 <dt class="hdlist1">
2595 core.safecrlf
2596 </dt>
2597 <dd>
2598 <p>
2599         If true, makes Git check if converting <code>CRLF</code> is reversible when
2600         end-of-line conversion is active.  Git will verify if a command
2601         modifies a file in the work tree either directly or indirectly.
2602         For example, committing a file followed by checking out the
2603         same file should yield the original file in the work tree.  If
2604         this is not the case for the current setting of
2605         <code>core.autocrlf</code>, Git will reject the file.  The variable can
2606         be set to "warn", in which case Git will only warn about an
2607         irreversible conversion but continue the operation.
2608 </p>
2609 <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
2610 When it is enabled, Git will convert CRLF to LF during commit and LF to
2611 CRLF during checkout.  A file that contains a mixture of LF and
2612 CRLF before the commit cannot be recreated by Git.  For text
2613 files this is the right thing to do: it corrects line endings
2614 such that we have only LF line endings in the repository.
2615 But for binary files that are accidentally classified as text the
2616 conversion can corrupt data.</p></div>
2617 <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
2618 setting the conversion type explicitly in .gitattributes.  Right
2619 after committing you still have the original file in your work
2620 tree and this file is not yet corrupted.  You can explicitly tell
2621 Git that this file is binary and Git will handle the file
2622 appropriately.</p></div>
2623 <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
2624 mixed line endings and the undesired effect of corrupting binary
2625 files cannot be distinguished.  In both cases CRLFs are removed
2626 in an irreversible way.  For text files this is the right thing
2627 to do because CRLFs are line endings, while for binary files
2628 converting CRLFs corrupts data.</p></div>
2629 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
2630 file identical to the original file for a different setting of
2631 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
2632 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
2633 and could later be checked out with <code>core.eol=crlf</code>, in which case the
2634 resulting file would contain <code>CRLF</code>, although the original file
2635 contained <code>LF</code>.  However, in both work trees the line endings would be
2636 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
2637 file with mixed line endings would be reported by the <code>core.safecrlf</code>
2638 mechanism.</p></div>
2639 </dd>
2640 <dt class="hdlist1">
2641 core.autocrlf
2642 </dt>
2643 <dd>
2644 <p>
2645         Setting this variable to "true" is the same as setting
2646         the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
2647         Set to true if you want to have <code>CRLF</code> line endings in your
2648         working directory and the repository has LF line endings.
2649         This variable can be set to <em>input</em>,
2650         in which case no output conversion is performed.
2651 </p>
2652 </dd>
2653 <dt class="hdlist1">
2654 core.checkRoundtripEncoding
2655 </dt>
2656 <dd>
2657 <p>
2658         A comma and/or whitespace separated list of encodings that Git
2659         performs UTF-8 round trip checks on if they are used in an
2660         <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
2661         The default value is <code>SHIFT-JIS</code>.
2662 </p>
2663 </dd>
2664 <dt class="hdlist1">
2665 core.symlinks
2666 </dt>
2667 <dd>
2668 <p>
2669         If false, symbolic links are checked out as small plain files that
2670         contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
2671         <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
2672         file. Useful on filesystems like FAT that do not support
2673         symbolic links.
2674 </p>
2675 <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>
2676 will probe and set core.symlinks false if appropriate when the repository
2677 is created.</p></div>
2678 </dd>
2679 <dt class="hdlist1">
2680 core.gitProxy
2681 </dt>
2682 <dd>
2683 <p>
2684         A "proxy command" to execute (as <em>command host port</em>) instead
2685         of establishing direct connection to the remote server when
2686         using the Git protocol for fetching. If the variable value is
2687         in the "COMMAND for DOMAIN" format, the command is applied only
2688         on hostnames ending with the specified domain string. This variable
2689         may be set multiple times and is matched in the given order;
2690         the first match wins.
2691 </p>
2692 <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
2693 (which always applies universally, without the special "for"
2694 handling).</p></div>
2695 <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
2696 specify that no proxy be used for a given domain pattern.
2697 This is useful for excluding servers inside a firewall from
2698 proxy use, while defaulting to a common proxy for external domains.</p></div>
2699 </dd>
2700 <dt class="hdlist1">
2701 core.sshCommand
2702 </dt>
2703 <dd>
2704 <p>
2705         If this variable is set, <code>git fetch</code> and <code>git push</code> will
2706         use the specified command instead of <code>ssh</code> when they need to
2707         connect to a remote system. The command is in the same form as
2708         the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
2709         when the environment variable is set.
2710 </p>
2711 </dd>
2712 <dt class="hdlist1">
2713 core.ignoreStat
2714 </dt>
2715 <dd>
2716 <p>
2717         If true, Git will avoid using lstat() calls to detect if files have
2718         changed by setting the "assume-unchanged" bit for those tracked files
2719         which it has updated identically in both the index and working tree.
2720 </p>
2721 <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
2722 the modified files explicitly (e.g. see <em>Examples</em> section in
2723 <a href="git-update-index.html">git-update-index(1)</a>).
2724 Git will not normally detect changes to those files.</p></div>
2725 <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
2726 CIFS/Microsoft Windows.</p></div>
2727 <div class="paragraph"><p>False by default.</p></div>
2728 </dd>
2729 <dt class="hdlist1">
2730 core.preferSymlinkRefs
2731 </dt>
2732 <dd>
2733 <p>
2734         Instead of the default "symref" format for HEAD
2735         and other symbolic reference files, use symbolic links.
2736         This is sometimes needed to work with old scripts that
2737         expect HEAD to be a symbolic link.
2738 </p>
2739 </dd>
2740 <dt class="hdlist1">
2741 core.alternateRefsCommand
2742 </dt>
2743 <dd>
2744 <p>
2745         When advertising tips of available history from an alternate, use the shell to
2746         execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
2747         first argument is the absolute path of the alternate. Output must contain one
2748         hex object id per line (i.e., the same as produced by <code>git for-each-ref
2749         --format='%(objectname)'</code>).
2750 </p>
2751 <div class="paragraph"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
2752 value, as it does not take a repository path as an argument (but you can wrap
2753 the command above in a shell script).</p></div>
2754 </dd>
2755 <dt class="hdlist1">
2756 core.alternateRefsPrefixes
2757 </dt>
2758 <dd>
2759 <p>
2760         When listing references from an alternate, list only references that begin
2761         with the given prefix. Prefixes match as if they were given as arguments to
2762         <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
2763         whitespace. If <code>core.alternateRefsCommand</code> is set, setting
2764         <code>core.alternateRefsPrefixes</code> has no effect.
2765 </p>
2766 </dd>
2767 <dt class="hdlist1">
2768 core.bare
2769 </dt>
2770 <dd>
2771 <p>
2772         If true this repository is assumed to be <em>bare</em> and has no
2773         working directory associated with it.  If this is the case a
2774         number of commands that require a working directory will be
2775         disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
2776 </p>
2777 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
2778 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
2779 repository that ends in "/.git" is assumed to be not bare (bare =
2780 false), while all other repositories are assumed to be bare (bare
2781 = true).</p></div>
2782 </dd>
2783 <dt class="hdlist1">
2784 core.worktree
2785 </dt>
2786 <dd>
2787 <p>
2788         Set the path to the root of the working tree.
2789         If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
2790         is ignored and not used for determining the root of working tree.
2791         This can be overridden by the <code>GIT_WORK_TREE</code> environment
2792         variable and the <code>--work-tree</code> command-line option.
2793         The value can be an absolute path or relative to the path to
2794         the .git directory, which is either specified by --git-dir
2795         or GIT_DIR, or automatically discovered.
2796         If --git-dir or GIT_DIR is specified but none of
2797         --work-tree, GIT_WORK_TREE and core.worktree is specified,
2798         the current working directory is regarded as the top level
2799         of your working tree.
2800 </p>
2801 <div class="paragraph"><p>Note that this variable is honored even when set in a configuration
2802 file in a ".git" subdirectory of a directory and its value differs
2803 from the latter directory (e.g. "/path/to/.git/config" has
2804 core.worktree set to "/different/path"), which is most likely a
2805 misconfiguration.  Running Git commands in the "/path/to" directory will
2806 still use "/different/path" as the root of the work tree and can cause
2807 confusion unless you know what you are doing (e.g. you are creating a
2808 read-only snapshot of the same index to a location different from the
2809 repository&#8217;s usual working tree).</p></div>
2810 </dd>
2811 <dt class="hdlist1">
2812 core.logAllRefUpdates
2813 </dt>
2814 <dd>
2815 <p>
2816         Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
2817         "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
2818         SHA-1, the date/time and the reason of the update, but
2819         only when the file exists.  If this configuration
2820         variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
2821         file is automatically created for branch heads (i.e. under
2822         <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
2823         note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
2824         If it is set to <code>always</code>, then a missing reflog is automatically
2825         created for any ref under <code>refs/</code>.
2826 </p>
2827 <div class="paragraph"><p>This information can be used to determine what commit
2828 was the tip of a branch "2 days ago".</p></div>
2829 <div class="paragraph"><p>This value is true by default in a repository that has
2830 a working directory associated with it, and false by
2831 default in a bare repository.</p></div>
2832 </dd>
2833 <dt class="hdlist1">
2834 core.repositoryFormatVersion
2835 </dt>
2836 <dd>
2837 <p>
2838         Internal variable identifying the repository format and layout
2839         version.
2840 </p>
2841 </dd>
2842 <dt class="hdlist1">
2843 core.sharedRepository
2844 </dt>
2845 <dd>
2846 <p>
2847         When <em>group</em> (or <em>true</em>), the repository is made shareable between
2848         several users in a group (making sure all the files and objects are
2849         group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
2850         repository will be readable by all users, additionally to being
2851         group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
2852         reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
2853         files in the repository will have this mode value. <em>0xxx</em> will override
2854         user&#8217;s umask value (whereas the other options will only override
2855         requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
2856         the repo read/write-able for the owner and group, but inaccessible to
2857         others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
2858         repository that is group-readable but not group-writable.
2859         See <a href="git-init.html">git-init(1)</a>. False by default.
2860 </p>
2861 </dd>
2862 <dt class="hdlist1">
2863 core.warnAmbiguousRefs
2864 </dt>
2865 <dd>
2866 <p>
2867         If true, Git will warn you if the ref name you passed it is ambiguous
2868         and might match multiple refs in the repository. True by default.
2869 </p>
2870 </dd>
2871 <dt class="hdlist1">
2872 core.compression
2873 </dt>
2874 <dd>
2875 <p>
2876         An integer -1..9, indicating a default compression level.
2877         -1 is the zlib default. 0 means no compression,
2878         and 1..9 are various speed/size tradeoffs, 9 being slowest.
2879         If set, this provides a default to other compression variables,
2880         such as <code>core.looseCompression</code> and <code>pack.compression</code>.
2881 </p>
2882 </dd>
2883 <dt class="hdlist1">
2884 core.looseCompression
2885 </dt>
2886 <dd>
2887 <p>
2888         An integer -1..9, indicating the compression level for objects that
2889         are not in a pack file. -1 is the zlib default. 0 means no
2890         compression, and 1..9 are various speed/size tradeoffs, 9 being
2891         slowest.  If not set,  defaults to core.compression.  If that is
2892         not set,  defaults to 1 (best speed).
2893 </p>
2894 </dd>
2895 <dt class="hdlist1">
2896 core.packedGitWindowSize
2897 </dt>
2898 <dd>
2899 <p>
2900         Number of bytes of a pack file to map into memory in a
2901         single mapping operation.  Larger window sizes may allow
2902         your system to process a smaller number of large pack files
2903         more quickly.  Smaller window sizes will negatively affect
2904         performance due to increased calls to the operating system&#8217;s
2905         memory manager, but may improve performance when accessing
2906         a large number of large pack files.
2907 </p>
2908 <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
2909 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
2910 be reasonable for all users/operating systems.  You probably do
2911 not need to adjust this value.</p></div>
2912 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2913 </dd>
2914 <dt class="hdlist1">
2915 core.packedGitLimit
2916 </dt>
2917 <dd>
2918 <p>
2919         Maximum number of bytes to map simultaneously into memory
2920         from pack files.  If Git needs to access more than this many
2921         bytes at once to complete an operation it will unmap existing
2922         regions to reclaim virtual address space within the process.
2923 </p>
2924 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
2925 unlimited) on 64 bit platforms.
2926 This should be reasonable for all users/operating systems, except on
2927 the largest projects.  You probably do not need to adjust this value.</p></div>
2928 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2929 </dd>
2930 <dt class="hdlist1">
2931 core.deltaBaseCacheLimit
2932 </dt>
2933 <dd>
2934 <p>
2935         Maximum number of bytes per thread to reserve for caching base objects
2936         that may be referenced by multiple deltified objects.  By storing the
2937         entire decompressed base objects in a cache Git is able
2938         to avoid unpacking and decompressing frequently used base
2939         objects multiple times.
2940 </p>
2941 <div class="paragraph"><p>Default is 96 MiB on all platforms.  This should be reasonable
2942 for all users/operating systems, except on the largest projects.
2943 You probably do not need to adjust this value.</p></div>
2944 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2945 </dd>
2946 <dt class="hdlist1">
2947 core.bigFileThreshold
2948 </dt>
2949 <dd>
2950 <p>
2951         The size of files considered "big", which as discussed below
2952         changes the behavior of numerous git commands, as well as how
2953         such files are stored within the repository. The default is
2954         512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
2955         supported.
2956 </p>
2957 <div class="paragraph"><p>Files above the configured limit will be:</p></div>
2958 <div class="ulist"><ul>
2959 <li>
2960 <p>
2961 Stored deflated in packfiles, without attempting delta compression.
2962 </p>
2963 <div class="paragraph"><p>The default limit is primarily set with this use-case in mind. With it,
2964 most projects will have their source code and other text files delta
2965 compressed, but not larger binary media files.</p></div>
2966 <div class="paragraph"><p>Storing large files without delta compression avoids excessive memory
2967 usage, at the slight expense of increased disk usage.</p></div>
2968 </li>
2969 <li>
2970 <p>
2971 Will be treated as if they were labeled "binary" (see
2972   <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
2973   <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.
2974 </p>
2975 </li>
2976 <li>
2977 <p>
2978 Will generally be streamed when written, which avoids excessive
2979 memory usage, at the cost of some fixed overhead. Commands that make
2980 use of this include <a href="git-archive.html">git-archive(1)</a>,
2981 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
2982 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.
2983 </p>
2984 </li>
2985 </ul></div>
2986 </dd>
2987 <dt class="hdlist1">
2988 core.excludesFile
2989 </dt>
2990 <dd>
2991 <p>
2992         Specifies the pathname to the file that contains patterns to
2993         describe paths that are not meant to be tracked, in addition
2994         to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
2995         Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
2996         If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
2997         is used instead. See <a href="gitignore.html">gitignore(5)</a>.
2998 </p>
2999 </dd>
3000 <dt class="hdlist1">
3001 core.askPass
3002 </dt>
3003 <dd>
3004 <p>
3005         Some commands (e.g. svn and http interfaces) that interactively
3006         ask for a password can be told to use an external program given
3007         via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
3008         environment variable. If not set, fall back to the value of the
3009         <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
3010         prompt. The external program shall be given a suitable prompt as
3011         command-line argument and write the password on its STDOUT.
3012 </p>
3013 </dd>
3014 <dt class="hdlist1">
3015 core.attributesFile
3016 </dt>
3017 <dd>
3018 <p>
3019         In addition to <code>.gitattributes</code> (per-directory) and
3020         <code>.git/info/attributes</code>, Git looks into this file for attributes
3021         (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
3022         way as for <code>core.excludesFile</code>. Its default value is
3023         <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
3024         set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
3025 </p>
3026 </dd>
3027 <dt class="hdlist1">
3028 core.hooksPath
3029 </dt>
3030 <dd>
3031 <p>
3032         By default Git will look for your hooks in the
3033         <code>$GIT_DIR/hooks</code> directory. Set this to different path,
3034         e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
3035         that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
3036         in <code>$GIT_DIR/hooks/pre-receive</code>.
3037 </p>
3038 <div class="paragraph"><p>The path can be either absolute or relative. A relative path is
3039 taken as relative to the directory where the hooks are run (see
3040 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
3041 <div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
3042 centrally configure your Git hooks instead of configuring them on a
3043 per-repository basis, or as a more flexible and centralized
3044 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
3045 default hooks.</p></div>
3046 </dd>
3047 <dt class="hdlist1">
3048 core.editor
3049 </dt>
3050 <dd>
3051 <p>
3052         Commands such as <code>commit</code> and <code>tag</code> that let you edit
3053         messages by launching an editor use the value of this
3054         variable when it is set, and the environment variable
3055         <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.
3056 </p>
3057 </dd>
3058 <dt class="hdlist1">
3059 core.commentChar
3060 </dt>
3061 <dd>
3062 <p>
3063         Commands such as <code>commit</code> and <code>tag</code> that let you edit
3064         messages consider a line that begins with this character
3065         commented, and removes them after the editor returns
3066         (default <em>#</em>).
3067 </p>
3068 <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
3069 the beginning character of any line in existing commit messages.</p></div>
3070 </dd>
3071 <dt class="hdlist1">
3072 core.filesRefLockTimeout
3073 </dt>
3074 <dd>
3075 <p>
3076         The length of time, in milliseconds, to retry when trying to
3077         lock an individual reference. Value 0 means not to retry at
3078         all; -1 means to try indefinitely. Default is 100 (i.e.,
3079         retry for 100ms).
3080 </p>
3081 </dd>
3082 <dt class="hdlist1">
3083 core.packedRefsTimeout
3084 </dt>
3085 <dd>
3086 <p>
3087         The length of time, in milliseconds, to retry when trying to
3088         lock the <code>packed-refs</code> file. Value 0 means not to retry at
3089         all; -1 means to try indefinitely. Default is 1000 (i.e.,
3090         retry for 1 second).
3091 </p>
3092 </dd>
3093 <dt class="hdlist1">
3094 core.pager
3095 </dt>
3096 <dd>
3097 <p>
3098         Text viewer for use by Git commands (e.g., <em>less</em>).  The value
3099         is meant to be interpreted by the shell.  The order of preference
3100         is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
3101         configuration, then <code>$PAGER</code>, and then the default chosen at
3102         compile time (usually <em>less</em>).
3103 </p>
3104 <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
3105 (if <code>LESS</code> environment variable is set, Git does not change it at
3106 all).  If you want to selectively override Git&#8217;s default setting
3107 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
3108 be passed to the shell by Git, which will translate the final
3109 command to <code>LESS=FRX less -S</code>. The environment does not set the
3110 <code>S</code> option but the command line does, instructing less to truncate
3111 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
3112 deactivate the <code>F</code> option specified by the environment from the
3113 command-line, deactivating the "quit if one screen" behavior of
3114 <code>less</code>.  One can specifically activate some flags for particular
3115 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
3116 line truncation only for <code>git blame</code>.</p></div>
3117 <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
3118 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
3119 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
3120 </dd>
3121 <dt class="hdlist1">
3122 core.whitespace
3123 </dt>
3124 <dd>
3125 <p>
3126         A comma separated list of common whitespace problems to
3127         notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
3128         highlight them, and <em>git apply --whitespace=error</em> will
3129         consider them as errors.  You can prefix <code>-</code> to disable
3130         any of them (e.g. <code>-trailing-space</code>):
3131 </p>
3132 <div class="ulist"><ul>
3133 <li>
3134 <p>
3135 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
3136   as an error (enabled by default).
3137 </p>
3138 </li>
3139 <li>
3140 <p>
3141 <code>space-before-tab</code> treats a space character that appears immediately
3142   before a tab character in the initial indent part of the line as an
3143   error (enabled by default).
3144 </p>
3145 </li>
3146 <li>
3147 <p>
3148 <code>indent-with-non-tab</code> treats a line that is indented with space
3149   characters instead of the equivalent tabs as an error (not enabled by
3150   default).
3151 </p>
3152 </li>
3153 <li>
3154 <p>
3155 <code>tab-in-indent</code> treats a tab character in the initial indent part of
3156   the line as an error (not enabled by default).
3157 </p>
3158 </li>
3159 <li>
3160 <p>
3161 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
3162   (enabled by default).
3163 </p>
3164 </li>
3165 <li>
3166 <p>
3167 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
3168   <code>blank-at-eof</code>.
3169 </p>
3170 </li>
3171 <li>
3172 <p>
3173 <code>cr-at-eol</code> treats a carriage-return at the end of line as
3174   part of the line terminator, i.e. with it, <code>trailing-space</code>
3175   does not trigger if the character before such a carriage-return
3176   is not a whitespace (not enabled by default).
3177 </p>
3178 </li>
3179 <li>
3180 <p>
3181 <code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
3182   is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
3183   errors. The default tab width is 8. Allowed values are 1 to 63.
3184 </p>
3185 </li>
3186 </ul></div>
3187 </dd>
3188 <dt class="hdlist1">
3189 core.fsync
3190 </dt>
3191 <dd>
3192 <p>
3193         A comma-separated list of components of the repository that
3194         should be hardened via the core.fsyncMethod when created or
3195         modified.  You can disable hardening of any component by
3196         prefixing it with a <em>-</em>.  Items that are not hardened may be
3197         lost in the event of an unclean system shutdown. Unless you
3198         have special requirements, it is recommended that you leave
3199         this option empty or pick one of <code>committed</code>, <code>added</code>,
3200         or <code>all</code>.
3201 </p>
3202 <div class="paragraph"><p>When this configuration is encountered, the set of components starts with
3203 the platform default value, disabled components are removed, and additional
3204 components are added. <code>none</code> resets the state so that the platform default
3205 is ignored.</p></div>
3206 <div class="paragraph"><p>The empty string resets the fsync configuration to the platform
3207 default. The default on most platforms is equivalent to
3208 <code>core.fsync=committed,-loose-object</code>, which has good performance,
3209 but risks losing recent work in the event of an unclean system shutdown.</p></div>
3210 <div class="ulist"><ul>
3211 <li>
3212 <p>
3213 <code>none</code> clears the set of fsynced components.
3214 </p>
3215 </li>
3216 <li>
3217 <p>
3218 <code>loose-object</code> hardens objects added to the repo in loose-object form.
3219 </p>
3220 </li>
3221 <li>
3222 <p>
3223 <code>pack</code> hardens objects added to the repo in packfile form.
3224 </p>
3225 </li>
3226 <li>
3227 <p>
3228 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
3229 </p>
3230 </li>
3231 <li>
3232 <p>
3233 <code>commit-graph</code> hardens the commit-graph file.
3234 </p>
3235 </li>
3236 <li>
3237 <p>
3238 <code>index</code> hardens the index when it is modified.
3239 </p>
3240 </li>
3241 <li>
3242 <p>
3243 <code>objects</code> is an aggregate option that is equivalent to
3244   <code>loose-object,pack</code>.
3245 </p>
3246 </li>
3247 <li>
3248 <p>
3249 <code>reference</code> hardens references modified in the repo.
3250 </p>
3251 </li>
3252 <li>
3253 <p>
3254 <code>derived-metadata</code> is an aggregate option that is equivalent to
3255   <code>pack-metadata,commit-graph</code>.
3256 </p>
3257 </li>
3258 <li>
3259 <p>
3260 <code>committed</code> is an aggregate option that is currently equivalent to
3261   <code>objects</code>. This mode sacrifices some performance to ensure that work
3262   that is committed to the repository with <code>git commit</code> or similar commands
3263   is hardened.
3264 </p>
3265 </li>
3266 <li>
3267 <p>
3268 <code>added</code> is an aggregate option that is currently equivalent to
3269   <code>committed,index</code>. This mode sacrifices additional performance to
3270   ensure that the results of commands like <code>git add</code> and similar operations
3271   are hardened.
3272 </p>
3273 </li>
3274 <li>
3275 <p>
3276 <code>all</code> is an aggregate option that syncs all individual components above.
3277 </p>
3278 </li>
3279 </ul></div>
3280 </dd>
3281 <dt class="hdlist1">
3282 core.fsyncMethod
3283 </dt>
3284 <dd>
3285 <p>
3286         A value indicating the strategy Git will use to harden repository data
3287         using fsync and related primitives.
3288 </p>
3289 <div class="ulist"><ul>
3290 <li>
3291 <p>
3292 <code>fsync</code> uses the fsync() system call or platform equivalents.
3293 </p>
3294 </li>
3295 <li>
3296 <p>
3297 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
3298   filesystem and storage hardware, data added to the repository may not be
3299   durable in the event of a system crash. This is the default mode on macOS.
3300 </p>
3301 </li>
3302 <li>
3303 <p>
3304 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
3305   updates in the disk writeback cache and then does a single full fsync of
3306   a dummy file to trigger the disk cache flush at the end of the operation.
3307 </p>
3308 <div class="paragraph"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
3309 data is made durable as if <code>fsync</code> was specified. This mode is expected to
3310 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
3311 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
3312 </li>
3313 </ul></div>
3314 </dd>
3315 <dt class="hdlist1">
3316 core.fsyncObjectFiles
3317 </dt>
3318 <dd>
3319 <p>
3320         This boolean will enable <em>fsync()</em> when writing object files.
3321         This setting is deprecated. Use core.fsync instead.
3322 </p>
3323 <div class="paragraph"><p>This setting affects data added to the Git repository in loose-object
3324 form. When set to true, Git will issue an fsync or similar system call
3325 to flush caches so that loose-objects remain consistent in the face
3326 of a unclean system shutdown.</p></div>
3327 </dd>
3328 <dt class="hdlist1">
3329 core.preloadIndex
3330 </dt>
3331 <dd>
3332 <p>
3333         Enable parallel index preload for operations like <em>git diff</em>
3334 </p>
3335 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
3336 on filesystems like NFS that have weak caching semantics and thus
3337 relatively high IO latencies.  When enabled, Git will do the
3338 index comparison to the filesystem data in parallel, allowing
3339 overlapping IO&#8217;s.  Defaults to true.</p></div>
3340 </dd>
3341 <dt class="hdlist1">
3342 core.unsetenvvars
3343 </dt>
3344 <dd>
3345 <p>
3346         Windows-only: comma-separated list of environment variables'
3347         names that need to be unset before spawning any other process.
3348         Defaults to <code>PERL5LIB</code> to account for the fact that Git for
3349         Windows insists on using its own Perl interpreter.
3350 </p>
3351 </dd>
3352 <dt class="hdlist1">
3353 core.restrictinheritedhandles
3354 </dt>
3355 <dd>
3356 <p>
3357         Windows-only: override whether spawned processes inherit only standard
3358         file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
3359         <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
3360         Windows 7 and later, and <code>false</code> on older Windows versions.
3361 </p>
3362 </dd>
3363 <dt class="hdlist1">
3364 core.createObject
3365 </dt>
3366 <dd>
3367 <p>
3368         You can set this to <em>link</em>, in which case a hardlink followed by
3369         a delete of the source are used to make sure that object creation
3370         will not overwrite existing objects.
3371 </p>
3372 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
3373 Set this config setting to <em>rename</em> there; However, This will remove the
3374 check that makes sure that existing object files will not get overwritten.</p></div>
3375 </dd>
3376 <dt class="hdlist1">
3377 core.notesRef
3378 </dt>
3379 <dd>
3380 <p>
3381         When showing commit messages, also show notes which are stored in
3382         the given ref.  The ref must be fully qualified.  If the given
3383         ref does not exist, it is not an error but means that no
3384         notes should be printed.
3385 </p>
3386 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
3387 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p></div>
3388 </dd>
3389 <dt class="hdlist1">
3390 core.commitGraph
3391 </dt>
3392 <dd>
3393 <p>
3394         If true, then git will read the commit-graph file (if it exists)
3395         to parse the graph structure of commits. Defaults to true. See
3396         <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
3397 </p>
3398 </dd>
3399 <dt class="hdlist1">
3400 core.useReplaceRefs
3401 </dt>
3402 <dd>
3403 <p>
3404         If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
3405         option was given on the command line. See <a href="git.html">git(1)</a> and
3406         <a href="git-replace.html">git-replace(1)</a> for more information.
3407 </p>
3408 </dd>
3409 <dt class="hdlist1">
3410 core.multiPackIndex
3411 </dt>
3412 <dd>
3413 <p>
3414         Use the multi-pack-index file to track multiple packfiles using a
3415         single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
3416         information. Defaults to true.
3417 </p>
3418 </dd>
3419 <dt class="hdlist1">
3420 core.sparseCheckout
3421 </dt>
3422 <dd>
3423 <p>
3424         Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
3425         for more information.
3426 </p>
3427 </dd>
3428 <dt class="hdlist1">
3429 core.sparseCheckoutCone
3430 </dt>
3431 <dd>
3432 <p>
3433         Enables the "cone mode" of the sparse checkout feature. When the
3434         sparse-checkout file contains a limited set of patterns, this
3435         mode provides significant performance advantages. The "non-cone
3436         mode" can be requested to allow specifying more flexible
3437         patterns by setting this variable to <em>false</em>. See
3438         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.
3439 </p>
3440 </dd>
3441 <dt class="hdlist1">
3442 core.abbrev
3443 </dt>
3444 <dd>
3445 <p>
3446         Set the length object names are abbreviated to.  If
3447         unspecified or set to "auto", an appropriate value is
3448         computed based on the approximate number of packed objects
3449         in your repository, which hopefully is enough for
3450         abbreviated object names to stay unique for some time.
3451         If set to "no", no abbreviation is made and the object names
3452         are shown in their full length.
3453         The minimum length is 4.
3454 </p>
3455 </dd>
3456 <dt class="hdlist1">
3457 core.maxTreeDepth
3458 </dt>
3459 <dd>
3460 <p>
3461         The maximum depth Git is willing to recurse while traversing a
3462         tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
3463         to allow Git to abort cleanly, and should not generally need to
3464         be adjusted. The default is 4096.
3465 </p>
3466 </dd>
3467 <dt class="hdlist1">
3468 add.ignoreErrors
3469 </dt>
3470 <dt class="hdlist1">
3471 add.ignore-errors (deprecated)
3472 </dt>
3473 <dd>
3474 <p>
3475         Tells <em>git add</em> to continue adding files when some files cannot be
3476         added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
3477         option of <a href="git-add.html">git-add(1)</a>.  <code>add.ignore-errors</code> is deprecated,
3478         as it does not follow the usual naming convention for configuration
3479         variables.
3480 </p>
3481 </dd>
3482 <dt class="hdlist1">
3483 add.interactive.useBuiltin
3484 </dt>
3485 <dd>
3486 <p>
3487         Unused configuration variable. Used in Git versions v2.25.0 to
3488         v2.36.0 to enable the built-in version of <a href="git-add.html">git-add(1)</a>'s
3489         interactive mode, which then became the default in Git
3490         versions v2.37.0 to v2.39.0.
3491 </p>
3492 </dd>
3493 <dt class="hdlist1">
3494 alias.*
3495 </dt>
3496 <dd>
3497 <p>
3498         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
3499         after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
3500         <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
3501         confusion and troubles with script usage, aliases that
3502         hide existing Git commands are ignored. Arguments are split by
3503         spaces, the usual shell quoting and escaping are supported.
3504         A quote pair or a backslash can be used to quote them.
3505 </p>
3506 <div class="paragraph"><p>Note that the first word of an alias does not necessarily have to be a
3507 command. It can be a command-line option that will be passed into the
3508 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
3509 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
3510 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
3511 running <code>git loud-rebase</code> would be equivalent to
3512 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
3513 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
3514 where the original command does not.</p></div>
3515 <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
3516 it will be treated as a shell command.  For example, defining
3517 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
3518 <code>git new</code> is equivalent to running the shell command
3519 <code>gitk --all --not ORIG_HEAD</code>.  Note that shell commands will be
3520 executed from the top-level directory of a repository, which may
3521 not necessarily be the current directory.
3522 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
3523 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
3524 </dd>
3525 <dt class="hdlist1">
3526 am.keepcr
3527 </dt>
3528 <dd>
3529 <p>
3530         If true, git-am will call git-mailsplit for patches in mbox format
3531         with parameter <code>--keep-cr</code>. In this case git-mailsplit will
3532         not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
3533         by giving <code>--no-keep-cr</code> from the command line.
3534         See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
3535 </p>
3536 </dd>
3537 <dt class="hdlist1">
3538 am.threeWay
3539 </dt>
3540 <dd>
3541 <p>
3542         By default, <code>git am</code> will fail if the patch does not apply cleanly. When
3543         set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
3544         the patch records the identity of blobs it is supposed to apply to and
3545         we have those blobs available locally (equivalent to giving the <code>--3way</code>
3546         option from the command line). Defaults to <code>false</code>.
3547         See <a href="git-am.html">git-am(1)</a>.
3548 </p>
3549 </dd>
3550 <dt class="hdlist1">
3551 apply.ignoreWhitespace
3552 </dt>
3553 <dd>
3554 <p>
3555         When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
3556         whitespace, in the same way as the <code>--ignore-space-change</code>
3557         option.
3558         When set to one of: no, none, never, false, it tells <em>git apply</em> to
3559         respect all whitespace differences.
3560         See <a href="git-apply.html">git-apply(1)</a>.
3561 </p>
3562 </dd>
3563 <dt class="hdlist1">
3564 apply.whitespace
3565 </dt>
3566 <dd>
3567 <p>
3568         Tells <em>git apply</em> how to handle whitespace, in the same way
3569         as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
3570 </p>
3571 </dd>
3572 <dt class="hdlist1">
3573 blame.blankBoundary
3574 </dt>
3575 <dd>
3576 <p>
3577         Show blank commit object name for boundary commits in
3578         <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.
3579 </p>
3580 </dd>
3581 <dt class="hdlist1">
3582 blame.coloring
3583 </dt>
3584 <dd>
3585 <p>
3586         This determines the coloring scheme to be applied to blame
3587         output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
3588         or <em>none</em> which is the default.
3589 </p>
3590 </dd>
3591 <dt class="hdlist1">
3592 blame.date
3593 </dt>
3594 <dd>
3595 <p>
3596         Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
3597         If unset the iso format is used. For supported values,
3598         see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.
3599 </p>
3600 </dd>
3601 <dt class="hdlist1">
3602 blame.showEmail
3603 </dt>
3604 <dd>
3605 <p>
3606         Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
3607         This option defaults to false.
3608 </p>
3609 </dd>
3610 <dt class="hdlist1">
3611 blame.showRoot
3612 </dt>
3613 <dd>
3614 <p>
3615         Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
3616         This option defaults to false.
3617 </p>
3618 </dd>
3619 <dt class="hdlist1">
3620 blame.ignoreRevsFile
3621 </dt>
3622 <dd>
3623 <p>
3624         Ignore revisions listed in the file, one unabbreviated object name per
3625         line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
3626         <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
3627         file names will reset the list of ignored revisions.  This option will
3628         be handled before the command line option <code>--ignore-revs-file</code>.
3629 </p>
3630 </dd>
3631 <dt class="hdlist1">
3632 blame.markUnblamableLines
3633 </dt>
3634 <dd>
3635 <p>
3636         Mark lines that were changed by an ignored revision that we could not
3637         attribute to another commit with a <em>*</em> in the output of
3638         <a href="git-blame.html">git-blame(1)</a>.
3639 </p>
3640 </dd>
3641 <dt class="hdlist1">
3642 blame.markIgnoredLines
3643 </dt>
3644 <dd>
3645 <p>
3646         Mark lines that were changed by an ignored revision that we attributed to
3647         another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.
3648 </p>
3649 </dd>
3650 <dt class="hdlist1">
3651 branch.autoSetupMerge
3652 </dt>
3653 <dd>
3654 <p>
3655         Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
3656         so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
3657         starting point branch. Note that even if this option is not set,
3658         this behavior can be chosen per-branch using the <code>--track</code>
3659         and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
3660         automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
3661         starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;        automatic setup is done when the starting point is either a
3662         local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
3663         has a tracking configuration, it is copied to the new
3664         branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
3665         is a remote-tracking branch and the new branch has the same name as the
3666         remote branch. This option defaults to true.
3667 </p>
3668 </dd>
3669 <dt class="hdlist1">
3670 branch.autoSetupRebase
3671 </dt>
3672 <dd>
3673 <p>
3674         When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
3675         that tracks another branch, this variable tells Git to set
3676         up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
3677         When <code>never</code>, rebase is never automatically set to true.
3678         When <code>local</code>, rebase is set to true for tracked branches of
3679         other local branches.
3680         When <code>remote</code>, rebase is set to true for tracked branches of
3681         remote-tracking branches.
3682         When <code>always</code>, rebase will be set to true for all tracking
3683         branches.
3684         See "branch.autoSetupMerge" for details on how to set up a
3685         branch to track another branch.
3686         This option defaults to never.
3687 </p>
3688 </dd>
3689 <dt class="hdlist1">
3690 branch.sort
3691 </dt>
3692 <dd>
3693 <p>
3694         This variable controls the sort ordering of branches when displayed by
3695         <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
3696         value of this variable will be used as the default.
3697         See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.
3698 </p>
3699 </dd>
3700 <dt class="hdlist1">
3701 branch.&lt;name&gt;.remote
3702 </dt>
3703 <dd>
3704 <p>
3705         When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
3706         which remote to fetch from or push to.  The remote to push to
3707         may be overridden with <code>remote.pushDefault</code> (for all branches).
3708         The remote to push to, for the current branch, may be further
3709         overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
3710         configured, or if you are not on any branch and there is more than
3711         one remote defined in the repository, it defaults to <code>origin</code> for
3712         fetching and <code>remote.pushDefault</code> for pushing.
3713         Additionally, <code>.</code> (a period) is the current local repository
3714         (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
3715 </p>
3716 </dd>
3717 <dt class="hdlist1">
3718 branch.&lt;name&gt;.pushRemote
3719 </dt>
3720 <dd>
3721 <p>
3722         When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
3723         pushing.  It also overrides <code>remote.pushDefault</code> for pushing
3724         from branch &lt;name&gt;.  When you pull from one place (e.g. your
3725         upstream) and push to another place (e.g. your own publishing
3726         repository), you would want to set <code>remote.pushDefault</code> to
3727         specify the remote to push to for all branches, and use this
3728         option to override it for a specific branch.
3729 </p>
3730 </dd>
3731 <dt class="hdlist1">
3732 branch.&lt;name&gt;.merge
3733 </dt>
3734 <dd>
3735 <p>
3736         Defines, together with branch.&lt;name&gt;.remote, the upstream branch
3737         for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
3738         branch to merge and can also affect <em>git push</em> (see push.default).
3739         When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
3740         refspec to be marked for merging in FETCH_HEAD. The value is
3741         handled like the remote part of a refspec, and must match a
3742         ref which is fetched from the remote given by
3743         "branch.&lt;name&gt;.remote".
3744         The merge information is used by <em>git pull</em> (which first calls
3745         <em>git fetch</em>) to lookup the default branch for merging. Without
3746         this option, <em>git pull</em> defaults to merge the first refspec fetched.
3747         Specify multiple values to get an octopus merge.
3748         If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
3749         another branch in the local repository, you can point
3750         branch.&lt;name&gt;.merge to the desired branch, and use the relative path
3751         setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
3752 </p>
3753 </dd>
3754 <dt class="hdlist1">
3755 branch.&lt;name&gt;.mergeOptions
3756 </dt>
3757 <dd>
3758 <p>
3759         Sets default options for merging into branch &lt;name&gt;. The syntax and
3760         supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
3761         option values containing whitespace characters are currently not
3762         supported.
3763 </p>
3764 </dd>
3765 <dt class="hdlist1">
3766 branch.&lt;name&gt;.rebase
3767 </dt>
3768 <dd>
3769 <p>
3770         When true, rebase the branch &lt;name&gt; on top of the fetched branch,
3771         instead of merging the default branch from the default remote when
3772         "git pull" is run. See "pull.rebase" for doing this in a non
3773         branch-specific manner.
3774 </p>
3775 <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>
3776 so that the local merge commits are included in the rebase (see
3777 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
3778 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
3779 mode.</p></div>
3780 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
3781 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
3782 for details).</p></div>
3783 </dd>
3784 <dt class="hdlist1">
3785 branch.&lt;name&gt;.description
3786 </dt>
3787 <dd>
3788 <p>
3789         Branch description, can be edited with
3790         <code>git branch --edit-description</code>. Branch description is
3791         automatically added to the format-patch cover letter or
3792         request-pull summary.
3793 </p>
3794 </dd>
3795 <dt class="hdlist1">
3796 browser.&lt;tool&gt;.cmd
3797 </dt>
3798 <dd>
3799 <p>
3800         Specify the command to invoke the specified browser. The
3801         specified command is evaluated in shell with the URLs passed
3802         as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
3803 </p>
3804 </dd>
3805 <dt class="hdlist1">
3806 browser.&lt;tool&gt;.path
3807 </dt>
3808 <dd>
3809 <p>
3810         Override the path for the given tool that may be used to
3811         browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
3812         working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
3813 </p>
3814 </dd>
3815 <dt class="hdlist1">
3816 bundle.*
3817 </dt>
3818 <dd>
3819 <p>
3820         The <code>bundle.*</code> keys may appear in a bundle list file found via the
3821         <code>git clone --bundle-uri</code> option. These keys currently have no effect
3822         if placed in a repository config file, though this will change in the
3823         future. See <a href="technical/bundle-uri.html">the bundle URI design
3824         document</a> for more details.
3825 </p>
3826 </dd>
3827 <dt class="hdlist1">
3828 bundle.version
3829 </dt>
3830 <dd>
3831 <p>
3832         This integer value advertises the version of the bundle list format
3833         used by the bundle list. Currently, the only accepted value is <code>1</code>.
3834 </p>
3835 </dd>
3836 <dt class="hdlist1">
3837 bundle.mode
3838 </dt>
3839 <dd>
3840 <p>
3841         This string value should be either <code>all</code> or <code>any</code>. This value describes
3842         whether all of the advertised bundles are required to unbundle a
3843         complete understanding of the bundled information (<code>all</code>) or if any one
3844         of the listed bundle URIs is sufficient (<code>any</code>).
3845 </p>
3846 </dd>
3847 <dt class="hdlist1">
3848 bundle.heuristic
3849 </dt>
3850 <dd>
3851 <p>
3852         If this string-valued key exists, then the bundle list is designed to
3853         work well with incremental <code>git fetch</code> commands. The heuristic signals
3854         that there are additional keys available for each bundle that help
3855         determine which subset of bundles the client should download. The
3856         only value currently understood is <code>creationToken</code>.
3857 </p>
3858 </dd>
3859 <dt class="hdlist1">
3860 bundle.&lt;id&gt;.*
3861 </dt>
3862 <dd>
3863 <p>
3864         The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
3865         bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.
3866 </p>
3867 </dd>
3868 <dt class="hdlist1">
3869 bundle.&lt;id&gt;.uri
3870 </dt>
3871 <dd>
3872 <p>
3873         This string value defines the URI by which Git can reach the contents
3874         of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.
3875 </p>
3876 </dd>
3877 <dt class="hdlist1">
3878 checkout.defaultRemote
3879 </dt>
3880 <dd>
3881 <p>
3882         When you run <code>git checkout &lt;something&gt;</code>
3883         or <code>git switch &lt;something&gt;</code> and only have one
3884         remote, it may implicitly fall back on checking out and
3885         tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
3886         as you have more than one remote with a <code>&lt;something&gt;</code>
3887         reference. This setting allows for setting the name of a
3888         preferred remote that should always win when it comes to
3889         disambiguation. The typical use-case is to set this to
3890         <code>origin</code>.
3891 </p>
3892 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
3893 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
3894 or <code>git switch &lt;something&gt;</code>
3895 will checkout the <code>&lt;something&gt;</code> branch on another remote,
3896 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
3897 remote branch. This setting might be used for other checkout-like
3898 commands or functionality in the future.</p></div>
3899 </dd>
3900 <dt class="hdlist1">
3901 checkout.guess
3902 </dt>
3903 <dd>
3904 <p>
3905         Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
3906         option in <code>git checkout</code> and <code>git switch</code>. See
3907         <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
3908 </p>
3909 </dd>
3910 <dt class="hdlist1">
3911 checkout.workers
3912 </dt>
3913 <dd>
3914 <p>
3915         The number of parallel workers to use when updating the working tree.
3916         The default is one, i.e. sequential execution. If set to a value less
3917         than one, Git will use as many workers as the number of logical cores
3918         available. This setting and <code>checkout.thresholdForParallelism</code> affect
3919         all commands that perform checkout. E.g. checkout, clone, reset,
3920         sparse-checkout, etc.
3921 </p>
3922 <div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories
3923 located on SSDs or over NFS. For repositories on spinning disks and/or machines
3924 with a small number of cores, the default sequential checkout often performs
3925 better. The size and compression level of a repository might also influence how
3926 well the parallel version performs.</p></div>
3927 </dd>
3928 <dt class="hdlist1">
3929 checkout.thresholdForParallelism
3930 </dt>
3931 <dd>
3932 <p>
3933         When running parallel checkout with a small number of files, the cost
3934         of subprocess spawning and inter-process communication might outweigh
3935         the parallelization gains. This setting allows you to define the minimum
3936         number of files for which parallel checkout should be attempted. The
3937         default is 100.
3938 </p>
3939 </dd>
3940 <dt class="hdlist1">
3941 clean.requireForce
3942 </dt>
3943 <dd>
3944 <p>
3945         A boolean to make git-clean do nothing unless given -f,
3946         -i, or -n.  Defaults to true.
3947 </p>
3948 </dd>
3949 <dt class="hdlist1">
3950 clone.defaultRemoteName
3951 </dt>
3952 <dd>
3953 <p>
3954         The name of the remote to create when cloning a repository.  Defaults to
3955         <code>origin</code>, and can be overridden by passing the <code>--origin</code> command-line
3956         option to <a href="git-clone.html">git-clone(1)</a>.
3957 </p>
3958 </dd>
3959 <dt class="hdlist1">
3960 clone.rejectShallow
3961 </dt>
3962 <dd>
3963 <p>
3964         Reject cloning a repository if it is a shallow one; this can be overridden by
3965         passing the <code>--reject-shallow</code> option on the command line. See <a href="git-clone.html">git-clone(1)</a>
3966 </p>
3967 </dd>
3968 <dt class="hdlist1">
3969 clone.filterSubmodules
3970 </dt>
3971 <dd>
3972 <p>
3973         If a partial clone filter is provided (see <code>--filter</code> in
3974         <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
3975         the filter to submodules.
3976 </p>
3977 </dd>
3978 <dt class="hdlist1">
3979 color.advice
3980 </dt>
3981 <dd>
3982 <p>
3983         A boolean to enable/disable color in hints (e.g. when a push
3984         failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
3985         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
3986         are used only when the error output goes to a terminal. If
3987         unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3988 </p>
3989 </dd>
3990 <dt class="hdlist1">
3991 color.advice.hint
3992 </dt>
3993 <dd>
3994 <p>
3995         Use customized color for hints.
3996 </p>
3997 </dd>
3998 <dt class="hdlist1">
3999 color.blame.highlightRecent
4000 </dt>
4001 <dd>
4002 <p>
4003         Specify the line annotation color for <code>git blame --color-by-age</code>
4004         depending upon the age of the line.
4005 </p>
4006 <div class="paragraph"><p>This setting should be set to a comma-separated list of color and
4007 date settings, starting and ending with a color, the dates should be
4008 set from oldest to newest. The metadata will be colored with the
4009 specified colors if the line was introduced before the given
4010 timestamp, overwriting older timestamped colors.</p></div>
4011 <div class="paragraph"><p>Instead of an absolute timestamp relative timestamps work as well,
4012 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
4013 <div class="paragraph"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
4014 colors everything older than one year blue, recent changes between
4015 one month and one year old are kept white, and lines introduced
4016 within the last month are colored red.</p></div>
4017 </dd>
4018 <dt class="hdlist1">
4019 color.blame.repeatedLines
4020 </dt>
4021 <dd>
4022 <p>
4023         Use the specified color to colorize line annotations for
4024         <code>git blame --color-lines</code>, if they come from the same commit as the
4025         preceding line. Defaults to cyan.
4026 </p>
4027 </dd>
4028 <dt class="hdlist1">
4029 color.branch
4030 </dt>
4031 <dd>
4032 <p>
4033         A boolean to enable/disable color in the output of
4034         <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
4035         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4036         only when the output is to a terminal. If unset, then the
4037         value of <code>color.ui</code> is used (<code>auto</code> by default).
4038 </p>
4039 </dd>
4040 <dt class="hdlist1">
4041 color.branch.&lt;slot&gt;
4042 </dt>
4043 <dd>
4044 <p>
4045         Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
4046         <code>current</code> (the current branch), <code>local</code> (a local branch),
4047         <code>remote</code> (a remote-tracking branch in refs/remotes/),
4048         <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
4049         refs).
4050 </p>
4051 </dd>
4052 <dt class="hdlist1">
4053 color.diff
4054 </dt>
4055 <dd>
4056 <p>
4057         Whether to use ANSI escape sequences to add color to patches.
4058         If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
4059         <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
4060         for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
4061         commands will only use color when output is to the terminal.
4062         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
4063         default).
4064 </p>
4065 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
4066 <em>git-diff-&#42;</em> plumbing commands.  Can be overridden on the
4067 command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
4068 </dd>
4069 <dt class="hdlist1">
4070 color.diff.&lt;slot&gt;
4071 </dt>
4072 <dd>
4073 <p>
4074         Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
4075         which part of the patch to use the specified color, and is one
4076         of <code>context</code> (context text - <code>plain</code> is a historical synonym),
4077         <code>meta</code> (metainformation), <code>frag</code>
4078         (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
4079         <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
4080         (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
4081         <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
4082         <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
4083         <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
4084         setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
4085         <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
4086         <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).
4087 </p>
4088 </dd>
4089 <dt class="hdlist1">
4090 color.decorate.&lt;slot&gt;
4091 </dt>
4092 <dd>
4093 <p>
4094         Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
4095         of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
4096         branches, remote-tracking branches, tags, stash and HEAD, respectively
4097         and <code>grafted</code> for grafted commits.
4098 </p>
4099 </dd>
4100 <dt class="hdlist1">
4101 color.grep
4102 </dt>
4103 <dd>
4104 <p>
4105         When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
4106         <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
4107         when the output is written to the terminal.  If unset, then the
4108         value of <code>color.ui</code> is used (<code>auto</code> by default).
4109 </p>
4110 </dd>
4111 <dt class="hdlist1">
4112 color.grep.&lt;slot&gt;
4113 </dt>
4114 <dd>
4115 <p>
4116         Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
4117         part of the line to use the specified color, and is one of
4118 </p>
4119 <div class="openblock">
4120 <div class="content">
4121 <div class="dlist"><dl>
4122 <dt class="hdlist1">
4123 <code>context</code>
4124 </dt>
4125 <dd>
4126 <p>
4127         non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
4128 </p>
4129 </dd>
4130 <dt class="hdlist1">
4131 <code>filename</code>
4132 </dt>
4133 <dd>
4134 <p>
4135         filename prefix (when not using <code>-h</code>)
4136 </p>
4137 </dd>
4138 <dt class="hdlist1">
4139 <code>function</code>
4140 </dt>
4141 <dd>
4142 <p>
4143         function name lines (when using <code>-p</code>)
4144 </p>
4145 </dd>
4146 <dt class="hdlist1">
4147 <code>lineNumber</code>
4148 </dt>
4149 <dd>
4150 <p>
4151         line number prefix (when using <code>-n</code>)
4152 </p>
4153 </dd>
4154 <dt class="hdlist1">
4155 <code>column</code>
4156 </dt>
4157 <dd>
4158 <p>
4159         column number prefix (when using <code>--column</code>)
4160 </p>
4161 </dd>
4162 <dt class="hdlist1">
4163 <code>match</code>
4164 </dt>
4165 <dd>
4166 <p>
4167         matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
4168 </p>
4169 </dd>
4170 <dt class="hdlist1">
4171 <code>matchContext</code>
4172 </dt>
4173 <dd>
4174 <p>
4175         matching text in context lines
4176 </p>
4177 </dd>
4178 <dt class="hdlist1">
4179 <code>matchSelected</code>
4180 </dt>
4181 <dd>
4182 <p>
4183         matching text in selected lines. Also, used to customize the following
4184         <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.
4185 </p>
4186 </dd>
4187 <dt class="hdlist1">
4188 <code>selected</code>
4189 </dt>
4190 <dd>
4191 <p>
4192         non-matching text in selected lines. Also, used to customize the
4193         following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
4194         <code>--committer</code>.
4195 </p>
4196 </dd>
4197 <dt class="hdlist1">
4198 <code>separator</code>
4199 </dt>
4200 <dd>
4201 <p>
4202         separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
4203         and between hunks (<code>--</code>)
4204 </p>
4205 </dd>
4206 </dl></div>
4207 </div></div>
4208 </dd>
4209 <dt class="hdlist1">
4210 color.interactive
4211 </dt>
4212 <dd>
4213 <p>
4214         When set to <code>always</code>, always use colors for interactive prompts
4215         and displays (such as those used by "git-add --interactive" and
4216         "git-clean --interactive"). When false (or <code>never</code>), never.
4217         When set to <code>true</code> or <code>auto</code>, use colors only when the output is
4218         to the terminal. If unset, then the value of <code>color.ui</code> is
4219         used (<code>auto</code> by default).
4220 </p>
4221 </dd>
4222 <dt class="hdlist1">
4223 color.interactive.&lt;slot&gt;
4224 </dt>
4225 <dd>
4226 <p>
4227         Use customized color for <em>git add --interactive</em> and <em>git clean
4228         --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
4229         or <code>error</code>, for four distinct types of normal output from
4230         interactive commands.
4231 </p>
4232 </dd>
4233 <dt class="hdlist1">
4234 color.pager
4235 </dt>
4236 <dd>
4237 <p>
4238         A boolean to specify whether <code>auto</code> color modes should colorize
4239         output going to the pager. Defaults to true; set this to false
4240         if your pager does not understand ANSI color codes.
4241 </p>
4242 </dd>
4243 <dt class="hdlist1">
4244 color.push
4245 </dt>
4246 <dd>
4247 <p>
4248         A boolean to enable/disable color in push errors. May be set to
4249         <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
4250         case colors are used only when the error output goes to a terminal.
4251         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
4252 </p>
4253 </dd>
4254 <dt class="hdlist1">
4255 color.push.error
4256 </dt>
4257 <dd>
4258 <p>
4259         Use customized color for push errors.
4260 </p>
4261 </dd>
4262 <dt class="hdlist1">
4263 color.remote
4264 </dt>
4265 <dd>
4266 <p>
4267         If set, keywords at the start of the line are highlighted. The
4268         keywords are "error", "warning", "hint" and "success", and are
4269         matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
4270         <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
4271         <code>color.ui</code> is used (<code>auto</code> by default).
4272 </p>
4273 </dd>
4274 <dt class="hdlist1">
4275 color.remote.&lt;slot&gt;
4276 </dt>
4277 <dd>
4278 <p>
4279         Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
4280         <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
4281         corresponding keyword.
4282 </p>
4283 </dd>
4284 <dt class="hdlist1">
4285 color.showBranch
4286 </dt>
4287 <dd>
4288 <p>
4289         A boolean to enable/disable color in the output of
4290         <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
4291         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4292         only when the output is to a terminal. If unset, then the
4293         value of <code>color.ui</code> is used (<code>auto</code> by default).
4294 </p>
4295 </dd>
4296 <dt class="hdlist1">
4297 color.status
4298 </dt>
4299 <dd>
4300 <p>
4301         A boolean to enable/disable color in the output of
4302         <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
4303         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4304         only when the output is to a terminal. If unset, then the
4305         value of <code>color.ui</code> is used (<code>auto</code> by default).
4306 </p>
4307 </dd>
4308 <dt class="hdlist1">
4309 color.status.&lt;slot&gt;
4310 </dt>
4311 <dd>
4312 <p>
4313         Use customized color for status colorization. <code>&lt;slot&gt;</code> is
4314         one of <code>header</code> (the header text of the status message),
4315         <code>added</code> or <code>updated</code> (files which are added but not committed),
4316         <code>changed</code> (files which are changed but not added in the index),
4317         <code>untracked</code> (files which are not tracked by Git),
4318         <code>branch</code> (the current branch),
4319         <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
4320         to red),
4321         <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
4322         respectively, when branch and tracking information is displayed in the
4323         status short-format), or
4324         <code>unmerged</code> (files which have unmerged changes).
4325 </p>
4326 </dd>
4327 <dt class="hdlist1">
4328 color.transport
4329 </dt>
4330 <dd>
4331 <p>
4332         A boolean to enable/disable color when pushes are rejected. May be
4333         set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
4334         case colors are used only when the error output goes to a terminal.
4335         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
4336 </p>
4337 </dd>
4338 <dt class="hdlist1">
4339 color.transport.rejected
4340 </dt>
4341 <dd>
4342 <p>
4343         Use customized color when a push was rejected.
4344 </p>
4345 </dd>
4346 <dt class="hdlist1">
4347 color.ui
4348 </dt>
4349 <dd>
4350 <p>
4351         This variable determines the default value for variables such
4352         as <code>color.diff</code> and <code>color.grep</code> that control the use of color
4353         per command family. Its scope will expand as more commands learn
4354         configuration to set a default for the <code>--color</code> option.  Set it
4355         to <code>false</code> or <code>never</code> if you prefer Git commands not to use
4356         color unless enabled explicitly with some other configuration
4357         or the <code>--color</code> option. Set it to <code>always</code> if you want all
4358         output not intended for machine consumption to use color, to
4359         <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
4360         want such output to use color when written to the terminal.
4361 </p>
4362 </dd>
4363 <dt class="hdlist1">
4364 column.ui
4365 </dt>
4366 <dd>
4367 <p>
4368         Specify whether supported commands should output in columns.
4369         This variable consists of a list of tokens separated by spaces
4370         or commas:
4371 </p>
4372 <div class="paragraph"><p>These options control when the feature should be enabled
4373 (defaults to <em>never</em>):</p></div>
4374 <div class="openblock">
4375 <div class="content">
4376 <div class="dlist"><dl>
4377 <dt class="hdlist1">
4378 <code>always</code>
4379 </dt>
4380 <dd>
4381 <p>
4382         always show in columns
4383 </p>
4384 </dd>
4385 <dt class="hdlist1">
4386 <code>never</code>
4387 </dt>
4388 <dd>
4389 <p>
4390         never show in columns
4391 </p>
4392 </dd>
4393 <dt class="hdlist1">
4394 <code>auto</code>
4395 </dt>
4396 <dd>
4397 <p>
4398         show in columns if the output is to the terminal
4399 </p>
4400 </dd>
4401 </dl></div>
4402 </div></div>
4403 <div class="paragraph"><p>These options control layout (defaults to <em>column</em>).  Setting any
4404 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
4405 specified.</p></div>
4406 <div class="openblock">
4407 <div class="content">
4408 <div class="dlist"><dl>
4409 <dt class="hdlist1">
4410 <code>column</code>
4411 </dt>
4412 <dd>
4413 <p>
4414         fill columns before rows
4415 </p>
4416 </dd>
4417 <dt class="hdlist1">
4418 <code>row</code>
4419 </dt>
4420 <dd>
4421 <p>
4422         fill rows before columns
4423 </p>
4424 </dd>
4425 <dt class="hdlist1">
4426 <code>plain</code>
4427 </dt>
4428 <dd>
4429 <p>
4430         show in one column
4431 </p>
4432 </dd>
4433 </dl></div>
4434 </div></div>
4435 <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
4436 to <em>nodense</em>):</p></div>
4437 <div class="openblock">
4438 <div class="content">
4439 <div class="dlist"><dl>
4440 <dt class="hdlist1">
4441 <code>dense</code>
4442 </dt>
4443 <dd>
4444 <p>
4445         make unequal size columns to utilize more space
4446 </p>
4447 </dd>
4448 <dt class="hdlist1">
4449 <code>nodense</code>
4450 </dt>
4451 <dd>
4452 <p>
4453         make equal size columns
4454 </p>
4455 </dd>
4456 </dl></div>
4457 </div></div>
4458 </dd>
4459 <dt class="hdlist1">
4460 column.branch
4461 </dt>
4462 <dd>
4463 <p>
4464         Specify whether to output branch listing in <code>git branch</code> in columns.
4465         See <code>column.ui</code> for details.
4466 </p>
4467 </dd>
4468 <dt class="hdlist1">
4469 column.clean
4470 </dt>
4471 <dd>
4472 <p>
4473         Specify the layout when listing items in <code>git clean -i</code>, which always
4474         shows files and directories in columns. See <code>column.ui</code> for details.
4475 </p>
4476 </dd>
4477 <dt class="hdlist1">
4478 column.status
4479 </dt>
4480 <dd>
4481 <p>
4482         Specify whether to output untracked files in <code>git status</code> in columns.
4483         See <code>column.ui</code> for details.
4484 </p>
4485 </dd>
4486 <dt class="hdlist1">
4487 column.tag
4488 </dt>
4489 <dd>
4490 <p>
4491         Specify whether to output tag listings in <code>git tag</code> in columns.
4492         See <code>column.ui</code> for details.
4493 </p>
4494 </dd>
4495 <dt class="hdlist1">
4496 commit.cleanup
4497 </dt>
4498 <dd>
4499 <p>
4500         This setting overrides the default of the <code>--cleanup</code> option in
4501         <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
4502         default can be useful when you always want to keep lines that begin
4503         with the comment character <code>#</code> in your log message, in which case you
4504         would do <code>git config commit.cleanup whitespace</code> (note that you will
4505         have to remove the help lines that begin with <code>#</code> in the commit log
4506         template yourself, if you do this).
4507 </p>
4508 </dd>
4509 <dt class="hdlist1">
4510 commit.gpgSign
4511 </dt>
4512 <dd>
4513 <p>
4514         A boolean to specify whether all commits should be GPG signed.
4515         Use of this option when doing operations such as rebase can
4516         result in a large number of commits being signed. It may be
4517         convenient to use an agent to avoid typing your GPG passphrase
4518         several times.
4519 </p>
4520 </dd>
4521 <dt class="hdlist1">
4522 commit.status
4523 </dt>
4524 <dd>
4525 <p>
4526         A boolean to enable/disable inclusion of status information in the
4527         commit message template when using an editor to prepare the commit
4528         message.  Defaults to true.
4529 </p>
4530 </dd>
4531 <dt class="hdlist1">
4532 commit.template
4533 </dt>
4534 <dd>
4535 <p>
4536         Specify the pathname of a file to use as the template for
4537         new commit messages.
4538 </p>
4539 </dd>
4540 <dt class="hdlist1">
4541 commit.verbose
4542 </dt>
4543 <dd>
4544 <p>
4545         A boolean or int to specify the level of verbosity with <code>git commit</code>.
4546         See <a href="git-commit.html">git-commit(1)</a>.
4547 </p>
4548 </dd>
4549 <dt class="hdlist1">
4550 commitGraph.generationVersion
4551 </dt>
4552 <dd>
4553 <p>
4554         Specifies the type of generation number version to use when writing
4555         or reading the commit-graph file. If version 1 is specified, then
4556         the corrected commit dates will not be written or read. Defaults to
4557         2.
4558 </p>
4559 </dd>
4560 <dt class="hdlist1">
4561 commitGraph.maxNewFilters
4562 </dt>
4563 <dd>
4564 <p>
4565         Specifies the default value for the <code>--max-new-filters</code> option of <code>git
4566         commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).
4567 </p>
4568 </dd>
4569 <dt class="hdlist1">
4570 commitGraph.readChangedPaths
4571 </dt>
4572 <dd>
4573 <p>
4574         If true, then git will use the changed-path Bloom filters in the
4575         commit-graph file (if it exists, and they are present). Defaults to
4576         true. See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
4577 </p>
4578 </dd>
4579 <dt class="hdlist1">
4580 credential.helper
4581 </dt>
4582 <dd>
4583 <p>
4584         Specify an external helper to be called when a username or
4585         password credential is needed; the helper may consult external
4586         storage to avoid prompting the user for the credentials. This is
4587         normally the name of a credential helper with possible
4588         arguments, but may also be an absolute path with arguments or, if
4589         preceded by <code>!</code>, shell commands.
4590 </p>
4591 <div class="paragraph"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
4592 for details and examples.</p></div>
4593 </dd>
4594 <dt class="hdlist1">
4595 credential.useHttpPath
4596 </dt>
4597 <dd>
4598 <p>
4599         When acquiring credentials, consider the "path" component of an http
4600         or https URL to be important. Defaults to false. See
4601         <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
4602 </p>
4603 </dd>
4604 <dt class="hdlist1">
4605 credential.username
4606 </dt>
4607 <dd>
4608 <p>
4609         If no username is set for a network authentication, use this username
4610         by default. See credential.&lt;context&gt;.* below, and
4611         <a href="gitcredentials.html">gitcredentials(7)</a>.
4612 </p>
4613 </dd>
4614 <dt class="hdlist1">
4615 credential.&lt;url&gt;.*
4616 </dt>
4617 <dd>
4618 <p>
4619         Any of the credential.* options above can be applied selectively to
4620         some credentials. For example, "credential.https://example.com.username"
4621         would set the default username only for https connections to
4622         example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
4623         matched.
4624 </p>
4625 </dd>
4626 <dt class="hdlist1">
4627 credentialCache.ignoreSIGHUP
4628 </dt>
4629 <dd>
4630 <p>
4631         Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
4632 </p>
4633 </dd>
4634 <dt class="hdlist1">
4635 credentialStore.lockTimeoutMS
4636 </dt>
4637 <dd>
4638 <p>
4639         The length of time, in milliseconds, for git-credential-store to retry
4640         when trying to lock the credentials file. A value of 0 means not to retry at
4641         all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
4642         1s).
4643 </p>
4644 </dd>
4645 <dt class="hdlist1">
4646 completion.commands
4647 </dt>
4648 <dd>
4649 <p>
4650         This is only used by git-completion.bash to add or remove
4651         commands from the list of completed commands. Normally only
4652         porcelain commands and a few select others are completed. You
4653         can add more commands, separated by space, in this
4654         variable. Prefixing the command with <em>-</em> will remove it from
4655         the existing list.
4656 </p>
4657 </dd>
4658 <dt class="hdlist1">
4659 diff.autoRefreshIndex
4660 </dt>
4661 <dd>
4662 <p>
4663         When using <em>git diff</em> to compare with work tree
4664         files, do not consider stat-only changes as changed.
4665         Instead, silently run <code>git update-index --refresh</code> to
4666         update the cached stat information for paths whose
4667         contents in the work tree match the contents in the
4668         index.  This option defaults to true.  Note that this
4669         affects only <em>git diff</em> Porcelain, and not lower level
4670         <em>diff</em> commands such as <em>git diff-files</em>.
4671 </p>
4672 </dd>
4673 <dt class="hdlist1">
4674 diff.dirstat
4675 </dt>
4676 <dd>
4677 <p>
4678         A comma separated list of <code>--dirstat</code> parameters specifying the
4679         default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
4680         and friends. The defaults can be overridden on the command line
4681         (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
4682         (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
4683         The following parameters are available:
4684 </p>
4685 <div class="openblock">
4686 <div class="content">
4687 <div class="dlist"><dl>
4688 <dt class="hdlist1">
4689 <code>changes</code>
4690 </dt>
4691 <dd>
4692 <p>
4693         Compute the dirstat numbers by counting the lines that have been
4694         removed from the source, or added to the destination. This ignores
4695         the amount of pure code movements within a file.  In other words,
4696         rearranging lines in a file is not counted as much as other changes.
4697         This is the default behavior when no parameter is given.
4698 </p>
4699 </dd>
4700 <dt class="hdlist1">
4701 <code>lines</code>
4702 </dt>
4703 <dd>
4704 <p>
4705         Compute the dirstat numbers by doing the regular line-based diff
4706         analysis, and summing the removed/added line counts. (For binary
4707         files, count 64-byte chunks instead, since binary files have no
4708         natural concept of lines). This is a more expensive <code>--dirstat</code>
4709         behavior than the <code>changes</code> behavior, but it does count rearranged
4710         lines within a file as much as other changes. The resulting output
4711         is consistent with what you get from the other <code>--*stat</code> options.
4712 </p>
4713 </dd>
4714 <dt class="hdlist1">
4715 <code>files</code>
4716 </dt>
4717 <dd>
4718 <p>
4719         Compute the dirstat numbers by counting the number of files changed.
4720         Each changed file counts equally in the dirstat analysis. This is
4721         the computationally cheapest <code>--dirstat</code> behavior, since it does
4722         not have to look at the file contents at all.
4723 </p>
4724 </dd>
4725 <dt class="hdlist1">
4726 <code>cumulative</code>
4727 </dt>
4728 <dd>
4729 <p>
4730         Count changes in a child directory for the parent directory as well.
4731         Note that when using <code>cumulative</code>, the sum of the percentages
4732         reported may exceed 100%. The default (non-cumulative) behavior can
4733         be specified with the <code>noncumulative</code> parameter.
4734 </p>
4735 </dd>
4736 <dt class="hdlist1">
4737 &lt;limit&gt;
4738 </dt>
4739 <dd>
4740 <p>
4741         An integer parameter specifies a cut-off percent (3% by default).
4742         Directories contributing less than this percentage of the changes
4743         are not shown in the output.
4744 </p>
4745 </dd>
4746 </dl></div>
4747 </div></div>
4748 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
4749 directories with less than 10% of the total amount of changed files,
4750 and accumulating child directory counts in the parent directories:
4751 <code>files,10,cumulative</code>.</p></div>
4752 </dd>
4753 <dt class="hdlist1">
4754 diff.statNameWidth
4755 </dt>
4756 <dd>
4757 <p>
4758         Limit the width of the filename part in --stat output. If set, applies
4759         to all commands generating --stat output except format-patch.
4760 </p>
4761 </dd>
4762 <dt class="hdlist1">
4763 diff.statGraphWidth
4764 </dt>
4765 <dd>
4766 <p>
4767         Limit the width of the graph part in --stat output. If set, applies
4768         to all commands generating --stat output except format-patch.
4769 </p>
4770 </dd>
4771 <dt class="hdlist1">
4772 diff.context
4773 </dt>
4774 <dd>
4775 <p>
4776         Generate diffs with &lt;n&gt; lines of context instead of the default
4777         of 3. This value is overridden by the -U option.
4778 </p>
4779 </dd>
4780 <dt class="hdlist1">
4781 diff.interHunkContext
4782 </dt>
4783 <dd>
4784 <p>
4785         Show the context between diff hunks, up to the specified number
4786         of lines, thereby fusing the hunks that are close to each other.
4787         This value serves as the default for the <code>--inter-hunk-context</code>
4788         command line option.
4789 </p>
4790 </dd>
4791 <dt class="hdlist1">
4792 diff.external
4793 </dt>
4794 <dd>
4795 <p>
4796         If this config variable is set, diff generation is not
4797         performed using the internal diff machinery, but using the
4798         given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
4799         environment variable.  The command is called with parameters
4800         as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
4801         you want to use an external diff program only on a subset of
4802         your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
4803 </p>
4804 </dd>
4805 <dt class="hdlist1">
4806 diff.ignoreSubmodules
4807 </dt>
4808 <dd>
4809 <p>
4810         Sets the default value of --ignore-submodules. Note that this
4811         affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
4812         commands such as <em>git diff-files</em>. <em>git checkout</em>
4813         and <em>git switch</em> also honor
4814         this setting when reporting uncommitted changes. Setting it to
4815         <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
4816         and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
4817         overridden by using the --ignore-submodules command-line option.
4818         The <em>git submodule</em> commands are not affected by this setting.
4819         By default this is set to untracked so that any untracked
4820         submodules are ignored.
4821 </p>
4822 </dd>
4823 <dt class="hdlist1">
4824 diff.mnemonicPrefix
4825 </dt>
4826 <dd>
4827 <p>
4828         If set, <em>git diff</em> uses a prefix pair that is different from the
4829         standard "a/" and "b/" depending on what is being compared.  When
4830         this configuration is in effect, reverse diff output also swaps
4831         the order of the prefixes:
4832 </p>
4833 <div class="dlist"><dl>
4834 <dt class="hdlist1">
4835 <code>git diff</code>
4836 </dt>
4837 <dd>
4838 <p>
4839         compares the (i)ndex and the (w)ork tree;
4840 </p>
4841 </dd>
4842 <dt class="hdlist1">
4843 <code>git diff HEAD</code>
4844 </dt>
4845 <dd>
4846 <p>
4847          compares a (c)ommit and the (w)ork tree;
4848 </p>
4849 </dd>
4850 <dt class="hdlist1">
4851 <code>git diff --cached</code>
4852 </dt>
4853 <dd>
4854 <p>
4855         compares a (c)ommit and the (i)ndex;
4856 </p>
4857 </dd>
4858 <dt class="hdlist1">
4859 <code>git diff HEAD:file1 file2</code>
4860 </dt>
4861 <dd>
4862 <p>
4863         compares an (o)bject and a (w)ork tree entity;
4864 </p>
4865 </dd>
4866 <dt class="hdlist1">
4867 <code>git diff --no-index a b</code>
4868 </dt>
4869 <dd>
4870 <p>
4871         compares two non-git things (1) and (2).
4872 </p>
4873 </dd>
4874 </dl></div>
4875 </dd>
4876 <dt class="hdlist1">
4877 diff.noprefix
4878 </dt>
4879 <dd>
4880 <p>
4881         If set, <em>git diff</em> does not show any source or destination prefix.
4882 </p>
4883 </dd>
4884 <dt class="hdlist1">
4885 diff.relative
4886 </dt>
4887 <dd>
4888 <p>
4889         If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
4890         and show pathnames relative to the current directory.
4891 </p>
4892 </dd>
4893 <dt class="hdlist1">
4894 diff.orderFile
4895 </dt>
4896 <dd>
4897 <p>
4898         File indicating how to order files within a diff.
4899         See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
4900         If <code>diff.orderFile</code> is a relative pathname, it is treated as
4901         relative to the top of the working tree.
4902 </p>
4903 </dd>
4904 <dt class="hdlist1">
4905 diff.renameLimit
4906 </dt>
4907 <dd>
4908 <p>
4909         The number of files to consider in the exhaustive portion of
4910         copy/rename detection; equivalent to the <em>git diff</em> option
4911         <code>-l</code>.  If not set, the default value is currently 1000.  This
4912         setting has no effect if rename detection is turned off.
4913 </p>
4914 </dd>
4915 <dt class="hdlist1">
4916 diff.renames
4917 </dt>
4918 <dd>
4919 <p>
4920         Whether and how Git detects renames.  If set to "false",
4921         rename detection is disabled. If set to "true", basic rename
4922         detection is enabled.  If set to "copies" or "copy", Git will
4923         detect copies, as well.  Defaults to true.  Note that this
4924         affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
4925         <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
4926         <a href="git-diff-files.html">git-diff-files(1)</a>.
4927 </p>
4928 </dd>
4929 <dt class="hdlist1">
4930 diff.suppressBlankEmpty
4931 </dt>
4932 <dd>
4933 <p>
4934         A boolean to inhibit the standard behavior of printing a space
4935         before each empty output line. Defaults to false.
4936 </p>
4937 </dd>
4938 <dt class="hdlist1">
4939 diff.submodule
4940 </dt>
4941 <dd>
4942 <p>
4943         Specify the format in which differences in submodules are
4944         shown.  The "short" format just shows the names of the commits
4945         at the beginning and end of the range. The "log" format lists
4946         the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
4947         does. The "diff" format shows an inline diff of the changed
4948         contents of the submodule. Defaults to "short".
4949 </p>
4950 </dd>
4951 <dt class="hdlist1">
4952 diff.wordRegex
4953 </dt>
4954 <dd>
4955 <p>
4956         A POSIX Extended Regular Expression used to determine what is a "word"
4957         when performing word-by-word difference calculations.  Character
4958         sequences that match the regular expression are "words", all other
4959         characters are <strong>ignorable</strong> whitespace.
4960 </p>
4961 </dd>
4962 <dt class="hdlist1">
4963 diff.&lt;driver&gt;.command
4964 </dt>
4965 <dd>
4966 <p>
4967         The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
4968         for details.
4969 </p>
4970 </dd>
4971 <dt class="hdlist1">
4972 diff.&lt;driver&gt;.xfuncname
4973 </dt>
4974 <dd>
4975 <p>
4976         The regular expression that the diff driver should use to
4977         recognize the hunk header.  A built-in pattern may also be used.
4978         See <a href="gitattributes.html">gitattributes(5)</a> for details.
4979 </p>
4980 </dd>
4981 <dt class="hdlist1">
4982 diff.&lt;driver&gt;.binary
4983 </dt>
4984 <dd>
4985 <p>
4986         Set this option to true to make the diff driver treat files as
4987         binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
4988 </p>
4989 </dd>
4990 <dt class="hdlist1">
4991 diff.&lt;driver&gt;.textconv
4992 </dt>
4993 <dd>
4994 <p>
4995         The command that the diff driver should call to generate the
4996         text-converted version of a file.  The result of the
4997         conversion is used to generate a human-readable diff.  See
4998         <a href="gitattributes.html">gitattributes(5)</a> for details.
4999 </p>
5000 </dd>
5001 <dt class="hdlist1">
5002 diff.&lt;driver&gt;.wordRegex
5003 </dt>
5004 <dd>
5005 <p>
5006         The regular expression that the diff driver should use to
5007         split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
5008         details.
5009 </p>
5010 </dd>
5011 <dt class="hdlist1">
5012 diff.&lt;driver&gt;.cachetextconv
5013 </dt>
5014 <dd>
5015 <p>
5016         Set this option to true to make the diff driver cache the text
5017         conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5018 </p>
5019 <div class="dlist"><dl>
5020 <dt class="hdlist1">
5021 <code>araxis</code>
5022 </dt>
5023 <dd>
5024 <p>
5025 Use Araxis Merge (requires a graphical session)
5026 </p>
5027 </dd>
5028 <dt class="hdlist1">
5029 <code>bc</code>
5030 </dt>
5031 <dd>
5032 <p>
5033 Use Beyond Compare (requires a graphical session)
5034 </p>
5035 </dd>
5036 <dt class="hdlist1">
5037 <code>bc3</code>
5038 </dt>
5039 <dd>
5040 <p>
5041 Use Beyond Compare (requires a graphical session)
5042 </p>
5043 </dd>
5044 <dt class="hdlist1">
5045 <code>bc4</code>
5046 </dt>
5047 <dd>
5048 <p>
5049 Use Beyond Compare (requires a graphical session)
5050 </p>
5051 </dd>
5052 <dt class="hdlist1">
5053 <code>codecompare</code>
5054 </dt>
5055 <dd>
5056 <p>
5057 Use Code Compare (requires a graphical session)
5058 </p>
5059 </dd>
5060 <dt class="hdlist1">
5061 <code>deltawalker</code>
5062 </dt>
5063 <dd>
5064 <p>
5065 Use DeltaWalker (requires a graphical session)
5066 </p>
5067 </dd>
5068 <dt class="hdlist1">
5069 <code>diffmerge</code>
5070 </dt>
5071 <dd>
5072 <p>
5073 Use DiffMerge (requires a graphical session)
5074 </p>
5075 </dd>
5076 <dt class="hdlist1">
5077 <code>diffuse</code>
5078 </dt>
5079 <dd>
5080 <p>
5081 Use Diffuse (requires a graphical session)
5082 </p>
5083 </dd>
5084 <dt class="hdlist1">
5085 <code>ecmerge</code>
5086 </dt>
5087 <dd>
5088 <p>
5089 Use ECMerge (requires a graphical session)
5090 </p>
5091 </dd>
5092 <dt class="hdlist1">
5093 <code>emerge</code>
5094 </dt>
5095 <dd>
5096 <p>
5097 Use Emacs' Emerge
5098 </p>
5099 </dd>
5100 <dt class="hdlist1">
5101 <code>examdiff</code>
5102 </dt>
5103 <dd>
5104 <p>
5105 Use ExamDiff Pro (requires a graphical session)
5106 </p>
5107 </dd>
5108 <dt class="hdlist1">
5109 <code>guiffy</code>
5110 </dt>
5111 <dd>
5112 <p>
5113 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
5114 </p>
5115 </dd>
5116 <dt class="hdlist1">
5117 <code>gvimdiff</code>
5118 </dt>
5119 <dd>
5120 <p>
5121 Use gVim (requires a graphical session)
5122 </p>
5123 </dd>
5124 <dt class="hdlist1">
5125 <code>kdiff3</code>
5126 </dt>
5127 <dd>
5128 <p>
5129 Use KDiff3 (requires a graphical session)
5130 </p>
5131 </dd>
5132 <dt class="hdlist1">
5133 <code>kompare</code>
5134 </dt>
5135 <dd>
5136 <p>
5137 Use Kompare (requires a graphical session)
5138 </p>
5139 </dd>
5140 <dt class="hdlist1">
5141 <code>meld</code>
5142 </dt>
5143 <dd>
5144 <p>
5145 Use Meld (requires a graphical session)
5146 </p>
5147 </dd>
5148 <dt class="hdlist1">
5149 <code>nvimdiff</code>
5150 </dt>
5151 <dd>
5152 <p>
5153 Use Neovim
5154 </p>
5155 </dd>
5156 <dt class="hdlist1">
5157 <code>opendiff</code>
5158 </dt>
5159 <dd>
5160 <p>
5161 Use FileMerge (requires a graphical session)
5162 </p>
5163 </dd>
5164 <dt class="hdlist1">
5165 <code>p4merge</code>
5166 </dt>
5167 <dd>
5168 <p>
5169 Use HelixCore P4Merge (requires a graphical session)
5170 </p>
5171 </dd>
5172 <dt class="hdlist1">
5173 <code>smerge</code>
5174 </dt>
5175 <dd>
5176 <p>
5177 Use Sublime Merge (requires a graphical session)
5178 </p>
5179 </dd>
5180 <dt class="hdlist1">
5181 <code>tkdiff</code>
5182 </dt>
5183 <dd>
5184 <p>
5185 Use TkDiff (requires a graphical session)
5186 </p>
5187 </dd>
5188 <dt class="hdlist1">
5189 <code>vimdiff</code>
5190 </dt>
5191 <dd>
5192 <p>
5193 Use Vim
5194 </p>
5195 </dd>
5196 <dt class="hdlist1">
5197 <code>winmerge</code>
5198 </dt>
5199 <dd>
5200 <p>
5201 Use WinMerge (requires a graphical session)
5202 </p>
5203 </dd>
5204 <dt class="hdlist1">
5205 <code>xxdiff</code>
5206 </dt>
5207 <dd>
5208 <p>
5209 Use xxdiff (requires a graphical session)
5210 </p>
5211 </dd>
5212 </dl></div>
5213 </dd>
5214 <dt class="hdlist1">
5215 diff.indentHeuristic
5216 </dt>
5217 <dd>
5218 <p>
5219         Set this option to <code>false</code> to disable the default heuristics
5220         that shift diff hunk boundaries to make patches easier to read.
5221 </p>
5222 </dd>
5223 <dt class="hdlist1">
5224 diff.algorithm
5225 </dt>
5226 <dd>
5227 <p>
5228         Choose a diff algorithm.  The variants are as follows:
5229 </p>
5230 <div class="openblock">
5231 <div class="content">
5232 <div class="dlist"><dl>
5233 <dt class="hdlist1">
5234 <code>default</code>, <code>myers</code>
5235 </dt>
5236 <dd>
5237 <p>
5238         The basic greedy diff algorithm. Currently, this is the default.
5239 </p>
5240 </dd>
5241 <dt class="hdlist1">
5242 <code>minimal</code>
5243 </dt>
5244 <dd>
5245 <p>
5246         Spend extra time to make sure the smallest possible diff is
5247         produced.
5248 </p>
5249 </dd>
5250 <dt class="hdlist1">
5251 <code>patience</code>
5252 </dt>
5253 <dd>
5254 <p>
5255         Use "patience diff" algorithm when generating patches.
5256 </p>
5257 </dd>
5258 <dt class="hdlist1">
5259 <code>histogram</code>
5260 </dt>
5261 <dd>
5262 <p>
5263         This algorithm extends the patience algorithm to "support
5264         low-occurrence common elements".
5265 </p>
5266 </dd>
5267 </dl></div>
5268 </div></div>
5269 </dd>
5270 <dt class="hdlist1">
5271 diff.wsErrorHighlight
5272 </dt>
5273 <dd>
5274 <p>
5275         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5276         lines of the diff.  Multiple values are separated by comma,
5277         <code>none</code> resets previous values, <code>default</code> reset the list to
5278         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
5279         whitespace errors are colored with <code>color.diff.whitespace</code>.
5280         The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
5281         overrides this setting.
5282 </p>
5283 </dd>
5284 <dt class="hdlist1">
5285 diff.colorMoved
5286 </dt>
5287 <dd>
5288 <p>
5289         If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
5290         in a diff are colored differently, for details of valid modes
5291         see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
5292         true the default color mode will be used. When set to false,
5293         moved lines are not colored.
5294 </p>
5295 </dd>
5296 <dt class="hdlist1">
5297 diff.colorMovedWS
5298 </dt>
5299 <dd>
5300 <p>
5301         When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5302         this option controls the <code>&lt;mode&gt;</code> how spaces are treated
5303         for details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.
5304 </p>
5305 </dd>
5306 <dt class="hdlist1">
5307 diff.tool
5308 </dt>
5309 <dd>
5310 <p>
5311         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
5312         This variable overrides the value configured in <code>merge.tool</code>.
5313         The list below shows the valid built-in values.
5314         Any other value is treated as a custom diff tool and requires
5315         that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
5316 </p>
5317 </dd>
5318 <dt class="hdlist1">
5319 diff.guitool
5320 </dt>
5321 <dd>
5322 <p>
5323         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
5324         the -g/--gui flag is specified. This variable overrides the value
5325         configured in <code>merge.guitool</code>. The list below shows the valid
5326         built-in values. Any other value is treated as a custom diff tool
5327         and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
5328         is defined.
5329 </p>
5330 </dd>
5331 <dt class="hdlist1">
5332 difftool.&lt;tool&gt;.cmd
5333 </dt>
5334 <dd>
5335 <p>
5336         Specify the command to invoke the specified diff tool.
5337         The specified command is evaluated in shell with the following
5338         variables available:  <em>LOCAL</em> is set to the name of the temporary
5339         file containing the contents of the diff pre-image and <em>REMOTE</em>
5340         is set to the name of the temporary file containing the contents
5341         of the diff post-image.
5342 </p>
5343 <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>
5344 </dd>
5345 <dt class="hdlist1">
5346 difftool.&lt;tool&gt;.path
5347 </dt>
5348 <dd>
5349 <p>
5350         Override the path for the given tool.  This is useful in case
5351         your tool is not in the PATH.
5352 </p>
5353 </dd>
5354 <dt class="hdlist1">
5355 difftool.trustExitCode
5356 </dt>
5357 <dd>
5358 <p>
5359         Exit difftool if the invoked diff tool returns a non-zero exit status.
5360 </p>
5361 <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>
5362 </dd>
5363 <dt class="hdlist1">
5364 difftool.prompt
5365 </dt>
5366 <dd>
5367 <p>
5368         Prompt before each invocation of the diff tool.
5369 </p>
5370 </dd>
5371 <dt class="hdlist1">
5372 difftool.guiDefault
5373 </dt>
5374 <dd>
5375 <p>
5376         Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5377         the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5378         depending on the presence of a <code>DISPLAY</code> environment variable value. The
5379         default is <code>false</code>, where the <code>--gui</code> argument must be provided
5380         explicitly for the <code>diff.guitool</code> to be used.
5381 </p>
5382 </dd>
5383 <dt class="hdlist1">
5384 extensions.objectFormat
5385 </dt>
5386 <dd>
5387 <p>
5388         Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
5389         <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
5390         this key unless <code>core.repositoryFormatVersion</code> is 1.
5391 </p>
5392 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5393 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
5394 work and will produce hard-to-diagnose issues.</p></div>
5395 </dd>
5396 <dt class="hdlist1">
5397 extensions.worktreeConfig
5398 </dt>
5399 <dd>
5400 <p>
5401         If enabled, then worktrees will load config settings from the
5402         <code>$GIT_DIR/config.worktree</code> file in addition to the
5403         <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5404         <code>$GIT_DIR</code> are the same for the main working tree, while other
5405         working trees have <code>$GIT_DIR</code> equal to
5406         <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
5407         <code>config.worktree</code> file will override settings from any other
5408         config files.
5409 </p>
5410 <div class="paragraph"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5411 certain values from the common config file to the main working tree&#8217;s
5412 <code>config.worktree</code> file, if present:</p></div>
5413 <div class="ulist"><ul>
5414 <li>
5415 <p>
5416 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5417   <code>$GIT_COMMON_DIR/config.worktree</code>.
5418 </p>
5419 </li>
5420 <li>
5421 <p>
5422 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5423   to <code>$GIT_COMMON_DIR/config.worktree</code>.
5424 </p>
5425 <div class="paragraph"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5426 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5427 sparse-checkout settings for each worktree. By default, the <code>git
5428 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5429 these config values on a per-worktree basis, and uses the
5430 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5431 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
5432 details.</p></div>
5433 <div class="paragraph"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5434 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5435 </li>
5436 </ul></div>
5437 </dd>
5438 <dt class="hdlist1">
5439 fastimport.unpackLimit
5440 </dt>
5441 <dd>
5442 <p>
5443         If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
5444         is below this limit, then the objects will be unpacked into
5445         loose object files.  However, if the number of imported objects
5446         equals or exceeds this limit, then the pack will be stored as a
5447         pack.  Storing the pack from a fast-import can make the import
5448         operation complete faster, especially on slow filesystems.  If
5449         not set, the value of <code>transfer.unpackLimit</code> is used instead.
5450 </p>
5451 </dd>
5452 <dt class="hdlist1">
5453 feature.*
5454 </dt>
5455 <dd>
5456 <p>
5457         The config settings that start with <code>feature.</code> modify the defaults of
5458         a group of other config settings. These groups are created by the Git
5459         developer community as recommended defaults and are subject to change.
5460         In particular, new config options may be added with different defaults.
5461 </p>
5462 </dd>
5463 <dt class="hdlist1">
5464 feature.experimental
5465 </dt>
5466 <dd>
5467 <p>
5468         Enable config options that are new to Git, and are being considered for
5469         future defaults. Config settings included here may be added or removed
5470         with each release, including minor version updates. These settings may
5471         have unintended interactions since they are so new. Please enable this
5472         setting if you are interested in providing feedback on experimental
5473         features. The new default values are:
5474 </p>
5475 <div class="ulist"><ul>
5476 <li>
5477 <p>
5478 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5479 skipping more commits at a time, reducing the number of round trips.
5480 </p>
5481 </li>
5482 <li>
5483 <p>
5484 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5485 walking fewer objects.
5486 </p>
5487 </li>
5488 </ul></div>
5489 </dd>
5490 <dt class="hdlist1">
5491 feature.manyFiles
5492 </dt>
5493 <dd>
5494 <p>
5495         Enable config options that optimize for repos with many files in the
5496         working directory. With many files, commands such as <code>git status</code> and
5497         <code>git checkout</code> may be slow and these new defaults improve performance:
5498 </p>
5499 <div class="ulist"><ul>
5500 <li>
5501 <p>
5502 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5503   checksum. Note that this will cause Git versions earlier than 2.13.0 to
5504   refuse to parse the index and Git versions earlier than 2.40.0 will report
5505   a corrupted index during <code>git fsck</code>.
5506 </p>
5507 </li>
5508 <li>
5509 <p>
5510 <code>index.version=4</code> enables path-prefix compression in the index.
5511 </p>
5512 </li>
5513 <li>
5514 <p>
5515 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5516 that mtime is working on your machine.
5517 </p>
5518 </li>
5519 </ul></div>
5520 </dd>
5521 <dt class="hdlist1">
5522 fetch.recurseSubmodules
5523 </dt>
5524 <dd>
5525 <p>
5526         This option controls whether <code>git fetch</code> (and the underlying fetch
5527         in <code>git pull</code>) will recursively fetch into populated submodules.
5528         This option can be set either to a boolean value or to <em>on-demand</em>.
5529         Setting it to a boolean changes the behavior of fetch and pull to
5530         recurse unconditionally into submodules when set to true or to not
5531         recurse at all when set to false. When set to <em>on-demand</em>, fetch and
5532         pull will only recurse into a populated submodule when its
5533         superproject retrieves a commit that updates the submodule&#8217;s
5534         reference.
5535         Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
5536 </p>
5537 </dd>
5538 <dt class="hdlist1">
5539 fetch.fsckObjects
5540 </dt>
5541 <dd>
5542 <p>
5543         If it is set to true, git-fetch-pack will check all fetched
5544         objects. See <code>transfer.fsckObjects</code> for what&#8217;s
5545         checked. Defaults to false. If not set, the value of
5546         <code>transfer.fsckObjects</code> is used instead.
5547 </p>
5548 </dd>
5549 <dt class="hdlist1">
5550 fetch.fsck.&lt;msg-id&gt;
5551 </dt>
5552 <dd>
5553 <p>
5554         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
5555         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5556         the <code>fsck.&lt;msg-id&gt;</code> documentation for details.
5557 </p>
5558 </dd>
5559 <dt class="hdlist1">
5560 fetch.fsck.skipList
5561 </dt>
5562 <dd>
5563 <p>
5564         Acts like <code>fsck.skipList</code>, but is used by
5565         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5566         the <code>fsck.skipList</code> documentation for details.
5567 </p>
5568 </dd>
5569 <dt class="hdlist1">
5570 fetch.unpackLimit
5571 </dt>
5572 <dd>
5573 <p>
5574         If the number of objects fetched over the Git native
5575         transfer is below this
5576         limit, then the objects will be unpacked into loose object
5577         files. However if the number of received objects equals or
5578         exceeds this limit then the received pack will be stored as
5579         a pack, after adding any missing delta bases.  Storing the
5580         pack from a push can make the push operation complete faster,
5581         especially on slow filesystems.  If not set, the value of
5582         <code>transfer.unpackLimit</code> is used instead.
5583 </p>
5584 </dd>
5585 <dt class="hdlist1">
5586 fetch.prune
5587 </dt>
5588 <dd>
5589 <p>
5590         If true, fetch will automatically behave as if the <code>--prune</code>
5591         option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
5592         and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.
5593 </p>
5594 </dd>
5595 <dt class="hdlist1">
5596 fetch.pruneTags
5597 </dt>
5598 <dd>
5599 <p>
5600         If true, fetch will automatically behave as if the
5601         <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
5602         if not set already. This allows for setting both this option
5603         and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
5604         refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
5605         section of <a href="git-fetch.html">git-fetch(1)</a>.
5606 </p>
5607 </dd>
5608 <dt class="hdlist1">
5609 fetch.output
5610 </dt>
5611 <dd>
5612 <p>
5613         Control how ref update status is printed. Valid values are
5614         <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
5615         OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.
5616 </p>
5617 </dd>
5618 <dt class="hdlist1">
5619 fetch.negotiationAlgorithm
5620 </dt>
5621 <dd>
5622 <p>
5623         Control how information about the commits in the local repository
5624         is sent when negotiating the contents of the packfile to be sent by
5625         the server.  Set to "consecutive" to use an algorithm that walks
5626         over consecutive commits checking each one.  Set to "skipping" to
5627         use an algorithm that skips commits in an effort to converge
5628         faster, but may result in a larger-than-necessary packfile; or set
5629         to "noop" to not send any information at all, which will almost
5630         certainly result in a larger-than-necessary packfile, but will skip
5631         the negotiation step.  Set to "default" to override settings made
5632         previously and use the default behaviour.  The default is normally
5633         "consecutive", but if <code>feature.experimental</code> is true, then the
5634         default is "skipping".  Unknown values will cause <em>git fetch</em> to
5635         error out.
5636 </p>
5637 <div class="paragraph"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
5638 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
5639 </dd>
5640 <dt class="hdlist1">
5641 fetch.showForcedUpdates
5642 </dt>
5643 <dd>
5644 <p>
5645         Set to false to enable <code>--no-show-forced-updates</code> in
5646         <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
5647         Defaults to true.
5648 </p>
5649 </dd>
5650 <dt class="hdlist1">
5651 fetch.parallel
5652 </dt>
5653 <dd>
5654 <p>
5655         Specifies the maximal number of fetch operations to be run in parallel
5656         at a time (submodules, or remotes when the <code>--multiple</code> option of
5657         <a href="git-fetch.html">git-fetch(1)</a> is in effect).
5658 </p>
5659 <div class="paragraph"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
5660 <div class="paragraph"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
5661 config setting.</p></div>
5662 </dd>
5663 <dt class="hdlist1">
5664 fetch.writeCommitGraph
5665 </dt>
5666 <dd>
5667 <p>
5668         Set to true to write a commit-graph after every <code>git fetch</code> command
5669         that downloads a pack-file from a remote. Using the <code>--split</code> option,
5670         most executions will create a very small commit-graph file on top of
5671         the existing commit-graph file(s). Occasionally, these files will
5672         merge and the write may take longer. Having an updated commit-graph
5673         file helps performance of many Git commands, including <code>git merge-base</code>,
5674         <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
5675 </p>
5676 </dd>
5677 <dt class="hdlist1">
5678 fetch.bundleURI
5679 </dt>
5680 <dd>
5681 <p>
5682         This value stores a URI for downloading Git object data from a bundle
5683         URI before performing an incremental fetch from the origin Git server.
5684         This is similar to how the <code>--bundle-uri</code> option behaves in
5685         <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
5686         <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
5687         list that is organized for incremental fetches.
5688 </p>
5689 <div class="paragraph"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
5690 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
5691 the new bundle URI.</p></div>
5692 </dd>
5693 <dt class="hdlist1">
5694 fetch.bundleCreationToken
5695 </dt>
5696 <dd>
5697 <p>
5698         When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
5699         list that uses the "creationToken" heuristic, this config value
5700         stores the maximum <code>creationToken</code> value of the downloaded bundles.
5701         This value is used to prevent downloading bundles in the future
5702         if the advertised <code>creationToken</code> is not strictly larger than this
5703         value.
5704 </p>
5705 <div class="paragraph"><p>The creation token values are chosen by the provider serving the specific
5706 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
5707 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
5708 </dd>
5709 <dt class="hdlist1">
5710 format.attach
5711 </dt>
5712 <dd>
5713 <p>
5714         Enable multipart/mixed attachments as the default for
5715         <em>format-patch</em>.  The value can also be a double quoted string
5716         which will enable attachments as the default and set the
5717         value as the boundary.  See the --attach option in
5718         <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
5719         value, set it to an empty string.
5720 </p>
5721 </dd>
5722 <dt class="hdlist1">
5723 format.from
5724 </dt>
5725 <dd>
5726 <p>
5727         Provides the default value for the <code>--from</code> option to format-patch.
5728         Accepts a boolean value, or a name and email address.  If false,
5729         format-patch defaults to <code>--no-from</code>, using commit authors directly in
5730         the "From:" field of patch mails.  If true, format-patch defaults to
5731         <code>--from</code>, using your committer identity in the "From:" field of patch
5732         mails and including a "From:" field in the body of the patch mail if
5733         different.  If set to a non-boolean value, format-patch uses that
5734         value instead of your committer identity.  Defaults to false.
5735 </p>
5736 </dd>
5737 <dt class="hdlist1">
5738 format.forceInBodyFrom
5739 </dt>
5740 <dd>
5741 <p>
5742         Provides the default value for the <code>--[no-]force-in-body-from</code>
5743         option to format-patch.  Defaults to false.
5744 </p>
5745 </dd>
5746 <dt class="hdlist1">
5747 format.numbered
5748 </dt>
5749 <dd>
5750 <p>
5751         A boolean which can enable or disable sequence numbers in patch
5752         subjects.  It defaults to "auto" which enables it only if there
5753         is more than one patch.  It can be enabled or disabled for all
5754         messages by setting it to "true" or "false".  See --numbered
5755         option in <a href="git-format-patch.html">git-format-patch(1)</a>.
5756 </p>
5757 </dd>
5758 <dt class="hdlist1">
5759 format.headers
5760 </dt>
5761 <dd>
5762 <p>
5763         Additional email headers to include in a patch to be submitted
5764         by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.
5765 </p>
5766 </dd>
5767 <dt class="hdlist1">
5768 format.to
5769 </dt>
5770 <dt class="hdlist1">
5771 format.cc
5772 </dt>
5773 <dd>
5774 <p>
5775         Additional recipients to include in a patch to be submitted
5776         by mail.  See the --to and --cc options in
5777         <a href="git-format-patch.html">git-format-patch(1)</a>.
5778 </p>
5779 </dd>
5780 <dt class="hdlist1">
5781 format.subjectPrefix
5782 </dt>
5783 <dd>
5784 <p>
5785         The default for format-patch is to output files with the <em>[PATCH]</em>
5786         subject prefix. Use this variable to change that prefix.
5787 </p>
5788 </dd>
5789 <dt class="hdlist1">
5790 format.coverFromDescription
5791 </dt>
5792 <dd>
5793 <p>
5794         The default mode for format-patch to determine which parts of
5795         the cover letter will be populated using the branch&#8217;s
5796         description. See the <code>--cover-from-description</code> option in
5797         <a href="git-format-patch.html">git-format-patch(1)</a>.
5798 </p>
5799 </dd>
5800 <dt class="hdlist1">
5801 format.signature
5802 </dt>
5803 <dd>
5804 <p>
5805         The default for format-patch is to output a signature containing
5806         the Git version number. Use this variable to change that default.
5807         Set this variable to the empty string ("") to suppress
5808         signature generation.
5809 </p>
5810 </dd>
5811 <dt class="hdlist1">
5812 format.signatureFile
5813 </dt>
5814 <dd>
5815 <p>
5816         Works just like format.signature except the contents of the
5817         file specified by this variable will be used as the signature.
5818 </p>
5819 </dd>
5820 <dt class="hdlist1">
5821 format.suffix
5822 </dt>
5823 <dd>
5824 <p>
5825         The default for format-patch is to output files with the suffix
5826         <code>.patch</code>. Use this variable to change that suffix (make sure to
5827         include the dot if you want it).
5828 </p>
5829 </dd>
5830 <dt class="hdlist1">
5831 format.encodeEmailHeaders
5832 </dt>
5833 <dd>
5834 <p>
5835         Encode email headers that have non-ASCII characters with
5836         "Q-encoding" (described in RFC 2047) for email transmission.
5837         Defaults to true.
5838 </p>
5839 </dd>
5840 <dt class="hdlist1">
5841 format.pretty
5842 </dt>
5843 <dd>
5844 <p>
5845         The default pretty format for log/show/whatchanged command.
5846         See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
5847         <a href="git-whatchanged.html">git-whatchanged(1)</a>.
5848 </p>
5849 </dd>
5850 <dt class="hdlist1">
5851 format.thread
5852 </dt>
5853 <dd>
5854 <p>
5855         The default threading style for <em>git format-patch</em>.  Can be
5856         a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
5857         makes every mail a reply to the head of the series,
5858         where the head is chosen from the cover letter, the
5859         <code>--in-reply-to</code>, and the first patch mail, in this order.
5860         <code>deep</code> threading makes every mail a reply to the previous one.
5861         A true boolean value is the same as <code>shallow</code>, and a false
5862         value disables threading.
5863 </p>
5864 </dd>
5865 <dt class="hdlist1">
5866 format.signOff
5867 </dt>
5868 <dd>
5869 <p>
5870         A boolean value which lets you enable the <code>-s/--signoff</code> option of
5871         format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
5872         patch should be a conscious act and means that you certify you have
5873         the rights to submit this work under the same open source license.
5874         Please see the <em>SubmittingPatches</em> document for further discussion.
5875 </p>
5876 </dd>
5877 <dt class="hdlist1">
5878 format.coverLetter
5879 </dt>
5880 <dd>
5881 <p>
5882         A boolean that controls whether to generate a cover-letter when
5883         format-patch is invoked, but in addition can be set to "auto", to
5884         generate a cover-letter only when there&#8217;s more than one patch.
5885         Default is false.
5886 </p>
5887 </dd>
5888 <dt class="hdlist1">
5889 format.outputDirectory
5890 </dt>
5891 <dd>
5892 <p>
5893         Set a custom directory to store the resulting files instead of the
5894         current working directory. All directory components will be created.
5895 </p>
5896 </dd>
5897 <dt class="hdlist1">
5898 format.filenameMaxLength
5899 </dt>
5900 <dd>
5901 <p>
5902         The maximum length of the output filenames generated by the
5903         <code>format-patch</code> command; defaults to 64.  Can be overridden
5904         by the <code>--filename-max-length=&lt;n&gt;</code> command line option.
5905 </p>
5906 </dd>
5907 <dt class="hdlist1">
5908 format.useAutoBase
5909 </dt>
5910 <dd>
5911 <p>
5912         A boolean value which lets you enable the <code>--base=auto</code> option of
5913         format-patch by default. Can also be set to "whenAble" to allow
5914         enabling <code>--base=auto</code> if a suitable base is available, but to skip
5915         adding base info otherwise without the format dying.
5916 </p>
5917 </dd>
5918 <dt class="hdlist1">
5919 format.notes
5920 </dt>
5921 <dd>
5922 <p>
5923         Provides the default value for the <code>--notes</code> option to
5924         format-patch. Accepts a boolean value, or a ref which specifies
5925         where to get notes. If false, format-patch defaults to
5926         <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
5927         set to a non-boolean value, format-patch defaults to
5928         <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
5929         to false.
5930 </p>
5931 <div class="paragraph"><p>If one wishes to use the ref <code>ref/notes/true</code>, please use that literal
5932 instead.</p></div>
5933 <div class="paragraph"><p>This configuration can be specified multiple times in order to allow
5934 multiple notes refs to be included. In that case, it will behave
5935 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
5936 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
5937 also show notes from that notes ref and a value of <code>false</code> will negate
5938 previous configurations and not show notes.</p></div>
5939 <div class="paragraph"><p>For example,</p></div>
5940 <div class="listingblock">
5941 <div class="content">
5942 <pre><code>[format]
5943         notes = true
5944         notes = foo
5945         notes = false
5946         notes = bar</code></pre>
5947 </div></div>
5948 <div class="paragraph"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
5949 </dd>
5950 <dt class="hdlist1">
5951 format.mboxrd
5952 </dt>
5953 <dd>
5954 <p>
5955         A boolean value which enables the robust "mboxrd" format when
5956         <code>--stdout</code> is in use to escape "^&gt;+From " lines.
5957 </p>
5958 </dd>
5959 <dt class="hdlist1">
5960 format.noprefix
5961 </dt>
5962 <dd>
5963 <p>
5964         If set, do not show any source or destination prefix in patches.
5965         This is equivalent to the <code>diff.noprefix</code> option used by <code>git
5966         diff</code> (but which is not respected by <code>format-patch</code>). Note that
5967         by setting this, the receiver of any patches you generate will
5968         have to apply them using the <code>-p0</code> option.
5969 </p>
5970 </dd>
5971 <dt class="hdlist1">
5972 filter.&lt;driver&gt;.clean
5973 </dt>
5974 <dd>
5975 <p>
5976         The command which is used to convert the content of a worktree
5977         file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
5978         details.
5979 </p>
5980 </dd>
5981 <dt class="hdlist1">
5982 filter.&lt;driver&gt;.smudge
5983 </dt>
5984 <dd>
5985 <p>
5986         The command which is used to convert the content of a blob
5987         object to a worktree file upon checkout.  See
5988         <a href="gitattributes.html">gitattributes(5)</a> for details.
5989 </p>
5990 </dd>
5991 <dt class="hdlist1">
5992 fsck.&lt;msg-id&gt;
5993 </dt>
5994 <dd>
5995 <p>
5996         During fsck git may find issues with legacy data which
5997         wouldn&#8217;t be generated by current versions of git, and which
5998         wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
5999         set. This feature is intended to support working with legacy
6000         repositories containing such data.
6001 </p>
6002 <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
6003 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
6004 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
6005 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
6006 same applies for the corresponding <code>receive.fsck.*</code> and
6007 <code>fetch.fsck.*</code>. variables.</p></div>
6008 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
6009 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
6010 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
6011 uniformly configure the same fsck settings in different circumstances,
6012 all three of them must be set to the same values.</p></div>
6013 <div class="paragraph"><p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
6014 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
6015 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
6016 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
6017 with the message ID, e.g. "missingEmail: invalid author/committer
6018 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
6019 will hide that issue.</p></div>
6020 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
6021 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6022 problematic objects share to be ignored, as doing the latter will
6023 allow new instances of the same breakages go unnoticed.</p></div>
6024 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
6025 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
6026 will only cause git to warn.</p></div>
6027 <div class="paragraph"><p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
6028 values of <code>&lt;msg-id&gt;</code>.</p></div>
6029 </dd>
6030 <dt class="hdlist1">
6031 fsck.skipList
6032 </dt>
6033 <dd>
6034 <p>
6035         The path to a list of object names (i.e. one unabbreviated SHA-1 per
6036         line) that are known to be broken in a non-fatal way and should
6037         be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
6038         lines, and any leading and trailing whitespace are ignored. Everything
6039         but a SHA-1 per line will error out on older versions.
6040 </p>
6041 <div class="paragraph"><p>This feature is useful when an established project should be accepted
6042 despite early commits containing errors that can be safely ignored,
6043 such as invalid committer email addresses.  Note: corrupt objects
6044 cannot be skipped with this setting.</p></div>
6045 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
6046 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6047 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6048 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6049 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
6050 uniformly configure the same fsck settings in different circumstances,
6051 all three of them must be set to the same values.</p></div>
6052 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
6053 list should be sorted. This was never a requirement; the object names
6054 could appear in any order, but when reading the list we tracked whether
6055 the list was sorted for the purposes of an internal binary search
6056 implementation, which could save itself some work with an already sorted
6057 list. Unless you had a humongous list there was no reason to go out of
6058 your way to pre-sort the list. After Git version 2.20 a hash implementation
6059 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
6060 </dd>
6061 <dt class="hdlist1">
6062 fsmonitor.allowRemote
6063 </dt>
6064 <dd>
6065 <p>
6066     By default, the fsmonitor daemon refuses to work with network-mounted
6067     repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6068     behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6069 </p>
6070 </dd>
6071 <dt class="hdlist1">
6072 fsmonitor.socketDir
6073 </dt>
6074 <dd>
6075 <p>
6076     This Mac OS-specific option, if set, specifies the directory in
6077     which to create the Unix domain socket used for communication
6078     between the fsmonitor daemon and various Git commands. The directory must
6079     reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
6080     is set to <code>true</code>.
6081 </p>
6082 </dd>
6083 <dt class="hdlist1">
6084 gc.aggressiveDepth
6085 </dt>
6086 <dd>
6087 <p>
6088         The depth parameter used in the delta compression
6089         algorithm used by <em>git gc --aggressive</em>.  This defaults
6090         to 50, which is the default for the <code>--depth</code> option when
6091         <code>--aggressive</code> isn&#8217;t in use.
6092 </p>
6093 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
6094 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6095 </dd>
6096 <dt class="hdlist1">
6097 gc.aggressiveWindow
6098 </dt>
6099 <dd>
6100 <p>
6101         The window size parameter used in the delta compression
6102         algorithm used by <em>git gc --aggressive</em>.  This defaults
6103         to 250, which is a much more aggressive window size than
6104         the default <code>--window</code> of 10.
6105 </p>
6106 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
6107 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6108 </dd>
6109 <dt class="hdlist1">
6110 gc.auto
6111 </dt>
6112 <dd>
6113 <p>
6114         When there are approximately more than this many loose
6115         objects in the repository, <code>git gc --auto</code> will pack them.
6116         Some Porcelain commands use this command to perform a
6117         light-weight garbage collection from time to time.  The
6118         default value is 6700.
6119 </p>
6120 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
6121 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
6122 otherwise use to determine if there&#8217;s work to do, such as
6123 <code>gc.autoPackLimit</code>.</p></div>
6124 </dd>
6125 <dt class="hdlist1">
6126 gc.autoPackLimit
6127 </dt>
6128 <dd>
6129 <p>
6130         When there are more than this many packs that are not
6131         marked with <code>*.keep</code> file in the repository, <code>git gc
6132         --auto</code> consolidates them into one larger pack.  The
6133         default value is 50.  Setting this to 0 disables it.
6134         Setting <code>gc.auto</code> to 0 will also disable this.
6135 </p>
6136 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6137 use, it&#8217;ll affect how the auto pack limit works.</p></div>
6138 </dd>
6139 <dt class="hdlist1">
6140 gc.autoDetach
6141 </dt>
6142 <dd>
6143 <p>
6144         Make <code>git gc --auto</code> return immediately and run in the background
6145         if the system supports it. Default is true.
6146 </p>
6147 </dd>
6148 <dt class="hdlist1">
6149 gc.bigPackThreshold
6150 </dt>
6151 <dd>
6152 <p>
6153         If non-zero, all non-cruft packs larger than this limit are kept
6154         when <code>git gc</code> is run. This is very similar to
6155         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6156         the threshold are kept, not just the largest pack. Defaults to
6157         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6158 </p>
6159 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6160 this configuration variable is ignored, all packs except the base pack
6161 will be repacked. After this the number of packs should go below
6162 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6163 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6164 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6165 will also be excluded (this is the equivalent of running <code>git gc</code> with
6166 <code>--keep-largest-pack</code>).</p></div>
6167 </dd>
6168 <dt class="hdlist1">
6169 gc.writeCommitGraph
6170 </dt>
6171 <dd>
6172 <p>
6173         If true, then gc will rewrite the commit-graph file when
6174         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6175         the commit-graph will be updated if housekeeping is
6176         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
6177         for details.
6178 </p>
6179 </dd>
6180 <dt class="hdlist1">
6181 gc.logExpiry
6182 </dt>
6183 <dd>
6184 <p>
6185         If the file gc.log exists, then <code>git gc --auto</code> will print
6186         its content and exit with status zero instead of running
6187         unless that file is more than <em>gc.logExpiry</em> old.  Default is
6188         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
6189         value.
6190 </p>
6191 </dd>
6192 <dt class="hdlist1">
6193 gc.packRefs
6194 </dt>
6195 <dd>
6196 <p>
6197         Running <code>git pack-refs</code> in a repository renders it
6198         unclonable by Git versions prior to 1.5.1.2 over dumb
6199         transports such as HTTP.  This variable determines whether
6200         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6201         to enable it within all non-bare repos or it can be set to a
6202         boolean value.  The default is <code>true</code>.
6203 </p>
6204 </dd>
6205 <dt class="hdlist1">
6206 gc.cruftPacks
6207 </dt>
6208 <dd>
6209 <p>
6210         Store unreachable objects in a cruft pack (see
6211         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
6212         is <code>true</code>.
6213 </p>
6214 </dd>
6215 <dt class="hdlist1">
6216 gc.maxCruftSize
6217 </dt>
6218 <dd>
6219 <p>
6220         Limit the size of new cruft packs when repacking. When
6221         specified in addition to <code>--max-cruft-size</code>, the command line
6222         option takes priority. See the <code>--max-cruft-size</code> option of
6223         <a href="git-repack.html">git-repack(1)</a>.
6224 </p>
6225 </dd>
6226 <dt class="hdlist1">
6227 gc.pruneExpire
6228 </dt>
6229 <dd>
6230 <p>
6231         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6232         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6233         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
6234         grace period with this config variable.  The value "now" may be
6235         used to disable this grace period and always prune unreachable
6236         objects immediately, or "never" may be used to suppress pruning.
6237         This feature helps prevent corruption when <em>git gc</em> runs
6238         concurrently with another process writing to the repository; see
6239         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
6240 </p>
6241 </dd>
6242 <dt class="hdlist1">
6243 gc.worktreePruneExpire
6244 </dt>
6245 <dd>
6246 <p>
6247         When <em>git gc</em> is run, it calls
6248         <em>git worktree prune --expire 3.months.ago</em>.
6249         This config variable can be used to set a different grace
6250         period. The value "now" may be used to disable the grace
6251         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
6252         may be used to suppress pruning.
6253 </p>
6254 </dd>
6255 <dt class="hdlist1">
6256 gc.reflogExpire
6257 </dt>
6258 <dt class="hdlist1">
6259 gc.&lt;pattern&gt;.reflogExpire
6260 </dt>
6261 <dd>
6262 <p>
6263         <em>git reflog expire</em> removes reflog entries older than
6264         this time; defaults to 90 days. The value "now" expires all
6265         entries immediately, and "never" suppresses expiration
6266         altogether. With "&lt;pattern&gt;" (e.g.
6267         "refs/stash") in the middle the setting applies only to
6268         the refs that match the &lt;pattern&gt;.
6269 </p>
6270 </dd>
6271 <dt class="hdlist1">
6272 gc.reflogExpireUnreachable
6273 </dt>
6274 <dt class="hdlist1">
6275 gc.&lt;pattern&gt;.reflogExpireUnreachable
6276 </dt>
6277 <dd>
6278 <p>
6279         <em>git reflog expire</em> removes reflog entries older than
6280         this time and are not reachable from the current tip;
6281         defaults to 30 days. The value "now" expires all entries
6282         immediately, and "never" suppresses expiration altogether.
6283         With "&lt;pattern&gt;" (e.g. "refs/stash")
6284         in the middle, the setting applies only to the refs that
6285         match the &lt;pattern&gt;.
6286 </p>
6287 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
6288 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6289 or rebase occurring.  Since these changes are not part of the current
6290 project most users will want to expire them sooner, which is why the
6291 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6292 </dd>
6293 <dt class="hdlist1">
6294 gc.recentObjectsHook
6295 </dt>
6296 <dd>
6297 <p>
6298         When considering whether or not to remove an object (either when
6299         generating a cruft pack or storing unreachable objects as
6300         loose), use the shell to execute the specified command(s).
6301         Interpret their output as object IDs which Git will consider as
6302         "recent", regardless of their age. By treating their mtimes as
6303         "now", any objects (and their descendants) mentioned in the
6304         output will be kept regardless of their true age.
6305 </p>
6306 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
6307 else. Objects which cannot be found in the repository are ignored.
6308 Multiple hooks are supported, but all must exit successfully, else the
6309 operation (either generating a cruft pack or unpacking unreachable
6310 objects) will be halted.</p></div>
6311 </dd>
6312 <dt class="hdlist1">
6313 gc.repackFilter
6314 </dt>
6315 <dd>
6316 <p>
6317         When repacking, use the specified filter to move certain
6318         objects into a separate packfile.  See the
6319         <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.
6320 </p>
6321 </dd>
6322 <dt class="hdlist1">
6323 gc.repackFilterTo
6324 </dt>
6325 <dd>
6326 <p>
6327         When repacking and using a filter, see <code>gc.repackFilter</code>, the
6328         specified location will be used to create the packfile
6329         containing the filtered out objects. <strong>WARNING:</strong> The
6330         specified location should be accessible, using for example the
6331         Git alternates mechanism, otherwise the repo could be
6332         considered corrupt by Git as it migh not be able to access the
6333         objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
6334         of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
6335         section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.
6336 </p>
6337 </dd>
6338 <dt class="hdlist1">
6339 gc.rerereResolved
6340 </dt>
6341 <dd>
6342 <p>
6343         Records of conflicted merge you resolved earlier are
6344         kept for this many days when <em>git rerere gc</em> is run.
6345         You can also use more human-readable "1.month.ago", etc.
6346         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6347 </p>
6348 </dd>
6349 <dt class="hdlist1">
6350 gc.rerereUnresolved
6351 </dt>
6352 <dd>
6353 <p>
6354         Records of conflicted merge you have not resolved are
6355         kept for this many days when <em>git rerere gc</em> is run.
6356         You can also use more human-readable "1.month.ago", etc.
6357         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6358 </p>
6359 </dd>
6360 <dt class="hdlist1">
6361 gitcvs.commitMsgAnnotation
6362 </dt>
6363 <dd>
6364 <p>
6365         Append this string to each commit message. Set to empty string
6366         to disable this feature. Defaults to "via git-CVS emulator".
6367 </p>
6368 </dd>
6369 <dt class="hdlist1">
6370 gitcvs.enabled
6371 </dt>
6372 <dd>
6373 <p>
6374         Whether the CVS server interface is enabled for this repository.
6375         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6376 </p>
6377 </dd>
6378 <dt class="hdlist1">
6379 gitcvs.logFile
6380 </dt>
6381 <dd>
6382 <p>
6383         Path to a log file where the CVS server interface well&#8230; logs
6384         various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6385 </p>
6386 </dd>
6387 <dt class="hdlist1">
6388 gitcvs.usecrlfattr
6389 </dt>
6390 <dd>
6391 <p>
6392         If true, the server will look up the end-of-line conversion
6393         attributes for files to determine the <code>-k</code> modes to use. If
6394         the attributes force Git to treat a file as text,
6395         the <code>-k</code> mode will be left blank so CVS clients will
6396         treat it as text. If they suppress text conversion, the file
6397         will be set with <em>-kb</em> mode, which suppresses any newline munging
6398         the client might otherwise do. If the attributes do not allow
6399         the file type to be determined, then <code>gitcvs.allBinary</code> is
6400         used. See <a href="gitattributes.html">gitattributes(5)</a>.
6401 </p>
6402 </dd>
6403 <dt class="hdlist1">
6404 gitcvs.allBinary
6405 </dt>
6406 <dd>
6407 <p>
6408         This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6409         the correct <em>-kb</em> mode to use. If true, all
6410         unresolved files are sent to the client in
6411         mode <em>-kb</em>. This causes the client to treat them
6412         as binary files, which suppresses any newline munging it
6413         otherwise might do. Alternatively, if it is set to "guess",
6414         then the contents of the file are examined to decide if
6415         it is binary, similar to <code>core.autocrlf</code>.
6416 </p>
6417 </dd>
6418 <dt class="hdlist1">
6419 gitcvs.dbName
6420 </dt>
6421 <dd>
6422 <p>
6423         Database used by git-cvsserver to cache revision information
6424         derived from the Git repository. The exact meaning depends on the
6425         used database driver, for SQLite (which is the default driver) this
6426         is a filename. Supports variable substitution (see
6427         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6428         Default: <em>%Ggitcvs.%m.sqlite</em>
6429 </p>
6430 </dd>
6431 <dt class="hdlist1">
6432 gitcvs.dbDriver
6433 </dt>
6434 <dd>
6435 <p>
6436         Used Perl DBI driver. You can specify any available driver
6437         for this here, but it might not work. git-cvsserver is tested
6438         with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6439         reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6440         May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6441         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6442 </p>
6443 </dd>
6444 <dt class="hdlist1">
6445 gitcvs.dbUser, gitcvs.dbPass
6446 </dt>
6447 <dd>
6448 <p>
6449         Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6450         since SQLite has no concept of database users and/or passwords.
6451         <em>gitcvs.dbUser</em> supports variable substitution (see
6452         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
6453 </p>
6454 </dd>
6455 <dt class="hdlist1">
6456 gitcvs.dbTableNamePrefix
6457 </dt>
6458 <dd>
6459 <p>
6460         Database table name prefix.  Prepended to the names of any
6461         database tables used, allowing a single database to be used
6462         for several repositories.  Supports variable substitution (see
6463         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
6464         characters will be replaced with underscores.
6465 </p>
6466 </dd>
6467 </dl></div>
6468 <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6469 <code>gitcvs.allBinary</code> can also be specified as
6470 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
6471 is one of "ext" and "pserver") to make them apply only for the given
6472 access method.</p></div>
6473 <div class="dlist"><dl>
6474 <dt class="hdlist1">
6475 gitweb.category
6476 </dt>
6477 <dt class="hdlist1">
6478 gitweb.description
6479 </dt>
6480 <dt class="hdlist1">
6481 gitweb.owner
6482 </dt>
6483 <dt class="hdlist1">
6484 gitweb.url
6485 </dt>
6486 <dd>
6487 <p>
6488         See <a href="gitweb.html">gitweb(1)</a> for description.
6489 </p>
6490 </dd>
6491 <dt class="hdlist1">
6492 gitweb.avatar
6493 </dt>
6494 <dt class="hdlist1">
6495 gitweb.blame
6496 </dt>
6497 <dt class="hdlist1">
6498 gitweb.grep
6499 </dt>
6500 <dt class="hdlist1">
6501 gitweb.highlight
6502 </dt>
6503 <dt class="hdlist1">
6504 gitweb.patches
6505 </dt>
6506 <dt class="hdlist1">
6507 gitweb.pickaxe
6508 </dt>
6509 <dt class="hdlist1">
6510 gitweb.remote_heads
6511 </dt>
6512 <dt class="hdlist1">
6513 gitweb.showSizes
6514 </dt>
6515 <dt class="hdlist1">
6516 gitweb.snapshot
6517 </dt>
6518 <dd>
6519 <p>
6520         See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
6521 </p>
6522 </dd>
6523 <dt class="hdlist1">
6524 grep.lineNumber
6525 </dt>
6526 <dd>
6527 <p>
6528         If set to true, enable <code>-n</code> option by default.
6529 </p>
6530 </dd>
6531 <dt class="hdlist1">
6532 grep.column
6533 </dt>
6534 <dd>
6535 <p>
6536         If set to true, enable the <code>--column</code> option by default.
6537 </p>
6538 </dd>
6539 <dt class="hdlist1">
6540 grep.patternType
6541 </dt>
6542 <dd>
6543 <p>
6544         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
6545         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
6546         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
6547         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
6548         between <em>basic</em> and <em>extended</em>.
6549 </p>
6550 </dd>
6551 <dt class="hdlist1">
6552 grep.extendedRegexp
6553 </dt>
6554 <dd>
6555 <p>
6556         If set to true, enable <code>--extended-regexp</code> option by default. This
6557         option is ignored when the <code>grep.patternType</code> option is set to a value
6558         other than <em>default</em>.
6559 </p>
6560 </dd>
6561 <dt class="hdlist1">
6562 grep.threads
6563 </dt>
6564 <dd>
6565 <p>
6566         Number of grep worker threads to use. If unset (or set to 0), Git will
6567         use as many threads as the number of logical cores available.
6568 </p>
6569 </dd>
6570 <dt class="hdlist1">
6571 grep.fullName
6572 </dt>
6573 <dd>
6574 <p>
6575         If set to true, enable <code>--full-name</code> option by default.
6576 </p>
6577 </dd>
6578 <dt class="hdlist1">
6579 grep.fallbackToNoIndex
6580 </dt>
6581 <dd>
6582 <p>
6583         If set to true, fall back to git grep --no-index if git grep
6584         is executed outside of a git repository.  Defaults to false.
6585 </p>
6586 </dd>
6587 <dt class="hdlist1">
6588 gpg.program
6589 </dt>
6590 <dd>
6591 <p>
6592         Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
6593         making or verifying a PGP signature. The program must support the
6594         same command-line interface as GPG, namely, to verify a detached
6595         signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
6596         program is expected to signal a good signature by exiting with
6597         code 0.  To generate an ASCII-armored detached signature, the
6598         standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
6599         signed, and the program is expected to send the result to its
6600         standard output.
6601 </p>
6602 </dd>
6603 <dt class="hdlist1">
6604 gpg.format
6605 </dt>
6606 <dd>
6607 <p>
6608         Specifies which key format to use when signing with <code>--gpg-sign</code>.
6609         Default is "openpgp". Other possible values are "x509", "ssh".
6610 </p>
6611 <div class="paragraph"><p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
6612 based on the selected <code>gpg.format</code>.</p></div>
6613 </dd>
6614 <dt class="hdlist1">
6615 gpg.&lt;format&gt;.program
6616 </dt>
6617 <dd>
6618 <p>
6619         Use this to customize the program used for the signing format you
6620         chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
6621         be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
6622         value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".
6623 </p>
6624 </dd>
6625 <dt class="hdlist1">
6626 gpg.minTrustLevel
6627 </dt>
6628 <dd>
6629 <p>
6630         Specifies a minimum trust level for signature verification.  If
6631         this option is unset, then signature verification for merge
6632         operations requires a key with at least <code>marginal</code> trust.  Other
6633         operations that perform signature verification require a key
6634         with at least <code>undefined</code> trust.  Setting this option overrides
6635         the required trust-level for all operations.  Supported values,
6636         in increasing order of significance:
6637 </p>
6638 <div class="ulist"><ul>
6639 <li>
6640 <p>
6641 <code>undefined</code>
6642 </p>
6643 </li>
6644 <li>
6645 <p>
6646 <code>never</code>
6647 </p>
6648 </li>
6649 <li>
6650 <p>
6651 <code>marginal</code>
6652 </p>
6653 </li>
6654 <li>
6655 <p>
6656 <code>fully</code>
6657 </p>
6658 </li>
6659 <li>
6660 <p>
6661 <code>ultimate</code>
6662 </p>
6663 </li>
6664 </ul></div>
6665 </dd>
6666 <dt class="hdlist1">
6667 gpg.ssh.defaultKeyCommand
6668 </dt>
6669 <dd>
6670 <p>
6671         This command will be run when user.signingkey is not set and a ssh
6672         signature is requested. On successful exit a valid ssh public key
6673         prefixed with <code>key::</code> is expected in the first line of its output.
6674         This allows for a script doing a dynamic lookup of the correct public
6675         key when it is impractical to statically configure <code>user.signingKey</code>.
6676         For example when keys or SSH Certificates are rotated frequently or
6677         selection of the right key depends on external factors unknown to git.
6678 </p>
6679 </dd>
6680 <dt class="hdlist1">
6681 gpg.ssh.allowedSignersFile
6682 </dt>
6683 <dd>
6684 <p>
6685         A file containing ssh public keys which you are willing to trust.
6686         The file consists of one or more lines of principals followed by an ssh
6687         public key.
6688         e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
6689         See ssh-keygen(1) "ALLOWED SIGNERS" for details.
6690         The principal is only used to identify the key and is available when
6691         verifying a signature.
6692 </p>
6693 <div class="paragraph"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
6694 between valid signatures and trusted signatures the trust level of a signature
6695 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
6696 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
6697 <div class="paragraph"><p>This file can be set to a location outside of the repository and every developer
6698 maintains their own trust store. A central repository server could generate this
6699 file automatically from ssh keys with push access to verify the code against.
6700 In a corporate setting this file is probably generated at a global location
6701 from automation that already handles developer ssh keys.</p></div>
6702 <div class="paragraph"><p>A repository that only allows signed commits can store the file
6703 in the repository itself using a path relative to the top-level of the working tree.
6704 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
6705 <div class="paragraph"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
6706 valid-before options. Git will mark signatures as valid if the signing key was
6707 valid at the time of the signature&#8217;s creation. This allows users to change a
6708 signing key without invalidating all previously made signatures.</p></div>
6709 <div class="paragraph"><p>Using a SSH CA key with the cert-authority option
6710 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p></div>
6711 </dd>
6712 <dt class="hdlist1">
6713 gpg.ssh.revocationFile
6714 </dt>
6715 <dd>
6716 <p>
6717         Either a SSH KRL or a list of revoked public keys (without the principal prefix).
6718         See ssh-keygen(1) for details.
6719         If a public key is found in this file then it will always be treated
6720         as having trust level "never" and signatures will show as invalid.
6721 </p>
6722 </dd>
6723 <dt class="hdlist1">
6724 gui.commitMsgWidth
6725 </dt>
6726 <dd>
6727 <p>
6728         Defines how wide the commit message window is in the
6729         <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
6730 </p>
6731 </dd>
6732 <dt class="hdlist1">
6733 gui.diffContext
6734 </dt>
6735 <dd>
6736 <p>
6737         Specifies how many context lines should be used in calls to diff
6738         made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
6739 </p>
6740 </dd>
6741 <dt class="hdlist1">
6742 gui.displayUntracked
6743 </dt>
6744 <dd>
6745 <p>
6746         Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
6747         in the file list. The default is "true".
6748 </p>
6749 </dd>
6750 <dt class="hdlist1">
6751 gui.encoding
6752 </dt>
6753 <dd>
6754 <p>
6755         Specifies the default character encoding to use for displaying of
6756         file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
6757         It can be overridden by setting the <em>encoding</em> attribute
6758         for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
6759         If this option is not set, the tools default to the
6760         locale encoding.
6761 </p>
6762 </dd>
6763 <dt class="hdlist1">
6764 gui.matchTrackingBranch
6765 </dt>
6766 <dd>
6767 <p>
6768         Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
6769         default to tracking remote branches with matching names or
6770         not. Default: "false".
6771 </p>
6772 </dd>
6773 <dt class="hdlist1">
6774 gui.newBranchTemplate
6775 </dt>
6776 <dd>
6777 <p>
6778         Is used as a suggested name when creating new branches using the
6779         <a href="git-gui.html">git-gui(1)</a>.
6780 </p>
6781 </dd>
6782 <dt class="hdlist1">
6783 gui.pruneDuringFetch
6784 </dt>
6785 <dd>
6786 <p>
6787         "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
6788         performing a fetch. The default value is "false".
6789 </p>
6790 </dd>
6791 <dt class="hdlist1">
6792 gui.trustmtime
6793 </dt>
6794 <dd>
6795 <p>
6796         Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
6797         timestamp or not. By default the timestamps are not trusted.
6798 </p>
6799 </dd>
6800 <dt class="hdlist1">
6801 gui.spellingDictionary
6802 </dt>
6803 <dd>
6804 <p>
6805         Specifies the dictionary used for spell checking commit messages in
6806         the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
6807         off.
6808 </p>
6809 </dd>
6810 <dt class="hdlist1">
6811 gui.fastCopyBlame
6812 </dt>
6813 <dd>
6814 <p>
6815         If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
6816         location detection. It makes blame significantly faster on huge
6817         repositories at the expense of less thorough copy detection.
6818 </p>
6819 </dd>
6820 <dt class="hdlist1">
6821 gui.copyBlameThreshold
6822 </dt>
6823 <dd>
6824 <p>
6825         Specifies the threshold to use in <em>git gui blame</em> original location
6826         detection, measured in alphanumeric characters. See the
6827         <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
6828 </p>
6829 </dd>
6830 <dt class="hdlist1">
6831 gui.blamehistoryctx
6832 </dt>
6833 <dd>
6834 <p>
6835         Specifies the radius of history context in days to show in
6836         <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
6837         Context</code> menu item is invoked from <em>git gui blame</em>. If this
6838         variable is set to zero, the whole history is shown.
6839 </p>
6840 </dd>
6841 <dt class="hdlist1">
6842 guitool.&lt;name&gt;.cmd
6843 </dt>
6844 <dd>
6845 <p>
6846         Specifies the shell command line to execute when the corresponding item
6847         of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
6848         mandatory for every tool. The command is executed from the root of
6849         the working directory, and in the environment it receives the name of
6850         the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
6851         <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
6852         the head is detached, <em>CUR_BRANCH</em> is empty).
6853 </p>
6854 </dd>
6855 <dt class="hdlist1">
6856 guitool.&lt;name&gt;.needsFile
6857 </dt>
6858 <dd>
6859 <p>
6860         Run the tool only if a diff is selected in the GUI. It guarantees
6861         that <em>FILENAME</em> is not empty.
6862 </p>
6863 </dd>
6864 <dt class="hdlist1">
6865 guitool.&lt;name&gt;.noConsole
6866 </dt>
6867 <dd>
6868 <p>
6869         Run the command silently, without creating a window to display its
6870         output.
6871 </p>
6872 </dd>
6873 <dt class="hdlist1">
6874 guitool.&lt;name&gt;.noRescan
6875 </dt>
6876 <dd>
6877 <p>
6878         Don&#8217;t rescan the working directory for changes after the tool
6879         finishes execution.
6880 </p>
6881 </dd>
6882 <dt class="hdlist1">
6883 guitool.&lt;name&gt;.confirm
6884 </dt>
6885 <dd>
6886 <p>
6887         Show a confirmation dialog before actually running the tool.
6888 </p>
6889 </dd>
6890 <dt class="hdlist1">
6891 guitool.&lt;name&gt;.argPrompt
6892 </dt>
6893 <dd>
6894 <p>
6895         Request a string argument from the user, and pass it to the tool
6896         through the <code>ARGS</code> environment variable. Since requesting an
6897         argument implies confirmation, the <em>confirm</em> option has no effect
6898         if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
6899         the dialog uses a built-in generic prompt; otherwise the exact
6900         value of the variable is used.
6901 </p>
6902 </dd>
6903 <dt class="hdlist1">
6904 guitool.&lt;name&gt;.revPrompt
6905 </dt>
6906 <dd>
6907 <p>
6908         Request a single valid revision from the user, and set the
6909         <code>REVISION</code> environment variable. In other aspects this option
6910         is similar to <em>argPrompt</em>, and can be used together with it.
6911 </p>
6912 </dd>
6913 <dt class="hdlist1">
6914 guitool.&lt;name&gt;.revUnmerged
6915 </dt>
6916 <dd>
6917 <p>
6918         Show only unmerged branches in the <em>revPrompt</em> subdialog.
6919         This is useful for tools similar to merge or rebase, but not
6920         for things like checkout or reset.
6921 </p>
6922 </dd>
6923 <dt class="hdlist1">
6924 guitool.&lt;name&gt;.title
6925 </dt>
6926 <dd>
6927 <p>
6928         Specifies the title to use for the prompt dialog. The default
6929         is the tool name.
6930 </p>
6931 </dd>
6932 <dt class="hdlist1">
6933 guitool.&lt;name&gt;.prompt
6934 </dt>
6935 <dd>
6936 <p>
6937         Specifies the general prompt string to display at the top of
6938         the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
6939         The default value includes the actual command.
6940 </p>
6941 </dd>
6942 <dt class="hdlist1">
6943 help.browser
6944 </dt>
6945 <dd>
6946 <p>
6947         Specify the browser that will be used to display help in the
6948         <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
6949 </p>
6950 </dd>
6951 <dt class="hdlist1">
6952 help.format
6953 </dt>
6954 <dd>
6955 <p>
6956         Override the default help format used by <a href="git-help.html">git-help(1)</a>.
6957         Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
6958         the default. <em>web</em> and <em>html</em> are the same.
6959 </p>
6960 </dd>
6961 <dt class="hdlist1">
6962 help.autoCorrect
6963 </dt>
6964 <dd>
6965 <p>
6966         If git detects typos and can identify exactly one valid command similar
6967         to the error, git will try to suggest the correct command or even
6968         run the suggestion automatically. Possible config values are:
6969 </p>
6970 <div class="ulist"><ul>
6971 <li>
6972 <p>
6973 0 (default): show the suggested command.
6974 </p>
6975 </li>
6976 <li>
6977 <p>
6978 positive number: run the suggested command after specified
6979 deciseconds (0.1 sec).
6980 </p>
6981 </li>
6982 <li>
6983 <p>
6984 "immediate": run the suggested command immediately.
6985 </p>
6986 </li>
6987 <li>
6988 <p>
6989 "prompt": show the suggestion and prompt for confirmation to run
6990 the command.
6991 </p>
6992 </li>
6993 <li>
6994 <p>
6995 "never": don&#8217;t run or show any suggested command.
6996 </p>
6997 </li>
6998 </ul></div>
6999 </dd>
7000 <dt class="hdlist1">
7001 help.htmlPath
7002 </dt>
7003 <dd>
7004 <p>
7005         Specify the path where the HTML documentation resides. File system paths
7006         and URLs are supported. HTML pages will be prefixed with this path when
7007         help is displayed in the <em>web</em> format. This defaults to the documentation
7008         path of your Git installation.
7009 </p>
7010 </dd>
7011 <dt class="hdlist1">
7012 http.proxy
7013 </dt>
7014 <dd>
7015 <p>
7016         Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
7017         <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
7018         addition to the syntax understood by curl, it is possible to specify a
7019         proxy string with a user name but no password, in which case git will
7020         attempt to acquire one in the same way it does for other credentials. See
7021         <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
7022         <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
7023         on a per-remote basis; see remote.&lt;name&gt;.proxy
7024 </p>
7025 </dd>
7026 <dt class="hdlist1">
7027 http.proxyAuthMethod
7028 </dt>
7029 <dd>
7030 <p>
7031         Set the method with which to authenticate against the HTTP proxy. This
7032         only takes effect if the configured proxy string contains a user name part
7033         (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
7034         overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
7035         Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
7036         variable.  Possible values are:
7037 </p>
7038 <div class="openblock">
7039 <div class="content">
7040 <div class="ulist"><ul>
7041 <li>
7042 <p>
7043 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
7044   assumed that the proxy answers an unauthenticated request with a 407
7045   status code and one or more Proxy-authenticate headers with supported
7046   authentication methods. This is the default.
7047 </p>
7048 </li>
7049 <li>
7050 <p>
7051 <code>basic</code> - HTTP Basic authentication
7052 </p>
7053 </li>
7054 <li>
7055 <p>
7056 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
7057   transmitted to the proxy in clear text
7058 </p>
7059 </li>
7060 <li>
7061 <p>
7062 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7063   of <code>curl(1)</code>)
7064 </p>
7065 </li>
7066 <li>
7067 <p>
7068 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7069 </p>
7070 </li>
7071 </ul></div>
7072 </div></div>
7073 </dd>
7074 <dt class="hdlist1">
7075 http.proxySSLCert
7076 </dt>
7077 <dd>
7078 <p>
7079         The pathname of a file that stores a client certificate to use to authenticate
7080         with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7081         variable.
7082 </p>
7083 </dd>
7084 <dt class="hdlist1">
7085 http.proxySSLKey
7086 </dt>
7087 <dd>
7088 <p>
7089         The pathname of a file that stores a private key to use to authenticate with
7090         an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7091         variable.
7092 </p>
7093 </dd>
7094 <dt class="hdlist1">
7095 http.proxySSLCertPasswordProtected
7096 </dt>
7097 <dd>
7098 <p>
7099         Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
7100         will prompt the user, possibly many times, if the certificate or private key
7101         is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7102         environment variable.
7103 </p>
7104 </dd>
7105 <dt class="hdlist1">
7106 http.proxySSLCAInfo
7107 </dt>
7108 <dd>
7109 <p>
7110         Pathname to the file containing the certificate bundle that should be used to
7111         verify the proxy with when using an HTTPS proxy. Can be overridden by the
7112         <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7113 </p>
7114 </dd>
7115 <dt class="hdlist1">
7116 http.emptyAuth
7117 </dt>
7118 <dd>
7119 <p>
7120         Attempt authentication without seeking a username or password.  This
7121         can be used to attempt GSS-Negotiate authentication without specifying
7122         a username in the URL, as libcurl normally requires a username for
7123         authentication.
7124 </p>
7125 </dd>
7126 <dt class="hdlist1">
7127 http.delegation
7128 </dt>
7129 <dd>
7130 <p>
7131         Control GSSAPI credential delegation. The delegation is disabled
7132         by default in libcurl since version 7.21.7. Set parameter to tell
7133         the server what it is allowed to delegate when it comes to user
7134         credentials. Used with GSS/kerberos. Possible values are:
7135 </p>
7136 <div class="openblock">
7137 <div class="content">
7138 <div class="ulist"><ul>
7139 <li>
7140 <p>
7141 <code>none</code> - Don&#8217;t allow any delegation.
7142 </p>
7143 </li>
7144 <li>
7145 <p>
7146 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7147   Kerberos service ticket, which is a matter of realm policy.
7148 </p>
7149 </li>
7150 <li>
7151 <p>
7152 <code>always</code> - Unconditionally allow the server to delegate.
7153 </p>
7154 </li>
7155 </ul></div>
7156 </div></div>
7157 </dd>
7158 <dt class="hdlist1">
7159 http.extraHeader
7160 </dt>
7161 <dd>
7162 <p>
7163         Pass an additional HTTP header when communicating with a server.  If
7164         more than one such entry exists, all of them are added as extra
7165         headers.  To allow overriding the settings inherited from the system
7166         config, an empty value will reset the extra headers to the empty list.
7167 </p>
7168 </dd>
7169 <dt class="hdlist1">
7170 http.cookieFile
7171 </dt>
7172 <dd>
7173 <p>
7174         The pathname of a file containing previously stored cookie lines,
7175         which should be used
7176         in the Git http session, if they match the server. The file format
7177         of the file to read cookies from should be plain HTTP headers or
7178         the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7179         NOTE that the file specified with http.cookieFile is used only as
7180         input unless http.saveCookies is set.
7181 </p>
7182 </dd>
7183 <dt class="hdlist1">
7184 http.saveCookies
7185 </dt>
7186 <dd>
7187 <p>
7188         If set, store cookies received during requests to the file specified by
7189         http.cookieFile. Has no effect if http.cookieFile is unset.
7190 </p>
7191 </dd>
7192 <dt class="hdlist1">
7193 http.version
7194 </dt>
7195 <dd>
7196 <p>
7197         Use the specified HTTP protocol version when communicating with a server.
7198         If you want to force the default. The available and default version depend
7199         on libcurl. Currently the possible values of
7200         this option are:
7201 </p>
7202 <div class="ulist"><ul>
7203 <li>
7204 <p>
7205 HTTP/2
7206 </p>
7207 </li>
7208 <li>
7209 <p>
7210 HTTP/1.1
7211 </p>
7212 </li>
7213 </ul></div>
7214 </dd>
7215 <dt class="hdlist1">
7216 http.curloptResolve
7217 </dt>
7218 <dd>
7219 <p>
7220         Hostname resolution information that will be used first by
7221         libcurl when sending HTTP requests.  This information should
7222         be in one of the following formats:
7223 </p>
7224 <div class="ulist"><ul>
7225 <li>
7226 <p>
7227 [+]HOST:PORT:ADDRESS[,ADDRESS]
7228 </p>
7229 </li>
7230 <li>
7231 <p>
7232 -HOST:PORT
7233 </p>
7234 </li>
7235 </ul></div>
7236 <div class="paragraph"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7237 to the provided <code>ADDRESS</code>(s). The second format clears all
7238 previous config values for that <code>HOST:PORT</code> combination.  To
7239 allow easy overriding of all the settings inherited from the
7240 system config, an empty value will reset all resolution
7241 information to the empty list.</p></div>
7242 </dd>
7243 <dt class="hdlist1">
7244 http.sslVersion
7245 </dt>
7246 <dd>
7247 <p>
7248         The SSL version to use when negotiating an SSL connection, if you
7249         want to force the default.  The available and default version
7250         depend on whether libcurl was built against NSS or OpenSSL and the
7251         particular configuration of the crypto library in use. Internally
7252         this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7253         documentation for more details on the format of this option and
7254         for the ssl version supported. Currently the possible values of
7255         this option are:
7256 </p>
7257 <div class="ulist"><ul>
7258 <li>
7259 <p>
7260 sslv2
7261 </p>
7262 </li>
7263 <li>
7264 <p>
7265 sslv3
7266 </p>
7267 </li>
7268 <li>
7269 <p>
7270 tlsv1
7271 </p>
7272 </li>
7273 <li>
7274 <p>
7275 tlsv1.0
7276 </p>
7277 </li>
7278 <li>
7279 <p>
7280 tlsv1.1
7281 </p>
7282 </li>
7283 <li>
7284 <p>
7285 tlsv1.2
7286 </p>
7287 </li>
7288 <li>
7289 <p>
7290 tlsv1.3
7291 </p>
7292 </li>
7293 </ul></div>
7294 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7295 To force git to use libcurl&#8217;s default ssl version and ignore any
7296 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7297 empty string.</p></div>
7298 </dd>
7299 <dt class="hdlist1">
7300 http.sslCipherList
7301 </dt>
7302 <dd>
7303 <p>
7304   A list of SSL ciphers to use when negotiating an SSL connection.
7305   The available ciphers depend on whether libcurl was built against
7306   NSS or OpenSSL and the particular configuration of the crypto
7307   library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7308   option; see the libcurl documentation for more details on the format
7309   of this list.
7310 </p>
7311 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7312 To force git to use libcurl&#8217;s default cipher list and ignore any
7313 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7314 empty string.</p></div>
7315 </dd>
7316 <dt class="hdlist1">
7317 http.sslVerify
7318 </dt>
7319 <dd>
7320 <p>
7321         Whether to verify the SSL certificate when fetching or pushing
7322         over HTTPS. Defaults to true. Can be overridden by the
7323         <code>GIT_SSL_NO_VERIFY</code> environment variable.
7324 </p>
7325 </dd>
7326 <dt class="hdlist1">
7327 http.sslCert
7328 </dt>
7329 <dd>
7330 <p>
7331         File containing the SSL certificate when fetching or pushing
7332         over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7333         variable.
7334 </p>
7335 </dd>
7336 <dt class="hdlist1">
7337 http.sslKey
7338 </dt>
7339 <dd>
7340 <p>
7341         File containing the SSL private key when fetching or pushing
7342         over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7343         variable.
7344 </p>
7345 </dd>
7346 <dt class="hdlist1">
7347 http.sslCertPasswordProtected
7348 </dt>
7349 <dd>
7350 <p>
7351         Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
7352         OpenSSL will prompt the user, possibly many times, if the
7353         certificate or private key is encrypted.  Can be overridden by the
7354         <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7355 </p>
7356 </dd>
7357 <dt class="hdlist1">
7358 http.sslCAInfo
7359 </dt>
7360 <dd>
7361 <p>
7362         File containing the certificates to verify the peer with when
7363         fetching or pushing over HTTPS. Can be overridden by the
7364         <code>GIT_SSL_CAINFO</code> environment variable.
7365 </p>
7366 </dd>
7367 <dt class="hdlist1">
7368 http.sslCAPath
7369 </dt>
7370 <dd>
7371 <p>
7372         Path containing files with the CA certificates to verify the peer
7373         with when fetching or pushing over HTTPS. Can be overridden
7374         by the <code>GIT_SSL_CAPATH</code> environment variable.
7375 </p>
7376 </dd>
7377 <dt class="hdlist1">
7378 http.sslBackend
7379 </dt>
7380 <dd>
7381 <p>
7382         Name of the SSL backend to use (e.g. "openssl" or "schannel").
7383         This option is ignored if cURL lacks support for choosing the SSL
7384         backend at runtime.
7385 </p>
7386 </dd>
7387 <dt class="hdlist1">
7388 http.schannelCheckRevoke
7389 </dt>
7390 <dd>
7391 <p>
7392         Used to enforce or disable certificate revocation checks in cURL
7393         when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
7394         unset. Only necessary to disable this if Git consistently errors
7395         and the message is about checking the revocation status of a
7396         certificate. This option is ignored if cURL lacks support for
7397         setting the relevant SSL option at runtime.
7398 </p>
7399 </dd>
7400 <dt class="hdlist1">
7401 http.schannelUseSSLCAInfo
7402 </dt>
7403 <dd>
7404 <p>
7405         As of cURL v7.60.0, the Secure Channel backend can use the
7406         certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7407         override the Windows Certificate Store. Since this is not desirable
7408         by default, Git will tell cURL not to use that bundle by default
7409         when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7410         unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7411 </p>
7412 </dd>
7413 <dt class="hdlist1">
7414 http.pinnedPubkey
7415 </dt>
7416 <dd>
7417 <p>
7418         Public key of the https service. It may either be the filename of
7419         a PEM or DER encoded public key file or a string starting with
7420         <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7421         public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7422         exit with an error if this option is set but not supported by
7423         cURL.
7424 </p>
7425 </dd>
7426 <dt class="hdlist1">
7427 http.sslTry
7428 </dt>
7429 <dd>
7430 <p>
7431         Attempt to use AUTH SSL/TLS and encrypted data transfers
7432         when connecting via regular FTP protocol. This might be needed
7433         if the FTP server requires it for security reasons or you wish
7434         to connect securely whenever remote FTP server supports it.
7435         Default is false since it might trigger certificate verification
7436         errors on misconfigured servers.
7437 </p>
7438 </dd>
7439 <dt class="hdlist1">
7440 http.maxRequests
7441 </dt>
7442 <dd>
7443 <p>
7444         How many HTTP requests to launch in parallel. Can be overridden
7445         by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7446 </p>
7447 </dd>
7448 <dt class="hdlist1">
7449 http.minSessions
7450 </dt>
7451 <dd>
7452 <p>
7453         The number of curl sessions (counted across slots) to be kept across
7454         requests. They will not be ended with curl_easy_cleanup() until
7455         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7456         value will be capped at 1. Defaults to 1.
7457 </p>
7458 </dd>
7459 <dt class="hdlist1">
7460 http.postBuffer
7461 </dt>
7462 <dd>
7463 <p>
7464         Maximum size in bytes of the buffer used by smart HTTP
7465         transports when POSTing data to the remote system.
7466         For requests larger than this buffer size, HTTP/1.1 and
7467         Transfer-Encoding: chunked is used to avoid creating a
7468         massive pack file locally.  Default is 1 MiB, which is
7469         sufficient for most requests.
7470 </p>
7471 <div class="paragraph"><p>Note that raising this limit is only effective for disabling chunked
7472 transfer encoding and therefore should be used only where the remote
7473 server or a proxy only supports HTTP/1.0 or is noncompliant with the
7474 HTTP standard.  Raising this is not, in general, an effective solution
7475 for most push problems, but can increase memory consumption
7476 significantly since the entire buffer is allocated even for small
7477 pushes.</p></div>
7478 </dd>
7479 <dt class="hdlist1">
7480 http.lowSpeedLimit, http.lowSpeedTime
7481 </dt>
7482 <dd>
7483 <p>
7484         If the HTTP transfer speed, in bytes per second, is less than
7485         <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
7486         the transfer is aborted.
7487         Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
7488         <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
7489 </p>
7490 </dd>
7491 <dt class="hdlist1">
7492 http.noEPSV
7493 </dt>
7494 <dd>
7495 <p>
7496         A boolean which disables using of EPSV ftp command by curl.
7497         This can be helpful with some "poor" ftp servers which don&#8217;t
7498         support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
7499         environment variable. Default is false (curl will use EPSV).
7500 </p>
7501 </dd>
7502 <dt class="hdlist1">
7503 http.userAgent
7504 </dt>
7505 <dd>
7506 <p>
7507         The HTTP USER_AGENT string presented to an HTTP server.  The default
7508         value represents the version of the Git client such as git/1.7.1.
7509         This option allows you to override this value to a more common value
7510         such as Mozilla/4.0.  This may be necessary, for instance, if
7511         connecting through a firewall that restricts HTTP connections to a set
7512         of common USER_AGENT strings (but not including those like git/1.7.1).
7513         Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
7514 </p>
7515 </dd>
7516 <dt class="hdlist1">
7517 http.followRedirects
7518 </dt>
7519 <dd>
7520 <p>
7521         Whether git should follow HTTP redirects. If set to <code>true</code>, git
7522         will transparently follow any redirect issued by a server it
7523         encounters. If set to <code>false</code>, git will treat all redirects as
7524         errors. If set to <code>initial</code>, git will follow redirects only for
7525         the initial request to a remote, but not for subsequent
7526         follow-up HTTP requests. Since git uses the redirected URL as
7527         the base for the follow-up requests, this is generally
7528         sufficient. The default is <code>initial</code>.
7529 </p>
7530 </dd>
7531 <dt class="hdlist1">
7532 http.&lt;url&gt;.*
7533 </dt>
7534 <dd>
7535 <p>
7536         Any of the http.* options above can be applied selectively to some URLs.
7537         For a config key to match a URL, each element of the config key is
7538         compared to that of the URL, in the following order:
7539 </p>
7540 <div class="openblock">
7541 <div class="content">
7542 <div class="olist arabic"><ol class="arabic">
7543 <li>
7544 <p>
7545 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
7546   must match exactly between the config key and the URL.
7547 </p>
7548 </li>
7549 <li>
7550 <p>
7551 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
7552   This field must match between the config key and the URL. It is
7553   possible to specify a <code>*</code> as part of the host name to match all subdomains
7554   at this level. <code>https://*.example.com/</code> for example would match
7555   <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
7556 </p>
7557 </li>
7558 <li>
7559 <p>
7560 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
7561   This field must match exactly between the config key and the URL.
7562   Omitted port numbers are automatically converted to the correct
7563   default for the scheme before matching.
7564 </p>
7565 </li>
7566 <li>
7567 <p>
7568 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
7569   path field of the config key must match the path field of the URL
7570   either exactly or as a prefix of slash-delimited path elements.  This means
7571   a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
7572   match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
7573   key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
7574   key with just path <code>foo/</code>).
7575 </p>
7576 </li>
7577 <li>
7578 <p>
7579 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
7580   the config key has a user name it must match the user name in the
7581   URL exactly. If the config key does not have a user name, that
7582   config key will match a URL with any user name (including none),
7583   but at a lower precedence than a config key with a user name.
7584 </p>
7585 </li>
7586 </ol></div>
7587 </div></div>
7588 <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
7589 a config key&#8217;s path is preferred to one that matches its user name. For example,
7590 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
7591 <code>https://example.com/foo</code> will be preferred over a config key match of
7592 <code>https://user@example.com</code>.</p></div>
7593 <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
7594 if embedded in the URL, is always ignored for matching purposes) so that
7595 equivalent URLs that are simply spelled differently will match properly.
7596 Environment variable settings always override any matches.  The URLs that are
7597 matched against are those given directly to Git commands.  This means any URLs
7598 visited as a result of a redirection do not participate in matching.</p></div>
7599 </dd>
7600 <dt class="hdlist1">
7601 i18n.commitEncoding
7602 </dt>
7603 <dd>
7604 <p>
7605         Character encoding the commit messages are stored in; Git itself
7606         does not care per se, but this information is necessary e.g. when
7607         importing commits from emails or in the gitk graphical history
7608         browser (and possibly in other places in the future or in other
7609         porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
7610 </p>
7611 </dd>
7612 <dt class="hdlist1">
7613 i18n.logOutputEncoding
7614 </dt>
7615 <dd>
7616 <p>
7617         Character encoding the commit messages are converted to when
7618         running <em>git log</em> and friends.
7619 </p>
7620 </dd>
7621 <dt class="hdlist1">
7622 imap.folder
7623 </dt>
7624 <dd>
7625 <p>
7626         The folder to drop the mails into, which is typically the Drafts
7627         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
7628         "[Gmail]/Drafts". Required.
7629 </p>
7630 </dd>
7631 <dt class="hdlist1">
7632 imap.tunnel
7633 </dt>
7634 <dd>
7635 <p>
7636         Command used to set up a tunnel to the IMAP server through which
7637         commands will be piped instead of using a direct network connection
7638         to the server. Required when imap.host is not set.
7639 </p>
7640 </dd>
7641 <dt class="hdlist1">
7642 imap.host
7643 </dt>
7644 <dd>
7645 <p>
7646         A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
7647         connections and an <code>imaps://</code> prefix for secure connections.
7648         Ignored when imap.tunnel is set, but required otherwise.
7649 </p>
7650 </dd>
7651 <dt class="hdlist1">
7652 imap.user
7653 </dt>
7654 <dd>
7655 <p>
7656         The username to use when logging in to the server.
7657 </p>
7658 </dd>
7659 <dt class="hdlist1">
7660 imap.pass
7661 </dt>
7662 <dd>
7663 <p>
7664         The password to use when logging in to the server.
7665 </p>
7666 </dd>
7667 <dt class="hdlist1">
7668 imap.port
7669 </dt>
7670 <dd>
7671 <p>
7672         An integer port number to connect to on the server.
7673         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
7674         Ignored when imap.tunnel is set.
7675 </p>
7676 </dd>
7677 <dt class="hdlist1">
7678 imap.sslverify
7679 </dt>
7680 <dd>
7681 <p>
7682         A boolean to enable/disable verification of the server certificate
7683         used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
7684         imap.tunnel is set.
7685 </p>
7686 </dd>
7687 <dt class="hdlist1">
7688 imap.preformattedHTML
7689 </dt>
7690 <dd>
7691 <p>
7692         A boolean to enable/disable the use of html encoding when sending
7693         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
7694         and have a content type of text/html.  Ironically, enabling this
7695         option causes Thunderbird to send the patch as a plain/text,
7696         format=fixed email.  Default is <code>false</code>.
7697 </p>
7698 </dd>
7699 <dt class="hdlist1">
7700 imap.authMethod
7701 </dt>
7702 <dd>
7703 <p>
7704         Specify the authentication method for authenticating with the IMAP server.
7705         If Git was built with the NO_CURL option, or if your curl version is older
7706         than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
7707         option, the only supported method is <em>CRAM-MD5</em>. If this is not set
7708         then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
7709 </p>
7710 </dd>
7711 <dt class="hdlist1">
7712 include.path
7713 </dt>
7714 <dt class="hdlist1">
7715 includeIf.&lt;condition&gt;.path
7716 </dt>
7717 <dd>
7718 <p>
7719         Special variables to include other configuration files. See
7720         the "CONFIGURATION FILE" section in the main
7721         <a href="git-config.html">git-config(1)</a> documentation,
7722         specifically the "Includes" and "Conditional Includes" subsections.
7723 </p>
7724 </dd>
7725 <dt class="hdlist1">
7726 index.recordEndOfIndexEntries
7727 </dt>
7728 <dd>
7729 <p>
7730         Specifies whether the index file should include an "End Of Index
7731         Entry" section. This reduces index load time on multiprocessor
7732         machines but produces a message "ignoring EOIE extension" when
7733         reading the index using Git versions before 2.20. Defaults to
7734         <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
7735         otherwise.
7736 </p>
7737 </dd>
7738 <dt class="hdlist1">
7739 index.recordOffsetTable
7740 </dt>
7741 <dd>
7742 <p>
7743         Specifies whether the index file should include an "Index Entry
7744         Offset Table" section. This reduces index load time on
7745         multiprocessor machines but produces a message "ignoring IEOT
7746         extension" when reading the index using Git versions before 2.20.
7747         Defaults to <em>true</em> if index.threads has been explicitly enabled,
7748         <em>false</em> otherwise.
7749 </p>
7750 </dd>
7751 <dt class="hdlist1">
7752 index.sparse
7753 </dt>
7754 <dd>
7755 <p>
7756         When enabled, write the index using sparse-directory entries. This
7757         has no effect unless <code>core.sparseCheckout</code> and
7758         <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
7759 </p>
7760 </dd>
7761 <dt class="hdlist1">
7762 index.threads
7763 </dt>
7764 <dd>
7765 <p>
7766         Specifies the number of threads to spawn when loading the index.
7767         This is meant to reduce index load time on multiprocessor machines.
7768         Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
7769         CPUs and set the number of threads accordingly. Specifying 1 or
7770         <em>false</em> will disable multithreading. Defaults to <em>true</em>.
7771 </p>
7772 </dd>
7773 <dt class="hdlist1">
7774 index.version
7775 </dt>
7776 <dd>
7777 <p>
7778         Specify the version with which new index files should be
7779         initialized.  This does not affect existing repositories.
7780         If <code>feature.manyFiles</code> is enabled, then the default is 4.
7781 </p>
7782 </dd>
7783 <dt class="hdlist1">
7784 index.skipHash
7785 </dt>
7786 <dd>
7787 <p>
7788         When enabled, do not compute the trailing hash for the index file.
7789         This accelerates Git commands that manipulate the index, such as
7790         <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
7791         checksum, write a trailing set of bytes with value zero, indicating
7792         that the computation was skipped.
7793 </p>
7794 <div class="paragraph"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
7795 refuse to parse the index and Git clients older than 2.40.0 will report an
7796 error during <code>git fsck</code>.</p></div>
7797 </dd>
7798 <dt class="hdlist1">
7799 init.templateDir
7800 </dt>
7801 <dd>
7802 <p>
7803         Specify the directory from which templates will be copied.
7804         (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
7805 </p>
7806 </dd>
7807 <dt class="hdlist1">
7808 init.defaultBranch
7809 </dt>
7810 <dd>
7811 <p>
7812         Allows overriding the default branch name e.g. when initializing
7813         a new repository.
7814 </p>
7815 </dd>
7816 <dt class="hdlist1">
7817 instaweb.browser
7818 </dt>
7819 <dd>
7820 <p>
7821         Specify the program that will be used to browse your working
7822         repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7823 </p>
7824 </dd>
7825 <dt class="hdlist1">
7826 instaweb.httpd
7827 </dt>
7828 <dd>
7829 <p>
7830         The HTTP daemon command-line to start gitweb on your working
7831         repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7832 </p>
7833 </dd>
7834 <dt class="hdlist1">
7835 instaweb.local
7836 </dt>
7837 <dd>
7838 <p>
7839         If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
7840         be bound to the local IP (127.0.0.1).
7841 </p>
7842 </dd>
7843 <dt class="hdlist1">
7844 instaweb.modulePath
7845 </dt>
7846 <dd>
7847 <p>
7848         The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
7849         instead of /usr/lib/apache2/modules.  Only used if httpd
7850         is Apache.
7851 </p>
7852 </dd>
7853 <dt class="hdlist1">
7854 instaweb.port
7855 </dt>
7856 <dd>
7857 <p>
7858         The port number to bind the gitweb httpd to. See
7859         <a href="git-instaweb.html">git-instaweb(1)</a>.
7860 </p>
7861 </dd>
7862 <dt class="hdlist1">
7863 interactive.singleKey
7864 </dt>
7865 <dd>
7866 <p>
7867         In interactive commands, allow the user to provide one-letter
7868         input with a single key (i.e., without hitting enter).
7869         Currently this is used by the <code>--patch</code> mode of
7870         <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
7871         <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
7872         <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>. Note that this
7873         setting is silently ignored if portable keystroke input
7874         is not available; requires the Perl module Term::ReadKey.
7875 </p>
7876 </dd>
7877 <dt class="hdlist1">
7878 interactive.diffFilter
7879 </dt>
7880 <dd>
7881 <p>
7882         When an interactive command (such as <code>git add --patch</code>) shows
7883         a colorized diff, git will pipe the diff through the shell
7884         command defined by this configuration variable. The command may
7885         mark up the diff further for human consumption, provided that it
7886         retains a one-to-one correspondence with the lines in the
7887         original diff. Defaults to disabled (no filtering).
7888 </p>
7889 </dd>
7890 <dt class="hdlist1">
7891 log.abbrevCommit
7892 </dt>
7893 <dd>
7894 <p>
7895         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
7896         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
7897         override this option with <code>--no-abbrev-commit</code>.
7898 </p>
7899 </dd>
7900 <dt class="hdlist1">
7901 log.date
7902 </dt>
7903 <dd>
7904 <p>
7905         Set the default date-time mode for the <em>log</em> command.
7906         Setting a value for log.date is similar to using <em>git log</em>'s
7907         <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.
7908 </p>
7909 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
7910 "foo" will be used for the date format. Otherwise, "default" will
7911 be used.</p></div>
7912 </dd>
7913 <dt class="hdlist1">
7914 log.decorate
7915 </dt>
7916 <dd>
7917 <p>
7918         Print out the ref names of any commits that are shown by the log
7919         command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
7920         <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
7921         specified, the full ref name (including prefix) will be printed.
7922         If <em>auto</em> is specified, then if the output is going to a terminal,
7923         the ref names are shown as if <em>short</em> were given, otherwise no ref
7924         names are shown. This is the same as the <code>--decorate</code> option
7925         of the <code>git log</code>.
7926 </p>
7927 </dd>
7928 <dt class="hdlist1">
7929 log.initialDecorationSet
7930 </dt>
7931 <dd>
7932 <p>
7933         By default, <code>git log</code> only shows decorations for certain known ref
7934         namespaces. If <em>all</em> is specified, then show all refs as
7935         decorations.
7936 </p>
7937 </dd>
7938 <dt class="hdlist1">
7939 log.excludeDecoration
7940 </dt>
7941 <dd>
7942 <p>
7943         Exclude the specified patterns from the log decorations. This is
7944         similar to the <code>--decorate-refs-exclude</code> command-line option, but
7945         the config option can be overridden by the <code>--decorate-refs</code>
7946         option.
7947 </p>
7948 </dd>
7949 <dt class="hdlist1">
7950 log.diffMerges
7951 </dt>
7952 <dd>
7953 <p>
7954         Set diff format to be used when <code>--diff-merges=on</code> is
7955         specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
7956         details. Defaults to <code>separate</code>.
7957 </p>
7958 </dd>
7959 <dt class="hdlist1">
7960 log.follow
7961 </dt>
7962 <dd>
7963 <p>
7964         If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
7965         a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
7966         i.e. it cannot be used to follow multiple files and does not work well
7967         on non-linear history.
7968 </p>
7969 </dd>
7970 <dt class="hdlist1">
7971 log.graphColors
7972 </dt>
7973 <dd>
7974 <p>
7975         A list of colors, separated by commas, that can be used to draw
7976         history lines in <code>git log --graph</code>.
7977 </p>
7978 </dd>
7979 <dt class="hdlist1">
7980 log.showRoot
7981 </dt>
7982 <dd>
7983 <p>
7984         If true, the initial commit will be shown as a big creation event.
7985         This is equivalent to a diff against an empty tree.
7986         Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
7987         normally hide the root commit will now show it. True by default.
7988 </p>
7989 </dd>
7990 <dt class="hdlist1">
7991 log.showSignature
7992 </dt>
7993 <dd>
7994 <p>
7995         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
7996         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
7997 </p>
7998 </dd>
7999 <dt class="hdlist1">
8000 log.mailmap
8001 </dt>
8002 <dd>
8003 <p>
8004         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8005         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
8006         assume <code>--no-use-mailmap</code>. True by default.
8007 </p>
8008 </dd>
8009 <dt class="hdlist1">
8010 lsrefs.unborn
8011 </dt>
8012 <dd>
8013 <p>
8014         May be "advertise" (the default), "allow", or "ignore". If "advertise",
8015         the server will respond to the client sending "unborn" (as described in
8016         <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
8017         protocol v2 capability advertisement. "allow" is the same as
8018         "advertise" except that the server will not advertise support for this
8019         feature; this is useful for load-balanced servers that cannot be
8020         updated atomically (for example), since the administrator could
8021         configure "allow", then after a delay, configure "advertise".
8022 </p>
8023 </dd>
8024 <dt class="hdlist1">
8025 mailinfo.scissors
8026 </dt>
8027 <dd>
8028 <p>
8029         If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
8030         <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
8031         was provided on the command-line. When active, this feature
8032         removes everything from the message body before a scissors
8033         line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
8034 </p>
8035 </dd>
8036 <dt class="hdlist1">
8037 mailmap.file
8038 </dt>
8039 <dd>
8040 <p>
8041         The location of an augmenting mailmap file. The default
8042         mailmap, located in the root of the repository, is loaded
8043         first, then the mailmap file pointed to by this variable.
8044         The location of the mailmap file may be in a repository
8045         subdirectory, or somewhere outside of the repository itself.
8046         See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
8047 </p>
8048 </dd>
8049 <dt class="hdlist1">
8050 mailmap.blob
8051 </dt>
8052 <dd>
8053 <p>
8054         Like <code>mailmap.file</code>, but consider the value as a reference to a
8055         blob in the repository. If both <code>mailmap.file</code> and
8056         <code>mailmap.blob</code> are given, both are parsed, with entries from
8057         <code>mailmap.file</code> taking precedence. In a bare repository, this
8058         defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8059         defaults to empty.
8060 </p>
8061 </dd>
8062 <dt class="hdlist1">
8063 maintenance.auto
8064 </dt>
8065 <dd>
8066 <p>
8067         This boolean config option controls whether some commands run
8068         <code>git maintenance run --auto</code> after doing their normal work. Defaults
8069         to true.
8070 </p>
8071 </dd>
8072 <dt class="hdlist1">
8073 maintenance.strategy
8074 </dt>
8075 <dd>
8076 <p>
8077         This string config option provides a way to specify one of a few
8078         recommended schedules for background maintenance. This only affects
8079         which tasks are run during <code>git maintenance run --schedule=X</code>
8080         commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
8081         Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
8082         then that value is used instead of the one provided by
8083         <code>maintenance.strategy</code>. The possible strategy strings are:
8084 </p>
8085 <div class="ulist"><ul>
8086 <li>
8087 <p>
8088 <code>none</code>: This default setting implies no tasks are run at any schedule.
8089 </p>
8090 </li>
8091 <li>
8092 <p>
8093 <code>incremental</code>: This setting optimizes for performing small maintenance
8094   activities that do not delete any data. This does not schedule the <code>gc</code>
8095   task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8096   <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8097   task weekly.
8098 </p>
8099 </li>
8100 </ul></div>
8101 </dd>
8102 <dt class="hdlist1">
8103 maintenance.&lt;task&gt;.enabled
8104 </dt>
8105 <dd>
8106 <p>
8107         This boolean config option controls whether the maintenance task
8108         with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
8109         <code>git maintenance run</code>. These config values are ignored if a
8110         <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8111         is true.
8112 </p>
8113 </dd>
8114 <dt class="hdlist1">
8115 maintenance.&lt;task&gt;.schedule
8116 </dt>
8117 <dd>
8118 <p>
8119         This config option controls whether or not the given <code>&lt;task&gt;</code> runs
8120         during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
8121         value must be one of "hourly", "daily", or "weekly".
8122 </p>
8123 </dd>
8124 <dt class="hdlist1">
8125 maintenance.commit-graph.auto
8126 </dt>
8127 <dd>
8128 <p>
8129         This integer config option controls how often the <code>commit-graph</code> task
8130         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8131         the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8132         negative value will force the task to run every time. Otherwise, a
8133         positive value implies the command should run when the number of
8134         reachable commits that are not in the commit-graph file is at least
8135         the value of <code>maintenance.commit-graph.auto</code>. The default value is
8136         100.
8137 </p>
8138 </dd>
8139 <dt class="hdlist1">
8140 maintenance.loose-objects.auto
8141 </dt>
8142 <dd>
8143 <p>
8144         This integer config option controls how often the <code>loose-objects</code> task
8145         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8146         the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8147         negative value will force the task to run every time. Otherwise, a
8148         positive value implies the command should run when the number of
8149         loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8150         The default value is 100.
8151 </p>
8152 </dd>
8153 <dt class="hdlist1">
8154 maintenance.incremental-repack.auto
8155 </dt>
8156 <dd>
8157 <p>
8158         This integer config option controls how often the <code>incremental-repack</code>
8159         task should be run as part of <code>git maintenance run --auto</code>. If zero,
8160         then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8161         option. A negative value will force the task to run every time.
8162         Otherwise, a positive value implies the command should run when the
8163         number of pack-files not in the multi-pack-index is at least the value
8164         of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8165 </p>
8166 </dd>
8167 <dt class="hdlist1">
8168 man.viewer
8169 </dt>
8170 <dd>
8171 <p>
8172         Specify the programs that may be used to display help in the
8173         <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8174 </p>
8175 </dd>
8176 <dt class="hdlist1">
8177 man.&lt;tool&gt;.cmd
8178 </dt>
8179 <dd>
8180 <p>
8181         Specify the command to invoke the specified man viewer. The
8182         specified command is evaluated in shell with the man page
8183         passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)
8184 </p>
8185 </dd>
8186 <dt class="hdlist1">
8187 man.&lt;tool&gt;.path
8188 </dt>
8189 <dd>
8190 <p>
8191         Override the path for the given tool that may be used to
8192         display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8193 </p>
8194 </dd>
8195 <dt class="hdlist1">
8196 merge.conflictStyle
8197 </dt>
8198 <dd>
8199 <p>
8200         Specify the style in which conflicted hunks are written out to
8201         working tree files upon merge.  The default is "merge", which
8202         shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
8203         a <code>=======</code> marker, changes made by the other side, and then
8204         a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
8205         marker and the original text before the <code>=======</code> marker.  The
8206         "merge" style tends to produce smaller conflict regions than diff3,
8207         both because of the exclusion of the original text, and because
8208         when a subset of lines match on the two sides, they are just pulled
8209         out of the conflict region.  Another alternate style, "zdiff3", is
8210         similar to diff3 but removes matching lines on the two sides from
8211         the conflict region when those matching lines appear near either
8212         the beginning or end of a conflict region.
8213 </p>
8214 </dd>
8215 <dt class="hdlist1">
8216 merge.defaultToUpstream
8217 </dt>
8218 <dd>
8219 <p>
8220         If merge is called without any commit argument, merge the upstream
8221         branches configured for the current branch by using their last
8222         observed values stored in their remote-tracking branches.
8223         The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
8224         branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
8225         are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
8226         to their corresponding remote-tracking branches, and the tips of
8227         these tracking branches are merged. Defaults to true.
8228 </p>
8229 </dd>
8230 <dt class="hdlist1">
8231 merge.ff
8232 </dt>
8233 <dd>
8234 <p>
8235         By default, Git does not create an extra merge commit when merging
8236         a commit that is a descendant of the current commit. Instead, the
8237         tip of the current branch is fast-forwarded. When set to <code>false</code>,
8238         this variable tells Git to create an extra merge commit in such
8239         a case (equivalent to giving the <code>--no-ff</code> option from the command
8240         line). When set to <code>only</code>, only such fast-forward merges are
8241         allowed (equivalent to giving the <code>--ff-only</code> option from the
8242         command line).
8243 </p>
8244 </dd>
8245 <dt class="hdlist1">
8246 merge.verifySignatures
8247 </dt>
8248 <dd>
8249 <p>
8250         If true, this is equivalent to the --verify-signatures command
8251         line option. See <a href="git-merge.html">git-merge(1)</a> for details.
8252 </p>
8253 </dd>
8254 <dt class="hdlist1">
8255 merge.branchdesc
8256 </dt>
8257 <dd>
8258 <p>
8259         In addition to branch names, populate the log message with
8260         the branch description text associated with them.  Defaults
8261         to false.
8262 </p>
8263 </dd>
8264 <dt class="hdlist1">
8265 merge.log
8266 </dt>
8267 <dd>
8268 <p>
8269         In addition to branch names, populate the log message with at
8270         most the specified number of one-line descriptions from the
8271         actual commits that are being merged.  Defaults to false, and
8272         true is a synonym for 20.
8273 </p>
8274 </dd>
8275 <dt class="hdlist1">
8276 merge.suppressDest
8277 </dt>
8278 <dd>
8279 <p>
8280         By adding a glob that matches the names of integration
8281         branches to this multi-valued configuration variable, the
8282         default merge message computed for merges into these
8283         integration branches will omit "into &lt;branch name&gt;" from
8284         its title.
8285 </p>
8286 <div class="paragraph"><p>An element with an empty value can be used to clear the list
8287 of globs accumulated from previous configuration entries.
8288 When there is no <code>merge.suppressDest</code> variable defined, the
8289 default value of <code>master</code> is used for backward compatibility.</p></div>
8290 </dd>
8291 <dt class="hdlist1">
8292 merge.renameLimit
8293 </dt>
8294 <dd>
8295 <p>
8296         The number of files to consider in the exhaustive portion of
8297         rename detection during a merge.  If not specified, defaults
8298         to the value of diff.renameLimit.  If neither
8299         merge.renameLimit nor diff.renameLimit are specified,
8300         currently defaults to 7000.  This setting has no effect if
8301         rename detection is turned off.
8302 </p>
8303 </dd>
8304 <dt class="hdlist1">
8305 merge.renames
8306 </dt>
8307 <dd>
8308 <p>
8309         Whether Git detects renames.  If set to "false", rename detection
8310         is disabled. If set to "true", basic rename detection is enabled.
8311         Defaults to the value of diff.renames.
8312 </p>
8313 </dd>
8314 <dt class="hdlist1">
8315 merge.directoryRenames
8316 </dt>
8317 <dd>
8318 <p>
8319         Whether Git detects directory renames, affecting what happens at
8320         merge time to new files added to a directory on one side of
8321         history when that directory was renamed on the other side of
8322         history.  If merge.directoryRenames is set to "false", directory
8323         rename detection is disabled, meaning that such new files will be
8324         left behind in the old directory.  If set to "true", directory
8325         rename detection is enabled, meaning that such new files will be
8326         moved into the new directory.  If set to "conflict", a conflict
8327         will be reported for such paths.  If merge.renames is false,
8328         merge.directoryRenames is ignored and treated as false.  Defaults
8329         to "conflict".
8330 </p>
8331 </dd>
8332 <dt class="hdlist1">
8333 merge.renormalize
8334 </dt>
8335 <dd>
8336 <p>
8337         Tell Git that canonical representation of files in the
8338         repository has changed over time (e.g. earlier commits record
8339         text files with CRLF line endings, but recent ones use LF line
8340         endings).  In such a repository, Git can convert the data
8341         recorded in commits to a canonical form before performing a
8342         merge to reduce unnecessary conflicts.  For more information,
8343         see section "Merging branches with differing checkin/checkout
8344         attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
8345 </p>
8346 </dd>
8347 <dt class="hdlist1">
8348 merge.stat
8349 </dt>
8350 <dd>
8351 <p>
8352         Whether to print the diffstat between ORIG_HEAD and the merge result
8353         at the end of the merge.  True by default.
8354 </p>
8355 </dd>
8356 <dt class="hdlist1">
8357 merge.autoStash
8358 </dt>
8359 <dd>
8360 <p>
8361         When set to true, automatically create a temporary stash entry
8362         before the operation begins, and apply it after the operation
8363         ends.  This means that you can run merge on a dirty worktree.
8364         However, use with care: the final stash application after a
8365         successful merge might result in non-trivial conflicts.
8366         This option can be overridden by the <code>--no-autostash</code> and
8367         <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
8368         Defaults to false.
8369 </p>
8370 </dd>
8371 <dt class="hdlist1">
8372 merge.tool
8373 </dt>
8374 <dd>
8375 <p>
8376         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
8377         The list below shows the valid built-in values.
8378         Any other value is treated as a custom merge tool and requires
8379         that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
8380 </p>
8381 </dd>
8382 <dt class="hdlist1">
8383 merge.guitool
8384 </dt>
8385 <dd>
8386 <p>
8387         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
8388         -g/--gui flag is specified. The list below shows the valid built-in values.
8389         Any other value is treated as a custom merge tool and requires that a
8390         corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.
8391 </p>
8392 <div class="dlist"><dl>
8393 <dt class="hdlist1">
8394 <code>araxis</code>
8395 </dt>
8396 <dd>
8397 <p>
8398 Use Araxis Merge (requires a graphical session)
8399 </p>
8400 </dd>
8401 <dt class="hdlist1">
8402 <code>bc</code>
8403 </dt>
8404 <dd>
8405 <p>
8406 Use Beyond Compare (requires a graphical session)
8407 </p>
8408 </dd>
8409 <dt class="hdlist1">
8410 <code>bc3</code>
8411 </dt>
8412 <dd>
8413 <p>
8414 Use Beyond Compare (requires a graphical session)
8415 </p>
8416 </dd>
8417 <dt class="hdlist1">
8418 <code>bc4</code>
8419 </dt>
8420 <dd>
8421 <p>
8422 Use Beyond Compare (requires a graphical session)
8423 </p>
8424 </dd>
8425 <dt class="hdlist1">
8426 <code>codecompare</code>
8427 </dt>
8428 <dd>
8429 <p>
8430 Use Code Compare (requires a graphical session)
8431 </p>
8432 </dd>
8433 <dt class="hdlist1">
8434 <code>deltawalker</code>
8435 </dt>
8436 <dd>
8437 <p>
8438 Use DeltaWalker (requires a graphical session)
8439 </p>
8440 </dd>
8441 <dt class="hdlist1">
8442 <code>diffmerge</code>
8443 </dt>
8444 <dd>
8445 <p>
8446 Use DiffMerge (requires a graphical session)
8447 </p>
8448 </dd>
8449 <dt class="hdlist1">
8450 <code>diffuse</code>
8451 </dt>
8452 <dd>
8453 <p>
8454 Use Diffuse (requires a graphical session)
8455 </p>
8456 </dd>
8457 <dt class="hdlist1">
8458 <code>ecmerge</code>
8459 </dt>
8460 <dd>
8461 <p>
8462 Use ECMerge (requires a graphical session)
8463 </p>
8464 </dd>
8465 <dt class="hdlist1">
8466 <code>emerge</code>
8467 </dt>
8468 <dd>
8469 <p>
8470 Use Emacs' Emerge
8471 </p>
8472 </dd>
8473 <dt class="hdlist1">
8474 <code>examdiff</code>
8475 </dt>
8476 <dd>
8477 <p>
8478 Use ExamDiff Pro (requires a graphical session)
8479 </p>
8480 </dd>
8481 <dt class="hdlist1">
8482 <code>guiffy</code>
8483 </dt>
8484 <dd>
8485 <p>
8486 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
8487 </p>
8488 </dd>
8489 <dt class="hdlist1">
8490 <code>gvimdiff</code>
8491 </dt>
8492 <dd>
8493 <p>
8494 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8495 </p>
8496 </dd>
8497 <dt class="hdlist1">
8498 <code>gvimdiff1</code>
8499 </dt>
8500 <dd>
8501 <p>
8502 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
8503 </p>
8504 </dd>
8505 <dt class="hdlist1">
8506 <code>gvimdiff2</code>
8507 </dt>
8508 <dd>
8509 <p>
8510 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
8511 </p>
8512 </dd>
8513 <dt class="hdlist1">
8514 <code>gvimdiff3</code>
8515 </dt>
8516 <dd>
8517 <p>
8518 Use gVim (requires a graphical session) where only the MERGED file is shown
8519 </p>
8520 </dd>
8521 <dt class="hdlist1">
8522 <code>kdiff3</code>
8523 </dt>
8524 <dd>
8525 <p>
8526 Use KDiff3 (requires a graphical session)
8527 </p>
8528 </dd>
8529 <dt class="hdlist1">
8530 <code>meld</code>
8531 </dt>
8532 <dd>
8533 <p>
8534 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
8535 </p>
8536 </dd>
8537 <dt class="hdlist1">
8538 <code>nvimdiff</code>
8539 </dt>
8540 <dd>
8541 <p>
8542 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8543 </p>
8544 </dd>
8545 <dt class="hdlist1">
8546 <code>nvimdiff1</code>
8547 </dt>
8548 <dd>
8549 <p>
8550 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
8551 </p>
8552 </dd>
8553 <dt class="hdlist1">
8554 <code>nvimdiff2</code>
8555 </dt>
8556 <dd>
8557 <p>
8558 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8559 </p>
8560 </dd>
8561 <dt class="hdlist1">
8562 <code>nvimdiff3</code>
8563 </dt>
8564 <dd>
8565 <p>
8566 Use Neovim where only the MERGED file is shown
8567 </p>
8568 </dd>
8569 <dt class="hdlist1">
8570 <code>opendiff</code>
8571 </dt>
8572 <dd>
8573 <p>
8574 Use FileMerge (requires a graphical session)
8575 </p>
8576 </dd>
8577 <dt class="hdlist1">
8578 <code>p4merge</code>
8579 </dt>
8580 <dd>
8581 <p>
8582 Use HelixCore P4Merge (requires a graphical session)
8583 </p>
8584 </dd>
8585 <dt class="hdlist1">
8586 <code>smerge</code>
8587 </dt>
8588 <dd>
8589 <p>
8590 Use Sublime Merge (requires a graphical session)
8591 </p>
8592 </dd>
8593 <dt class="hdlist1">
8594 <code>tkdiff</code>
8595 </dt>
8596 <dd>
8597 <p>
8598 Use TkDiff (requires a graphical session)
8599 </p>
8600 </dd>
8601 <dt class="hdlist1">
8602 <code>tortoisemerge</code>
8603 </dt>
8604 <dd>
8605 <p>
8606 Use TortoiseMerge (requires a graphical session)
8607 </p>
8608 </dd>
8609 <dt class="hdlist1">
8610 <code>vimdiff</code>
8611 </dt>
8612 <dd>
8613 <p>
8614 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8615 </p>
8616 </dd>
8617 <dt class="hdlist1">
8618 <code>vimdiff1</code>
8619 </dt>
8620 <dd>
8621 <p>
8622 Use Vim with a 2 panes layout (LOCAL and REMOTE)
8623 </p>
8624 </dd>
8625 <dt class="hdlist1">
8626 <code>vimdiff2</code>
8627 </dt>
8628 <dd>
8629 <p>
8630 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8631 </p>
8632 </dd>
8633 <dt class="hdlist1">
8634 <code>vimdiff3</code>
8635 </dt>
8636 <dd>
8637 <p>
8638 Use Vim where only the MERGED file is shown
8639 </p>
8640 </dd>
8641 <dt class="hdlist1">
8642 <code>winmerge</code>
8643 </dt>
8644 <dd>
8645 <p>
8646 Use WinMerge (requires a graphical session)
8647 </p>
8648 </dd>
8649 <dt class="hdlist1">
8650 <code>xxdiff</code>
8651 </dt>
8652 <dd>
8653 <p>
8654 Use xxdiff (requires a graphical session)
8655 </p>
8656 </dd>
8657 </dl></div>
8658 </dd>
8659 <dt class="hdlist1">
8660 merge.verbosity
8661 </dt>
8662 <dd>
8663 <p>
8664         Controls the amount of output shown by the recursive merge
8665         strategy.  Level 0 outputs nothing except a final error
8666         message if conflicts were detected. Level 1 outputs only
8667         conflicts, 2 outputs conflicts and file changes.  Level 5 and
8668         above outputs debugging information.  The default is level 2.
8669         Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
8670 </p>
8671 </dd>
8672 <dt class="hdlist1">
8673 merge.&lt;driver&gt;.name
8674 </dt>
8675 <dd>
8676 <p>
8677         Defines a human-readable name for a custom low-level
8678         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8679 </p>
8680 </dd>
8681 <dt class="hdlist1">
8682 merge.&lt;driver&gt;.driver
8683 </dt>
8684 <dd>
8685 <p>
8686         Defines the command that implements a custom low-level
8687         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8688 </p>
8689 </dd>
8690 <dt class="hdlist1">
8691 merge.&lt;driver&gt;.recursive
8692 </dt>
8693 <dd>
8694 <p>
8695         Names a low-level merge driver to be used when
8696         performing an internal merge between common ancestors.
8697         See <a href="gitattributes.html">gitattributes(5)</a> for details.
8698 </p>
8699 </dd>
8700 <dt class="hdlist1">
8701 mergetool.&lt;tool&gt;.path
8702 </dt>
8703 <dd>
8704 <p>
8705         Override the path for the given tool.  This is useful in case
8706         your tool is not in the PATH.
8707 </p>
8708 </dd>
8709 <dt class="hdlist1">
8710 mergetool.&lt;tool&gt;.cmd
8711 </dt>
8712 <dd>
8713 <p>
8714         Specify the command to invoke the specified merge tool.  The
8715         specified command is evaluated in shell with the following
8716         variables available: <em>BASE</em> is the name of a temporary file
8717         containing the common base of the files to be merged, if available;
8718         <em>LOCAL</em> is the name of a temporary file containing the contents of
8719         the file on the current branch; <em>REMOTE</em> is the name of a temporary
8720         file containing the contents of the file from the branch being
8721         merged; <em>MERGED</em> contains the name of the file to which the merge
8722         tool should write the results of a successful merge.
8723 </p>
8724 </dd>
8725 <dt class="hdlist1">
8726 mergetool.&lt;tool&gt;.hideResolved
8727 </dt>
8728 <dd>
8729 <p>
8730         Allows the user to override the global <code>mergetool.hideResolved</code> value
8731         for a specific tool. See <code>mergetool.hideResolved</code> for the full
8732         description.
8733 </p>
8734 </dd>
8735 <dt class="hdlist1">
8736 mergetool.&lt;tool&gt;.trustExitCode
8737 </dt>
8738 <dd>
8739 <p>
8740         For a custom merge command, specify whether the exit code of
8741         the merge command can be used to determine whether the merge was
8742         successful.  If this is not set to true then the merge target file
8743         timestamp is checked, and the merge is assumed to have been successful
8744         if the file has been updated; otherwise, the user is prompted to
8745         indicate the success of the merge.
8746 </p>
8747 </dd>
8748 <dt class="hdlist1">
8749 mergetool.meld.hasOutput
8750 </dt>
8751 <dd>
8752 <p>
8753         Older versions of <code>meld</code> do not support the <code>--output</code> option.
8754         Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
8755         by inspecting the output of <code>meld --help</code>.  Configuring
8756         <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
8757         use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
8758         to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
8759         and <code>false</code> avoids using <code>--output</code>.
8760 </p>
8761 </dd>
8762 <dt class="hdlist1">
8763 mergetool.meld.useAutoMerge
8764 </dt>
8765 <dd>
8766 <p>
8767         When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
8768         parts automatically, highlight the conflicting parts, and wait for
8769         user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
8770         Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
8771         Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
8772         is supported and will only use <code>--auto-merge</code> when available.  A
8773         value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
8774         default value.
8775 </p>
8776 </dd>
8777 <dt class="hdlist1">
8778 mergetool.vimdiff.layout
8779 </dt>
8780 <dd>
8781 <p>
8782         The vimdiff backend uses this variable to control how its split
8783         windows appear. Applies even if you are using Neovim (<code>nvim</code>) or
8784         gVim (<code>gvim</code>) as the merge tool. See BACKEND SPECIFIC HINTS section
8785         in <a href="git-mergetool.html">git-mergetool(1)</a>.
8786         for details.
8787 </p>
8788 </dd>
8789 <dt class="hdlist1">
8790 mergetool.hideResolved
8791 </dt>
8792 <dd>
8793 <p>
8794         During a merge, Git will automatically resolve as many conflicts as
8795         possible and write the <em>MERGED</em> file containing conflict markers around
8796         any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
8797         represent the versions of the file from before Git&#8217;s conflict
8798         resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
8799         that only the unresolved conflicts are presented to the merge tool. Can
8800         be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
8801         configuration variable. Defaults to <code>false</code>.
8802 </p>
8803 </dd>
8804 <dt class="hdlist1">
8805 mergetool.keepBackup
8806 </dt>
8807 <dd>
8808 <p>
8809         After performing a merge, the original file with conflict markers
8810         can be saved as a file with a <code>.orig</code> extension.  If this variable
8811         is set to <code>false</code> then this file is not preserved.  Defaults to
8812         <code>true</code> (i.e. keep the backup files).
8813 </p>
8814 </dd>
8815 <dt class="hdlist1">
8816 mergetool.keepTemporaries
8817 </dt>
8818 <dd>
8819 <p>
8820         When invoking a custom merge tool, Git uses a set of temporary
8821         files to pass to the tool. If the tool returns an error and this
8822         variable is set to <code>true</code>, then these temporary files will be
8823         preserved; otherwise, they will be removed after the tool has
8824         exited. Defaults to <code>false</code>.
8825 </p>
8826 </dd>
8827 <dt class="hdlist1">
8828 mergetool.writeToTemp
8829 </dt>
8830 <dd>
8831 <p>
8832         Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
8833         conflicting files in the worktree by default.  Git will attempt
8834         to use a temporary directory for these files when set <code>true</code>.
8835         Defaults to <code>false</code>.
8836 </p>
8837 </dd>
8838 <dt class="hdlist1">
8839 mergetool.prompt
8840 </dt>
8841 <dd>
8842 <p>
8843         Prompt before each invocation of the merge resolution program.
8844 </p>
8845 </dd>
8846 <dt class="hdlist1">
8847 mergetool.guiDefault
8848 </dt>
8849 <dd>
8850 <p>
8851         Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
8852         specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
8853         or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
8854         variable value. The default is <code>false</code>, where the <code>--gui</code> argument
8855         must be provided explicitly for the <code>merge.guitool</code> to be used.
8856 </p>
8857 </dd>
8858 <dt class="hdlist1">
8859 notes.mergeStrategy
8860 </dt>
8861 <dd>
8862 <p>
8863         Which merge strategy to choose by default when resolving notes
8864         conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
8865         <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
8866         section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
8867 </p>
8868 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
8869 <a href="git-notes.html">git-notes(1)</a>.</p></div>
8870 </dd>
8871 <dt class="hdlist1">
8872 notes.&lt;name&gt;.mergeStrategy
8873 </dt>
8874 <dd>
8875 <p>
8876         Which merge strategy to choose when doing a notes merge into
8877         refs/notes/&lt;name&gt;.  This overrides the more general
8878         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
8879         <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
8880 </p>
8881 </dd>
8882 <dt class="hdlist1">
8883 notes.displayRef
8884 </dt>
8885 <dd>
8886 <p>
8887         Which ref (or refs, if a glob or specified more than once), in
8888         addition to the default set by <code>core.notesRef</code> or
8889         <code>GIT_NOTES_REF</code>, to read notes from when showing commit
8890         messages with the <em>git log</em> family of commands.
8891 </p>
8892 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
8893 environment variable, which must be a colon separated list of refs or
8894 globs.</p></div>
8895 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
8896 but a glob that does not match any refs is silently ignored.</p></div>
8897 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
8898 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
8899 those commands.</p></div>
8900 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
8901 GIT_NOTES_REF) is also implicitly added to the list of refs to be
8902 displayed.</p></div>
8903 </dd>
8904 <dt class="hdlist1">
8905 notes.rewrite.&lt;command&gt;
8906 </dt>
8907 <dd>
8908 <p>
8909         When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
8910         <code>rebase</code>), if this variable is <code>false</code>, git will not copy
8911         notes from the original to the rewritten commit.  Defaults to
8912         <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.
8913 </p>
8914 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
8915 environment variable, which must be a colon separated list of refs or
8916 globs.</p></div>
8917 </dd>
8918 <dt class="hdlist1">
8919 notes.rewriteMode
8920 </dt>
8921 <dd>
8922 <p>
8923         When copying notes during a rewrite (see the
8924         "notes.rewrite.&lt;command&gt;" option), determines what to do if
8925         the target commit already has a note.  Must be one of
8926         <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
8927         Defaults to <code>concatenate</code>.
8928 </p>
8929 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
8930 environment variable.</p></div>
8931 </dd>
8932 <dt class="hdlist1">
8933 notes.rewriteRef
8934 </dt>
8935 <dd>
8936 <p>
8937         When copying notes during a rewrite, specifies the (fully
8938         qualified) ref whose notes should be copied.  May be a glob,
8939         in which case notes in all matching refs will be copied.  You
8940         may also specify this configuration several times.
8941 </p>
8942 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
8943 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
8944 rewriting for the default commit notes.</p></div>
8945 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
8946 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
8947 </dd>
8948 <dt class="hdlist1">
8949 pack.window
8950 </dt>
8951 <dd>
8952 <p>
8953         The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
8954         window size is given on the command line. Defaults to 10.
8955 </p>
8956 </dd>
8957 <dt class="hdlist1">
8958 pack.depth
8959 </dt>
8960 <dd>
8961 <p>
8962         The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
8963         maximum depth is given on the command line. Defaults to 50.
8964         Maximum value is 4095.
8965 </p>
8966 </dd>
8967 <dt class="hdlist1">
8968 pack.windowMemory
8969 </dt>
8970 <dd>
8971 <p>
8972         The maximum size of memory that is consumed by each thread
8973         in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
8974         no limit is given on the command line.  The value can be
8975         suffixed with "k", "m", or "g".  When left unconfigured (or
8976         set explicitly to 0), there will be no limit.
8977 </p>
8978 </dd>
8979 <dt class="hdlist1">
8980 pack.compression
8981 </dt>
8982 <dd>
8983 <p>
8984         An integer -1..9, indicating the compression level for objects
8985         in a pack file. -1 is the zlib default. 0 means no
8986         compression, and 1..9 are various speed/size tradeoffs, 9 being
8987         slowest.  If not set,  defaults to core.compression.  If that is
8988         not set,  defaults to -1, the zlib default, which is "a default
8989         compromise between speed and compression (currently equivalent
8990         to level 6)."
8991 </p>
8992 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
8993 all existing objects. You can force recompression by passing the -F option
8994 to <a href="git-repack.html">git-repack(1)</a>.</p></div>
8995 </dd>
8996 <dt class="hdlist1">
8997 pack.allowPackReuse
8998 </dt>
8999 <dd>
9000 <p>
9001         When true, and when reachability bitmaps are enabled,
9002         pack-objects will try to send parts of the bitmapped packfile
9003         verbatim. This can reduce memory and CPU usage to serve fetches,
9004         but might result in sending a slightly larger pack. Defaults to
9005         true.
9006 </p>
9007 </dd>
9008 <dt class="hdlist1">
9009 pack.island
9010 </dt>
9011 <dd>
9012 <p>
9013         An extended regular expression configuring a set of delta
9014         islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
9015         for details.
9016 </p>
9017 </dd>
9018 <dt class="hdlist1">
9019 pack.islandCore
9020 </dt>
9021 <dd>
9022 <p>
9023         Specify an island name which gets to have its objects be
9024         packed first. This creates a kind of pseudo-pack at the front
9025         of one pack, so that the objects from the specified island are
9026         hopefully faster to copy into any pack that should be served
9027         to a user requesting these objects. In practice this means
9028         that the island specified should likely correspond to what is
9029         the most commonly cloned in the repo. See also "DELTA ISLANDS"
9030         in <a href="git-pack-objects.html">git-pack-objects(1)</a>.
9031 </p>
9032 </dd>
9033 <dt class="hdlist1">
9034 pack.deltaCacheSize
9035 </dt>
9036 <dd>
9037 <p>
9038         The maximum memory in bytes used for caching deltas in
9039         <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
9040         This cache is used to speed up the writing object phase by not
9041         having to recompute the final delta result once the best match
9042         for all objects is found.  Repacking large repositories on machines
9043         which are tight with memory might be badly impacted by this though,
9044         especially if this cache pushes the system into swapping.
9045         A value of 0 means no limit. The smallest size of 1 byte may be
9046         used to virtually disable this cache. Defaults to 256 MiB.
9047 </p>
9048 </dd>
9049 <dt class="hdlist1">
9050 pack.deltaCacheLimit
9051 </dt>
9052 <dd>
9053 <p>
9054         The maximum size of a delta, that is cached in
9055         <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
9056         writing object phase by not having to recompute the final delta
9057         result once the best match for all objects is found.
9058         Defaults to 1000. Maximum value is 65535.
9059 </p>
9060 </dd>
9061 <dt class="hdlist1">
9062 pack.threads
9063 </dt>
9064 <dd>
9065 <p>
9066         Specifies the number of threads to spawn when searching for best
9067         delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
9068         be compiled with pthreads otherwise this option is ignored with a
9069         warning. This is meant to reduce packing time on multiprocessor
9070         machines. The required amount of memory for the delta search window
9071         is however multiplied by the number of threads.
9072         Specifying 0 will cause Git to auto-detect the number of CPUs
9073         and set the number of threads accordingly.
9074 </p>
9075 </dd>
9076 <dt class="hdlist1">
9077 pack.indexVersion
9078 </dt>
9079 <dd>
9080 <p>
9081         Specify the default pack index version.  Valid values are 1 for
9082         legacy pack index used by Git versions prior to 1.5.2, and 2 for
9083         the new pack index with capabilities for packs larger than 4 GB
9084         as well as proper protection against the repacking of corrupted
9085         packs.  Version 2 is the default.  Note that version 2 is enforced
9086         and this config option is ignored whenever the corresponding pack is
9087         larger than 2 GB.
9088 </p>
9089 <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9090 cloning or fetching over a non-native protocol (e.g. "http")
9091 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9092 other side may give you a repository that cannot be accessed with your
9093 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9094 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
9095 the <code>*.idx</code> file.</p></div>
9096 </dd>
9097 <dt class="hdlist1">
9098 pack.packSizeLimit
9099 </dt>
9100 <dd>
9101 <p>
9102         The maximum size of a pack.  This setting only affects
9103         packing to a file when repacking, i.e. the git:// protocol
9104         is unaffected.  It can be overridden by the <code>--max-pack-size</code>
9105         option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
9106         in the creation of multiple packfiles.
9107 </p>
9108 <div class="paragraph"><p>Note that this option is rarely useful, and may result in a larger total
9109 on-disk size (because Git will not store deltas between packs) and
9110 worse runtime performance (object lookup within multiple packs is
9111 slower than a single pack, and optimizations like reachability bitmaps
9112 cannot cope with multiple packs).</p></div>
9113 <div class="paragraph"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9114 filesystem does not support large files), this option may help. But if
9115 your goal is to transmit a packfile over a medium that supports limited
9116 sizes (e.g., removable media that cannot store the whole repository),
9117 you are likely better off creating a single large packfile and splitting
9118 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9119 <div class="paragraph"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9120 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9121 </dd>
9122 <dt class="hdlist1">
9123 pack.useBitmaps
9124 </dt>
9125 <dd>
9126 <p>
9127         When true, git will use pack bitmaps (if available) when packing
9128         to stdout (e.g., during the server side of a fetch). Defaults to
9129         true. You should not generally need to turn this off unless
9130         you are debugging pack bitmaps.
9131 </p>
9132 </dd>
9133 <dt class="hdlist1">
9134 pack.useBitmapBoundaryTraversal
9135 </dt>
9136 <dd>
9137 <p>
9138         When true, Git will use an experimental algorithm for computing
9139         reachability queries with bitmaps. Instead of building up
9140         complete bitmaps for all of the negated tips and then OR-ing
9141         them together, consider negated tips with existing bitmaps as
9142         additive (i.e. OR-ing them into the result if they exist,
9143         ignoring them otherwise), and build up a bitmap at the boundary
9144         instead.
9145 </p>
9146 <div class="paragraph"><p>When using this algorithm, Git may include too many objects as a result
9147 of not opening up trees belonging to certain UNINTERESTING commits. This
9148 inexactness matches the non-bitmap traversal algorithm.</p></div>
9149 <div class="paragraph"><p>In many cases, this can provide a speed-up over the exact algorithm,
9150 particularly when there is poor bitmap coverage of the negated side of
9151 the query.</p></div>
9152 </dd>
9153 <dt class="hdlist1">
9154 pack.useSparse
9155 </dt>
9156 <dd>
9157 <p>
9158         When true, git will default to using the <em>--sparse</em> option in
9159         <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9160         algorithm only walks trees that appear in paths that introduce new
9161         objects. This can have significant performance benefits when
9162         computing a pack to send a small change. However, it is possible
9163         that extra objects are added to the pack-file if the included
9164         commits contain certain types of direct renames. Default is
9165         <code>true</code>.
9166 </p>
9167 </dd>
9168 <dt class="hdlist1">
9169 pack.preferBitmapTips
9170 </dt>
9171 <dd>
9172 <p>
9173         When selecting which commits will receive bitmaps, prefer a
9174         commit at the tip of any reference that is a suffix of any value
9175         of this configuration over any other commits in the "selection
9176         window".
9177 </p>
9178 <div class="paragraph"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9179 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9180 necessarily be selected. This is because commits are selected for
9181 bitmaps from within a series of windows of variable length.</p></div>
9182 <div class="paragraph"><p>If a commit at the tip of any reference which is a suffix of any value
9183 of this configuration is seen in a window, it is immediately given
9184 preference over any other commit in that window.</p></div>
9185 </dd>
9186 <dt class="hdlist1">
9187 pack.writeBitmaps (deprecated)
9188 </dt>
9189 <dd>
9190 <p>
9191         This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9192 </p>
9193 </dd>
9194 <dt class="hdlist1">
9195 pack.writeBitmapHashCache
9196 </dt>
9197 <dd>
9198 <p>
9199         When true, git will include a "hash cache" section in the bitmap
9200         index (if one is written). This cache can be used to feed git&#8217;s
9201         delta heuristics, potentially leading to better deltas between
9202         bitmapped and non-bitmapped objects (e.g., when serving a fetch
9203         between an older, bitmapped pack and objects that have been
9204         pushed since the last gc). The downside is that it consumes 4
9205         bytes per object of disk space. Defaults to true.
9206 </p>
9207 <div class="paragraph"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9208 computed; instead, any namehashes stored in an existing bitmap are
9209 permuted into their appropriate location when writing a new bitmap.</p></div>
9210 </dd>
9211 <dt class="hdlist1">
9212 pack.writeBitmapLookupTable
9213 </dt>
9214 <dd>
9215 <p>
9216         When true, Git will include a "lookup table" section in the
9217         bitmap index (if one is written). This table is used to defer
9218         loading individual bitmaps as late as possible. This can be
9219         beneficial in repositories that have relatively large bitmap
9220         indexes. Defaults to false.
9221 </p>
9222 </dd>
9223 <dt class="hdlist1">
9224 pack.readReverseIndex
9225 </dt>
9226 <dd>
9227 <p>
9228         When true, git will read any .rev file(s) that may be available
9229         (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
9230         will be generated from scratch and stored in memory. Defaults to
9231         true.
9232 </p>
9233 </dd>
9234 <dt class="hdlist1">
9235 pack.writeReverseIndex
9236 </dt>
9237 <dd>
9238 <p>
9239         When true, git will write a corresponding .rev file (see:
9240         <a href="gitformat-pack.html">gitformat-pack(5)</a>)
9241         for each new packfile that it writes in all places except for
9242         <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
9243         Defaults to true.
9244 </p>
9245 </dd>
9246 <dt class="hdlist1">
9247 pager.&lt;cmd&gt;
9248 </dt>
9249 <dd>
9250 <p>
9251         If the value is boolean, turns on or off pagination of the
9252         output of a particular Git subcommand when writing to a tty.
9253         Otherwise, turns on pagination for the subcommand using the
9254         pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
9255         or <code>--no-pager</code> is specified on the command line, it takes
9256         precedence over this option.  To disable pagination for all
9257         commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9258 </p>
9259 </dd>
9260 <dt class="hdlist1">
9261 pretty.&lt;name&gt;
9262 </dt>
9263 <dd>
9264 <p>
9265         Alias for a --pretty= format string, as specified in
9266         <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
9267         as the built-in pretty formats could. For example,
9268         running <code>git config pretty.changelog "format:* %H %s"</code>
9269         would cause the invocation <code>git log --pretty=changelog</code>
9270         to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
9271         Note that an alias with the same name as a built-in format
9272         will be silently ignored.
9273 </p>
9274 </dd>
9275 <dt class="hdlist1">
9276 protocol.allow
9277 </dt>
9278 <dd>
9279 <p>
9280         If set, provide a user defined default policy for all protocols which
9281         don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
9282         if unset, known-safe protocols (http, https, git, ssh) have a
9283         default policy of <code>always</code>, known-dangerous protocols (ext) have a
9284         default policy of <code>never</code>, and all other protocols (including file)
9285         have a default policy of <code>user</code>.  Supported policies:
9286 </p>
9287 <div class="openblock">
9288 <div class="content">
9289 <div class="ulist"><ul>
9290 <li>
9291 <p>
9292 <code>always</code> - protocol is always able to be used.
9293 </p>
9294 </li>
9295 <li>
9296 <p>
9297 <code>never</code> - protocol is never able to be used.
9298 </p>
9299 </li>
9300 <li>
9301 <p>
9302 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9303   either unset or has a value of 1.  This policy should be used when you want a
9304   protocol to be directly usable by the user but don&#8217;t want it used by commands which
9305   execute clone/fetch/push commands without user input, e.g. recursive
9306   submodule initialization.
9307 </p>
9308 </li>
9309 </ul></div>
9310 </div></div>
9311 </dd>
9312 <dt class="hdlist1">
9313 protocol.&lt;name&gt;.allow
9314 </dt>
9315 <dd>
9316 <p>
9317         Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
9318         commands. See <code>protocol.allow</code> above for the available policies.
9319 </p>
9320 <div class="paragraph"><p>The protocol names currently used by git are:</p></div>
9321 <div class="openblock">
9322 <div class="content">
9323 <div class="ulist"><ul>
9324 <li>
9325 <p>
9326 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9327     or local paths)
9328 </p>
9329 </li>
9330 <li>
9331 <p>
9332 <code>git</code>: the anonymous git protocol over a direct TCP
9333     connection (or proxy, if configured)
9334 </p>
9335 </li>
9336 <li>
9337 <p>
9338 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9339     <code>ssh://</code>, etc).
9340 </p>
9341 </li>
9342 <li>
9343 <p>
9344 <code>http</code>: git over http, both "smart http" and "dumb http".
9345     Note that this does <em>not</em> include <code>https</code>; if you want to configure
9346     both, you must do so individually.
9347 </p>
9348 </li>
9349 <li>
9350 <p>
9351 any external helpers are named by their protocol (e.g., use
9352     <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9353 </p>
9354 </li>
9355 </ul></div>
9356 </div></div>
9357 </dd>
9358 <dt class="hdlist1">
9359 protocol.version
9360 </dt>
9361 <dd>
9362 <p>
9363         If set, clients will attempt to communicate with a server
9364         using the specified protocol version.  If the server does
9365         not support it, communication falls back to version 0.
9366         If unset, the default is <code>2</code>.
9367         Supported versions:
9368 </p>
9369 <div class="openblock">
9370 <div class="content">
9371 <div class="ulist"><ul>
9372 <li>
9373 <p>
9374 <code>0</code> - the original wire protocol.
9375 </p>
9376 </li>
9377 <li>
9378 <p>
9379 <code>1</code> - the original wire protocol with the addition of a version string
9380   in the initial response from the server.
9381 </p>
9382 </li>
9383 <li>
9384 <p>
9385 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.
9386 </p>
9387 </li>
9388 </ul></div>
9389 </div></div>
9390 </dd>
9391 <dt class="hdlist1">
9392 pull.ff
9393 </dt>
9394 <dd>
9395 <p>
9396         By default, Git does not create an extra merge commit when merging
9397         a commit that is a descendant of the current commit. Instead, the
9398         tip of the current branch is fast-forwarded. When set to <code>false</code>,
9399         this variable tells Git to create an extra merge commit in such
9400         a case (equivalent to giving the <code>--no-ff</code> option from the command
9401         line). When set to <code>only</code>, only such fast-forward merges are
9402         allowed (equivalent to giving the <code>--ff-only</code> option from the
9403         command line). This setting overrides <code>merge.ff</code> when pulling.
9404 </p>
9405 </dd>
9406 <dt class="hdlist1">
9407 pull.rebase
9408 </dt>
9409 <dd>
9410 <p>
9411         When true, rebase branches on top of the fetched branch, instead
9412         of merging the default branch from the default remote when "git
9413         pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
9414         per-branch basis.
9415 </p>
9416 <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>
9417 so that the local merge commits are included in the rebase (see
9418 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
9419 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9420 mode.</p></div>
9421 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9422 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
9423 for details).</p></div>
9424 </dd>
9425 <dt class="hdlist1">
9426 pull.octopus
9427 </dt>
9428 <dd>
9429 <p>
9430         The default merge strategy to use when pulling multiple branches
9431         at once.
9432 </p>
9433 </dd>
9434 <dt class="hdlist1">
9435 pull.twohead
9436 </dt>
9437 <dd>
9438 <p>
9439         The default merge strategy to use when pulling a single branch.
9440 </p>
9441 </dd>
9442 <dt class="hdlist1">
9443 push.autoSetupRemote
9444 </dt>
9445 <dd>
9446 <p>
9447         If set to "true" assume <code>--set-upstream</code> on default push when no
9448         upstream tracking exists for the current branch; this option
9449         takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9450         and <em>current</em>. It is useful if by default you want new branches
9451         to be pushed to the default remote (like the behavior of
9452         <em>push.default=current</em>) and you also want the upstream tracking
9453         to be set. Workflows most likely to benefit from this option are
9454         <em>simple</em> central workflows where all branches are expected to
9455         have the same name on the remote.
9456 </p>
9457 </dd>
9458 <dt class="hdlist1">
9459 push.default
9460 </dt>
9461 <dd>
9462 <p>
9463         Defines the action <code>git push</code> should take if no refspec is
9464         given (whether from the command-line, config, or elsewhere).
9465         Different values are well-suited for
9466         specific workflows; for instance, in a purely central workflow
9467         (i.e. the fetch source is equal to the push destination),
9468         <code>upstream</code> is probably what you want.  Possible values are:
9469 </p>
9470 <div class="openblock">
9471 <div class="content">
9472 <div class="ulist"><ul>
9473 <li>
9474 <p>
9475 <code>nothing</code> - do not push anything (error out) unless a refspec is
9476   given. This is primarily meant for people who want to
9477   avoid mistakes by always being explicit.
9478 </p>
9479 </li>
9480 <li>
9481 <p>
9482 <code>current</code> - push the current branch to update a branch with the same
9483   name on the receiving end.  Works in both central and non-central
9484   workflows.
9485 </p>
9486 </li>
9487 <li>
9488 <p>
9489 <code>upstream</code> - push the current branch back to the branch whose
9490   changes are usually integrated into the current branch (which is
9491   called <code>@{upstream}</code>).  This mode only makes sense if you are
9492   pushing to the same repository you would normally pull from
9493   (i.e. central workflow).
9494 </p>
9495 </li>
9496 <li>
9497 <p>
9498 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
9499 </p>
9500 </li>
9501 <li>
9502 <p>
9503 <code>simple</code> - push the current branch with the same name on the remote.
9504 </p>
9505 <div class="paragraph"><p>If you are working on a centralized workflow (pushing to the same repository you
9506 pull from, which is typically <code>origin</code>), then you need to configure an upstream
9507 branch with the same name.</p></div>
9508 <div class="paragraph"><p>This mode is the default since Git 2.0, and is the safest option suited for
9509 beginners.</p></div>
9510 </li>
9511 <li>
9512 <p>
9513 <code>matching</code> - push all branches having the same name on both ends.
9514   This makes the repository you are pushing to remember the set of
9515   branches that will be pushed out (e.g. if you always push <em>maint</em>
9516   and <em>master</em> there and no other branches, the repository you push
9517   to will have these two branches, and your local <em>maint</em> and
9518   <em>master</em> will be pushed there).
9519 </p>
9520 <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
9521 branches you would push out are ready to be pushed out before
9522 running <em>git push</em>, as the whole point of this mode is to allow you
9523 to push all of the branches in one go.  If you usually finish work
9524 on only one branch and push out the result, while other branches are
9525 unfinished, this mode is not for you.  Also this mode is not
9526 suitable for pushing into a shared central repository, as other
9527 people may add new branches there, or update the tip of existing
9528 branches outside your control.</p></div>
9529 <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
9530 new default).</p></div>
9531 </li>
9532 </ul></div>
9533 </div></div>
9534 </dd>
9535 <dt class="hdlist1">
9536 push.followTags
9537 </dt>
9538 <dd>
9539 <p>
9540         If set to true, enable <code>--follow-tags</code> option by default.  You
9541         may override this configuration at time of push by specifying
9542         <code>--no-follow-tags</code>.
9543 </p>
9544 </dd>
9545 <dt class="hdlist1">
9546 push.gpgSign
9547 </dt>
9548 <dd>
9549 <p>
9550         May be set to a boolean value, or the string <em>if-asked</em>. A true
9551         value causes all pushes to be GPG signed, as if <code>--signed</code> is
9552         passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
9553         pushes to be signed if the server supports it, as if
9554         <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
9555         override a value from a lower-priority config file. An explicit
9556         command-line flag always overrides this config option.
9557 </p>
9558 </dd>
9559 <dt class="hdlist1">
9560 push.pushOption
9561 </dt>
9562 <dd>
9563 <p>
9564         When no <code>--push-option=&lt;option&gt;</code> argument is given from the
9565         command line, <code>git push</code> behaves as if each &lt;value&gt; of
9566         this variable is given as <code>--push-option=&lt;value&gt;</code>.
9567 </p>
9568 <div class="paragraph"><p>This is a multi-valued variable, and an empty value can be used in a
9569 higher priority configuration file (e.g. <code>.git/config</code> in a
9570 repository) to clear the values inherited from a lower priority
9571 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
9572 <div class="listingblock">
9573 <div class="content">
9574 <pre><code>Example:
9575
9576 /etc/gitconfig
9577   push.pushoption = a
9578   push.pushoption = b
9579
9580 ~/.gitconfig
9581   push.pushoption = c
9582
9583 repo/.git/config
9584   push.pushoption =
9585   push.pushoption = b
9586
9587 This will result in only b (a and c are cleared).</code></pre>
9588 </div></div>
9589 </dd>
9590 <dt class="hdlist1">
9591 push.recurseSubmodules
9592 </dt>
9593 <dd>
9594 <p>
9595         May be "check", "on-demand", "only", or "no", with the same behavior
9596         as that of "push --recurse-submodules".
9597         If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
9598         set (in which case a <em>true</em> value means <em>on-demand</em>).
9599 </p>
9600 </dd>
9601 <dt class="hdlist1">
9602 push.useForceIfIncludes
9603 </dt>
9604 <dd>
9605 <p>
9606         If set to "true", it is equivalent to specifying
9607         <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
9608         in the command line. Adding <code>--no-force-if-includes</code> at the
9609         time of push overrides this configuration setting.
9610 </p>
9611 </dd>
9612 <dt class="hdlist1">
9613 push.negotiate
9614 </dt>
9615 <dd>
9616 <p>
9617         If set to "true", attempt to reduce the size of the packfile
9618         sent by rounds of negotiation in which the client and the
9619         server attempt to find commits in common. If "false", Git will
9620         rely solely on the server&#8217;s ref advertisement to find commits
9621         in common.
9622 </p>
9623 </dd>
9624 <dt class="hdlist1">
9625 push.useBitmaps
9626 </dt>
9627 <dd>
9628 <p>
9629         If set to "false", disable use of bitmaps for "git push" even if
9630         <code>pack.useBitmaps</code> is "true", without preventing other git operations
9631         from using bitmaps. Default is true.
9632 </p>
9633 </dd>
9634 <dt class="hdlist1">
9635 rebase.backend
9636 </dt>
9637 <dd>
9638 <p>
9639         Default backend to use for rebasing.  Possible choices are
9640         <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
9641         all remaining capabilities of the apply backend, this setting
9642         may become unused.
9643 </p>
9644 </dd>
9645 <dt class="hdlist1">
9646 rebase.stat
9647 </dt>
9648 <dd>
9649 <p>
9650         Whether to show a diffstat of what changed upstream since the last
9651         rebase. False by default.
9652 </p>
9653 </dd>
9654 <dt class="hdlist1">
9655 rebase.autoSquash
9656 </dt>
9657 <dd>
9658 <p>
9659         If set to true enable <code>--autosquash</code> option by default.
9660 </p>
9661 </dd>
9662 <dt class="hdlist1">
9663 rebase.autoStash
9664 </dt>
9665 <dd>
9666 <p>
9667         When set to true, automatically create a temporary stash entry
9668         before the operation begins, and apply it after the operation
9669         ends.  This means that you can run rebase on a dirty worktree.
9670         However, use with care: the final stash application after a
9671         successful rebase might result in non-trivial conflicts.
9672         This option can be overridden by the <code>--no-autostash</code> and
9673         <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
9674         Defaults to false.
9675 </p>
9676 </dd>
9677 <dt class="hdlist1">
9678 rebase.updateRefs
9679 </dt>
9680 <dd>
9681 <p>
9682         If set to true enable <code>--update-refs</code> option by default.
9683 </p>
9684 </dd>
9685 <dt class="hdlist1">
9686 rebase.missingCommitsCheck
9687 </dt>
9688 <dd>
9689 <p>
9690         If set to "warn", git rebase -i will print a warning if some
9691         commits are removed (e.g. a line was deleted), however the
9692         rebase will still proceed. If set to "error", it will print
9693         the previous warning and stop the rebase, <em>git rebase
9694         --edit-todo</em> can then be used to correct the error. If set to
9695         "ignore", no checking is done.
9696         To drop a commit without warning or error, use the <code>drop</code>
9697         command in the todo list.
9698         Defaults to "ignore".
9699 </p>
9700 </dd>
9701 <dt class="hdlist1">
9702 rebase.instructionFormat
9703 </dt>
9704 <dd>
9705 <p>
9706         A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
9707         todo list during an interactive rebase.  The format will
9708         automatically have the long commit hash prepended to the format.
9709 </p>
9710 </dd>
9711 <dt class="hdlist1">
9712 rebase.abbreviateCommands
9713 </dt>
9714 <dd>
9715 <p>
9716         If set to true, <code>git rebase</code> will use abbreviated command names in the
9717         todo list resulting in something like this:
9718 </p>
9719 <div class="listingblock">
9720 <div class="content">
9721 <pre><code>        p deadbee The oneline of the commit
9722         p fa1afe1 The oneline of the next commit
9723         ...</code></pre>
9724 </div></div>
9725 <div class="paragraph"><p>instead of:</p></div>
9726 <div class="listingblock">
9727 <div class="content">
9728 <pre><code>        pick deadbee The oneline of the commit
9729         pick fa1afe1 The oneline of the next commit
9730         ...</code></pre>
9731 </div></div>
9732 <div class="paragraph"><p>Defaults to false.</p></div>
9733 </dd>
9734 <dt class="hdlist1">
9735 rebase.rescheduleFailedExec
9736 </dt>
9737 <dd>
9738 <p>
9739         Automatically reschedule <code>exec</code> commands that failed. This only makes
9740         sense in interactive mode (or when an <code>--exec</code> option was provided).
9741         This is the same as specifying the <code>--reschedule-failed-exec</code> option.
9742 </p>
9743 </dd>
9744 <dt class="hdlist1">
9745 rebase.forkPoint
9746 </dt>
9747 <dd>
9748 <p>
9749         If set to false set <code>--no-fork-point</code> option by default.
9750 </p>
9751 </dd>
9752 <dt class="hdlist1">
9753 rebase.rebaseMerges
9754 </dt>
9755 <dd>
9756 <p>
9757         Whether and how to set the <code>--rebase-merges</code> option by default. Can
9758         be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
9759         true or to <code>no-rebase-cousins</code> is equivalent to
9760         <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
9761         equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
9762         equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
9763         command line, with or without an argument, overrides any
9764         <code>rebase.rebaseMerges</code> configuration.
9765 </p>
9766 </dd>
9767 <dt class="hdlist1">
9768 rebase.maxLabelLength
9769 </dt>
9770 <dd>
9771 <p>
9772         When generating label names from commit subjects, truncate the names to
9773         this length. By default, the names are truncated to a little less than
9774         <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
9775         corresponding loose refs).
9776 </p>
9777 </dd>
9778 <dt class="hdlist1">
9779 receive.advertiseAtomic
9780 </dt>
9781 <dd>
9782 <p>
9783         By default, git-receive-pack will advertise the atomic push
9784         capability to its clients. If you don&#8217;t want to advertise this
9785         capability, set this variable to false.
9786 </p>
9787 </dd>
9788 <dt class="hdlist1">
9789 receive.advertisePushOptions
9790 </dt>
9791 <dd>
9792 <p>
9793         When set to true, git-receive-pack will advertise the push options
9794         capability to its clients. False by default.
9795 </p>
9796 </dd>
9797 <dt class="hdlist1">
9798 receive.autogc
9799 </dt>
9800 <dd>
9801 <p>
9802         By default, git-receive-pack will run "git-gc --auto" after
9803         receiving data from git-push and updating refs.  You can stop
9804         it by setting this variable to false.
9805 </p>
9806 </dd>
9807 <dt class="hdlist1">
9808 receive.certNonceSeed
9809 </dt>
9810 <dd>
9811 <p>
9812         By setting this variable to a string, <code>git receive-pack</code>
9813         will accept a <code>git push --signed</code> and verify it by using
9814         a "nonce" protected by HMAC using this string as a secret
9815         key.
9816 </p>
9817 </dd>
9818 <dt class="hdlist1">
9819 receive.certNonceSlop
9820 </dt>
9821 <dd>
9822 <p>
9823         When a <code>git push --signed</code> sends a push certificate with a
9824         "nonce" that was issued by a receive-pack serving the same
9825         repository within this many seconds, export the "nonce"
9826         found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
9827         hooks (instead of what the receive-pack asked the sending
9828         side to include).  This may allow writing checks in
9829         <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
9830         checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
9831         that records by how many seconds the nonce is stale to
9832         decide if they want to accept the certificate, they only
9833         can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
9834 </p>
9835 </dd>
9836 <dt class="hdlist1">
9837 receive.fsckObjects
9838 </dt>
9839 <dd>
9840 <p>
9841         If it is set to true, git-receive-pack will check all received
9842         objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
9843         Defaults to false. If not set, the value of
9844         <code>transfer.fsckObjects</code> is used instead.
9845 </p>
9846 </dd>
9847 <dt class="hdlist1">
9848 receive.fsck.&lt;msg-id&gt;
9849 </dt>
9850 <dd>
9851 <p>
9852         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
9853         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
9854         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
9855         details.
9856 </p>
9857 </dd>
9858 <dt class="hdlist1">
9859 receive.fsck.skipList
9860 </dt>
9861 <dd>
9862 <p>
9863         Acts like <code>fsck.skipList</code>, but is used by
9864         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
9865         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
9866         details.
9867 </p>
9868 </dd>
9869 <dt class="hdlist1">
9870 receive.keepAlive
9871 </dt>
9872 <dd>
9873 <p>
9874         After receiving the pack from the client, <code>receive-pack</code> may
9875         produce no output (if <code>--quiet</code> was specified) while processing
9876         the pack, causing some networks to drop the TCP connection.
9877         With this option set, if <code>receive-pack</code> does not transmit
9878         any data in this phase for <code>receive.keepAlive</code> seconds, it will
9879         send a short keepalive packet.  The default is 5 seconds; set
9880         to 0 to disable keepalives entirely.
9881 </p>
9882 </dd>
9883 <dt class="hdlist1">
9884 receive.unpackLimit
9885 </dt>
9886 <dd>
9887 <p>
9888         If the number of objects received in a push is below this
9889         limit then the objects will be unpacked into loose object
9890         files. However if the number of received objects equals or
9891         exceeds this limit then the received pack will be stored as
9892         a pack, after adding any missing delta bases.  Storing the
9893         pack from a push can make the push operation complete faster,
9894         especially on slow filesystems.  If not set, the value of
9895         <code>transfer.unpackLimit</code> is used instead.
9896 </p>
9897 </dd>
9898 <dt class="hdlist1">
9899 receive.maxInputSize
9900 </dt>
9901 <dd>
9902 <p>
9903         If the size of the incoming pack stream is larger than this
9904         limit, then git-receive-pack will error out, instead of
9905         accepting the pack file. If not set or set to 0, then the size
9906         is unlimited.
9907 </p>
9908 </dd>
9909 <dt class="hdlist1">
9910 receive.denyDeletes
9911 </dt>
9912 <dd>
9913 <p>
9914         If set to true, git-receive-pack will deny a ref update that deletes
9915         the ref. Use this to prevent such a ref deletion via a push.
9916 </p>
9917 </dd>
9918 <dt class="hdlist1">
9919 receive.denyDeleteCurrent
9920 </dt>
9921 <dd>
9922 <p>
9923         If set to true, git-receive-pack will deny a ref update that
9924         deletes the currently checked out branch of a non-bare repository.
9925 </p>
9926 </dd>
9927 <dt class="hdlist1">
9928 receive.denyCurrentBranch
9929 </dt>
9930 <dd>
9931 <p>
9932         If set to true or "refuse", git-receive-pack will deny a ref update
9933         to the currently checked out branch of a non-bare repository.
9934         Such a push is potentially dangerous because it brings the HEAD
9935         out of sync with the index and working tree. If set to "warn",
9936         print a warning of such a push to stderr, but allow the push to
9937         proceed. If set to false or "ignore", allow such pushes with no
9938         message. Defaults to "refuse".
9939 </p>
9940 <div class="paragraph"><p>Another option is "updateInstead" which will update the working
9941 tree if pushing into the current branch.  This option is
9942 intended for synchronizing working directories when one side is not easily
9943 accessible via interactive ssh (e.g. a live web site, hence the requirement
9944 that the working directory be clean). This mode also comes in handy when
9945 developing inside a VM to test and fix code on different Operating Systems.</p></div>
9946 <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
9947 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
9948 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p></div>
9949 </dd>
9950 <dt class="hdlist1">
9951 receive.denyNonFastForwards
9952 </dt>
9953 <dd>
9954 <p>
9955         If set to true, git-receive-pack will deny a ref update which is
9956         not a fast-forward. Use this to prevent such an update via a push,
9957         even if that push is forced. This configuration variable is
9958         set when initializing a shared repository.
9959 </p>
9960 </dd>
9961 <dt class="hdlist1">
9962 receive.hideRefs
9963 </dt>
9964 <dd>
9965 <p>
9966         This variable is the same as <code>transfer.hideRefs</code>, but applies
9967         only to <code>receive-pack</code> (and so affects pushes, but not fetches).
9968         An attempt to update or delete a hidden ref by <code>git push</code> is
9969         rejected.
9970 </p>
9971 </dd>
9972 <dt class="hdlist1">
9973 receive.procReceiveRefs
9974 </dt>
9975 <dd>
9976 <p>
9977         This is a multi-valued variable that defines reference prefixes
9978         to match the commands in <code>receive-pack</code>.  Commands matching the
9979         prefixes will be executed by an external hook "proc-receive",
9980         instead of the internal <code>execute_commands</code> function.  If this
9981         variable is not defined, the "proc-receive" hook will never be
9982         used, and all commands will be executed by the internal
9983         <code>execute_commands</code> function.
9984 </p>
9985 <div class="paragraph"><p>For example, if this variable is set to "refs/for", pushing to reference
9986 such as "refs/for/master" will not create or update a reference named
9987 "refs/for/master", but may create or update a pull request directly by
9988 running the hook "proc-receive".</p></div>
9989 <div class="paragraph"><p>Optional modifiers can be provided in the beginning of the value to filter
9990 commands for specific actions: create (a), modify (m), delete (d).
9991 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
9992 E.g.:</p></div>
9993 <div class="literalblock">
9994 <div class="content">
9995 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
9996 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
9997 </div></div>
9998 </dd>
9999 <dt class="hdlist1">
10000 receive.updateServerInfo
10001 </dt>
10002 <dd>
10003 <p>
10004         If set to true, git-receive-pack will run git-update-server-info
10005         after receiving data from git-push and updating refs.
10006 </p>
10007 </dd>
10008 <dt class="hdlist1">
10009 receive.shallowUpdate
10010 </dt>
10011 <dd>
10012 <p>
10013         If set to true, .git/shallow can be updated when new refs
10014         require new shallow roots. Otherwise those refs are rejected.
10015 </p>
10016 </dd>
10017 <dt class="hdlist1">
10018 remote.pushDefault
10019 </dt>
10020 <dd>
10021 <p>
10022         The remote to push to by default.  Overrides
10023         <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
10024         <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
10025 </p>
10026 </dd>
10027 <dt class="hdlist1">
10028 remote.&lt;name&gt;.url
10029 </dt>
10030 <dd>
10031 <p>
10032         The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
10033         <a href="git-push.html">git-push(1)</a>.
10034 </p>
10035 </dd>
10036 <dt class="hdlist1">
10037 remote.&lt;name&gt;.pushurl
10038 </dt>
10039 <dd>
10040 <p>
10041         The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
10042 </p>
10043 </dd>
10044 <dt class="hdlist1">
10045 remote.&lt;name&gt;.proxy
10046 </dt>
10047 <dd>
10048 <p>
10049         For remotes that require curl (http, https and ftp), the URL to
10050         the proxy to use for that remote.  Set to the empty string to
10051         disable proxying for that remote.
10052 </p>
10053 </dd>
10054 <dt class="hdlist1">
10055 remote.&lt;name&gt;.proxyAuthMethod
10056 </dt>
10057 <dd>
10058 <p>
10059         For remotes that require curl (http, https and ftp), the method to use for
10060         authenticating against the proxy in use (probably set in
10061         <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
10062 </p>
10063 </dd>
10064 <dt class="hdlist1">
10065 remote.&lt;name&gt;.fetch
10066 </dt>
10067 <dd>
10068 <p>
10069         The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
10070         <a href="git-fetch.html">git-fetch(1)</a>.
10071 </p>
10072 </dd>
10073 <dt class="hdlist1">
10074 remote.&lt;name&gt;.push
10075 </dt>
10076 <dd>
10077 <p>
10078         The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
10079         <a href="git-push.html">git-push(1)</a>.
10080 </p>
10081 </dd>
10082 <dt class="hdlist1">
10083 remote.&lt;name&gt;.mirror
10084 </dt>
10085 <dd>
10086 <p>
10087         If true, pushing to this remote will automatically behave
10088         as if the <code>--mirror</code> option was given on the command line.
10089 </p>
10090 </dd>
10091 <dt class="hdlist1">
10092 remote.&lt;name&gt;.skipDefaultUpdate
10093 </dt>
10094 <dd>
10095 <p>
10096         If true, this remote will be skipped by default when updating
10097         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10098         <a href="git-remote.html">git-remote(1)</a>.
10099 </p>
10100 </dd>
10101 <dt class="hdlist1">
10102 remote.&lt;name&gt;.skipFetchAll
10103 </dt>
10104 <dd>
10105 <p>
10106         If true, this remote will be skipped by default when updating
10107         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10108         <a href="git-remote.html">git-remote(1)</a>.
10109 </p>
10110 </dd>
10111 <dt class="hdlist1">
10112 remote.&lt;name&gt;.receivepack
10113 </dt>
10114 <dd>
10115 <p>
10116         The default program to execute on the remote side when pushing.  See
10117         option --receive-pack of <a href="git-push.html">git-push(1)</a>.
10118 </p>
10119 </dd>
10120 <dt class="hdlist1">
10121 remote.&lt;name&gt;.uploadpack
10122 </dt>
10123 <dd>
10124 <p>
10125         The default program to execute on the remote side when fetching.  See
10126         option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
10127 </p>
10128 </dd>
10129 <dt class="hdlist1">
10130 remote.&lt;name&gt;.tagOpt
10131 </dt>
10132 <dd>
10133 <p>
10134         Setting this value to --no-tags disables automatic tag following when
10135         fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
10136         tag from remote &lt;name&gt;, even if they are not reachable from remote
10137         branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
10138         override this setting. See options --tags and --no-tags of
10139         <a href="git-fetch.html">git-fetch(1)</a>.
10140 </p>
10141 </dd>
10142 <dt class="hdlist1">
10143 remote.&lt;name&gt;.vcs
10144 </dt>
10145 <dd>
10146 <p>
10147         Setting this to a value &lt;vcs&gt; will cause Git to interact with
10148         the remote with the git-remote-&lt;vcs&gt; helper.
10149 </p>
10150 </dd>
10151 <dt class="hdlist1">
10152 remote.&lt;name&gt;.prune
10153 </dt>
10154 <dd>
10155 <p>
10156         When set to true, fetching from this remote by default will also
10157         remove any remote-tracking references that no longer exist on the
10158         remote (as if the <code>--prune</code> option was given on the command line).
10159         Overrides <code>fetch.prune</code> settings, if any.
10160 </p>
10161 </dd>
10162 <dt class="hdlist1">
10163 remote.&lt;name&gt;.pruneTags
10164 </dt>
10165 <dd>
10166 <p>
10167         When set to true, fetching from this remote by default will also
10168         remove any local tags that no longer exist on the remote if pruning
10169         is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
10170         <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10171 </p>
10172 <div class="paragraph"><p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
10173 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
10174 </dd>
10175 <dt class="hdlist1">
10176 remote.&lt;name&gt;.promisor
10177 </dt>
10178 <dd>
10179 <p>
10180         When set to true, this remote will be used to fetch promisor
10181         objects.
10182 </p>
10183 </dd>
10184 <dt class="hdlist1">
10185 remote.&lt;name&gt;.partialclonefilter
10186 </dt>
10187 <dd>
10188 <p>
10189         The filter that will be applied when fetching from this promisor remote.
10190         Changing or clearing this value will only affect fetches for new commits.
10191         To fetch associated objects for commits already present in the local object
10192         database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.
10193 </p>
10194 </dd>
10195 <dt class="hdlist1">
10196 remotes.&lt;group&gt;
10197 </dt>
10198 <dd>
10199 <p>
10200         The list of remotes which are fetched by "git remote update
10201         &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.
10202 </p>
10203 </dd>
10204 <dt class="hdlist1">
10205 repack.useDeltaBaseOffset
10206 </dt>
10207 <dd>
10208 <p>
10209         By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
10210         delta-base offset. If you need to share your repository with
10211         Git older than version 1.4.4, either directly or via a dumb
10212         protocol such as http, then you need to set this option to
10213         "false" and repack. Access from old Git versions over the
10214         native protocol are unaffected by this option.
10215 </p>
10216 </dd>
10217 <dt class="hdlist1">
10218 repack.packKeptObjects
10219 </dt>
10220 <dd>
10221 <p>
10222         If set to true, makes <code>git repack</code> act as if
10223         <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
10224         details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10225         index is being written (either via <code>--write-bitmap-index</code> or
10226         <code>repack.writeBitmaps</code>).
10227 </p>
10228 </dd>
10229 <dt class="hdlist1">
10230 repack.useDeltaIslands
10231 </dt>
10232 <dd>
10233 <p>
10234         If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10235         was passed. Defaults to <code>false</code>.
10236 </p>
10237 </dd>
10238 <dt class="hdlist1">
10239 repack.writeBitmaps
10240 </dt>
10241 <dd>
10242 <p>
10243         When true, git will write a bitmap index when packing all
10244         objects to disk (e.g., when <code>git repack -a</code> is run).  This
10245         index can speed up the "counting objects" phase of subsequent
10246         packs created for clones and fetches, at the cost of some disk
10247         space and extra time spent on the initial repack.  This has
10248         no effect if multiple packfiles are created.
10249         Defaults to true on bare repos, false otherwise.
10250 </p>
10251 </dd>
10252 <dt class="hdlist1">
10253 repack.updateServerInfo
10254 </dt>
10255 <dd>
10256 <p>
10257         If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
10258         <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10259         when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.
10260 </p>
10261 </dd>
10262 <dt class="hdlist1">
10263 repack.cruftWindow
10264 </dt>
10265 <dt class="hdlist1">
10266 repack.cruftWindowMemory
10267 </dt>
10268 <dt class="hdlist1">
10269 repack.cruftDepth
10270 </dt>
10271 <dt class="hdlist1">
10272 repack.cruftThreads
10273 </dt>
10274 <dd>
10275 <p>
10276         Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
10277         a cruft pack and the respective parameters are not given over
10278         the command line. See similarly named <code>pack.*</code> configuration
10279         variables for defaults and meaning.
10280 </p>
10281 </dd>
10282 <dt class="hdlist1">
10283 rerere.autoUpdate
10284 </dt>
10285 <dd>
10286 <p>
10287         When set to true, <code>git-rerere</code> updates the index with the
10288         resulting contents after it cleanly resolves conflicts using
10289         previously recorded resolutions.  Defaults to false.
10290 </p>
10291 </dd>
10292 <dt class="hdlist1">
10293 rerere.enabled
10294 </dt>
10295 <dd>
10296 <p>
10297         Activate recording of resolved conflicts, so that identical
10298         conflict hunks can be resolved automatically, should they be
10299         encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
10300         enabled if there is an <code>rr-cache</code> directory under the
10301         <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
10302         repository.
10303 </p>
10304 </dd>
10305 <dt class="hdlist1">
10306 revert.reference
10307 </dt>
10308 <dd>
10309 <p>
10310         Setting this variable to true makes <code>git revert</code> behave
10311         as if the <code>--reference</code> option is given.
10312 </p>
10313 </dd>
10314 <dt class="hdlist1">
10315 safe.bareRepository
10316 </dt>
10317 <dd>
10318 <p>
10319         Specifies which bare repositories Git will work with. The currently
10320         supported values are:
10321 </p>
10322 <div class="ulist"><ul>
10323 <li>
10324 <p>
10325 <code>all</code>: Git works with all bare repositories. This is the default.
10326 </p>
10327 </li>
10328 <li>
10329 <p>
10330 <code>explicit</code>: Git only works with bare repositories specified via
10331   the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10332   environment variable (see <a href="git.html">git(1)</a>).
10333 </p>
10334 <div class="paragraph"><p>If you do not use bare repositories in your workflow, then it may be
10335 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10336 config. This will protect you from attacks that involve cloning a
10337 repository that contains a bare repository and running a Git command
10338 within that directory.</p></div>
10339 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10340 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with
10341 this value.</p></div>
10342 </li>
10343 </ul></div>
10344 </dd>
10345 <dt class="hdlist1">
10346 safe.directory
10347 </dt>
10348 <dd>
10349 <p>
10350         These config entries specify Git-tracked directories that are
10351         considered safe even if they are owned by someone other than the
10352         current user. By default, Git will refuse to even parse a Git
10353         config of a repository owned by someone else, let alone run its
10354         hooks, and this config setting allows users to specify exceptions,
10355         e.g. for intentionally shared repositories (see the <code>--shared</code>
10356         option in <a href="git-init.html">git-init(1)</a>).
10357 </p>
10358 <div class="paragraph"><p>This is a multi-valued setting, i.e. you can add more than one directory
10359 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10360 override any such directories specified in the system config), add a
10361 <code>safe.directory</code> entry with an empty value.</p></div>
10362 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10363 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with this
10364 value.</p></div>
10365 <div class="paragraph"><p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
10366 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
10367 path relative to Git&#8217;s (runtime) prefix.</p></div>
10368 <div class="paragraph"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10369 string <code>*</code>. This will allow all repositories to be treated as if their
10370 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10371 is set in system config and you want to re-enable this protection, then
10372 initialize your list with an empty value before listing the repositories
10373 that you deem safe.</p></div>
10374 <div class="paragraph"><p>As explained, Git only allows you to access repositories owned by
10375 yourself, i.e. the user who is running Git, by default.  When Git
10376 is running as <em>root</em> in a non Windows platform that provides sudo,
10377 however, git checks the SUDO_UID environment variable that sudo creates
10378 and will allow access to the uid recorded as its value in addition to
10379 the id from <em>root</em>.
10380 This is to make it easy to perform a common sequence during installation
10381 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
10382 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
10383 which id the original user has.
10384 If that is not what you would prefer and want git to only trust
10385 repositories that are owned by root instead, then you can remove
10386 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p></div>
10387 </dd>
10388 <dt class="hdlist1">
10389 sendemail.identity
10390 </dt>
10391 <dd>
10392 <p>
10393         A configuration identity. When given, causes values in the
10394         <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
10395         values in the <em>sendemail</em> section. The default identity is
10396         the value of <code>sendemail.identity</code>.
10397 </p>
10398 </dd>
10399 <dt class="hdlist1">
10400 sendemail.smtpEncryption
10401 </dt>
10402 <dd>
10403 <p>
10404         See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
10405         setting is not subject to the <em>identity</em> mechanism.
10406 </p>
10407 </dd>
10408 <dt class="hdlist1">
10409 sendemail.smtpsslcertpath
10410 </dt>
10411 <dd>
10412 <p>
10413         Path to ca-certificates (either a directory or a single file).
10414         Set it to an empty string to disable certificate verification.
10415 </p>
10416 </dd>
10417 <dt class="hdlist1">
10418 sendemail.&lt;identity&gt;.*
10419 </dt>
10420 <dd>
10421 <p>
10422         Identity-specific versions of the <em>sendemail.*</em> parameters
10423         found below, taking precedence over those when this
10424         identity is selected, through either the command-line or
10425         <code>sendemail.identity</code>.
10426 </p>
10427 </dd>
10428 <dt class="hdlist1">
10429 sendemail.multiEdit
10430 </dt>
10431 <dd>
10432 <p>
10433         If true (default), a single editor instance will be spawned to edit
10434         files you have to edit (patches when <code>--annotate</code> is used, and the
10435         summary when <code>--compose</code> is used). If false, files will be edited one
10436         after the other, spawning a new editor each time.
10437 </p>
10438 </dd>
10439 <dt class="hdlist1">
10440 sendemail.confirm
10441 </dt>
10442 <dd>
10443 <p>
10444         Sets the default for whether to confirm before sending. Must be
10445         one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
10446         in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
10447         values.
10448 </p>
10449 </dd>
10450 <dt class="hdlist1">
10451 sendemail.aliasesFile
10452 </dt>
10453 <dd>
10454 <p>
10455         To avoid typing long email addresses, point this to one or more
10456         email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.
10457 </p>
10458 </dd>
10459 <dt class="hdlist1">
10460 sendemail.aliasFileType
10461 </dt>
10462 <dd>
10463 <p>
10464         Format of the file(s) specified in sendemail.aliasesFile. Must be
10465         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.
10466 </p>
10467 <div class="paragraph"><p>What an alias file in each format looks like can be found in
10468 the documentation of the email program of the same name. The
10469 differences and limitations from the standard formats are
10470 described below:</p></div>
10471 <div class="openblock">
10472 <div class="content">
10473 <div class="dlist"><dl>
10474 <dt class="hdlist1">
10475 sendmail
10476 </dt>
10477 <dd>
10478 <div class="ulist"><ul>
10479 <li>
10480 <p>
10481 Quoted aliases and quoted addresses are not supported: lines that
10482         contain a <code>"</code> symbol are ignored.
10483 </p>
10484 </li>
10485 <li>
10486 <p>
10487 Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
10488         supported.
10489 </p>
10490 </li>
10491 <li>
10492 <p>
10493 File inclusion (<code>:include: /path/name</code>) is not supported.
10494 </p>
10495 </li>
10496 <li>
10497 <p>
10498 Warnings are printed on the standard error output for any
10499         explicitly unsupported constructs, and any other lines that are not
10500         recognized by the parser.
10501 </p>
10502 </li>
10503 </ul></div>
10504 </dd>
10505 </dl></div>
10506 </div></div>
10507 </dd>
10508 <dt class="hdlist1">
10509 sendemail.annotate
10510 </dt>
10511 <dt class="hdlist1">
10512 sendemail.bcc
10513 </dt>
10514 <dt class="hdlist1">
10515 sendemail.cc
10516 </dt>
10517 <dt class="hdlist1">
10518 sendemail.ccCmd
10519 </dt>
10520 <dt class="hdlist1">
10521 sendemail.chainReplyTo
10522 </dt>
10523 <dt class="hdlist1">
10524 sendemail.envelopeSender
10525 </dt>
10526 <dt class="hdlist1">
10527 sendemail.from
10528 </dt>
10529 <dt class="hdlist1">
10530 sendemail.headerCmd
10531 </dt>
10532 <dt class="hdlist1">
10533 sendemail.signedoffbycc
10534 </dt>
10535 <dt class="hdlist1">
10536 sendemail.smtpPass
10537 </dt>
10538 <dt class="hdlist1">
10539 sendemail.suppresscc
10540 </dt>
10541 <dt class="hdlist1">
10542 sendemail.suppressFrom
10543 </dt>
10544 <dt class="hdlist1">
10545 sendemail.to
10546 </dt>
10547 <dt class="hdlist1">
10548 sendemail.tocmd
10549 </dt>
10550 <dt class="hdlist1">
10551 sendemail.smtpDomain
10552 </dt>
10553 <dt class="hdlist1">
10554 sendemail.smtpServer
10555 </dt>
10556 <dt class="hdlist1">
10557 sendemail.smtpServerPort
10558 </dt>
10559 <dt class="hdlist1">
10560 sendemail.smtpServerOption
10561 </dt>
10562 <dt class="hdlist1">
10563 sendemail.smtpUser
10564 </dt>
10565 <dt class="hdlist1">
10566 sendemail.thread
10567 </dt>
10568 <dt class="hdlist1">
10569 sendemail.transferEncoding
10570 </dt>
10571 <dt class="hdlist1">
10572 sendemail.validate
10573 </dt>
10574 <dt class="hdlist1">
10575 sendemail.xmailer
10576 </dt>
10577 <dd>
10578 <p>
10579         These configuration variables all provide a default for
10580         <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
10581         documentation for details.
10582 </p>
10583 </dd>
10584 <dt class="hdlist1">
10585 sendemail.signedoffcc (deprecated)
10586 </dt>
10587 <dd>
10588 <p>
10589         Deprecated alias for <code>sendemail.signedoffbycc</code>.
10590 </p>
10591 </dd>
10592 <dt class="hdlist1">
10593 sendemail.smtpBatchSize
10594 </dt>
10595 <dd>
10596 <p>
10597         Number of messages to be sent per connection, after that a relogin
10598         will happen.  If the value is 0 or undefined, send all messages in
10599         one connection.
10600         See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10601 </p>
10602 </dd>
10603 <dt class="hdlist1">
10604 sendemail.smtpReloginDelay
10605 </dt>
10606 <dd>
10607 <p>
10608         Seconds to wait before reconnecting to the smtp server.
10609         See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10610 </p>
10611 </dd>
10612 <dt class="hdlist1">
10613 sendemail.forbidSendmailVariables
10614 </dt>
10615 <dd>
10616 <p>
10617         To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
10618         will abort with a warning if any configuration options for "sendmail"
10619         exist. Set this variable to bypass the check.
10620 </p>
10621 </dd>
10622 <dt class="hdlist1">
10623 sequence.editor
10624 </dt>
10625 <dd>
10626 <p>
10627         Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
10628         The value is meant to be interpreted by the shell when it is used.
10629         It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
10630         When not configured, the default commit message editor is used instead.
10631 </p>
10632 </dd>
10633 <dt class="hdlist1">
10634 showBranch.default
10635 </dt>
10636 <dd>
10637 <p>
10638         The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
10639         See <a href="git-show-branch.html">git-show-branch(1)</a>.
10640 </p>
10641 </dd>
10642 <dt class="hdlist1">
10643 sparse.expectFilesOutsideOfPatterns
10644 </dt>
10645 <dd>
10646 <p>
10647         Typically with sparse checkouts, files not matching any
10648         sparsity patterns are marked with a SKIP_WORKTREE bit in the
10649         index and are missing from the working tree.  Accordingly, Git
10650         will ordinarily check whether files with the SKIP_WORKTREE bit
10651         are in fact present in the working tree contrary to
10652         expectations.  If Git finds any, it marks those paths as
10653         present by clearing the relevant SKIP_WORKTREE bits.  This
10654         option can be used to tell Git that such
10655         present-despite-skipped files are expected and to stop
10656         checking for them.
10657 </p>
10658 <div class="paragraph"><p>The default is <code>false</code>, which allows Git to automatically recover
10659 from the list of files in the index and working tree falling out of
10660 sync.</p></div>
10661 <div class="paragraph"><p>Set this to <code>true</code> if you are in a setup where some external factor
10662 relieves Git of the responsibility for maintaining the consistency
10663 between the presence of working tree files and sparsity patterns.  For
10664 example, if you have a Git-aware virtual file system that has a robust
10665 mechanism for keeping the working tree and the sparsity patterns up to
10666 date based on access patterns.</p></div>
10667 <div class="paragraph"><p>Regardless of this setting, Git does not check for
10668 present-despite-skipped files unless sparse checkout is enabled, so
10669 this config option has no effect unless <code>core.sparseCheckout</code> is
10670 <code>true</code>.</p></div>
10671 </dd>
10672 <dt class="hdlist1">
10673 splitIndex.maxPercentChange
10674 </dt>
10675 <dd>
10676 <p>
10677         When the split index feature is used, this specifies the
10678         percent of entries the split index can contain compared to the
10679         total number of entries in both the split index and the shared
10680         index before a new shared index is written.
10681         The value should be between 0 and 100. If the value is 0, then
10682         a new shared index is always written; if it is 100, a new
10683         shared index is never written.
10684         By default, the value is 20, so a new shared index is written
10685         if the number of entries in the split index would be greater
10686         than 20 percent of the total number of entries.
10687         See <a href="git-update-index.html">git-update-index(1)</a>.
10688 </p>
10689 </dd>
10690 <dt class="hdlist1">
10691 splitIndex.sharedIndexExpire
10692 </dt>
10693 <dd>
10694 <p>
10695         When the split index feature is used, shared index files that
10696         were not modified since the time this variable specifies will
10697         be removed when a new shared index file is created. The value
10698         "now" expires all entries immediately, and "never" suppresses
10699         expiration altogether.
10700         The default value is "2.weeks.ago".
10701         Note that a shared index file is considered modified (for the
10702         purpose of expiration) each time a new split-index file is
10703         either created based on it or read from it.
10704         See <a href="git-update-index.html">git-update-index(1)</a>.
10705 </p>
10706 </dd>
10707 <dt class="hdlist1">
10708 ssh.variant
10709 </dt>
10710 <dd>
10711 <p>
10712         By default, Git determines the command line arguments to use
10713         based on the basename of the configured SSH command (configured
10714         using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
10715         the config setting <code>core.sshCommand</code>). If the basename is
10716         unrecognized, Git will attempt to detect support of OpenSSH
10717         options by first invoking the configured SSH command with the
10718         <code>-G</code> (print configuration) option and will subsequently use
10719         OpenSSH options (if that is successful) or no options besides
10720         the host and remote command (if it fails).
10721 </p>
10722 <div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this detection.
10723 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
10724 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
10725 The default auto-detection can be explicitly requested using the value
10726 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
10727 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
10728 <div class="paragraph"><p>The current command-line parameters used for each variant are as
10729 follows:</p></div>
10730 <div class="openblock">
10731 <div class="content">
10732 <div class="ulist"><ul>
10733 <li>
10734 <p>
10735 <code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command
10736 </p>
10737 </li>
10738 <li>
10739 <p>
10740 <code>simple</code> - [username@]host command
10741 </p>
10742 </li>
10743 <li>
10744 <p>
10745 <code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command
10746 </p>
10747 </li>
10748 <li>
10749 <p>
10750 <code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command
10751 </p>
10752 </li>
10753 </ul></div>
10754 </div></div>
10755 <div class="paragraph"><p>Except for the <code>simple</code> variant, command-line parameters are likely to
10756 change as git gains new features.</p></div>
10757 </dd>
10758 <dt class="hdlist1">
10759 status.relativePaths
10760 </dt>
10761 <dd>
10762 <p>
10763         By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
10764         current directory. Setting this variable to <code>false</code> shows paths
10765         relative to the repository root (this was the default for Git
10766         prior to v1.5.4).
10767 </p>
10768 </dd>
10769 <dt class="hdlist1">
10770 status.short
10771 </dt>
10772 <dd>
10773 <p>
10774         Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
10775         The option --no-short takes precedence over this variable.
10776 </p>
10777 </dd>
10778 <dt class="hdlist1">
10779 status.branch
10780 </dt>
10781 <dd>
10782 <p>
10783         Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
10784         The option --no-branch takes precedence over this variable.
10785 </p>
10786 </dd>
10787 <dt class="hdlist1">
10788 status.aheadBehind
10789 </dt>
10790 <dd>
10791 <p>
10792         Set to true to enable <code>--ahead-behind</code> and false to enable
10793         <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
10794         non-porcelain status formats.  Defaults to true.
10795 </p>
10796 </dd>
10797 <dt class="hdlist1">
10798 status.displayCommentPrefix
10799 </dt>
10800 <dd>
10801 <p>
10802         If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
10803         prefix before each output line (starting with
10804         <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
10805         behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
10806         Defaults to false.
10807 </p>
10808 </dd>
10809 <dt class="hdlist1">
10810 status.renameLimit
10811 </dt>
10812 <dd>
10813 <p>
10814         The number of files to consider when performing rename detection
10815         in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
10816         the value of diff.renameLimit.
10817 </p>
10818 </dd>
10819 <dt class="hdlist1">
10820 status.renames
10821 </dt>
10822 <dd>
10823 <p>
10824         Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
10825         <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
10826         disabled. If set to "true", basic rename detection is enabled.
10827         If set to "copies" or "copy", Git will detect copies, as well.
10828         Defaults to the value of diff.renames.
10829 </p>
10830 </dd>
10831 <dt class="hdlist1">
10832 status.showStash
10833 </dt>
10834 <dd>
10835 <p>
10836         If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
10837         entries currently stashed away.
10838         Defaults to false.
10839 </p>
10840 </dd>
10841 <dt class="hdlist1">
10842 status.showUntrackedFiles
10843 </dt>
10844 <dd>
10845 <p>
10846         By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
10847         files which are not currently tracked by Git. Directories which
10848         contain only untracked files, are shown with the directory name
10849         only. Showing untracked files means that Git needs to lstat() all
10850         the files in the whole repository, which might be slow on some
10851         systems. So, this variable controls how the commands display
10852         the untracked files. Possible values are:
10853 </p>
10854 <div class="openblock">
10855 <div class="content">
10856 <div class="ulist"><ul>
10857 <li>
10858 <p>
10859 <code>no</code> - Show no untracked files.
10860 </p>
10861 </li>
10862 <li>
10863 <p>
10864 <code>normal</code> - Show untracked files and directories.
10865 </p>
10866 </li>
10867 <li>
10868 <p>
10869 <code>all</code> - Show also individual files in untracked directories.
10870 </p>
10871 </li>
10872 </ul></div>
10873 </div></div>
10874 <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
10875 This variable can be overridden with the -u|--untracked-files option
10876 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
10877 </dd>
10878 <dt class="hdlist1">
10879 status.submoduleSummary
10880 </dt>
10881 <dd>
10882 <p>
10883         Defaults to false.
10884         If this is set to a non-zero number or true (identical to -1 or an
10885         unlimited number), the submodule summary will be enabled and a
10886         summary of commits for modified submodules will be shown (see
10887         --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
10888         that the summary output command will be suppressed for all
10889         submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
10890         for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
10891         exception to that rule is that status and commit will show staged
10892         submodule changes. To
10893         also view the summary for ignored submodules you can either use
10894         the --ignore-submodules=dirty command-line option or the <em>git
10895         submodule summary</em> command, which shows a similar output but does
10896         not honor these settings.
10897 </p>
10898 </dd>
10899 <dt class="hdlist1">
10900 stash.showIncludeUntracked
10901 </dt>
10902 <dd>
10903 <p>
10904         If this is set to true, the <code>git stash show</code> command will show
10905         the untracked files of a stash entry.  Defaults to false. See
10906         the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10907 </p>
10908 </dd>
10909 <dt class="hdlist1">
10910 stash.showPatch
10911 </dt>
10912 <dd>
10913 <p>
10914         If this is set to true, the <code>git stash show</code> command without an
10915         option will show the stash entry in patch form.  Defaults to false.
10916         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10917 </p>
10918 </dd>
10919 <dt class="hdlist1">
10920 stash.showStat
10921 </dt>
10922 <dd>
10923 <p>
10924         If this is set to true, the <code>git stash show</code> command without an
10925         option will show a diffstat of the stash entry.  Defaults to true.
10926         See 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 submodule.&lt;name&gt;.url
10931 </dt>
10932 <dd>
10933 <p>
10934         The URL for a submodule. This variable is copied from the .gitmodules
10935         file to the git config via <em>git submodule init</em>. The user can change
10936         the configured URL before obtaining the submodule via <em>git submodule
10937         update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
10938         set, the presence of this variable is used as a fallback to indicate
10939         whether the submodule is of interest to git commands.
10940         See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
10941 </p>
10942 </dd>
10943 <dt class="hdlist1">
10944 submodule.&lt;name&gt;.update
10945 </dt>
10946 <dd>
10947 <p>
10948         The method by which a submodule is updated by <em>git submodule update</em>,
10949         which is the only affected command, others such as
10950         <em>git checkout --recurse-submodules</em> are unaffected. It exists for
10951         historical reasons, when <em>git submodule</em> was the only command to
10952         interact with submodules; settings like <code>submodule.active</code>
10953         and <code>pull.rebase</code> are more specific. It is populated by
10954         <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
10955         See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.
10956 </p>
10957 </dd>
10958 <dt class="hdlist1">
10959 submodule.&lt;name&gt;.branch
10960 </dt>
10961 <dd>
10962 <p>
10963         The remote branch name for a submodule, used by <code>git submodule
10964         update --remote</code>.  Set this option to override the value found in
10965         the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
10966         <a href="gitmodules.html">gitmodules(5)</a> for details.
10967 </p>
10968 </dd>
10969 <dt class="hdlist1">
10970 submodule.&lt;name&gt;.fetchRecurseSubmodules
10971 </dt>
10972 <dd>
10973 <p>
10974         This option can be used to control recursive fetching of this
10975         submodule. It can be overridden by using the --[no-]recurse-submodules
10976         command-line option to "git fetch" and "git pull".
10977         This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
10978         file.
10979 </p>
10980 </dd>
10981 <dt class="hdlist1">
10982 submodule.&lt;name&gt;.ignore
10983 </dt>
10984 <dd>
10985 <p>
10986         Defines under what circumstances "git status" and the diff family show
10987         a submodule as modified. When set to "all", it will never be considered
10988         modified (but it will nonetheless show up in the output of status and
10989         commit when it has been staged), "dirty" will ignore all changes
10990         to the submodule&#8217;s work tree and
10991         takes only differences between the HEAD of the submodule and the commit
10992         recorded in the superproject into account. "untracked" will additionally
10993         let submodules with modified tracked files in their work tree show up.
10994         Using "none" (the default when this option is not set) also shows
10995         submodules that have untracked files in their work tree as changed.
10996         This setting overrides any setting made in .gitmodules for this submodule,
10997         both settings can be overridden on the command line by using the
10998         "--ignore-submodules" option. The <em>git submodule</em> commands are not
10999         affected by this setting.
11000 </p>
11001 </dd>
11002 <dt class="hdlist1">
11003 submodule.&lt;name&gt;.active
11004 </dt>
11005 <dd>
11006 <p>
11007         Boolean value indicating if the submodule is of interest to git
11008         commands.  This config option takes precedence over the
11009         submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
11010         details.
11011 </p>
11012 </dd>
11013 <dt class="hdlist1">
11014 submodule.active
11015 </dt>
11016 <dd>
11017 <p>
11018         A repeated field which contains a pathspec used to match against a
11019         submodule&#8217;s path to determine if the submodule is of interest to git
11020         commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.
11021 </p>
11022 </dd>
11023 <dt class="hdlist1">
11024 submodule.recurse
11025 </dt>
11026 <dd>
11027 <p>
11028         A boolean indicating if commands should enable the <code>--recurse-submodules</code>
11029         option by default. Defaults to false.
11030 </p>
11031 <div class="paragraph"><p>When set to true, it can be deactivated via the
11032 <code>--no-recurse-submodules</code> option. Note that some Git commands
11033 lacking this option may call some of the above commands affected by
11034 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
11035 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
11036 For these commands a workaround is to temporarily change the
11037 configuration value by using <code>git -c submodule.recurse=0</code>.</p></div>
11038 <div class="paragraph"><p>The following list shows the commands that accept
11039 <code>--recurse-submodules</code> and whether they are supported by this
11040 setting.</p></div>
11041 <div class="ulist"><ul>
11042 <li>
11043 <p>
11044 <code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
11045 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.
11046 </p>
11047 </li>
11048 <li>
11049 <p>
11050 <code>clone</code> and <code>ls-files</code> are not supported.
11051 </p>
11052 </li>
11053 <li>
11054 <p>
11055 <code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
11056 enabled
11057 </p>
11058 </li>
11059 </ul></div>
11060 </dd>
11061 <dt class="hdlist1">
11062 submodule.propagateBranches
11063 </dt>
11064 <dd>
11065 <p>
11066         [EXPERIMENTAL] A boolean that enables branching support when
11067         using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
11068         Enabling this will allow certain commands to accept
11069         <code>--recurse-submodules</code> and certain commands that already accept
11070         <code>--recurse-submodules</code> will now consider branches.
11071         Defaults to false.
11072 </p>
11073 </dd>
11074 <dt class="hdlist1">
11075 submodule.fetchJobs
11076 </dt>
11077 <dd>
11078 <p>
11079         Specifies how many submodules are fetched/cloned at the same time.
11080         A positive integer allows up to that number of submodules fetched
11081         in parallel. A value of 0 will give some reasonable default.
11082         If unset, it defaults to 1.
11083 </p>
11084 </dd>
11085 <dt class="hdlist1">
11086 submodule.alternateLocation
11087 </dt>
11088 <dd>
11089 <p>
11090         Specifies how the submodules obtain alternates when submodules are
11091         cloned. Possible values are <code>no</code>, <code>superproject</code>.
11092         By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
11093         value is set to <code>superproject</code> the submodule to be cloned computes
11094         its alternates location relative to the superprojects alternate.
11095 </p>
11096 </dd>
11097 <dt class="hdlist1">
11098 submodule.alternateErrorStrategy
11099 </dt>
11100 <dd>
11101 <p>
11102         Specifies how to treat errors with the alternates for a submodule
11103         as computed via <code>submodule.alternateLocation</code>. Possible values are
11104         <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
11105         or <code>info</code>, and if there is an error with the computed alternate, the
11106         clone proceeds as if no alternate was specified.
11107 </p>
11108 </dd>
11109 <dt class="hdlist1">
11110 tag.forceSignAnnotated
11111 </dt>
11112 <dd>
11113 <p>
11114         A boolean to specify whether annotated tags created should be GPG signed.
11115         If <code>--annotate</code> is specified on the command line, it takes
11116         precedence over this option.
11117 </p>
11118 </dd>
11119 <dt class="hdlist1">
11120 tag.sort
11121 </dt>
11122 <dd>
11123 <p>
11124         This variable controls the sort ordering of tags when displayed by
11125         <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
11126         value of this variable will be used as the default.
11127 </p>
11128 </dd>
11129 <dt class="hdlist1">
11130 tag.gpgSign
11131 </dt>
11132 <dd>
11133 <p>
11134         A boolean to specify whether all tags should be GPG signed.
11135         Use of this option when running in an automated script can
11136         result in a large number of tags being signed. It is therefore
11137         convenient to use an agent to avoid typing your gpg passphrase
11138         several times. Note that this option doesn&#8217;t affect tag signing
11139         behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.
11140 </p>
11141 </dd>
11142 <dt class="hdlist1">
11143 tar.umask
11144 </dt>
11145 <dd>
11146 <p>
11147         This variable can be used to restrict the permission bits of
11148         tar archive entries.  The default is 0002, which turns off the
11149         world write bit.  The special value "user" indicates that the
11150         archiving user&#8217;s umask will be used instead.  See umask(2) and
11151         <a href="git-archive.html">git-archive(1)</a>.
11152 </p>
11153 </dd>
11154 </dl></div>
11155 <div class="paragraph"><p>Trace2 config settings are only read from the system and global
11156 config files; repository local and worktree config files and <code>-c</code>
11157 command line arguments are not respected.</p></div>
11158 <div class="dlist"><dl>
11159 <dt class="hdlist1">
11160 trace2.normalTarget
11161 </dt>
11162 <dd>
11163 <p>
11164         This variable controls the normal target destination.
11165         It may be overridden by the <code>GIT_TRACE2</code> environment variable.
11166         The following table shows possible values.
11167 </p>
11168 </dd>
11169 <dt class="hdlist1">
11170 trace2.perfTarget
11171 </dt>
11172 <dd>
11173 <p>
11174         This variable controls the performance target destination.
11175         It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
11176         The following table shows possible values.
11177 </p>
11178 </dd>
11179 <dt class="hdlist1">
11180 trace2.eventTarget
11181 </dt>
11182 <dd>
11183 <p>
11184         This variable controls the event target destination.
11185         It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
11186         The following table shows possible values.
11187 </p>
11188 <div class="openblock">
11189 <div class="content">
11190 <div class="ulist"><ul>
11191 <li>
11192 <p>
11193 <code>0</code> or <code>false</code> - Disables the target.
11194 </p>
11195 </li>
11196 <li>
11197 <p>
11198 <code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.
11199 </p>
11200 </li>
11201 <li>
11202 <p>
11203 <code>[2-9]</code> - Writes to the already opened file descriptor.
11204 </p>
11205 </li>
11206 <li>
11207 <p>
11208 <code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
11209 already exists and is a directory, the traces will be written to files (one
11210 per process) underneath the given directory.
11211 </p>
11212 </li>
11213 <li>
11214 <p>
11215 <code>af_unix:[&lt;socket_type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
11216 Unix DomainSocket (on platforms that support them).  Socket
11217 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
11218 try both.
11219 </p>
11220 </li>
11221 </ul></div>
11222 </div></div>
11223 </dd>
11224 <dt class="hdlist1">
11225 trace2.normalBrief
11226 </dt>
11227 <dd>
11228 <p>
11229         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11230         omitted from normal output.  May be overridden by the
11231         <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.
11232 </p>
11233 </dd>
11234 <dt class="hdlist1">
11235 trace2.perfBrief
11236 </dt>
11237 <dd>
11238 <p>
11239         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11240         omitted from PERF output.  May be overridden by the
11241         <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.
11242 </p>
11243 </dd>
11244 <dt class="hdlist1">
11245 trace2.eventBrief
11246 </dt>
11247 <dd>
11248 <p>
11249         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11250         omitted from event output.  May be overridden by the
11251         <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.
11252 </p>
11253 </dd>
11254 <dt class="hdlist1">
11255 trace2.eventNesting
11256 </dt>
11257 <dd>
11258 <p>
11259         Integer.  Specifies desired depth of nested regions in the
11260         event output.  Regions deeper than this value will be
11261         omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
11262         environment variable.  Defaults to 2.
11263 </p>
11264 </dd>
11265 <dt class="hdlist1">
11266 trace2.configParams
11267 </dt>
11268 <dd>
11269 <p>
11270         A comma-separated list of patterns of "important" config
11271         settings that should be recorded in the trace2 output.
11272         For example, <code>core.*,remote.*.url</code> would cause the trace2
11273         output to contain events listing each configured remote.
11274         May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
11275         variable.  Unset by default.
11276 </p>
11277 </dd>
11278 <dt class="hdlist1">
11279 trace2.envVars
11280 </dt>
11281 <dd>
11282 <p>
11283         A comma-separated list of "important" environment variables that should
11284         be recorded in the trace2 output.  For example,
11285         <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
11286         contain events listing the overrides for HTTP user agent and the
11287         location of the Git configuration file (assuming any are set).  May be
11288         overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
11289         default.
11290 </p>
11291 </dd>
11292 <dt class="hdlist1">
11293 trace2.destinationDebug
11294 </dt>
11295 <dd>
11296 <p>
11297         Boolean.  When true Git will print error messages when a
11298         trace target destination cannot be opened for writing.
11299         By default, these errors are suppressed and tracing is
11300         silently disabled.  May be overridden by the
11301         <code>GIT_TRACE2_DST_DEBUG</code> environment variable.
11302 </p>
11303 </dd>
11304 <dt class="hdlist1">
11305 trace2.maxFiles
11306 </dt>
11307 <dd>
11308 <p>
11309         Integer.  When writing trace files to a target directory, do not
11310         write additional traces if doing so would exceed this many files. Instead,
11311         write a sentinel file that will block further tracing to this
11312         directory. Defaults to 0, which disables this check.
11313 </p>
11314 </dd>
11315 <dt class="hdlist1">
11316 transfer.credentialsInUrl
11317 </dt>
11318 <dd>
11319 <p>
11320         A configured URL can contain plaintext credentials in the form
11321         <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
11322         to warn or forbid the use of such configuration (in favor of
11323         using <a href="git-credential.html">git-credential(1)</a>). This will be used on
11324         <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>,
11325         and any other direct use of the configured URL.
11326 </p>
11327 <div class="paragraph"><p>Note that this is currently limited to detecting credentials in
11328 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
11329 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p></div>
11330 <div class="paragraph"><p>You might want to enable this to prevent inadvertent credentials
11331 exposure, e.g. because:</p></div>
11332 <div class="ulist"><ul>
11333 <li>
11334 <p>
11335 The OS or system where you&#8217;re running git may not provide a way or
11336   otherwise allow you to configure the permissions of the
11337   configuration file where the username and/or password are stored.
11338 </p>
11339 </li>
11340 <li>
11341 <p>
11342 Even if it does, having such data stored "at rest" might expose you
11343   in other ways, e.g. a backup process might copy the data to another
11344   system.
11345 </p>
11346 </li>
11347 <li>
11348 <p>
11349 The git programs will pass the full URL to one another as arguments
11350   on the command-line, meaning the credentials will be exposed to other
11351   unprivileged users on systems that allow them to see the full
11352   process list of other users. On linux the "hidepid" setting
11353   documented in procfs(5) allows for configuring this behavior.
11354 </p>
11355 <div class="paragraph"><p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
11356 concerned about credentials exposure due to storing sensitive
11357 data in git&#8217;s configuration files. If you do want to use this, set
11358 <code>transfer.credentialsInUrl</code> to one of these values:</p></div>
11359 </li>
11360 <li>
11361 <p>
11362 <code>allow</code> (default): Git will proceed with its activity without warning.
11363 </p>
11364 </li>
11365 <li>
11366 <p>
11367 <code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
11368   with a plaintext credential.
11369 </p>
11370 </li>
11371 <li>
11372 <p>
11373 <code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
11374   with a plaintext credential.
11375 </p>
11376 </li>
11377 </ul></div>
11378 </dd>
11379 <dt class="hdlist1">
11380 transfer.fsckObjects
11381 </dt>
11382 <dd>
11383 <p>
11384         When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
11385         not set, the value of this variable is used instead.
11386         Defaults to false.
11387 </p>
11388 <div class="paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
11389 object or a link to a nonexistent object. In addition, various other
11390 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
11391 and potential security issues like the existence of a <code>.GIT</code> directory
11392 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
11393 and v2.17.1 for details). Other sanity and security checks may be
11394 added in future releases.</p></div>
11395 <div class="paragraph"><p>On the receiving side, failing fsckObjects will make those objects
11396 unreachable, see "QUARANTINE ENVIRONMENT" in
11397 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
11398 instead be left unreferenced in the repository.</p></div>
11399 <div class="paragraph"><p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
11400 implementation it cannot be relied upon to leave the object store
11401 clean like <code>receive.fsckObjects</code> can.</p></div>
11402 <div class="paragraph"><p>As objects are unpacked they&#8217;re written to the object store, so there
11403 can be cases where malicious objects get introduced even though the
11404 "fetch" failed, only to have a subsequent "fetch" succeed because only
11405 new incoming objects are checked, not those that have already been
11406 written to the object store. That difference in behavior should not be
11407 relied upon. In the future, such objects may be quarantined for
11408 "fetch" as well.</p></div>
11409 <div class="paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
11410 environment if they&#8217;d like the same protection as "push". E.g. in the
11411 case of an internal mirror do the mirroring in two steps, one to fetch
11412 the untrusted objects, and then do a second "push" (which will use the
11413 quarantine) to another internal repo, and have internal clients
11414 consume this pushed-to repository, or embargo internal fetches and
11415 only allow them once a full "fsck" has run (and no new fetches have
11416 happened in the meantime).</p></div>
11417 </dd>
11418 <dt class="hdlist1">
11419 transfer.hideRefs
11420 </dt>
11421 <dd>
11422 <p>
11423         String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
11424         refs to omit from their initial advertisements.  Use more than
11425         one definition to specify multiple prefix strings. A ref that is
11426         under the hierarchies listed in the value of this variable is
11427         excluded, and is hidden when responding to <code>git push</code> or <code>git
11428         fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
11429         program-specific versions of this config.
11430 </p>
11431 <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
11432 explicitly exposing it, even if an earlier entry marked it as hidden.
11433 If you have multiple hideRefs values, later entries override earlier ones
11434 (and entries in more-specific config files override less-specific ones).</p></div>
11435 <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
11436 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
11437 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
11438 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
11439 <div class="paragraph"><p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
11440 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
11441 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
11442 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
11443 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
11444 <code>receive-pack</code>, on the other hand, will still advertise the object id the
11445 ref is pointing to without mentioning its name (a so-called ".have" line).</p></div>
11446 <div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
11447 objects via the techniques described in the "SECURITY" section of the
11448 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
11449 separate repository.</p></div>
11450 </dd>
11451 <dt class="hdlist1">
11452 transfer.unpackLimit
11453 </dt>
11454 <dd>
11455 <p>
11456         When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
11457         not set, the value of this variable is used instead.
11458         The default value is 100.
11459 </p>
11460 </dd>
11461 <dt class="hdlist1">
11462 transfer.advertiseSID
11463 </dt>
11464 <dd>
11465 <p>
11466         Boolean. When true, client and server processes will advertise their
11467         unique session IDs to their remote counterpart. Defaults to false.
11468 </p>
11469 </dd>
11470 <dt class="hdlist1">
11471 transfer.bundleURI
11472 </dt>
11473 <dd>
11474 <p>
11475         When <code>true</code>, local <code>git clone</code> commands will request bundle
11476         information from the remote server (if advertised) and download
11477         bundles before continuing the clone through the Git protocol.
11478         Defaults to <code>false</code>.
11479 </p>
11480 </dd>
11481 <dt class="hdlist1">
11482 uploadarchive.allowUnreachable
11483 </dt>
11484 <dd>
11485 <p>
11486         If true, allow clients to use <code>git archive --remote</code> to request
11487         any tree, whether reachable from the ref tips or not. See the
11488         discussion in the "SECURITY" section of
11489         <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
11490         <code>false</code>.
11491 </p>
11492 </dd>
11493 <dt class="hdlist1">
11494 uploadpack.hideRefs
11495 </dt>
11496 <dd>
11497 <p>
11498         This variable is the same as <code>transfer.hideRefs</code>, but applies
11499         only to <code>upload-pack</code> (and so affects only fetches, not pushes).
11500         An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
11501         also <code>uploadpack.allowTipSHA1InWant</code>.
11502 </p>
11503 </dd>
11504 <dt class="hdlist1">
11505 uploadpack.allowTipSHA1InWant
11506 </dt>
11507 <dd>
11508 <p>
11509         When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
11510         to accept a fetch request that asks for an object at the tip
11511         of a hidden ref (by default, such a request is rejected).
11512         See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
11513         may be able to steal objects via the techniques described in the
11514         "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
11515         best to keep private data in a separate repository.
11516 </p>
11517 </dd>
11518 <dt class="hdlist1">
11519 uploadpack.allowReachableSHA1InWant
11520 </dt>
11521 <dd>
11522 <p>
11523         Allow <code>upload-pack</code> to accept a fetch request that asks for an
11524         object that is reachable from any ref tip. However, note that
11525         calculating object reachability is computationally expensive.
11526         Defaults to <code>false</code>.  Even if this is false, a client may be able
11527         to steal objects via the techniques described in the "SECURITY"
11528         section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
11529         keep private data in a separate repository.
11530 </p>
11531 </dd>
11532 <dt class="hdlist1">
11533 uploadpack.allowAnySHA1InWant
11534 </dt>
11535 <dd>
11536 <p>
11537         Allow <code>upload-pack</code> to accept a fetch request that asks for any
11538         object at all.
11539         Defaults to <code>false</code>.
11540 </p>
11541 </dd>
11542 <dt class="hdlist1">
11543 uploadpack.keepAlive
11544 </dt>
11545 <dd>
11546 <p>
11547         When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
11548         quiet period while <code>pack-objects</code> prepares the pack. Normally
11549         it would output progress information, but if <code>--quiet</code> was used
11550         for the fetch, <code>pack-objects</code> will output nothing at all until
11551         the pack data begins. Some clients and networks may consider
11552         the server to be hung and give up. Setting this option instructs
11553         <code>upload-pack</code> to send an empty keepalive packet every
11554         <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
11555         disables keepalive packets entirely. The default is 5 seconds.
11556 </p>
11557 </dd>
11558 <dt class="hdlist1">
11559 uploadpack.packObjectsHook
11560 </dt>
11561 <dd>
11562 <p>
11563         If this option is set, when <code>upload-pack</code> would run
11564         <code>git pack-objects</code> to create a packfile for a client, it will
11565         run this shell command instead.  The <code>pack-objects</code> command and
11566         arguments it <em>would</em> have run (including the <code>git pack-objects</code>
11567         at the beginning) are appended to the shell command. The stdin
11568         and stdout of the hook are treated as if <code>pack-objects</code> itself
11569         was run. I.e., <code>upload-pack</code> will feed input intended for
11570         <code>pack-objects</code> to the hook, and expects a completed packfile on
11571         stdout.
11572 </p>
11573 <div class="paragraph"><p>Note that this configuration variable is only respected when it is specified
11574 in protected configuration (see <a href="#SCOPES">[SCOPES]</a>). This is a safety measure
11575 against fetching from untrusted repositories.</p></div>
11576 </dd>
11577 <dt class="hdlist1">
11578 uploadpack.allowFilter
11579 </dt>
11580 <dd>
11581 <p>
11582         If this option is set, <code>upload-pack</code> will support partial
11583         clone and partial fetch object filtering.
11584 </p>
11585 </dd>
11586 <dt class="hdlist1">
11587 uploadpackfilter.allow
11588 </dt>
11589 <dd>
11590 <p>
11591         Provides a default value for unspecified object filters (see: the
11592         below configuration variable). If set to <code>true</code>, this will also
11593         enable all filters which get added in the future.
11594         Defaults to <code>true</code>.
11595 </p>
11596 </dd>
11597 <dt class="hdlist1">
11598 uploadpackfilter.&lt;filter&gt;.allow
11599 </dt>
11600 <dd>
11601 <p>
11602         Explicitly allow or ban the object filter corresponding to
11603         <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
11604         <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
11605         If using combined filters, both <code>combine</code> and all of the nested
11606         filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.
11607 </p>
11608 </dd>
11609 <dt class="hdlist1">
11610 uploadpackfilter.tree.maxDepth
11611 </dt>
11612 <dd>
11613 <p>
11614         Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
11615         <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
11616         <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
11617         variable had already been set. Has no effect if unset.
11618 </p>
11619 </dd>
11620 <dt class="hdlist1">
11621 uploadpack.allowRefInWant
11622 </dt>
11623 <dd>
11624 <p>
11625         If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
11626         feature of the protocol version 2 <code>fetch</code> command.  This feature
11627         is intended for the benefit of load-balanced servers which may
11628         not have the same view of what OIDs their refs point to due to
11629         replication delay.
11630 </p>
11631 </dd>
11632 <dt class="hdlist1">
11633 url.&lt;base&gt;.insteadOf
11634 </dt>
11635 <dd>
11636 <p>
11637         Any URL that starts with this value will be rewritten to
11638         start, instead, with &lt;base&gt;. In cases where some site serves a
11639         large number of repositories, and serves them with multiple
11640         access methods, and some users need to use different access
11641         methods, this feature allows people to specify any of the
11642         equivalent URLs and have Git automatically rewrite the URL to
11643         the best alternative for the particular user, even for a
11644         never-before-seen repository on the site.  When more than one
11645         insteadOf strings match a given URL, the longest match is used.
11646 </p>
11647 <div class="paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
11648 URL. If the rewrite changes the URL to use a custom protocol or remote
11649 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
11650 the request.  In particular, protocols you expect to use for submodules
11651 must be set to <code>always</code> rather than the default of <code>user</code>. See the
11652 description of <code>protocol.allow</code> above.</p></div>
11653 </dd>
11654 <dt class="hdlist1">
11655 url.&lt;base&gt;.pushInsteadOf
11656 </dt>
11657 <dd>
11658 <p>
11659         Any URL that starts with this value will not be pushed to;
11660         instead, it will be rewritten to start with &lt;base&gt;, and the
11661         resulting URL will be pushed to. In cases where some site serves
11662         a large number of repositories, and serves them with multiple
11663         access methods, some of which do not allow push, this feature
11664         allows people to specify a pull-only URL and have Git
11665         automatically use an appropriate URL to push, even for a
11666         never-before-seen repository on the site.  When more than one
11667         pushInsteadOf strings match a given URL, the longest match is
11668         used.  If a remote has an explicit pushurl, Git will ignore this
11669         setting for that remote.
11670 </p>
11671 </dd>
11672 <dt class="hdlist1">
11673 user.name
11674 </dt>
11675 <dt class="hdlist1">
11676 user.email
11677 </dt>
11678 <dt class="hdlist1">
11679 author.name
11680 </dt>
11681 <dt class="hdlist1">
11682 author.email
11683 </dt>
11684 <dt class="hdlist1">
11685 committer.name
11686 </dt>
11687 <dt class="hdlist1">
11688 committer.email
11689 </dt>
11690 <dd>
11691 <p>
11692         The <code>user.name</code> and <code>user.email</code> variables determine what ends
11693         up in the <code>author</code> and <code>committer</code> fields of commit
11694         objects.
11695         If you need the <code>author</code> or <code>committer</code> to be different, the
11696         <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
11697         <code>committer.email</code> variables can be set.
11698         All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
11699         <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
11700         <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.
11701 </p>
11702 <div class="paragraph"><p>Note that the <code>name</code> forms of these variables conventionally refer to
11703 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
11704 environment variables section of <a href="git.html">git(1)</a> for more information on
11705 these settings and the <code>credential.username</code> option if you&#8217;re looking
11706 for authentication credentials instead.</p></div>
11707 </dd>
11708 <dt class="hdlist1">
11709 user.useConfigOnly
11710 </dt>
11711 <dd>
11712 <p>
11713         Instruct Git to avoid trying to guess defaults for <code>user.email</code>
11714         and <code>user.name</code>, and instead retrieve the values only from the
11715         configuration. For example, if you have multiple email addresses
11716         and would like to use a different one for each repository, then
11717         with this configuration option set to <code>true</code> in the global config
11718         along with a name, Git will prompt you to set up an email before
11719         making new commits in a newly cloned repository.
11720         Defaults to <code>false</code>.
11721 </p>
11722 </dd>
11723 <dt class="hdlist1">
11724 user.signingKey
11725 </dt>
11726 <dd>
11727 <p>
11728         If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
11729         key you want it to automatically when creating a signed tag or
11730         commit, you can override the default selection with this variable.
11731         This option is passed unchanged to gpg&#8217;s --local-user parameter,
11732         so you may specify a key using any method that gpg supports.
11733         If gpg.format is set to <code>ssh</code> this can contain the path to either
11734         your private ssh key or the public key when ssh-agent is used.
11735         Alternatively it can contain a public key prefixed with <code>key::</code>
11736         directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
11737         needs to be available via ssh-agent. If not set Git will call
11738         gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
11739         first key available. For backward compatibility, a raw key which
11740         begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
11741         as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
11742         use the <code>key::</code> form instead.
11743 </p>
11744 </dd>
11745 <dt class="hdlist1">
11746 versionsort.prereleaseSuffix (deprecated)
11747 </dt>
11748 <dd>
11749 <p>
11750         Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
11751         <code>versionsort.suffix</code> is set.
11752 </p>
11753 </dd>
11754 <dt class="hdlist1">
11755 versionsort.suffix
11756 </dt>
11757 <dd>
11758 <p>
11759         Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
11760         with the same base version but different suffixes are still sorted
11761         lexicographically, resulting e.g. in prerelease tags appearing
11762         after the main release (e.g. "1.0-rc1" after "1.0").  This
11763         variable can be specified to determine the sorting order of tags
11764         with different suffixes.
11765 </p>
11766 <div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
11767 that suffix will appear before the corresponding main release.  E.g. if
11768 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
11769 "1.0".  If specified multiple times, once per suffix, then the order of
11770 suffixes in the configuration will determine the sorting order of tagnames
11771 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
11772 configuration, then all "1.0-preX" tags will be listed before any
11773 "1.0-rcX" tags.  The placement of the main release tag relative to tags
11774 with various suffixes can be determined by specifying the empty suffix
11775 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
11776 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
11777 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
11778 "v4.8-bfsX".</p></div>
11779 <div class="paragraph"><p>If more than one suffix matches the same tagname, then that tagname will
11780 be sorted according to the suffix which starts at the earliest position in
11781 the tagname.  If more than one different matching suffix starts at
11782 that earliest position, then that tagname will be sorted according to the
11783 longest of those suffixes.
11784 The sorting order between different suffixes is undefined if they are
11785 in multiple config files.</p></div>
11786 </dd>
11787 <dt class="hdlist1">
11788 web.browser
11789 </dt>
11790 <dd>
11791 <p>
11792         Specify a web browser that may be used by some commands.
11793         Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
11794         may use it.
11795 </p>
11796 </dd>
11797 <dt class="hdlist1">
11798 worktree.guessRemote
11799 </dt>
11800 <dd>
11801 <p>
11802         If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
11803         <code>--detach</code> is used, then <code>git worktree add</code> defaults to
11804         creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
11805         set to true, <code>worktree add</code> tries to find a remote-tracking
11806         branch whose name uniquely matches the new branch name.  If
11807         such a branch exists, it is checked out and set as "upstream"
11808         for the new branch.  If no such match can be found, it falls
11809         back to creating a new branch from the current HEAD.
11810 </p>
11811 </dd>
11812 </dl></div>
11813 </div>
11814 </div>
11815 </div>
11816 <div class="sect1">
11817 <h2 id="_bugs">BUGS</h2>
11818 <div class="sectionbody">
11819 <div class="paragraph"><p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
11820 will result in adding a multi-line key instead of a change, if the subsection
11821 is given with at least one uppercase character. For example when the config
11822 looks like</p></div>
11823 <div class="listingblock">
11824 <div class="content">
11825 <pre><code>  [section.subsection]
11826     key = value1</code></pre>
11827 </div></div>
11828 <div class="paragraph"><p>and running <code>git config section.Subsection.key value2</code> will result in</p></div>
11829 <div class="listingblock">
11830 <div class="content">
11831 <pre><code>  [section.subsection]
11832     key = value1
11833     key = value2</code></pre>
11834 </div></div>
11835 </div>
11836 </div>
11837 <div class="sect1">
11838 <h2 id="_git">GIT</h2>
11839 <div class="sectionbody">
11840 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
11841 </div>
11842 </div>
11843 </div>
11844 <div id="footnotes"><hr /></div>
11845 <div id="footer">
11846 <div id="footer-text">
11847 Last updated
11848  2023-09-23 09:04:28 JST
11849 </div>
11850 </div>
11851 </body>
11852 </html>