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 addEmbeddedRepo
1995 </dt>
1996 <dd>
1997 <p>
1998                 Advice on what to do when you&#8217;ve accidentally added one
1999                 git repo inside of another.
2000 </p>
2001 </dd>
2002 <dt class="hdlist1">
2003 addEmptyPathspec
2004 </dt>
2005 <dd>
2006 <p>
2007                 Advice shown if a user runs the add command without providing
2008                 the pathspec parameter.
2009 </p>
2010 </dd>
2011 <dt class="hdlist1">
2012 addIgnoredFile
2013 </dt>
2014 <dd>
2015 <p>
2016                 Advice shown if a user attempts to add an ignored file to
2017                 the index.
2018 </p>
2019 </dd>
2020 <dt class="hdlist1">
2021 amWorkDir
2022 </dt>
2023 <dd>
2024 <p>
2025                 Advice that shows the location of the patch file when
2026                 <a href="git-am.html">git-am(1)</a> fails to apply it.
2027 </p>
2028 </dd>
2029 <dt class="hdlist1">
2030 ambiguousFetchRefspec
2031 </dt>
2032 <dd>
2033 <p>
2034                 Advice shown when a fetch refspec for multiple remotes maps to
2035                 the same remote-tracking branch namespace and causes branch
2036                 tracking set-up to fail.
2037 </p>
2038 </dd>
2039 <dt class="hdlist1">
2040 checkoutAmbiguousRemoteBranchName
2041 </dt>
2042 <dd>
2043 <p>
2044                 Advice shown when the argument to
2045                 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
2046                 ambiguously resolves to a
2047                 remote tracking branch on more than one remote in
2048                 situations where an unambiguous argument would have
2049                 otherwise caused a remote-tracking branch to be
2050                 checked out. See the <code>checkout.defaultRemote</code>
2051                 configuration variable for how to set a given remote
2052                 to be used by default in some situations where this
2053                 advice would be printed.
2054 </p>
2055 </dd>
2056 <dt class="hdlist1">
2057 commitBeforeMerge
2058 </dt>
2059 <dd>
2060 <p>
2061                 Advice shown when <a href="git-merge.html">git-merge(1)</a> refuses to
2062                 merge to avoid overwriting local changes.
2063 </p>
2064 </dd>
2065 <dt class="hdlist1">
2066 detachedHead
2067 </dt>
2068 <dd>
2069 <p>
2070                 Advice shown when you used
2071                 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
2072                 to move to the detached HEAD state, to instruct how to
2073                 create a local branch after the fact.
2074 </p>
2075 </dd>
2076 <dt class="hdlist1">
2077 diverging
2078 </dt>
2079 <dd>
2080 <p>
2081                 Advice shown when a fast-forward is not possible.
2082 </p>
2083 </dd>
2084 <dt class="hdlist1">
2085 fetchShowForcedUpdates
2086 </dt>
2087 <dd>
2088 <p>
2089                 Advice shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
2090                 to calculate forced updates after ref updates, or to warn
2091                 that the check is disabled.
2092 </p>
2093 </dd>
2094 <dt class="hdlist1">
2095 forceDeleteBranch
2096 </dt>
2097 <dd>
2098 <p>
2099                 Advice shown when a user tries to delete a not fully merged
2100                 branch without the force option set.
2101 </p>
2102 </dd>
2103 <dt class="hdlist1">
2104 ignoredHook
2105 </dt>
2106 <dd>
2107 <p>
2108                 Advice shown if a hook is ignored because the hook is not
2109                 set as executable.
2110 </p>
2111 </dd>
2112 <dt class="hdlist1">
2113 implicitIdentity
2114 </dt>
2115 <dd>
2116 <p>
2117                 Advice on how to set your identity configuration when
2118                 your information is guessed from the system username and
2119                 domain name.
2120 </p>
2121 </dd>
2122 <dt class="hdlist1">
2123 nestedTag
2124 </dt>
2125 <dd>
2126 <p>
2127                 Advice shown if a user attempts to recursively tag a tag object.
2128 </p>
2129 </dd>
2130 <dt class="hdlist1">
2131 pushAlreadyExists
2132 </dt>
2133 <dd>
2134 <p>
2135                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2136                 does not qualify for fast-forwarding (e.g., a tag.)
2137 </p>
2138 </dd>
2139 <dt class="hdlist1">
2140 pushFetchFirst
2141 </dt>
2142 <dd>
2143 <p>
2144                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2145                 tries to overwrite a remote ref that points at an
2146                 object we do not have.
2147 </p>
2148 </dd>
2149 <dt class="hdlist1">
2150 pushNeedsForce
2151 </dt>
2152 <dd>
2153 <p>
2154                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2155                 tries to overwrite a remote ref that points at an
2156                 object that is not a commit-ish, or make the remote
2157                 ref point at an object that is not a commit-ish.
2158 </p>
2159 </dd>
2160 <dt class="hdlist1">
2161 pushNonFFCurrent
2162 </dt>
2163 <dd>
2164 <p>
2165                 Advice shown when <a href="git-push.html">git-push(1)</a> fails due to a
2166                 non-fast-forward update to the current branch.
2167 </p>
2168 </dd>
2169 <dt class="hdlist1">
2170 pushNonFFMatching
2171 </dt>
2172 <dd>
2173 <p>
2174                 Advice shown when you ran <a href="git-push.html">git-push(1)</a> and pushed
2175                 <em>matching refs</em> explicitly (i.e. you used <em>:</em>, or
2176                 specified a refspec that isn&#8217;t your current branch) and
2177                 it resulted in a non-fast-forward error.
2178 </p>
2179 </dd>
2180 <dt class="hdlist1">
2181 pushRefNeedsUpdate
2182 </dt>
2183 <dd>
2184 <p>
2185                 Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
2186                 a branch when its remote-tracking ref has updates that we
2187                 do not have locally.
2188 </p>
2189 </dd>
2190 <dt class="hdlist1">
2191 pushUnqualifiedRefname
2192 </dt>
2193 <dd>
2194 <p>
2195                 Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
2196                 guess based on the source and destination refs what
2197                 remote ref namespace the source belongs in, but where
2198                 we can still suggest that the user push to either
2199                 refs/heads/* or refs/tags/* based on the type of the
2200                 source object.
2201 </p>
2202 </dd>
2203 <dt class="hdlist1">
2204 pushUpdateRejected
2205 </dt>
2206 <dd>
2207 <p>
2208                 Set this variable to <em>false</em> if you want to disable
2209                 <em>pushNonFFCurrent</em>, <em>pushNonFFMatching</em>, <em>pushAlreadyExists</em>,
2210                 <em>pushFetchFirst</em>, <em>pushNeedsForce</em>, and <em>pushRefNeedsUpdate</em>
2211                 simultaneously.
2212 </p>
2213 </dd>
2214 <dt class="hdlist1">
2215 resetNoRefresh
2216 </dt>
2217 <dd>
2218 <p>
2219                 Advice to consider using the <code>--no-refresh</code> option to
2220                 <a href="git-reset.html">git-reset(1)</a> when the command takes more than 2 seconds
2221                 to refresh the index after reset.
2222 </p>
2223 </dd>
2224 <dt class="hdlist1">
2225 resolveConflict
2226 </dt>
2227 <dd>
2228 <p>
2229                 Advice shown by various commands when conflicts
2230                 prevent the operation from being performed.
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 sequencerInUse
2244 </dt>
2245 <dd>
2246 <p>
2247                 Advice shown when a sequencer command is already in progress.
2248 </p>
2249 </dd>
2250 <dt class="hdlist1">
2251 skippedCherryPicks
2252 </dt>
2253 <dd>
2254 <p>
2255                 Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
2256                 been cherry-picked onto the upstream branch.
2257 </p>
2258 </dd>
2259 <dt class="hdlist1">
2260 statusAheadBehind
2261 </dt>
2262 <dd>
2263 <p>
2264                 Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
2265                 counts for a local ref compared to its remote tracking ref,
2266                 and that calculation takes longer than expected. Will not
2267                 appear if <code>status.aheadBehind</code> is false or the option
2268                 <code>--no-ahead-behind</code> is given.
2269 </p>
2270 </dd>
2271 <dt class="hdlist1">
2272 statusHints
2273 </dt>
2274 <dd>
2275 <p>
2276                 Show directions on how to proceed from the current
2277                 state in the output of <a href="git-status.html">git-status(1)</a>, in
2278                 the template shown when writing commit messages in
2279                 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
2280                 by <a href="git-switch.html">git-switch(1)</a> or
2281                 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.
2282 </p>
2283 </dd>
2284 <dt class="hdlist1">
2285 statusUoption
2286 </dt>
2287 <dd>
2288 <p>
2289                 Advise to consider using the <code>-u</code> option to <a href="git-status.html">git-status(1)</a>
2290                 when the command takes more than 2 seconds to enumerate untracked
2291                 files.
2292 </p>
2293 </dd>
2294 <dt class="hdlist1">
2295 submoduleAlternateErrorStrategyDie
2296 </dt>
2297 <dd>
2298 <p>
2299                 Advice shown when a submodule.alternateErrorStrategy option
2300                 configured to "die" causes a fatal error.
2301 </p>
2302 </dd>
2303 <dt class="hdlist1">
2304 submodulesNotUpdated
2305 </dt>
2306 <dd>
2307 <p>
2308                 Advice shown when a user runs a submodule command that fails
2309                 because <code>git submodule update --init</code> was not run.
2310 </p>
2311 </dd>
2312 <dt class="hdlist1">
2313 suggestDetachingHead
2314 </dt>
2315 <dd>
2316 <p>
2317                 Advice shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
2318                 without the explicit <code>--detach</code> option.
2319 </p>
2320 </dd>
2321 <dt class="hdlist1">
2322 updateSparsePath
2323 </dt>
2324 <dd>
2325 <p>
2326                 Advice shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
2327                 is asked to update index entries outside the current sparse
2328                 checkout.
2329 </p>
2330 </dd>
2331 <dt class="hdlist1">
2332 waitingForEditor
2333 </dt>
2334 <dd>
2335 <p>
2336                 Print a message to the terminal whenever Git is waiting for
2337                 editor input from the user.
2338 </p>
2339 </dd>
2340 <dt class="hdlist1">
2341 worktreeAddOrphan
2342 </dt>
2343 <dd>
2344 <p>
2345                 Advice shown when a user tries to create a worktree from an
2346                 invalid reference, to instruct how to create a new unborn
2347                 branch instead.
2348 </p>
2349 </dd>
2350 </dl></div>
2351 </div></div>
2352 </dd>
2353 <dt class="hdlist1">
2354 attr.tree
2355 </dt>
2356 <dd>
2357 <p>
2358         A reference to a tree in the repository from which to read attributes,
2359         instead of the <code>.gitattributes</code> file in the working tree. In a bare
2360         repository, this defaults to <code>HEAD:.gitattributes</code>. If the value does
2361         not resolve to a valid tree object, an empty tree is used instead.
2362         When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2363         command line option are used, this configuration variable has no effect.
2364 </p>
2365 </dd>
2366 <dt class="hdlist1">
2367 core.fileMode
2368 </dt>
2369 <dd>
2370 <p>
2371         Tells Git if the executable bit of files in the working tree
2372         is to be honored.
2373 </p>
2374 <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
2375 marked as executable is checked out, or checks out a
2376 non-executable file with executable bit on.
2377 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
2378 to see if it handles the executable bit correctly
2379 and this variable is automatically set as necessary.</p></div>
2380 <div class="paragraph"><p>A repository, however, may be on a filesystem that handles
2381 the filemode correctly, and this variable is set to <em>true</em>
2382 when created, but later may be made accessible from another
2383 environment that loses the filemode (e.g. exporting ext4 via
2384 CIFS mount, visiting a Cygwin created repository with
2385 Git for Windows or Eclipse).
2386 In such a case it may be necessary to set this variable to <em>false</em>.
2387 See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
2388 <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
2389 </dd>
2390 <dt class="hdlist1">
2391 core.hideDotFiles
2392 </dt>
2393 <dd>
2394 <p>
2395         (Windows-only) If true, mark newly-created directories and files whose
2396         name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
2397         directory is hidden, but no other files starting with a dot.  The
2398         default mode is <em>dotGitOnly</em>.
2399 </p>
2400 </dd>
2401 <dt class="hdlist1">
2402 core.ignoreCase
2403 </dt>
2404 <dd>
2405 <p>
2406         Internal variable which enables various workarounds to enable
2407         Git to work better on filesystems that are not case sensitive,
2408         like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
2409         finds "makefile" when Git expects "Makefile", Git will assume
2410         it is really the same file, and continue to remember it as
2411         "Makefile".
2412 </p>
2413 <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>
2414 will probe and set core.ignoreCase true if appropriate when the repository
2415 is created.</p></div>
2416 <div class="paragraph"><p>Git relies on the proper configuration of this variable for your operating
2417 and file system. Modifying this value may result in unexpected behavior.</p></div>
2418 </dd>
2419 <dt class="hdlist1">
2420 core.precomposeUnicode
2421 </dt>
2422 <dd>
2423 <p>
2424         This option is only used by Mac OS implementation of Git.
2425         When core.precomposeUnicode=true, Git reverts the unicode decomposition
2426         of filenames done by Mac OS. This is useful when sharing a repository
2427         between Mac OS and Linux or Windows.
2428         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
2429         When false, file names are handled fully transparent by Git,
2430         which is backward compatible with older versions of Git.
2431 </p>
2432 </dd>
2433 <dt class="hdlist1">
2434 core.protectHFS
2435 </dt>
2436 <dd>
2437 <p>
2438         If set to true, do not allow checkout of paths that would
2439         be considered equivalent to <code>.git</code> on an HFS+ filesystem.
2440         Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
2441 </p>
2442 </dd>
2443 <dt class="hdlist1">
2444 core.protectNTFS
2445 </dt>
2446 <dd>
2447 <p>
2448         If set to true, do not allow checkout of paths that would
2449         cause problems with the NTFS filesystem, e.g. conflict with
2450         8.3 "short" names.
2451         Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
2452 </p>
2453 </dd>
2454 <dt class="hdlist1">
2455 core.fsmonitor
2456 </dt>
2457 <dd>
2458 <p>
2459         If set to true, enable the built-in file system monitor
2460         daemon for this working directory (<a href="git-fsmonitor&#45;&#45;daemon.html">git-fsmonitor&#45;&#45;daemon(1)</a>).
2461 </p>
2462 <div class="paragraph"><p>Like hook-based file system monitors, the built-in file system monitor
2463 can speed up Git commands that need to refresh the Git index
2464 (e.g. <code>git status</code>) in a working directory with many files.  The
2465 built-in monitor eliminates the need to install and maintain an
2466 external third-party tool.</p></div>
2467 <div class="paragraph"><p>The built-in file system monitor is currently available only on a
2468 limited set of supported platforms.  Currently, this includes Windows
2469 and MacOS.</p></div>
2470 <div class="literalblock">
2471 <div class="content">
2472 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor"
2473 hook command.</code></pre>
2474 </div></div>
2475 <div class="paragraph"><p>This hook command is used to identify all files that may have changed
2476 since the requested date/time. This information is used to speed up
2477 git by avoiding unnecessary scanning of files that have not changed.</p></div>
2478 <div class="paragraph"><p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p></div>
2479 <div class="paragraph"><p>Note that if you concurrently use multiple versions of Git, such
2480 as one version on the command line and another version in an IDE
2481 tool, that the definition of <code>core.fsmonitor</code> was extended to
2482 allow boolean values in addition to hook pathnames.  Git versions
2483 2.35.1 and prior will not understand the boolean values and will
2484 consider the "true" or "false" values as hook pathnames to be
2485 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
2486 V2 and will fall back to no fsmonitor (full scan).  Git versions
2487 prior to 2.26 default to hook protocol V1 and will silently
2488 assume there were no changes to report (no scan), so status
2489 commands may report incomplete results.  For this reason, it is
2490 best to upgrade all of your Git versions before using the built-in
2491 file system monitor.</p></div>
2492 </dd>
2493 <dt class="hdlist1">
2494 core.fsmonitorHookVersion
2495 </dt>
2496 <dd>
2497 <p>
2498         Sets the protocol version to be used when invoking the
2499         "fsmonitor" hook.
2500 </p>
2501 <div class="paragraph"><p>There are currently versions 1 and 2. When this is not set,
2502 version 2 will be tried first and if it fails then version 1
2503 will be tried. Version 1 uses a timestamp as input to determine
2504 which files have changes since that time but some monitors
2505 like Watchman have race conditions when used with a timestamp.
2506 Version 2 uses an opaque string so that the monitor can return
2507 something that can be used to determine what files have changed
2508 without race conditions.</p></div>
2509 </dd>
2510 <dt class="hdlist1">
2511 core.trustctime
2512 </dt>
2513 <dd>
2514 <p>
2515         If false, the ctime differences between the index and the
2516         working tree are ignored; useful when the inode change time
2517         is regularly modified by something outside Git (file system
2518         crawlers and some backup systems).
2519         See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
2520 </p>
2521 </dd>
2522 <dt class="hdlist1">
2523 core.splitIndex
2524 </dt>
2525 <dd>
2526 <p>
2527         If true, the split-index feature of the index will be used.
2528         See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
2529 </p>
2530 </dd>
2531 <dt class="hdlist1">
2532 core.untrackedCache
2533 </dt>
2534 <dd>
2535 <p>
2536         Determines what to do about the untracked cache feature of the
2537         index. It will be kept, if this variable is unset or set to
2538         <code>keep</code>. It will automatically be added if set to <code>true</code>. And
2539         it will automatically be removed, if set to <code>false</code>. Before
2540         setting it to <code>true</code>, you should check that mtime is working
2541         properly on your system.
2542         See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
2543         <code>feature.manyFiles</code> is enabled which sets this setting to
2544         <code>true</code> by default.
2545 </p>
2546 </dd>
2547 <dt class="hdlist1">
2548 core.checkStat
2549 </dt>
2550 <dd>
2551 <p>
2552         When missing or is set to <code>default</code>, many fields in the stat
2553         structure are checked to detect if a file has been modified
2554         since Git looked at it.  When this configuration variable is
2555         set to <code>minimal</code>, sub-second part of mtime and ctime, the
2556         uid and gid of the owner of the file, the inode number (and
2557         the device number, if Git was compiled to use it), are
2558         excluded from the check among these fields, leaving only the
2559         whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
2560         is set) and the filesize to be checked.
2561 </p>
2562 <div class="paragraph"><p>There are implementations of Git that do not leave usable values in
2563 some fields (e.g. JGit); by excluding these fields from the
2564 comparison, the <code>minimal</code> mode may help interoperability when the
2565 same repository is used by these other systems at the same time.</p></div>
2566 </dd>
2567 <dt class="hdlist1">
2568 core.quotePath
2569 </dt>
2570 <dd>
2571 <p>
2572         Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
2573         quote "unusual" characters in the pathname by enclosing the
2574         pathname in double-quotes and escaping those characters with
2575         backslashes in the same way C escapes control characters (e.g.
2576         <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
2577         values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
2578         UTF-8).  If this variable is set to false, bytes higher than
2579         0x80 are not considered "unusual" any more. Double-quotes,
2580         backslash and control characters are always escaped regardless
2581         of the setting of this variable.  A simple space character is
2582         not considered "unusual".  Many commands can output pathnames
2583         completely verbatim using the <code>-z</code> option. The default value
2584         is true.
2585 </p>
2586 </dd>
2587 <dt class="hdlist1">
2588 core.eol
2589 </dt>
2590 <dd>
2591 <p>
2592         Sets the line ending type to use in the working directory for
2593         files that are marked as text (either by having the <code>text</code>
2594         attribute set, or by having <code>text=auto</code> and Git auto-detecting
2595         the contents as text).
2596         Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
2597         native line ending.  The default value is <code>native</code>.  See
2598         <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
2599         conversion. Note that this value is ignored if <code>core.autocrlf</code>
2600         is set to <code>true</code> or <code>input</code>.
2601 </p>
2602 </dd>
2603 <dt class="hdlist1">
2604 core.safecrlf
2605 </dt>
2606 <dd>
2607 <p>
2608         If true, makes Git check if converting <code>CRLF</code> is reversible when
2609         end-of-line conversion is active.  Git will verify if a command
2610         modifies a file in the work tree either directly or indirectly.
2611         For example, committing a file followed by checking out the
2612         same file should yield the original file in the work tree.  If
2613         this is not the case for the current setting of
2614         <code>core.autocrlf</code>, Git will reject the file.  The variable can
2615         be set to "warn", in which case Git will only warn about an
2616         irreversible conversion but continue the operation.
2617 </p>
2618 <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
2619 When it is enabled, Git will convert CRLF to LF during commit and LF to
2620 CRLF during checkout.  A file that contains a mixture of LF and
2621 CRLF before the commit cannot be recreated by Git.  For text
2622 files this is the right thing to do: it corrects line endings
2623 such that we have only LF line endings in the repository.
2624 But for binary files that are accidentally classified as text the
2625 conversion can corrupt data.</p></div>
2626 <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
2627 setting the conversion type explicitly in .gitattributes.  Right
2628 after committing you still have the original file in your work
2629 tree and this file is not yet corrupted.  You can explicitly tell
2630 Git that this file is binary and Git will handle the file
2631 appropriately.</p></div>
2632 <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
2633 mixed line endings and the undesired effect of corrupting binary
2634 files cannot be distinguished.  In both cases CRLFs are removed
2635 in an irreversible way.  For text files this is the right thing
2636 to do because CRLFs are line endings, while for binary files
2637 converting CRLFs corrupts data.</p></div>
2638 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
2639 file identical to the original file for a different setting of
2640 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
2641 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
2642 and could later be checked out with <code>core.eol=crlf</code>, in which case the
2643 resulting file would contain <code>CRLF</code>, although the original file
2644 contained <code>LF</code>.  However, in both work trees the line endings would be
2645 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
2646 file with mixed line endings would be reported by the <code>core.safecrlf</code>
2647 mechanism.</p></div>
2648 </dd>
2649 <dt class="hdlist1">
2650 core.autocrlf
2651 </dt>
2652 <dd>
2653 <p>
2654         Setting this variable to "true" is the same as setting
2655         the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
2656         Set to true if you want to have <code>CRLF</code> line endings in your
2657         working directory and the repository has LF line endings.
2658         This variable can be set to <em>input</em>,
2659         in which case no output conversion is performed.
2660 </p>
2661 </dd>
2662 <dt class="hdlist1">
2663 core.checkRoundtripEncoding
2664 </dt>
2665 <dd>
2666 <p>
2667         A comma and/or whitespace separated list of encodings that Git
2668         performs UTF-8 round trip checks on if they are used in an
2669         <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
2670         The default value is <code>SHIFT-JIS</code>.
2671 </p>
2672 </dd>
2673 <dt class="hdlist1">
2674 core.symlinks
2675 </dt>
2676 <dd>
2677 <p>
2678         If false, symbolic links are checked out as small plain files that
2679         contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
2680         <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
2681         file. Useful on filesystems like FAT that do not support
2682         symbolic links.
2683 </p>
2684 <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>
2685 will probe and set core.symlinks false if appropriate when the repository
2686 is created.</p></div>
2687 </dd>
2688 <dt class="hdlist1">
2689 core.gitProxy
2690 </dt>
2691 <dd>
2692 <p>
2693         A "proxy command" to execute (as <em>command host port</em>) instead
2694         of establishing direct connection to the remote server when
2695         using the Git protocol for fetching. If the variable value is
2696         in the "COMMAND for DOMAIN" format, the command is applied only
2697         on hostnames ending with the specified domain string. This variable
2698         may be set multiple times and is matched in the given order;
2699         the first match wins.
2700 </p>
2701 <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
2702 (which always applies universally, without the special "for"
2703 handling).</p></div>
2704 <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
2705 specify that no proxy be used for a given domain pattern.
2706 This is useful for excluding servers inside a firewall from
2707 proxy use, while defaulting to a common proxy for external domains.</p></div>
2708 </dd>
2709 <dt class="hdlist1">
2710 core.sshCommand
2711 </dt>
2712 <dd>
2713 <p>
2714         If this variable is set, <code>git fetch</code> and <code>git push</code> will
2715         use the specified command instead of <code>ssh</code> when they need to
2716         connect to a remote system. The command is in the same form as
2717         the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
2718         when the environment variable is set.
2719 </p>
2720 </dd>
2721 <dt class="hdlist1">
2722 core.ignoreStat
2723 </dt>
2724 <dd>
2725 <p>
2726         If true, Git will avoid using lstat() calls to detect if files have
2727         changed by setting the "assume-unchanged" bit for those tracked files
2728         which it has updated identically in both the index and working tree.
2729 </p>
2730 <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
2731 the modified files explicitly (e.g. see <em>Examples</em> section in
2732 <a href="git-update-index.html">git-update-index(1)</a>).
2733 Git will not normally detect changes to those files.</p></div>
2734 <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
2735 CIFS/Microsoft Windows.</p></div>
2736 <div class="paragraph"><p>False by default.</p></div>
2737 </dd>
2738 <dt class="hdlist1">
2739 core.preferSymlinkRefs
2740 </dt>
2741 <dd>
2742 <p>
2743         Instead of the default "symref" format for HEAD
2744         and other symbolic reference files, use symbolic links.
2745         This is sometimes needed to work with old scripts that
2746         expect HEAD to be a symbolic link.
2747 </p>
2748 </dd>
2749 <dt class="hdlist1">
2750 core.alternateRefsCommand
2751 </dt>
2752 <dd>
2753 <p>
2754         When advertising tips of available history from an alternate, use the shell to
2755         execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
2756         first argument is the absolute path of the alternate. Output must contain one
2757         hex object id per line (i.e., the same as produced by <code>git for-each-ref
2758         --format='%(objectname)'</code>).
2759 </p>
2760 <div class="paragraph"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
2761 value, as it does not take a repository path as an argument (but you can wrap
2762 the command above in a shell script).</p></div>
2763 </dd>
2764 <dt class="hdlist1">
2765 core.alternateRefsPrefixes
2766 </dt>
2767 <dd>
2768 <p>
2769         When listing references from an alternate, list only references that begin
2770         with the given prefix. Prefixes match as if they were given as arguments to
2771         <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
2772         whitespace. If <code>core.alternateRefsCommand</code> is set, setting
2773         <code>core.alternateRefsPrefixes</code> has no effect.
2774 </p>
2775 </dd>
2776 <dt class="hdlist1">
2777 core.bare
2778 </dt>
2779 <dd>
2780 <p>
2781         If true this repository is assumed to be <em>bare</em> and has no
2782         working directory associated with it.  If this is the case a
2783         number of commands that require a working directory will be
2784         disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
2785 </p>
2786 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
2787 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
2788 repository that ends in "/.git" is assumed to be not bare (bare =
2789 false), while all other repositories are assumed to be bare (bare
2790 = true).</p></div>
2791 </dd>
2792 <dt class="hdlist1">
2793 core.worktree
2794 </dt>
2795 <dd>
2796 <p>
2797         Set the path to the root of the working tree.
2798         If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
2799         is ignored and not used for determining the root of working tree.
2800         This can be overridden by the <code>GIT_WORK_TREE</code> environment
2801         variable and the <code>--work-tree</code> command-line option.
2802         The value can be an absolute path or relative to the path to
2803         the .git directory, which is either specified by --git-dir
2804         or GIT_DIR, or automatically discovered.
2805         If --git-dir or GIT_DIR is specified but none of
2806         --work-tree, GIT_WORK_TREE and core.worktree is specified,
2807         the current working directory is regarded as the top level
2808         of your working tree.
2809 </p>
2810 <div class="paragraph"><p>Note that this variable is honored even when set in a configuration
2811 file in a ".git" subdirectory of a directory and its value differs
2812 from the latter directory (e.g. "/path/to/.git/config" has
2813 core.worktree set to "/different/path"), which is most likely a
2814 misconfiguration.  Running Git commands in the "/path/to" directory will
2815 still use "/different/path" as the root of the work tree and can cause
2816 confusion unless you know what you are doing (e.g. you are creating a
2817 read-only snapshot of the same index to a location different from the
2818 repository&#8217;s usual working tree).</p></div>
2819 </dd>
2820 <dt class="hdlist1">
2821 core.logAllRefUpdates
2822 </dt>
2823 <dd>
2824 <p>
2825         Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
2826         "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
2827         SHA-1, the date/time and the reason of the update, but
2828         only when the file exists.  If this configuration
2829         variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
2830         file is automatically created for branch heads (i.e. under
2831         <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
2832         note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
2833         If it is set to <code>always</code>, then a missing reflog is automatically
2834         created for any ref under <code>refs/</code>.
2835 </p>
2836 <div class="paragraph"><p>This information can be used to determine what commit
2837 was the tip of a branch "2 days ago".</p></div>
2838 <div class="paragraph"><p>This value is true by default in a repository that has
2839 a working directory associated with it, and false by
2840 default in a bare repository.</p></div>
2841 </dd>
2842 <dt class="hdlist1">
2843 core.repositoryFormatVersion
2844 </dt>
2845 <dd>
2846 <p>
2847         Internal variable identifying the repository format and layout
2848         version.
2849 </p>
2850 </dd>
2851 <dt class="hdlist1">
2852 core.sharedRepository
2853 </dt>
2854 <dd>
2855 <p>
2856         When <em>group</em> (or <em>true</em>), the repository is made shareable between
2857         several users in a group (making sure all the files and objects are
2858         group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
2859         repository will be readable by all users, additionally to being
2860         group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
2861         reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
2862         files in the repository will have this mode value. <em>0xxx</em> will override
2863         user&#8217;s umask value (whereas the other options will only override
2864         requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
2865         the repo read/write-able for the owner and group, but inaccessible to
2866         others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
2867         repository that is group-readable but not group-writable.
2868         See <a href="git-init.html">git-init(1)</a>. False by default.
2869 </p>
2870 </dd>
2871 <dt class="hdlist1">
2872 core.warnAmbiguousRefs
2873 </dt>
2874 <dd>
2875 <p>
2876         If true, Git will warn you if the ref name you passed it is ambiguous
2877         and might match multiple refs in the repository. True by default.
2878 </p>
2879 </dd>
2880 <dt class="hdlist1">
2881 core.compression
2882 </dt>
2883 <dd>
2884 <p>
2885         An integer -1..9, indicating a default compression level.
2886         -1 is the zlib default. 0 means no compression,
2887         and 1..9 are various speed/size tradeoffs, 9 being slowest.
2888         If set, this provides a default to other compression variables,
2889         such as <code>core.looseCompression</code> and <code>pack.compression</code>.
2890 </p>
2891 </dd>
2892 <dt class="hdlist1">
2893 core.looseCompression
2894 </dt>
2895 <dd>
2896 <p>
2897         An integer -1..9, indicating the compression level for objects that
2898         are not in a pack file. -1 is the zlib default. 0 means no
2899         compression, and 1..9 are various speed/size tradeoffs, 9 being
2900         slowest.  If not set,  defaults to core.compression.  If that is
2901         not set,  defaults to 1 (best speed).
2902 </p>
2903 </dd>
2904 <dt class="hdlist1">
2905 core.packedGitWindowSize
2906 </dt>
2907 <dd>
2908 <p>
2909         Number of bytes of a pack file to map into memory in a
2910         single mapping operation.  Larger window sizes may allow
2911         your system to process a smaller number of large pack files
2912         more quickly.  Smaller window sizes will negatively affect
2913         performance due to increased calls to the operating system&#8217;s
2914         memory manager, but may improve performance when accessing
2915         a large number of large pack files.
2916 </p>
2917 <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
2918 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
2919 be reasonable for all users/operating systems.  You probably do
2920 not need to adjust this value.</p></div>
2921 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2922 </dd>
2923 <dt class="hdlist1">
2924 core.packedGitLimit
2925 </dt>
2926 <dd>
2927 <p>
2928         Maximum number of bytes to map simultaneously into memory
2929         from pack files.  If Git needs to access more than this many
2930         bytes at once to complete an operation it will unmap existing
2931         regions to reclaim virtual address space within the process.
2932 </p>
2933 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
2934 unlimited) on 64 bit platforms.
2935 This should be reasonable for all users/operating systems, except on
2936 the largest projects.  You probably do not need to adjust this value.</p></div>
2937 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2938 </dd>
2939 <dt class="hdlist1">
2940 core.deltaBaseCacheLimit
2941 </dt>
2942 <dd>
2943 <p>
2944         Maximum number of bytes per thread to reserve for caching base objects
2945         that may be referenced by multiple deltified objects.  By storing the
2946         entire decompressed base objects in a cache Git is able
2947         to avoid unpacking and decompressing frequently used base
2948         objects multiple times.
2949 </p>
2950 <div class="paragraph"><p>Default is 96 MiB on all platforms.  This should be reasonable
2951 for all users/operating systems, except on the largest projects.
2952 You probably do not need to adjust this value.</p></div>
2953 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2954 </dd>
2955 <dt class="hdlist1">
2956 core.bigFileThreshold
2957 </dt>
2958 <dd>
2959 <p>
2960         The size of files considered "big", which as discussed below
2961         changes the behavior of numerous git commands, as well as how
2962         such files are stored within the repository. The default is
2963         512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
2964         supported.
2965 </p>
2966 <div class="paragraph"><p>Files above the configured limit will be:</p></div>
2967 <div class="ulist"><ul>
2968 <li>
2969 <p>
2970 Stored deflated in packfiles, without attempting delta compression.
2971 </p>
2972 <div class="paragraph"><p>The default limit is primarily set with this use-case in mind. With it,
2973 most projects will have their source code and other text files delta
2974 compressed, but not larger binary media files.</p></div>
2975 <div class="paragraph"><p>Storing large files without delta compression avoids excessive memory
2976 usage, at the slight expense of increased disk usage.</p></div>
2977 </li>
2978 <li>
2979 <p>
2980 Will be treated as if they were labeled "binary" (see
2981   <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
2982   <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.
2983 </p>
2984 </li>
2985 <li>
2986 <p>
2987 Will generally be streamed when written, which avoids excessive
2988 memory usage, at the cost of some fixed overhead. Commands that make
2989 use of this include <a href="git-archive.html">git-archive(1)</a>,
2990 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
2991 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.
2992 </p>
2993 </li>
2994 </ul></div>
2995 </dd>
2996 <dt class="hdlist1">
2997 core.excludesFile
2998 </dt>
2999 <dd>
3000 <p>
3001         Specifies the pathname to the file that contains patterns to
3002         describe paths that are not meant to be tracked, in addition
3003         to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
3004         Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
3005         If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
3006         is used instead. See <a href="gitignore.html">gitignore(5)</a>.
3007 </p>
3008 </dd>
3009 <dt class="hdlist1">
3010 core.askPass
3011 </dt>
3012 <dd>
3013 <p>
3014         Some commands (e.g. svn and http interfaces) that interactively
3015         ask for a password can be told to use an external program given
3016         via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
3017         environment variable. If not set, fall back to the value of the
3018         <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
3019         prompt. The external program shall be given a suitable prompt as
3020         command-line argument and write the password on its STDOUT.
3021 </p>
3022 </dd>
3023 <dt class="hdlist1">
3024 core.attributesFile
3025 </dt>
3026 <dd>
3027 <p>
3028         In addition to <code>.gitattributes</code> (per-directory) and
3029         <code>.git/info/attributes</code>, Git looks into this file for attributes
3030         (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
3031         way as for <code>core.excludesFile</code>. Its default value is
3032         <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
3033         set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
3034 </p>
3035 </dd>
3036 <dt class="hdlist1">
3037 core.hooksPath
3038 </dt>
3039 <dd>
3040 <p>
3041         By default Git will look for your hooks in the
3042         <code>$GIT_DIR/hooks</code> directory. Set this to different path,
3043         e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
3044         that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
3045         in <code>$GIT_DIR/hooks/pre-receive</code>.
3046 </p>
3047 <div class="paragraph"><p>The path can be either absolute or relative. A relative path is
3048 taken as relative to the directory where the hooks are run (see
3049 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
3050 <div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
3051 centrally configure your Git hooks instead of configuring them on a
3052 per-repository basis, or as a more flexible and centralized
3053 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
3054 default hooks.</p></div>
3055 </dd>
3056 <dt class="hdlist1">
3057 core.editor
3058 </dt>
3059 <dd>
3060 <p>
3061         Commands such as <code>commit</code> and <code>tag</code> that let you edit
3062         messages by launching an editor use the value of this
3063         variable when it is set, and the environment variable
3064         <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.
3065 </p>
3066 </dd>
3067 <dt class="hdlist1">
3068 core.commentChar
3069 </dt>
3070 <dd>
3071 <p>
3072         Commands such as <code>commit</code> and <code>tag</code> that let you edit
3073         messages consider a line that begins with this character
3074         commented, and removes them after the editor returns
3075         (default <em>#</em>).
3076 </p>
3077 <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
3078 the beginning character of any line in existing commit messages.</p></div>
3079 </dd>
3080 <dt class="hdlist1">
3081 core.filesRefLockTimeout
3082 </dt>
3083 <dd>
3084 <p>
3085         The length of time, in milliseconds, to retry when trying to
3086         lock an individual reference. Value 0 means not to retry at
3087         all; -1 means to try indefinitely. Default is 100 (i.e.,
3088         retry for 100ms).
3089 </p>
3090 </dd>
3091 <dt class="hdlist1">
3092 core.packedRefsTimeout
3093 </dt>
3094 <dd>
3095 <p>
3096         The length of time, in milliseconds, to retry when trying to
3097         lock the <code>packed-refs</code> file. Value 0 means not to retry at
3098         all; -1 means to try indefinitely. Default is 1000 (i.e.,
3099         retry for 1 second).
3100 </p>
3101 </dd>
3102 <dt class="hdlist1">
3103 core.pager
3104 </dt>
3105 <dd>
3106 <p>
3107         Text viewer for use by Git commands (e.g., <em>less</em>).  The value
3108         is meant to be interpreted by the shell.  The order of preference
3109         is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
3110         configuration, then <code>$PAGER</code>, and then the default chosen at
3111         compile time (usually <em>less</em>).
3112 </p>
3113 <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
3114 (if <code>LESS</code> environment variable is set, Git does not change it at
3115 all).  If you want to selectively override Git&#8217;s default setting
3116 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
3117 be passed to the shell by Git, which will translate the final
3118 command to <code>LESS=FRX less -S</code>. The environment does not set the
3119 <code>S</code> option but the command line does, instructing less to truncate
3120 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
3121 deactivate the <code>F</code> option specified by the environment from the
3122 command-line, deactivating the "quit if one screen" behavior of
3123 <code>less</code>.  One can specifically activate some flags for particular
3124 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
3125 line truncation only for <code>git blame</code>.</p></div>
3126 <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
3127 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
3128 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
3129 </dd>
3130 <dt class="hdlist1">
3131 core.whitespace
3132 </dt>
3133 <dd>
3134 <p>
3135         A comma separated list of common whitespace problems to
3136         notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
3137         highlight them, and <em>git apply --whitespace=error</em> will
3138         consider them as errors.  You can prefix <code>-</code> to disable
3139         any of them (e.g. <code>-trailing-space</code>):
3140 </p>
3141 <div class="ulist"><ul>
3142 <li>
3143 <p>
3144 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
3145   as an error (enabled by default).
3146 </p>
3147 </li>
3148 <li>
3149 <p>
3150 <code>space-before-tab</code> treats a space character that appears immediately
3151   before a tab character in the initial indent part of the line as an
3152   error (enabled by default).
3153 </p>
3154 </li>
3155 <li>
3156 <p>
3157 <code>indent-with-non-tab</code> treats a line that is indented with space
3158   characters instead of the equivalent tabs as an error (not enabled by
3159   default).
3160 </p>
3161 </li>
3162 <li>
3163 <p>
3164 <code>tab-in-indent</code> treats a tab character in the initial indent part of
3165   the line as an error (not enabled by default).
3166 </p>
3167 </li>
3168 <li>
3169 <p>
3170 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
3171   (enabled by default).
3172 </p>
3173 </li>
3174 <li>
3175 <p>
3176 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
3177   <code>blank-at-eof</code>.
3178 </p>
3179 </li>
3180 <li>
3181 <p>
3182 <code>cr-at-eol</code> treats a carriage-return at the end of line as
3183   part of the line terminator, i.e. with it, <code>trailing-space</code>
3184   does not trigger if the character before such a carriage-return
3185   is not a whitespace (not enabled by default).
3186 </p>
3187 </li>
3188 <li>
3189 <p>
3190 <code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
3191   is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
3192   errors. The default tab width is 8. Allowed values are 1 to 63.
3193 </p>
3194 </li>
3195 </ul></div>
3196 </dd>
3197 <dt class="hdlist1">
3198 core.fsync
3199 </dt>
3200 <dd>
3201 <p>
3202         A comma-separated list of components of the repository that
3203         should be hardened via the core.fsyncMethod when created or
3204         modified.  You can disable hardening of any component by
3205         prefixing it with a <em>-</em>.  Items that are not hardened may be
3206         lost in the event of an unclean system shutdown. Unless you
3207         have special requirements, it is recommended that you leave
3208         this option empty or pick one of <code>committed</code>, <code>added</code>,
3209         or <code>all</code>.
3210 </p>
3211 <div class="paragraph"><p>When this configuration is encountered, the set of components starts with
3212 the platform default value, disabled components are removed, and additional
3213 components are added. <code>none</code> resets the state so that the platform default
3214 is ignored.</p></div>
3215 <div class="paragraph"><p>The empty string resets the fsync configuration to the platform
3216 default. The default on most platforms is equivalent to
3217 <code>core.fsync=committed,-loose-object</code>, which has good performance,
3218 but risks losing recent work in the event of an unclean system shutdown.</p></div>
3219 <div class="ulist"><ul>
3220 <li>
3221 <p>
3222 <code>none</code> clears the set of fsynced components.
3223 </p>
3224 </li>
3225 <li>
3226 <p>
3227 <code>loose-object</code> hardens objects added to the repo in loose-object form.
3228 </p>
3229 </li>
3230 <li>
3231 <p>
3232 <code>pack</code> hardens objects added to the repo in packfile form.
3233 </p>
3234 </li>
3235 <li>
3236 <p>
3237 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
3238 </p>
3239 </li>
3240 <li>
3241 <p>
3242 <code>commit-graph</code> hardens the commit-graph file.
3243 </p>
3244 </li>
3245 <li>
3246 <p>
3247 <code>index</code> hardens the index when it is modified.
3248 </p>
3249 </li>
3250 <li>
3251 <p>
3252 <code>objects</code> is an aggregate option that is equivalent to
3253   <code>loose-object,pack</code>.
3254 </p>
3255 </li>
3256 <li>
3257 <p>
3258 <code>reference</code> hardens references modified in the repo.
3259 </p>
3260 </li>
3261 <li>
3262 <p>
3263 <code>derived-metadata</code> is an aggregate option that is equivalent to
3264   <code>pack-metadata,commit-graph</code>.
3265 </p>
3266 </li>
3267 <li>
3268 <p>
3269 <code>committed</code> is an aggregate option that is currently equivalent to
3270   <code>objects</code>. This mode sacrifices some performance to ensure that work
3271   that is committed to the repository with <code>git commit</code> or similar commands
3272   is hardened.
3273 </p>
3274 </li>
3275 <li>
3276 <p>
3277 <code>added</code> is an aggregate option that is currently equivalent to
3278   <code>committed,index</code>. This mode sacrifices additional performance to
3279   ensure that the results of commands like <code>git add</code> and similar operations
3280   are hardened.
3281 </p>
3282 </li>
3283 <li>
3284 <p>
3285 <code>all</code> is an aggregate option that syncs all individual components above.
3286 </p>
3287 </li>
3288 </ul></div>
3289 </dd>
3290 <dt class="hdlist1">
3291 core.fsyncMethod
3292 </dt>
3293 <dd>
3294 <p>
3295         A value indicating the strategy Git will use to harden repository data
3296         using fsync and related primitives.
3297 </p>
3298 <div class="ulist"><ul>
3299 <li>
3300 <p>
3301 <code>fsync</code> uses the fsync() system call or platform equivalents.
3302 </p>
3303 </li>
3304 <li>
3305 <p>
3306 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
3307   filesystem and storage hardware, data added to the repository may not be
3308   durable in the event of a system crash. This is the default mode on macOS.
3309 </p>
3310 </li>
3311 <li>
3312 <p>
3313 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
3314   updates in the disk writeback cache and then does a single full fsync of
3315   a dummy file to trigger the disk cache flush at the end of the operation.
3316 </p>
3317 <div class="paragraph"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
3318 data is made durable as if <code>fsync</code> was specified. This mode is expected to
3319 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
3320 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
3321 </li>
3322 </ul></div>
3323 </dd>
3324 <dt class="hdlist1">
3325 core.fsyncObjectFiles
3326 </dt>
3327 <dd>
3328 <p>
3329         This boolean will enable <em>fsync()</em> when writing object files.
3330         This setting is deprecated. Use core.fsync instead.
3331 </p>
3332 <div class="paragraph"><p>This setting affects data added to the Git repository in loose-object
3333 form. When set to true, Git will issue an fsync or similar system call
3334 to flush caches so that loose-objects remain consistent in the face
3335 of a unclean system shutdown.</p></div>
3336 </dd>
3337 <dt class="hdlist1">
3338 core.preloadIndex
3339 </dt>
3340 <dd>
3341 <p>
3342         Enable parallel index preload for operations like <em>git diff</em>
3343 </p>
3344 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
3345 on filesystems like NFS that have weak caching semantics and thus
3346 relatively high IO latencies.  When enabled, Git will do the
3347 index comparison to the filesystem data in parallel, allowing
3348 overlapping IO&#8217;s.  Defaults to true.</p></div>
3349 </dd>
3350 <dt class="hdlist1">
3351 core.unsetenvvars
3352 </dt>
3353 <dd>
3354 <p>
3355         Windows-only: comma-separated list of environment variables'
3356         names that need to be unset before spawning any other process.
3357         Defaults to <code>PERL5LIB</code> to account for the fact that Git for
3358         Windows insists on using its own Perl interpreter.
3359 </p>
3360 </dd>
3361 <dt class="hdlist1">
3362 core.restrictinheritedhandles
3363 </dt>
3364 <dd>
3365 <p>
3366         Windows-only: override whether spawned processes inherit only standard
3367         file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
3368         <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
3369         Windows 7 and later, and <code>false</code> on older Windows versions.
3370 </p>
3371 </dd>
3372 <dt class="hdlist1">
3373 core.createObject
3374 </dt>
3375 <dd>
3376 <p>
3377         You can set this to <em>link</em>, in which case a hardlink followed by
3378         a delete of the source are used to make sure that object creation
3379         will not overwrite existing objects.
3380 </p>
3381 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
3382 Set this config setting to <em>rename</em> there; However, This will remove the
3383 check that makes sure that existing object files will not get overwritten.</p></div>
3384 </dd>
3385 <dt class="hdlist1">
3386 core.notesRef
3387 </dt>
3388 <dd>
3389 <p>
3390         When showing commit messages, also show notes which are stored in
3391         the given ref.  The ref must be fully qualified.  If the given
3392         ref does not exist, it is not an error but means that no
3393         notes should be printed.
3394 </p>
3395 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
3396 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p></div>
3397 </dd>
3398 <dt class="hdlist1">
3399 core.commitGraph
3400 </dt>
3401 <dd>
3402 <p>
3403         If true, then git will read the commit-graph file (if it exists)
3404         to parse the graph structure of commits. Defaults to true. See
3405         <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
3406 </p>
3407 </dd>
3408 <dt class="hdlist1">
3409 core.useReplaceRefs
3410 </dt>
3411 <dd>
3412 <p>
3413         If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
3414         option was given on the command line. See <a href="git.html">git(1)</a> and
3415         <a href="git-replace.html">git-replace(1)</a> for more information.
3416 </p>
3417 </dd>
3418 <dt class="hdlist1">
3419 core.multiPackIndex
3420 </dt>
3421 <dd>
3422 <p>
3423         Use the multi-pack-index file to track multiple packfiles using a
3424         single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
3425         information. Defaults to true.
3426 </p>
3427 </dd>
3428 <dt class="hdlist1">
3429 core.sparseCheckout
3430 </dt>
3431 <dd>
3432 <p>
3433         Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
3434         for more information.
3435 </p>
3436 </dd>
3437 <dt class="hdlist1">
3438 core.sparseCheckoutCone
3439 </dt>
3440 <dd>
3441 <p>
3442         Enables the "cone mode" of the sparse checkout feature. When the
3443         sparse-checkout file contains a limited set of patterns, this
3444         mode provides significant performance advantages. The "non-cone
3445         mode" can be requested to allow specifying more flexible
3446         patterns by setting this variable to <em>false</em>. See
3447         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.
3448 </p>
3449 </dd>
3450 <dt class="hdlist1">
3451 core.abbrev
3452 </dt>
3453 <dd>
3454 <p>
3455         Set the length object names are abbreviated to.  If
3456         unspecified or set to "auto", an appropriate value is
3457         computed based on the approximate number of packed objects
3458         in your repository, which hopefully is enough for
3459         abbreviated object names to stay unique for some time.
3460         If set to "no", no abbreviation is made and the object names
3461         are shown in their full length.
3462         The minimum length is 4.
3463 </p>
3464 </dd>
3465 <dt class="hdlist1">
3466 core.maxTreeDepth
3467 </dt>
3468 <dd>
3469 <p>
3470         The maximum depth Git is willing to recurse while traversing a
3471         tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
3472         to allow Git to abort cleanly, and should not generally need to
3473         be adjusted. The default is 4096.
3474 </p>
3475 </dd>
3476 <dt class="hdlist1">
3477 add.ignoreErrors
3478 </dt>
3479 <dt class="hdlist1">
3480 add.ignore-errors (deprecated)
3481 </dt>
3482 <dd>
3483 <p>
3484         Tells <em>git add</em> to continue adding files when some files cannot be
3485         added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
3486         option of <a href="git-add.html">git-add(1)</a>.  <code>add.ignore-errors</code> is deprecated,
3487         as it does not follow the usual naming convention for configuration
3488         variables.
3489 </p>
3490 </dd>
3491 <dt class="hdlist1">
3492 add.interactive.useBuiltin
3493 </dt>
3494 <dd>
3495 <p>
3496         Unused configuration variable. Used in Git versions v2.25.0 to
3497         v2.36.0 to enable the built-in version of <a href="git-add.html">git-add(1)</a>'s
3498         interactive mode, which then became the default in Git
3499         versions v2.37.0 to v2.39.0.
3500 </p>
3501 </dd>
3502 <dt class="hdlist1">
3503 alias.*
3504 </dt>
3505 <dd>
3506 <p>
3507         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
3508         after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
3509         <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
3510         confusion and troubles with script usage, aliases that
3511         hide existing Git commands are ignored. Arguments are split by
3512         spaces, the usual shell quoting and escaping are supported.
3513         A quote pair or a backslash can be used to quote them.
3514 </p>
3515 <div class="paragraph"><p>Note that the first word of an alias does not necessarily have to be a
3516 command. It can be a command-line option that will be passed into the
3517 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
3518 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
3519 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
3520 running <code>git loud-rebase</code> would be equivalent to
3521 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
3522 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
3523 where the original command does not.</p></div>
3524 <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
3525 it will be treated as a shell command.  For example, defining
3526 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
3527 <code>git new</code> is equivalent to running the shell command
3528 <code>gitk --all --not ORIG_HEAD</code>.  Note that shell commands will be
3529 executed from the top-level directory of a repository, which may
3530 not necessarily be the current directory.
3531 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
3532 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
3533 </dd>
3534 <dt class="hdlist1">
3535 am.keepcr
3536 </dt>
3537 <dd>
3538 <p>
3539         If true, git-am will call git-mailsplit for patches in mbox format
3540         with parameter <code>--keep-cr</code>. In this case git-mailsplit will
3541         not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
3542         by giving <code>--no-keep-cr</code> from the command line.
3543         See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
3544 </p>
3545 </dd>
3546 <dt class="hdlist1">
3547 am.threeWay
3548 </dt>
3549 <dd>
3550 <p>
3551         By default, <code>git am</code> will fail if the patch does not apply cleanly. When
3552         set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
3553         the patch records the identity of blobs it is supposed to apply to and
3554         we have those blobs available locally (equivalent to giving the <code>--3way</code>
3555         option from the command line). Defaults to <code>false</code>.
3556         See <a href="git-am.html">git-am(1)</a>.
3557 </p>
3558 </dd>
3559 <dt class="hdlist1">
3560 apply.ignoreWhitespace
3561 </dt>
3562 <dd>
3563 <p>
3564         When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
3565         whitespace, in the same way as the <code>--ignore-space-change</code>
3566         option.
3567         When set to one of: no, none, never, false, it tells <em>git apply</em> to
3568         respect all whitespace differences.
3569         See <a href="git-apply.html">git-apply(1)</a>.
3570 </p>
3571 </dd>
3572 <dt class="hdlist1">
3573 apply.whitespace
3574 </dt>
3575 <dd>
3576 <p>
3577         Tells <em>git apply</em> how to handle whitespace, in the same way
3578         as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
3579 </p>
3580 </dd>
3581 <dt class="hdlist1">
3582 blame.blankBoundary
3583 </dt>
3584 <dd>
3585 <p>
3586         Show blank commit object name for boundary commits in
3587         <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.
3588 </p>
3589 </dd>
3590 <dt class="hdlist1">
3591 blame.coloring
3592 </dt>
3593 <dd>
3594 <p>
3595         This determines the coloring scheme to be applied to blame
3596         output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
3597         or <em>none</em> which is the default.
3598 </p>
3599 </dd>
3600 <dt class="hdlist1">
3601 blame.date
3602 </dt>
3603 <dd>
3604 <p>
3605         Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
3606         If unset the iso format is used. For supported values,
3607         see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.
3608 </p>
3609 </dd>
3610 <dt class="hdlist1">
3611 blame.showEmail
3612 </dt>
3613 <dd>
3614 <p>
3615         Show the author email instead of author name 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.showRoot
3621 </dt>
3622 <dd>
3623 <p>
3624         Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
3625         This option defaults to false.
3626 </p>
3627 </dd>
3628 <dt class="hdlist1">
3629 blame.ignoreRevsFile
3630 </dt>
3631 <dd>
3632 <p>
3633         Ignore revisions listed in the file, one unabbreviated object name per
3634         line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
3635         <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
3636         file names will reset the list of ignored revisions.  This option will
3637         be handled before the command line option <code>--ignore-revs-file</code>.
3638 </p>
3639 </dd>
3640 <dt class="hdlist1">
3641 blame.markUnblamableLines
3642 </dt>
3643 <dd>
3644 <p>
3645         Mark lines that were changed by an ignored revision that we could not
3646         attribute to another commit with a <em>*</em> in the output of
3647         <a href="git-blame.html">git-blame(1)</a>.
3648 </p>
3649 </dd>
3650 <dt class="hdlist1">
3651 blame.markIgnoredLines
3652 </dt>
3653 <dd>
3654 <p>
3655         Mark lines that were changed by an ignored revision that we attributed to
3656         another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.
3657 </p>
3658 </dd>
3659 <dt class="hdlist1">
3660 branch.autoSetupMerge
3661 </dt>
3662 <dd>
3663 <p>
3664         Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
3665         so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
3666         starting point branch. Note that even if this option is not set,
3667         this behavior can be chosen per-branch using the <code>--track</code>
3668         and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
3669         automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
3670         starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;        automatic setup is done when the starting point is either a
3671         local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
3672         has a tracking configuration, it is copied to the new
3673         branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
3674         is a remote-tracking branch and the new branch has the same name as the
3675         remote branch. This option defaults to true.
3676 </p>
3677 </dd>
3678 <dt class="hdlist1">
3679 branch.autoSetupRebase
3680 </dt>
3681 <dd>
3682 <p>
3683         When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
3684         that tracks another branch, this variable tells Git to set
3685         up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
3686         When <code>never</code>, rebase is never automatically set to true.
3687         When <code>local</code>, rebase is set to true for tracked branches of
3688         other local branches.
3689         When <code>remote</code>, rebase is set to true for tracked branches of
3690         remote-tracking branches.
3691         When <code>always</code>, rebase will be set to true for all tracking
3692         branches.
3693         See "branch.autoSetupMerge" for details on how to set up a
3694         branch to track another branch.
3695         This option defaults to never.
3696 </p>
3697 </dd>
3698 <dt class="hdlist1">
3699 branch.sort
3700 </dt>
3701 <dd>
3702 <p>
3703         This variable controls the sort ordering of branches when displayed by
3704         <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
3705         value of this variable will be used as the default.
3706         See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.
3707 </p>
3708 </dd>
3709 <dt class="hdlist1">
3710 branch.&lt;name&gt;.remote
3711 </dt>
3712 <dd>
3713 <p>
3714         When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
3715         which remote to fetch from or push to.  The remote to push to
3716         may be overridden with <code>remote.pushDefault</code> (for all branches).
3717         The remote to push to, for the current branch, may be further
3718         overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
3719         configured, or if you are not on any branch and there is more than
3720         one remote defined in the repository, it defaults to <code>origin</code> for
3721         fetching and <code>remote.pushDefault</code> for pushing.
3722         Additionally, <code>.</code> (a period) is the current local repository
3723         (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
3724 </p>
3725 </dd>
3726 <dt class="hdlist1">
3727 branch.&lt;name&gt;.pushRemote
3728 </dt>
3729 <dd>
3730 <p>
3731         When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
3732         pushing.  It also overrides <code>remote.pushDefault</code> for pushing
3733         from branch &lt;name&gt;.  When you pull from one place (e.g. your
3734         upstream) and push to another place (e.g. your own publishing
3735         repository), you would want to set <code>remote.pushDefault</code> to
3736         specify the remote to push to for all branches, and use this
3737         option to override it for a specific branch.
3738 </p>
3739 </dd>
3740 <dt class="hdlist1">
3741 branch.&lt;name&gt;.merge
3742 </dt>
3743 <dd>
3744 <p>
3745         Defines, together with branch.&lt;name&gt;.remote, the upstream branch
3746         for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
3747         branch to merge and can also affect <em>git push</em> (see push.default).
3748         When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
3749         refspec to be marked for merging in FETCH_HEAD. The value is
3750         handled like the remote part of a refspec, and must match a
3751         ref which is fetched from the remote given by
3752         "branch.&lt;name&gt;.remote".
3753         The merge information is used by <em>git pull</em> (which first calls
3754         <em>git fetch</em>) to lookup the default branch for merging. Without
3755         this option, <em>git pull</em> defaults to merge the first refspec fetched.
3756         Specify multiple values to get an octopus merge.
3757         If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
3758         another branch in the local repository, you can point
3759         branch.&lt;name&gt;.merge to the desired branch, and use the relative path
3760         setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
3761 </p>
3762 </dd>
3763 <dt class="hdlist1">
3764 branch.&lt;name&gt;.mergeOptions
3765 </dt>
3766 <dd>
3767 <p>
3768         Sets default options for merging into branch &lt;name&gt;. The syntax and
3769         supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
3770         option values containing whitespace characters are currently not
3771         supported.
3772 </p>
3773 </dd>
3774 <dt class="hdlist1">
3775 branch.&lt;name&gt;.rebase
3776 </dt>
3777 <dd>
3778 <p>
3779         When true, rebase the branch &lt;name&gt; on top of the fetched branch,
3780         instead of merging the default branch from the default remote when
3781         "git pull" is run. See "pull.rebase" for doing this in a non
3782         branch-specific manner.
3783 </p>
3784 <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>
3785 so that the local merge commits are included in the rebase (see
3786 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
3787 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
3788 mode.</p></div>
3789 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
3790 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
3791 for details).</p></div>
3792 </dd>
3793 <dt class="hdlist1">
3794 branch.&lt;name&gt;.description
3795 </dt>
3796 <dd>
3797 <p>
3798         Branch description, can be edited with
3799         <code>git branch --edit-description</code>. Branch description is
3800         automatically added to the format-patch cover letter or
3801         request-pull summary.
3802 </p>
3803 </dd>
3804 <dt class="hdlist1">
3805 browser.&lt;tool&gt;.cmd
3806 </dt>
3807 <dd>
3808 <p>
3809         Specify the command to invoke the specified browser. The
3810         specified command is evaluated in shell with the URLs passed
3811         as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
3812 </p>
3813 </dd>
3814 <dt class="hdlist1">
3815 browser.&lt;tool&gt;.path
3816 </dt>
3817 <dd>
3818 <p>
3819         Override the path for the given tool that may be used to
3820         browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
3821         working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
3822 </p>
3823 </dd>
3824 <dt class="hdlist1">
3825 bundle.*
3826 </dt>
3827 <dd>
3828 <p>
3829         The <code>bundle.*</code> keys may appear in a bundle list file found via the
3830         <code>git clone --bundle-uri</code> option. These keys currently have no effect
3831         if placed in a repository config file, though this will change in the
3832         future. See <a href="technical/bundle-uri.html">the bundle URI design
3833         document</a> for more details.
3834 </p>
3835 </dd>
3836 <dt class="hdlist1">
3837 bundle.version
3838 </dt>
3839 <dd>
3840 <p>
3841         This integer value advertises the version of the bundle list format
3842         used by the bundle list. Currently, the only accepted value is <code>1</code>.
3843 </p>
3844 </dd>
3845 <dt class="hdlist1">
3846 bundle.mode
3847 </dt>
3848 <dd>
3849 <p>
3850         This string value should be either <code>all</code> or <code>any</code>. This value describes
3851         whether all of the advertised bundles are required to unbundle a
3852         complete understanding of the bundled information (<code>all</code>) or if any one
3853         of the listed bundle URIs is sufficient (<code>any</code>).
3854 </p>
3855 </dd>
3856 <dt class="hdlist1">
3857 bundle.heuristic
3858 </dt>
3859 <dd>
3860 <p>
3861         If this string-valued key exists, then the bundle list is designed to
3862         work well with incremental <code>git fetch</code> commands. The heuristic signals
3863         that there are additional keys available for each bundle that help
3864         determine which subset of bundles the client should download. The
3865         only value currently understood is <code>creationToken</code>.
3866 </p>
3867 </dd>
3868 <dt class="hdlist1">
3869 bundle.&lt;id&gt;.*
3870 </dt>
3871 <dd>
3872 <p>
3873         The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
3874         bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.
3875 </p>
3876 </dd>
3877 <dt class="hdlist1">
3878 bundle.&lt;id&gt;.uri
3879 </dt>
3880 <dd>
3881 <p>
3882         This string value defines the URI by which Git can reach the contents
3883         of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.
3884 </p>
3885 </dd>
3886 <dt class="hdlist1">
3887 checkout.defaultRemote
3888 </dt>
3889 <dd>
3890 <p>
3891         When you run <code>git checkout &lt;something&gt;</code>
3892         or <code>git switch &lt;something&gt;</code> and only have one
3893         remote, it may implicitly fall back on checking out and
3894         tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
3895         as you have more than one remote with a <code>&lt;something&gt;</code>
3896         reference. This setting allows for setting the name of a
3897         preferred remote that should always win when it comes to
3898         disambiguation. The typical use-case is to set this to
3899         <code>origin</code>.
3900 </p>
3901 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
3902 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
3903 or <code>git switch &lt;something&gt;</code>
3904 will checkout the <code>&lt;something&gt;</code> branch on another remote,
3905 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
3906 remote branch. This setting might be used for other checkout-like
3907 commands or functionality in the future.</p></div>
3908 </dd>
3909 <dt class="hdlist1">
3910 checkout.guess
3911 </dt>
3912 <dd>
3913 <p>
3914         Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
3915         option in <code>git checkout</code> and <code>git switch</code>. See
3916         <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
3917 </p>
3918 </dd>
3919 <dt class="hdlist1">
3920 checkout.workers
3921 </dt>
3922 <dd>
3923 <p>
3924         The number of parallel workers to use when updating the working tree.
3925         The default is one, i.e. sequential execution. If set to a value less
3926         than one, Git will use as many workers as the number of logical cores
3927         available. This setting and <code>checkout.thresholdForParallelism</code> affect
3928         all commands that perform checkout. E.g. checkout, clone, reset,
3929         sparse-checkout, etc.
3930 </p>
3931 <div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories
3932 located on SSDs or over NFS. For repositories on spinning disks and/or machines
3933 with a small number of cores, the default sequential checkout often performs
3934 better. The size and compression level of a repository might also influence how
3935 well the parallel version performs.</p></div>
3936 </dd>
3937 <dt class="hdlist1">
3938 checkout.thresholdForParallelism
3939 </dt>
3940 <dd>
3941 <p>
3942         When running parallel checkout with a small number of files, the cost
3943         of subprocess spawning and inter-process communication might outweigh
3944         the parallelization gains. This setting allows you to define the minimum
3945         number of files for which parallel checkout should be attempted. The
3946         default is 100.
3947 </p>
3948 </dd>
3949 <dt class="hdlist1">
3950 clean.requireForce
3951 </dt>
3952 <dd>
3953 <p>
3954         A boolean to make git-clean do nothing unless given -f,
3955         -i, or -n.  Defaults to true.
3956 </p>
3957 </dd>
3958 <dt class="hdlist1">
3959 clone.defaultRemoteName
3960 </dt>
3961 <dd>
3962 <p>
3963         The name of the remote to create when cloning a repository.  Defaults to
3964         <code>origin</code>, and can be overridden by passing the <code>--origin</code> command-line
3965         option to <a href="git-clone.html">git-clone(1)</a>.
3966 </p>
3967 </dd>
3968 <dt class="hdlist1">
3969 clone.rejectShallow
3970 </dt>
3971 <dd>
3972 <p>
3973         Reject cloning a repository if it is a shallow one; this can be overridden by
3974         passing the <code>--reject-shallow</code> option on the command line. See <a href="git-clone.html">git-clone(1)</a>
3975 </p>
3976 </dd>
3977 <dt class="hdlist1">
3978 clone.filterSubmodules
3979 </dt>
3980 <dd>
3981 <p>
3982         If a partial clone filter is provided (see <code>--filter</code> in
3983         <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
3984         the filter to submodules.
3985 </p>
3986 </dd>
3987 <dt class="hdlist1">
3988 color.advice
3989 </dt>
3990 <dd>
3991 <p>
3992         A boolean to enable/disable color in hints (e.g. when a push
3993         failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
3994         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
3995         are used only when the error output goes to a terminal. If
3996         unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3997 </p>
3998 </dd>
3999 <dt class="hdlist1">
4000 color.advice.hint
4001 </dt>
4002 <dd>
4003 <p>
4004         Use customized color for hints.
4005 </p>
4006 </dd>
4007 <dt class="hdlist1">
4008 color.blame.highlightRecent
4009 </dt>
4010 <dd>
4011 <p>
4012         Specify the line annotation color for <code>git blame --color-by-age</code>
4013         depending upon the age of the line.
4014 </p>
4015 <div class="paragraph"><p>This setting should be set to a comma-separated list of color and
4016 date settings, starting and ending with a color, the dates should be
4017 set from oldest to newest. The metadata will be colored with the
4018 specified colors if the line was introduced before the given
4019 timestamp, overwriting older timestamped colors.</p></div>
4020 <div class="paragraph"><p>Instead of an absolute timestamp relative timestamps work as well,
4021 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
4022 <div class="paragraph"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
4023 colors everything older than one year blue, recent changes between
4024 one month and one year old are kept white, and lines introduced
4025 within the last month are colored red.</p></div>
4026 </dd>
4027 <dt class="hdlist1">
4028 color.blame.repeatedLines
4029 </dt>
4030 <dd>
4031 <p>
4032         Use the specified color to colorize line annotations for
4033         <code>git blame --color-lines</code>, if they come from the same commit as the
4034         preceding line. Defaults to cyan.
4035 </p>
4036 </dd>
4037 <dt class="hdlist1">
4038 color.branch
4039 </dt>
4040 <dd>
4041 <p>
4042         A boolean to enable/disable color in the output of
4043         <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
4044         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4045         only when the output is to a terminal. If unset, then the
4046         value of <code>color.ui</code> is used (<code>auto</code> by default).
4047 </p>
4048 </dd>
4049 <dt class="hdlist1">
4050 color.branch.&lt;slot&gt;
4051 </dt>
4052 <dd>
4053 <p>
4054         Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
4055         <code>current</code> (the current branch), <code>local</code> (a local branch),
4056         <code>remote</code> (a remote-tracking branch in refs/remotes/),
4057         <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
4058         refs).
4059 </p>
4060 </dd>
4061 <dt class="hdlist1">
4062 color.diff
4063 </dt>
4064 <dd>
4065 <p>
4066         Whether to use ANSI escape sequences to add color to patches.
4067         If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
4068         <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
4069         for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
4070         commands will only use color when output is to the terminal.
4071         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
4072         default).
4073 </p>
4074 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
4075 <em>git-diff-&#42;</em> plumbing commands.  Can be overridden on the
4076 command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
4077 </dd>
4078 <dt class="hdlist1">
4079 color.diff.&lt;slot&gt;
4080 </dt>
4081 <dd>
4082 <p>
4083         Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
4084         which part of the patch to use the specified color, and is one
4085         of <code>context</code> (context text - <code>plain</code> is a historical synonym),
4086         <code>meta</code> (metainformation), <code>frag</code>
4087         (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
4088         <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
4089         (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
4090         <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
4091         <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
4092         <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
4093         setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
4094         <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
4095         <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).
4096 </p>
4097 </dd>
4098 <dt class="hdlist1">
4099 color.decorate.&lt;slot&gt;
4100 </dt>
4101 <dd>
4102 <p>
4103         Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
4104         of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
4105         branches, remote-tracking branches, tags, stash and HEAD, respectively
4106         and <code>grafted</code> for grafted commits.
4107 </p>
4108 </dd>
4109 <dt class="hdlist1">
4110 color.grep
4111 </dt>
4112 <dd>
4113 <p>
4114         When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
4115         <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
4116         when the output is written to the terminal.  If unset, then the
4117         value of <code>color.ui</code> is used (<code>auto</code> by default).
4118 </p>
4119 </dd>
4120 <dt class="hdlist1">
4121 color.grep.&lt;slot&gt;
4122 </dt>
4123 <dd>
4124 <p>
4125         Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
4126         part of the line to use the specified color, and is one of
4127 </p>
4128 <div class="openblock">
4129 <div class="content">
4130 <div class="dlist"><dl>
4131 <dt class="hdlist1">
4132 <code>context</code>
4133 </dt>
4134 <dd>
4135 <p>
4136         non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
4137 </p>
4138 </dd>
4139 <dt class="hdlist1">
4140 <code>filename</code>
4141 </dt>
4142 <dd>
4143 <p>
4144         filename prefix (when not using <code>-h</code>)
4145 </p>
4146 </dd>
4147 <dt class="hdlist1">
4148 <code>function</code>
4149 </dt>
4150 <dd>
4151 <p>
4152         function name lines (when using <code>-p</code>)
4153 </p>
4154 </dd>
4155 <dt class="hdlist1">
4156 <code>lineNumber</code>
4157 </dt>
4158 <dd>
4159 <p>
4160         line number prefix (when using <code>-n</code>)
4161 </p>
4162 </dd>
4163 <dt class="hdlist1">
4164 <code>column</code>
4165 </dt>
4166 <dd>
4167 <p>
4168         column number prefix (when using <code>--column</code>)
4169 </p>
4170 </dd>
4171 <dt class="hdlist1">
4172 <code>match</code>
4173 </dt>
4174 <dd>
4175 <p>
4176         matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
4177 </p>
4178 </dd>
4179 <dt class="hdlist1">
4180 <code>matchContext</code>
4181 </dt>
4182 <dd>
4183 <p>
4184         matching text in context lines
4185 </p>
4186 </dd>
4187 <dt class="hdlist1">
4188 <code>matchSelected</code>
4189 </dt>
4190 <dd>
4191 <p>
4192         matching text in selected lines. Also, used to customize the following
4193         <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.
4194 </p>
4195 </dd>
4196 <dt class="hdlist1">
4197 <code>selected</code>
4198 </dt>
4199 <dd>
4200 <p>
4201         non-matching text in selected lines. Also, used to customize the
4202         following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
4203         <code>--committer</code>.
4204 </p>
4205 </dd>
4206 <dt class="hdlist1">
4207 <code>separator</code>
4208 </dt>
4209 <dd>
4210 <p>
4211         separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
4212         and between hunks (<code>--</code>)
4213 </p>
4214 </dd>
4215 </dl></div>
4216 </div></div>
4217 </dd>
4218 <dt class="hdlist1">
4219 color.interactive
4220 </dt>
4221 <dd>
4222 <p>
4223         When set to <code>always</code>, always use colors for interactive prompts
4224         and displays (such as those used by "git-add --interactive" and
4225         "git-clean --interactive"). When false (or <code>never</code>), never.
4226         When set to <code>true</code> or <code>auto</code>, use colors only when the output is
4227         to the terminal. If unset, then the value of <code>color.ui</code> is
4228         used (<code>auto</code> by default).
4229 </p>
4230 </dd>
4231 <dt class="hdlist1">
4232 color.interactive.&lt;slot&gt;
4233 </dt>
4234 <dd>
4235 <p>
4236         Use customized color for <em>git add --interactive</em> and <em>git clean
4237         --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
4238         or <code>error</code>, for four distinct types of normal output from
4239         interactive commands.
4240 </p>
4241 </dd>
4242 <dt class="hdlist1">
4243 color.pager
4244 </dt>
4245 <dd>
4246 <p>
4247         A boolean to specify whether <code>auto</code> color modes should colorize
4248         output going to the pager. Defaults to true; set this to false
4249         if your pager does not understand ANSI color codes.
4250 </p>
4251 </dd>
4252 <dt class="hdlist1">
4253 color.push
4254 </dt>
4255 <dd>
4256 <p>
4257         A boolean to enable/disable color in push errors. May be set to
4258         <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
4259         case colors are used only when the error output goes to a terminal.
4260         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
4261 </p>
4262 </dd>
4263 <dt class="hdlist1">
4264 color.push.error
4265 </dt>
4266 <dd>
4267 <p>
4268         Use customized color for push errors.
4269 </p>
4270 </dd>
4271 <dt class="hdlist1">
4272 color.remote
4273 </dt>
4274 <dd>
4275 <p>
4276         If set, keywords at the start of the line are highlighted. The
4277         keywords are "error", "warning", "hint" and "success", and are
4278         matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
4279         <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
4280         <code>color.ui</code> is used (<code>auto</code> by default).
4281 </p>
4282 </dd>
4283 <dt class="hdlist1">
4284 color.remote.&lt;slot&gt;
4285 </dt>
4286 <dd>
4287 <p>
4288         Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
4289         <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
4290         corresponding keyword.
4291 </p>
4292 </dd>
4293 <dt class="hdlist1">
4294 color.showBranch
4295 </dt>
4296 <dd>
4297 <p>
4298         A boolean to enable/disable color in the output of
4299         <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
4300         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4301         only when the output is to a terminal. If unset, then the
4302         value of <code>color.ui</code> is used (<code>auto</code> by default).
4303 </p>
4304 </dd>
4305 <dt class="hdlist1">
4306 color.status
4307 </dt>
4308 <dd>
4309 <p>
4310         A boolean to enable/disable color in the output of
4311         <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
4312         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4313         only when the output is to a terminal. If unset, then the
4314         value of <code>color.ui</code> is used (<code>auto</code> by default).
4315 </p>
4316 </dd>
4317 <dt class="hdlist1">
4318 color.status.&lt;slot&gt;
4319 </dt>
4320 <dd>
4321 <p>
4322         Use customized color for status colorization. <code>&lt;slot&gt;</code> is
4323         one of <code>header</code> (the header text of the status message),
4324         <code>added</code> or <code>updated</code> (files which are added but not committed),
4325         <code>changed</code> (files which are changed but not added in the index),
4326         <code>untracked</code> (files which are not tracked by Git),
4327         <code>branch</code> (the current branch),
4328         <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
4329         to red),
4330         <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
4331         respectively, when branch and tracking information is displayed in the
4332         status short-format), or
4333         <code>unmerged</code> (files which have unmerged changes).
4334 </p>
4335 </dd>
4336 <dt class="hdlist1">
4337 color.transport
4338 </dt>
4339 <dd>
4340 <p>
4341         A boolean to enable/disable color when pushes are rejected. May be
4342         set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
4343         case colors are used only when the error output goes to a terminal.
4344         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
4345 </p>
4346 </dd>
4347 <dt class="hdlist1">
4348 color.transport.rejected
4349 </dt>
4350 <dd>
4351 <p>
4352         Use customized color when a push was rejected.
4353 </p>
4354 </dd>
4355 <dt class="hdlist1">
4356 color.ui
4357 </dt>
4358 <dd>
4359 <p>
4360         This variable determines the default value for variables such
4361         as <code>color.diff</code> and <code>color.grep</code> that control the use of color
4362         per command family. Its scope will expand as more commands learn
4363         configuration to set a default for the <code>--color</code> option.  Set it
4364         to <code>false</code> or <code>never</code> if you prefer Git commands not to use
4365         color unless enabled explicitly with some other configuration
4366         or the <code>--color</code> option. Set it to <code>always</code> if you want all
4367         output not intended for machine consumption to use color, to
4368         <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
4369         want such output to use color when written to the terminal.
4370 </p>
4371 </dd>
4372 <dt class="hdlist1">
4373 column.ui
4374 </dt>
4375 <dd>
4376 <p>
4377         Specify whether supported commands should output in columns.
4378         This variable consists of a list of tokens separated by spaces
4379         or commas:
4380 </p>
4381 <div class="paragraph"><p>These options control when the feature should be enabled
4382 (defaults to <em>never</em>):</p></div>
4383 <div class="openblock">
4384 <div class="content">
4385 <div class="dlist"><dl>
4386 <dt class="hdlist1">
4387 <code>always</code>
4388 </dt>
4389 <dd>
4390 <p>
4391         always show in columns
4392 </p>
4393 </dd>
4394 <dt class="hdlist1">
4395 <code>never</code>
4396 </dt>
4397 <dd>
4398 <p>
4399         never show in columns
4400 </p>
4401 </dd>
4402 <dt class="hdlist1">
4403 <code>auto</code>
4404 </dt>
4405 <dd>
4406 <p>
4407         show in columns if the output is to the terminal
4408 </p>
4409 </dd>
4410 </dl></div>
4411 </div></div>
4412 <div class="paragraph"><p>These options control layout (defaults to <em>column</em>).  Setting any
4413 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
4414 specified.</p></div>
4415 <div class="openblock">
4416 <div class="content">
4417 <div class="dlist"><dl>
4418 <dt class="hdlist1">
4419 <code>column</code>
4420 </dt>
4421 <dd>
4422 <p>
4423         fill columns before rows
4424 </p>
4425 </dd>
4426 <dt class="hdlist1">
4427 <code>row</code>
4428 </dt>
4429 <dd>
4430 <p>
4431         fill rows before columns
4432 </p>
4433 </dd>
4434 <dt class="hdlist1">
4435 <code>plain</code>
4436 </dt>
4437 <dd>
4438 <p>
4439         show in one column
4440 </p>
4441 </dd>
4442 </dl></div>
4443 </div></div>
4444 <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
4445 to <em>nodense</em>):</p></div>
4446 <div class="openblock">
4447 <div class="content">
4448 <div class="dlist"><dl>
4449 <dt class="hdlist1">
4450 <code>dense</code>
4451 </dt>
4452 <dd>
4453 <p>
4454         make unequal size columns to utilize more space
4455 </p>
4456 </dd>
4457 <dt class="hdlist1">
4458 <code>nodense</code>
4459 </dt>
4460 <dd>
4461 <p>
4462         make equal size columns
4463 </p>
4464 </dd>
4465 </dl></div>
4466 </div></div>
4467 </dd>
4468 <dt class="hdlist1">
4469 column.branch
4470 </dt>
4471 <dd>
4472 <p>
4473         Specify whether to output branch listing in <code>git branch</code> in columns.
4474         See <code>column.ui</code> for details.
4475 </p>
4476 </dd>
4477 <dt class="hdlist1">
4478 column.clean
4479 </dt>
4480 <dd>
4481 <p>
4482         Specify the layout when listing items in <code>git clean -i</code>, which always
4483         shows files and directories in columns. See <code>column.ui</code> for details.
4484 </p>
4485 </dd>
4486 <dt class="hdlist1">
4487 column.status
4488 </dt>
4489 <dd>
4490 <p>
4491         Specify whether to output untracked files in <code>git status</code> in columns.
4492         See <code>column.ui</code> for details.
4493 </p>
4494 </dd>
4495 <dt class="hdlist1">
4496 column.tag
4497 </dt>
4498 <dd>
4499 <p>
4500         Specify whether to output tag listings in <code>git tag</code> in columns.
4501         See <code>column.ui</code> for details.
4502 </p>
4503 </dd>
4504 <dt class="hdlist1">
4505 commit.cleanup
4506 </dt>
4507 <dd>
4508 <p>
4509         This setting overrides the default of the <code>--cleanup</code> option in
4510         <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
4511         default can be useful when you always want to keep lines that begin
4512         with the comment character <code>#</code> in your log message, in which case you
4513         would do <code>git config commit.cleanup whitespace</code> (note that you will
4514         have to remove the help lines that begin with <code>#</code> in the commit log
4515         template yourself, if you do this).
4516 </p>
4517 </dd>
4518 <dt class="hdlist1">
4519 commit.gpgSign
4520 </dt>
4521 <dd>
4522 <p>
4523         A boolean to specify whether all commits should be GPG signed.
4524         Use of this option when doing operations such as rebase can
4525         result in a large number of commits being signed. It may be
4526         convenient to use an agent to avoid typing your GPG passphrase
4527         several times.
4528 </p>
4529 </dd>
4530 <dt class="hdlist1">
4531 commit.status
4532 </dt>
4533 <dd>
4534 <p>
4535         A boolean to enable/disable inclusion of status information in the
4536         commit message template when using an editor to prepare the commit
4537         message.  Defaults to true.
4538 </p>
4539 </dd>
4540 <dt class="hdlist1">
4541 commit.template
4542 </dt>
4543 <dd>
4544 <p>
4545         Specify the pathname of a file to use as the template for
4546         new commit messages.
4547 </p>
4548 </dd>
4549 <dt class="hdlist1">
4550 commit.verbose
4551 </dt>
4552 <dd>
4553 <p>
4554         A boolean or int to specify the level of verbosity with <code>git commit</code>.
4555         See <a href="git-commit.html">git-commit(1)</a>.
4556 </p>
4557 </dd>
4558 <dt class="hdlist1">
4559 commitGraph.generationVersion
4560 </dt>
4561 <dd>
4562 <p>
4563         Specifies the type of generation number version to use when writing
4564         or reading the commit-graph file. If version 1 is specified, then
4565         the corrected commit dates will not be written or read. Defaults to
4566         2.
4567 </p>
4568 </dd>
4569 <dt class="hdlist1">
4570 commitGraph.maxNewFilters
4571 </dt>
4572 <dd>
4573 <p>
4574         Specifies the default value for the <code>--max-new-filters</code> option of <code>git
4575         commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).
4576 </p>
4577 </dd>
4578 <dt class="hdlist1">
4579 commitGraph.readChangedPaths
4580 </dt>
4581 <dd>
4582 <p>
4583         If true, then git will use the changed-path Bloom filters in the
4584         commit-graph file (if it exists, and they are present). Defaults to
4585         true. See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
4586 </p>
4587 </dd>
4588 <dt class="hdlist1">
4589 credential.helper
4590 </dt>
4591 <dd>
4592 <p>
4593         Specify an external helper to be called when a username or
4594         password credential is needed; the helper may consult external
4595         storage to avoid prompting the user for the credentials. This is
4596         normally the name of a credential helper with possible
4597         arguments, but may also be an absolute path with arguments or, if
4598         preceded by <code>!</code>, shell commands.
4599 </p>
4600 <div class="paragraph"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
4601 for details and examples.</p></div>
4602 </dd>
4603 <dt class="hdlist1">
4604 credential.useHttpPath
4605 </dt>
4606 <dd>
4607 <p>
4608         When acquiring credentials, consider the "path" component of an http
4609         or https URL to be important. Defaults to false. See
4610         <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
4611 </p>
4612 </dd>
4613 <dt class="hdlist1">
4614 credential.username
4615 </dt>
4616 <dd>
4617 <p>
4618         If no username is set for a network authentication, use this username
4619         by default. See credential.&lt;context&gt;.* below, and
4620         <a href="gitcredentials.html">gitcredentials(7)</a>.
4621 </p>
4622 </dd>
4623 <dt class="hdlist1">
4624 credential.&lt;url&gt;.*
4625 </dt>
4626 <dd>
4627 <p>
4628         Any of the credential.* options above can be applied selectively to
4629         some credentials. For example, "credential.https://example.com.username"
4630         would set the default username only for https connections to
4631         example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
4632         matched.
4633 </p>
4634 </dd>
4635 <dt class="hdlist1">
4636 credentialCache.ignoreSIGHUP
4637 </dt>
4638 <dd>
4639 <p>
4640         Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
4641 </p>
4642 </dd>
4643 <dt class="hdlist1">
4644 credentialStore.lockTimeoutMS
4645 </dt>
4646 <dd>
4647 <p>
4648         The length of time, in milliseconds, for git-credential-store to retry
4649         when trying to lock the credentials file. A value of 0 means not to retry at
4650         all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
4651         1s).
4652 </p>
4653 </dd>
4654 <dt class="hdlist1">
4655 completion.commands
4656 </dt>
4657 <dd>
4658 <p>
4659         This is only used by git-completion.bash to add or remove
4660         commands from the list of completed commands. Normally only
4661         porcelain commands and a few select others are completed. You
4662         can add more commands, separated by space, in this
4663         variable. Prefixing the command with <em>-</em> will remove it from
4664         the existing list.
4665 </p>
4666 </dd>
4667 <dt class="hdlist1">
4668 diff.autoRefreshIndex
4669 </dt>
4670 <dd>
4671 <p>
4672         When using <em>git diff</em> to compare with work tree
4673         files, do not consider stat-only changes as changed.
4674         Instead, silently run <code>git update-index --refresh</code> to
4675         update the cached stat information for paths whose
4676         contents in the work tree match the contents in the
4677         index.  This option defaults to true.  Note that this
4678         affects only <em>git diff</em> Porcelain, and not lower level
4679         <em>diff</em> commands such as <em>git diff-files</em>.
4680 </p>
4681 </dd>
4682 <dt class="hdlist1">
4683 diff.dirstat
4684 </dt>
4685 <dd>
4686 <p>
4687         A comma separated list of <code>--dirstat</code> parameters specifying the
4688         default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
4689         and friends. The defaults can be overridden on the command line
4690         (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
4691         (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
4692         The following parameters are available:
4693 </p>
4694 <div class="openblock">
4695 <div class="content">
4696 <div class="dlist"><dl>
4697 <dt class="hdlist1">
4698 <code>changes</code>
4699 </dt>
4700 <dd>
4701 <p>
4702         Compute the dirstat numbers by counting the lines that have been
4703         removed from the source, or added to the destination. This ignores
4704         the amount of pure code movements within a file.  In other words,
4705         rearranging lines in a file is not counted as much as other changes.
4706         This is the default behavior when no parameter is given.
4707 </p>
4708 </dd>
4709 <dt class="hdlist1">
4710 <code>lines</code>
4711 </dt>
4712 <dd>
4713 <p>
4714         Compute the dirstat numbers by doing the regular line-based diff
4715         analysis, and summing the removed/added line counts. (For binary
4716         files, count 64-byte chunks instead, since binary files have no
4717         natural concept of lines). This is a more expensive <code>--dirstat</code>
4718         behavior than the <code>changes</code> behavior, but it does count rearranged
4719         lines within a file as much as other changes. The resulting output
4720         is consistent with what you get from the other <code>--*stat</code> options.
4721 </p>
4722 </dd>
4723 <dt class="hdlist1">
4724 <code>files</code>
4725 </dt>
4726 <dd>
4727 <p>
4728         Compute the dirstat numbers by counting the number of files changed.
4729         Each changed file counts equally in the dirstat analysis. This is
4730         the computationally cheapest <code>--dirstat</code> behavior, since it does
4731         not have to look at the file contents at all.
4732 </p>
4733 </dd>
4734 <dt class="hdlist1">
4735 <code>cumulative</code>
4736 </dt>
4737 <dd>
4738 <p>
4739         Count changes in a child directory for the parent directory as well.
4740         Note that when using <code>cumulative</code>, the sum of the percentages
4741         reported may exceed 100%. The default (non-cumulative) behavior can
4742         be specified with the <code>noncumulative</code> parameter.
4743 </p>
4744 </dd>
4745 <dt class="hdlist1">
4746 &lt;limit&gt;
4747 </dt>
4748 <dd>
4749 <p>
4750         An integer parameter specifies a cut-off percent (3% by default).
4751         Directories contributing less than this percentage of the changes
4752         are not shown in the output.
4753 </p>
4754 </dd>
4755 </dl></div>
4756 </div></div>
4757 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
4758 directories with less than 10% of the total amount of changed files,
4759 and accumulating child directory counts in the parent directories:
4760 <code>files,10,cumulative</code>.</p></div>
4761 </dd>
4762 <dt class="hdlist1">
4763 diff.statNameWidth
4764 </dt>
4765 <dd>
4766 <p>
4767         Limit the width of the filename 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.statGraphWidth
4773 </dt>
4774 <dd>
4775 <p>
4776         Limit the width of the graph part in --stat output. If set, applies
4777         to all commands generating --stat output except format-patch.
4778 </p>
4779 </dd>
4780 <dt class="hdlist1">
4781 diff.context
4782 </dt>
4783 <dd>
4784 <p>
4785         Generate diffs with &lt;n&gt; lines of context instead of the default
4786         of 3. This value is overridden by the -U option.
4787 </p>
4788 </dd>
4789 <dt class="hdlist1">
4790 diff.interHunkContext
4791 </dt>
4792 <dd>
4793 <p>
4794         Show the context between diff hunks, up to the specified number
4795         of lines, thereby fusing the hunks that are close to each other.
4796         This value serves as the default for the <code>--inter-hunk-context</code>
4797         command line option.
4798 </p>
4799 </dd>
4800 <dt class="hdlist1">
4801 diff.external
4802 </dt>
4803 <dd>
4804 <p>
4805         If this config variable is set, diff generation is not
4806         performed using the internal diff machinery, but using the
4807         given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
4808         environment variable.  The command is called with parameters
4809         as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
4810         you want to use an external diff program only on a subset of
4811         your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
4812 </p>
4813 </dd>
4814 <dt class="hdlist1">
4815 diff.ignoreSubmodules
4816 </dt>
4817 <dd>
4818 <p>
4819         Sets the default value of --ignore-submodules. Note that this
4820         affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
4821         commands such as <em>git diff-files</em>. <em>git checkout</em>
4822         and <em>git switch</em> also honor
4823         this setting when reporting uncommitted changes. Setting it to
4824         <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
4825         and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
4826         overridden by using the --ignore-submodules command-line option.
4827         The <em>git submodule</em> commands are not affected by this setting.
4828         By default this is set to untracked so that any untracked
4829         submodules are ignored.
4830 </p>
4831 </dd>
4832 <dt class="hdlist1">
4833 diff.mnemonicPrefix
4834 </dt>
4835 <dd>
4836 <p>
4837         If set, <em>git diff</em> uses a prefix pair that is different from the
4838         standard "a/" and "b/" depending on what is being compared.  When
4839         this configuration is in effect, reverse diff output also swaps
4840         the order of the prefixes:
4841 </p>
4842 <div class="dlist"><dl>
4843 <dt class="hdlist1">
4844 <code>git diff</code>
4845 </dt>
4846 <dd>
4847 <p>
4848         compares the (i)ndex and the (w)ork tree;
4849 </p>
4850 </dd>
4851 <dt class="hdlist1">
4852 <code>git diff HEAD</code>
4853 </dt>
4854 <dd>
4855 <p>
4856          compares a (c)ommit and the (w)ork tree;
4857 </p>
4858 </dd>
4859 <dt class="hdlist1">
4860 <code>git diff --cached</code>
4861 </dt>
4862 <dd>
4863 <p>
4864         compares a (c)ommit and the (i)ndex;
4865 </p>
4866 </dd>
4867 <dt class="hdlist1">
4868 <code>git diff HEAD:file1 file2</code>
4869 </dt>
4870 <dd>
4871 <p>
4872         compares an (o)bject and a (w)ork tree entity;
4873 </p>
4874 </dd>
4875 <dt class="hdlist1">
4876 <code>git diff --no-index a b</code>
4877 </dt>
4878 <dd>
4879 <p>
4880         compares two non-git things (1) and (2).
4881 </p>
4882 </dd>
4883 </dl></div>
4884 </dd>
4885 <dt class="hdlist1">
4886 diff.noprefix
4887 </dt>
4888 <dd>
4889 <p>
4890         If set, <em>git diff</em> does not show any source or destination prefix.
4891 </p>
4892 </dd>
4893 <dt class="hdlist1">
4894 diff.relative
4895 </dt>
4896 <dd>
4897 <p>
4898         If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
4899         and show pathnames relative to the current directory.
4900 </p>
4901 </dd>
4902 <dt class="hdlist1">
4903 diff.orderFile
4904 </dt>
4905 <dd>
4906 <p>
4907         File indicating how to order files within a diff.
4908         See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
4909         If <code>diff.orderFile</code> is a relative pathname, it is treated as
4910         relative to the top of the working tree.
4911 </p>
4912 </dd>
4913 <dt class="hdlist1">
4914 diff.renameLimit
4915 </dt>
4916 <dd>
4917 <p>
4918         The number of files to consider in the exhaustive portion of
4919         copy/rename detection; equivalent to the <em>git diff</em> option
4920         <code>-l</code>.  If not set, the default value is currently 1000.  This
4921         setting has no effect if rename detection is turned off.
4922 </p>
4923 </dd>
4924 <dt class="hdlist1">
4925 diff.renames
4926 </dt>
4927 <dd>
4928 <p>
4929         Whether and how Git detects renames.  If set to "false",
4930         rename detection is disabled. If set to "true", basic rename
4931         detection is enabled.  If set to "copies" or "copy", Git will
4932         detect copies, as well.  Defaults to true.  Note that this
4933         affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
4934         <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
4935         <a href="git-diff-files.html">git-diff-files(1)</a>.
4936 </p>
4937 </dd>
4938 <dt class="hdlist1">
4939 diff.suppressBlankEmpty
4940 </dt>
4941 <dd>
4942 <p>
4943         A boolean to inhibit the standard behavior of printing a space
4944         before each empty output line. Defaults to false.
4945 </p>
4946 </dd>
4947 <dt class="hdlist1">
4948 diff.submodule
4949 </dt>
4950 <dd>
4951 <p>
4952         Specify the format in which differences in submodules are
4953         shown.  The "short" format just shows the names of the commits
4954         at the beginning and end of the range. The "log" format lists
4955         the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
4956         does. The "diff" format shows an inline diff of the changed
4957         contents of the submodule. Defaults to "short".
4958 </p>
4959 </dd>
4960 <dt class="hdlist1">
4961 diff.wordRegex
4962 </dt>
4963 <dd>
4964 <p>
4965         A POSIX Extended Regular Expression used to determine what is a "word"
4966         when performing word-by-word difference calculations.  Character
4967         sequences that match the regular expression are "words", all other
4968         characters are <strong>ignorable</strong> whitespace.
4969 </p>
4970 </dd>
4971 <dt class="hdlist1">
4972 diff.&lt;driver&gt;.command
4973 </dt>
4974 <dd>
4975 <p>
4976         The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
4977         for details.
4978 </p>
4979 </dd>
4980 <dt class="hdlist1">
4981 diff.&lt;driver&gt;.xfuncname
4982 </dt>
4983 <dd>
4984 <p>
4985         The regular expression that the diff driver should use to
4986         recognize the hunk header.  A built-in pattern may also be used.
4987         See <a href="gitattributes.html">gitattributes(5)</a> for details.
4988 </p>
4989 </dd>
4990 <dt class="hdlist1">
4991 diff.&lt;driver&gt;.binary
4992 </dt>
4993 <dd>
4994 <p>
4995         Set this option to true to make the diff driver treat files as
4996         binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
4997 </p>
4998 </dd>
4999 <dt class="hdlist1">
5000 diff.&lt;driver&gt;.textconv
5001 </dt>
5002 <dd>
5003 <p>
5004         The command that the diff driver should call to generate the
5005         text-converted version of a file.  The result of the
5006         conversion is used to generate a human-readable diff.  See
5007         <a href="gitattributes.html">gitattributes(5)</a> for details.
5008 </p>
5009 </dd>
5010 <dt class="hdlist1">
5011 diff.&lt;driver&gt;.wordRegex
5012 </dt>
5013 <dd>
5014 <p>
5015         The regular expression that the diff driver should use to
5016         split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
5017         details.
5018 </p>
5019 </dd>
5020 <dt class="hdlist1">
5021 diff.&lt;driver&gt;.cachetextconv
5022 </dt>
5023 <dd>
5024 <p>
5025         Set this option to true to make the diff driver cache the text
5026         conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5027 </p>
5028 <div class="dlist"><dl>
5029 <dt class="hdlist1">
5030 <code>araxis</code>
5031 </dt>
5032 <dd>
5033 <p>
5034 Use Araxis Merge (requires a graphical session)
5035 </p>
5036 </dd>
5037 <dt class="hdlist1">
5038 <code>bc</code>
5039 </dt>
5040 <dd>
5041 <p>
5042 Use Beyond Compare (requires a graphical session)
5043 </p>
5044 </dd>
5045 <dt class="hdlist1">
5046 <code>bc3</code>
5047 </dt>
5048 <dd>
5049 <p>
5050 Use Beyond Compare (requires a graphical session)
5051 </p>
5052 </dd>
5053 <dt class="hdlist1">
5054 <code>bc4</code>
5055 </dt>
5056 <dd>
5057 <p>
5058 Use Beyond Compare (requires a graphical session)
5059 </p>
5060 </dd>
5061 <dt class="hdlist1">
5062 <code>codecompare</code>
5063 </dt>
5064 <dd>
5065 <p>
5066 Use Code Compare (requires a graphical session)
5067 </p>
5068 </dd>
5069 <dt class="hdlist1">
5070 <code>deltawalker</code>
5071 </dt>
5072 <dd>
5073 <p>
5074 Use DeltaWalker (requires a graphical session)
5075 </p>
5076 </dd>
5077 <dt class="hdlist1">
5078 <code>diffmerge</code>
5079 </dt>
5080 <dd>
5081 <p>
5082 Use DiffMerge (requires a graphical session)
5083 </p>
5084 </dd>
5085 <dt class="hdlist1">
5086 <code>diffuse</code>
5087 </dt>
5088 <dd>
5089 <p>
5090 Use Diffuse (requires a graphical session)
5091 </p>
5092 </dd>
5093 <dt class="hdlist1">
5094 <code>ecmerge</code>
5095 </dt>
5096 <dd>
5097 <p>
5098 Use ECMerge (requires a graphical session)
5099 </p>
5100 </dd>
5101 <dt class="hdlist1">
5102 <code>emerge</code>
5103 </dt>
5104 <dd>
5105 <p>
5106 Use Emacs' Emerge
5107 </p>
5108 </dd>
5109 <dt class="hdlist1">
5110 <code>examdiff</code>
5111 </dt>
5112 <dd>
5113 <p>
5114 Use ExamDiff Pro (requires a graphical session)
5115 </p>
5116 </dd>
5117 <dt class="hdlist1">
5118 <code>guiffy</code>
5119 </dt>
5120 <dd>
5121 <p>
5122 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
5123 </p>
5124 </dd>
5125 <dt class="hdlist1">
5126 <code>gvimdiff</code>
5127 </dt>
5128 <dd>
5129 <p>
5130 Use gVim (requires a graphical session)
5131 </p>
5132 </dd>
5133 <dt class="hdlist1">
5134 <code>kdiff3</code>
5135 </dt>
5136 <dd>
5137 <p>
5138 Use KDiff3 (requires a graphical session)
5139 </p>
5140 </dd>
5141 <dt class="hdlist1">
5142 <code>kompare</code>
5143 </dt>
5144 <dd>
5145 <p>
5146 Use Kompare (requires a graphical session)
5147 </p>
5148 </dd>
5149 <dt class="hdlist1">
5150 <code>meld</code>
5151 </dt>
5152 <dd>
5153 <p>
5154 Use Meld (requires a graphical session)
5155 </p>
5156 </dd>
5157 <dt class="hdlist1">
5158 <code>nvimdiff</code>
5159 </dt>
5160 <dd>
5161 <p>
5162 Use Neovim
5163 </p>
5164 </dd>
5165 <dt class="hdlist1">
5166 <code>opendiff</code>
5167 </dt>
5168 <dd>
5169 <p>
5170 Use FileMerge (requires a graphical session)
5171 </p>
5172 </dd>
5173 <dt class="hdlist1">
5174 <code>p4merge</code>
5175 </dt>
5176 <dd>
5177 <p>
5178 Use HelixCore P4Merge (requires a graphical session)
5179 </p>
5180 </dd>
5181 <dt class="hdlist1">
5182 <code>smerge</code>
5183 </dt>
5184 <dd>
5185 <p>
5186 Use Sublime Merge (requires a graphical session)
5187 </p>
5188 </dd>
5189 <dt class="hdlist1">
5190 <code>tkdiff</code>
5191 </dt>
5192 <dd>
5193 <p>
5194 Use TkDiff (requires a graphical session)
5195 </p>
5196 </dd>
5197 <dt class="hdlist1">
5198 <code>vimdiff</code>
5199 </dt>
5200 <dd>
5201 <p>
5202 Use Vim
5203 </p>
5204 </dd>
5205 <dt class="hdlist1">
5206 <code>winmerge</code>
5207 </dt>
5208 <dd>
5209 <p>
5210 Use WinMerge (requires a graphical session)
5211 </p>
5212 </dd>
5213 <dt class="hdlist1">
5214 <code>xxdiff</code>
5215 </dt>
5216 <dd>
5217 <p>
5218 Use xxdiff (requires a graphical session)
5219 </p>
5220 </dd>
5221 </dl></div>
5222 </dd>
5223 <dt class="hdlist1">
5224 diff.indentHeuristic
5225 </dt>
5226 <dd>
5227 <p>
5228         Set this option to <code>false</code> to disable the default heuristics
5229         that shift diff hunk boundaries to make patches easier to read.
5230 </p>
5231 </dd>
5232 <dt class="hdlist1">
5233 diff.algorithm
5234 </dt>
5235 <dd>
5236 <p>
5237         Choose a diff algorithm.  The variants are as follows:
5238 </p>
5239 <div class="openblock">
5240 <div class="content">
5241 <div class="dlist"><dl>
5242 <dt class="hdlist1">
5243 <code>default</code>, <code>myers</code>
5244 </dt>
5245 <dd>
5246 <p>
5247         The basic greedy diff algorithm. Currently, this is the default.
5248 </p>
5249 </dd>
5250 <dt class="hdlist1">
5251 <code>minimal</code>
5252 </dt>
5253 <dd>
5254 <p>
5255         Spend extra time to make sure the smallest possible diff is
5256         produced.
5257 </p>
5258 </dd>
5259 <dt class="hdlist1">
5260 <code>patience</code>
5261 </dt>
5262 <dd>
5263 <p>
5264         Use "patience diff" algorithm when generating patches.
5265 </p>
5266 </dd>
5267 <dt class="hdlist1">
5268 <code>histogram</code>
5269 </dt>
5270 <dd>
5271 <p>
5272         This algorithm extends the patience algorithm to "support
5273         low-occurrence common elements".
5274 </p>
5275 </dd>
5276 </dl></div>
5277 </div></div>
5278 </dd>
5279 <dt class="hdlist1">
5280 diff.wsErrorHighlight
5281 </dt>
5282 <dd>
5283 <p>
5284         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5285         lines of the diff.  Multiple values are separated by comma,
5286         <code>none</code> resets previous values, <code>default</code> reset the list to
5287         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
5288         whitespace errors are colored with <code>color.diff.whitespace</code>.
5289         The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
5290         overrides this setting.
5291 </p>
5292 </dd>
5293 <dt class="hdlist1">
5294 diff.colorMoved
5295 </dt>
5296 <dd>
5297 <p>
5298         If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
5299         in a diff are colored differently, for details of valid modes
5300         see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
5301         true the default color mode will be used. When set to false,
5302         moved lines are not colored.
5303 </p>
5304 </dd>
5305 <dt class="hdlist1">
5306 diff.colorMovedWS
5307 </dt>
5308 <dd>
5309 <p>
5310         When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5311         this option controls the <code>&lt;mode&gt;</code> how spaces are treated
5312         for details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.
5313 </p>
5314 </dd>
5315 <dt class="hdlist1">
5316 diff.tool
5317 </dt>
5318 <dd>
5319 <p>
5320         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
5321         This variable overrides the value configured in <code>merge.tool</code>.
5322         The list below shows the valid built-in values.
5323         Any other value is treated as a custom diff tool and requires
5324         that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
5325 </p>
5326 </dd>
5327 <dt class="hdlist1">
5328 diff.guitool
5329 </dt>
5330 <dd>
5331 <p>
5332         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
5333         the -g/--gui flag is specified. This variable overrides the value
5334         configured in <code>merge.guitool</code>. The list below shows the valid
5335         built-in values. Any other value is treated as a custom diff tool
5336         and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
5337         is defined.
5338 </p>
5339 </dd>
5340 <dt class="hdlist1">
5341 difftool.&lt;tool&gt;.cmd
5342 </dt>
5343 <dd>
5344 <p>
5345         Specify the command to invoke the specified diff tool.
5346         The specified command is evaluated in shell with the following
5347         variables available:  <em>LOCAL</em> is set to the name of the temporary
5348         file containing the contents of the diff pre-image and <em>REMOTE</em>
5349         is set to the name of the temporary file containing the contents
5350         of the diff post-image.
5351 </p>
5352 <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>
5353 </dd>
5354 <dt class="hdlist1">
5355 difftool.&lt;tool&gt;.path
5356 </dt>
5357 <dd>
5358 <p>
5359         Override the path for the given tool.  This is useful in case
5360         your tool is not in the PATH.
5361 </p>
5362 </dd>
5363 <dt class="hdlist1">
5364 difftool.trustExitCode
5365 </dt>
5366 <dd>
5367 <p>
5368         Exit difftool if the invoked diff tool returns a non-zero exit status.
5369 </p>
5370 <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>
5371 </dd>
5372 <dt class="hdlist1">
5373 difftool.prompt
5374 </dt>
5375 <dd>
5376 <p>
5377         Prompt before each invocation of the diff tool.
5378 </p>
5379 </dd>
5380 <dt class="hdlist1">
5381 difftool.guiDefault
5382 </dt>
5383 <dd>
5384 <p>
5385         Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5386         the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5387         depending on the presence of a <code>DISPLAY</code> environment variable value. The
5388         default is <code>false</code>, where the <code>--gui</code> argument must be provided
5389         explicitly for the <code>diff.guitool</code> to be used.
5390 </p>
5391 </dd>
5392 <dt class="hdlist1">
5393 extensions.objectFormat
5394 </dt>
5395 <dd>
5396 <p>
5397         Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
5398         <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
5399         this key unless <code>core.repositoryFormatVersion</code> is 1.
5400 </p>
5401 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5402 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
5403 work and will produce hard-to-diagnose issues.</p></div>
5404 </dd>
5405 <dt class="hdlist1">
5406 extensions.refStorage
5407 </dt>
5408 <dd>
5409 <p>
5410         Specify the ref storage format to use. The acceptable values are:
5411 </p>
5412 <div class="ulist"><ul>
5413 <li>
5414 <p>
5415 <code>files</code> for loose files with packed-refs. This is the default.
5416 </p>
5417 <div class="paragraph"><p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p></div>
5418 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5419 <a href="git-clone.html">git-clone(1)</a>. Trying to change it after initialization will not
5420 work and will produce hard-to-diagnose issues.</p></div>
5421 </li>
5422 </ul></div>
5423 </dd>
5424 <dt class="hdlist1">
5425 extensions.worktreeConfig
5426 </dt>
5427 <dd>
5428 <p>
5429         If enabled, then worktrees will load config settings from the
5430         <code>$GIT_DIR/config.worktree</code> file in addition to the
5431         <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5432         <code>$GIT_DIR</code> are the same for the main working tree, while other
5433         working trees have <code>$GIT_DIR</code> equal to
5434         <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
5435         <code>config.worktree</code> file will override settings from any other
5436         config files.
5437 </p>
5438 <div class="paragraph"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5439 certain values from the common config file to the main working tree&#8217;s
5440 <code>config.worktree</code> file, if present:</p></div>
5441 <div class="ulist"><ul>
5442 <li>
5443 <p>
5444 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5445   <code>$GIT_COMMON_DIR/config.worktree</code>.
5446 </p>
5447 </li>
5448 <li>
5449 <p>
5450 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5451   to <code>$GIT_COMMON_DIR/config.worktree</code>.
5452 </p>
5453 <div class="paragraph"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5454 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5455 sparse-checkout settings for each worktree. By default, the <code>git
5456 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5457 these config values on a per-worktree basis, and uses the
5458 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5459 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
5460 details.</p></div>
5461 <div class="paragraph"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5462 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5463 </li>
5464 </ul></div>
5465 </dd>
5466 <dt class="hdlist1">
5467 fastimport.unpackLimit
5468 </dt>
5469 <dd>
5470 <p>
5471         If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
5472         is below this limit, then the objects will be unpacked into
5473         loose object files.  However, if the number of imported objects
5474         equals or exceeds this limit, then the pack will be stored as a
5475         pack.  Storing the pack from a fast-import can make the import
5476         operation complete faster, especially on slow filesystems.  If
5477         not set, the value of <code>transfer.unpackLimit</code> is used instead.
5478 </p>
5479 </dd>
5480 <dt class="hdlist1">
5481 feature.*
5482 </dt>
5483 <dd>
5484 <p>
5485         The config settings that start with <code>feature.</code> modify the defaults of
5486         a group of other config settings. These groups are created by the Git
5487         developer community as recommended defaults and are subject to change.
5488         In particular, new config options may be added with different defaults.
5489 </p>
5490 </dd>
5491 <dt class="hdlist1">
5492 feature.experimental
5493 </dt>
5494 <dd>
5495 <p>
5496         Enable config options that are new to Git, and are being considered for
5497         future defaults. Config settings included here may be added or removed
5498         with each release, including minor version updates. These settings may
5499         have unintended interactions since they are so new. Please enable this
5500         setting if you are interested in providing feedback on experimental
5501         features. The new default values are:
5502 </p>
5503 <div class="ulist"><ul>
5504 <li>
5505 <p>
5506 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5507 skipping more commits at a time, reducing the number of round trips.
5508 </p>
5509 </li>
5510 <li>
5511 <p>
5512 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5513 walking fewer objects.
5514 </p>
5515 </li>
5516 </ul></div>
5517 </dd>
5518 <dt class="hdlist1">
5519 feature.manyFiles
5520 </dt>
5521 <dd>
5522 <p>
5523         Enable config options that optimize for repos with many files in the
5524         working directory. With many files, commands such as <code>git status</code> and
5525         <code>git checkout</code> may be slow and these new defaults improve performance:
5526 </p>
5527 <div class="ulist"><ul>
5528 <li>
5529 <p>
5530 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5531   checksum. Note that this will cause Git versions earlier than 2.13.0 to
5532   refuse to parse the index and Git versions earlier than 2.40.0 will report
5533   a corrupted index during <code>git fsck</code>.
5534 </p>
5535 </li>
5536 <li>
5537 <p>
5538 <code>index.version=4</code> enables path-prefix compression in the index.
5539 </p>
5540 </li>
5541 <li>
5542 <p>
5543 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5544 that mtime is working on your machine.
5545 </p>
5546 </li>
5547 </ul></div>
5548 </dd>
5549 <dt class="hdlist1">
5550 fetch.recurseSubmodules
5551 </dt>
5552 <dd>
5553 <p>
5554         This option controls whether <code>git fetch</code> (and the underlying fetch
5555         in <code>git pull</code>) will recursively fetch into populated submodules.
5556         This option can be set either to a boolean value or to <em>on-demand</em>.
5557         Setting it to a boolean changes the behavior of fetch and pull to
5558         recurse unconditionally into submodules when set to true or to not
5559         recurse at all when set to false. When set to <em>on-demand</em>, fetch and
5560         pull will only recurse into a populated submodule when its
5561         superproject retrieves a commit that updates the submodule&#8217;s
5562         reference.
5563         Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
5564 </p>
5565 </dd>
5566 <dt class="hdlist1">
5567 fetch.fsckObjects
5568 </dt>
5569 <dd>
5570 <p>
5571         If it is set to true, git-fetch-pack will check all fetched
5572         objects. See <code>transfer.fsckObjects</code> for what&#8217;s
5573         checked. Defaults to false. If not set, the value of
5574         <code>transfer.fsckObjects</code> is used instead.
5575 </p>
5576 </dd>
5577 <dt class="hdlist1">
5578 fetch.fsck.&lt;msg-id&gt;
5579 </dt>
5580 <dd>
5581 <p>
5582         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
5583         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5584         the <code>fsck.&lt;msg-id&gt;</code> documentation for details.
5585 </p>
5586 </dd>
5587 <dt class="hdlist1">
5588 fetch.fsck.skipList
5589 </dt>
5590 <dd>
5591 <p>
5592         Acts like <code>fsck.skipList</code>, but is used by
5593         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5594         the <code>fsck.skipList</code> documentation for details.
5595 </p>
5596 </dd>
5597 <dt class="hdlist1">
5598 fetch.unpackLimit
5599 </dt>
5600 <dd>
5601 <p>
5602         If the number of objects fetched over the Git native
5603         transfer is below this
5604         limit, then the objects will be unpacked into loose object
5605         files. However if the number of received objects equals or
5606         exceeds this limit then the received pack will be stored as
5607         a pack, after adding any missing delta bases.  Storing the
5608         pack from a push can make the push operation complete faster,
5609         especially on slow filesystems.  If not set, the value of
5610         <code>transfer.unpackLimit</code> is used instead.
5611 </p>
5612 </dd>
5613 <dt class="hdlist1">
5614 fetch.prune
5615 </dt>
5616 <dd>
5617 <p>
5618         If true, fetch will automatically behave as if the <code>--prune</code>
5619         option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
5620         and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.
5621 </p>
5622 </dd>
5623 <dt class="hdlist1">
5624 fetch.pruneTags
5625 </dt>
5626 <dd>
5627 <p>
5628         If true, fetch will automatically behave as if the
5629         <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
5630         if not set already. This allows for setting both this option
5631         and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
5632         refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
5633         section of <a href="git-fetch.html">git-fetch(1)</a>.
5634 </p>
5635 </dd>
5636 <dt class="hdlist1">
5637 fetch.all
5638 </dt>
5639 <dd>
5640 <p>
5641         If true, fetch will attempt to update all available remotes.
5642         This behavior can be overridden by passing <code>--no-all</code> or by
5643         explicitly specifying one or more remote(s) to fetch from.
5644         Defaults to false.
5645 </p>
5646 </dd>
5647 <dt class="hdlist1">
5648 fetch.output
5649 </dt>
5650 <dd>
5651 <p>
5652         Control how ref update status is printed. Valid values are
5653         <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
5654         OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.
5655 </p>
5656 </dd>
5657 <dt class="hdlist1">
5658 fetch.negotiationAlgorithm
5659 </dt>
5660 <dd>
5661 <p>
5662         Control how information about the commits in the local repository
5663         is sent when negotiating the contents of the packfile to be sent by
5664         the server.  Set to "consecutive" to use an algorithm that walks
5665         over consecutive commits checking each one.  Set to "skipping" to
5666         use an algorithm that skips commits in an effort to converge
5667         faster, but may result in a larger-than-necessary packfile; or set
5668         to "noop" to not send any information at all, which will almost
5669         certainly result in a larger-than-necessary packfile, but will skip
5670         the negotiation step.  Set to "default" to override settings made
5671         previously and use the default behaviour.  The default is normally
5672         "consecutive", but if <code>feature.experimental</code> is true, then the
5673         default is "skipping".  Unknown values will cause <em>git fetch</em> to
5674         error out.
5675 </p>
5676 <div class="paragraph"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
5677 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
5678 </dd>
5679 <dt class="hdlist1">
5680 fetch.showForcedUpdates
5681 </dt>
5682 <dd>
5683 <p>
5684         Set to false to enable <code>--no-show-forced-updates</code> in
5685         <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
5686         Defaults to true.
5687 </p>
5688 </dd>
5689 <dt class="hdlist1">
5690 fetch.parallel
5691 </dt>
5692 <dd>
5693 <p>
5694         Specifies the maximal number of fetch operations to be run in parallel
5695         at a time (submodules, or remotes when the <code>--multiple</code> option of
5696         <a href="git-fetch.html">git-fetch(1)</a> is in effect).
5697 </p>
5698 <div class="paragraph"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
5699 <div class="paragraph"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
5700 config setting.</p></div>
5701 </dd>
5702 <dt class="hdlist1">
5703 fetch.writeCommitGraph
5704 </dt>
5705 <dd>
5706 <p>
5707         Set to true to write a commit-graph after every <code>git fetch</code> command
5708         that downloads a pack-file from a remote. Using the <code>--split</code> option,
5709         most executions will create a very small commit-graph file on top of
5710         the existing commit-graph file(s). Occasionally, these files will
5711         merge and the write may take longer. Having an updated commit-graph
5712         file helps performance of many Git commands, including <code>git merge-base</code>,
5713         <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
5714 </p>
5715 </dd>
5716 <dt class="hdlist1">
5717 fetch.bundleURI
5718 </dt>
5719 <dd>
5720 <p>
5721         This value stores a URI for downloading Git object data from a bundle
5722         URI before performing an incremental fetch from the origin Git server.
5723         This is similar to how the <code>--bundle-uri</code> option behaves in
5724         <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
5725         <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
5726         list that is organized for incremental fetches.
5727 </p>
5728 <div class="paragraph"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
5729 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
5730 the new bundle URI.</p></div>
5731 </dd>
5732 <dt class="hdlist1">
5733 fetch.bundleCreationToken
5734 </dt>
5735 <dd>
5736 <p>
5737         When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
5738         list that uses the "creationToken" heuristic, this config value
5739         stores the maximum <code>creationToken</code> value of the downloaded bundles.
5740         This value is used to prevent downloading bundles in the future
5741         if the advertised <code>creationToken</code> is not strictly larger than this
5742         value.
5743 </p>
5744 <div class="paragraph"><p>The creation token values are chosen by the provider serving the specific
5745 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
5746 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
5747 </dd>
5748 <dt class="hdlist1">
5749 format.attach
5750 </dt>
5751 <dd>
5752 <p>
5753         Enable multipart/mixed attachments as the default for
5754         <em>format-patch</em>.  The value can also be a double quoted string
5755         which will enable attachments as the default and set the
5756         value as the boundary.  See the --attach option in
5757         <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
5758         value, set it to an empty string.
5759 </p>
5760 </dd>
5761 <dt class="hdlist1">
5762 format.from
5763 </dt>
5764 <dd>
5765 <p>
5766         Provides the default value for the <code>--from</code> option to format-patch.
5767         Accepts a boolean value, or a name and email address.  If false,
5768         format-patch defaults to <code>--no-from</code>, using commit authors directly in
5769         the "From:" field of patch mails.  If true, format-patch defaults to
5770         <code>--from</code>, using your committer identity in the "From:" field of patch
5771         mails and including a "From:" field in the body of the patch mail if
5772         different.  If set to a non-boolean value, format-patch uses that
5773         value instead of your committer identity.  Defaults to false.
5774 </p>
5775 </dd>
5776 <dt class="hdlist1">
5777 format.forceInBodyFrom
5778 </dt>
5779 <dd>
5780 <p>
5781         Provides the default value for the <code>--[no-]force-in-body-from</code>
5782         option to format-patch.  Defaults to false.
5783 </p>
5784 </dd>
5785 <dt class="hdlist1">
5786 format.numbered
5787 </dt>
5788 <dd>
5789 <p>
5790         A boolean which can enable or disable sequence numbers in patch
5791         subjects.  It defaults to "auto" which enables it only if there
5792         is more than one patch.  It can be enabled or disabled for all
5793         messages by setting it to "true" or "false".  See --numbered
5794         option in <a href="git-format-patch.html">git-format-patch(1)</a>.
5795 </p>
5796 </dd>
5797 <dt class="hdlist1">
5798 format.headers
5799 </dt>
5800 <dd>
5801 <p>
5802         Additional email headers to include in a patch to be submitted
5803         by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.
5804 </p>
5805 </dd>
5806 <dt class="hdlist1">
5807 format.to
5808 </dt>
5809 <dt class="hdlist1">
5810 format.cc
5811 </dt>
5812 <dd>
5813 <p>
5814         Additional recipients to include in a patch to be submitted
5815         by mail.  See the --to and --cc options in
5816         <a href="git-format-patch.html">git-format-patch(1)</a>.
5817 </p>
5818 </dd>
5819 <dt class="hdlist1">
5820 format.subjectPrefix
5821 </dt>
5822 <dd>
5823 <p>
5824         The default for format-patch is to output files with the <em>[PATCH]</em>
5825         subject prefix. Use this variable to change that prefix.
5826 </p>
5827 </dd>
5828 <dt class="hdlist1">
5829 format.coverFromDescription
5830 </dt>
5831 <dd>
5832 <p>
5833         The default mode for format-patch to determine which parts of
5834         the cover letter will be populated using the branch&#8217;s
5835         description. See the <code>--cover-from-description</code> option in
5836         <a href="git-format-patch.html">git-format-patch(1)</a>.
5837 </p>
5838 </dd>
5839 <dt class="hdlist1">
5840 format.signature
5841 </dt>
5842 <dd>
5843 <p>
5844         The default for format-patch is to output a signature containing
5845         the Git version number. Use this variable to change that default.
5846         Set this variable to the empty string ("") to suppress
5847         signature generation.
5848 </p>
5849 </dd>
5850 <dt class="hdlist1">
5851 format.signatureFile
5852 </dt>
5853 <dd>
5854 <p>
5855         Works just like format.signature except the contents of the
5856         file specified by this variable will be used as the signature.
5857 </p>
5858 </dd>
5859 <dt class="hdlist1">
5860 format.suffix
5861 </dt>
5862 <dd>
5863 <p>
5864         The default for format-patch is to output files with the suffix
5865         <code>.patch</code>. Use this variable to change that suffix (make sure to
5866         include the dot if you want it).
5867 </p>
5868 </dd>
5869 <dt class="hdlist1">
5870 format.encodeEmailHeaders
5871 </dt>
5872 <dd>
5873 <p>
5874         Encode email headers that have non-ASCII characters with
5875         "Q-encoding" (described in RFC 2047) for email transmission.
5876         Defaults to true.
5877 </p>
5878 </dd>
5879 <dt class="hdlist1">
5880 format.pretty
5881 </dt>
5882 <dd>
5883 <p>
5884         The default pretty format for log/show/whatchanged command.
5885         See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
5886         <a href="git-whatchanged.html">git-whatchanged(1)</a>.
5887 </p>
5888 </dd>
5889 <dt class="hdlist1">
5890 format.thread
5891 </dt>
5892 <dd>
5893 <p>
5894         The default threading style for <em>git format-patch</em>.  Can be
5895         a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
5896         makes every mail a reply to the head of the series,
5897         where the head is chosen from the cover letter, the
5898         <code>--in-reply-to</code>, and the first patch mail, in this order.
5899         <code>deep</code> threading makes every mail a reply to the previous one.
5900         A true boolean value is the same as <code>shallow</code>, and a false
5901         value disables threading.
5902 </p>
5903 </dd>
5904 <dt class="hdlist1">
5905 format.signOff
5906 </dt>
5907 <dd>
5908 <p>
5909         A boolean value which lets you enable the <code>-s/--signoff</code> option of
5910         format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
5911         patch should be a conscious act and means that you certify you have
5912         the rights to submit this work under the same open source license.
5913         Please see the <em>SubmittingPatches</em> document for further discussion.
5914 </p>
5915 </dd>
5916 <dt class="hdlist1">
5917 format.coverLetter
5918 </dt>
5919 <dd>
5920 <p>
5921         A boolean that controls whether to generate a cover-letter when
5922         format-patch is invoked, but in addition can be set to "auto", to
5923         generate a cover-letter only when there&#8217;s more than one patch.
5924         Default is false.
5925 </p>
5926 </dd>
5927 <dt class="hdlist1">
5928 format.outputDirectory
5929 </dt>
5930 <dd>
5931 <p>
5932         Set a custom directory to store the resulting files instead of the
5933         current working directory. All directory components will be created.
5934 </p>
5935 </dd>
5936 <dt class="hdlist1">
5937 format.filenameMaxLength
5938 </dt>
5939 <dd>
5940 <p>
5941         The maximum length of the output filenames generated by the
5942         <code>format-patch</code> command; defaults to 64.  Can be overridden
5943         by the <code>--filename-max-length=&lt;n&gt;</code> command line option.
5944 </p>
5945 </dd>
5946 <dt class="hdlist1">
5947 format.useAutoBase
5948 </dt>
5949 <dd>
5950 <p>
5951         A boolean value which lets you enable the <code>--base=auto</code> option of
5952         format-patch by default. Can also be set to "whenAble" to allow
5953         enabling <code>--base=auto</code> if a suitable base is available, but to skip
5954         adding base info otherwise without the format dying.
5955 </p>
5956 </dd>
5957 <dt class="hdlist1">
5958 format.notes
5959 </dt>
5960 <dd>
5961 <p>
5962         Provides the default value for the <code>--notes</code> option to
5963         format-patch. Accepts a boolean value, or a ref which specifies
5964         where to get notes. If false, format-patch defaults to
5965         <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
5966         set to a non-boolean value, format-patch defaults to
5967         <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
5968         to false.
5969 </p>
5970 <div class="paragraph"><p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
5971 instead.</p></div>
5972 <div class="paragraph"><p>This configuration can be specified multiple times in order to allow
5973 multiple notes refs to be included. In that case, it will behave
5974 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
5975 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
5976 also show notes from that notes ref and a value of <code>false</code> will negate
5977 previous configurations and not show notes.</p></div>
5978 <div class="paragraph"><p>For example,</p></div>
5979 <div class="listingblock">
5980 <div class="content">
5981 <pre><code>[format]
5982         notes = true
5983         notes = foo
5984         notes = false
5985         notes = bar</code></pre>
5986 </div></div>
5987 <div class="paragraph"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
5988 </dd>
5989 <dt class="hdlist1">
5990 format.mboxrd
5991 </dt>
5992 <dd>
5993 <p>
5994         A boolean value which enables the robust "mboxrd" format when
5995         <code>--stdout</code> is in use to escape "^&gt;+From " lines.
5996 </p>
5997 </dd>
5998 <dt class="hdlist1">
5999 format.noprefix
6000 </dt>
6001 <dd>
6002 <p>
6003         If set, do not show any source or destination prefix in patches.
6004         This is equivalent to the <code>diff.noprefix</code> option used by <code>git
6005         diff</code> (but which is not respected by <code>format-patch</code>). Note that
6006         by setting this, the receiver of any patches you generate will
6007         have to apply them using the <code>-p0</code> option.
6008 </p>
6009 </dd>
6010 <dt class="hdlist1">
6011 filter.&lt;driver&gt;.clean
6012 </dt>
6013 <dd>
6014 <p>
6015         The command which is used to convert the content of a worktree
6016         file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
6017         details.
6018 </p>
6019 </dd>
6020 <dt class="hdlist1">
6021 filter.&lt;driver&gt;.smudge
6022 </dt>
6023 <dd>
6024 <p>
6025         The command which is used to convert the content of a blob
6026         object to a worktree file upon checkout.  See
6027         <a href="gitattributes.html">gitattributes(5)</a> for details.
6028 </p>
6029 </dd>
6030 <dt class="hdlist1">
6031 fsck.&lt;msg-id&gt;
6032 </dt>
6033 <dd>
6034 <p>
6035         During fsck git may find issues with legacy data which
6036         wouldn&#8217;t be generated by current versions of git, and which
6037         wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
6038         set. This feature is intended to support working with legacy
6039         repositories containing such data.
6040 </p>
6041 <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
6042 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
6043 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
6044 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
6045 same applies for the corresponding <code>receive.fsck.*</code> and
6046 <code>fetch.fsck.*</code>. variables.</p></div>
6047 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
6048 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
6049 fall back on the <code>fsck.&lt;msg-id&gt;</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>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
6053 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
6054 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
6055 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
6056 with the message ID, e.g. "missingEmail: invalid author/committer
6057 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
6058 will hide that issue.</p></div>
6059 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
6060 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6061 problematic objects share to be ignored, as doing the latter will
6062 allow new instances of the same breakages go unnoticed.</p></div>
6063 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
6064 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
6065 will only cause git to warn.</p></div>
6066 <div class="paragraph"><p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
6067 values of <code>&lt;msg-id&gt;</code>.</p></div>
6068 </dd>
6069 <dt class="hdlist1">
6070 fsck.skipList
6071 </dt>
6072 <dd>
6073 <p>
6074         The path to a list of object names (i.e. one unabbreviated SHA-1 per
6075         line) that are known to be broken in a non-fatal way and should
6076         be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
6077         lines, and any leading and trailing whitespace are ignored. Everything
6078         but a SHA-1 per line will error out on older versions.
6079 </p>
6080 <div class="paragraph"><p>This feature is useful when an established project should be accepted
6081 despite early commits containing errors that can be safely ignored,
6082 such as invalid committer email addresses.  Note: corrupt objects
6083 cannot be skipped with this setting.</p></div>
6084 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
6085 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6086 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6087 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6088 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
6089 uniformly configure the same fsck settings in different circumstances,
6090 all three of them must be set to the same values.</p></div>
6091 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
6092 list should be sorted. This was never a requirement; the object names
6093 could appear in any order, but when reading the list we tracked whether
6094 the list was sorted for the purposes of an internal binary search
6095 implementation, which could save itself some work with an already sorted
6096 list. Unless you had a humongous list there was no reason to go out of
6097 your way to pre-sort the list. After Git version 2.20 a hash implementation
6098 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
6099 </dd>
6100 <dt class="hdlist1">
6101 fsmonitor.allowRemote
6102 </dt>
6103 <dd>
6104 <p>
6105     By default, the fsmonitor daemon refuses to work with network-mounted
6106     repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6107     behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6108 </p>
6109 </dd>
6110 <dt class="hdlist1">
6111 fsmonitor.socketDir
6112 </dt>
6113 <dd>
6114 <p>
6115     This Mac OS-specific option, if set, specifies the directory in
6116     which to create the Unix domain socket used for communication
6117     between the fsmonitor daemon and various Git commands. The directory must
6118     reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
6119     is set to <code>true</code>.
6120 </p>
6121 </dd>
6122 <dt class="hdlist1">
6123 gc.aggressiveDepth
6124 </dt>
6125 <dd>
6126 <p>
6127         The depth parameter used in the delta compression
6128         algorithm used by <em>git gc --aggressive</em>.  This defaults
6129         to 50, which is the default for the <code>--depth</code> option when
6130         <code>--aggressive</code> isn&#8217;t in use.
6131 </p>
6132 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
6133 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6134 </dd>
6135 <dt class="hdlist1">
6136 gc.aggressiveWindow
6137 </dt>
6138 <dd>
6139 <p>
6140         The window size parameter used in the delta compression
6141         algorithm used by <em>git gc --aggressive</em>.  This defaults
6142         to 250, which is a much more aggressive window size than
6143         the default <code>--window</code> of 10.
6144 </p>
6145 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
6146 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6147 </dd>
6148 <dt class="hdlist1">
6149 gc.auto
6150 </dt>
6151 <dd>
6152 <p>
6153         When there are approximately more than this many loose
6154         objects in the repository, <code>git gc --auto</code> will pack them.
6155         Some Porcelain commands use this command to perform a
6156         light-weight garbage collection from time to time.  The
6157         default value is 6700.
6158 </p>
6159 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
6160 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
6161 otherwise use to determine if there&#8217;s work to do, such as
6162 <code>gc.autoPackLimit</code>.</p></div>
6163 </dd>
6164 <dt class="hdlist1">
6165 gc.autoPackLimit
6166 </dt>
6167 <dd>
6168 <p>
6169         When there are more than this many packs that are not
6170         marked with <code>*.keep</code> file in the repository, <code>git gc
6171         --auto</code> consolidates them into one larger pack.  The
6172         default value is 50.  Setting this to 0 disables it.
6173         Setting <code>gc.auto</code> to 0 will also disable this.
6174 </p>
6175 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6176 use, it&#8217;ll affect how the auto pack limit works.</p></div>
6177 </dd>
6178 <dt class="hdlist1">
6179 gc.autoDetach
6180 </dt>
6181 <dd>
6182 <p>
6183         Make <code>git gc --auto</code> return immediately and run in the background
6184         if the system supports it. Default is true.
6185 </p>
6186 </dd>
6187 <dt class="hdlist1">
6188 gc.bigPackThreshold
6189 </dt>
6190 <dd>
6191 <p>
6192         If non-zero, all non-cruft packs larger than this limit are kept
6193         when <code>git gc</code> is run. This is very similar to
6194         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6195         the threshold are kept, not just the largest pack. Defaults to
6196         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6197 </p>
6198 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6199 this configuration variable is ignored, all packs except the base pack
6200 will be repacked. After this the number of packs should go below
6201 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6202 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6203 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6204 will also be excluded (this is the equivalent of running <code>git gc</code> with
6205 <code>--keep-largest-pack</code>).</p></div>
6206 </dd>
6207 <dt class="hdlist1">
6208 gc.writeCommitGraph
6209 </dt>
6210 <dd>
6211 <p>
6212         If true, then gc will rewrite the commit-graph file when
6213         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6214         the commit-graph will be updated if housekeeping is
6215         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
6216         for details.
6217 </p>
6218 </dd>
6219 <dt class="hdlist1">
6220 gc.logExpiry
6221 </dt>
6222 <dd>
6223 <p>
6224         If the file gc.log exists, then <code>git gc --auto</code> will print
6225         its content and exit with status zero instead of running
6226         unless that file is more than <em>gc.logExpiry</em> old.  Default is
6227         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
6228         value.
6229 </p>
6230 </dd>
6231 <dt class="hdlist1">
6232 gc.packRefs
6233 </dt>
6234 <dd>
6235 <p>
6236         Running <code>git pack-refs</code> in a repository renders it
6237         unclonable by Git versions prior to 1.5.1.2 over dumb
6238         transports such as HTTP.  This variable determines whether
6239         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6240         to enable it within all non-bare repos or it can be set to a
6241         boolean value.  The default is <code>true</code>.
6242 </p>
6243 </dd>
6244 <dt class="hdlist1">
6245 gc.cruftPacks
6246 </dt>
6247 <dd>
6248 <p>
6249         Store unreachable objects in a cruft pack (see
6250         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
6251         is <code>true</code>.
6252 </p>
6253 </dd>
6254 <dt class="hdlist1">
6255 gc.maxCruftSize
6256 </dt>
6257 <dd>
6258 <p>
6259         Limit the size of new cruft packs when repacking. When
6260         specified in addition to <code>--max-cruft-size</code>, the command line
6261         option takes priority. See the <code>--max-cruft-size</code> option of
6262         <a href="git-repack.html">git-repack(1)</a>.
6263 </p>
6264 </dd>
6265 <dt class="hdlist1">
6266 gc.pruneExpire
6267 </dt>
6268 <dd>
6269 <p>
6270         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6271         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6272         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
6273         grace period with this config variable.  The value "now" may be
6274         used to disable this grace period and always prune unreachable
6275         objects immediately, or "never" may be used to suppress pruning.
6276         This feature helps prevent corruption when <em>git gc</em> runs
6277         concurrently with another process writing to the repository; see
6278         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
6279 </p>
6280 </dd>
6281 <dt class="hdlist1">
6282 gc.worktreePruneExpire
6283 </dt>
6284 <dd>
6285 <p>
6286         When <em>git gc</em> is run, it calls
6287         <em>git worktree prune --expire 3.months.ago</em>.
6288         This config variable can be used to set a different grace
6289         period. The value "now" may be used to disable the grace
6290         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
6291         may be used to suppress pruning.
6292 </p>
6293 </dd>
6294 <dt class="hdlist1">
6295 gc.reflogExpire
6296 </dt>
6297 <dt class="hdlist1">
6298 gc.&lt;pattern&gt;.reflogExpire
6299 </dt>
6300 <dd>
6301 <p>
6302         <em>git reflog expire</em> removes reflog entries older than
6303         this time; defaults to 90 days. The value "now" expires all
6304         entries immediately, and "never" suppresses expiration
6305         altogether. With "&lt;pattern&gt;" (e.g.
6306         "refs/stash") in the middle the setting applies only to
6307         the refs that match the &lt;pattern&gt;.
6308 </p>
6309 </dd>
6310 <dt class="hdlist1">
6311 gc.reflogExpireUnreachable
6312 </dt>
6313 <dt class="hdlist1">
6314 gc.&lt;pattern&gt;.reflogExpireUnreachable
6315 </dt>
6316 <dd>
6317 <p>
6318         <em>git reflog expire</em> removes reflog entries older than
6319         this time and are not reachable from the current tip;
6320         defaults to 30 days. The value "now" expires all entries
6321         immediately, and "never" suppresses expiration altogether.
6322         With "&lt;pattern&gt;" (e.g. "refs/stash")
6323         in the middle, the setting applies only to the refs that
6324         match the &lt;pattern&gt;.
6325 </p>
6326 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
6327 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6328 or rebase occurring.  Since these changes are not part of the current
6329 project most users will want to expire them sooner, which is why the
6330 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6331 </dd>
6332 <dt class="hdlist1">
6333 gc.recentObjectsHook
6334 </dt>
6335 <dd>
6336 <p>
6337         When considering whether or not to remove an object (either when
6338         generating a cruft pack or storing unreachable objects as
6339         loose), use the shell to execute the specified command(s).
6340         Interpret their output as object IDs which Git will consider as
6341         "recent", regardless of their age. By treating their mtimes as
6342         "now", any objects (and their descendants) mentioned in the
6343         output will be kept regardless of their true age.
6344 </p>
6345 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
6346 else. Objects which cannot be found in the repository are ignored.
6347 Multiple hooks are supported, but all must exit successfully, else the
6348 operation (either generating a cruft pack or unpacking unreachable
6349 objects) will be halted.</p></div>
6350 </dd>
6351 <dt class="hdlist1">
6352 gc.repackFilter
6353 </dt>
6354 <dd>
6355 <p>
6356         When repacking, use the specified filter to move certain
6357         objects into a separate packfile.  See the
6358         <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.
6359 </p>
6360 </dd>
6361 <dt class="hdlist1">
6362 gc.repackFilterTo
6363 </dt>
6364 <dd>
6365 <p>
6366         When repacking and using a filter, see <code>gc.repackFilter</code>, the
6367         specified location will be used to create the packfile
6368         containing the filtered out objects. <strong>WARNING:</strong> The
6369         specified location should be accessible, using for example the
6370         Git alternates mechanism, otherwise the repo could be
6371         considered corrupt by Git as it migh not be able to access the
6372         objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
6373         of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
6374         section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.
6375 </p>
6376 </dd>
6377 <dt class="hdlist1">
6378 gc.rerereResolved
6379 </dt>
6380 <dd>
6381 <p>
6382         Records of conflicted merge you resolved earlier are
6383         kept for this many days when <em>git rerere gc</em> is run.
6384         You can also use more human-readable "1.month.ago", etc.
6385         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6386 </p>
6387 </dd>
6388 <dt class="hdlist1">
6389 gc.rerereUnresolved
6390 </dt>
6391 <dd>
6392 <p>
6393         Records of conflicted merge you have not resolved are
6394         kept for this many days when <em>git rerere gc</em> is run.
6395         You can also use more human-readable "1.month.ago", etc.
6396         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6397 </p>
6398 </dd>
6399 <dt class="hdlist1">
6400 gitcvs.commitMsgAnnotation
6401 </dt>
6402 <dd>
6403 <p>
6404         Append this string to each commit message. Set to empty string
6405         to disable this feature. Defaults to "via git-CVS emulator".
6406 </p>
6407 </dd>
6408 <dt class="hdlist1">
6409 gitcvs.enabled
6410 </dt>
6411 <dd>
6412 <p>
6413         Whether the CVS server interface is enabled for this repository.
6414         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6415 </p>
6416 </dd>
6417 <dt class="hdlist1">
6418 gitcvs.logFile
6419 </dt>
6420 <dd>
6421 <p>
6422         Path to a log file where the CVS server interface well&#8230; logs
6423         various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6424 </p>
6425 </dd>
6426 <dt class="hdlist1">
6427 gitcvs.usecrlfattr
6428 </dt>
6429 <dd>
6430 <p>
6431         If true, the server will look up the end-of-line conversion
6432         attributes for files to determine the <code>-k</code> modes to use. If
6433         the attributes force Git to treat a file as text,
6434         the <code>-k</code> mode will be left blank so CVS clients will
6435         treat it as text. If they suppress text conversion, the file
6436         will be set with <em>-kb</em> mode, which suppresses any newline munging
6437         the client might otherwise do. If the attributes do not allow
6438         the file type to be determined, then <code>gitcvs.allBinary</code> is
6439         used. See <a href="gitattributes.html">gitattributes(5)</a>.
6440 </p>
6441 </dd>
6442 <dt class="hdlist1">
6443 gitcvs.allBinary
6444 </dt>
6445 <dd>
6446 <p>
6447         This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6448         the correct <em>-kb</em> mode to use. If true, all
6449         unresolved files are sent to the client in
6450         mode <em>-kb</em>. This causes the client to treat them
6451         as binary files, which suppresses any newline munging it
6452         otherwise might do. Alternatively, if it is set to "guess",
6453         then the contents of the file are examined to decide if
6454         it is binary, similar to <code>core.autocrlf</code>.
6455 </p>
6456 </dd>
6457 <dt class="hdlist1">
6458 gitcvs.dbName
6459 </dt>
6460 <dd>
6461 <p>
6462         Database used by git-cvsserver to cache revision information
6463         derived from the Git repository. The exact meaning depends on the
6464         used database driver, for SQLite (which is the default driver) this
6465         is a filename. Supports variable substitution (see
6466         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6467         Default: <em>%Ggitcvs.%m.sqlite</em>
6468 </p>
6469 </dd>
6470 <dt class="hdlist1">
6471 gitcvs.dbDriver
6472 </dt>
6473 <dd>
6474 <p>
6475         Used Perl DBI driver. You can specify any available driver
6476         for this here, but it might not work. git-cvsserver is tested
6477         with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6478         reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6479         May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6480         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6481 </p>
6482 </dd>
6483 <dt class="hdlist1">
6484 gitcvs.dbUser, gitcvs.dbPass
6485 </dt>
6486 <dd>
6487 <p>
6488         Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6489         since SQLite has no concept of database users and/or passwords.
6490         <em>gitcvs.dbUser</em> supports variable substitution (see
6491         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
6492 </p>
6493 </dd>
6494 <dt class="hdlist1">
6495 gitcvs.dbTableNamePrefix
6496 </dt>
6497 <dd>
6498 <p>
6499         Database table name prefix.  Prepended to the names of any
6500         database tables used, allowing a single database to be used
6501         for several repositories.  Supports variable substitution (see
6502         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
6503         characters will be replaced with underscores.
6504 </p>
6505 </dd>
6506 </dl></div>
6507 <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6508 <code>gitcvs.allBinary</code> can also be specified as
6509 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
6510 is one of "ext" and "pserver") to make them apply only for the given
6511 access method.</p></div>
6512 <div class="dlist"><dl>
6513 <dt class="hdlist1">
6514 gitweb.category
6515 </dt>
6516 <dt class="hdlist1">
6517 gitweb.description
6518 </dt>
6519 <dt class="hdlist1">
6520 gitweb.owner
6521 </dt>
6522 <dt class="hdlist1">
6523 gitweb.url
6524 </dt>
6525 <dd>
6526 <p>
6527         See <a href="gitweb.html">gitweb(1)</a> for description.
6528 </p>
6529 </dd>
6530 <dt class="hdlist1">
6531 gitweb.avatar
6532 </dt>
6533 <dt class="hdlist1">
6534 gitweb.blame
6535 </dt>
6536 <dt class="hdlist1">
6537 gitweb.grep
6538 </dt>
6539 <dt class="hdlist1">
6540 gitweb.highlight
6541 </dt>
6542 <dt class="hdlist1">
6543 gitweb.patches
6544 </dt>
6545 <dt class="hdlist1">
6546 gitweb.pickaxe
6547 </dt>
6548 <dt class="hdlist1">
6549 gitweb.remote_heads
6550 </dt>
6551 <dt class="hdlist1">
6552 gitweb.showSizes
6553 </dt>
6554 <dt class="hdlist1">
6555 gitweb.snapshot
6556 </dt>
6557 <dd>
6558 <p>
6559         See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
6560 </p>
6561 </dd>
6562 <dt class="hdlist1">
6563 grep.lineNumber
6564 </dt>
6565 <dd>
6566 <p>
6567         If set to true, enable <code>-n</code> option by default.
6568 </p>
6569 </dd>
6570 <dt class="hdlist1">
6571 grep.column
6572 </dt>
6573 <dd>
6574 <p>
6575         If set to true, enable the <code>--column</code> option by default.
6576 </p>
6577 </dd>
6578 <dt class="hdlist1">
6579 grep.patternType
6580 </dt>
6581 <dd>
6582 <p>
6583         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
6584         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
6585         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
6586         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
6587         between <em>basic</em> and <em>extended</em>.
6588 </p>
6589 </dd>
6590 <dt class="hdlist1">
6591 grep.extendedRegexp
6592 </dt>
6593 <dd>
6594 <p>
6595         If set to true, enable <code>--extended-regexp</code> option by default. This
6596         option is ignored when the <code>grep.patternType</code> option is set to a value
6597         other than <em>default</em>.
6598 </p>
6599 </dd>
6600 <dt class="hdlist1">
6601 grep.threads
6602 </dt>
6603 <dd>
6604 <p>
6605         Number of grep worker threads to use. If unset (or set to 0), Git will
6606         use as many threads as the number of logical cores available.
6607 </p>
6608 </dd>
6609 <dt class="hdlist1">
6610 grep.fullName
6611 </dt>
6612 <dd>
6613 <p>
6614         If set to true, enable <code>--full-name</code> option by default.
6615 </p>
6616 </dd>
6617 <dt class="hdlist1">
6618 grep.fallbackToNoIndex
6619 </dt>
6620 <dd>
6621 <p>
6622         If set to true, fall back to git grep --no-index if git grep
6623         is executed outside of a git repository.  Defaults to false.
6624 </p>
6625 </dd>
6626 <dt class="hdlist1">
6627 gpg.program
6628 </dt>
6629 <dd>
6630 <p>
6631         Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
6632         making or verifying a PGP signature. The program must support the
6633         same command-line interface as GPG, namely, to verify a detached
6634         signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
6635         program is expected to signal a good signature by exiting with
6636         code 0.  To generate an ASCII-armored detached signature, the
6637         standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
6638         signed, and the program is expected to send the result to its
6639         standard output.
6640 </p>
6641 </dd>
6642 <dt class="hdlist1">
6643 gpg.format
6644 </dt>
6645 <dd>
6646 <p>
6647         Specifies which key format to use when signing with <code>--gpg-sign</code>.
6648         Default is "openpgp". Other possible values are "x509", "ssh".
6649 </p>
6650 <div class="paragraph"><p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
6651 based on the selected <code>gpg.format</code>.</p></div>
6652 </dd>
6653 <dt class="hdlist1">
6654 gpg.&lt;format&gt;.program
6655 </dt>
6656 <dd>
6657 <p>
6658         Use this to customize the program used for the signing format you
6659         chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
6660         be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
6661         value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".
6662 </p>
6663 </dd>
6664 <dt class="hdlist1">
6665 gpg.minTrustLevel
6666 </dt>
6667 <dd>
6668 <p>
6669         Specifies a minimum trust level for signature verification.  If
6670         this option is unset, then signature verification for merge
6671         operations requires a key with at least <code>marginal</code> trust.  Other
6672         operations that perform signature verification require a key
6673         with at least <code>undefined</code> trust.  Setting this option overrides
6674         the required trust-level for all operations.  Supported values,
6675         in increasing order of significance:
6676 </p>
6677 <div class="ulist"><ul>
6678 <li>
6679 <p>
6680 <code>undefined</code>
6681 </p>
6682 </li>
6683 <li>
6684 <p>
6685 <code>never</code>
6686 </p>
6687 </li>
6688 <li>
6689 <p>
6690 <code>marginal</code>
6691 </p>
6692 </li>
6693 <li>
6694 <p>
6695 <code>fully</code>
6696 </p>
6697 </li>
6698 <li>
6699 <p>
6700 <code>ultimate</code>
6701 </p>
6702 </li>
6703 </ul></div>
6704 </dd>
6705 <dt class="hdlist1">
6706 gpg.ssh.defaultKeyCommand
6707 </dt>
6708 <dd>
6709 <p>
6710         This command will be run when user.signingkey is not set and a ssh
6711         signature is requested. On successful exit a valid ssh public key
6712         prefixed with <code>key::</code> is expected in the first line of its output.
6713         This allows for a script doing a dynamic lookup of the correct public
6714         key when it is impractical to statically configure <code>user.signingKey</code>.
6715         For example when keys or SSH Certificates are rotated frequently or
6716         selection of the right key depends on external factors unknown to git.
6717 </p>
6718 </dd>
6719 <dt class="hdlist1">
6720 gpg.ssh.allowedSignersFile
6721 </dt>
6722 <dd>
6723 <p>
6724         A file containing ssh public keys which you are willing to trust.
6725         The file consists of one or more lines of principals followed by an ssh
6726         public key.
6727         e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
6728         See ssh-keygen(1) "ALLOWED SIGNERS" for details.
6729         The principal is only used to identify the key and is available when
6730         verifying a signature.
6731 </p>
6732 <div class="paragraph"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
6733 between valid signatures and trusted signatures the trust level of a signature
6734 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
6735 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
6736 <div class="paragraph"><p>This file can be set to a location outside of the repository and every developer
6737 maintains their own trust store. A central repository server could generate this
6738 file automatically from ssh keys with push access to verify the code against.
6739 In a corporate setting this file is probably generated at a global location
6740 from automation that already handles developer ssh keys.</p></div>
6741 <div class="paragraph"><p>A repository that only allows signed commits can store the file
6742 in the repository itself using a path relative to the top-level of the working tree.
6743 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
6744 <div class="paragraph"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
6745 valid-before options. Git will mark signatures as valid if the signing key was
6746 valid at the time of the signature&#8217;s creation. This allows users to change a
6747 signing key without invalidating all previously made signatures.</p></div>
6748 <div class="paragraph"><p>Using a SSH CA key with the cert-authority option
6749 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p></div>
6750 </dd>
6751 <dt class="hdlist1">
6752 gpg.ssh.revocationFile
6753 </dt>
6754 <dd>
6755 <p>
6756         Either a SSH KRL or a list of revoked public keys (without the principal prefix).
6757         See ssh-keygen(1) for details.
6758         If a public key is found in this file then it will always be treated
6759         as having trust level "never" and signatures will show as invalid.
6760 </p>
6761 </dd>
6762 <dt class="hdlist1">
6763 gui.commitMsgWidth
6764 </dt>
6765 <dd>
6766 <p>
6767         Defines how wide the commit message window is in the
6768         <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
6769 </p>
6770 </dd>
6771 <dt class="hdlist1">
6772 gui.diffContext
6773 </dt>
6774 <dd>
6775 <p>
6776         Specifies how many context lines should be used in calls to diff
6777         made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
6778 </p>
6779 </dd>
6780 <dt class="hdlist1">
6781 gui.displayUntracked
6782 </dt>
6783 <dd>
6784 <p>
6785         Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
6786         in the file list. The default is "true".
6787 </p>
6788 </dd>
6789 <dt class="hdlist1">
6790 gui.encoding
6791 </dt>
6792 <dd>
6793 <p>
6794         Specifies the default character encoding to use for displaying of
6795         file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
6796         It can be overridden by setting the <em>encoding</em> attribute
6797         for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
6798         If this option is not set, the tools default to the
6799         locale encoding.
6800 </p>
6801 </dd>
6802 <dt class="hdlist1">
6803 gui.matchTrackingBranch
6804 </dt>
6805 <dd>
6806 <p>
6807         Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
6808         default to tracking remote branches with matching names or
6809         not. Default: "false".
6810 </p>
6811 </dd>
6812 <dt class="hdlist1">
6813 gui.newBranchTemplate
6814 </dt>
6815 <dd>
6816 <p>
6817         Is used as a suggested name when creating new branches using the
6818         <a href="git-gui.html">git-gui(1)</a>.
6819 </p>
6820 </dd>
6821 <dt class="hdlist1">
6822 gui.pruneDuringFetch
6823 </dt>
6824 <dd>
6825 <p>
6826         "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
6827         performing a fetch. The default value is "false".
6828 </p>
6829 </dd>
6830 <dt class="hdlist1">
6831 gui.trustmtime
6832 </dt>
6833 <dd>
6834 <p>
6835         Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
6836         timestamp or not. By default the timestamps are not trusted.
6837 </p>
6838 </dd>
6839 <dt class="hdlist1">
6840 gui.spellingDictionary
6841 </dt>
6842 <dd>
6843 <p>
6844         Specifies the dictionary used for spell checking commit messages in
6845         the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
6846         off.
6847 </p>
6848 </dd>
6849 <dt class="hdlist1">
6850 gui.fastCopyBlame
6851 </dt>
6852 <dd>
6853 <p>
6854         If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
6855         location detection. It makes blame significantly faster on huge
6856         repositories at the expense of less thorough copy detection.
6857 </p>
6858 </dd>
6859 <dt class="hdlist1">
6860 gui.copyBlameThreshold
6861 </dt>
6862 <dd>
6863 <p>
6864         Specifies the threshold to use in <em>git gui blame</em> original location
6865         detection, measured in alphanumeric characters. See the
6866         <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
6867 </p>
6868 </dd>
6869 <dt class="hdlist1">
6870 gui.blamehistoryctx
6871 </dt>
6872 <dd>
6873 <p>
6874         Specifies the radius of history context in days to show in
6875         <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
6876         Context</code> menu item is invoked from <em>git gui blame</em>. If this
6877         variable is set to zero, the whole history is shown.
6878 </p>
6879 </dd>
6880 <dt class="hdlist1">
6881 guitool.&lt;name&gt;.cmd
6882 </dt>
6883 <dd>
6884 <p>
6885         Specifies the shell command line to execute when the corresponding item
6886         of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
6887         mandatory for every tool. The command is executed from the root of
6888         the working directory, and in the environment it receives the name of
6889         the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
6890         <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
6891         the head is detached, <em>CUR_BRANCH</em> is empty).
6892 </p>
6893 </dd>
6894 <dt class="hdlist1">
6895 guitool.&lt;name&gt;.needsFile
6896 </dt>
6897 <dd>
6898 <p>
6899         Run the tool only if a diff is selected in the GUI. It guarantees
6900         that <em>FILENAME</em> is not empty.
6901 </p>
6902 </dd>
6903 <dt class="hdlist1">
6904 guitool.&lt;name&gt;.noConsole
6905 </dt>
6906 <dd>
6907 <p>
6908         Run the command silently, without creating a window to display its
6909         output.
6910 </p>
6911 </dd>
6912 <dt class="hdlist1">
6913 guitool.&lt;name&gt;.noRescan
6914 </dt>
6915 <dd>
6916 <p>
6917         Don&#8217;t rescan the working directory for changes after the tool
6918         finishes execution.
6919 </p>
6920 </dd>
6921 <dt class="hdlist1">
6922 guitool.&lt;name&gt;.confirm
6923 </dt>
6924 <dd>
6925 <p>
6926         Show a confirmation dialog before actually running the tool.
6927 </p>
6928 </dd>
6929 <dt class="hdlist1">
6930 guitool.&lt;name&gt;.argPrompt
6931 </dt>
6932 <dd>
6933 <p>
6934         Request a string argument from the user, and pass it to the tool
6935         through the <code>ARGS</code> environment variable. Since requesting an
6936         argument implies confirmation, the <em>confirm</em> option has no effect
6937         if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
6938         the dialog uses a built-in generic prompt; otherwise the exact
6939         value of the variable is used.
6940 </p>
6941 </dd>
6942 <dt class="hdlist1">
6943 guitool.&lt;name&gt;.revPrompt
6944 </dt>
6945 <dd>
6946 <p>
6947         Request a single valid revision from the user, and set the
6948         <code>REVISION</code> environment variable. In other aspects this option
6949         is similar to <em>argPrompt</em>, and can be used together with it.
6950 </p>
6951 </dd>
6952 <dt class="hdlist1">
6953 guitool.&lt;name&gt;.revUnmerged
6954 </dt>
6955 <dd>
6956 <p>
6957         Show only unmerged branches in the <em>revPrompt</em> subdialog.
6958         This is useful for tools similar to merge or rebase, but not
6959         for things like checkout or reset.
6960 </p>
6961 </dd>
6962 <dt class="hdlist1">
6963 guitool.&lt;name&gt;.title
6964 </dt>
6965 <dd>
6966 <p>
6967         Specifies the title to use for the prompt dialog. The default
6968         is the tool name.
6969 </p>
6970 </dd>
6971 <dt class="hdlist1">
6972 guitool.&lt;name&gt;.prompt
6973 </dt>
6974 <dd>
6975 <p>
6976         Specifies the general prompt string to display at the top of
6977         the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
6978         The default value includes the actual command.
6979 </p>
6980 </dd>
6981 <dt class="hdlist1">
6982 help.browser
6983 </dt>
6984 <dd>
6985 <p>
6986         Specify the browser that will be used to display help in the
6987         <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
6988 </p>
6989 </dd>
6990 <dt class="hdlist1">
6991 help.format
6992 </dt>
6993 <dd>
6994 <p>
6995         Override the default help format used by <a href="git-help.html">git-help(1)</a>.
6996         Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
6997         the default. <em>web</em> and <em>html</em> are the same.
6998 </p>
6999 </dd>
7000 <dt class="hdlist1">
7001 help.autoCorrect
7002 </dt>
7003 <dd>
7004 <p>
7005         If git detects typos and can identify exactly one valid command similar
7006         to the error, git will try to suggest the correct command or even
7007         run the suggestion automatically. Possible config values are:
7008 </p>
7009 <div class="ulist"><ul>
7010 <li>
7011 <p>
7012 0 (default): show the suggested command.
7013 </p>
7014 </li>
7015 <li>
7016 <p>
7017 positive number: run the suggested command after specified
7018 deciseconds (0.1 sec).
7019 </p>
7020 </li>
7021 <li>
7022 <p>
7023 "immediate": run the suggested command immediately.
7024 </p>
7025 </li>
7026 <li>
7027 <p>
7028 "prompt": show the suggestion and prompt for confirmation to run
7029 the command.
7030 </p>
7031 </li>
7032 <li>
7033 <p>
7034 "never": don&#8217;t run or show any suggested command.
7035 </p>
7036 </li>
7037 </ul></div>
7038 </dd>
7039 <dt class="hdlist1">
7040 help.htmlPath
7041 </dt>
7042 <dd>
7043 <p>
7044         Specify the path where the HTML documentation resides. File system paths
7045         and URLs are supported. HTML pages will be prefixed with this path when
7046         help is displayed in the <em>web</em> format. This defaults to the documentation
7047         path of your Git installation.
7048 </p>
7049 </dd>
7050 <dt class="hdlist1">
7051 http.proxy
7052 </dt>
7053 <dd>
7054 <p>
7055         Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
7056         <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
7057         addition to the syntax understood by curl, it is possible to specify a
7058         proxy string with a user name but no password, in which case git will
7059         attempt to acquire one in the same way it does for other credentials. See
7060         <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
7061         <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
7062         on a per-remote basis; see remote.&lt;name&gt;.proxy
7063 </p>
7064 </dd>
7065 <dt class="hdlist1">
7066 http.proxyAuthMethod
7067 </dt>
7068 <dd>
7069 <p>
7070         Set the method with which to authenticate against the HTTP proxy. This
7071         only takes effect if the configured proxy string contains a user name part
7072         (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
7073         overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
7074         Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
7075         variable.  Possible values are:
7076 </p>
7077 <div class="openblock">
7078 <div class="content">
7079 <div class="ulist"><ul>
7080 <li>
7081 <p>
7082 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
7083   assumed that the proxy answers an unauthenticated request with a 407
7084   status code and one or more Proxy-authenticate headers with supported
7085   authentication methods. This is the default.
7086 </p>
7087 </li>
7088 <li>
7089 <p>
7090 <code>basic</code> - HTTP Basic authentication
7091 </p>
7092 </li>
7093 <li>
7094 <p>
7095 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
7096   transmitted to the proxy in clear text
7097 </p>
7098 </li>
7099 <li>
7100 <p>
7101 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7102   of <code>curl(1)</code>)
7103 </p>
7104 </li>
7105 <li>
7106 <p>
7107 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7108 </p>
7109 </li>
7110 </ul></div>
7111 </div></div>
7112 </dd>
7113 <dt class="hdlist1">
7114 http.proxySSLCert
7115 </dt>
7116 <dd>
7117 <p>
7118         The pathname of a file that stores a client certificate to use to authenticate
7119         with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7120         variable.
7121 </p>
7122 </dd>
7123 <dt class="hdlist1">
7124 http.proxySSLKey
7125 </dt>
7126 <dd>
7127 <p>
7128         The pathname of a file that stores a private key to use to authenticate with
7129         an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7130         variable.
7131 </p>
7132 </dd>
7133 <dt class="hdlist1">
7134 http.proxySSLCertPasswordProtected
7135 </dt>
7136 <dd>
7137 <p>
7138         Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
7139         will prompt the user, possibly many times, if the certificate or private key
7140         is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7141         environment variable.
7142 </p>
7143 </dd>
7144 <dt class="hdlist1">
7145 http.proxySSLCAInfo
7146 </dt>
7147 <dd>
7148 <p>
7149         Pathname to the file containing the certificate bundle that should be used to
7150         verify the proxy with when using an HTTPS proxy. Can be overridden by the
7151         <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7152 </p>
7153 </dd>
7154 <dt class="hdlist1">
7155 http.emptyAuth
7156 </dt>
7157 <dd>
7158 <p>
7159         Attempt authentication without seeking a username or password.  This
7160         can be used to attempt GSS-Negotiate authentication without specifying
7161         a username in the URL, as libcurl normally requires a username for
7162         authentication.
7163 </p>
7164 </dd>
7165 <dt class="hdlist1">
7166 http.delegation
7167 </dt>
7168 <dd>
7169 <p>
7170         Control GSSAPI credential delegation. The delegation is disabled
7171         by default in libcurl since version 7.21.7. Set parameter to tell
7172         the server what it is allowed to delegate when it comes to user
7173         credentials. Used with GSS/kerberos. Possible values are:
7174 </p>
7175 <div class="openblock">
7176 <div class="content">
7177 <div class="ulist"><ul>
7178 <li>
7179 <p>
7180 <code>none</code> - Don&#8217;t allow any delegation.
7181 </p>
7182 </li>
7183 <li>
7184 <p>
7185 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7186   Kerberos service ticket, which is a matter of realm policy.
7187 </p>
7188 </li>
7189 <li>
7190 <p>
7191 <code>always</code> - Unconditionally allow the server to delegate.
7192 </p>
7193 </li>
7194 </ul></div>
7195 </div></div>
7196 </dd>
7197 <dt class="hdlist1">
7198 http.extraHeader
7199 </dt>
7200 <dd>
7201 <p>
7202         Pass an additional HTTP header when communicating with a server.  If
7203         more than one such entry exists, all of them are added as extra
7204         headers.  To allow overriding the settings inherited from the system
7205         config, an empty value will reset the extra headers to the empty list.
7206 </p>
7207 </dd>
7208 <dt class="hdlist1">
7209 http.cookieFile
7210 </dt>
7211 <dd>
7212 <p>
7213         The pathname of a file containing previously stored cookie lines,
7214         which should be used
7215         in the Git http session, if they match the server. The file format
7216         of the file to read cookies from should be plain HTTP headers or
7217         the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7218         NOTE that the file specified with http.cookieFile is used only as
7219         input unless http.saveCookies is set.
7220 </p>
7221 </dd>
7222 <dt class="hdlist1">
7223 http.saveCookies
7224 </dt>
7225 <dd>
7226 <p>
7227         If set, store cookies received during requests to the file specified by
7228         http.cookieFile. Has no effect if http.cookieFile is unset.
7229 </p>
7230 </dd>
7231 <dt class="hdlist1">
7232 http.version
7233 </dt>
7234 <dd>
7235 <p>
7236         Use the specified HTTP protocol version when communicating with a server.
7237         If you want to force the default. The available and default version depend
7238         on libcurl. Currently the possible values of
7239         this option are:
7240 </p>
7241 <div class="ulist"><ul>
7242 <li>
7243 <p>
7244 HTTP/2
7245 </p>
7246 </li>
7247 <li>
7248 <p>
7249 HTTP/1.1
7250 </p>
7251 </li>
7252 </ul></div>
7253 </dd>
7254 <dt class="hdlist1">
7255 http.curloptResolve
7256 </dt>
7257 <dd>
7258 <p>
7259         Hostname resolution information that will be used first by
7260         libcurl when sending HTTP requests.  This information should
7261         be in one of the following formats:
7262 </p>
7263 <div class="ulist"><ul>
7264 <li>
7265 <p>
7266 [+]HOST:PORT:ADDRESS[,ADDRESS]
7267 </p>
7268 </li>
7269 <li>
7270 <p>
7271 -HOST:PORT
7272 </p>
7273 </li>
7274 </ul></div>
7275 <div class="paragraph"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7276 to the provided <code>ADDRESS</code>(s). The second format clears all
7277 previous config values for that <code>HOST:PORT</code> combination.  To
7278 allow easy overriding of all the settings inherited from the
7279 system config, an empty value will reset all resolution
7280 information to the empty list.</p></div>
7281 </dd>
7282 <dt class="hdlist1">
7283 http.sslVersion
7284 </dt>
7285 <dd>
7286 <p>
7287         The SSL version to use when negotiating an SSL connection, if you
7288         want to force the default.  The available and default version
7289         depend on whether libcurl was built against NSS or OpenSSL and the
7290         particular configuration of the crypto library in use. Internally
7291         this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7292         documentation for more details on the format of this option and
7293         for the ssl version supported. Currently the possible values of
7294         this option are:
7295 </p>
7296 <div class="ulist"><ul>
7297 <li>
7298 <p>
7299 sslv2
7300 </p>
7301 </li>
7302 <li>
7303 <p>
7304 sslv3
7305 </p>
7306 </li>
7307 <li>
7308 <p>
7309 tlsv1
7310 </p>
7311 </li>
7312 <li>
7313 <p>
7314 tlsv1.0
7315 </p>
7316 </li>
7317 <li>
7318 <p>
7319 tlsv1.1
7320 </p>
7321 </li>
7322 <li>
7323 <p>
7324 tlsv1.2
7325 </p>
7326 </li>
7327 <li>
7328 <p>
7329 tlsv1.3
7330 </p>
7331 </li>
7332 </ul></div>
7333 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7334 To force git to use libcurl&#8217;s default ssl version and ignore any
7335 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7336 empty string.</p></div>
7337 </dd>
7338 <dt class="hdlist1">
7339 http.sslCipherList
7340 </dt>
7341 <dd>
7342 <p>
7343   A list of SSL ciphers to use when negotiating an SSL connection.
7344   The available ciphers depend on whether libcurl was built against
7345   NSS or OpenSSL and the particular configuration of the crypto
7346   library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7347   option; see the libcurl documentation for more details on the format
7348   of this list.
7349 </p>
7350 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7351 To force git to use libcurl&#8217;s default cipher list and ignore any
7352 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7353 empty string.</p></div>
7354 </dd>
7355 <dt class="hdlist1">
7356 http.sslVerify
7357 </dt>
7358 <dd>
7359 <p>
7360         Whether to verify the SSL certificate when fetching or pushing
7361         over HTTPS. Defaults to true. Can be overridden by the
7362         <code>GIT_SSL_NO_VERIFY</code> environment variable.
7363 </p>
7364 </dd>
7365 <dt class="hdlist1">
7366 http.sslCert
7367 </dt>
7368 <dd>
7369 <p>
7370         File containing the SSL certificate when fetching or pushing
7371         over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7372         variable.
7373 </p>
7374 </dd>
7375 <dt class="hdlist1">
7376 http.sslKey
7377 </dt>
7378 <dd>
7379 <p>
7380         File containing the SSL private key when fetching or pushing
7381         over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7382         variable.
7383 </p>
7384 </dd>
7385 <dt class="hdlist1">
7386 http.sslCertPasswordProtected
7387 </dt>
7388 <dd>
7389 <p>
7390         Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
7391         OpenSSL will prompt the user, possibly many times, if the
7392         certificate or private key is encrypted.  Can be overridden by the
7393         <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7394 </p>
7395 </dd>
7396 <dt class="hdlist1">
7397 http.sslCAInfo
7398 </dt>
7399 <dd>
7400 <p>
7401         File containing the certificates to verify the peer with when
7402         fetching or pushing over HTTPS. Can be overridden by the
7403         <code>GIT_SSL_CAINFO</code> environment variable.
7404 </p>
7405 </dd>
7406 <dt class="hdlist1">
7407 http.sslCAPath
7408 </dt>
7409 <dd>
7410 <p>
7411         Path containing files with the CA certificates to verify the peer
7412         with when fetching or pushing over HTTPS. Can be overridden
7413         by the <code>GIT_SSL_CAPATH</code> environment variable.
7414 </p>
7415 </dd>
7416 <dt class="hdlist1">
7417 http.sslBackend
7418 </dt>
7419 <dd>
7420 <p>
7421         Name of the SSL backend to use (e.g. "openssl" or "schannel").
7422         This option is ignored if cURL lacks support for choosing the SSL
7423         backend at runtime.
7424 </p>
7425 </dd>
7426 <dt class="hdlist1">
7427 http.schannelCheckRevoke
7428 </dt>
7429 <dd>
7430 <p>
7431         Used to enforce or disable certificate revocation checks in cURL
7432         when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
7433         unset. Only necessary to disable this if Git consistently errors
7434         and the message is about checking the revocation status of a
7435         certificate. This option is ignored if cURL lacks support for
7436         setting the relevant SSL option at runtime.
7437 </p>
7438 </dd>
7439 <dt class="hdlist1">
7440 http.schannelUseSSLCAInfo
7441 </dt>
7442 <dd>
7443 <p>
7444         As of cURL v7.60.0, the Secure Channel backend can use the
7445         certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7446         override the Windows Certificate Store. Since this is not desirable
7447         by default, Git will tell cURL not to use that bundle by default
7448         when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7449         unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7450 </p>
7451 </dd>
7452 <dt class="hdlist1">
7453 http.pinnedPubkey
7454 </dt>
7455 <dd>
7456 <p>
7457         Public key of the https service. It may either be the filename of
7458         a PEM or DER encoded public key file or a string starting with
7459         <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7460         public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7461         exit with an error if this option is set but not supported by
7462         cURL.
7463 </p>
7464 </dd>
7465 <dt class="hdlist1">
7466 http.sslTry
7467 </dt>
7468 <dd>
7469 <p>
7470         Attempt to use AUTH SSL/TLS and encrypted data transfers
7471         when connecting via regular FTP protocol. This might be needed
7472         if the FTP server requires it for security reasons or you wish
7473         to connect securely whenever remote FTP server supports it.
7474         Default is false since it might trigger certificate verification
7475         errors on misconfigured servers.
7476 </p>
7477 </dd>
7478 <dt class="hdlist1">
7479 http.maxRequests
7480 </dt>
7481 <dd>
7482 <p>
7483         How many HTTP requests to launch in parallel. Can be overridden
7484         by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7485 </p>
7486 </dd>
7487 <dt class="hdlist1">
7488 http.minSessions
7489 </dt>
7490 <dd>
7491 <p>
7492         The number of curl sessions (counted across slots) to be kept across
7493         requests. They will not be ended with curl_easy_cleanup() until
7494         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7495         value will be capped at 1. Defaults to 1.
7496 </p>
7497 </dd>
7498 <dt class="hdlist1">
7499 http.postBuffer
7500 </dt>
7501 <dd>
7502 <p>
7503         Maximum size in bytes of the buffer used by smart HTTP
7504         transports when POSTing data to the remote system.
7505         For requests larger than this buffer size, HTTP/1.1 and
7506         Transfer-Encoding: chunked is used to avoid creating a
7507         massive pack file locally.  Default is 1 MiB, which is
7508         sufficient for most requests.
7509 </p>
7510 <div class="paragraph"><p>Note that raising this limit is only effective for disabling chunked
7511 transfer encoding and therefore should be used only where the remote
7512 server or a proxy only supports HTTP/1.0 or is noncompliant with the
7513 HTTP standard.  Raising this is not, in general, an effective solution
7514 for most push problems, but can increase memory consumption
7515 significantly since the entire buffer is allocated even for small
7516 pushes.</p></div>
7517 </dd>
7518 <dt class="hdlist1">
7519 http.lowSpeedLimit, http.lowSpeedTime
7520 </dt>
7521 <dd>
7522 <p>
7523         If the HTTP transfer speed, in bytes per second, is less than
7524         <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
7525         the transfer is aborted.
7526         Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
7527         <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
7528 </p>
7529 </dd>
7530 <dt class="hdlist1">
7531 http.noEPSV
7532 </dt>
7533 <dd>
7534 <p>
7535         A boolean which disables using of EPSV ftp command by curl.
7536         This can be helpful with some "poor" ftp servers which don&#8217;t
7537         support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
7538         environment variable. Default is false (curl will use EPSV).
7539 </p>
7540 </dd>
7541 <dt class="hdlist1">
7542 http.userAgent
7543 </dt>
7544 <dd>
7545 <p>
7546         The HTTP USER_AGENT string presented to an HTTP server.  The default
7547         value represents the version of the Git client such as git/1.7.1.
7548         This option allows you to override this value to a more common value
7549         such as Mozilla/4.0.  This may be necessary, for instance, if
7550         connecting through a firewall that restricts HTTP connections to a set
7551         of common USER_AGENT strings (but not including those like git/1.7.1).
7552         Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
7553 </p>
7554 </dd>
7555 <dt class="hdlist1">
7556 http.followRedirects
7557 </dt>
7558 <dd>
7559 <p>
7560         Whether git should follow HTTP redirects. If set to <code>true</code>, git
7561         will transparently follow any redirect issued by a server it
7562         encounters. If set to <code>false</code>, git will treat all redirects as
7563         errors. If set to <code>initial</code>, git will follow redirects only for
7564         the initial request to a remote, but not for subsequent
7565         follow-up HTTP requests. Since git uses the redirected URL as
7566         the base for the follow-up requests, this is generally
7567         sufficient. The default is <code>initial</code>.
7568 </p>
7569 </dd>
7570 <dt class="hdlist1">
7571 http.&lt;url&gt;.*
7572 </dt>
7573 <dd>
7574 <p>
7575         Any of the http.* options above can be applied selectively to some URLs.
7576         For a config key to match a URL, each element of the config key is
7577         compared to that of the URL, in the following order:
7578 </p>
7579 <div class="openblock">
7580 <div class="content">
7581 <div class="olist arabic"><ol class="arabic">
7582 <li>
7583 <p>
7584 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
7585   must match exactly between the config key and the URL.
7586 </p>
7587 </li>
7588 <li>
7589 <p>
7590 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
7591   This field must match between the config key and the URL. It is
7592   possible to specify a <code>*</code> as part of the host name to match all subdomains
7593   at this level. <code>https://*.example.com/</code> for example would match
7594   <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
7595 </p>
7596 </li>
7597 <li>
7598 <p>
7599 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
7600   This field must match exactly between the config key and the URL.
7601   Omitted port numbers are automatically converted to the correct
7602   default for the scheme before matching.
7603 </p>
7604 </li>
7605 <li>
7606 <p>
7607 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
7608   path field of the config key must match the path field of the URL
7609   either exactly or as a prefix of slash-delimited path elements.  This means
7610   a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
7611   match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
7612   key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
7613   key with just path <code>foo/</code>).
7614 </p>
7615 </li>
7616 <li>
7617 <p>
7618 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
7619   the config key has a user name it must match the user name in the
7620   URL exactly. If the config key does not have a user name, that
7621   config key will match a URL with any user name (including none),
7622   but at a lower precedence than a config key with a user name.
7623 </p>
7624 </li>
7625 </ol></div>
7626 </div></div>
7627 <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
7628 a config key&#8217;s path is preferred to one that matches its user name. For example,
7629 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
7630 <code>https://example.com/foo</code> will be preferred over a config key match of
7631 <code>https://user@example.com</code>.</p></div>
7632 <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
7633 if embedded in the URL, is always ignored for matching purposes) so that
7634 equivalent URLs that are simply spelled differently will match properly.
7635 Environment variable settings always override any matches.  The URLs that are
7636 matched against are those given directly to Git commands.  This means any URLs
7637 visited as a result of a redirection do not participate in matching.</p></div>
7638 </dd>
7639 <dt class="hdlist1">
7640 i18n.commitEncoding
7641 </dt>
7642 <dd>
7643 <p>
7644         Character encoding the commit messages are stored in; Git itself
7645         does not care per se, but this information is necessary e.g. when
7646         importing commits from emails or in the gitk graphical history
7647         browser (and possibly in other places in the future or in other
7648         porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
7649 </p>
7650 </dd>
7651 <dt class="hdlist1">
7652 i18n.logOutputEncoding
7653 </dt>
7654 <dd>
7655 <p>
7656         Character encoding the commit messages are converted to when
7657         running <em>git log</em> and friends.
7658 </p>
7659 </dd>
7660 <dt class="hdlist1">
7661 imap.folder
7662 </dt>
7663 <dd>
7664 <p>
7665         The folder to drop the mails into, which is typically the Drafts
7666         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
7667         "[Gmail]/Drafts". Required.
7668 </p>
7669 </dd>
7670 <dt class="hdlist1">
7671 imap.tunnel
7672 </dt>
7673 <dd>
7674 <p>
7675         Command used to set up a tunnel to the IMAP server through which
7676         commands will be piped instead of using a direct network connection
7677         to the server. Required when imap.host is not set.
7678 </p>
7679 </dd>
7680 <dt class="hdlist1">
7681 imap.host
7682 </dt>
7683 <dd>
7684 <p>
7685         A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
7686         connections and an <code>imaps://</code> prefix for secure connections.
7687         Ignored when imap.tunnel is set, but required otherwise.
7688 </p>
7689 </dd>
7690 <dt class="hdlist1">
7691 imap.user
7692 </dt>
7693 <dd>
7694 <p>
7695         The username to use when logging in to the server.
7696 </p>
7697 </dd>
7698 <dt class="hdlist1">
7699 imap.pass
7700 </dt>
7701 <dd>
7702 <p>
7703         The password to use when logging in to the server.
7704 </p>
7705 </dd>
7706 <dt class="hdlist1">
7707 imap.port
7708 </dt>
7709 <dd>
7710 <p>
7711         An integer port number to connect to on the server.
7712         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
7713         Ignored when imap.tunnel is set.
7714 </p>
7715 </dd>
7716 <dt class="hdlist1">
7717 imap.sslverify
7718 </dt>
7719 <dd>
7720 <p>
7721         A boolean to enable/disable verification of the server certificate
7722         used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
7723         imap.tunnel is set.
7724 </p>
7725 </dd>
7726 <dt class="hdlist1">
7727 imap.preformattedHTML
7728 </dt>
7729 <dd>
7730 <p>
7731         A boolean to enable/disable the use of html encoding when sending
7732         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
7733         and have a content type of text/html.  Ironically, enabling this
7734         option causes Thunderbird to send the patch as a plain/text,
7735         format=fixed email.  Default is <code>false</code>.
7736 </p>
7737 </dd>
7738 <dt class="hdlist1">
7739 imap.authMethod
7740 </dt>
7741 <dd>
7742 <p>
7743         Specify the authentication method for authenticating with the IMAP server.
7744         If Git was built with the NO_CURL option, or if your curl version is older
7745         than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
7746         option, the only supported method is <em>CRAM-MD5</em>. If this is not set
7747         then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
7748 </p>
7749 </dd>
7750 <dt class="hdlist1">
7751 include.path
7752 </dt>
7753 <dt class="hdlist1">
7754 includeIf.&lt;condition&gt;.path
7755 </dt>
7756 <dd>
7757 <p>
7758         Special variables to include other configuration files. See
7759         the "CONFIGURATION FILE" section in the main
7760         <a href="git-config.html">git-config(1)</a> documentation,
7761         specifically the "Includes" and "Conditional Includes" subsections.
7762 </p>
7763 </dd>
7764 <dt class="hdlist1">
7765 index.recordEndOfIndexEntries
7766 </dt>
7767 <dd>
7768 <p>
7769         Specifies whether the index file should include an "End Of Index
7770         Entry" section. This reduces index load time on multiprocessor
7771         machines but produces a message "ignoring EOIE extension" when
7772         reading the index using Git versions before 2.20. Defaults to
7773         <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
7774         otherwise.
7775 </p>
7776 </dd>
7777 <dt class="hdlist1">
7778 index.recordOffsetTable
7779 </dt>
7780 <dd>
7781 <p>
7782         Specifies whether the index file should include an "Index Entry
7783         Offset Table" section. This reduces index load time on
7784         multiprocessor machines but produces a message "ignoring IEOT
7785         extension" when reading the index using Git versions before 2.20.
7786         Defaults to <em>true</em> if index.threads has been explicitly enabled,
7787         <em>false</em> otherwise.
7788 </p>
7789 </dd>
7790 <dt class="hdlist1">
7791 index.sparse
7792 </dt>
7793 <dd>
7794 <p>
7795         When enabled, write the index using sparse-directory entries. This
7796         has no effect unless <code>core.sparseCheckout</code> and
7797         <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
7798 </p>
7799 </dd>
7800 <dt class="hdlist1">
7801 index.threads
7802 </dt>
7803 <dd>
7804 <p>
7805         Specifies the number of threads to spawn when loading the index.
7806         This is meant to reduce index load time on multiprocessor machines.
7807         Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
7808         CPUs and set the number of threads accordingly. Specifying 1 or
7809         <em>false</em> will disable multithreading. Defaults to <em>true</em>.
7810 </p>
7811 </dd>
7812 <dt class="hdlist1">
7813 index.version
7814 </dt>
7815 <dd>
7816 <p>
7817         Specify the version with which new index files should be
7818         initialized.  This does not affect existing repositories.
7819         If <code>feature.manyFiles</code> is enabled, then the default is 4.
7820 </p>
7821 </dd>
7822 <dt class="hdlist1">
7823 index.skipHash
7824 </dt>
7825 <dd>
7826 <p>
7827         When enabled, do not compute the trailing hash for the index file.
7828         This accelerates Git commands that manipulate the index, such as
7829         <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
7830         checksum, write a trailing set of bytes with value zero, indicating
7831         that the computation was skipped.
7832 </p>
7833 <div class="paragraph"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
7834 refuse to parse the index and Git clients older than 2.40.0 will report an
7835 error during <code>git fsck</code>.</p></div>
7836 </dd>
7837 <dt class="hdlist1">
7838 init.templateDir
7839 </dt>
7840 <dd>
7841 <p>
7842         Specify the directory from which templates will be copied.
7843         (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
7844 </p>
7845 </dd>
7846 <dt class="hdlist1">
7847 init.defaultBranch
7848 </dt>
7849 <dd>
7850 <p>
7851         Allows overriding the default branch name e.g. when initializing
7852         a new repository.
7853 </p>
7854 </dd>
7855 <dt class="hdlist1">
7856 instaweb.browser
7857 </dt>
7858 <dd>
7859 <p>
7860         Specify the program that will be used to browse your working
7861         repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7862 </p>
7863 </dd>
7864 <dt class="hdlist1">
7865 instaweb.httpd
7866 </dt>
7867 <dd>
7868 <p>
7869         The HTTP daemon command-line to start gitweb on your working
7870         repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7871 </p>
7872 </dd>
7873 <dt class="hdlist1">
7874 instaweb.local
7875 </dt>
7876 <dd>
7877 <p>
7878         If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
7879         be bound to the local IP (127.0.0.1).
7880 </p>
7881 </dd>
7882 <dt class="hdlist1">
7883 instaweb.modulePath
7884 </dt>
7885 <dd>
7886 <p>
7887         The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
7888         instead of /usr/lib/apache2/modules.  Only used if httpd
7889         is Apache.
7890 </p>
7891 </dd>
7892 <dt class="hdlist1">
7893 instaweb.port
7894 </dt>
7895 <dd>
7896 <p>
7897         The port number to bind the gitweb httpd to. See
7898         <a href="git-instaweb.html">git-instaweb(1)</a>.
7899 </p>
7900 </dd>
7901 <dt class="hdlist1">
7902 interactive.singleKey
7903 </dt>
7904 <dd>
7905 <p>
7906         In interactive commands, allow the user to provide one-letter
7907         input with a single key (i.e., without hitting enter).
7908         Currently this is used by the <code>--patch</code> mode of
7909         <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
7910         <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
7911         <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>. Note that this
7912         setting is silently ignored if portable keystroke input
7913         is not available; requires the Perl module Term::ReadKey.
7914 </p>
7915 </dd>
7916 <dt class="hdlist1">
7917 interactive.diffFilter
7918 </dt>
7919 <dd>
7920 <p>
7921         When an interactive command (such as <code>git add --patch</code>) shows
7922         a colorized diff, git will pipe the diff through the shell
7923         command defined by this configuration variable. The command may
7924         mark up the diff further for human consumption, provided that it
7925         retains a one-to-one correspondence with the lines in the
7926         original diff. Defaults to disabled (no filtering).
7927 </p>
7928 </dd>
7929 <dt class="hdlist1">
7930 log.abbrevCommit
7931 </dt>
7932 <dd>
7933 <p>
7934         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
7935         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
7936         override this option with <code>--no-abbrev-commit</code>.
7937 </p>
7938 </dd>
7939 <dt class="hdlist1">
7940 log.date
7941 </dt>
7942 <dd>
7943 <p>
7944         Set the default date-time mode for the <em>log</em> command.
7945         Setting a value for log.date is similar to using <em>git log</em>'s
7946         <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.
7947 </p>
7948 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
7949 "foo" will be used for the date format. Otherwise, "default" will
7950 be used.</p></div>
7951 </dd>
7952 <dt class="hdlist1">
7953 log.decorate
7954 </dt>
7955 <dd>
7956 <p>
7957         Print out the ref names of any commits that are shown by the log
7958         command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
7959         <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
7960         specified, the full ref name (including prefix) will be printed.
7961         If <em>auto</em> is specified, then if the output is going to a terminal,
7962         the ref names are shown as if <em>short</em> were given, otherwise no ref
7963         names are shown. This is the same as the <code>--decorate</code> option
7964         of the <code>git log</code>.
7965 </p>
7966 </dd>
7967 <dt class="hdlist1">
7968 log.initialDecorationSet
7969 </dt>
7970 <dd>
7971 <p>
7972         By default, <code>git log</code> only shows decorations for certain known ref
7973         namespaces. If <em>all</em> is specified, then show all refs as
7974         decorations.
7975 </p>
7976 </dd>
7977 <dt class="hdlist1">
7978 log.excludeDecoration
7979 </dt>
7980 <dd>
7981 <p>
7982         Exclude the specified patterns from the log decorations. This is
7983         similar to the <code>--decorate-refs-exclude</code> command-line option, but
7984         the config option can be overridden by the <code>--decorate-refs</code>
7985         option.
7986 </p>
7987 </dd>
7988 <dt class="hdlist1">
7989 log.diffMerges
7990 </dt>
7991 <dd>
7992 <p>
7993         Set diff format to be used when <code>--diff-merges=on</code> is
7994         specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
7995         details. Defaults to <code>separate</code>.
7996 </p>
7997 </dd>
7998 <dt class="hdlist1">
7999 log.follow
8000 </dt>
8001 <dd>
8002 <p>
8003         If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
8004         a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
8005         i.e. it cannot be used to follow multiple files and does not work well
8006         on non-linear history.
8007 </p>
8008 </dd>
8009 <dt class="hdlist1">
8010 log.graphColors
8011 </dt>
8012 <dd>
8013 <p>
8014         A list of colors, separated by commas, that can be used to draw
8015         history lines in <code>git log --graph</code>.
8016 </p>
8017 </dd>
8018 <dt class="hdlist1">
8019 log.showRoot
8020 </dt>
8021 <dd>
8022 <p>
8023         If true, the initial commit will be shown as a big creation event.
8024         This is equivalent to a diff against an empty tree.
8025         Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
8026         normally hide the root commit will now show it. True by default.
8027 </p>
8028 </dd>
8029 <dt class="hdlist1">
8030 log.showSignature
8031 </dt>
8032 <dd>
8033 <p>
8034         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8035         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
8036 </p>
8037 </dd>
8038 <dt class="hdlist1">
8039 log.mailmap
8040 </dt>
8041 <dd>
8042 <p>
8043         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8044         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
8045         assume <code>--no-use-mailmap</code>. True by default.
8046 </p>
8047 </dd>
8048 <dt class="hdlist1">
8049 lsrefs.unborn
8050 </dt>
8051 <dd>
8052 <p>
8053         May be "advertise" (the default), "allow", or "ignore". If "advertise",
8054         the server will respond to the client sending "unborn" (as described in
8055         <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
8056         protocol v2 capability advertisement. "allow" is the same as
8057         "advertise" except that the server will not advertise support for this
8058         feature; this is useful for load-balanced servers that cannot be
8059         updated atomically (for example), since the administrator could
8060         configure "allow", then after a delay, configure "advertise".
8061 </p>
8062 </dd>
8063 <dt class="hdlist1">
8064 mailinfo.scissors
8065 </dt>
8066 <dd>
8067 <p>
8068         If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
8069         <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
8070         was provided on the command-line. When active, this feature
8071         removes everything from the message body before a scissors
8072         line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
8073 </p>
8074 </dd>
8075 <dt class="hdlist1">
8076 mailmap.file
8077 </dt>
8078 <dd>
8079 <p>
8080         The location of an augmenting mailmap file. The default
8081         mailmap, located in the root of the repository, is loaded
8082         first, then the mailmap file pointed to by this variable.
8083         The location of the mailmap file may be in a repository
8084         subdirectory, or somewhere outside of the repository itself.
8085         See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
8086 </p>
8087 </dd>
8088 <dt class="hdlist1">
8089 mailmap.blob
8090 </dt>
8091 <dd>
8092 <p>
8093         Like <code>mailmap.file</code>, but consider the value as a reference to a
8094         blob in the repository. If both <code>mailmap.file</code> and
8095         <code>mailmap.blob</code> are given, both are parsed, with entries from
8096         <code>mailmap.file</code> taking precedence. In a bare repository, this
8097         defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8098         defaults to empty.
8099 </p>
8100 </dd>
8101 <dt class="hdlist1">
8102 maintenance.auto
8103 </dt>
8104 <dd>
8105 <p>
8106         This boolean config option controls whether some commands run
8107         <code>git maintenance run --auto</code> after doing their normal work. Defaults
8108         to true.
8109 </p>
8110 </dd>
8111 <dt class="hdlist1">
8112 maintenance.strategy
8113 </dt>
8114 <dd>
8115 <p>
8116         This string config option provides a way to specify one of a few
8117         recommended schedules for background maintenance. This only affects
8118         which tasks are run during <code>git maintenance run --schedule=X</code>
8119         commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
8120         Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
8121         then that value is used instead of the one provided by
8122         <code>maintenance.strategy</code>. The possible strategy strings are:
8123 </p>
8124 <div class="ulist"><ul>
8125 <li>
8126 <p>
8127 <code>none</code>: This default setting implies no tasks are run at any schedule.
8128 </p>
8129 </li>
8130 <li>
8131 <p>
8132 <code>incremental</code>: This setting optimizes for performing small maintenance
8133   activities that do not delete any data. This does not schedule the <code>gc</code>
8134   task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8135   <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8136   task weekly.
8137 </p>
8138 </li>
8139 </ul></div>
8140 </dd>
8141 <dt class="hdlist1">
8142 maintenance.&lt;task&gt;.enabled
8143 </dt>
8144 <dd>
8145 <p>
8146         This boolean config option controls whether the maintenance task
8147         with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
8148         <code>git maintenance run</code>. These config values are ignored if a
8149         <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8150         is true.
8151 </p>
8152 </dd>
8153 <dt class="hdlist1">
8154 maintenance.&lt;task&gt;.schedule
8155 </dt>
8156 <dd>
8157 <p>
8158         This config option controls whether or not the given <code>&lt;task&gt;</code> runs
8159         during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
8160         value must be one of "hourly", "daily", or "weekly".
8161 </p>
8162 </dd>
8163 <dt class="hdlist1">
8164 maintenance.commit-graph.auto
8165 </dt>
8166 <dd>
8167 <p>
8168         This integer config option controls how often the <code>commit-graph</code> task
8169         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8170         the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8171         negative value will force the task to run every time. Otherwise, a
8172         positive value implies the command should run when the number of
8173         reachable commits that are not in the commit-graph file is at least
8174         the value of <code>maintenance.commit-graph.auto</code>. The default value is
8175         100.
8176 </p>
8177 </dd>
8178 <dt class="hdlist1">
8179 maintenance.loose-objects.auto
8180 </dt>
8181 <dd>
8182 <p>
8183         This integer config option controls how often the <code>loose-objects</code> task
8184         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8185         the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8186         negative value will force the task to run every time. Otherwise, a
8187         positive value implies the command should run when the number of
8188         loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8189         The default value is 100.
8190 </p>
8191 </dd>
8192 <dt class="hdlist1">
8193 maintenance.incremental-repack.auto
8194 </dt>
8195 <dd>
8196 <p>
8197         This integer config option controls how often the <code>incremental-repack</code>
8198         task should be run as part of <code>git maintenance run --auto</code>. If zero,
8199         then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8200         option. A negative value will force the task to run every time.
8201         Otherwise, a positive value implies the command should run when the
8202         number of pack-files not in the multi-pack-index is at least the value
8203         of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8204 </p>
8205 </dd>
8206 <dt class="hdlist1">
8207 man.viewer
8208 </dt>
8209 <dd>
8210 <p>
8211         Specify the programs that may be used to display help in the
8212         <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8213 </p>
8214 </dd>
8215 <dt class="hdlist1">
8216 man.&lt;tool&gt;.cmd
8217 </dt>
8218 <dd>
8219 <p>
8220         Specify the command to invoke the specified man viewer. The
8221         specified command is evaluated in shell with the man page
8222         passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)
8223 </p>
8224 </dd>
8225 <dt class="hdlist1">
8226 man.&lt;tool&gt;.path
8227 </dt>
8228 <dd>
8229 <p>
8230         Override the path for the given tool that may be used to
8231         display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8232 </p>
8233 </dd>
8234 <dt class="hdlist1">
8235 merge.conflictStyle
8236 </dt>
8237 <dd>
8238 <p>
8239         Specify the style in which conflicted hunks are written out to
8240         working tree files upon merge.  The default is "merge", which
8241         shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
8242         a <code>=======</code> marker, changes made by the other side, and then
8243         a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
8244         marker and the original text before the <code>=======</code> marker.  The
8245         "merge" style tends to produce smaller conflict regions than diff3,
8246         both because of the exclusion of the original text, and because
8247         when a subset of lines match on the two sides, they are just pulled
8248         out of the conflict region.  Another alternate style, "zdiff3", is
8249         similar to diff3 but removes matching lines on the two sides from
8250         the conflict region when those matching lines appear near either
8251         the beginning or end of a conflict region.
8252 </p>
8253 </dd>
8254 <dt class="hdlist1">
8255 merge.defaultToUpstream
8256 </dt>
8257 <dd>
8258 <p>
8259         If merge is called without any commit argument, merge the upstream
8260         branches configured for the current branch by using their last
8261         observed values stored in their remote-tracking branches.
8262         The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
8263         branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
8264         are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
8265         to their corresponding remote-tracking branches, and the tips of
8266         these tracking branches are merged. Defaults to true.
8267 </p>
8268 </dd>
8269 <dt class="hdlist1">
8270 merge.ff
8271 </dt>
8272 <dd>
8273 <p>
8274         By default, Git does not create an extra merge commit when merging
8275         a commit that is a descendant of the current commit. Instead, the
8276         tip of the current branch is fast-forwarded. When set to <code>false</code>,
8277         this variable tells Git to create an extra merge commit in such
8278         a case (equivalent to giving the <code>--no-ff</code> option from the command
8279         line). When set to <code>only</code>, only such fast-forward merges are
8280         allowed (equivalent to giving the <code>--ff-only</code> option from the
8281         command line).
8282 </p>
8283 </dd>
8284 <dt class="hdlist1">
8285 merge.verifySignatures
8286 </dt>
8287 <dd>
8288 <p>
8289         If true, this is equivalent to the --verify-signatures command
8290         line option. See <a href="git-merge.html">git-merge(1)</a> for details.
8291 </p>
8292 </dd>
8293 <dt class="hdlist1">
8294 merge.branchdesc
8295 </dt>
8296 <dd>
8297 <p>
8298         In addition to branch names, populate the log message with
8299         the branch description text associated with them.  Defaults
8300         to false.
8301 </p>
8302 </dd>
8303 <dt class="hdlist1">
8304 merge.log
8305 </dt>
8306 <dd>
8307 <p>
8308         In addition to branch names, populate the log message with at
8309         most the specified number of one-line descriptions from the
8310         actual commits that are being merged.  Defaults to false, and
8311         true is a synonym for 20.
8312 </p>
8313 </dd>
8314 <dt class="hdlist1">
8315 merge.suppressDest
8316 </dt>
8317 <dd>
8318 <p>
8319         By adding a glob that matches the names of integration
8320         branches to this multi-valued configuration variable, the
8321         default merge message computed for merges into these
8322         integration branches will omit "into &lt;branch name&gt;" from
8323         its title.
8324 </p>
8325 <div class="paragraph"><p>An element with an empty value can be used to clear the list
8326 of globs accumulated from previous configuration entries.
8327 When there is no <code>merge.suppressDest</code> variable defined, the
8328 default value of <code>master</code> is used for backward compatibility.</p></div>
8329 </dd>
8330 <dt class="hdlist1">
8331 merge.renameLimit
8332 </dt>
8333 <dd>
8334 <p>
8335         The number of files to consider in the exhaustive portion of
8336         rename detection during a merge.  If not specified, defaults
8337         to the value of diff.renameLimit.  If neither
8338         merge.renameLimit nor diff.renameLimit are specified,
8339         currently defaults to 7000.  This setting has no effect if
8340         rename detection is turned off.
8341 </p>
8342 </dd>
8343 <dt class="hdlist1">
8344 merge.renames
8345 </dt>
8346 <dd>
8347 <p>
8348         Whether Git detects renames.  If set to "false", rename detection
8349         is disabled. If set to "true", basic rename detection is enabled.
8350         Defaults to the value of diff.renames.
8351 </p>
8352 </dd>
8353 <dt class="hdlist1">
8354 merge.directoryRenames
8355 </dt>
8356 <dd>
8357 <p>
8358         Whether Git detects directory renames, affecting what happens at
8359         merge time to new files added to a directory on one side of
8360         history when that directory was renamed on the other side of
8361         history.  If merge.directoryRenames is set to "false", directory
8362         rename detection is disabled, meaning that such new files will be
8363         left behind in the old directory.  If set to "true", directory
8364         rename detection is enabled, meaning that such new files will be
8365         moved into the new directory.  If set to "conflict", a conflict
8366         will be reported for such paths.  If merge.renames is false,
8367         merge.directoryRenames is ignored and treated as false.  Defaults
8368         to "conflict".
8369 </p>
8370 </dd>
8371 <dt class="hdlist1">
8372 merge.renormalize
8373 </dt>
8374 <dd>
8375 <p>
8376         Tell Git that canonical representation of files in the
8377         repository has changed over time (e.g. earlier commits record
8378         text files with CRLF line endings, but recent ones use LF line
8379         endings).  In such a repository, Git can convert the data
8380         recorded in commits to a canonical form before performing a
8381         merge to reduce unnecessary conflicts.  For more information,
8382         see section "Merging branches with differing checkin/checkout
8383         attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
8384 </p>
8385 </dd>
8386 <dt class="hdlist1">
8387 merge.stat
8388 </dt>
8389 <dd>
8390 <p>
8391         Whether to print the diffstat between ORIG_HEAD and the merge result
8392         at the end of the merge.  True by default.
8393 </p>
8394 </dd>
8395 <dt class="hdlist1">
8396 merge.autoStash
8397 </dt>
8398 <dd>
8399 <p>
8400         When set to true, automatically create a temporary stash entry
8401         before the operation begins, and apply it after the operation
8402         ends.  This means that you can run merge on a dirty worktree.
8403         However, use with care: the final stash application after a
8404         successful merge might result in non-trivial conflicts.
8405         This option can be overridden by the <code>--no-autostash</code> and
8406         <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
8407         Defaults to false.
8408 </p>
8409 </dd>
8410 <dt class="hdlist1">
8411 merge.tool
8412 </dt>
8413 <dd>
8414 <p>
8415         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
8416         The list below shows the valid built-in values.
8417         Any other value is treated as a custom merge tool and requires
8418         that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
8419 </p>
8420 </dd>
8421 <dt class="hdlist1">
8422 merge.guitool
8423 </dt>
8424 <dd>
8425 <p>
8426         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
8427         -g/--gui flag is specified. The list below shows the valid built-in values.
8428         Any other value is treated as a custom merge tool and requires that a
8429         corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.
8430 </p>
8431 <div class="dlist"><dl>
8432 <dt class="hdlist1">
8433 <code>araxis</code>
8434 </dt>
8435 <dd>
8436 <p>
8437 Use Araxis Merge (requires a graphical session)
8438 </p>
8439 </dd>
8440 <dt class="hdlist1">
8441 <code>bc</code>
8442 </dt>
8443 <dd>
8444 <p>
8445 Use Beyond Compare (requires a graphical session)
8446 </p>
8447 </dd>
8448 <dt class="hdlist1">
8449 <code>bc3</code>
8450 </dt>
8451 <dd>
8452 <p>
8453 Use Beyond Compare (requires a graphical session)
8454 </p>
8455 </dd>
8456 <dt class="hdlist1">
8457 <code>bc4</code>
8458 </dt>
8459 <dd>
8460 <p>
8461 Use Beyond Compare (requires a graphical session)
8462 </p>
8463 </dd>
8464 <dt class="hdlist1">
8465 <code>codecompare</code>
8466 </dt>
8467 <dd>
8468 <p>
8469 Use Code Compare (requires a graphical session)
8470 </p>
8471 </dd>
8472 <dt class="hdlist1">
8473 <code>deltawalker</code>
8474 </dt>
8475 <dd>
8476 <p>
8477 Use DeltaWalker (requires a graphical session)
8478 </p>
8479 </dd>
8480 <dt class="hdlist1">
8481 <code>diffmerge</code>
8482 </dt>
8483 <dd>
8484 <p>
8485 Use DiffMerge (requires a graphical session)
8486 </p>
8487 </dd>
8488 <dt class="hdlist1">
8489 <code>diffuse</code>
8490 </dt>
8491 <dd>
8492 <p>
8493 Use Diffuse (requires a graphical session)
8494 </p>
8495 </dd>
8496 <dt class="hdlist1">
8497 <code>ecmerge</code>
8498 </dt>
8499 <dd>
8500 <p>
8501 Use ECMerge (requires a graphical session)
8502 </p>
8503 </dd>
8504 <dt class="hdlist1">
8505 <code>emerge</code>
8506 </dt>
8507 <dd>
8508 <p>
8509 Use Emacs' Emerge
8510 </p>
8511 </dd>
8512 <dt class="hdlist1">
8513 <code>examdiff</code>
8514 </dt>
8515 <dd>
8516 <p>
8517 Use ExamDiff Pro (requires a graphical session)
8518 </p>
8519 </dd>
8520 <dt class="hdlist1">
8521 <code>guiffy</code>
8522 </dt>
8523 <dd>
8524 <p>
8525 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
8526 </p>
8527 </dd>
8528 <dt class="hdlist1">
8529 <code>gvimdiff</code>
8530 </dt>
8531 <dd>
8532 <p>
8533 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8534 </p>
8535 </dd>
8536 <dt class="hdlist1">
8537 <code>gvimdiff1</code>
8538 </dt>
8539 <dd>
8540 <p>
8541 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
8542 </p>
8543 </dd>
8544 <dt class="hdlist1">
8545 <code>gvimdiff2</code>
8546 </dt>
8547 <dd>
8548 <p>
8549 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
8550 </p>
8551 </dd>
8552 <dt class="hdlist1">
8553 <code>gvimdiff3</code>
8554 </dt>
8555 <dd>
8556 <p>
8557 Use gVim (requires a graphical session) where only the MERGED file is shown
8558 </p>
8559 </dd>
8560 <dt class="hdlist1">
8561 <code>kdiff3</code>
8562 </dt>
8563 <dd>
8564 <p>
8565 Use KDiff3 (requires a graphical session)
8566 </p>
8567 </dd>
8568 <dt class="hdlist1">
8569 <code>meld</code>
8570 </dt>
8571 <dd>
8572 <p>
8573 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
8574 </p>
8575 </dd>
8576 <dt class="hdlist1">
8577 <code>nvimdiff</code>
8578 </dt>
8579 <dd>
8580 <p>
8581 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8582 </p>
8583 </dd>
8584 <dt class="hdlist1">
8585 <code>nvimdiff1</code>
8586 </dt>
8587 <dd>
8588 <p>
8589 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
8590 </p>
8591 </dd>
8592 <dt class="hdlist1">
8593 <code>nvimdiff2</code>
8594 </dt>
8595 <dd>
8596 <p>
8597 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8598 </p>
8599 </dd>
8600 <dt class="hdlist1">
8601 <code>nvimdiff3</code>
8602 </dt>
8603 <dd>
8604 <p>
8605 Use Neovim where only the MERGED file is shown
8606 </p>
8607 </dd>
8608 <dt class="hdlist1">
8609 <code>opendiff</code>
8610 </dt>
8611 <dd>
8612 <p>
8613 Use FileMerge (requires a graphical session)
8614 </p>
8615 </dd>
8616 <dt class="hdlist1">
8617 <code>p4merge</code>
8618 </dt>
8619 <dd>
8620 <p>
8621 Use HelixCore P4Merge (requires a graphical session)
8622 </p>
8623 </dd>
8624 <dt class="hdlist1">
8625 <code>smerge</code>
8626 </dt>
8627 <dd>
8628 <p>
8629 Use Sublime Merge (requires a graphical session)
8630 </p>
8631 </dd>
8632 <dt class="hdlist1">
8633 <code>tkdiff</code>
8634 </dt>
8635 <dd>
8636 <p>
8637 Use TkDiff (requires a graphical session)
8638 </p>
8639 </dd>
8640 <dt class="hdlist1">
8641 <code>tortoisemerge</code>
8642 </dt>
8643 <dd>
8644 <p>
8645 Use TortoiseMerge (requires a graphical session)
8646 </p>
8647 </dd>
8648 <dt class="hdlist1">
8649 <code>vimdiff</code>
8650 </dt>
8651 <dd>
8652 <p>
8653 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8654 </p>
8655 </dd>
8656 <dt class="hdlist1">
8657 <code>vimdiff1</code>
8658 </dt>
8659 <dd>
8660 <p>
8661 Use Vim with a 2 panes layout (LOCAL and REMOTE)
8662 </p>
8663 </dd>
8664 <dt class="hdlist1">
8665 <code>vimdiff2</code>
8666 </dt>
8667 <dd>
8668 <p>
8669 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8670 </p>
8671 </dd>
8672 <dt class="hdlist1">
8673 <code>vimdiff3</code>
8674 </dt>
8675 <dd>
8676 <p>
8677 Use Vim where only the MERGED file is shown
8678 </p>
8679 </dd>
8680 <dt class="hdlist1">
8681 <code>winmerge</code>
8682 </dt>
8683 <dd>
8684 <p>
8685 Use WinMerge (requires a graphical session)
8686 </p>
8687 </dd>
8688 <dt class="hdlist1">
8689 <code>xxdiff</code>
8690 </dt>
8691 <dd>
8692 <p>
8693 Use xxdiff (requires a graphical session)
8694 </p>
8695 </dd>
8696 </dl></div>
8697 </dd>
8698 <dt class="hdlist1">
8699 merge.verbosity
8700 </dt>
8701 <dd>
8702 <p>
8703         Controls the amount of output shown by the recursive merge
8704         strategy.  Level 0 outputs nothing except a final error
8705         message if conflicts were detected. Level 1 outputs only
8706         conflicts, 2 outputs conflicts and file changes.  Level 5 and
8707         above outputs debugging information.  The default is level 2.
8708         Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
8709 </p>
8710 </dd>
8711 <dt class="hdlist1">
8712 merge.&lt;driver&gt;.name
8713 </dt>
8714 <dd>
8715 <p>
8716         Defines a human-readable name for a custom low-level
8717         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8718 </p>
8719 </dd>
8720 <dt class="hdlist1">
8721 merge.&lt;driver&gt;.driver
8722 </dt>
8723 <dd>
8724 <p>
8725         Defines the command that implements a custom low-level
8726         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8727 </p>
8728 </dd>
8729 <dt class="hdlist1">
8730 merge.&lt;driver&gt;.recursive
8731 </dt>
8732 <dd>
8733 <p>
8734         Names a low-level merge driver to be used when
8735         performing an internal merge between common ancestors.
8736         See <a href="gitattributes.html">gitattributes(5)</a> for details.
8737 </p>
8738 </dd>
8739 <dt class="hdlist1">
8740 mergetool.&lt;tool&gt;.path
8741 </dt>
8742 <dd>
8743 <p>
8744         Override the path for the given tool.  This is useful in case
8745         your tool is not in the PATH.
8746 </p>
8747 </dd>
8748 <dt class="hdlist1">
8749 mergetool.&lt;tool&gt;.cmd
8750 </dt>
8751 <dd>
8752 <p>
8753         Specify the command to invoke the specified merge tool.  The
8754         specified command is evaluated in shell with the following
8755         variables available: <em>BASE</em> is the name of a temporary file
8756         containing the common base of the files to be merged, if available;
8757         <em>LOCAL</em> is the name of a temporary file containing the contents of
8758         the file on the current branch; <em>REMOTE</em> is the name of a temporary
8759         file containing the contents of the file from the branch being
8760         merged; <em>MERGED</em> contains the name of the file to which the merge
8761         tool should write the results of a successful merge.
8762 </p>
8763 </dd>
8764 <dt class="hdlist1">
8765 mergetool.&lt;tool&gt;.hideResolved
8766 </dt>
8767 <dd>
8768 <p>
8769         Allows the user to override the global <code>mergetool.hideResolved</code> value
8770         for a specific tool. See <code>mergetool.hideResolved</code> for the full
8771         description.
8772 </p>
8773 </dd>
8774 <dt class="hdlist1">
8775 mergetool.&lt;tool&gt;.trustExitCode
8776 </dt>
8777 <dd>
8778 <p>
8779         For a custom merge command, specify whether the exit code of
8780         the merge command can be used to determine whether the merge was
8781         successful.  If this is not set to true then the merge target file
8782         timestamp is checked, and the merge is assumed to have been successful
8783         if the file has been updated; otherwise, the user is prompted to
8784         indicate the success of the merge.
8785 </p>
8786 </dd>
8787 <dt class="hdlist1">
8788 mergetool.meld.hasOutput
8789 </dt>
8790 <dd>
8791 <p>
8792         Older versions of <code>meld</code> do not support the <code>--output</code> option.
8793         Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
8794         by inspecting the output of <code>meld --help</code>.  Configuring
8795         <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
8796         use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
8797         to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
8798         and <code>false</code> avoids using <code>--output</code>.
8799 </p>
8800 </dd>
8801 <dt class="hdlist1">
8802 mergetool.meld.useAutoMerge
8803 </dt>
8804 <dd>
8805 <p>
8806         When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
8807         parts automatically, highlight the conflicting parts, and wait for
8808         user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
8809         Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
8810         Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
8811         is supported and will only use <code>--auto-merge</code> when available.  A
8812         value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
8813         default value.
8814 </p>
8815 </dd>
8816 <dt class="hdlist1">
8817 mergetool.vimdiff.layout
8818 </dt>
8819 <dd>
8820 <p>
8821         The vimdiff backend uses this variable to control how its split
8822         windows appear. Applies even if you are using Neovim (<code>nvim</code>) or
8823         gVim (<code>gvim</code>) as the merge tool. See BACKEND SPECIFIC HINTS section
8824         in <a href="git-mergetool.html">git-mergetool(1)</a>.
8825         for details.
8826 </p>
8827 </dd>
8828 <dt class="hdlist1">
8829 mergetool.hideResolved
8830 </dt>
8831 <dd>
8832 <p>
8833         During a merge, Git will automatically resolve as many conflicts as
8834         possible and write the <em>MERGED</em> file containing conflict markers around
8835         any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
8836         represent the versions of the file from before Git&#8217;s conflict
8837         resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
8838         that only the unresolved conflicts are presented to the merge tool. Can
8839         be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
8840         configuration variable. Defaults to <code>false</code>.
8841 </p>
8842 </dd>
8843 <dt class="hdlist1">
8844 mergetool.keepBackup
8845 </dt>
8846 <dd>
8847 <p>
8848         After performing a merge, the original file with conflict markers
8849         can be saved as a file with a <code>.orig</code> extension.  If this variable
8850         is set to <code>false</code> then this file is not preserved.  Defaults to
8851         <code>true</code> (i.e. keep the backup files).
8852 </p>
8853 </dd>
8854 <dt class="hdlist1">
8855 mergetool.keepTemporaries
8856 </dt>
8857 <dd>
8858 <p>
8859         When invoking a custom merge tool, Git uses a set of temporary
8860         files to pass to the tool. If the tool returns an error and this
8861         variable is set to <code>true</code>, then these temporary files will be
8862         preserved; otherwise, they will be removed after the tool has
8863         exited. Defaults to <code>false</code>.
8864 </p>
8865 </dd>
8866 <dt class="hdlist1">
8867 mergetool.writeToTemp
8868 </dt>
8869 <dd>
8870 <p>
8871         Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
8872         conflicting files in the worktree by default.  Git will attempt
8873         to use a temporary directory for these files when set <code>true</code>.
8874         Defaults to <code>false</code>.
8875 </p>
8876 </dd>
8877 <dt class="hdlist1">
8878 mergetool.prompt
8879 </dt>
8880 <dd>
8881 <p>
8882         Prompt before each invocation of the merge resolution program.
8883 </p>
8884 </dd>
8885 <dt class="hdlist1">
8886 mergetool.guiDefault
8887 </dt>
8888 <dd>
8889 <p>
8890         Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
8891         specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
8892         or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
8893         variable value. The default is <code>false</code>, where the <code>--gui</code> argument
8894         must be provided explicitly for the <code>merge.guitool</code> to be used.
8895 </p>
8896 </dd>
8897 <dt class="hdlist1">
8898 notes.mergeStrategy
8899 </dt>
8900 <dd>
8901 <p>
8902         Which merge strategy to choose by default when resolving notes
8903         conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
8904         <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
8905         section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
8906 </p>
8907 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
8908 <a href="git-notes.html">git-notes(1)</a>.</p></div>
8909 </dd>
8910 <dt class="hdlist1">
8911 notes.&lt;name&gt;.mergeStrategy
8912 </dt>
8913 <dd>
8914 <p>
8915         Which merge strategy to choose when doing a notes merge into
8916         refs/notes/&lt;name&gt;.  This overrides the more general
8917         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
8918         <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
8919 </p>
8920 </dd>
8921 <dt class="hdlist1">
8922 notes.displayRef
8923 </dt>
8924 <dd>
8925 <p>
8926         Which ref (or refs, if a glob or specified more than once), in
8927         addition to the default set by <code>core.notesRef</code> or
8928         <code>GIT_NOTES_REF</code>, to read notes from when showing commit
8929         messages with the <em>git log</em> family of commands.
8930 </p>
8931 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
8932 environment variable, which must be a colon separated list of refs or
8933 globs.</p></div>
8934 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
8935 but a glob that does not match any refs is silently ignored.</p></div>
8936 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
8937 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
8938 those commands.</p></div>
8939 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
8940 GIT_NOTES_REF) is also implicitly added to the list of refs to be
8941 displayed.</p></div>
8942 </dd>
8943 <dt class="hdlist1">
8944 notes.rewrite.&lt;command&gt;
8945 </dt>
8946 <dd>
8947 <p>
8948         When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
8949         <code>rebase</code>), if this variable is <code>false</code>, git will not copy
8950         notes from the original to the rewritten commit.  Defaults to
8951         <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.
8952 </p>
8953 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
8954 environment variable, which must be a colon separated list of refs or
8955 globs.</p></div>
8956 </dd>
8957 <dt class="hdlist1">
8958 notes.rewriteMode
8959 </dt>
8960 <dd>
8961 <p>
8962         When copying notes during a rewrite (see the
8963         "notes.rewrite.&lt;command&gt;" option), determines what to do if
8964         the target commit already has a note.  Must be one of
8965         <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
8966         Defaults to <code>concatenate</code>.
8967 </p>
8968 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
8969 environment variable.</p></div>
8970 </dd>
8971 <dt class="hdlist1">
8972 notes.rewriteRef
8973 </dt>
8974 <dd>
8975 <p>
8976         When copying notes during a rewrite, specifies the (fully
8977         qualified) ref whose notes should be copied.  May be a glob,
8978         in which case notes in all matching refs will be copied.  You
8979         may also specify this configuration several times.
8980 </p>
8981 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
8982 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
8983 rewriting for the default commit notes.</p></div>
8984 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
8985 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
8986 </dd>
8987 <dt class="hdlist1">
8988 pack.window
8989 </dt>
8990 <dd>
8991 <p>
8992         The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
8993         window size is given on the command line. Defaults to 10.
8994 </p>
8995 </dd>
8996 <dt class="hdlist1">
8997 pack.depth
8998 </dt>
8999 <dd>
9000 <p>
9001         The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9002         maximum depth is given on the command line. Defaults to 50.
9003         Maximum value is 4095.
9004 </p>
9005 </dd>
9006 <dt class="hdlist1">
9007 pack.windowMemory
9008 </dt>
9009 <dd>
9010 <p>
9011         The maximum size of memory that is consumed by each thread
9012         in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
9013         no limit is given on the command line.  The value can be
9014         suffixed with "k", "m", or "g".  When left unconfigured (or
9015         set explicitly to 0), there will be no limit.
9016 </p>
9017 </dd>
9018 <dt class="hdlist1">
9019 pack.compression
9020 </dt>
9021 <dd>
9022 <p>
9023         An integer -1..9, indicating the compression level for objects
9024         in a pack file. -1 is the zlib default. 0 means no
9025         compression, and 1..9 are various speed/size tradeoffs, 9 being
9026         slowest.  If not set,  defaults to core.compression.  If that is
9027         not set,  defaults to -1, the zlib default, which is "a default
9028         compromise between speed and compression (currently equivalent
9029         to level 6)."
9030 </p>
9031 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
9032 all existing objects. You can force recompression by passing the -F option
9033 to <a href="git-repack.html">git-repack(1)</a>.</p></div>
9034 </dd>
9035 <dt class="hdlist1">
9036 pack.allowPackReuse
9037 </dt>
9038 <dd>
9039 <p>
9040         When true or "single", and when reachability bitmaps are
9041         enabled, pack-objects will try to send parts of the bitmapped
9042         packfile verbatim. When "multi", and when a multi-pack
9043         reachability bitmap is available, pack-objects will try to send
9044         parts of all packs in the MIDX.
9045 </p>
9046 <div class="literalblock">
9047 <div class="content">
9048 <pre><code>If only a single pack bitmap is available, and
9049 `pack.allowPackReuse` is set to "multi", reuse parts of just the
9050 bitmapped packfile. This can reduce memory and CPU usage to
9051 serve fetches, but might result in sending a slightly larger
9052 pack. Defaults to true.</code></pre>
9053 </div></div>
9054 </dd>
9055 <dt class="hdlist1">
9056 pack.island
9057 </dt>
9058 <dd>
9059 <p>
9060         An extended regular expression configuring a set of delta
9061         islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
9062         for details.
9063 </p>
9064 </dd>
9065 <dt class="hdlist1">
9066 pack.islandCore
9067 </dt>
9068 <dd>
9069 <p>
9070         Specify an island name which gets to have its objects be
9071         packed first. This creates a kind of pseudo-pack at the front
9072         of one pack, so that the objects from the specified island are
9073         hopefully faster to copy into any pack that should be served
9074         to a user requesting these objects. In practice this means
9075         that the island specified should likely correspond to what is
9076         the most commonly cloned in the repo. See also "DELTA ISLANDS"
9077         in <a href="git-pack-objects.html">git-pack-objects(1)</a>.
9078 </p>
9079 </dd>
9080 <dt class="hdlist1">
9081 pack.deltaCacheSize
9082 </dt>
9083 <dd>
9084 <p>
9085         The maximum memory in bytes used for caching deltas in
9086         <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
9087         This cache is used to speed up the writing object phase by not
9088         having to recompute the final delta result once the best match
9089         for all objects is found.  Repacking large repositories on machines
9090         which are tight with memory might be badly impacted by this though,
9091         especially if this cache pushes the system into swapping.
9092         A value of 0 means no limit. The smallest size of 1 byte may be
9093         used to virtually disable this cache. Defaults to 256 MiB.
9094 </p>
9095 </dd>
9096 <dt class="hdlist1">
9097 pack.deltaCacheLimit
9098 </dt>
9099 <dd>
9100 <p>
9101         The maximum size of a delta, that is cached in
9102         <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
9103         writing object phase by not having to recompute the final delta
9104         result once the best match for all objects is found.
9105         Defaults to 1000. Maximum value is 65535.
9106 </p>
9107 </dd>
9108 <dt class="hdlist1">
9109 pack.threads
9110 </dt>
9111 <dd>
9112 <p>
9113         Specifies the number of threads to spawn when searching for best
9114         delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
9115         be compiled with pthreads otherwise this option is ignored with a
9116         warning. This is meant to reduce packing time on multiprocessor
9117         machines. The required amount of memory for the delta search window
9118         is however multiplied by the number of threads.
9119         Specifying 0 will cause Git to auto-detect the number of CPUs
9120         and set the number of threads accordingly.
9121 </p>
9122 </dd>
9123 <dt class="hdlist1">
9124 pack.indexVersion
9125 </dt>
9126 <dd>
9127 <p>
9128         Specify the default pack index version.  Valid values are 1 for
9129         legacy pack index used by Git versions prior to 1.5.2, and 2 for
9130         the new pack index with capabilities for packs larger than 4 GB
9131         as well as proper protection against the repacking of corrupted
9132         packs.  Version 2 is the default.  Note that version 2 is enforced
9133         and this config option is ignored whenever the corresponding pack is
9134         larger than 2 GB.
9135 </p>
9136 <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9137 cloning or fetching over a non-native protocol (e.g. "http")
9138 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9139 other side may give you a repository that cannot be accessed with your
9140 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9141 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
9142 the <code>*.idx</code> file.</p></div>
9143 </dd>
9144 <dt class="hdlist1">
9145 pack.packSizeLimit
9146 </dt>
9147 <dd>
9148 <p>
9149         The maximum size of a pack.  This setting only affects
9150         packing to a file when repacking, i.e. the git:// protocol
9151         is unaffected.  It can be overridden by the <code>--max-pack-size</code>
9152         option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
9153         in the creation of multiple packfiles.
9154 </p>
9155 <div class="paragraph"><p>Note that this option is rarely useful, and may result in a larger total
9156 on-disk size (because Git will not store deltas between packs) and
9157 worse runtime performance (object lookup within multiple packs is
9158 slower than a single pack, and optimizations like reachability bitmaps
9159 cannot cope with multiple packs).</p></div>
9160 <div class="paragraph"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9161 filesystem does not support large files), this option may help. But if
9162 your goal is to transmit a packfile over a medium that supports limited
9163 sizes (e.g., removable media that cannot store the whole repository),
9164 you are likely better off creating a single large packfile and splitting
9165 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9166 <div class="paragraph"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9167 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9168 </dd>
9169 <dt class="hdlist1">
9170 pack.useBitmaps
9171 </dt>
9172 <dd>
9173 <p>
9174         When true, git will use pack bitmaps (if available) when packing
9175         to stdout (e.g., during the server side of a fetch). Defaults to
9176         true. You should not generally need to turn this off unless
9177         you are debugging pack bitmaps.
9178 </p>
9179 </dd>
9180 <dt class="hdlist1">
9181 pack.useBitmapBoundaryTraversal
9182 </dt>
9183 <dd>
9184 <p>
9185         When true, Git will use an experimental algorithm for computing
9186         reachability queries with bitmaps. Instead of building up
9187         complete bitmaps for all of the negated tips and then OR-ing
9188         them together, consider negated tips with existing bitmaps as
9189         additive (i.e. OR-ing them into the result if they exist,
9190         ignoring them otherwise), and build up a bitmap at the boundary
9191         instead.
9192 </p>
9193 <div class="paragraph"><p>When using this algorithm, Git may include too many objects as a result
9194 of not opening up trees belonging to certain UNINTERESTING commits. This
9195 inexactness matches the non-bitmap traversal algorithm.</p></div>
9196 <div class="paragraph"><p>In many cases, this can provide a speed-up over the exact algorithm,
9197 particularly when there is poor bitmap coverage of the negated side of
9198 the query.</p></div>
9199 </dd>
9200 <dt class="hdlist1">
9201 pack.useSparse
9202 </dt>
9203 <dd>
9204 <p>
9205         When true, git will default to using the <em>--sparse</em> option in
9206         <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9207         algorithm only walks trees that appear in paths that introduce new
9208         objects. This can have significant performance benefits when
9209         computing a pack to send a small change. However, it is possible
9210         that extra objects are added to the pack-file if the included
9211         commits contain certain types of direct renames. Default is
9212         <code>true</code>.
9213 </p>
9214 </dd>
9215 <dt class="hdlist1">
9216 pack.preferBitmapTips
9217 </dt>
9218 <dd>
9219 <p>
9220         When selecting which commits will receive bitmaps, prefer a
9221         commit at the tip of any reference that is a suffix of any value
9222         of this configuration over any other commits in the "selection
9223         window".
9224 </p>
9225 <div class="paragraph"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9226 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9227 necessarily be selected. This is because commits are selected for
9228 bitmaps from within a series of windows of variable length.</p></div>
9229 <div class="paragraph"><p>If a commit at the tip of any reference which is a suffix of any value
9230 of this configuration is seen in a window, it is immediately given
9231 preference over any other commit in that window.</p></div>
9232 </dd>
9233 <dt class="hdlist1">
9234 pack.writeBitmaps (deprecated)
9235 </dt>
9236 <dd>
9237 <p>
9238         This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9239 </p>
9240 </dd>
9241 <dt class="hdlist1">
9242 pack.writeBitmapHashCache
9243 </dt>
9244 <dd>
9245 <p>
9246         When true, git will include a "hash cache" section in the bitmap
9247         index (if one is written). This cache can be used to feed git&#8217;s
9248         delta heuristics, potentially leading to better deltas between
9249         bitmapped and non-bitmapped objects (e.g., when serving a fetch
9250         between an older, bitmapped pack and objects that have been
9251         pushed since the last gc). The downside is that it consumes 4
9252         bytes per object of disk space. Defaults to true.
9253 </p>
9254 <div class="paragraph"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9255 computed; instead, any namehashes stored in an existing bitmap are
9256 permuted into their appropriate location when writing a new bitmap.</p></div>
9257 </dd>
9258 <dt class="hdlist1">
9259 pack.writeBitmapLookupTable
9260 </dt>
9261 <dd>
9262 <p>
9263         When true, Git will include a "lookup table" section in the
9264         bitmap index (if one is written). This table is used to defer
9265         loading individual bitmaps as late as possible. This can be
9266         beneficial in repositories that have relatively large bitmap
9267         indexes. Defaults to false.
9268 </p>
9269 </dd>
9270 <dt class="hdlist1">
9271 pack.readReverseIndex
9272 </dt>
9273 <dd>
9274 <p>
9275         When true, git will read any .rev file(s) that may be available
9276         (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
9277         will be generated from scratch and stored in memory. Defaults to
9278         true.
9279 </p>
9280 </dd>
9281 <dt class="hdlist1">
9282 pack.writeReverseIndex
9283 </dt>
9284 <dd>
9285 <p>
9286         When true, git will write a corresponding .rev file (see:
9287         <a href="gitformat-pack.html">gitformat-pack(5)</a>)
9288         for each new packfile that it writes in all places except for
9289         <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
9290         Defaults to true.
9291 </p>
9292 </dd>
9293 <dt class="hdlist1">
9294 pager.&lt;cmd&gt;
9295 </dt>
9296 <dd>
9297 <p>
9298         If the value is boolean, turns on or off pagination of the
9299         output of a particular Git subcommand when writing to a tty.
9300         Otherwise, turns on pagination for the subcommand using the
9301         pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
9302         or <code>--no-pager</code> is specified on the command line, it takes
9303         precedence over this option.  To disable pagination for all
9304         commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9305 </p>
9306 </dd>
9307 <dt class="hdlist1">
9308 pretty.&lt;name&gt;
9309 </dt>
9310 <dd>
9311 <p>
9312         Alias for a --pretty= format string, as specified in
9313         <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
9314         as the built-in pretty formats could. For example,
9315         running <code>git config pretty.changelog "format:* %H %s"</code>
9316         would cause the invocation <code>git log --pretty=changelog</code>
9317         to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
9318         Note that an alias with the same name as a built-in format
9319         will be silently ignored.
9320 </p>
9321 </dd>
9322 <dt class="hdlist1">
9323 protocol.allow
9324 </dt>
9325 <dd>
9326 <p>
9327         If set, provide a user defined default policy for all protocols which
9328         don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
9329         if unset, known-safe protocols (http, https, git, ssh) have a
9330         default policy of <code>always</code>, known-dangerous protocols (ext) have a
9331         default policy of <code>never</code>, and all other protocols (including file)
9332         have a default policy of <code>user</code>.  Supported policies:
9333 </p>
9334 <div class="openblock">
9335 <div class="content">
9336 <div class="ulist"><ul>
9337 <li>
9338 <p>
9339 <code>always</code> - protocol is always able to be used.
9340 </p>
9341 </li>
9342 <li>
9343 <p>
9344 <code>never</code> - protocol is never able to be used.
9345 </p>
9346 </li>
9347 <li>
9348 <p>
9349 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9350   either unset or has a value of 1.  This policy should be used when you want a
9351   protocol to be directly usable by the user but don&#8217;t want it used by commands which
9352   execute clone/fetch/push commands without user input, e.g. recursive
9353   submodule initialization.
9354 </p>
9355 </li>
9356 </ul></div>
9357 </div></div>
9358 </dd>
9359 <dt class="hdlist1">
9360 protocol.&lt;name&gt;.allow
9361 </dt>
9362 <dd>
9363 <p>
9364         Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
9365         commands. See <code>protocol.allow</code> above for the available policies.
9366 </p>
9367 <div class="paragraph"><p>The protocol names currently used by git are:</p></div>
9368 <div class="openblock">
9369 <div class="content">
9370 <div class="ulist"><ul>
9371 <li>
9372 <p>
9373 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9374     or local paths)
9375 </p>
9376 </li>
9377 <li>
9378 <p>
9379 <code>git</code>: the anonymous git protocol over a direct TCP
9380     connection (or proxy, if configured)
9381 </p>
9382 </li>
9383 <li>
9384 <p>
9385 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9386     <code>ssh://</code>, etc).
9387 </p>
9388 </li>
9389 <li>
9390 <p>
9391 <code>http</code>: git over http, both "smart http" and "dumb http".
9392     Note that this does <em>not</em> include <code>https</code>; if you want to configure
9393     both, you must do so individually.
9394 </p>
9395 </li>
9396 <li>
9397 <p>
9398 any external helpers are named by their protocol (e.g., use
9399     <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9400 </p>
9401 </li>
9402 </ul></div>
9403 </div></div>
9404 </dd>
9405 <dt class="hdlist1">
9406 protocol.version
9407 </dt>
9408 <dd>
9409 <p>
9410         If set, clients will attempt to communicate with a server
9411         using the specified protocol version.  If the server does
9412         not support it, communication falls back to version 0.
9413         If unset, the default is <code>2</code>.
9414         Supported versions:
9415 </p>
9416 <div class="openblock">
9417 <div class="content">
9418 <div class="ulist"><ul>
9419 <li>
9420 <p>
9421 <code>0</code> - the original wire protocol.
9422 </p>
9423 </li>
9424 <li>
9425 <p>
9426 <code>1</code> - the original wire protocol with the addition of a version string
9427   in the initial response from the server.
9428 </p>
9429 </li>
9430 <li>
9431 <p>
9432 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.
9433 </p>
9434 </li>
9435 </ul></div>
9436 </div></div>
9437 </dd>
9438 <dt class="hdlist1">
9439 pull.ff
9440 </dt>
9441 <dd>
9442 <p>
9443         By default, Git does not create an extra merge commit when merging
9444         a commit that is a descendant of the current commit. Instead, the
9445         tip of the current branch is fast-forwarded. When set to <code>false</code>,
9446         this variable tells Git to create an extra merge commit in such
9447         a case (equivalent to giving the <code>--no-ff</code> option from the command
9448         line). When set to <code>only</code>, only such fast-forward merges are
9449         allowed (equivalent to giving the <code>--ff-only</code> option from the
9450         command line). This setting overrides <code>merge.ff</code> when pulling.
9451 </p>
9452 </dd>
9453 <dt class="hdlist1">
9454 pull.rebase
9455 </dt>
9456 <dd>
9457 <p>
9458         When true, rebase branches on top of the fetched branch, instead
9459         of merging the default branch from the default remote when "git
9460         pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
9461         per-branch basis.
9462 </p>
9463 <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>
9464 so that the local merge commits are included in the rebase (see
9465 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
9466 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9467 mode.</p></div>
9468 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9469 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
9470 for details).</p></div>
9471 </dd>
9472 <dt class="hdlist1">
9473 pull.octopus
9474 </dt>
9475 <dd>
9476 <p>
9477         The default merge strategy to use when pulling multiple branches
9478         at once.
9479 </p>
9480 </dd>
9481 <dt class="hdlist1">
9482 pull.twohead
9483 </dt>
9484 <dd>
9485 <p>
9486         The default merge strategy to use when pulling a single branch.
9487 </p>
9488 </dd>
9489 <dt class="hdlist1">
9490 push.autoSetupRemote
9491 </dt>
9492 <dd>
9493 <p>
9494         If set to "true" assume <code>--set-upstream</code> on default push when no
9495         upstream tracking exists for the current branch; this option
9496         takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9497         and <em>current</em>. It is useful if by default you want new branches
9498         to be pushed to the default remote (like the behavior of
9499         <em>push.default=current</em>) and you also want the upstream tracking
9500         to be set. Workflows most likely to benefit from this option are
9501         <em>simple</em> central workflows where all branches are expected to
9502         have the same name on the remote.
9503 </p>
9504 </dd>
9505 <dt class="hdlist1">
9506 push.default
9507 </dt>
9508 <dd>
9509 <p>
9510         Defines the action <code>git push</code> should take if no refspec is
9511         given (whether from the command-line, config, or elsewhere).
9512         Different values are well-suited for
9513         specific workflows; for instance, in a purely central workflow
9514         (i.e. the fetch source is equal to the push destination),
9515         <code>upstream</code> is probably what you want.  Possible values are:
9516 </p>
9517 <div class="openblock">
9518 <div class="content">
9519 <div class="ulist"><ul>
9520 <li>
9521 <p>
9522 <code>nothing</code> - do not push anything (error out) unless a refspec is
9523   given. This is primarily meant for people who want to
9524   avoid mistakes by always being explicit.
9525 </p>
9526 </li>
9527 <li>
9528 <p>
9529 <code>current</code> - push the current branch to update a branch with the same
9530   name on the receiving end.  Works in both central and non-central
9531   workflows.
9532 </p>
9533 </li>
9534 <li>
9535 <p>
9536 <code>upstream</code> - push the current branch back to the branch whose
9537   changes are usually integrated into the current branch (which is
9538   called <code>@{upstream}</code>).  This mode only makes sense if you are
9539   pushing to the same repository you would normally pull from
9540   (i.e. central workflow).
9541 </p>
9542 </li>
9543 <li>
9544 <p>
9545 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
9546 </p>
9547 </li>
9548 <li>
9549 <p>
9550 <code>simple</code> - push the current branch with the same name on the remote.
9551 </p>
9552 <div class="paragraph"><p>If you are working on a centralized workflow (pushing to the same repository you
9553 pull from, which is typically <code>origin</code>), then you need to configure an upstream
9554 branch with the same name.</p></div>
9555 <div class="paragraph"><p>This mode is the default since Git 2.0, and is the safest option suited for
9556 beginners.</p></div>
9557 </li>
9558 <li>
9559 <p>
9560 <code>matching</code> - push all branches having the same name on both ends.
9561   This makes the repository you are pushing to remember the set of
9562   branches that will be pushed out (e.g. if you always push <em>maint</em>
9563   and <em>master</em> there and no other branches, the repository you push
9564   to will have these two branches, and your local <em>maint</em> and
9565   <em>master</em> will be pushed there).
9566 </p>
9567 <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
9568 branches you would push out are ready to be pushed out before
9569 running <em>git push</em>, as the whole point of this mode is to allow you
9570 to push all of the branches in one go.  If you usually finish work
9571 on only one branch and push out the result, while other branches are
9572 unfinished, this mode is not for you.  Also this mode is not
9573 suitable for pushing into a shared central repository, as other
9574 people may add new branches there, or update the tip of existing
9575 branches outside your control.</p></div>
9576 <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
9577 new default).</p></div>
9578 </li>
9579 </ul></div>
9580 </div></div>
9581 </dd>
9582 <dt class="hdlist1">
9583 push.followTags
9584 </dt>
9585 <dd>
9586 <p>
9587         If set to true, enable <code>--follow-tags</code> option by default.  You
9588         may override this configuration at time of push by specifying
9589         <code>--no-follow-tags</code>.
9590 </p>
9591 </dd>
9592 <dt class="hdlist1">
9593 push.gpgSign
9594 </dt>
9595 <dd>
9596 <p>
9597         May be set to a boolean value, or the string <em>if-asked</em>. A true
9598         value causes all pushes to be GPG signed, as if <code>--signed</code> is
9599         passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
9600         pushes to be signed if the server supports it, as if
9601         <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
9602         override a value from a lower-priority config file. An explicit
9603         command-line flag always overrides this config option.
9604 </p>
9605 </dd>
9606 <dt class="hdlist1">
9607 push.pushOption
9608 </dt>
9609 <dd>
9610 <p>
9611         When no <code>--push-option=&lt;option&gt;</code> argument is given from the
9612         command line, <code>git push</code> behaves as if each &lt;value&gt; of
9613         this variable is given as <code>--push-option=&lt;value&gt;</code>.
9614 </p>
9615 <div class="paragraph"><p>This is a multi-valued variable, and an empty value can be used in a
9616 higher priority configuration file (e.g. <code>.git/config</code> in a
9617 repository) to clear the values inherited from a lower priority
9618 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
9619 <div class="listingblock">
9620 <div class="content">
9621 <pre><code>Example:
9622
9623 /etc/gitconfig
9624   push.pushoption = a
9625   push.pushoption = b
9626
9627 ~/.gitconfig
9628   push.pushoption = c
9629
9630 repo/.git/config
9631   push.pushoption =
9632   push.pushoption = b
9633
9634 This will result in only b (a and c are cleared).</code></pre>
9635 </div></div>
9636 </dd>
9637 <dt class="hdlist1">
9638 push.recurseSubmodules
9639 </dt>
9640 <dd>
9641 <p>
9642         May be "check", "on-demand", "only", or "no", with the same behavior
9643         as that of "push --recurse-submodules".
9644         If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
9645         set (in which case a <em>true</em> value means <em>on-demand</em>).
9646 </p>
9647 </dd>
9648 <dt class="hdlist1">
9649 push.useForceIfIncludes
9650 </dt>
9651 <dd>
9652 <p>
9653         If set to "true", it is equivalent to specifying
9654         <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
9655         in the command line. Adding <code>--no-force-if-includes</code> at the
9656         time of push overrides this configuration setting.
9657 </p>
9658 </dd>
9659 <dt class="hdlist1">
9660 push.negotiate
9661 </dt>
9662 <dd>
9663 <p>
9664         If set to "true", attempt to reduce the size of the packfile
9665         sent by rounds of negotiation in which the client and the
9666         server attempt to find commits in common. If "false", Git will
9667         rely solely on the server&#8217;s ref advertisement to find commits
9668         in common.
9669 </p>
9670 </dd>
9671 <dt class="hdlist1">
9672 push.useBitmaps
9673 </dt>
9674 <dd>
9675 <p>
9676         If set to "false", disable use of bitmaps for "git push" even if
9677         <code>pack.useBitmaps</code> is "true", without preventing other git operations
9678         from using bitmaps. Default is true.
9679 </p>
9680 </dd>
9681 <dt class="hdlist1">
9682 rebase.backend
9683 </dt>
9684 <dd>
9685 <p>
9686         Default backend to use for rebasing.  Possible choices are
9687         <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
9688         all remaining capabilities of the apply backend, this setting
9689         may become unused.
9690 </p>
9691 </dd>
9692 <dt class="hdlist1">
9693 rebase.stat
9694 </dt>
9695 <dd>
9696 <p>
9697         Whether to show a diffstat of what changed upstream since the last
9698         rebase. False by default.
9699 </p>
9700 </dd>
9701 <dt class="hdlist1">
9702 rebase.autoSquash
9703 </dt>
9704 <dd>
9705 <p>
9706         If set to true, enable the <code>--autosquash</code> option of
9707         <a href="git-rebase.html">git-rebase(1)</a> by default for interactive mode.
9708         This can be overridden with the <code>--no-autosquash</code> option.
9709 </p>
9710 </dd>
9711 <dt class="hdlist1">
9712 rebase.autoStash
9713 </dt>
9714 <dd>
9715 <p>
9716         When set to true, automatically create a temporary stash entry
9717         before the operation begins, and apply it after the operation
9718         ends.  This means that you can run rebase on a dirty worktree.
9719         However, use with care: the final stash application after a
9720         successful rebase might result in non-trivial conflicts.
9721         This option can be overridden by the <code>--no-autostash</code> and
9722         <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
9723         Defaults to false.
9724 </p>
9725 </dd>
9726 <dt class="hdlist1">
9727 rebase.updateRefs
9728 </dt>
9729 <dd>
9730 <p>
9731         If set to true enable <code>--update-refs</code> option by default.
9732 </p>
9733 </dd>
9734 <dt class="hdlist1">
9735 rebase.missingCommitsCheck
9736 </dt>
9737 <dd>
9738 <p>
9739         If set to "warn", git rebase -i will print a warning if some
9740         commits are removed (e.g. a line was deleted), however the
9741         rebase will still proceed. If set to "error", it will print
9742         the previous warning and stop the rebase, <em>git rebase
9743         --edit-todo</em> can then be used to correct the error. If set to
9744         "ignore", no checking is done.
9745         To drop a commit without warning or error, use the <code>drop</code>
9746         command in the todo list.
9747         Defaults to "ignore".
9748 </p>
9749 </dd>
9750 <dt class="hdlist1">
9751 rebase.instructionFormat
9752 </dt>
9753 <dd>
9754 <p>
9755         A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
9756         todo list during an interactive rebase.  The format will
9757         automatically have the commit hash prepended to the format.
9758 </p>
9759 </dd>
9760 <dt class="hdlist1">
9761 rebase.abbreviateCommands
9762 </dt>
9763 <dd>
9764 <p>
9765         If set to true, <code>git rebase</code> will use abbreviated command names in the
9766         todo list resulting in something like this:
9767 </p>
9768 <div class="listingblock">
9769 <div class="content">
9770 <pre><code>        p deadbee The oneline of the commit
9771         p fa1afe1 The oneline of the next commit
9772         ...</code></pre>
9773 </div></div>
9774 <div class="paragraph"><p>instead of:</p></div>
9775 <div class="listingblock">
9776 <div class="content">
9777 <pre><code>        pick deadbee The oneline of the commit
9778         pick fa1afe1 The oneline of the next commit
9779         ...</code></pre>
9780 </div></div>
9781 <div class="paragraph"><p>Defaults to false.</p></div>
9782 </dd>
9783 <dt class="hdlist1">
9784 rebase.rescheduleFailedExec
9785 </dt>
9786 <dd>
9787 <p>
9788         Automatically reschedule <code>exec</code> commands that failed. This only makes
9789         sense in interactive mode (or when an <code>--exec</code> option was provided).
9790         This is the same as specifying the <code>--reschedule-failed-exec</code> option.
9791 </p>
9792 </dd>
9793 <dt class="hdlist1">
9794 rebase.forkPoint
9795 </dt>
9796 <dd>
9797 <p>
9798         If set to false set <code>--no-fork-point</code> option by default.
9799 </p>
9800 </dd>
9801 <dt class="hdlist1">
9802 rebase.rebaseMerges
9803 </dt>
9804 <dd>
9805 <p>
9806         Whether and how to set the <code>--rebase-merges</code> option by default. Can
9807         be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
9808         true or to <code>no-rebase-cousins</code> is equivalent to
9809         <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
9810         equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
9811         equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
9812         command line, with or without an argument, overrides any
9813         <code>rebase.rebaseMerges</code> configuration.
9814 </p>
9815 </dd>
9816 <dt class="hdlist1">
9817 rebase.maxLabelLength
9818 </dt>
9819 <dd>
9820 <p>
9821         When generating label names from commit subjects, truncate the names to
9822         this length. By default, the names are truncated to a little less than
9823         <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
9824         corresponding loose refs).
9825 </p>
9826 </dd>
9827 <dt class="hdlist1">
9828 receive.advertiseAtomic
9829 </dt>
9830 <dd>
9831 <p>
9832         By default, git-receive-pack will advertise the atomic push
9833         capability to its clients. If you don&#8217;t want to advertise this
9834         capability, set this variable to false.
9835 </p>
9836 </dd>
9837 <dt class="hdlist1">
9838 receive.advertisePushOptions
9839 </dt>
9840 <dd>
9841 <p>
9842         When set to true, git-receive-pack will advertise the push options
9843         capability to its clients. False by default.
9844 </p>
9845 </dd>
9846 <dt class="hdlist1">
9847 receive.autogc
9848 </dt>
9849 <dd>
9850 <p>
9851         By default, git-receive-pack will run "git-gc --auto" after
9852         receiving data from git-push and updating refs.  You can stop
9853         it by setting this variable to false.
9854 </p>
9855 </dd>
9856 <dt class="hdlist1">
9857 receive.certNonceSeed
9858 </dt>
9859 <dd>
9860 <p>
9861         By setting this variable to a string, <code>git receive-pack</code>
9862         will accept a <code>git push --signed</code> and verify it by using
9863         a "nonce" protected by HMAC using this string as a secret
9864         key.
9865 </p>
9866 </dd>
9867 <dt class="hdlist1">
9868 receive.certNonceSlop
9869 </dt>
9870 <dd>
9871 <p>
9872         When a <code>git push --signed</code> sends a push certificate with a
9873         "nonce" that was issued by a receive-pack serving the same
9874         repository within this many seconds, export the "nonce"
9875         found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
9876         hooks (instead of what the receive-pack asked the sending
9877         side to include).  This may allow writing checks in
9878         <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
9879         checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
9880         that records by how many seconds the nonce is stale to
9881         decide if they want to accept the certificate, they only
9882         can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
9883 </p>
9884 </dd>
9885 <dt class="hdlist1">
9886 receive.fsckObjects
9887 </dt>
9888 <dd>
9889 <p>
9890         If it is set to true, git-receive-pack will check all received
9891         objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
9892         Defaults to false. If not set, the value of
9893         <code>transfer.fsckObjects</code> is used instead.
9894 </p>
9895 </dd>
9896 <dt class="hdlist1">
9897 receive.fsck.&lt;msg-id&gt;
9898 </dt>
9899 <dd>
9900 <p>
9901         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
9902         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
9903         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
9904         details.
9905 </p>
9906 </dd>
9907 <dt class="hdlist1">
9908 receive.fsck.skipList
9909 </dt>
9910 <dd>
9911 <p>
9912         Acts like <code>fsck.skipList</code>, but is used by
9913         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
9914         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
9915         details.
9916 </p>
9917 </dd>
9918 <dt class="hdlist1">
9919 receive.keepAlive
9920 </dt>
9921 <dd>
9922 <p>
9923         After receiving the pack from the client, <code>receive-pack</code> may
9924         produce no output (if <code>--quiet</code> was specified) while processing
9925         the pack, causing some networks to drop the TCP connection.
9926         With this option set, if <code>receive-pack</code> does not transmit
9927         any data in this phase for <code>receive.keepAlive</code> seconds, it will
9928         send a short keepalive packet.  The default is 5 seconds; set
9929         to 0 to disable keepalives entirely.
9930 </p>
9931 </dd>
9932 <dt class="hdlist1">
9933 receive.unpackLimit
9934 </dt>
9935 <dd>
9936 <p>
9937         If the number of objects received in a push is below this
9938         limit then the objects will be unpacked into loose object
9939         files. However if the number of received objects equals or
9940         exceeds this limit then the received pack will be stored as
9941         a pack, after adding any missing delta bases.  Storing the
9942         pack from a push can make the push operation complete faster,
9943         especially on slow filesystems.  If not set, the value of
9944         <code>transfer.unpackLimit</code> is used instead.
9945 </p>
9946 </dd>
9947 <dt class="hdlist1">
9948 receive.maxInputSize
9949 </dt>
9950 <dd>
9951 <p>
9952         If the size of the incoming pack stream is larger than this
9953         limit, then git-receive-pack will error out, instead of
9954         accepting the pack file. If not set or set to 0, then the size
9955         is unlimited.
9956 </p>
9957 </dd>
9958 <dt class="hdlist1">
9959 receive.denyDeletes
9960 </dt>
9961 <dd>
9962 <p>
9963         If set to true, git-receive-pack will deny a ref update that deletes
9964         the ref. Use this to prevent such a ref deletion via a push.
9965 </p>
9966 </dd>
9967 <dt class="hdlist1">
9968 receive.denyDeleteCurrent
9969 </dt>
9970 <dd>
9971 <p>
9972         If set to true, git-receive-pack will deny a ref update that
9973         deletes the currently checked out branch of a non-bare repository.
9974 </p>
9975 </dd>
9976 <dt class="hdlist1">
9977 receive.denyCurrentBranch
9978 </dt>
9979 <dd>
9980 <p>
9981         If set to true or "refuse", git-receive-pack will deny a ref update
9982         to the currently checked out branch of a non-bare repository.
9983         Such a push is potentially dangerous because it brings the HEAD
9984         out of sync with the index and working tree. If set to "warn",
9985         print a warning of such a push to stderr, but allow the push to
9986         proceed. If set to false or "ignore", allow such pushes with no
9987         message. Defaults to "refuse".
9988 </p>
9989 <div class="paragraph"><p>Another option is "updateInstead" which will update the working
9990 tree if pushing into the current branch.  This option is
9991 intended for synchronizing working directories when one side is not easily
9992 accessible via interactive ssh (e.g. a live web site, hence the requirement
9993 that the working directory be clean). This mode also comes in handy when
9994 developing inside a VM to test and fix code on different Operating Systems.</p></div>
9995 <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
9996 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
9997 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p></div>
9998 </dd>
9999 <dt class="hdlist1">
10000 receive.denyNonFastForwards
10001 </dt>
10002 <dd>
10003 <p>
10004         If set to true, git-receive-pack will deny a ref update which is
10005         not a fast-forward. Use this to prevent such an update via a push,
10006         even if that push is forced. This configuration variable is
10007         set when initializing a shared repository.
10008 </p>
10009 </dd>
10010 <dt class="hdlist1">
10011 receive.hideRefs
10012 </dt>
10013 <dd>
10014 <p>
10015         This variable is the same as <code>transfer.hideRefs</code>, but applies
10016         only to <code>receive-pack</code> (and so affects pushes, but not fetches).
10017         An attempt to update or delete a hidden ref by <code>git push</code> is
10018         rejected.
10019 </p>
10020 </dd>
10021 <dt class="hdlist1">
10022 receive.procReceiveRefs
10023 </dt>
10024 <dd>
10025 <p>
10026         This is a multi-valued variable that defines reference prefixes
10027         to match the commands in <code>receive-pack</code>.  Commands matching the
10028         prefixes will be executed by an external hook "proc-receive",
10029         instead of the internal <code>execute_commands</code> function.  If this
10030         variable is not defined, the "proc-receive" hook will never be
10031         used, and all commands will be executed by the internal
10032         <code>execute_commands</code> function.
10033 </p>
10034 <div class="paragraph"><p>For example, if this variable is set to "refs/for", pushing to reference
10035 such as "refs/for/master" will not create or update a reference named
10036 "refs/for/master", but may create or update a pull request directly by
10037 running the hook "proc-receive".</p></div>
10038 <div class="paragraph"><p>Optional modifiers can be provided in the beginning of the value to filter
10039 commands for specific actions: create (a), modify (m), delete (d).
10040 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
10041 E.g.:</p></div>
10042 <div class="literalblock">
10043 <div class="content">
10044 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
10045 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
10046 </div></div>
10047 </dd>
10048 <dt class="hdlist1">
10049 receive.updateServerInfo
10050 </dt>
10051 <dd>
10052 <p>
10053         If set to true, git-receive-pack will run git-update-server-info
10054         after receiving data from git-push and updating refs.
10055 </p>
10056 </dd>
10057 <dt class="hdlist1">
10058 receive.shallowUpdate
10059 </dt>
10060 <dd>
10061 <p>
10062         If set to true, .git/shallow can be updated when new refs
10063         require new shallow roots. Otherwise those refs are rejected.
10064 </p>
10065 </dd>
10066 <dt class="hdlist1">
10067 remote.pushDefault
10068 </dt>
10069 <dd>
10070 <p>
10071         The remote to push to by default.  Overrides
10072         <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
10073         <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
10074 </p>
10075 </dd>
10076 <dt class="hdlist1">
10077 remote.&lt;name&gt;.url
10078 </dt>
10079 <dd>
10080 <p>
10081         The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
10082         <a href="git-push.html">git-push(1)</a>.
10083 </p>
10084 </dd>
10085 <dt class="hdlist1">
10086 remote.&lt;name&gt;.pushurl
10087 </dt>
10088 <dd>
10089 <p>
10090         The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
10091 </p>
10092 </dd>
10093 <dt class="hdlist1">
10094 remote.&lt;name&gt;.proxy
10095 </dt>
10096 <dd>
10097 <p>
10098         For remotes that require curl (http, https and ftp), the URL to
10099         the proxy to use for that remote.  Set to the empty string to
10100         disable proxying for that remote.
10101 </p>
10102 </dd>
10103 <dt class="hdlist1">
10104 remote.&lt;name&gt;.proxyAuthMethod
10105 </dt>
10106 <dd>
10107 <p>
10108         For remotes that require curl (http, https and ftp), the method to use for
10109         authenticating against the proxy in use (probably set in
10110         <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
10111 </p>
10112 </dd>
10113 <dt class="hdlist1">
10114 remote.&lt;name&gt;.fetch
10115 </dt>
10116 <dd>
10117 <p>
10118         The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
10119         <a href="git-fetch.html">git-fetch(1)</a>.
10120 </p>
10121 </dd>
10122 <dt class="hdlist1">
10123 remote.&lt;name&gt;.push
10124 </dt>
10125 <dd>
10126 <p>
10127         The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
10128         <a href="git-push.html">git-push(1)</a>.
10129 </p>
10130 </dd>
10131 <dt class="hdlist1">
10132 remote.&lt;name&gt;.mirror
10133 </dt>
10134 <dd>
10135 <p>
10136         If true, pushing to this remote will automatically behave
10137         as if the <code>--mirror</code> option was given on the command line.
10138 </p>
10139 </dd>
10140 <dt class="hdlist1">
10141 remote.&lt;name&gt;.skipDefaultUpdate
10142 </dt>
10143 <dd>
10144 <p>
10145         If true, this remote will be skipped by default when updating
10146         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10147         <a href="git-remote.html">git-remote(1)</a>.
10148 </p>
10149 </dd>
10150 <dt class="hdlist1">
10151 remote.&lt;name&gt;.skipFetchAll
10152 </dt>
10153 <dd>
10154 <p>
10155         If true, this remote will be skipped by default when updating
10156         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10157         <a href="git-remote.html">git-remote(1)</a>.
10158 </p>
10159 </dd>
10160 <dt class="hdlist1">
10161 remote.&lt;name&gt;.receivepack
10162 </dt>
10163 <dd>
10164 <p>
10165         The default program to execute on the remote side when pushing.  See
10166         option --receive-pack of <a href="git-push.html">git-push(1)</a>.
10167 </p>
10168 </dd>
10169 <dt class="hdlist1">
10170 remote.&lt;name&gt;.uploadpack
10171 </dt>
10172 <dd>
10173 <p>
10174         The default program to execute on the remote side when fetching.  See
10175         option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
10176 </p>
10177 </dd>
10178 <dt class="hdlist1">
10179 remote.&lt;name&gt;.tagOpt
10180 </dt>
10181 <dd>
10182 <p>
10183         Setting this value to --no-tags disables automatic tag following when
10184         fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
10185         tag from remote &lt;name&gt;, even if they are not reachable from remote
10186         branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
10187         override this setting. See options --tags and --no-tags of
10188         <a href="git-fetch.html">git-fetch(1)</a>.
10189 </p>
10190 </dd>
10191 <dt class="hdlist1">
10192 remote.&lt;name&gt;.vcs
10193 </dt>
10194 <dd>
10195 <p>
10196         Setting this to a value &lt;vcs&gt; will cause Git to interact with
10197         the remote with the git-remote-&lt;vcs&gt; helper.
10198 </p>
10199 </dd>
10200 <dt class="hdlist1">
10201 remote.&lt;name&gt;.prune
10202 </dt>
10203 <dd>
10204 <p>
10205         When set to true, fetching from this remote by default will also
10206         remove any remote-tracking references that no longer exist on the
10207         remote (as if the <code>--prune</code> option was given on the command line).
10208         Overrides <code>fetch.prune</code> settings, if any.
10209 </p>
10210 </dd>
10211 <dt class="hdlist1">
10212 remote.&lt;name&gt;.pruneTags
10213 </dt>
10214 <dd>
10215 <p>
10216         When set to true, fetching from this remote by default will also
10217         remove any local tags that no longer exist on the remote if pruning
10218         is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
10219         <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10220 </p>
10221 <div class="paragraph"><p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
10222 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
10223 </dd>
10224 <dt class="hdlist1">
10225 remote.&lt;name&gt;.promisor
10226 </dt>
10227 <dd>
10228 <p>
10229         When set to true, this remote will be used to fetch promisor
10230         objects.
10231 </p>
10232 </dd>
10233 <dt class="hdlist1">
10234 remote.&lt;name&gt;.partialclonefilter
10235 </dt>
10236 <dd>
10237 <p>
10238         The filter that will be applied when fetching from this promisor remote.
10239         Changing or clearing this value will only affect fetches for new commits.
10240         To fetch associated objects for commits already present in the local object
10241         database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.
10242 </p>
10243 </dd>
10244 <dt class="hdlist1">
10245 remotes.&lt;group&gt;
10246 </dt>
10247 <dd>
10248 <p>
10249         The list of remotes which are fetched by "git remote update
10250         &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.
10251 </p>
10252 </dd>
10253 <dt class="hdlist1">
10254 repack.useDeltaBaseOffset
10255 </dt>
10256 <dd>
10257 <p>
10258         By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
10259         delta-base offset. If you need to share your repository with
10260         Git older than version 1.4.4, either directly or via a dumb
10261         protocol such as http, then you need to set this option to
10262         "false" and repack. Access from old Git versions over the
10263         native protocol are unaffected by this option.
10264 </p>
10265 </dd>
10266 <dt class="hdlist1">
10267 repack.packKeptObjects
10268 </dt>
10269 <dd>
10270 <p>
10271         If set to true, makes <code>git repack</code> act as if
10272         <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
10273         details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10274         index is being written (either via <code>--write-bitmap-index</code> or
10275         <code>repack.writeBitmaps</code>).
10276 </p>
10277 </dd>
10278 <dt class="hdlist1">
10279 repack.useDeltaIslands
10280 </dt>
10281 <dd>
10282 <p>
10283         If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10284         was passed. Defaults to <code>false</code>.
10285 </p>
10286 </dd>
10287 <dt class="hdlist1">
10288 repack.writeBitmaps
10289 </dt>
10290 <dd>
10291 <p>
10292         When true, git will write a bitmap index when packing all
10293         objects to disk (e.g., when <code>git repack -a</code> is run).  This
10294         index can speed up the "counting objects" phase of subsequent
10295         packs created for clones and fetches, at the cost of some disk
10296         space and extra time spent on the initial repack.  This has
10297         no effect if multiple packfiles are created.
10298         Defaults to true on bare repos, false otherwise.
10299 </p>
10300 </dd>
10301 <dt class="hdlist1">
10302 repack.updateServerInfo
10303 </dt>
10304 <dd>
10305 <p>
10306         If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
10307         <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10308         when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.
10309 </p>
10310 </dd>
10311 <dt class="hdlist1">
10312 repack.cruftWindow
10313 </dt>
10314 <dt class="hdlist1">
10315 repack.cruftWindowMemory
10316 </dt>
10317 <dt class="hdlist1">
10318 repack.cruftDepth
10319 </dt>
10320 <dt class="hdlist1">
10321 repack.cruftThreads
10322 </dt>
10323 <dd>
10324 <p>
10325         Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
10326         a cruft pack and the respective parameters are not given over
10327         the command line. See similarly named <code>pack.*</code> configuration
10328         variables for defaults and meaning.
10329 </p>
10330 </dd>
10331 <dt class="hdlist1">
10332 rerere.autoUpdate
10333 </dt>
10334 <dd>
10335 <p>
10336         When set to true, <code>git-rerere</code> updates the index with the
10337         resulting contents after it cleanly resolves conflicts using
10338         previously recorded resolutions.  Defaults to false.
10339 </p>
10340 </dd>
10341 <dt class="hdlist1">
10342 rerere.enabled
10343 </dt>
10344 <dd>
10345 <p>
10346         Activate recording of resolved conflicts, so that identical
10347         conflict hunks can be resolved automatically, should they be
10348         encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
10349         enabled if there is an <code>rr-cache</code> directory under the
10350         <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
10351         repository.
10352 </p>
10353 </dd>
10354 <dt class="hdlist1">
10355 revert.reference
10356 </dt>
10357 <dd>
10358 <p>
10359         Setting this variable to true makes <code>git revert</code> behave
10360         as if the <code>--reference</code> option is given.
10361 </p>
10362 </dd>
10363 <dt class="hdlist1">
10364 safe.bareRepository
10365 </dt>
10366 <dd>
10367 <p>
10368         Specifies which bare repositories Git will work with. The currently
10369         supported values are:
10370 </p>
10371 <div class="ulist"><ul>
10372 <li>
10373 <p>
10374 <code>all</code>: Git works with all bare repositories. This is the default.
10375 </p>
10376 </li>
10377 <li>
10378 <p>
10379 <code>explicit</code>: Git only works with bare repositories specified via
10380   the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10381   environment variable (see <a href="git.html">git(1)</a>).
10382 </p>
10383 <div class="paragraph"><p>If you do not use bare repositories in your workflow, then it may be
10384 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10385 config. This will protect you from attacks that involve cloning a
10386 repository that contains a bare repository and running a Git command
10387 within that directory.</p></div>
10388 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10389 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with
10390 this value.</p></div>
10391 </li>
10392 </ul></div>
10393 </dd>
10394 <dt class="hdlist1">
10395 safe.directory
10396 </dt>
10397 <dd>
10398 <p>
10399         These config entries specify Git-tracked directories that are
10400         considered safe even if they are owned by someone other than the
10401         current user. By default, Git will refuse to even parse a Git
10402         config of a repository owned by someone else, let alone run its
10403         hooks, and this config setting allows users to specify exceptions,
10404         e.g. for intentionally shared repositories (see the <code>--shared</code>
10405         option in <a href="git-init.html">git-init(1)</a>).
10406 </p>
10407 <div class="paragraph"><p>This is a multi-valued setting, i.e. you can add more than one directory
10408 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10409 override any such directories specified in the system config), add a
10410 <code>safe.directory</code> entry with an empty value.</p></div>
10411 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10412 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with this
10413 value.</p></div>
10414 <div class="paragraph"><p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
10415 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
10416 path relative to Git&#8217;s (runtime) prefix.</p></div>
10417 <div class="paragraph"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10418 string <code>*</code>. This will allow all repositories to be treated as if their
10419 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10420 is set in system config and you want to re-enable this protection, then
10421 initialize your list with an empty value before listing the repositories
10422 that you deem safe.</p></div>
10423 <div class="paragraph"><p>As explained, Git only allows you to access repositories owned by
10424 yourself, i.e. the user who is running Git, by default.  When Git
10425 is running as <em>root</em> in a non Windows platform that provides sudo,
10426 however, git checks the SUDO_UID environment variable that sudo creates
10427 and will allow access to the uid recorded as its value in addition to
10428 the id from <em>root</em>.
10429 This is to make it easy to perform a common sequence during installation
10430 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
10431 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
10432 which id the original user has.
10433 If that is not what you would prefer and want git to only trust
10434 repositories that are owned by root instead, then you can remove
10435 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p></div>
10436 </dd>
10437 <dt class="hdlist1">
10438 sendemail.identity
10439 </dt>
10440 <dd>
10441 <p>
10442         A configuration identity. When given, causes values in the
10443         <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
10444         values in the <em>sendemail</em> section. The default identity is
10445         the value of <code>sendemail.identity</code>.
10446 </p>
10447 </dd>
10448 <dt class="hdlist1">
10449 sendemail.smtpEncryption
10450 </dt>
10451 <dd>
10452 <p>
10453         See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
10454         setting is not subject to the <em>identity</em> mechanism.
10455 </p>
10456 </dd>
10457 <dt class="hdlist1">
10458 sendemail.smtpsslcertpath
10459 </dt>
10460 <dd>
10461 <p>
10462         Path to ca-certificates (either a directory or a single file).
10463         Set it to an empty string to disable certificate verification.
10464 </p>
10465 </dd>
10466 <dt class="hdlist1">
10467 sendemail.&lt;identity&gt;.*
10468 </dt>
10469 <dd>
10470 <p>
10471         Identity-specific versions of the <em>sendemail.*</em> parameters
10472         found below, taking precedence over those when this
10473         identity is selected, through either the command-line or
10474         <code>sendemail.identity</code>.
10475 </p>
10476 </dd>
10477 <dt class="hdlist1">
10478 sendemail.multiEdit
10479 </dt>
10480 <dd>
10481 <p>
10482         If true (default), a single editor instance will be spawned to edit
10483         files you have to edit (patches when <code>--annotate</code> is used, and the
10484         summary when <code>--compose</code> is used). If false, files will be edited one
10485         after the other, spawning a new editor each time.
10486 </p>
10487 </dd>
10488 <dt class="hdlist1">
10489 sendemail.confirm
10490 </dt>
10491 <dd>
10492 <p>
10493         Sets the default for whether to confirm before sending. Must be
10494         one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
10495         in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
10496         values.
10497 </p>
10498 </dd>
10499 <dt class="hdlist1">
10500 sendemail.aliasesFile
10501 </dt>
10502 <dd>
10503 <p>
10504         To avoid typing long email addresses, point this to one or more
10505         email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.
10506 </p>
10507 </dd>
10508 <dt class="hdlist1">
10509 sendemail.aliasFileType
10510 </dt>
10511 <dd>
10512 <p>
10513         Format of the file(s) specified in sendemail.aliasesFile. Must be
10514         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.
10515 </p>
10516 <div class="paragraph"><p>What an alias file in each format looks like can be found in
10517 the documentation of the email program of the same name. The
10518 differences and limitations from the standard formats are
10519 described below:</p></div>
10520 <div class="openblock">
10521 <div class="content">
10522 <div class="dlist"><dl>
10523 <dt class="hdlist1">
10524 sendmail
10525 </dt>
10526 <dd>
10527 <div class="ulist"><ul>
10528 <li>
10529 <p>
10530 Quoted aliases and quoted addresses are not supported: lines that
10531         contain a <code>"</code> symbol are ignored.
10532 </p>
10533 </li>
10534 <li>
10535 <p>
10536 Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
10537         supported.
10538 </p>
10539 </li>
10540 <li>
10541 <p>
10542 File inclusion (<code>:include: /path/name</code>) is not supported.
10543 </p>
10544 </li>
10545 <li>
10546 <p>
10547 Warnings are printed on the standard error output for any
10548         explicitly unsupported constructs, and any other lines that are not
10549         recognized by the parser.
10550 </p>
10551 </li>
10552 </ul></div>
10553 </dd>
10554 </dl></div>
10555 </div></div>
10556 </dd>
10557 <dt class="hdlist1">
10558 sendemail.annotate
10559 </dt>
10560 <dt class="hdlist1">
10561 sendemail.bcc
10562 </dt>
10563 <dt class="hdlist1">
10564 sendemail.cc
10565 </dt>
10566 <dt class="hdlist1">
10567 sendemail.ccCmd
10568 </dt>
10569 <dt class="hdlist1">
10570 sendemail.chainReplyTo
10571 </dt>
10572 <dt class="hdlist1">
10573 sendemail.envelopeSender
10574 </dt>
10575 <dt class="hdlist1">
10576 sendemail.from
10577 </dt>
10578 <dt class="hdlist1">
10579 sendemail.headerCmd
10580 </dt>
10581 <dt class="hdlist1">
10582 sendemail.signedoffbycc
10583 </dt>
10584 <dt class="hdlist1">
10585 sendemail.smtpPass
10586 </dt>
10587 <dt class="hdlist1">
10588 sendemail.suppresscc
10589 </dt>
10590 <dt class="hdlist1">
10591 sendemail.suppressFrom
10592 </dt>
10593 <dt class="hdlist1">
10594 sendemail.to
10595 </dt>
10596 <dt class="hdlist1">
10597 sendemail.tocmd
10598 </dt>
10599 <dt class="hdlist1">
10600 sendemail.smtpDomain
10601 </dt>
10602 <dt class="hdlist1">
10603 sendemail.smtpServer
10604 </dt>
10605 <dt class="hdlist1">
10606 sendemail.smtpServerPort
10607 </dt>
10608 <dt class="hdlist1">
10609 sendemail.smtpServerOption
10610 </dt>
10611 <dt class="hdlist1">
10612 sendemail.smtpUser
10613 </dt>
10614 <dt class="hdlist1">
10615 sendemail.thread
10616 </dt>
10617 <dt class="hdlist1">
10618 sendemail.transferEncoding
10619 </dt>
10620 <dt class="hdlist1">
10621 sendemail.validate
10622 </dt>
10623 <dt class="hdlist1">
10624 sendemail.xmailer
10625 </dt>
10626 <dd>
10627 <p>
10628         These configuration variables all provide a default for
10629         <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
10630         documentation for details.
10631 </p>
10632 </dd>
10633 <dt class="hdlist1">
10634 sendemail.signedoffcc (deprecated)
10635 </dt>
10636 <dd>
10637 <p>
10638         Deprecated alias for <code>sendemail.signedoffbycc</code>.
10639 </p>
10640 </dd>
10641 <dt class="hdlist1">
10642 sendemail.smtpBatchSize
10643 </dt>
10644 <dd>
10645 <p>
10646         Number of messages to be sent per connection, after that a relogin
10647         will happen.  If the value is 0 or undefined, send all messages in
10648         one connection.
10649         See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10650 </p>
10651 </dd>
10652 <dt class="hdlist1">
10653 sendemail.smtpReloginDelay
10654 </dt>
10655 <dd>
10656 <p>
10657         Seconds to wait before reconnecting to the smtp server.
10658         See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10659 </p>
10660 </dd>
10661 <dt class="hdlist1">
10662 sendemail.forbidSendmailVariables
10663 </dt>
10664 <dd>
10665 <p>
10666         To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
10667         will abort with a warning if any configuration options for "sendmail"
10668         exist. Set this variable to bypass the check.
10669 </p>
10670 </dd>
10671 <dt class="hdlist1">
10672 sequence.editor
10673 </dt>
10674 <dd>
10675 <p>
10676         Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
10677         The value is meant to be interpreted by the shell when it is used.
10678         It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
10679         When not configured, the default commit message editor is used instead.
10680 </p>
10681 </dd>
10682 <dt class="hdlist1">
10683 showBranch.default
10684 </dt>
10685 <dd>
10686 <p>
10687         The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
10688         See <a href="git-show-branch.html">git-show-branch(1)</a>.
10689 </p>
10690 </dd>
10691 <dt class="hdlist1">
10692 sparse.expectFilesOutsideOfPatterns
10693 </dt>
10694 <dd>
10695 <p>
10696         Typically with sparse checkouts, files not matching any
10697         sparsity patterns are marked with a SKIP_WORKTREE bit in the
10698         index and are missing from the working tree.  Accordingly, Git
10699         will ordinarily check whether files with the SKIP_WORKTREE bit
10700         are in fact present in the working tree contrary to
10701         expectations.  If Git finds any, it marks those paths as
10702         present by clearing the relevant SKIP_WORKTREE bits.  This
10703         option can be used to tell Git that such
10704         present-despite-skipped files are expected and to stop
10705         checking for them.
10706 </p>
10707 <div class="paragraph"><p>The default is <code>false</code>, which allows Git to automatically recover
10708 from the list of files in the index and working tree falling out of
10709 sync.</p></div>
10710 <div class="paragraph"><p>Set this to <code>true</code> if you are in a setup where some external factor
10711 relieves Git of the responsibility for maintaining the consistency
10712 between the presence of working tree files and sparsity patterns.  For
10713 example, if you have a Git-aware virtual file system that has a robust
10714 mechanism for keeping the working tree and the sparsity patterns up to
10715 date based on access patterns.</p></div>
10716 <div class="paragraph"><p>Regardless of this setting, Git does not check for
10717 present-despite-skipped files unless sparse checkout is enabled, so
10718 this config option has no effect unless <code>core.sparseCheckout</code> is
10719 <code>true</code>.</p></div>
10720 </dd>
10721 <dt class="hdlist1">
10722 splitIndex.maxPercentChange
10723 </dt>
10724 <dd>
10725 <p>
10726         When the split index feature is used, this specifies the
10727         percent of entries the split index can contain compared to the
10728         total number of entries in both the split index and the shared
10729         index before a new shared index is written.
10730         The value should be between 0 and 100. If the value is 0, then
10731         a new shared index is always written; if it is 100, a new
10732         shared index is never written.
10733         By default, the value is 20, so a new shared index is written
10734         if the number of entries in the split index would be greater
10735         than 20 percent of the total number of entries.
10736         See <a href="git-update-index.html">git-update-index(1)</a>.
10737 </p>
10738 </dd>
10739 <dt class="hdlist1">
10740 splitIndex.sharedIndexExpire
10741 </dt>
10742 <dd>
10743 <p>
10744         When the split index feature is used, shared index files that
10745         were not modified since the time this variable specifies will
10746         be removed when a new shared index file is created. The value
10747         "now" expires all entries immediately, and "never" suppresses
10748         expiration altogether.
10749         The default value is "2.weeks.ago".
10750         Note that a shared index file is considered modified (for the
10751         purpose of expiration) each time a new split-index file is
10752         either created based on it or read from it.
10753         See <a href="git-update-index.html">git-update-index(1)</a>.
10754 </p>
10755 </dd>
10756 <dt class="hdlist1">
10757 ssh.variant
10758 </dt>
10759 <dd>
10760 <p>
10761         By default, Git determines the command line arguments to use
10762         based on the basename of the configured SSH command (configured
10763         using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
10764         the config setting <code>core.sshCommand</code>). If the basename is
10765         unrecognized, Git will attempt to detect support of OpenSSH
10766         options by first invoking the configured SSH command with the
10767         <code>-G</code> (print configuration) option and will subsequently use
10768         OpenSSH options (if that is successful) or no options besides
10769         the host and remote command (if it fails).
10770 </p>
10771 <div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this detection.
10772 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
10773 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
10774 The default auto-detection can be explicitly requested using the value
10775 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
10776 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
10777 <div class="paragraph"><p>The current command-line parameters used for each variant are as
10778 follows:</p></div>
10779 <div class="openblock">
10780 <div class="content">
10781 <div class="ulist"><ul>
10782 <li>
10783 <p>
10784 <code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command
10785 </p>
10786 </li>
10787 <li>
10788 <p>
10789 <code>simple</code> - [username@]host command
10790 </p>
10791 </li>
10792 <li>
10793 <p>
10794 <code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command
10795 </p>
10796 </li>
10797 <li>
10798 <p>
10799 <code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command
10800 </p>
10801 </li>
10802 </ul></div>
10803 </div></div>
10804 <div class="paragraph"><p>Except for the <code>simple</code> variant, command-line parameters are likely to
10805 change as git gains new features.</p></div>
10806 </dd>
10807 <dt class="hdlist1">
10808 status.relativePaths
10809 </dt>
10810 <dd>
10811 <p>
10812         By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
10813         current directory. Setting this variable to <code>false</code> shows paths
10814         relative to the repository root (this was the default for Git
10815         prior to v1.5.4).
10816 </p>
10817 </dd>
10818 <dt class="hdlist1">
10819 status.short
10820 </dt>
10821 <dd>
10822 <p>
10823         Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
10824         The option --no-short takes precedence over this variable.
10825 </p>
10826 </dd>
10827 <dt class="hdlist1">
10828 status.branch
10829 </dt>
10830 <dd>
10831 <p>
10832         Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
10833         The option --no-branch takes precedence over this variable.
10834 </p>
10835 </dd>
10836 <dt class="hdlist1">
10837 status.aheadBehind
10838 </dt>
10839 <dd>
10840 <p>
10841         Set to true to enable <code>--ahead-behind</code> and false to enable
10842         <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
10843         non-porcelain status formats.  Defaults to true.
10844 </p>
10845 </dd>
10846 <dt class="hdlist1">
10847 status.displayCommentPrefix
10848 </dt>
10849 <dd>
10850 <p>
10851         If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
10852         prefix before each output line (starting with
10853         <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
10854         behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
10855         Defaults to false.
10856 </p>
10857 </dd>
10858 <dt class="hdlist1">
10859 status.renameLimit
10860 </dt>
10861 <dd>
10862 <p>
10863         The number of files to consider when performing rename detection
10864         in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
10865         the value of diff.renameLimit.
10866 </p>
10867 </dd>
10868 <dt class="hdlist1">
10869 status.renames
10870 </dt>
10871 <dd>
10872 <p>
10873         Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
10874         <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
10875         disabled. If set to "true", basic rename detection is enabled.
10876         If set to "copies" or "copy", Git will detect copies, as well.
10877         Defaults to the value of diff.renames.
10878 </p>
10879 </dd>
10880 <dt class="hdlist1">
10881 status.showStash
10882 </dt>
10883 <dd>
10884 <p>
10885         If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
10886         entries currently stashed away.
10887         Defaults to false.
10888 </p>
10889 </dd>
10890 <dt class="hdlist1">
10891 status.showUntrackedFiles
10892 </dt>
10893 <dd>
10894 <p>
10895         By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
10896         files which are not currently tracked by Git. Directories which
10897         contain only untracked files, are shown with the directory name
10898         only. Showing untracked files means that Git needs to lstat() all
10899         the files in the whole repository, which might be slow on some
10900         systems. So, this variable controls how the commands display
10901         the untracked files. Possible values are:
10902 </p>
10903 <div class="openblock">
10904 <div class="content">
10905 <div class="ulist"><ul>
10906 <li>
10907 <p>
10908 <code>no</code> - Show no untracked files.
10909 </p>
10910 </li>
10911 <li>
10912 <p>
10913 <code>normal</code> - Show untracked files and directories.
10914 </p>
10915 </li>
10916 <li>
10917 <p>
10918 <code>all</code> - Show also individual files in untracked directories.
10919 </p>
10920 </li>
10921 </ul></div>
10922 </div></div>
10923 <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
10924 This variable can be overridden with the -u|--untracked-files option
10925 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
10926 </dd>
10927 <dt class="hdlist1">
10928 status.submoduleSummary
10929 </dt>
10930 <dd>
10931 <p>
10932         Defaults to false.
10933         If this is set to a non-zero number or true (identical to -1 or an
10934         unlimited number), the submodule summary will be enabled and a
10935         summary of commits for modified submodules will be shown (see
10936         --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
10937         that the summary output command will be suppressed for all
10938         submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
10939         for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
10940         exception to that rule is that status and commit will show staged
10941         submodule changes. To
10942         also view the summary for ignored submodules you can either use
10943         the --ignore-submodules=dirty command-line option or the <em>git
10944         submodule summary</em> command, which shows a similar output but does
10945         not honor these settings.
10946 </p>
10947 </dd>
10948 <dt class="hdlist1">
10949 stash.showIncludeUntracked
10950 </dt>
10951 <dd>
10952 <p>
10953         If this is set to true, the <code>git stash show</code> command will show
10954         the untracked files of a stash entry.  Defaults to false. See
10955         the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10956 </p>
10957 </dd>
10958 <dt class="hdlist1">
10959 stash.showPatch
10960 </dt>
10961 <dd>
10962 <p>
10963         If this is set to true, the <code>git stash show</code> command without an
10964         option will show the stash entry in patch form.  Defaults to false.
10965         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10966 </p>
10967 </dd>
10968 <dt class="hdlist1">
10969 stash.showStat
10970 </dt>
10971 <dd>
10972 <p>
10973         If this is set to true, the <code>git stash show</code> command without an
10974         option will show a diffstat of the stash entry.  Defaults to true.
10975         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10976 </p>
10977 </dd>
10978 <dt class="hdlist1">
10979 submodule.&lt;name&gt;.url
10980 </dt>
10981 <dd>
10982 <p>
10983         The URL for a submodule. This variable is copied from the .gitmodules
10984         file to the git config via <em>git submodule init</em>. The user can change
10985         the configured URL before obtaining the submodule via <em>git submodule
10986         update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
10987         set, the presence of this variable is used as a fallback to indicate
10988         whether the submodule is of interest to git commands.
10989         See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
10990 </p>
10991 </dd>
10992 <dt class="hdlist1">
10993 submodule.&lt;name&gt;.update
10994 </dt>
10995 <dd>
10996 <p>
10997         The method by which a submodule is updated by <em>git submodule update</em>,
10998         which is the only affected command, others such as
10999         <em>git checkout --recurse-submodules</em> are unaffected. It exists for
11000         historical reasons, when <em>git submodule</em> was the only command to
11001         interact with submodules; settings like <code>submodule.active</code>
11002         and <code>pull.rebase</code> are more specific. It is populated by
11003         <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
11004         See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.
11005 </p>
11006 </dd>
11007 <dt class="hdlist1">
11008 submodule.&lt;name&gt;.branch
11009 </dt>
11010 <dd>
11011 <p>
11012         The remote branch name for a submodule, used by <code>git submodule
11013         update --remote</code>.  Set this option to override the value found in
11014         the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
11015         <a href="gitmodules.html">gitmodules(5)</a> for details.
11016 </p>
11017 </dd>
11018 <dt class="hdlist1">
11019 submodule.&lt;name&gt;.fetchRecurseSubmodules
11020 </dt>
11021 <dd>
11022 <p>
11023         This option can be used to control recursive fetching of this
11024         submodule. It can be overridden by using the --[no-]recurse-submodules
11025         command-line option to "git fetch" and "git pull".
11026         This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
11027         file.
11028 </p>
11029 </dd>
11030 <dt class="hdlist1">
11031 submodule.&lt;name&gt;.ignore
11032 </dt>
11033 <dd>
11034 <p>
11035         Defines under what circumstances "git status" and the diff family show
11036         a submodule as modified. When set to "all", it will never be considered
11037         modified (but it will nonetheless show up in the output of status and
11038         commit when it has been staged), "dirty" will ignore all changes
11039         to the submodule&#8217;s work tree and
11040         takes only differences between the HEAD of the submodule and the commit
11041         recorded in the superproject into account. "untracked" will additionally
11042         let submodules with modified tracked files in their work tree show up.
11043         Using "none" (the default when this option is not set) also shows
11044         submodules that have untracked files in their work tree as changed.
11045         This setting overrides any setting made in .gitmodules for this submodule,
11046         both settings can be overridden on the command line by using the
11047         "--ignore-submodules" option. The <em>git submodule</em> commands are not
11048         affected by this setting.
11049 </p>
11050 </dd>
11051 <dt class="hdlist1">
11052 submodule.&lt;name&gt;.active
11053 </dt>
11054 <dd>
11055 <p>
11056         Boolean value indicating if the submodule is of interest to git
11057         commands.  This config option takes precedence over the
11058         submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
11059         details.
11060 </p>
11061 </dd>
11062 <dt class="hdlist1">
11063 submodule.active
11064 </dt>
11065 <dd>
11066 <p>
11067         A repeated field which contains a pathspec used to match against a
11068         submodule&#8217;s path to determine if the submodule is of interest to git
11069         commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.
11070 </p>
11071 </dd>
11072 <dt class="hdlist1">
11073 submodule.recurse
11074 </dt>
11075 <dd>
11076 <p>
11077         A boolean indicating if commands should enable the <code>--recurse-submodules</code>
11078         option by default. Defaults to false.
11079 </p>
11080 <div class="paragraph"><p>When set to true, it can be deactivated via the
11081 <code>--no-recurse-submodules</code> option. Note that some Git commands
11082 lacking this option may call some of the above commands affected by
11083 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
11084 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
11085 For these commands a workaround is to temporarily change the
11086 configuration value by using <code>git -c submodule.recurse=0</code>.</p></div>
11087 <div class="paragraph"><p>The following list shows the commands that accept
11088 <code>--recurse-submodules</code> and whether they are supported by this
11089 setting.</p></div>
11090 <div class="ulist"><ul>
11091 <li>
11092 <p>
11093 <code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
11094 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.
11095 </p>
11096 </li>
11097 <li>
11098 <p>
11099 <code>clone</code> and <code>ls-files</code> are not supported.
11100 </p>
11101 </li>
11102 <li>
11103 <p>
11104 <code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
11105 enabled
11106 </p>
11107 </li>
11108 </ul></div>
11109 </dd>
11110 <dt class="hdlist1">
11111 submodule.propagateBranches
11112 </dt>
11113 <dd>
11114 <p>
11115         [EXPERIMENTAL] A boolean that enables branching support when
11116         using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
11117         Enabling this will allow certain commands to accept
11118         <code>--recurse-submodules</code> and certain commands that already accept
11119         <code>--recurse-submodules</code> will now consider branches.
11120         Defaults to false.
11121 </p>
11122 </dd>
11123 <dt class="hdlist1">
11124 submodule.fetchJobs
11125 </dt>
11126 <dd>
11127 <p>
11128         Specifies how many submodules are fetched/cloned at the same time.
11129         A positive integer allows up to that number of submodules fetched
11130         in parallel. A value of 0 will give some reasonable default.
11131         If unset, it defaults to 1.
11132 </p>
11133 </dd>
11134 <dt class="hdlist1">
11135 submodule.alternateLocation
11136 </dt>
11137 <dd>
11138 <p>
11139         Specifies how the submodules obtain alternates when submodules are
11140         cloned. Possible values are <code>no</code>, <code>superproject</code>.
11141         By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
11142         value is set to <code>superproject</code> the submodule to be cloned computes
11143         its alternates location relative to the superprojects alternate.
11144 </p>
11145 </dd>
11146 <dt class="hdlist1">
11147 submodule.alternateErrorStrategy
11148 </dt>
11149 <dd>
11150 <p>
11151         Specifies how to treat errors with the alternates for a submodule
11152         as computed via <code>submodule.alternateLocation</code>. Possible values are
11153         <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
11154         or <code>info</code>, and if there is an error with the computed alternate, the
11155         clone proceeds as if no alternate was specified.
11156 </p>
11157 </dd>
11158 <dt class="hdlist1">
11159 tag.forceSignAnnotated
11160 </dt>
11161 <dd>
11162 <p>
11163         A boolean to specify whether annotated tags created should be GPG signed.
11164         If <code>--annotate</code> is specified on the command line, it takes
11165         precedence over this option.
11166 </p>
11167 </dd>
11168 <dt class="hdlist1">
11169 tag.sort
11170 </dt>
11171 <dd>
11172 <p>
11173         This variable controls the sort ordering of tags when displayed by
11174         <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
11175         value of this variable will be used as the default.
11176 </p>
11177 </dd>
11178 <dt class="hdlist1">
11179 tag.gpgSign
11180 </dt>
11181 <dd>
11182 <p>
11183         A boolean to specify whether all tags should be GPG signed.
11184         Use of this option when running in an automated script can
11185         result in a large number of tags being signed. It is therefore
11186         convenient to use an agent to avoid typing your gpg passphrase
11187         several times. Note that this option doesn&#8217;t affect tag signing
11188         behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.
11189 </p>
11190 </dd>
11191 <dt class="hdlist1">
11192 tar.umask
11193 </dt>
11194 <dd>
11195 <p>
11196         This variable can be used to restrict the permission bits of
11197         tar archive entries.  The default is 0002, which turns off the
11198         world write bit.  The special value "user" indicates that the
11199         archiving user&#8217;s umask will be used instead.  See umask(2) and
11200         <a href="git-archive.html">git-archive(1)</a>.
11201 </p>
11202 </dd>
11203 </dl></div>
11204 <div class="paragraph"><p>Trace2 config settings are only read from the system and global
11205 config files; repository local and worktree config files and <code>-c</code>
11206 command line arguments are not respected.</p></div>
11207 <div class="dlist"><dl>
11208 <dt class="hdlist1">
11209 trace2.normalTarget
11210 </dt>
11211 <dd>
11212 <p>
11213         This variable controls the normal target destination.
11214         It may be overridden by the <code>GIT_TRACE2</code> environment variable.
11215         The following table shows possible values.
11216 </p>
11217 </dd>
11218 <dt class="hdlist1">
11219 trace2.perfTarget
11220 </dt>
11221 <dd>
11222 <p>
11223         This variable controls the performance target destination.
11224         It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
11225         The following table shows possible values.
11226 </p>
11227 </dd>
11228 <dt class="hdlist1">
11229 trace2.eventTarget
11230 </dt>
11231 <dd>
11232 <p>
11233         This variable controls the event target destination.
11234         It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
11235         The following table shows possible values.
11236 </p>
11237 <div class="openblock">
11238 <div class="content">
11239 <div class="ulist"><ul>
11240 <li>
11241 <p>
11242 <code>0</code> or <code>false</code> - Disables the target.
11243 </p>
11244 </li>
11245 <li>
11246 <p>
11247 <code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.
11248 </p>
11249 </li>
11250 <li>
11251 <p>
11252 <code>[2-9]</code> - Writes to the already opened file descriptor.
11253 </p>
11254 </li>
11255 <li>
11256 <p>
11257 <code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
11258 already exists and is a directory, the traces will be written to files (one
11259 per process) underneath the given directory.
11260 </p>
11261 </li>
11262 <li>
11263 <p>
11264 <code>af_unix:[&lt;socket_type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
11265 Unix DomainSocket (on platforms that support them).  Socket
11266 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
11267 try both.
11268 </p>
11269 </li>
11270 </ul></div>
11271 </div></div>
11272 </dd>
11273 <dt class="hdlist1">
11274 trace2.normalBrief
11275 </dt>
11276 <dd>
11277 <p>
11278         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11279         omitted from normal output.  May be overridden by the
11280         <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.
11281 </p>
11282 </dd>
11283 <dt class="hdlist1">
11284 trace2.perfBrief
11285 </dt>
11286 <dd>
11287 <p>
11288         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11289         omitted from PERF output.  May be overridden by the
11290         <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.
11291 </p>
11292 </dd>
11293 <dt class="hdlist1">
11294 trace2.eventBrief
11295 </dt>
11296 <dd>
11297 <p>
11298         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11299         omitted from event output.  May be overridden by the
11300         <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.
11301 </p>
11302 </dd>
11303 <dt class="hdlist1">
11304 trace2.eventNesting
11305 </dt>
11306 <dd>
11307 <p>
11308         Integer.  Specifies desired depth of nested regions in the
11309         event output.  Regions deeper than this value will be
11310         omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
11311         environment variable.  Defaults to 2.
11312 </p>
11313 </dd>
11314 <dt class="hdlist1">
11315 trace2.configParams
11316 </dt>
11317 <dd>
11318 <p>
11319         A comma-separated list of patterns of "important" config
11320         settings that should be recorded in the trace2 output.
11321         For example, <code>core.*,remote.*.url</code> would cause the trace2
11322         output to contain events listing each configured remote.
11323         May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
11324         variable.  Unset by default.
11325 </p>
11326 </dd>
11327 <dt class="hdlist1">
11328 trace2.envVars
11329 </dt>
11330 <dd>
11331 <p>
11332         A comma-separated list of "important" environment variables that should
11333         be recorded in the trace2 output.  For example,
11334         <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
11335         contain events listing the overrides for HTTP user agent and the
11336         location of the Git configuration file (assuming any are set).  May be
11337         overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
11338         default.
11339 </p>
11340 </dd>
11341 <dt class="hdlist1">
11342 trace2.destinationDebug
11343 </dt>
11344 <dd>
11345 <p>
11346         Boolean.  When true Git will print error messages when a
11347         trace target destination cannot be opened for writing.
11348         By default, these errors are suppressed and tracing is
11349         silently disabled.  May be overridden by the
11350         <code>GIT_TRACE2_DST_DEBUG</code> environment variable.
11351 </p>
11352 </dd>
11353 <dt class="hdlist1">
11354 trace2.maxFiles
11355 </dt>
11356 <dd>
11357 <p>
11358         Integer.  When writing trace files to a target directory, do not
11359         write additional traces if doing so would exceed this many files. Instead,
11360         write a sentinel file that will block further tracing to this
11361         directory. Defaults to 0, which disables this check.
11362 </p>
11363 </dd>
11364 <dt class="hdlist1">
11365 transfer.credentialsInUrl
11366 </dt>
11367 <dd>
11368 <p>
11369         A configured URL can contain plaintext credentials in the form
11370         <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
11371         to warn or forbid the use of such configuration (in favor of
11372         using <a href="git-credential.html">git-credential(1)</a>). This will be used on
11373         <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>,
11374         and any other direct use of the configured URL.
11375 </p>
11376 <div class="paragraph"><p>Note that this is currently limited to detecting credentials in
11377 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
11378 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p></div>
11379 <div class="paragraph"><p>You might want to enable this to prevent inadvertent credentials
11380 exposure, e.g. because:</p></div>
11381 <div class="ulist"><ul>
11382 <li>
11383 <p>
11384 The OS or system where you&#8217;re running git may not provide a way or
11385   otherwise allow you to configure the permissions of the
11386   configuration file where the username and/or password are stored.
11387 </p>
11388 </li>
11389 <li>
11390 <p>
11391 Even if it does, having such data stored "at rest" might expose you
11392   in other ways, e.g. a backup process might copy the data to another
11393   system.
11394 </p>
11395 </li>
11396 <li>
11397 <p>
11398 The git programs will pass the full URL to one another as arguments
11399   on the command-line, meaning the credentials will be exposed to other
11400   unprivileged users on systems that allow them to see the full
11401   process list of other users. On linux the "hidepid" setting
11402   documented in procfs(5) allows for configuring this behavior.
11403 </p>
11404 <div class="paragraph"><p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
11405 concerned about credentials exposure due to storing sensitive
11406 data in git&#8217;s configuration files. If you do want to use this, set
11407 <code>transfer.credentialsInUrl</code> to one of these values:</p></div>
11408 </li>
11409 <li>
11410 <p>
11411 <code>allow</code> (default): Git will proceed with its activity without warning.
11412 </p>
11413 </li>
11414 <li>
11415 <p>
11416 <code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
11417   with a plaintext credential.
11418 </p>
11419 </li>
11420 <li>
11421 <p>
11422 <code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
11423   with a plaintext credential.
11424 </p>
11425 </li>
11426 </ul></div>
11427 </dd>
11428 <dt class="hdlist1">
11429 transfer.fsckObjects
11430 </dt>
11431 <dd>
11432 <p>
11433         When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
11434         not set, the value of this variable is used instead.
11435         Defaults to false.
11436 </p>
11437 <div class="paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
11438 object or a link to a nonexistent object. In addition, various other
11439 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
11440 and potential security issues like the existence of a <code>.GIT</code> directory
11441 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
11442 and v2.17.1 for details). Other sanity and security checks may be
11443 added in future releases.</p></div>
11444 <div class="paragraph"><p>On the receiving side, failing fsckObjects will make those objects
11445 unreachable, see "QUARANTINE ENVIRONMENT" in
11446 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
11447 instead be left unreferenced in the repository.</p></div>
11448 <div class="paragraph"><p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
11449 implementation it cannot be relied upon to leave the object store
11450 clean like <code>receive.fsckObjects</code> can.</p></div>
11451 <div class="paragraph"><p>As objects are unpacked they&#8217;re written to the object store, so there
11452 can be cases where malicious objects get introduced even though the
11453 "fetch" failed, only to have a subsequent "fetch" succeed because only
11454 new incoming objects are checked, not those that have already been
11455 written to the object store. That difference in behavior should not be
11456 relied upon. In the future, such objects may be quarantined for
11457 "fetch" as well.</p></div>
11458 <div class="paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
11459 environment if they&#8217;d like the same protection as "push". E.g. in the
11460 case of an internal mirror do the mirroring in two steps, one to fetch
11461 the untrusted objects, and then do a second "push" (which will use the
11462 quarantine) to another internal repo, and have internal clients
11463 consume this pushed-to repository, or embargo internal fetches and
11464 only allow them once a full "fsck" has run (and no new fetches have
11465 happened in the meantime).</p></div>
11466 </dd>
11467 <dt class="hdlist1">
11468 transfer.hideRefs
11469 </dt>
11470 <dd>
11471 <p>
11472         String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
11473         refs to omit from their initial advertisements.  Use more than
11474         one definition to specify multiple prefix strings. A ref that is
11475         under the hierarchies listed in the value of this variable is
11476         excluded, and is hidden when responding to <code>git push</code> or <code>git
11477         fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
11478         program-specific versions of this config.
11479 </p>
11480 <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
11481 explicitly exposing it, even if an earlier entry marked it as hidden.
11482 If you have multiple hideRefs values, later entries override earlier ones
11483 (and entries in more-specific config files override less-specific ones).</p></div>
11484 <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
11485 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
11486 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
11487 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
11488 <div class="paragraph"><p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
11489 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
11490 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
11491 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
11492 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
11493 <code>receive-pack</code>, on the other hand, will still advertise the object id the
11494 ref is pointing to without mentioning its name (a so-called ".have" line).</p></div>
11495 <div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
11496 objects via the techniques described in the "SECURITY" section of the
11497 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
11498 separate repository.</p></div>
11499 </dd>
11500 <dt class="hdlist1">
11501 transfer.unpackLimit
11502 </dt>
11503 <dd>
11504 <p>
11505         When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
11506         not set, the value of this variable is used instead.
11507         The default value is 100.
11508 </p>
11509 </dd>
11510 <dt class="hdlist1">
11511 transfer.advertiseSID
11512 </dt>
11513 <dd>
11514 <p>
11515         Boolean. When true, client and server processes will advertise their
11516         unique session IDs to their remote counterpart. Defaults to false.
11517 </p>
11518 </dd>
11519 <dt class="hdlist1">
11520 transfer.bundleURI
11521 </dt>
11522 <dd>
11523 <p>
11524         When <code>true</code>, local <code>git clone</code> commands will request bundle
11525         information from the remote server (if advertised) and download
11526         bundles before continuing the clone through the Git protocol.
11527         Defaults to <code>false</code>.
11528 </p>
11529 </dd>
11530 <dt class="hdlist1">
11531 uploadarchive.allowUnreachable
11532 </dt>
11533 <dd>
11534 <p>
11535         If true, allow clients to use <code>git archive --remote</code> to request
11536         any tree, whether reachable from the ref tips or not. See the
11537         discussion in the "SECURITY" section of
11538         <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
11539         <code>false</code>.
11540 </p>
11541 </dd>
11542 <dt class="hdlist1">
11543 uploadpack.hideRefs
11544 </dt>
11545 <dd>
11546 <p>
11547         This variable is the same as <code>transfer.hideRefs</code>, but applies
11548         only to <code>upload-pack</code> (and so affects only fetches, not pushes).
11549         An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
11550         also <code>uploadpack.allowTipSHA1InWant</code>.
11551 </p>
11552 </dd>
11553 <dt class="hdlist1">
11554 uploadpack.allowTipSHA1InWant
11555 </dt>
11556 <dd>
11557 <p>
11558         When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
11559         to accept a fetch request that asks for an object at the tip
11560         of a hidden ref (by default, such a request is rejected).
11561         See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
11562         may be able to steal objects via the techniques described in the
11563         "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
11564         best to keep private data in a separate repository.
11565 </p>
11566 </dd>
11567 <dt class="hdlist1">
11568 uploadpack.allowReachableSHA1InWant
11569 </dt>
11570 <dd>
11571 <p>
11572         Allow <code>upload-pack</code> to accept a fetch request that asks for an
11573         object that is reachable from any ref tip. However, note that
11574         calculating object reachability is computationally expensive.
11575         Defaults to <code>false</code>.  Even if this is false, a client may be able
11576         to steal objects via the techniques described in the "SECURITY"
11577         section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
11578         keep private data in a separate repository.
11579 </p>
11580 </dd>
11581 <dt class="hdlist1">
11582 uploadpack.allowAnySHA1InWant
11583 </dt>
11584 <dd>
11585 <p>
11586         Allow <code>upload-pack</code> to accept a fetch request that asks for any
11587         object at all.
11588         Defaults to <code>false</code>.
11589 </p>
11590 </dd>
11591 <dt class="hdlist1">
11592 uploadpack.keepAlive
11593 </dt>
11594 <dd>
11595 <p>
11596         When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
11597         quiet period while <code>pack-objects</code> prepares the pack. Normally
11598         it would output progress information, but if <code>--quiet</code> was used
11599         for the fetch, <code>pack-objects</code> will output nothing at all until
11600         the pack data begins. Some clients and networks may consider
11601         the server to be hung and give up. Setting this option instructs
11602         <code>upload-pack</code> to send an empty keepalive packet every
11603         <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
11604         disables keepalive packets entirely. The default is 5 seconds.
11605 </p>
11606 </dd>
11607 <dt class="hdlist1">
11608 uploadpack.packObjectsHook
11609 </dt>
11610 <dd>
11611 <p>
11612         If this option is set, when <code>upload-pack</code> would run
11613         <code>git pack-objects</code> to create a packfile for a client, it will
11614         run this shell command instead.  The <code>pack-objects</code> command and
11615         arguments it <em>would</em> have run (including the <code>git pack-objects</code>
11616         at the beginning) are appended to the shell command. The stdin
11617         and stdout of the hook are treated as if <code>pack-objects</code> itself
11618         was run. I.e., <code>upload-pack</code> will feed input intended for
11619         <code>pack-objects</code> to the hook, and expects a completed packfile on
11620         stdout.
11621 </p>
11622 <div class="paragraph"><p>Note that this configuration variable is only respected when it is specified
11623 in protected configuration (see <a href="#SCOPES">[SCOPES]</a>). This is a safety measure
11624 against fetching from untrusted repositories.</p></div>
11625 </dd>
11626 <dt class="hdlist1">
11627 uploadpack.allowFilter
11628 </dt>
11629 <dd>
11630 <p>
11631         If this option is set, <code>upload-pack</code> will support partial
11632         clone and partial fetch object filtering.
11633 </p>
11634 </dd>
11635 <dt class="hdlist1">
11636 uploadpackfilter.allow
11637 </dt>
11638 <dd>
11639 <p>
11640         Provides a default value for unspecified object filters (see: the
11641         below configuration variable). If set to <code>true</code>, this will also
11642         enable all filters which get added in the future.
11643         Defaults to <code>true</code>.
11644 </p>
11645 </dd>
11646 <dt class="hdlist1">
11647 uploadpackfilter.&lt;filter&gt;.allow
11648 </dt>
11649 <dd>
11650 <p>
11651         Explicitly allow or ban the object filter corresponding to
11652         <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
11653         <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
11654         If using combined filters, both <code>combine</code> and all of the nested
11655         filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.
11656 </p>
11657 </dd>
11658 <dt class="hdlist1">
11659 uploadpackfilter.tree.maxDepth
11660 </dt>
11661 <dd>
11662 <p>
11663         Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
11664         <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
11665         <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
11666         variable had already been set. Has no effect if unset.
11667 </p>
11668 </dd>
11669 <dt class="hdlist1">
11670 uploadpack.allowRefInWant
11671 </dt>
11672 <dd>
11673 <p>
11674         If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
11675         feature of the protocol version 2 <code>fetch</code> command.  This feature
11676         is intended for the benefit of load-balanced servers which may
11677         not have the same view of what OIDs their refs point to due to
11678         replication delay.
11679 </p>
11680 </dd>
11681 <dt class="hdlist1">
11682 url.&lt;base&gt;.insteadOf
11683 </dt>
11684 <dd>
11685 <p>
11686         Any URL that starts with this value will be rewritten to
11687         start, instead, with &lt;base&gt;. In cases where some site serves a
11688         large number of repositories, and serves them with multiple
11689         access methods, and some users need to use different access
11690         methods, this feature allows people to specify any of the
11691         equivalent URLs and have Git automatically rewrite the URL to
11692         the best alternative for the particular user, even for a
11693         never-before-seen repository on the site.  When more than one
11694         insteadOf strings match a given URL, the longest match is used.
11695 </p>
11696 <div class="paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
11697 URL. If the rewrite changes the URL to use a custom protocol or remote
11698 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
11699 the request.  In particular, protocols you expect to use for submodules
11700 must be set to <code>always</code> rather than the default of <code>user</code>. See the
11701 description of <code>protocol.allow</code> above.</p></div>
11702 </dd>
11703 <dt class="hdlist1">
11704 url.&lt;base&gt;.pushInsteadOf
11705 </dt>
11706 <dd>
11707 <p>
11708         Any URL that starts with this value will not be pushed to;
11709         instead, it will be rewritten to start with &lt;base&gt;, and the
11710         resulting URL will be pushed to. In cases where some site serves
11711         a large number of repositories, and serves them with multiple
11712         access methods, some of which do not allow push, this feature
11713         allows people to specify a pull-only URL and have Git
11714         automatically use an appropriate URL to push, even for a
11715         never-before-seen repository on the site.  When more than one
11716         pushInsteadOf strings match a given URL, the longest match is
11717         used.  If a remote has an explicit pushurl, Git will ignore this
11718         setting for that remote.
11719 </p>
11720 </dd>
11721 <dt class="hdlist1">
11722 user.name
11723 </dt>
11724 <dt class="hdlist1">
11725 user.email
11726 </dt>
11727 <dt class="hdlist1">
11728 author.name
11729 </dt>
11730 <dt class="hdlist1">
11731 author.email
11732 </dt>
11733 <dt class="hdlist1">
11734 committer.name
11735 </dt>
11736 <dt class="hdlist1">
11737 committer.email
11738 </dt>
11739 <dd>
11740 <p>
11741         The <code>user.name</code> and <code>user.email</code> variables determine what ends
11742         up in the <code>author</code> and <code>committer</code> fields of commit
11743         objects.
11744         If you need the <code>author</code> or <code>committer</code> to be different, the
11745         <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
11746         <code>committer.email</code> variables can be set.
11747         All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
11748         <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
11749         <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.
11750 </p>
11751 <div class="paragraph"><p>Note that the <code>name</code> forms of these variables conventionally refer to
11752 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
11753 environment variables section of <a href="git.html">git(1)</a> for more information on
11754 these settings and the <code>credential.username</code> option if you&#8217;re looking
11755 for authentication credentials instead.</p></div>
11756 </dd>
11757 <dt class="hdlist1">
11758 user.useConfigOnly
11759 </dt>
11760 <dd>
11761 <p>
11762         Instruct Git to avoid trying to guess defaults for <code>user.email</code>
11763         and <code>user.name</code>, and instead retrieve the values only from the
11764         configuration. For example, if you have multiple email addresses
11765         and would like to use a different one for each repository, then
11766         with this configuration option set to <code>true</code> in the global config
11767         along with a name, Git will prompt you to set up an email before
11768         making new commits in a newly cloned repository.
11769         Defaults to <code>false</code>.
11770 </p>
11771 </dd>
11772 <dt class="hdlist1">
11773 user.signingKey
11774 </dt>
11775 <dd>
11776 <p>
11777         If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
11778         key you want it to automatically when creating a signed tag or
11779         commit, you can override the default selection with this variable.
11780         This option is passed unchanged to gpg&#8217;s --local-user parameter,
11781         so you may specify a key using any method that gpg supports.
11782         If gpg.format is set to <code>ssh</code> this can contain the path to either
11783         your private ssh key or the public key when ssh-agent is used.
11784         Alternatively it can contain a public key prefixed with <code>key::</code>
11785         directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
11786         needs to be available via ssh-agent. If not set Git will call
11787         gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
11788         first key available. For backward compatibility, a raw key which
11789         begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
11790         as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
11791         use the <code>key::</code> form instead.
11792 </p>
11793 </dd>
11794 <dt class="hdlist1">
11795 versionsort.prereleaseSuffix (deprecated)
11796 </dt>
11797 <dd>
11798 <p>
11799         Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
11800         <code>versionsort.suffix</code> is set.
11801 </p>
11802 </dd>
11803 <dt class="hdlist1">
11804 versionsort.suffix
11805 </dt>
11806 <dd>
11807 <p>
11808         Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
11809         with the same base version but different suffixes are still sorted
11810         lexicographically, resulting e.g. in prerelease tags appearing
11811         after the main release (e.g. "1.0-rc1" after "1.0").  This
11812         variable can be specified to determine the sorting order of tags
11813         with different suffixes.
11814 </p>
11815 <div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
11816 that suffix will appear before the corresponding main release.  E.g. if
11817 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
11818 "1.0".  If specified multiple times, once per suffix, then the order of
11819 suffixes in the configuration will determine the sorting order of tagnames
11820 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
11821 configuration, then all "1.0-preX" tags will be listed before any
11822 "1.0-rcX" tags.  The placement of the main release tag relative to tags
11823 with various suffixes can be determined by specifying the empty suffix
11824 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
11825 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
11826 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
11827 "v4.8-bfsX".</p></div>
11828 <div class="paragraph"><p>If more than one suffix matches the same tagname, then that tagname will
11829 be sorted according to the suffix which starts at the earliest position in
11830 the tagname.  If more than one different matching suffix starts at
11831 that earliest position, then that tagname will be sorted according to the
11832 longest of those suffixes.
11833 The sorting order between different suffixes is undefined if they are
11834 in multiple config files.</p></div>
11835 </dd>
11836 <dt class="hdlist1">
11837 web.browser
11838 </dt>
11839 <dd>
11840 <p>
11841         Specify a web browser that may be used by some commands.
11842         Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
11843         may use it.
11844 </p>
11845 </dd>
11846 <dt class="hdlist1">
11847 worktree.guessRemote
11848 </dt>
11849 <dd>
11850 <p>
11851         If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
11852         <code>--detach</code> is used, then <code>git worktree add</code> defaults to
11853         creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
11854         set to true, <code>worktree add</code> tries to find a remote-tracking
11855         branch whose name uniquely matches the new branch name.  If
11856         such a branch exists, it is checked out and set as "upstream"
11857         for the new branch.  If no such match can be found, it falls
11858         back to creating a new branch from the current HEAD.
11859 </p>
11860 </dd>
11861 </dl></div>
11862 </div>
11863 </div>
11864 </div>
11865 <div class="sect1">
11866 <h2 id="_bugs">BUGS</h2>
11867 <div class="sectionbody">
11868 <div class="paragraph"><p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
11869 will result in adding a multi-line key instead of a change, if the subsection
11870 is given with at least one uppercase character. For example when the config
11871 looks like</p></div>
11872 <div class="listingblock">
11873 <div class="content">
11874 <pre><code>  [section.subsection]
11875     key = value1</code></pre>
11876 </div></div>
11877 <div class="paragraph"><p>and running <code>git config section.Subsection.key value2</code> will result in</p></div>
11878 <div class="listingblock">
11879 <div class="content">
11880 <pre><code>  [section.subsection]
11881     key = value1
11882     key = value2</code></pre>
11883 </div></div>
11884 </div>
11885 </div>
11886 <div class="sect1">
11887 <h2 id="_git">GIT</h2>
11888 <div class="sectionbody">
11889 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
11890 </div>
11891 </div>
11892 </div>
11893 <div id="footnotes"><hr /></div>
11894 <div id="footer">
11895 <div id="footer-text">
11896 Last updated
11897  2023-09-22 17:04:28 PDT
11898 </div>
11899 </div>
11900 </body>
11901 </html>