git-config.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-config(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-config(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-config -
 743    Get and set repository or global options
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git config list</em> [&lt;file-option&gt;] [&lt;display-option&gt;] [--includes]
 753 <em>git config get</em> [&lt;file-option&gt;] [&lt;display-option&gt;] [--includes] [--all] [--regexp=&lt;regexp&gt;] [--value=&lt;value&gt;] [--fixed-value] [--default=&lt;default&gt;] &lt;name&gt;
 754 <em>git config set</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--all] [--value=&lt;value&gt;] [--fixed-value] &lt;name&gt; &lt;value&gt;
 755 <em>git config unset</em> [&lt;file-option&gt;] [--all] [--value=&lt;value&gt;] [--fixed-value] &lt;name&gt; &lt;value&gt;
 756 <em>git config rename-section</em> [&lt;file-option&gt;] &lt;old-name&gt; &lt;new-name&gt;
 757 <em>git config remove-section</em> [&lt;file-option&gt;] &lt;name&gt;
 758 <em>git config edit</em> [&lt;file-option&gt;]
 759 <em>git config</em> [&lt;file-option&gt;] --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]</pre>
 760 <div class="attribution">
 761 </div></div>
 762 </div>
 763 </div>
 764 <div class="sect1">
 765 <h2 id="_description">DESCRIPTION</h2>
 766 <div class="sectionbody">
 767 <div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is
 768 actually the section and the key separated by a dot, and the value will be
 769 escaped.</p></div>
 770 <div class="paragraph"><p>Multiple lines can be added to an option by using the <code>--append</code> option.
 771 If you want to update or unset an option which can occur on multiple
 772 lines, a <code>value-pattern</code> (which is an extended regular expression,
 773 unless the <code>--fixed-value</code> option is given) needs to be given.  Only the
 774 existing values that match the pattern are updated or unset.  If
 775 you want to handle the lines that do <strong>not</strong> match the pattern, just
 776 prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>),
 777 but note that this only works when the <code>--fixed-value</code> option is not
 778 in use.</p></div>
 779 <div class="paragraph"><p>The <code>--type=&lt;type&gt;</code> option instructs <em>git config</em> to ensure that incoming and
 780 outgoing values are canonicalize-able under the given &lt;type&gt;.  If no
 781 <code>--type=&lt;type&gt;</code> is given, no canonicalization will be performed. Callers may
 782 unset an existing <code>--type</code> specifier with <code>--no-type</code>.</p></div>
 783 <div class="paragraph"><p>When reading, the values are read from the system, global and
 784 repository local configuration files by default, and options
 785 <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code> and
 786 <code>--file &lt;filename&gt;</code> can be used to tell the command to read from only
 787 that location (see <a href="#FILES">[FILES]</a>).</p></div>
 788 <div class="paragraph"><p>When writing, the new value is written to the repository local
 789 configuration file by default, and options <code>--system</code>, <code>--global</code>,
 790 <code>--worktree</code>, <code>--file &lt;filename&gt;</code> can be used to tell the command to
 791 write to that location (you can say <code>--local</code> but that is the
 792 default).</p></div>
 793 <div class="paragraph"><p>This command will fail with non-zero status upon error.  Some exit
 794 codes are:</p></div>
 795 <div class="ulist"><ul>
 796 <li>
 797 <p>
 798 The section or key is invalid (ret=1),
 799 </p>
 800 </li>
 801 <li>
 802 <p>
 803 no section or name was provided (ret=2),
 804 </p>
 805 </li>
 806 <li>
 807 <p>
 808 the config file is invalid (ret=3),
 809 </p>
 810 </li>
 811 <li>
 812 <p>
 813 the config file cannot be written (ret=4),
 814 </p>
 815 </li>
 816 <li>
 817 <p>
 818 you try to unset an option which does not exist (ret=5),
 819 </p>
 820 </li>
 821 <li>
 822 <p>
 823 you try to unset/set an option for which multiple lines match (ret=5), or
 824 </p>
 825 </li>
 826 <li>
 827 <p>
 828 you try to use an invalid regexp (ret=6).
 829 </p>
 830 </li>
 831 </ul></div>
 832 <div class="paragraph"><p>On success, the command returns the exit code 0.</p></div>
 833 <div class="paragraph"><p>A list of all available configuration variables can be obtained using the
 834 <code>git help --config</code> command.</p></div>
 835 </div>
 836 </div>
 837 <div class="sect1">
 838 <h2 id="_commands">COMMANDS</h2>
 839 <div class="sectionbody">
 840 <div class="dlist"><dl>
 841 <dt class="hdlist1">
 842 list
 843 </dt>
 844 <dd>
 845 <p>
 846         List all variables set in config file, along with their values.
 847 </p>
 848 </dd>
 849 <dt class="hdlist1">
 850 get
 851 </dt>
 852 <dd>
 853 <p>
 854         Emits the value of the specified key. If key is present multiple times
 855         in the configuration, emits the last value. If <code>--all</code> is specified,
 856         emits all values associated with key. Returns error code 1 if key is
 857         not present.
 858 </p>
 859 </dd>
 860 <dt class="hdlist1">
 861 set
 862 </dt>
 863 <dd>
 864 <p>
 865         Set value for one or more config options. By default, this command
 866         refuses to write multi-valued config options. Passing <code>--all</code> will
 867         replace all multi-valued config options with the new value, whereas
 868         <code>--value=</code> will replace all config options whose values match the given
 869         pattern.
 870 </p>
 871 </dd>
 872 <dt class="hdlist1">
 873 unset
 874 </dt>
 875 <dd>
 876 <p>
 877         Unset value for one or more config options. By default, this command
 878         refuses to unset multi-valued keys. Passing <code>--all</code> will unset all
 879         multi-valued config options, whereas <code>--value</code> will unset all config
 880         options whose values match the given pattern.
 881 </p>
 882 </dd>
 883 <dt class="hdlist1">
 884 rename-section
 885 </dt>
 886 <dd>
 887 <p>
 888         Rename the given section to a new name.
 889 </p>
 890 </dd>
 891 <dt class="hdlist1">
 892 remove-section
 893 </dt>
 894 <dd>
 895 <p>
 896         Remove the given section from the configuration file.
 897 </p>
 898 </dd>
 899 <dt class="hdlist1">
 900 edit
 901 </dt>
 902 <dd>
 903 <p>
 904         Opens an editor to modify the specified config file; either
 905         <code>--system</code>, <code>--global</code>, <code>--local</code> (default), <code>--worktree</code>, or
 906         <code>--file &lt;config-file&gt;</code>.
 907 </p>
 908 </dd>
 909 </dl></div>
 910 </div>
 911 </div>
 912 <div class="sect1">
 913 <h2 id="OPTIONS">OPTIONS</h2>
 914 <div class="sectionbody">
 915 <div class="dlist"><dl>
 916 <dt class="hdlist1">
 917 --replace-all
 918 </dt>
 919 <dd>
 920 <p>
 921         Default behavior is to replace at most one line. This replaces
 922         all lines matching the key (and optionally the <code>value-pattern</code>).
 923 </p>
 924 </dd>
 925 <dt class="hdlist1">
 926 --append
 927 </dt>
 928 <dd>
 929 <p>
 930         Adds a new line to the option without altering any existing
 931         values. This is the same as providing <em>--value=^$</em> in <code>set</code>.
 932 </p>
 933 </dd>
 934 <dt class="hdlist1">
 935 --comment &lt;message&gt;
 936 </dt>
 937 <dd>
 938 <p>
 939         Append a comment at the end of new or modified lines.
 940 </p>
 941 <div class="literalblock">
 942 <div class="content">
 943 <pre><code>If _&lt;message&gt;_ begins with one or more whitespaces followed
 944 by "#", it is used as-is.  If it begins with "#", a space is
 945 prepended before it is used.  Otherwise, a string " # " (a
 946 space followed by a hash followed by a space) is prepended
 947 to it.  And the resulting string is placed immediately after
 948 the value defined for the variable.  The _&lt;message&gt;_ must
 949 not contain linefeed characters (no multi-line comments are
 950 permitted).</code></pre>
 951 </div></div>
 952 </dd>
 953 <dt class="hdlist1">
 954 --all
 955 </dt>
 956 <dd>
 957 <p>
 958         With <code>get</code>, return all values for a multi-valued key.
 959 </p>
 960 </dd>
 961 <dt class="hdlist1">
 962 ---regexp
 963 </dt>
 964 <dd>
 965 <p>
 966         With <code>get</code>, interpret the name as a regular expression. Regular
 967         expression matching is currently case-sensitive and done against a
 968         canonicalized version of the key in which section and variable names
 969         are lowercased, but subsection names are not.
 970 </p>
 971 </dd>
 972 <dt class="hdlist1">
 973 --url=&lt;URL&gt;
 974 </dt>
 975 <dd>
 976 <p>
 977         When given a two-part &lt;name&gt; as &lt;section&gt;.&lt;key&gt;, the value for
 978         &lt;section&gt;.&lt;URL&gt;.&lt;key&gt; whose &lt;URL&gt; part matches the best to the
 979         given URL is returned (if no such key exists, the value for
 980         &lt;section&gt;.&lt;key&gt; is used as a fallback).  When given just the
 981         &lt;section&gt; as name, do so for all the keys in the section and
 982         list them.  Returns error code 1 if no value is found.
 983 </p>
 984 </dd>
 985 <dt class="hdlist1">
 986 --global
 987 </dt>
 988 <dd>
 989 <p>
 990         For writing options: write to global <code>~/.gitconfig</code> file
 991         rather than the repository <code>.git/config</code>, write to
 992         <code>$XDG_CONFIG_HOME/git/config</code> file if this file exists and the
 993         <code>~/.gitconfig</code> file doesn&#8217;t.
 994 </p>
 995 <div class="paragraph"><p>For reading options: read only from global <code>~/.gitconfig</code> and from
 996 <code>$XDG_CONFIG_HOME/git/config</code> rather than from all available files.</p></div>
 997 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 998 </dd>
 999 <dt class="hdlist1">
1000 --system
1001 </dt>
1002 <dd>
1003 <p>
1004         For writing options: write to system-wide
1005         <code>$(prefix)/etc/gitconfig</code> rather than the repository
1006         <code>.git/config</code>.
1007 </p>
1008 <div class="paragraph"><p>For reading options: read only from system-wide <code>$(prefix)/etc/gitconfig</code>
1009 rather than from all available files.</p></div>
1010 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1011 </dd>
1012 <dt class="hdlist1">
1013 --local
1014 </dt>
1015 <dd>
1016 <p>
1017         For writing options: write to the repository <code>.git/config</code> file.
1018         This is the default behavior.
1019 </p>
1020 <div class="paragraph"><p>For reading options: read only from the repository <code>.git/config</code> rather than
1021 from all available files.</p></div>
1022 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1023 </dd>
1024 <dt class="hdlist1">
1025 --worktree
1026 </dt>
1027 <dd>
1028 <p>
1029         Similar to <code>--local</code> except that <code>$GIT_DIR/config.worktree</code> is
1030         read from or written to if <code>extensions.worktreeConfig</code> is
1031         enabled. If not it&#8217;s the same as <code>--local</code>. Note that <code>$GIT_DIR</code>
1032         is equal to <code>$GIT_COMMON_DIR</code> for the main working tree, but is of
1033         the form <code>$GIT_DIR/worktrees/&lt;id&gt;/</code> for other working trees. See
1034         <a href="git-worktree.html">git-worktree(1)</a> to learn how to enable
1035         <code>extensions.worktreeConfig</code>.
1036 </p>
1037 </dd>
1038 <dt class="hdlist1">
1039 -f &lt;config-file&gt;
1040 </dt>
1041 <dt class="hdlist1">
1042 --file &lt;config-file&gt;
1043 </dt>
1044 <dd>
1045 <p>
1046         For writing options: write to the specified file rather than the
1047         repository <code>.git/config</code>.
1048 </p>
1049 <div class="paragraph"><p>For reading options: read only from the specified file rather than from all
1050 available files.</p></div>
1051 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1052 </dd>
1053 <dt class="hdlist1">
1054 --blob &lt;blob&gt;
1055 </dt>
1056 <dd>
1057 <p>
1058         Similar to <code>--file</code> but use the given blob instead of a file. E.g.
1059         you can use <em>master:.gitmodules</em> to read values from the file
1060         <em>.gitmodules</em> in the master branch. See "SPECIFYING REVISIONS"
1061         section in <a href="gitrevisions.html">gitrevisions(7)</a> for a more complete list of
1062         ways to spell blob names.
1063 </p>
1064 </dd>
1065 <dt class="hdlist1">
1066 --fixed-value
1067 </dt>
1068 <dd>
1069 <p>
1070         When used with the <code>value-pattern</code> argument, treat <code>value-pattern</code> as
1071         an exact string instead of a regular expression. This will restrict
1072         the name/value pairs that are matched to only those where the value
1073         is exactly equal to the <code>value-pattern</code>.
1074 </p>
1075 </dd>
1076 <dt class="hdlist1">
1077 --type &lt;type&gt;
1078 </dt>
1079 <dd>
1080 <p>
1081   <em>git config</em> will ensure that any input or output is valid under the given
1082   type constraint(s), and will canonicalize outgoing values in <code>&lt;type&gt;</code>'s
1083   canonical form.
1084 </p>
1085 <div class="paragraph"><p>Valid <code>&lt;type&gt;</code>'s include:</p></div>
1086 <div class="ulist"><ul>
1087 <li>
1088 <p>
1089 <em>bool</em>: canonicalize values as either "true" or "false".
1090 </p>
1091 </li>
1092 <li>
1093 <p>
1094 <em>int</em>: canonicalize values as simple decimal numbers. An optional suffix of
1095   <em>k</em>, <em>m</em>, or <em>g</em> will cause the value to be multiplied by 1024, 1048576, or
1096   1073741824 upon input.
1097 </p>
1098 </li>
1099 <li>
1100 <p>
1101 <em>bool-or-int</em>: canonicalize according to either <em>bool</em> or <em>int</em>, as described
1102   above.
1103 </p>
1104 </li>
1105 <li>
1106 <p>
1107 <em>path</em>: canonicalize by expanding a leading <code>~</code> to the value of <code>$HOME</code> and
1108   <code>~user</code> to the home directory for the specified user. This specifier has no
1109   effect when setting the value (but you can use <code>git config section.variable
1110   ~/</code> from the command line to let your shell do the expansion.)
1111 </p>
1112 </li>
1113 <li>
1114 <p>
1115 <em>expiry-date</em>: canonicalize by converting from a fixed or relative date-string
1116   to a timestamp. This specifier has no effect when setting the value.
1117 </p>
1118 </li>
1119 <li>
1120 <p>
1121 <em>color</em>: When getting a value, canonicalize by converting to an ANSI color
1122   escape sequence. When setting a value, a sanity-check is performed to ensure
1123   that the given value is canonicalize-able as an ANSI color, but it is written
1124   as-is.
1125 </p>
1126 </li>
1127 </ul></div>
1128 </dd>
1129 <dt class="hdlist1">
1130 --bool
1131 </dt>
1132 <dt class="hdlist1">
1133 --int
1134 </dt>
1135 <dt class="hdlist1">
1136 --bool-or-int
1137 </dt>
1138 <dt class="hdlist1">
1139 --path
1140 </dt>
1141 <dt class="hdlist1">
1142 --expiry-date
1143 </dt>
1144 <dd>
1145 <p>
1146   Historical options for selecting a type specifier. Prefer instead <code>--type</code>
1147   (see above).
1148 </p>
1149 </dd>
1150 <dt class="hdlist1">
1151 --no-type
1152 </dt>
1153 <dd>
1154 <p>
1155   Un-sets the previously set type specifier (if one was previously set). This
1156   option requests that <em>git config</em> not canonicalize the retrieved variable.
1157   <code>--no-type</code> has no effect without <code>--type=&lt;type&gt;</code> or <code>--&lt;type&gt;</code>.
1158 </p>
1159 </dd>
1160 <dt class="hdlist1">
1161 -z
1162 </dt>
1163 <dt class="hdlist1">
1164 --null
1165 </dt>
1166 <dd>
1167 <p>
1168         For all options that output values and/or keys, always
1169         end values with the null character (instead of a
1170         newline). Use newline instead as a delimiter between
1171         key and value. This allows for secure parsing of the
1172         output without getting confused e.g. by values that
1173         contain line breaks.
1174 </p>
1175 </dd>
1176 <dt class="hdlist1">
1177 --name-only
1178 </dt>
1179 <dd>
1180 <p>
1181         Output only the names of config variables for <code>list</code> or
1182         <code>get</code>.
1183 </p>
1184 </dd>
1185 <dt class="hdlist1">
1186 --show-origin
1187 </dt>
1188 <dd>
1189 <p>
1190         Augment the output of all queried config options with the
1191         origin type (file, standard input, blob, command line) and
1192         the actual origin (config file path, ref, or blob id if
1193         applicable).
1194 </p>
1195 </dd>
1196 <dt class="hdlist1">
1197 --show-scope
1198 </dt>
1199 <dd>
1200 <p>
1201         Similar to <code>--show-origin</code> in that it augments the output of
1202         all queried config options with the scope of that value
1203         (worktree, local, global, system, command).
1204 </p>
1205 </dd>
1206 <dt class="hdlist1">
1207 --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]
1208 </dt>
1209 <dd>
1210 <p>
1211         Find the color setting for <code>&lt;name&gt;</code> (e.g. <code>color.diff</code>) and output
1212         "true" or "false".  <code>&lt;stdout-is-tty&gt;</code> should be either "true" or
1213         "false", and is taken into account when configuration says
1214         "auto".  If <code>&lt;stdout-is-tty&gt;</code> is missing, then checks the standard
1215         output of the command itself, and exits with status 0 if color
1216         is to be used, or exits with status 1 otherwise.
1217         When the color setting for <code>name</code> is undefined, the command uses
1218         <code>color.ui</code> as fallback.
1219 </p>
1220 </dd>
1221 <dt class="hdlist1">
1222 --[no-]includes
1223 </dt>
1224 <dd>
1225 <p>
1226         Respect <code>include.*</code> directives in config files when looking up
1227         values. Defaults to <code>off</code> when a specific file is given (e.g.,
1228         using <code>--file</code>, <code>--global</code>, etc) and <code>on</code> when searching all
1229         config files.
1230 </p>
1231 </dd>
1232 <dt class="hdlist1">
1233 --default &lt;value&gt;
1234 </dt>
1235 <dd>
1236 <p>
1237   When using <code>get</code>, and the requested variable is not found, behave as if
1238   &lt;value&gt; were the value assigned to that variable.
1239 </p>
1240 </dd>
1241 </dl></div>
1242 </div>
1243 </div>
1244 <div class="sect1">
1245 <h2 id="_deprecated_modes">DEPRECATED MODES</h2>
1246 <div class="sectionbody">
1247 <div class="paragraph"><p>The following modes have been deprecated in favor of subcommands. It is
1248 recommended to migrate to the new syntax.</p></div>
1249 <div class="dlist"><dl>
1250 <dt class="hdlist1">
1251 <em>git config &lt;name&gt;</em>
1252 </dt>
1253 <dd>
1254 <p>
1255         Replaced by <code>git config get &lt;name&gt;</code>.
1256 </p>
1257 </dd>
1258 <dt class="hdlist1">
1259 <em>git config &lt;name&gt; &lt;value&gt; [&lt;value-pattern&gt;]</em>
1260 </dt>
1261 <dd>
1262 <p>
1263         Replaced by <code>git config set [--value=&lt;pattern&gt;] &lt;name&gt; &lt;value&gt;</code>.
1264 </p>
1265 </dd>
1266 <dt class="hdlist1">
1267 -l
1268 </dt>
1269 <dt class="hdlist1">
1270 --list
1271 </dt>
1272 <dd>
1273 <p>
1274         Replaced by <code>git config list</code>.
1275 </p>
1276 </dd>
1277 <dt class="hdlist1">
1278 --get &lt;name&gt; [&lt;value-pattern&gt;]
1279 </dt>
1280 <dd>
1281 <p>
1282         Replaced by <code>git config get [--value=&lt;pattern&gt;] &lt;name&gt;</code>.
1283 </p>
1284 </dd>
1285 <dt class="hdlist1">
1286 --get-all &lt;name&gt; [&lt;value-pattern&gt;]
1287 </dt>
1288 <dd>
1289 <p>
1290         Replaced by <code>git config get [--value=&lt;pattern&gt;] --all --show-names &lt;name&gt;</code>.
1291 </p>
1292 </dd>
1293 <dt class="hdlist1">
1294 --get-regexp &lt;name-regexp&gt;
1295 </dt>
1296 <dd>
1297 <p>
1298         Replaced by <code>git config get --all --show-names --regexp &lt;name-regexp&gt;</code>.
1299 </p>
1300 </dd>
1301 <dt class="hdlist1">
1302 --get-urlmatch &lt;name&gt; &lt;URL&gt;
1303 </dt>
1304 <dd>
1305 <p>
1306         Replaced by <code>git config get --all --show-names --url=&lt;URL&gt; &lt;name&gt;</code>.
1307 </p>
1308 </dd>
1309 <dt class="hdlist1">
1310 --get-color &lt;name&gt; [&lt;default&gt;]
1311 </dt>
1312 <dd>
1313 <p>
1314         Replaced by <code>git config get --type=color [--default=&lt;default&gt;] &lt;name&gt;</code>.
1315 </p>
1316 </dd>
1317 <dt class="hdlist1">
1318 --add &lt;name&gt; &lt;value&gt;
1319 </dt>
1320 <dd>
1321 <p>
1322         Replaced by <code>git config set --append &lt;name&gt; &lt;value&gt;</code>.
1323 </p>
1324 </dd>
1325 <dt class="hdlist1">
1326 --unset &lt;name&gt; [&lt;value-pattern&gt;]
1327 </dt>
1328 <dd>
1329 <p>
1330         Replaced by <code>git config unset [--value=&lt;pattern&gt;] &lt;name&gt;</code>.
1331 </p>
1332 </dd>
1333 <dt class="hdlist1">
1334 --unset-all &lt;name&gt; [&lt;value-pattern&gt;]
1335 </dt>
1336 <dd>
1337 <p>
1338         Replaced by <code>git config unset [--value=&lt;pattern&gt;] --all &lt;name&gt;</code>.
1339 </p>
1340 </dd>
1341 <dt class="hdlist1">
1342 --rename-section &lt;old-name&gt; &lt;new-name&gt;
1343 </dt>
1344 <dd>
1345 <p>
1346         Replaced by <code>git config rename-section &lt;old-name&gt; &lt;new-name&gt;</code>.
1347 </p>
1348 </dd>
1349 <dt class="hdlist1">
1350 --remove-section &lt;name&gt;
1351 </dt>
1352 <dd>
1353 <p>
1354         Replaced by <code>git config remove-section &lt;name&gt;</code>.
1355 </p>
1356 </dd>
1357 <dt class="hdlist1">
1358 -e
1359 </dt>
1360 <dt class="hdlist1">
1361 --edit
1362 </dt>
1363 <dd>
1364 <p>
1365         Replaced by <code>git config edit</code>.
1366 </p>
1367 </dd>
1368 </dl></div>
1369 </div>
1370 </div>
1371 <div class="sect1">
1372 <h2 id="_configuration">CONFIGURATION</h2>
1373 <div class="sectionbody">
1374 <div class="paragraph"><p><code>pager.config</code> is only respected when listing configuration, i.e., when
1375 using <code>list</code> or <code>get</code> which may return multiple results. The default is to use
1376 a pager.</p></div>
1377 </div>
1378 </div>
1379 <div class="sect1">
1380 <h2 id="FILES">FILES</h2>
1381 <div class="sectionbody">
1382 <div class="paragraph"><p>By default, <em>git config</em> will read configuration options from multiple
1383 files:</p></div>
1384 <div class="dlist"><dl>
1385 <dt class="hdlist1">
1386 $(prefix)/etc/gitconfig
1387 </dt>
1388 <dd>
1389 <p>
1390         System-wide configuration file.
1391 </p>
1392 </dd>
1393 <dt class="hdlist1">
1394 $XDG_CONFIG_HOME/git/config
1395 </dt>
1396 <dt class="hdlist1">
1397 ~/.gitconfig
1398 </dt>
1399 <dd>
1400 <p>
1401         User-specific configuration files. When the XDG_CONFIG_HOME environment
1402         variable is not set or empty, $HOME/.config/ is used as
1403         $XDG_CONFIG_HOME.
1404 </p>
1405 <div class="paragraph"><p>These are also called "global" configuration files. If both files exist, both
1406 files are read in the order given above.</p></div>
1407 </dd>
1408 <dt class="hdlist1">
1409 $GIT_DIR/config
1410 </dt>
1411 <dd>
1412 <p>
1413         Repository specific configuration file.
1414 </p>
1415 </dd>
1416 <dt class="hdlist1">
1417 $GIT_DIR/config.worktree
1418 </dt>
1419 <dd>
1420 <p>
1421         This is optional and is only searched when
1422         <code>extensions.worktreeConfig</code> is present in $GIT_DIR/config.
1423 </p>
1424 </dd>
1425 </dl></div>
1426 <div class="paragraph"><p>You may also provide additional configuration parameters when running any
1427 git command by using the <code>-c</code> option. See <a href="git.html">git(1)</a> for details.</p></div>
1428 <div class="paragraph"><p>Options will be read from all of these files that are available. If the
1429 global or the system-wide configuration files are missing or unreadable they
1430 will be ignored. If the repository configuration file is missing or unreadable,
1431 <em>git config</em> will exit with a non-zero error code. An error message is produced
1432 if the file is unreadable, but not if it is missing.</p></div>
1433 <div class="paragraph"><p>The files are read in the order given above, with last value found taking
1434 precedence over values read earlier.  When multiple values are taken then all
1435 values of a key from all files will be used.</p></div>
1436 <div class="paragraph"><p>By default, options are only written to the repository specific
1437 configuration file. Note that this also affects options like <code>set</code>
1438 and <code>unset</code>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
1439 <div class="paragraph"><p>You can limit which configuration sources are read from or written to by
1440 specifying the path of a file with the <code>--file</code> option, or by specifying a
1441 configuration scope with <code>--system</code>, <code>--global</code>, <code>--local</code>, or <code>--worktree</code>.
1442 For more, see <a href="#OPTIONS">[OPTIONS]</a> above.</p></div>
1443 </div>
1444 </div>
1445 <div class="sect1">
1446 <h2 id="SCOPES">SCOPES</h2>
1447 <div class="sectionbody">
1448 <div class="paragraph"><p>Each configuration source falls within a configuration scope. The scopes
1449 are:</p></div>
1450 <div class="dlist"><dl>
1451 <dt class="hdlist1">
1452 system
1453 </dt>
1454 <dd>
1455 <p>
1456         $(prefix)/etc/gitconfig
1457 </p>
1458 </dd>
1459 <dt class="hdlist1">
1460 global
1461 </dt>
1462 <dd>
1463 <p>
1464         $XDG_CONFIG_HOME/git/config
1465 </p>
1466 <div class="paragraph"><p>~/.gitconfig</p></div>
1467 </dd>
1468 <dt class="hdlist1">
1469 local
1470 </dt>
1471 <dd>
1472 <p>
1473         $GIT_DIR/config
1474 </p>
1475 </dd>
1476 <dt class="hdlist1">
1477 worktree
1478 </dt>
1479 <dd>
1480 <p>
1481         $GIT_DIR/config.worktree
1482 </p>
1483 </dd>
1484 <dt class="hdlist1">
1485 command
1486 </dt>
1487 <dd>
1488 <p>
1489         GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see <a href="#ENVIRONMENT">[ENVIRONMENT]</a>
1490         below)
1491 </p>
1492 <div class="paragraph"><p>the <code>-c</code> option</p></div>
1493 </dd>
1494 </dl></div>
1495 <div class="paragraph"><p>With the exception of <em>command</em>, each scope corresponds to a command line
1496 option: <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code>.</p></div>
1497 <div class="paragraph"><p>When reading options, specifying a scope will only read options from the
1498 files within that scope. When writing options, specifying a scope will write
1499 to the files within that scope (instead of the repository specific
1500 configuration file). See <a href="#OPTIONS">[OPTIONS]</a> above for a complete description.</p></div>
1501 <div class="paragraph"><p>Most configuration options are respected regardless of the scope it is
1502 defined in, but some options are only respected in certain scopes. See the
1503 respective option&#8217;s documentation for the full details.</p></div>
1504 <div class="sect2">
1505 <h3 id="_protected_configuration">Protected configuration</h3>
1506 <div class="paragraph"><p>Protected configuration refers to the <em>system</em>, <em>global</em>, and <em>command</em> scopes.
1507 For security reasons, certain options are only respected when they are
1508 specified in protected configuration, and ignored otherwise.</p></div>
1509 <div class="paragraph"><p>Git treats these scopes as if they are controlled by the user or a trusted
1510 administrator. This is because an attacker who controls these scopes can do
1511 substantial harm without using Git, so it is assumed that the user&#8217;s environment
1512 protects these scopes against attackers.</p></div>
1513 </div>
1514 </div>
1515 </div>
1516 <div class="sect1">
1517 <h2 id="ENVIRONMENT">ENVIRONMENT</h2>
1518 <div class="sectionbody">
1519 <div class="dlist"><dl>
1520 <dt class="hdlist1">
1521 GIT_CONFIG_GLOBAL
1522 </dt>
1523 <dt class="hdlist1">
1524 GIT_CONFIG_SYSTEM
1525 </dt>
1526 <dd>
1527 <p>
1528         Take the configuration from the given files instead from global or
1529         system-level configuration. See <a href="git.html">git(1)</a> for details.
1530 </p>
1531 </dd>
1532 <dt class="hdlist1">
1533 GIT_CONFIG_NOSYSTEM
1534 </dt>
1535 <dd>
1536 <p>
1537         Whether to skip reading settings from the system-wide
1538         $(prefix)/etc/gitconfig file. See <a href="git.html">git(1)</a> for details.
1539 </p>
1540 </dd>
1541 </dl></div>
1542 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1543 <div class="dlist"><dl>
1544 <dt class="hdlist1">
1545 GIT_CONFIG_COUNT
1546 </dt>
1547 <dt class="hdlist1">
1548 GIT_CONFIG_KEY_&lt;n&gt;
1549 </dt>
1550 <dt class="hdlist1">
1551 GIT_CONFIG_VALUE_&lt;n&gt;
1552 </dt>
1553 <dd>
1554 <p>
1555         If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
1556         GIT_CONFIG_KEY_&lt;n&gt; and GIT_CONFIG_VALUE_&lt;n&gt; up to that number will be
1557         added to the process&#8217;s runtime configuration. The config pairs are
1558         zero-indexed. Any missing key or value is treated as an error. An empty
1559         GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
1560         pairs are processed. These environment variables will override values
1561         in configuration files, but will be overridden by any explicit options
1562         passed via <code>git -c</code>.
1563 </p>
1564 <div class="paragraph"><p>This is useful for cases where you want to spawn multiple git commands
1565 with a common configuration but cannot depend on a configuration file,
1566 for example when writing scripts.</p></div>
1567 </dd>
1568 <dt class="hdlist1">
1569 GIT_CONFIG
1570 </dt>
1571 <dd>
1572 <p>
1573         If no <code>--file</code> option is provided to <code>git config</code>, use the file
1574         given by <code>GIT_CONFIG</code> as if it were provided via <code>--file</code>. This
1575         variable has no effect on other Git commands, and is mostly for
1576         historical compatibility; there is generally no reason to use it
1577         instead of the <code>--file</code> option.
1578 </p>
1579 </dd>
1580 </dl></div>
1581 </div>
1582 </div>
1583 <div class="sect1">
1584 <h2 id="EXAMPLES">EXAMPLES</h2>
1585 <div class="sectionbody">
1586 <div class="paragraph"><p>Given a .git/config like this:</p></div>
1587 <div class="listingblock">
1588 <div class="content">
1589 <pre><code>#
1590 # This is the config file, and
1591 # a '#' or ';' character indicates
1592 # a comment
1593 #
1594
1595 ; core variables
1596 [core]
1597         ; Don't trust file modes
1598         filemode = false
1599
1600 ; Our diff algorithm
1601 [diff]
1602         external = /usr/local/bin/diff-wrapper
1603         renames = true
1604
1605 ; Proxy settings
1606 [core]
1607         gitproxy=proxy-command for kernel.org
1608         gitproxy=default-proxy ; for all the rest
1609
1610 ; HTTP
1611 [http]
1612         sslVerify
1613 [http "https://weak.example.com"]
1614         sslVerify = false
1615         cookieFile = /tmp/cookie.txt</code></pre>
1616 </div></div>
1617 <div class="paragraph"><p>you can set the filemode to true with</p></div>
1618 <div class="listingblock">
1619 <div class="content">
1620 <pre><code>% git config set core.filemode true</code></pre>
1621 </div></div>
1622 <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
1623 what URL they apply to. Here is how to change the entry for kernel.org
1624 to "ssh".</p></div>
1625 <div class="listingblock">
1626 <div class="content">
1627 <pre><code>% git config set --value='for kernel.org$' core.gitproxy '"ssh" for kernel.org'</code></pre>
1628 </div></div>
1629 <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
1630 <div class="paragraph"><p>To delete the entry for renames, do</p></div>
1631 <div class="listingblock">
1632 <div class="content">
1633 <pre><code>% git config unset diff.renames</code></pre>
1634 </div></div>
1635 <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
1636 you have to provide a regex matching the value of exactly one line.</p></div>
1637 <div class="paragraph"><p>To query the value for a given key, do</p></div>
1638 <div class="listingblock">
1639 <div class="content">
1640 <pre><code>% git config get core.filemode</code></pre>
1641 </div></div>
1642 <div class="paragraph"><p>or, to query a multivar:</p></div>
1643 <div class="listingblock">
1644 <div class="content">
1645 <pre><code>% git config get --value="for kernel.org$" core.gitproxy</code></pre>
1646 </div></div>
1647 <div class="paragraph"><p>If you want to know all the values for a multivar, do:</p></div>
1648 <div class="listingblock">
1649 <div class="content">
1650 <pre><code>% git config get --all --show-names core.gitproxy</code></pre>
1651 </div></div>
1652 <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
1653 new one with</p></div>
1654 <div class="listingblock">
1655 <div class="content">
1656 <pre><code>% git config set --all core.gitproxy ssh</code></pre>
1657 </div></div>
1658 <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy,
1659 i.e. the one without a "for &#8230;" postfix, do something like this:</p></div>
1660 <div class="listingblock">
1661 <div class="content">
1662 <pre><code>% git config set --value='! for ' core.gitproxy ssh</code></pre>
1663 </div></div>
1664 <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div>
1665 <div class="listingblock">
1666 <div class="content">
1667 <pre><code>% git config set --value='[!]' section.key value</code></pre>
1668 </div></div>
1669 <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
1670 <div class="listingblock">
1671 <div class="content">
1672 <pre><code>% git config set --append core.gitproxy '"proxy-command" for example.com'</code></pre>
1673 </div></div>
1674 <div class="paragraph"><p>An example to use customized color from the configuration in your
1675 script:</p></div>
1676 <div class="listingblock">
1677 <div class="content">
1678 <pre><code>#!/bin/sh
1679 WS=$(git config get --type=color --default="blue reverse" color.diff.whitespace)
1680 RESET=$(git config get --type=color --default="reset" "")
1681 echo "${WS}your whitespace color or blue reverse${RESET}"</code></pre>
1682 </div></div>
1683 <div class="paragraph"><p>For URLs in <code>https://weak.example.com</code>, <code>http.sslVerify</code> is set to
1684 false, while it is set to <code>true</code> for all others:</p></div>
1685 <div class="listingblock">
1686 <div class="content">
1687 <pre><code>% git config get --type=bool --url=https://good.example.com http.sslverify
1688 true
1689 % git config get --type=bool --url=https://weak.example.com http.sslverify
1690 false
1691 % git config get --url=https://weak.example.com http
1692 http.cookieFile /tmp/cookie.txt
1693 http.sslverify false</code></pre>
1694 </div></div>
1695 </div>
1696 </div>
1697 <div class="sect1">
1698 <h2 id="_configuration_file">CONFIGURATION FILE</h2>
1699 <div class="sectionbody">
1700 <div class="paragraph"><p>The Git configuration file contains a number of variables that affect
1701 the Git commands' behavior. The files <code>.git/config</code> and optionally
1702 <code>config.worktree</code> (see the "CONFIGURATION FILE" section of
1703 <a href="git-worktree.html">git-worktree(1)</a>) in each repository are used to store the
1704 configuration for that repository, and <code>$HOME/.gitconfig</code> is used to
1705 store a per-user configuration as fallback values for the <code>.git/config</code>
1706 file. The file <code>/etc/gitconfig</code> can be used to store a system-wide
1707 default configuration.</p></div>
1708 <div class="paragraph"><p>The configuration variables are used by both the Git plumbing
1709 and the porcelain commands. The variables are divided into sections, wherein
1710 the fully qualified variable name of the variable itself is the last
1711 dot-separated segment and the section name is everything before the last
1712 dot. The variable names are case-insensitive, allow only alphanumeric
1713 characters and <code>-</code>, and must start with an alphabetic character.  Some
1714 variables may appear multiple times; we say then that the variable is
1715 multivalued.</p></div>
1716 <div class="sect2">
1717 <h3 id="_syntax">Syntax</h3>
1718 <div class="paragraph"><p>The syntax is fairly flexible and permissive.  Whitespace characters,
1719 which in this context are the space character (SP) and the horizontal
1720 tabulation (HT), are mostly ignored.  The <em>#</em> and <em>;</em> characters begin
1721 comments to the end of line.  Blank lines are ignored.</p></div>
1722 <div class="paragraph"><p>The file consists of sections and variables.  A section begins with
1723 the name of the section in square brackets and continues until the next
1724 section begins.  Section names are case-insensitive.  Only alphanumeric
1725 characters, <code>-</code> and <code>.</code> are allowed in section names.  Each variable
1726 must belong to some section, which means that there must be a section
1727 header before the first setting of a variable.</p></div>
1728 <div class="paragraph"><p>Sections can be further divided into subsections.  To begin a subsection
1729 put its name in double quotes, separated by space from the section name,
1730 in the section header, like in the example below:</p></div>
1731 <div class="listingblock">
1732 <div class="content">
1733 <pre><code>        [section "subsection"]</code></pre>
1734 </div></div>
1735 <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
1736 newline and the null byte. Doublequote <code>"</code> and backslash can be included
1737 by escaping them as <code>\"</code> and <code>\\</code>, respectively. Backslashes preceding
1738 other characters are dropped when reading; for example, <code>\t</code> is read as
1739 <code>t</code> and <code>\0</code> is read as <code>0</code>. Section headers cannot span multiple lines.
1740 Variables may belong directly to a section or to a given subsection. You
1741 can have <code>[section]</code> if you have <code>[section "subsection"]</code>, but you don&#8217;t
1742 need to.</p></div>
1743 <div class="paragraph"><p>There is also a deprecated <code>[section.subsection]</code> syntax. With this
1744 syntax, the subsection name is converted to lower-case and is also
1745 compared case sensitively. These subsection names follow the same
1746 restrictions as section names.</p></div>
1747 <div class="paragraph"><p>All the other lines (and the remainder of the line after the section
1748 header) are recognized as setting variables, in the form
1749 <em>name = value</em> (or just <em>name</em>, which is a short-hand to say that
1750 the variable is the boolean "true").
1751 The variable names are case-insensitive, allow only alphanumeric characters
1752 and <code>-</code>, and must start with an alphabetic character.</p></div>
1753 <div class="paragraph"><p>Whitespace characters surrounding <code>name</code>, <code>=</code> and <code>value</code> are discarded.
1754 Internal whitespace characters within <em>value</em> are retained verbatim.
1755 Comments starting with either <code>#</code> or <code>;</code> and extending to the end of line
1756 are discarded.  A line that defines a value can be continued to the next
1757 line by ending it with a backslash (<code>\</code>);  the backslash and the end-of-line
1758 characters are discarded.</p></div>
1759 <div class="paragraph"><p>If <code>value</code> needs to contain leading or trailing whitespace characters,
1760 it must be enclosed in double quotation marks (<code>"</code>).  Inside double quotation
1761 marks, double quote (<code>"</code>) and backslash (<code>\</code>) characters must be escaped:
1762 use <code>\"</code> for <code>"</code> and <code>\\</code> for <code>\</code>.</p></div>
1763 <div class="paragraph"><p>The following escape sequences (beside <code>\"</code> and <code>\\</code>) are recognized:
1764 <code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB)
1765 and <code>\b</code> for backspace (BS).  Other char escape sequences (including octal
1766 escape sequences) are invalid.</p></div>
1767 </div>
1768 <div class="sect2">
1769 <h3 id="_includes">Includes</h3>
1770 <div class="paragraph"><p>The <code>include</code> and <code>includeIf</code> sections allow you to include config
1771 directives from another source. These sections behave identically to
1772 each other with the exception that <code>includeIf</code> sections may be ignored
1773 if their condition does not evaluate to true; see "Conditional includes"
1774 below.</p></div>
1775 <div class="paragraph"><p>You can include a config file from another by setting the special
1776 <code>include.path</code> (or <code>includeIf.*.path</code>) variable to the name of the file
1777 to be included. The variable takes a pathname as its value, and is
1778 subject to tilde expansion. These variables can be given multiple times.</p></div>
1779 <div class="paragraph"><p>The contents of the included file are inserted immediately, as if they
1780 had been found at the location of the include directive. If the value of the
1781 variable is a relative path, the path is considered to
1782 be relative to the configuration file in which the include directive
1783 was found.  See below for examples.</p></div>
1784 </div>
1785 <div class="sect2">
1786 <h3 id="_conditional_includes">Conditional includes</h3>
1787 <div class="paragraph"><p>You can conditionally include a config file from another by setting an
1788 <code>includeIf.&lt;condition&gt;.path</code> variable to the name of the file to be
1789 included.</p></div>
1790 <div class="paragraph"><p>The condition starts with a keyword followed by a colon and some data
1791 whose format and meaning depends on the keyword. Supported keywords
1792 are:</p></div>
1793 <div class="dlist"><dl>
1794 <dt class="hdlist1">
1795 <code>gitdir</code>
1796 </dt>
1797 <dd>
1798 <p>
1799         The data that follows the keyword <code>gitdir:</code> is used as a glob
1800         pattern. If the location of the .git directory matches the
1801         pattern, the include condition is met.
1802 </p>
1803 <div class="paragraph"><p>The .git location may be auto-discovered, or come from <code>$GIT_DIR</code>
1804 environment variable. If the repository is auto-discovered via a .git
1805 file (e.g. from submodules, or a linked worktree), the .git location
1806 would be the final location where the .git directory is, not where the
1807 .git file is.</p></div>
1808 <div class="paragraph"><p>The pattern can contain standard globbing wildcards and two additional
1809 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components. Please
1810 refer to <a href="gitignore.html">gitignore(5)</a> for details. For convenience:</p></div>
1811 <div class="ulist"><ul>
1812 <li>
1813 <p>
1814 If the pattern starts with <code>~/</code>, <code>~</code> will be substituted with the
1815    content of the environment variable <code>HOME</code>.
1816 </p>
1817 </li>
1818 <li>
1819 <p>
1820 If the pattern starts with <code>./</code>, it is replaced with the directory
1821    containing the current config file.
1822 </p>
1823 </li>
1824 <li>
1825 <p>
1826 If the pattern does not start with either <code>~/</code>, <code>./</code> or <code>/</code>, <code>**/</code>
1827    will be automatically prepended. For example, the pattern <code>foo/bar</code>
1828    becomes <code>**/foo/bar</code> and would match <code>/any/path/to/foo/bar</code>.
1829 </p>
1830 </li>
1831 <li>
1832 <p>
1833 If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1834    example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it
1835    matches "foo" and everything inside, recursively.
1836 </p>
1837 </li>
1838 </ul></div>
1839 </dd>
1840 <dt class="hdlist1">
1841 <code>gitdir/i</code>
1842 </dt>
1843 <dd>
1844 <p>
1845         This is the same as <code>gitdir</code> except that matching is done
1846         case-insensitively (e.g. on case-insensitive file systems)
1847 </p>
1848 </dd>
1849 <dt class="hdlist1">
1850 <code>onbranch</code>
1851 </dt>
1852 <dd>
1853 <p>
1854         The data that follows the keyword <code>onbranch:</code> is taken to be a
1855         pattern with standard globbing wildcards and two additional
1856         ones, <code>**/</code> and <code>/**</code>, that can match multiple path components.
1857         If we are in a worktree where the name of the branch that is
1858         currently checked out matches the pattern, the include condition
1859         is met.
1860 </p>
1861 <div class="paragraph"><p>If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1862 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it matches
1863 all branches that begin with <code>foo/</code>. This is useful if your branches are
1864 organized hierarchically and you would like to apply a configuration to
1865 all the branches in that hierarchy.</p></div>
1866 </dd>
1867 <dt class="hdlist1">
1868 <code>hasconfig:remote.*.url:</code>
1869 </dt>
1870 <dd>
1871 <p>
1872         The data that follows this keyword is taken to
1873         be a pattern with standard globbing wildcards and two
1874         additional ones, <code>**/</code> and <code>/**</code>, that can match multiple
1875         components. The first time this keyword is seen, the rest of
1876         the config files will be scanned for remote URLs (without
1877         applying any values). If there exists at least one remote URL
1878         that matches this pattern, the include condition is met.
1879 </p>
1880 <div class="paragraph"><p>Files included by this option (directly or indirectly) are not allowed
1881 to contain remote URLs.</p></div>
1882 <div class="paragraph"><p>Note that unlike other includeIf conditions, resolving this condition
1883 relies on information that is not yet known at the point of reading the
1884 condition. A typical use case is this option being present as a
1885 system-level or global-level config, and the remote URL being in a
1886 local-level config; hence the need to scan ahead when resolving this
1887 condition. In order to avoid the chicken-and-egg problem in which
1888 potentially-included files can affect whether such files are potentially
1889 included, Git breaks the cycle by prohibiting these files from affecting
1890 the resolution of these conditions (thus, prohibiting them from
1891 declaring remote URLs).</p></div>
1892 <div class="paragraph"><p>As for the naming of this keyword, it is for forwards compatibility with
1893 a naming scheme that supports more variable-based include conditions,
1894 but currently Git only supports the exact keyword described above.</p></div>
1895 </dd>
1896 </dl></div>
1897 <div class="paragraph"><p>A few more notes on matching via <code>gitdir</code> and <code>gitdir/i</code>:</p></div>
1898 <div class="ulist"><ul>
1899 <li>
1900 <p>
1901 Symlinks in <code>$GIT_DIR</code> are not resolved before matching.
1902 </p>
1903 </li>
1904 <li>
1905 <p>
1906 Both the symlink &amp; realpath versions of paths will be matched
1907    outside of <code>$GIT_DIR</code>. E.g. if ~/git is a symlink to
1908    /mnt/storage/git, both <code>gitdir:~/git</code> and <code>gitdir:/mnt/storage/git</code>
1909    will match.
1910 </p>
1911 <div class="paragraph"><p>This was not the case in the initial release of this feature in
1912 v2.13.0, which only matched the realpath version. Configuration that
1913 wants to be compatible with the initial release of this feature needs
1914 to either specify only the realpath version, or both versions.</p></div>
1915 </li>
1916 <li>
1917 <p>
1918 Note that "../" is not special and will match literally, which is
1919    unlikely what you want.
1920 </p>
1921 </li>
1922 </ul></div>
1923 </div>
1924 <div class="sect2">
1925 <h3 id="_example">Example</h3>
1926 <div class="listingblock">
1927 <div class="content">
1928 <pre><code># Core variables
1929 [core]
1930         ; Don't trust file modes
1931         filemode = false
1932
1933 # Our diff algorithm
1934 [diff]
1935         external = /usr/local/bin/diff-wrapper
1936         renames = true
1937
1938 [branch "devel"]
1939         remote = origin
1940         merge = refs/heads/devel
1941
1942 # Proxy settings
1943 [core]
1944         gitProxy="ssh" for "kernel.org"
1945         gitProxy=default-proxy ; for the rest
1946
1947 [include]
1948         path = /path/to/foo.inc ; include by absolute path
1949         path = foo.inc ; find "foo.inc" relative to the current file
1950         path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
1951
1952 ; include if $GIT_DIR is /path/to/foo/.git
1953 [includeIf "gitdir:/path/to/foo/.git"]
1954         path = /path/to/foo.inc
1955
1956 ; include for all repositories inside /path/to/group
1957 [includeIf "gitdir:/path/to/group/"]
1958         path = /path/to/foo.inc
1959
1960 ; include for all repositories inside $HOME/to/group
1961 [includeIf "gitdir:~/to/group/"]
1962         path = /path/to/foo.inc
1963
1964 ; relative paths are always relative to the including
1965 ; file (if the condition is true); their location is not
1966 ; affected by the condition
1967 [includeIf "gitdir:/path/to/group/"]
1968         path = foo.inc
1969
1970 ; include only if we are in a worktree where foo-branch is
1971 ; currently checked out
1972 [includeIf "onbranch:foo-branch"]
1973         path = foo.inc
1974
1975 ; include only if a remote with the given URL exists (note
1976 ; that such a URL may be provided later in a file or in a
1977 ; file read after this file is read, as seen in this example)
1978 [includeIf "hasconfig:remote.*.url:https://example.com/**"]
1979         path = foo.inc
1980 [remote "origin"]
1981         url = https://example.com/git</code></pre>
1982 </div></div>
1983 </div>
1984 <div class="sect2">
1985 <h3 id="_values">Values</h3>
1986 <div class="paragraph"><p>Values of many variables are treated as a simple string, but there
1987 are variables that take values of specific types and there are rules
1988 as to how to spell them.</p></div>
1989 <div class="dlist"><dl>
1990 <dt class="hdlist1">
1991 boolean
1992 </dt>
1993 <dd>
1994 <p>
1995        When a variable is said to take a boolean value, many
1996        synonyms are accepted for <em>true</em> and <em>false</em>; these are all
1997        case-insensitive.
1998 </p>
1999 <div class="dlist"><dl>
2000 <dt class="hdlist1">
2001 true
2002 </dt>
2003 <dd>
2004 <p>
2005 Boolean true literals are <code>yes</code>, <code>on</code>, <code>true</code>,
2006                 and <code>1</code>.  Also, a variable defined without <code>= &lt;value&gt;</code>
2007                 is taken as true.
2008 </p>
2009 </dd>
2010 <dt class="hdlist1">
2011 false
2012 </dt>
2013 <dd>
2014 <p>
2015 Boolean false literals are <code>no</code>, <code>off</code>, <code>false</code>,
2016                 <code>0</code> and the empty string.
2017 </p>
2018 <div class="paragraph"><p>When converting a value to its canonical form using the <code>--type=bool</code> type
2019 specifier, <em>git config</em> will ensure that the output is "true" or
2020 "false" (spelled in lowercase).</p></div>
2021 </dd>
2022 </dl></div>
2023 </dd>
2024 <dt class="hdlist1">
2025 integer
2026 </dt>
2027 <dd>
2028 <p>
2029        The value for many variables that specify various sizes can
2030        be suffixed with <code>k</code>, <code>M</code>,&#8230; to mean "scale the number by
2031        1024", "by 1024x1024", etc.
2032 </p>
2033 </dd>
2034 <dt class="hdlist1">
2035 color
2036 </dt>
2037 <dd>
2038 <p>
2039        The value for a variable that takes a color is a list of
2040        colors (at most two, one for foreground and one for background)
2041        and attributes (as many as you want), separated by spaces.
2042 </p>
2043 <div class="paragraph"><p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>,
2044 <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code> and <code>default</code>.  The first
2045 color given is the foreground; the second is the background.  All the
2046 basic colors except <code>normal</code> and <code>default</code> have a bright variant that can
2047 be specified by prefixing the color with <code>bright</code>, like <code>brightred</code>.</p></div>
2048 <div class="paragraph"><p>The color <code>normal</code> makes no change to the color. It is the same as an
2049 empty string, but can be used as the foreground color when specifying a
2050 background color alone (for example, "normal red").</p></div>
2051 <div class="paragraph"><p>The color <code>default</code> explicitly resets the color to the terminal default,
2052 for example to specify a cleared background. Although it varies between
2053 terminals, this is usually not the same as setting to "white black".</p></div>
2054 <div class="paragraph"><p>Colors may also be given as numbers between 0 and 255; these use ANSI
2055 256-color mode (but note that not all terminals may support this).  If
2056 your terminal supports it, you may also specify 24-bit RGB values as
2057 hex, like <code>#ff0ab3</code>, or 12-bit RGB values like <code>#f1b</code>, which is
2058 equivalent to the 24-bit color <code>#ff11bb</code>.</p></div>
2059 <div class="paragraph"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
2060 <code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters).
2061 The position of any attributes with respect to the colors
2062 (before, after, or in between), doesn&#8217;t matter. Specific attributes may
2063 be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>,
2064 <code>no-ul</code>, etc).</p></div>
2065 <div class="paragraph"><p>The pseudo-attribute <code>reset</code> resets all colors and attributes before
2066 applying the specified coloring. For example, <code>reset green</code> will result
2067 in a green foreground and default background without any active
2068 attributes.</p></div>
2069 <div class="paragraph"><p>An empty color string produces no color effect at all. This can be used
2070 to avoid coloring specific elements without disabling color entirely.</p></div>
2071 <div class="paragraph"><p>For git&#8217;s pre-defined color slots, the attributes are meant to be reset
2072 at the beginning of each item in the colored output. So setting
2073 <code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a
2074 plain <code>black</code>, even if the previous thing on the same output line (e.g.
2075 opening parenthesis before the list of branch names in <code>log --decorate</code>
2076 output) is set to be painted with <code>bold</code> or some other attribute.
2077 However, custom log formats may do more complicated and layered
2078 coloring, and the negated forms may be useful there.</p></div>
2079 </dd>
2080 <dt class="hdlist1">
2081 pathname
2082 </dt>
2083 <dd>
2084 <p>
2085         A variable that takes a pathname value can be given a
2086         string that begins with "<code>~/</code>" or "<code>~user/</code>", and the usual
2087         tilde expansion happens to such a string: <code>~/</code>
2088         is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the
2089         specified user&#8217;s home directory.
2090 </p>
2091 <div class="paragraph"><p>If a path starts with <code>%(prefix)/</code>, the remainder is interpreted as a
2092 path relative to Git&#8217;s "runtime prefix", i.e. relative to the location
2093 where Git itself was installed. For example, <code>%(prefix)/bin/</code> refers to
2094 the directory in which the Git executable itself lives. If Git was
2095 compiled without runtime prefix support, the compiled-in prefix will be
2096 substituted instead. In the unlikely event that a literal path needs to
2097 be specified that should <em>not</em> be expanded, it needs to be prefixed by
2098 <code>./</code>, like so: <code>./%(prefix)/bin</code>.</p></div>
2099 </dd>
2100 </dl></div>
2101 </div>
2102 <div class="sect2">
2103 <h3 id="_variables">Variables</h3>
2104 <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
2105 For command-specific variables, you will find a more detailed description
2106 in the appropriate manual page.</p></div>
2107 <div class="paragraph"><p>Other git-related tools may and do use their own variables.  When
2108 inventing new variables for use in your own tool, make sure their
2109 names do not conflict with those that are used by Git itself and
2110 other popular tools, and describe them in your documentation.</p></div>
2111 <div class="dlist"><dl>
2112 <dt class="hdlist1">
2113 add.ignoreErrors
2114 </dt>
2115 <dt class="hdlist1">
2116 add.ignore-errors (deprecated)
2117 </dt>
2118 <dd>
2119 <p>
2120         Tells <em>git add</em> to continue adding files when some files cannot be
2121         added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
2122         option of <a href="git-add.html">git-add(1)</a>.  <code>add.ignore-errors</code> is deprecated,
2123         as it does not follow the usual naming convention for configuration
2124         variables.
2125 </p>
2126 </dd>
2127 <dt class="hdlist1">
2128 add.interactive.useBuiltin
2129 </dt>
2130 <dd>
2131 <p>
2132         Unused configuration variable. Used in Git versions v2.25.0 to
2133         v2.36.0 to enable the built-in version of <a href="git-add.html">git-add(1)</a>'s
2134         interactive mode, which then became the default in Git
2135         versions v2.37.0 to v2.39.0.
2136 </p>
2137 </dd>
2138 <dt class="hdlist1">
2139 advice.*
2140 </dt>
2141 <dd>
2142 <p>
2143         These variables control various optional help messages designed to
2144         aid new users.  When left unconfigured, Git will give the message
2145         alongside instructions on how to squelch it.  You can tell Git
2146         that you do not need the help message by setting these to <code>false</code>:
2147 </p>
2148 <div class="openblock">
2149 <div class="content">
2150 <div class="dlist"><dl>
2151 <dt class="hdlist1">
2152 addEmbeddedRepo
2153 </dt>
2154 <dd>
2155 <p>
2156                 Shown when the user accidentally adds one
2157                 git repo inside of another.
2158 </p>
2159 </dd>
2160 <dt class="hdlist1">
2161 addEmptyPathspec
2162 </dt>
2163 <dd>
2164 <p>
2165                 Shown when the user runs <code>git add</code> without providing
2166                 the pathspec parameter.
2167 </p>
2168 </dd>
2169 <dt class="hdlist1">
2170 addIgnoredFile
2171 </dt>
2172 <dd>
2173 <p>
2174                 Shown when the user attempts to add an ignored file to
2175                 the index.
2176 </p>
2177 </dd>
2178 <dt class="hdlist1">
2179 amWorkDir
2180 </dt>
2181 <dd>
2182 <p>
2183                 Shown when <a href="git-am.html">git-am(1)</a> fails to apply a patch
2184                 file, to tell the user the location of the file.
2185 </p>
2186 </dd>
2187 <dt class="hdlist1">
2188 ambiguousFetchRefspec
2189 </dt>
2190 <dd>
2191 <p>
2192                 Shown when a fetch refspec for multiple remotes maps to
2193                 the same remote-tracking branch namespace and causes branch
2194                 tracking set-up to fail.
2195 </p>
2196 </dd>
2197 <dt class="hdlist1">
2198 checkoutAmbiguousRemoteBranchName
2199 </dt>
2200 <dd>
2201 <p>
2202                 Shown when the argument to
2203                 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
2204                 ambiguously resolves to a
2205                 remote tracking branch on more than one remote in
2206                 situations where an unambiguous argument would have
2207                 otherwise caused a remote-tracking branch to be
2208                 checked out. See the <code>checkout.defaultRemote</code>
2209                 configuration variable for how to set a given remote
2210                 to be used by default in some situations where this
2211                 advice would be printed.
2212 </p>
2213 </dd>
2214 <dt class="hdlist1">
2215 commitBeforeMerge
2216 </dt>
2217 <dd>
2218 <p>
2219                 Shown when <a href="git-merge.html">git-merge(1)</a> refuses to
2220                 merge to avoid overwriting local changes.
2221 </p>
2222 </dd>
2223 <dt class="hdlist1">
2224 detachedHead
2225 </dt>
2226 <dd>
2227 <p>
2228                 Shown when the user uses
2229                 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
2230                 to move to the detached HEAD state, to tell the user how
2231                 to create a local branch after the fact.
2232 </p>
2233 </dd>
2234 <dt class="hdlist1">
2235 diverging
2236 </dt>
2237 <dd>
2238 <p>
2239                 Shown when a fast-forward is not possible.
2240 </p>
2241 </dd>
2242 <dt class="hdlist1">
2243 fetchShowForcedUpdates
2244 </dt>
2245 <dd>
2246 <p>
2247                 Shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
2248                 to calculate forced updates after ref updates, or to warn
2249                 that the check is disabled.
2250 </p>
2251 </dd>
2252 <dt class="hdlist1">
2253 forceDeleteBranch
2254 </dt>
2255 <dd>
2256 <p>
2257                 Shown when the user tries to delete a not fully merged
2258                 branch without the force option set.
2259 </p>
2260 </dd>
2261 <dt class="hdlist1">
2262 ignoredHook
2263 </dt>
2264 <dd>
2265 <p>
2266                 Shown when a hook is ignored because the hook is not
2267                 set as executable.
2268 </p>
2269 </dd>
2270 <dt class="hdlist1">
2271 implicitIdentity
2272 </dt>
2273 <dd>
2274 <p>
2275                 Shown when the user&#8217;s information is guessed from the
2276                 system username and domain name, to tell the user how to
2277                 set their identity configuration.
2278 </p>
2279 </dd>
2280 <dt class="hdlist1">
2281 mergeConflict
2282 </dt>
2283 <dd>
2284 <p>
2285                 Shown when various commands stop because of conflicts.
2286 </p>
2287 </dd>
2288 <dt class="hdlist1">
2289 nestedTag
2290 </dt>
2291 <dd>
2292 <p>
2293                 Shown when a user attempts to recursively tag a tag object.
2294 </p>
2295 </dd>
2296 <dt class="hdlist1">
2297 pushAlreadyExists
2298 </dt>
2299 <dd>
2300 <p>
2301                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2302                 does not qualify for fast-forwarding (e.g., a tag.)
2303 </p>
2304 </dd>
2305 <dt class="hdlist1">
2306 pushFetchFirst
2307 </dt>
2308 <dd>
2309 <p>
2310                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2311                 tries to overwrite a remote ref that points at an
2312                 object we do not have.
2313 </p>
2314 </dd>
2315 <dt class="hdlist1">
2316 pushNeedsForce
2317 </dt>
2318 <dd>
2319 <p>
2320                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2321                 tries to overwrite a remote ref that points at an
2322                 object that is not a commit-ish, or make the remote
2323                 ref point at an object that is not a commit-ish.
2324 </p>
2325 </dd>
2326 <dt class="hdlist1">
2327 pushNonFFCurrent
2328 </dt>
2329 <dd>
2330 <p>
2331                 Shown when <a href="git-push.html">git-push(1)</a> fails due to a
2332                 non-fast-forward update to the current branch.
2333 </p>
2334 </dd>
2335 <dt class="hdlist1">
2336 pushNonFFMatching
2337 </dt>
2338 <dd>
2339 <p>
2340                 Shown when the user ran <a href="git-push.html">git-push(1)</a> and pushed
2341                 "matching refs" explicitly (i.e. used <code>:</code>, or
2342                 specified a refspec that isn&#8217;t the current branch) and
2343                 it resulted in a non-fast-forward error.
2344 </p>
2345 </dd>
2346 <dt class="hdlist1">
2347 pushRefNeedsUpdate
2348 </dt>
2349 <dd>
2350 <p>
2351                 Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
2352                 a branch when its remote-tracking ref has updates that we
2353                 do not have locally.
2354 </p>
2355 </dd>
2356 <dt class="hdlist1">
2357 pushUnqualifiedRefname
2358 </dt>
2359 <dd>
2360 <p>
2361                 Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
2362                 guess based on the source and destination refs what
2363                 remote ref namespace the source belongs in, but where
2364                 we can still suggest that the user push to either
2365                 <code>refs/heads/*</code> or <code>refs/tags/*</code> based on the type of the
2366                 source object.
2367 </p>
2368 </dd>
2369 <dt class="hdlist1">
2370 pushUpdateRejected
2371 </dt>
2372 <dd>
2373 <p>
2374                 Set this variable to <code>false</code> if you want to disable
2375                 <code>pushNonFFCurrent</code>, <code>pushNonFFMatching</code>, <code>pushAlreadyExists</code>,
2376                 <code>pushFetchFirst</code>, <code>pushNeedsForce</code>, and <code>pushRefNeedsUpdate</code>
2377                 simultaneously.
2378 </p>
2379 </dd>
2380 <dt class="hdlist1">
2381 refSyntax
2382 </dt>
2383 <dd>
2384 <p>
2385                 Shown when the user provides an illegal ref name, to
2386                 tell the user about the ref syntax documentation.
2387 </p>
2388 </dd>
2389 <dt class="hdlist1">
2390 resetNoRefresh
2391 </dt>
2392 <dd>
2393 <p>
2394                 Shown when <a href="git-reset.html">git-reset(1)</a> takes more than 2
2395                 seconds to refresh the index after reset, to tell the user
2396                 that they can use the <code>--no-refresh</code> option.
2397 </p>
2398 </dd>
2399 <dt class="hdlist1">
2400 resolveConflict
2401 </dt>
2402 <dd>
2403 <p>
2404                 Shown by various commands when conflicts
2405                 prevent the operation from being performed.
2406 </p>
2407 </dd>
2408 <dt class="hdlist1">
2409 rmHints
2410 </dt>
2411 <dd>
2412 <p>
2413                 Shown on failure in the output of <a href="git-rm.html">git-rm(1)</a>, to
2414                 give directions on how to proceed from the current state.
2415 </p>
2416 </dd>
2417 <dt class="hdlist1">
2418 sequencerInUse
2419 </dt>
2420 <dd>
2421 <p>
2422                 Shown when a sequencer command is already in progress.
2423 </p>
2424 </dd>
2425 <dt class="hdlist1">
2426 skippedCherryPicks
2427 </dt>
2428 <dd>
2429 <p>
2430                 Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
2431                 been cherry-picked onto the upstream branch.
2432 </p>
2433 </dd>
2434 <dt class="hdlist1">
2435 statusAheadBehind
2436 </dt>
2437 <dd>
2438 <p>
2439                 Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
2440                 counts for a local ref compared to its remote tracking ref,
2441                 and that calculation takes longer than expected. Will not
2442                 appear if <code>status.aheadBehind</code> is false or the option
2443                 <code>--no-ahead-behind</code> is given.
2444 </p>
2445 </dd>
2446 <dt class="hdlist1">
2447 statusHints
2448 </dt>
2449 <dd>
2450 <p>
2451                 Show directions on how to proceed from the current
2452                 state in the output of <a href="git-status.html">git-status(1)</a>, in
2453                 the template shown when writing commit messages in
2454                 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
2455                 by <a href="git-switch.html">git-switch(1)</a> or
2456                 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.
2457 </p>
2458 </dd>
2459 <dt class="hdlist1">
2460 statusUoption
2461 </dt>
2462 <dd>
2463 <p>
2464                 Shown when <a href="git-status.html">git-status(1)</a> takes more than 2
2465                 seconds to enumerate untracked files, to tell the user that
2466                 they can use the <code>-u</code> option.
2467 </p>
2468 </dd>
2469 <dt class="hdlist1">
2470 submoduleAlternateErrorStrategyDie
2471 </dt>
2472 <dd>
2473 <p>
2474                 Shown when a submodule.alternateErrorStrategy option
2475                 configured to "die" causes a fatal error.
2476 </p>
2477 </dd>
2478 <dt class="hdlist1">
2479 submoduleMergeConflict
2480 </dt>
2481 <dd>
2482 <p>
2483                 Advice shown when a non-trivial submodule merge conflict is
2484                 encountered.
2485 </p>
2486 </dd>
2487 <dt class="hdlist1">
2488 submodulesNotUpdated
2489 </dt>
2490 <dd>
2491 <p>
2492                 Shown when a user runs a submodule command that fails
2493                 because <code>git submodule update --init</code> was not run.
2494 </p>
2495 </dd>
2496 <dt class="hdlist1">
2497 suggestDetachingHead
2498 </dt>
2499 <dd>
2500 <p>
2501                 Shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
2502                 without the explicit <code>--detach</code> option.
2503 </p>
2504 </dd>
2505 <dt class="hdlist1">
2506 updateSparsePath
2507 </dt>
2508 <dd>
2509 <p>
2510                 Shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
2511                 is asked to update index entries outside the current sparse
2512                 checkout.
2513 </p>
2514 </dd>
2515 <dt class="hdlist1">
2516 waitingForEditor
2517 </dt>
2518 <dd>
2519 <p>
2520                 Shown when Git is waiting for editor input. Relevant
2521                 when e.g. the editor is not launched inside the terminal.
2522 </p>
2523 </dd>
2524 <dt class="hdlist1">
2525 worktreeAddOrphan
2526 </dt>
2527 <dd>
2528 <p>
2529                 Shown when the user tries to create a worktree from an
2530                 invalid reference, to tell the user how to create a new unborn
2531                 branch instead.
2532 </p>
2533 </dd>
2534 </dl></div>
2535 </div></div>
2536 </dd>
2537 <dt class="hdlist1">
2538 alias.*
2539 </dt>
2540 <dd>
2541 <p>
2542         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
2543         after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
2544         <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
2545         confusion and troubles with script usage, aliases that
2546         hide existing Git commands are ignored. Arguments are split by
2547         spaces, the usual shell quoting and escaping are supported.
2548         A quote pair or a backslash can be used to quote them.
2549 </p>
2550 <div class="paragraph"><p>Note that the first word of an alias does not necessarily have to be a
2551 command. It can be a command-line option that will be passed into the
2552 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
2553 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
2554 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
2555 running <code>git loud-rebase</code> would be equivalent to
2556 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
2557 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
2558 where the original command does not.</p></div>
2559 <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
2560 it will be treated as a shell command.  For example, defining
2561 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
2562 <code>git new</code> is equivalent to running the shell command
2563 <code>gitk --all --not ORIG_HEAD</code>.  Note that shell commands will be
2564 executed from the top-level directory of a repository, which may
2565 not necessarily be the current directory.
2566 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
2567 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
2568 </dd>
2569 <dt class="hdlist1">
2570 am.keepcr
2571 </dt>
2572 <dd>
2573 <p>
2574         If true, git-am will call git-mailsplit for patches in mbox format
2575         with parameter <code>--keep-cr</code>. In this case git-mailsplit will
2576         not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
2577         by giving <code>--no-keep-cr</code> from the command line.
2578         See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
2579 </p>
2580 </dd>
2581 <dt class="hdlist1">
2582 am.threeWay
2583 </dt>
2584 <dd>
2585 <p>
2586         By default, <code>git am</code> will fail if the patch does not apply cleanly. When
2587         set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
2588         the patch records the identity of blobs it is supposed to apply to and
2589         we have those blobs available locally (equivalent to giving the <code>--3way</code>
2590         option from the command line). Defaults to <code>false</code>.
2591         See <a href="git-am.html">git-am(1)</a>.
2592 </p>
2593 </dd>
2594 <dt class="hdlist1">
2595 apply.ignoreWhitespace
2596 </dt>
2597 <dd>
2598 <p>
2599         When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
2600         whitespace, in the same way as the <code>--ignore-space-change</code>
2601         option.
2602         When set to one of: no, none, never, false, it tells <em>git apply</em> to
2603         respect all whitespace differences.
2604         See <a href="git-apply.html">git-apply(1)</a>.
2605 </p>
2606 </dd>
2607 <dt class="hdlist1">
2608 apply.whitespace
2609 </dt>
2610 <dd>
2611 <p>
2612         Tells <em>git apply</em> how to handle whitespace, in the same way
2613         as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
2614 </p>
2615 </dd>
2616 <dt class="hdlist1">
2617 attr.tree
2618 </dt>
2619 <dd>
2620 <p>
2621         A reference to a tree in the repository from which to read attributes,
2622         instead of the <code>.gitattributes</code> file in the working tree. In a bare
2623         repository, this defaults to <code>HEAD:.gitattributes</code>. If the value does
2624         not resolve to a valid tree object, an empty tree is used instead.
2625         When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2626         command line option are used, this configuration variable has no effect.
2627 </p>
2628 </dd>
2629 <dt class="hdlist1">
2630 blame.blankBoundary
2631 </dt>
2632 <dd>
2633 <p>
2634         Show blank commit object name for boundary commits in
2635         <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.
2636 </p>
2637 </dd>
2638 <dt class="hdlist1">
2639 blame.coloring
2640 </dt>
2641 <dd>
2642 <p>
2643         This determines the coloring scheme to be applied to blame
2644         output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
2645         or <em>none</em> which is the default.
2646 </p>
2647 </dd>
2648 <dt class="hdlist1">
2649 blame.date
2650 </dt>
2651 <dd>
2652 <p>
2653         Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
2654         If unset the iso format is used. For supported values,
2655         see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.
2656 </p>
2657 </dd>
2658 <dt class="hdlist1">
2659 blame.showEmail
2660 </dt>
2661 <dd>
2662 <p>
2663         Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
2664         This option defaults to false.
2665 </p>
2666 </dd>
2667 <dt class="hdlist1">
2668 blame.showRoot
2669 </dt>
2670 <dd>
2671 <p>
2672         Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
2673         This option defaults to false.
2674 </p>
2675 </dd>
2676 <dt class="hdlist1">
2677 blame.ignoreRevsFile
2678 </dt>
2679 <dd>
2680 <p>
2681         Ignore revisions listed in the file, one unabbreviated object name per
2682         line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
2683         <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
2684         file names will reset the list of ignored revisions.  This option will
2685         be handled before the command line option <code>--ignore-revs-file</code>.
2686 </p>
2687 </dd>
2688 <dt class="hdlist1">
2689 blame.markUnblamableLines
2690 </dt>
2691 <dd>
2692 <p>
2693         Mark lines that were changed by an ignored revision that we could not
2694         attribute to another commit with a <em>*</em> in the output of
2695         <a href="git-blame.html">git-blame(1)</a>.
2696 </p>
2697 </dd>
2698 <dt class="hdlist1">
2699 blame.markIgnoredLines
2700 </dt>
2701 <dd>
2702 <p>
2703         Mark lines that were changed by an ignored revision that we attributed to
2704         another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.
2705 </p>
2706 </dd>
2707 <dt class="hdlist1">
2708 branch.autoSetupMerge
2709 </dt>
2710 <dd>
2711 <p>
2712         Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
2713         so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
2714         starting point branch. Note that even if this option is not set,
2715         this behavior can be chosen per-branch using the <code>--track</code>
2716         and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
2717         automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
2718         starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;        automatic setup is done when the starting point is either a
2719         local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
2720         has a tracking configuration, it is copied to the new
2721         branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
2722         is a remote-tracking branch and the new branch has the same name as the
2723         remote branch. This option defaults to true.
2724 </p>
2725 </dd>
2726 <dt class="hdlist1">
2727 branch.autoSetupRebase
2728 </dt>
2729 <dd>
2730 <p>
2731         When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
2732         that tracks another branch, this variable tells Git to set
2733         up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
2734         When <code>never</code>, rebase is never automatically set to true.
2735         When <code>local</code>, rebase is set to true for tracked branches of
2736         other local branches.
2737         When <code>remote</code>, rebase is set to true for tracked branches of
2738         remote-tracking branches.
2739         When <code>always</code>, rebase will be set to true for all tracking
2740         branches.
2741         See "branch.autoSetupMerge" for details on how to set up a
2742         branch to track another branch.
2743         This option defaults to never.
2744 </p>
2745 </dd>
2746 <dt class="hdlist1">
2747 branch.sort
2748 </dt>
2749 <dd>
2750 <p>
2751         This variable controls the sort ordering of branches when displayed by
2752         <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
2753         value of this variable will be used as the default.
2754         See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.
2755 </p>
2756 </dd>
2757 <dt class="hdlist1">
2758 branch.&lt;name&gt;.remote
2759 </dt>
2760 <dd>
2761 <p>
2762         When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
2763         which remote to fetch from or push to.  The remote to push to
2764         may be overridden with <code>remote.pushDefault</code> (for all branches).
2765         The remote to push to, for the current branch, may be further
2766         overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
2767         configured, or if you are not on any branch and there is more than
2768         one remote defined in the repository, it defaults to <code>origin</code> for
2769         fetching and <code>remote.pushDefault</code> for pushing.
2770         Additionally, <code>.</code> (a period) is the current local repository
2771         (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
2772 </p>
2773 </dd>
2774 <dt class="hdlist1">
2775 branch.&lt;name&gt;.pushRemote
2776 </dt>
2777 <dd>
2778 <p>
2779         When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
2780         pushing.  It also overrides <code>remote.pushDefault</code> for pushing
2781         from branch &lt;name&gt;.  When you pull from one place (e.g. your
2782         upstream) and push to another place (e.g. your own publishing
2783         repository), you would want to set <code>remote.pushDefault</code> to
2784         specify the remote to push to for all branches, and use this
2785         option to override it for a specific branch.
2786 </p>
2787 </dd>
2788 <dt class="hdlist1">
2789 branch.&lt;name&gt;.merge
2790 </dt>
2791 <dd>
2792 <p>
2793         Defines, together with branch.&lt;name&gt;.remote, the upstream branch
2794         for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
2795         branch to merge and can also affect <em>git push</em> (see push.default).
2796         When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
2797         refspec to be marked for merging in FETCH_HEAD. The value is
2798         handled like the remote part of a refspec, and must match a
2799         ref which is fetched from the remote given by
2800         "branch.&lt;name&gt;.remote".
2801         The merge information is used by <em>git pull</em> (which first calls
2802         <em>git fetch</em>) to lookup the default branch for merging. Without
2803         this option, <em>git pull</em> defaults to merge the first refspec fetched.
2804         Specify multiple values to get an octopus merge.
2805         If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
2806         another branch in the local repository, you can point
2807         branch.&lt;name&gt;.merge to the desired branch, and use the relative path
2808         setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
2809 </p>
2810 </dd>
2811 <dt class="hdlist1">
2812 branch.&lt;name&gt;.mergeOptions
2813 </dt>
2814 <dd>
2815 <p>
2816         Sets default options for merging into branch &lt;name&gt;. The syntax and
2817         supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
2818         option values containing whitespace characters are currently not
2819         supported.
2820 </p>
2821 </dd>
2822 <dt class="hdlist1">
2823 branch.&lt;name&gt;.rebase
2824 </dt>
2825 <dd>
2826 <p>
2827         When true, rebase the branch &lt;name&gt; on top of the fetched branch,
2828         instead of merging the default branch from the default remote when
2829         "git pull" is run. See "pull.rebase" for doing this in a non
2830         branch-specific manner.
2831 </p>
2832 <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>
2833 so that the local merge commits are included in the rebase (see
2834 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
2835 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
2836 mode.</p></div>
2837 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
2838 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
2839 for details).</p></div>
2840 </dd>
2841 <dt class="hdlist1">
2842 branch.&lt;name&gt;.description
2843 </dt>
2844 <dd>
2845 <p>
2846         Branch description, can be edited with
2847         <code>git branch --edit-description</code>. Branch description is
2848         automatically added to the format-patch cover letter or
2849         request-pull summary.
2850 </p>
2851 </dd>
2852 <dt class="hdlist1">
2853 browser.&lt;tool&gt;.cmd
2854 </dt>
2855 <dd>
2856 <p>
2857         Specify the command to invoke the specified browser. The
2858         specified command is evaluated in shell with the URLs passed
2859         as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
2860 </p>
2861 </dd>
2862 <dt class="hdlist1">
2863 browser.&lt;tool&gt;.path
2864 </dt>
2865 <dd>
2866 <p>
2867         Override the path for the given tool that may be used to
2868         browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
2869         working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
2870 </p>
2871 </dd>
2872 <dt class="hdlist1">
2873 bundle.*
2874 </dt>
2875 <dd>
2876 <p>
2877         The <code>bundle.*</code> keys may appear in a bundle list file found via the
2878         <code>git clone --bundle-uri</code> option. These keys currently have no effect
2879         if placed in a repository config file, though this will change in the
2880         future. See <a href="technical/bundle-uri.html">the bundle URI design
2881         document</a> for more details.
2882 </p>
2883 </dd>
2884 <dt class="hdlist1">
2885 bundle.version
2886 </dt>
2887 <dd>
2888 <p>
2889         This integer value advertises the version of the bundle list format
2890         used by the bundle list. Currently, the only accepted value is <code>1</code>.
2891 </p>
2892 </dd>
2893 <dt class="hdlist1">
2894 bundle.mode
2895 </dt>
2896 <dd>
2897 <p>
2898         This string value should be either <code>all</code> or <code>any</code>. This value describes
2899         whether all of the advertised bundles are required to unbundle a
2900         complete understanding of the bundled information (<code>all</code>) or if any one
2901         of the listed bundle URIs is sufficient (<code>any</code>).
2902 </p>
2903 </dd>
2904 <dt class="hdlist1">
2905 bundle.heuristic
2906 </dt>
2907 <dd>
2908 <p>
2909         If this string-valued key exists, then the bundle list is designed to
2910         work well with incremental <code>git fetch</code> commands. The heuristic signals
2911         that there are additional keys available for each bundle that help
2912         determine which subset of bundles the client should download. The
2913         only value currently understood is <code>creationToken</code>.
2914 </p>
2915 </dd>
2916 <dt class="hdlist1">
2917 bundle.&lt;id&gt;.*
2918 </dt>
2919 <dd>
2920 <p>
2921         The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
2922         bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.
2923 </p>
2924 </dd>
2925 <dt class="hdlist1">
2926 bundle.&lt;id&gt;.uri
2927 </dt>
2928 <dd>
2929 <p>
2930         This string value defines the URI by which Git can reach the contents
2931         of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.
2932 </p>
2933 </dd>
2934 <dt class="hdlist1">
2935 checkout.defaultRemote
2936 </dt>
2937 <dd>
2938 <p>
2939         When you run <code>git checkout &lt;something&gt;</code>
2940         or <code>git switch &lt;something&gt;</code> and only have one
2941         remote, it may implicitly fall back on checking out and
2942         tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
2943         as you have more than one remote with a <code>&lt;something&gt;</code>
2944         reference. This setting allows for setting the name of a
2945         preferred remote that should always win when it comes to
2946         disambiguation. The typical use-case is to set this to
2947         <code>origin</code>.
2948 </p>
2949 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
2950 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
2951 or <code>git switch &lt;something&gt;</code>
2952 will checkout the <code>&lt;something&gt;</code> branch on another remote,
2953 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
2954 remote branch. This setting might be used for other checkout-like
2955 commands or functionality in the future.</p></div>
2956 </dd>
2957 <dt class="hdlist1">
2958 checkout.guess
2959 </dt>
2960 <dd>
2961 <p>
2962         Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
2963         option in <code>git checkout</code> and <code>git switch</code>. See
2964         <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
2965 </p>
2966 </dd>
2967 <dt class="hdlist1">
2968 checkout.workers
2969 </dt>
2970 <dd>
2971 <p>
2972         The number of parallel workers to use when updating the working tree.
2973         The default is one, i.e. sequential execution. If set to a value less
2974         than one, Git will use as many workers as the number of logical cores
2975         available. This setting and <code>checkout.thresholdForParallelism</code> affect
2976         all commands that perform checkout. E.g. checkout, clone, reset,
2977         sparse-checkout, etc.
2978 </p>
2979 <div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories
2980 located on SSDs or over NFS. For repositories on spinning disks and/or machines
2981 with a small number of cores, the default sequential checkout often performs
2982 better. The size and compression level of a repository might also influence how
2983 well the parallel version performs.</p></div>
2984 </dd>
2985 <dt class="hdlist1">
2986 checkout.thresholdForParallelism
2987 </dt>
2988 <dd>
2989 <p>
2990         When running parallel checkout with a small number of files, the cost
2991         of subprocess spawning and inter-process communication might outweigh
2992         the parallelization gains. This setting allows you to define the minimum
2993         number of files for which parallel checkout should be attempted. The
2994         default is 100.
2995 </p>
2996 </dd>
2997 <dt class="hdlist1">
2998 clean.requireForce
2999 </dt>
3000 <dd>
3001 <p>
3002         A boolean to make git-clean refuse to delete files unless -f
3003         is given. Defaults to true.
3004 </p>
3005 </dd>
3006 <dt class="hdlist1">
3007 <code>clone.defaultRemoteName</code>
3008 </dt>
3009 <dd>
3010 <p>
3011         The name of the remote to create when cloning a repository.  Defaults to
3012         <code>origin</code>.
3013         It can be overridden by passing the <code>--origin</code> command-line
3014         option to <a href="git-clone.html">git-clone(1)</a>.
3015 </p>
3016 </dd>
3017 <dt class="hdlist1">
3018 <code>clone.rejectShallow</code>
3019 </dt>
3020 <dd>
3021 <p>
3022         Reject cloning a repository if it is a shallow one; this can be overridden by
3023         passing the <code>--reject-shallow</code> option on the command line.
3024         See <a href="git-clone.html">git-clone(1)</a>.
3025 </p>
3026 </dd>
3027 <dt class="hdlist1">
3028 <code>clone.filterSubmodules</code>
3029 </dt>
3030 <dd>
3031 <p>
3032         If a partial clone filter is provided (see <code>--filter</code> in
3033         <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
3034         the filter to submodules.
3035 </p>
3036 </dd>
3037 <dt class="hdlist1">
3038 color.advice
3039 </dt>
3040 <dd>
3041 <p>
3042         A boolean to enable/disable color in hints (e.g. when a push
3043         failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
3044         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
3045         are used only when the error output goes to a terminal. If
3046         unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3047 </p>
3048 </dd>
3049 <dt class="hdlist1">
3050 color.advice.hint
3051 </dt>
3052 <dd>
3053 <p>
3054         Use customized color for hints.
3055 </p>
3056 </dd>
3057 <dt class="hdlist1">
3058 color.blame.highlightRecent
3059 </dt>
3060 <dd>
3061 <p>
3062         Specify the line annotation color for <code>git blame --color-by-age</code>
3063         depending upon the age of the line.
3064 </p>
3065 <div class="paragraph"><p>This setting should be set to a comma-separated list of color and
3066 date settings, starting and ending with a color, the dates should be
3067 set from oldest to newest. The metadata will be colored with the
3068 specified colors if the line was introduced before the given
3069 timestamp, overwriting older timestamped colors.</p></div>
3070 <div class="paragraph"><p>Instead of an absolute timestamp relative timestamps work as well,
3071 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
3072 <div class="paragraph"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
3073 colors everything older than one year blue, recent changes between
3074 one month and one year old are kept white, and lines introduced
3075 within the last month are colored red.</p></div>
3076 </dd>
3077 <dt class="hdlist1">
3078 color.blame.repeatedLines
3079 </dt>
3080 <dd>
3081 <p>
3082         Use the specified color to colorize line annotations for
3083         <code>git blame --color-lines</code>, if they come from the same commit as the
3084         preceding line. Defaults to cyan.
3085 </p>
3086 </dd>
3087 <dt class="hdlist1">
3088 color.branch
3089 </dt>
3090 <dd>
3091 <p>
3092         A boolean to enable/disable color in the output of
3093         <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
3094         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3095         only when the output is to a terminal. If unset, then the
3096         value of <code>color.ui</code> is used (<code>auto</code> by default).
3097 </p>
3098 </dd>
3099 <dt class="hdlist1">
3100 color.branch.&lt;slot&gt;
3101 </dt>
3102 <dd>
3103 <p>
3104         Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
3105         <code>current</code> (the current branch), <code>local</code> (a local branch),
3106         <code>remote</code> (a remote-tracking branch in refs/remotes/),
3107         <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
3108         refs).
3109 </p>
3110 </dd>
3111 <dt class="hdlist1">
3112 color.diff
3113 </dt>
3114 <dd>
3115 <p>
3116         Whether to use ANSI escape sequences to add color to patches.
3117         If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
3118         <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
3119         for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
3120         commands will only use color when output is to the terminal.
3121         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
3122         default).
3123 </p>
3124 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
3125 <em>git-diff-&#42;</em> plumbing commands.  Can be overridden on the
3126 command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
3127 </dd>
3128 <dt class="hdlist1">
3129 color.diff.&lt;slot&gt;
3130 </dt>
3131 <dd>
3132 <p>
3133         Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
3134         which part of the patch to use the specified color, and is one
3135         of <code>context</code> (context text - <code>plain</code> is a historical synonym),
3136         <code>meta</code> (metainformation), <code>frag</code>
3137         (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
3138         <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
3139         (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
3140         <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
3141         <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
3142         <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
3143         setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
3144         <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
3145         <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).
3146 </p>
3147 </dd>
3148 <dt class="hdlist1">
3149 color.decorate.&lt;slot&gt;
3150 </dt>
3151 <dd>
3152 <p>
3153         Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
3154         of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
3155         branches, remote-tracking branches, tags, stash and HEAD, respectively
3156         and <code>grafted</code> for grafted commits.
3157 </p>
3158 </dd>
3159 <dt class="hdlist1">
3160 color.grep
3161 </dt>
3162 <dd>
3163 <p>
3164         When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
3165         <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
3166         when the output is written to the terminal.  If unset, then the
3167         value of <code>color.ui</code> is used (<code>auto</code> by default).
3168 </p>
3169 </dd>
3170 <dt class="hdlist1">
3171 color.grep.&lt;slot&gt;
3172 </dt>
3173 <dd>
3174 <p>
3175         Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
3176         part of the line to use the specified color, and is one of
3177 </p>
3178 <div class="openblock">
3179 <div class="content">
3180 <div class="dlist"><dl>
3181 <dt class="hdlist1">
3182 <code>context</code>
3183 </dt>
3184 <dd>
3185 <p>
3186         non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
3187 </p>
3188 </dd>
3189 <dt class="hdlist1">
3190 <code>filename</code>
3191 </dt>
3192 <dd>
3193 <p>
3194         filename prefix (when not using <code>-h</code>)
3195 </p>
3196 </dd>
3197 <dt class="hdlist1">
3198 <code>function</code>
3199 </dt>
3200 <dd>
3201 <p>
3202         function name lines (when using <code>-p</code>)
3203 </p>
3204 </dd>
3205 <dt class="hdlist1">
3206 <code>lineNumber</code>
3207 </dt>
3208 <dd>
3209 <p>
3210         line number prefix (when using <code>-n</code>)
3211 </p>
3212 </dd>
3213 <dt class="hdlist1">
3214 <code>column</code>
3215 </dt>
3216 <dd>
3217 <p>
3218         column number prefix (when using <code>--column</code>)
3219 </p>
3220 </dd>
3221 <dt class="hdlist1">
3222 <code>match</code>
3223 </dt>
3224 <dd>
3225 <p>
3226         matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
3227 </p>
3228 </dd>
3229 <dt class="hdlist1">
3230 <code>matchContext</code>
3231 </dt>
3232 <dd>
3233 <p>
3234         matching text in context lines
3235 </p>
3236 </dd>
3237 <dt class="hdlist1">
3238 <code>matchSelected</code>
3239 </dt>
3240 <dd>
3241 <p>
3242         matching text in selected lines. Also, used to customize the following
3243         <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.
3244 </p>
3245 </dd>
3246 <dt class="hdlist1">
3247 <code>selected</code>
3248 </dt>
3249 <dd>
3250 <p>
3251         non-matching text in selected lines. Also, used to customize the
3252         following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
3253         <code>--committer</code>.
3254 </p>
3255 </dd>
3256 <dt class="hdlist1">
3257 <code>separator</code>
3258 </dt>
3259 <dd>
3260 <p>
3261         separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
3262         and between hunks (<code>--</code>)
3263 </p>
3264 </dd>
3265 </dl></div>
3266 </div></div>
3267 </dd>
3268 <dt class="hdlist1">
3269 color.interactive
3270 </dt>
3271 <dd>
3272 <p>
3273         When set to <code>always</code>, always use colors for interactive prompts
3274         and displays (such as those used by "git-add --interactive" and
3275         "git-clean --interactive"). When false (or <code>never</code>), never.
3276         When set to <code>true</code> or <code>auto</code>, use colors only when the output is
3277         to the terminal. If unset, then the value of <code>color.ui</code> is
3278         used (<code>auto</code> by default).
3279 </p>
3280 </dd>
3281 <dt class="hdlist1">
3282 color.interactive.&lt;slot&gt;
3283 </dt>
3284 <dd>
3285 <p>
3286         Use customized color for <em>git add --interactive</em> and <em>git clean
3287         --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
3288         or <code>error</code>, for four distinct types of normal output from
3289         interactive commands.
3290 </p>
3291 </dd>
3292 <dt class="hdlist1">
3293 color.pager
3294 </dt>
3295 <dd>
3296 <p>
3297         A boolean to specify whether <code>auto</code> color modes should colorize
3298         output going to the pager. Defaults to true; set this to false
3299         if your pager does not understand ANSI color codes.
3300 </p>
3301 </dd>
3302 <dt class="hdlist1">
3303 color.push
3304 </dt>
3305 <dd>
3306 <p>
3307         A boolean to enable/disable color in push errors. May be set to
3308         <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3309         case colors are used only when the error output goes to a terminal.
3310         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3311 </p>
3312 </dd>
3313 <dt class="hdlist1">
3314 color.push.error
3315 </dt>
3316 <dd>
3317 <p>
3318         Use customized color for push errors.
3319 </p>
3320 </dd>
3321 <dt class="hdlist1">
3322 color.remote
3323 </dt>
3324 <dd>
3325 <p>
3326         If set, keywords at the start of the line are highlighted. The
3327         keywords are "error", "warning", "hint" and "success", and are
3328         matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
3329         <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
3330         <code>color.ui</code> is used (<code>auto</code> by default).
3331 </p>
3332 </dd>
3333 <dt class="hdlist1">
3334 color.remote.&lt;slot&gt;
3335 </dt>
3336 <dd>
3337 <p>
3338         Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
3339         <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
3340         corresponding keyword.
3341 </p>
3342 </dd>
3343 <dt class="hdlist1">
3344 color.showBranch
3345 </dt>
3346 <dd>
3347 <p>
3348         A boolean to enable/disable color in the output of
3349         <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
3350         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3351         only when the output is to a terminal. If unset, then the
3352         value of <code>color.ui</code> is used (<code>auto</code> by default).
3353 </p>
3354 </dd>
3355 <dt class="hdlist1">
3356 color.status
3357 </dt>
3358 <dd>
3359 <p>
3360         A boolean to enable/disable color in the output of
3361         <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
3362         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3363         only when the output is to a terminal. If unset, then the
3364         value of <code>color.ui</code> is used (<code>auto</code> by default).
3365 </p>
3366 </dd>
3367 <dt class="hdlist1">
3368 color.status.&lt;slot&gt;
3369 </dt>
3370 <dd>
3371 <p>
3372         Use customized color for status colorization. <code>&lt;slot&gt;</code> is
3373         one of <code>header</code> (the header text of the status message),
3374         <code>added</code> or <code>updated</code> (files which are added but not committed),
3375         <code>changed</code> (files which are changed but not added in the index),
3376         <code>untracked</code> (files which are not tracked by Git),
3377         <code>branch</code> (the current branch),
3378         <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
3379         to red),
3380         <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
3381         respectively, when branch and tracking information is displayed in the
3382         status short-format), or
3383         <code>unmerged</code> (files which have unmerged changes).
3384 </p>
3385 </dd>
3386 <dt class="hdlist1">
3387 color.transport
3388 </dt>
3389 <dd>
3390 <p>
3391         A boolean to enable/disable color when pushes are rejected. May be
3392         set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3393         case colors are used only when the error output goes to a terminal.
3394         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3395 </p>
3396 </dd>
3397 <dt class="hdlist1">
3398 color.transport.rejected
3399 </dt>
3400 <dd>
3401 <p>
3402         Use customized color when a push was rejected.
3403 </p>
3404 </dd>
3405 <dt class="hdlist1">
3406 color.ui
3407 </dt>
3408 <dd>
3409 <p>
3410         This variable determines the default value for variables such
3411         as <code>color.diff</code> and <code>color.grep</code> that control the use of color
3412         per command family. Its scope will expand as more commands learn
3413         configuration to set a default for the <code>--color</code> option.  Set it
3414         to <code>false</code> or <code>never</code> if you prefer Git commands not to use
3415         color unless enabled explicitly with some other configuration
3416         or the <code>--color</code> option. Set it to <code>always</code> if you want all
3417         output not intended for machine consumption to use color, to
3418         <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
3419         want such output to use color when written to the terminal.
3420 </p>
3421 </dd>
3422 <dt class="hdlist1">
3423 column.ui
3424 </dt>
3425 <dd>
3426 <p>
3427         Specify whether supported commands should output in columns.
3428         This variable consists of a list of tokens separated by spaces
3429         or commas:
3430 </p>
3431 <div class="paragraph"><p>These options control when the feature should be enabled
3432 (defaults to <em>never</em>):</p></div>
3433 <div class="openblock">
3434 <div class="content">
3435 <div class="dlist"><dl>
3436 <dt class="hdlist1">
3437 <code>always</code>
3438 </dt>
3439 <dd>
3440 <p>
3441         always show in columns
3442 </p>
3443 </dd>
3444 <dt class="hdlist1">
3445 <code>never</code>
3446 </dt>
3447 <dd>
3448 <p>
3449         never show in columns
3450 </p>
3451 </dd>
3452 <dt class="hdlist1">
3453 <code>auto</code>
3454 </dt>
3455 <dd>
3456 <p>
3457         show in columns if the output is to the terminal
3458 </p>
3459 </dd>
3460 </dl></div>
3461 </div></div>
3462 <div class="paragraph"><p>These options control layout (defaults to <em>column</em>).  Setting any
3463 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
3464 specified.</p></div>
3465 <div class="openblock">
3466 <div class="content">
3467 <div class="dlist"><dl>
3468 <dt class="hdlist1">
3469 <code>column</code>
3470 </dt>
3471 <dd>
3472 <p>
3473         fill columns before rows
3474 </p>
3475 </dd>
3476 <dt class="hdlist1">
3477 <code>row</code>
3478 </dt>
3479 <dd>
3480 <p>
3481         fill rows before columns
3482 </p>
3483 </dd>
3484 <dt class="hdlist1">
3485 <code>plain</code>
3486 </dt>
3487 <dd>
3488 <p>
3489         show in one column
3490 </p>
3491 </dd>
3492 </dl></div>
3493 </div></div>
3494 <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
3495 to <em>nodense</em>):</p></div>
3496 <div class="openblock">
3497 <div class="content">
3498 <div class="dlist"><dl>
3499 <dt class="hdlist1">
3500 <code>dense</code>
3501 </dt>
3502 <dd>
3503 <p>
3504         make unequal size columns to utilize more space
3505 </p>
3506 </dd>
3507 <dt class="hdlist1">
3508 <code>nodense</code>
3509 </dt>
3510 <dd>
3511 <p>
3512         make equal size columns
3513 </p>
3514 </dd>
3515 </dl></div>
3516 </div></div>
3517 </dd>
3518 <dt class="hdlist1">
3519 column.branch
3520 </dt>
3521 <dd>
3522 <p>
3523         Specify whether to output branch listing in <code>git branch</code> in columns.
3524         See <code>column.ui</code> for details.
3525 </p>
3526 </dd>
3527 <dt class="hdlist1">
3528 column.clean
3529 </dt>
3530 <dd>
3531 <p>
3532         Specify the layout when listing items in <code>git clean -i</code>, which always
3533         shows files and directories in columns. See <code>column.ui</code> for details.
3534 </p>
3535 </dd>
3536 <dt class="hdlist1">
3537 column.status
3538 </dt>
3539 <dd>
3540 <p>
3541         Specify whether to output untracked files in <code>git status</code> in columns.
3542         See <code>column.ui</code> for details.
3543 </p>
3544 </dd>
3545 <dt class="hdlist1">
3546 column.tag
3547 </dt>
3548 <dd>
3549 <p>
3550         Specify whether to output tag listings in <code>git tag</code> in columns.
3551         See <code>column.ui</code> for details.
3552 </p>
3553 </dd>
3554 <dt class="hdlist1">
3555 commit.cleanup
3556 </dt>
3557 <dd>
3558 <p>
3559         This setting overrides the default of the <code>--cleanup</code> option in
3560         <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
3561         default can be useful when you always want to keep lines that begin
3562         with the comment character <code>#</code> in your log message, in which case you
3563         would do <code>git config commit.cleanup whitespace</code> (note that you will
3564         have to remove the help lines that begin with <code>#</code> in the commit log
3565         template yourself, if you do this).
3566 </p>
3567 </dd>
3568 <dt class="hdlist1">
3569 commit.gpgSign
3570 </dt>
3571 <dd>
3572 <p>
3573         A boolean to specify whether all commits should be GPG signed.
3574         Use of this option when doing operations such as rebase can
3575         result in a large number of commits being signed. It may be
3576         convenient to use an agent to avoid typing your GPG passphrase
3577         several times.
3578 </p>
3579 </dd>
3580 <dt class="hdlist1">
3581 commit.status
3582 </dt>
3583 <dd>
3584 <p>
3585         A boolean to enable/disable inclusion of status information in the
3586         commit message template when using an editor to prepare the commit
3587         message.  Defaults to true.
3588 </p>
3589 </dd>
3590 <dt class="hdlist1">
3591 commit.template
3592 </dt>
3593 <dd>
3594 <p>
3595         Specify the pathname of a file to use as the template for
3596         new commit messages.
3597 </p>
3598 </dd>
3599 <dt class="hdlist1">
3600 commit.verbose
3601 </dt>
3602 <dd>
3603 <p>
3604         A boolean or int to specify the level of verbosity with <code>git commit</code>.
3605         See <a href="git-commit.html">git-commit(1)</a>.
3606 </p>
3607 </dd>
3608 <dt class="hdlist1">
3609 commitGraph.generationVersion
3610 </dt>
3611 <dd>
3612 <p>
3613         Specifies the type of generation number version to use when writing
3614         or reading the commit-graph file. If version 1 is specified, then
3615         the corrected commit dates will not be written or read. Defaults to
3616         2.
3617 </p>
3618 </dd>
3619 <dt class="hdlist1">
3620 commitGraph.maxNewFilters
3621 </dt>
3622 <dd>
3623 <p>
3624         Specifies the default value for the <code>--max-new-filters</code> option of <code>git
3625         commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).
3626 </p>
3627 </dd>
3628 <dt class="hdlist1">
3629 commitGraph.readChangedPaths
3630 </dt>
3631 <dd>
3632 <p>
3633         If true, then git will use the changed-path Bloom filters in the
3634         commit-graph file (if it exists, and they are present). Defaults to
3635         true. See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
3636 </p>
3637 </dd>
3638 <dt class="hdlist1">
3639 completion.commands
3640 </dt>
3641 <dd>
3642 <p>
3643         This is only used by git-completion.bash to add or remove
3644         commands from the list of completed commands. Normally only
3645         porcelain commands and a few select others are completed. You
3646         can add more commands, separated by space, in this
3647         variable. Prefixing the command with <em>-</em> will remove it from
3648         the existing list.
3649 </p>
3650 </dd>
3651 <dt class="hdlist1">
3652 core.fileMode
3653 </dt>
3654 <dd>
3655 <p>
3656         Tells Git if the executable bit of files in the working tree
3657         is to be honored.
3658 </p>
3659 <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
3660 marked as executable is checked out, or checks out a
3661 non-executable file with executable bit on.
3662 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
3663 to see if it handles the executable bit correctly
3664 and this variable is automatically set as necessary.</p></div>
3665 <div class="paragraph"><p>A repository, however, may be on a filesystem that handles
3666 the filemode correctly, and this variable is set to <em>true</em>
3667 when created, but later may be made accessible from another
3668 environment that loses the filemode (e.g. exporting ext4 via
3669 CIFS mount, visiting a Cygwin created repository with
3670 Git for Windows or Eclipse).
3671 In such a case it may be necessary to set this variable to <em>false</em>.
3672 See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
3673 <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
3674 </dd>
3675 <dt class="hdlist1">
3676 core.hideDotFiles
3677 </dt>
3678 <dd>
3679 <p>
3680         (Windows-only) If true, mark newly-created directories and files whose
3681         name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
3682         directory is hidden, but no other files starting with a dot.  The
3683         default mode is <em>dotGitOnly</em>.
3684 </p>
3685 </dd>
3686 <dt class="hdlist1">
3687 core.ignoreCase
3688 </dt>
3689 <dd>
3690 <p>
3691         Internal variable which enables various workarounds to enable
3692         Git to work better on filesystems that are not case sensitive,
3693         like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
3694         finds "makefile" when Git expects "Makefile", Git will assume
3695         it is really the same file, and continue to remember it as
3696         "Makefile".
3697 </p>
3698 <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>
3699 will probe and set core.ignoreCase true if appropriate when the repository
3700 is created.</p></div>
3701 <div class="paragraph"><p>Git relies on the proper configuration of this variable for your operating
3702 and file system. Modifying this value may result in unexpected behavior.</p></div>
3703 </dd>
3704 <dt class="hdlist1">
3705 core.precomposeUnicode
3706 </dt>
3707 <dd>
3708 <p>
3709         This option is only used by Mac OS implementation of Git.
3710         When core.precomposeUnicode=true, Git reverts the unicode decomposition
3711         of filenames done by Mac OS. This is useful when sharing a repository
3712         between Mac OS and Linux or Windows.
3713         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
3714         When false, file names are handled fully transparent by Git,
3715         which is backward compatible with older versions of Git.
3716 </p>
3717 </dd>
3718 <dt class="hdlist1">
3719 core.protectHFS
3720 </dt>
3721 <dd>
3722 <p>
3723         If set to true, do not allow checkout of paths that would
3724         be considered equivalent to <code>.git</code> on an HFS+ filesystem.
3725         Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
3726 </p>
3727 </dd>
3728 <dt class="hdlist1">
3729 core.protectNTFS
3730 </dt>
3731 <dd>
3732 <p>
3733         If set to true, do not allow checkout of paths that would
3734         cause problems with the NTFS filesystem, e.g. conflict with
3735         8.3 "short" names.
3736         Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
3737 </p>
3738 </dd>
3739 <dt class="hdlist1">
3740 core.fsmonitor
3741 </dt>
3742 <dd>
3743 <p>
3744         If set to true, enable the built-in file system monitor
3745         daemon for this working directory (<a href="git-fsmonitor&#45;&#45;daemon.html">git-fsmonitor&#45;&#45;daemon(1)</a>).
3746 </p>
3747 <div class="paragraph"><p>Like hook-based file system monitors, the built-in file system monitor
3748 can speed up Git commands that need to refresh the Git index
3749 (e.g. <code>git status</code>) in a working directory with many files.  The
3750 built-in monitor eliminates the need to install and maintain an
3751 external third-party tool.</p></div>
3752 <div class="paragraph"><p>The built-in file system monitor is currently available only on a
3753 limited set of supported platforms.  Currently, this includes Windows
3754 and MacOS.</p></div>
3755 <div class="literalblock">
3756 <div class="content">
3757 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor"
3758 hook command.</code></pre>
3759 </div></div>
3760 <div class="paragraph"><p>This hook command is used to identify all files that may have changed
3761 since the requested date/time. This information is used to speed up
3762 git by avoiding unnecessary scanning of files that have not changed.</p></div>
3763 <div class="paragraph"><p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p></div>
3764 <div class="paragraph"><p>Note that if you concurrently use multiple versions of Git, such
3765 as one version on the command line and another version in an IDE
3766 tool, that the definition of <code>core.fsmonitor</code> was extended to
3767 allow boolean values in addition to hook pathnames.  Git versions
3768 2.35.1 and prior will not understand the boolean values and will
3769 consider the "true" or "false" values as hook pathnames to be
3770 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
3771 V2 and will fall back to no fsmonitor (full scan).  Git versions
3772 prior to 2.26 default to hook protocol V1 and will silently
3773 assume there were no changes to report (no scan), so status
3774 commands may report incomplete results.  For this reason, it is
3775 best to upgrade all of your Git versions before using the built-in
3776 file system monitor.</p></div>
3777 </dd>
3778 <dt class="hdlist1">
3779 core.fsmonitorHookVersion
3780 </dt>
3781 <dd>
3782 <p>
3783         Sets the protocol version to be used when invoking the
3784         "fsmonitor" hook.
3785 </p>
3786 <div class="paragraph"><p>There are currently versions 1 and 2. When this is not set,
3787 version 2 will be tried first and if it fails then version 1
3788 will be tried. Version 1 uses a timestamp as input to determine
3789 which files have changes since that time but some monitors
3790 like Watchman have race conditions when used with a timestamp.
3791 Version 2 uses an opaque string so that the monitor can return
3792 something that can be used to determine what files have changed
3793 without race conditions.</p></div>
3794 </dd>
3795 <dt class="hdlist1">
3796 core.trustctime
3797 </dt>
3798 <dd>
3799 <p>
3800         If false, the ctime differences between the index and the
3801         working tree are ignored; useful when the inode change time
3802         is regularly modified by something outside Git (file system
3803         crawlers and some backup systems).
3804         See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
3805 </p>
3806 </dd>
3807 <dt class="hdlist1">
3808 core.splitIndex
3809 </dt>
3810 <dd>
3811 <p>
3812         If true, the split-index feature of the index will be used.
3813         See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
3814 </p>
3815 </dd>
3816 <dt class="hdlist1">
3817 core.untrackedCache
3818 </dt>
3819 <dd>
3820 <p>
3821         Determines what to do about the untracked cache feature of the
3822         index. It will be kept, if this variable is unset or set to
3823         <code>keep</code>. It will automatically be added if set to <code>true</code>. And
3824         it will automatically be removed, if set to <code>false</code>. Before
3825         setting it to <code>true</code>, you should check that mtime is working
3826         properly on your system.
3827         See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
3828         <code>feature.manyFiles</code> is enabled which sets this setting to
3829         <code>true</code> by default.
3830 </p>
3831 </dd>
3832 <dt class="hdlist1">
3833 core.checkStat
3834 </dt>
3835 <dd>
3836 <p>
3837         When missing or is set to <code>default</code>, many fields in the stat
3838         structure are checked to detect if a file has been modified
3839         since Git looked at it.  When this configuration variable is
3840         set to <code>minimal</code>, sub-second part of mtime and ctime, the
3841         uid and gid of the owner of the file, the inode number (and
3842         the device number, if Git was compiled to use it), are
3843         excluded from the check among these fields, leaving only the
3844         whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
3845         is set) and the filesize to be checked.
3846 </p>
3847 <div class="paragraph"><p>There are implementations of Git that do not leave usable values in
3848 some fields (e.g. JGit); by excluding these fields from the
3849 comparison, the <code>minimal</code> mode may help interoperability when the
3850 same repository is used by these other systems at the same time.</p></div>
3851 </dd>
3852 <dt class="hdlist1">
3853 core.quotePath
3854 </dt>
3855 <dd>
3856 <p>
3857         Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
3858         quote "unusual" characters in the pathname by enclosing the
3859         pathname in double-quotes and escaping those characters with
3860         backslashes in the same way C escapes control characters (e.g.
3861         <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
3862         values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
3863         UTF-8).  If this variable is set to false, bytes higher than
3864         0x80 are not considered "unusual" any more. Double-quotes,
3865         backslash and control characters are always escaped regardless
3866         of the setting of this variable.  A simple space character is
3867         not considered "unusual".  Many commands can output pathnames
3868         completely verbatim using the <code>-z</code> option. The default value
3869         is true.
3870 </p>
3871 </dd>
3872 <dt class="hdlist1">
3873 core.eol
3874 </dt>
3875 <dd>
3876 <p>
3877         Sets the line ending type to use in the working directory for
3878         files that are marked as text (either by having the <code>text</code>
3879         attribute set, or by having <code>text=auto</code> and Git auto-detecting
3880         the contents as text).
3881         Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
3882         native line ending.  The default value is <code>native</code>.  See
3883         <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
3884         conversion. Note that this value is ignored if <code>core.autocrlf</code>
3885         is set to <code>true</code> or <code>input</code>.
3886 </p>
3887 </dd>
3888 <dt class="hdlist1">
3889 core.safecrlf
3890 </dt>
3891 <dd>
3892 <p>
3893         If true, makes Git check if converting <code>CRLF</code> is reversible when
3894         end-of-line conversion is active.  Git will verify if a command
3895         modifies a file in the work tree either directly or indirectly.
3896         For example, committing a file followed by checking out the
3897         same file should yield the original file in the work tree.  If
3898         this is not the case for the current setting of
3899         <code>core.autocrlf</code>, Git will reject the file.  The variable can
3900         be set to "warn", in which case Git will only warn about an
3901         irreversible conversion but continue the operation.
3902 </p>
3903 <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
3904 When it is enabled, Git will convert CRLF to LF during commit and LF to
3905 CRLF during checkout.  A file that contains a mixture of LF and
3906 CRLF before the commit cannot be recreated by Git.  For text
3907 files this is the right thing to do: it corrects line endings
3908 such that we have only LF line endings in the repository.
3909 But for binary files that are accidentally classified as text the
3910 conversion can corrupt data.</p></div>
3911 <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
3912 setting the conversion type explicitly in .gitattributes.  Right
3913 after committing you still have the original file in your work
3914 tree and this file is not yet corrupted.  You can explicitly tell
3915 Git that this file is binary and Git will handle the file
3916 appropriately.</p></div>
3917 <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
3918 mixed line endings and the undesired effect of corrupting binary
3919 files cannot be distinguished.  In both cases CRLFs are removed
3920 in an irreversible way.  For text files this is the right thing
3921 to do because CRLFs are line endings, while for binary files
3922 converting CRLFs corrupts data.</p></div>
3923 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
3924 file identical to the original file for a different setting of
3925 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
3926 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
3927 and could later be checked out with <code>core.eol=crlf</code>, in which case the
3928 resulting file would contain <code>CRLF</code>, although the original file
3929 contained <code>LF</code>.  However, in both work trees the line endings would be
3930 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
3931 file with mixed line endings would be reported by the <code>core.safecrlf</code>
3932 mechanism.</p></div>
3933 </dd>
3934 <dt class="hdlist1">
3935 core.autocrlf
3936 </dt>
3937 <dd>
3938 <p>
3939         Setting this variable to "true" is the same as setting
3940         the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
3941         Set to true if you want to have <code>CRLF</code> line endings in your
3942         working directory and the repository has LF line endings.
3943         This variable can be set to <em>input</em>,
3944         in which case no output conversion is performed.
3945 </p>
3946 </dd>
3947 <dt class="hdlist1">
3948 core.checkRoundtripEncoding
3949 </dt>
3950 <dd>
3951 <p>
3952         A comma and/or whitespace separated list of encodings that Git
3953         performs UTF-8 round trip checks on if they are used in an
3954         <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
3955         The default value is <code>SHIFT-JIS</code>.
3956 </p>
3957 </dd>
3958 <dt class="hdlist1">
3959 core.symlinks
3960 </dt>
3961 <dd>
3962 <p>
3963         If false, symbolic links are checked out as small plain files that
3964         contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
3965         <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
3966         file. Useful on filesystems like FAT that do not support
3967         symbolic links.
3968 </p>
3969 <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>
3970 will probe and set core.symlinks false if appropriate when the repository
3971 is created.</p></div>
3972 </dd>
3973 <dt class="hdlist1">
3974 core.gitProxy
3975 </dt>
3976 <dd>
3977 <p>
3978         A "proxy command" to execute (as <em>command host port</em>) instead
3979         of establishing direct connection to the remote server when
3980         using the Git protocol for fetching. If the variable value is
3981         in the "COMMAND for DOMAIN" format, the command is applied only
3982         on hostnames ending with the specified domain string. This variable
3983         may be set multiple times and is matched in the given order;
3984         the first match wins.
3985 </p>
3986 <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
3987 (which always applies universally, without the special "for"
3988 handling).</p></div>
3989 <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
3990 specify that no proxy be used for a given domain pattern.
3991 This is useful for excluding servers inside a firewall from
3992 proxy use, while defaulting to a common proxy for external domains.</p></div>
3993 </dd>
3994 <dt class="hdlist1">
3995 core.sshCommand
3996 </dt>
3997 <dd>
3998 <p>
3999         If this variable is set, <code>git fetch</code> and <code>git push</code> will
4000         use the specified command instead of <code>ssh</code> when they need to
4001         connect to a remote system. The command is in the same form as
4002         the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
4003         when the environment variable is set.
4004 </p>
4005 </dd>
4006 <dt class="hdlist1">
4007 core.ignoreStat
4008 </dt>
4009 <dd>
4010 <p>
4011         If true, Git will avoid using lstat() calls to detect if files have
4012         changed by setting the "assume-unchanged" bit for those tracked files
4013         which it has updated identically in both the index and working tree.
4014 </p>
4015 <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
4016 the modified files explicitly (e.g. see <em>Examples</em> section in
4017 <a href="git-update-index.html">git-update-index(1)</a>).
4018 Git will not normally detect changes to those files.</p></div>
4019 <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
4020 CIFS/Microsoft Windows.</p></div>
4021 <div class="paragraph"><p>False by default.</p></div>
4022 </dd>
4023 <dt class="hdlist1">
4024 core.preferSymlinkRefs
4025 </dt>
4026 <dd>
4027 <p>
4028         Instead of the default "symref" format for HEAD
4029         and other symbolic reference files, use symbolic links.
4030         This is sometimes needed to work with old scripts that
4031         expect HEAD to be a symbolic link.
4032 </p>
4033 </dd>
4034 <dt class="hdlist1">
4035 core.alternateRefsCommand
4036 </dt>
4037 <dd>
4038 <p>
4039         When advertising tips of available history from an alternate, use the shell to
4040         execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
4041         first argument is the absolute path of the alternate. Output must contain one
4042         hex object id per line (i.e., the same as produced by <code>git for-each-ref
4043         --format='%(objectname)'</code>).
4044 </p>
4045 <div class="paragraph"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
4046 value, as it does not take a repository path as an argument (but you can wrap
4047 the command above in a shell script).</p></div>
4048 </dd>
4049 <dt class="hdlist1">
4050 core.alternateRefsPrefixes
4051 </dt>
4052 <dd>
4053 <p>
4054         When listing references from an alternate, list only references that begin
4055         with the given prefix. Prefixes match as if they were given as arguments to
4056         <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
4057         whitespace. If <code>core.alternateRefsCommand</code> is set, setting
4058         <code>core.alternateRefsPrefixes</code> has no effect.
4059 </p>
4060 </dd>
4061 <dt class="hdlist1">
4062 core.bare
4063 </dt>
4064 <dd>
4065 <p>
4066         If true this repository is assumed to be <em>bare</em> and has no
4067         working directory associated with it.  If this is the case a
4068         number of commands that require a working directory will be
4069         disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
4070 </p>
4071 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
4072 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
4073 repository that ends in "/.git" is assumed to be not bare (bare =
4074 false), while all other repositories are assumed to be bare (bare
4075 = true).</p></div>
4076 </dd>
4077 <dt class="hdlist1">
4078 core.worktree
4079 </dt>
4080 <dd>
4081 <p>
4082         Set the path to the root of the working tree.
4083         If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
4084         is ignored and not used for determining the root of working tree.
4085         This can be overridden by the <code>GIT_WORK_TREE</code> environment
4086         variable and the <code>--work-tree</code> command-line option.
4087         The value can be an absolute path or relative to the path to
4088         the .git directory, which is either specified by --git-dir
4089         or GIT_DIR, or automatically discovered.
4090         If --git-dir or GIT_DIR is specified but none of
4091         --work-tree, GIT_WORK_TREE and core.worktree is specified,
4092         the current working directory is regarded as the top level
4093         of your working tree.
4094 </p>
4095 <div class="paragraph"><p>Note that this variable is honored even when set in a configuration
4096 file in a ".git" subdirectory of a directory and its value differs
4097 from the latter directory (e.g. "/path/to/.git/config" has
4098 core.worktree set to "/different/path"), which is most likely a
4099 misconfiguration.  Running Git commands in the "/path/to" directory will
4100 still use "/different/path" as the root of the work tree and can cause
4101 confusion unless you know what you are doing (e.g. you are creating a
4102 read-only snapshot of the same index to a location different from the
4103 repository&#8217;s usual working tree).</p></div>
4104 </dd>
4105 <dt class="hdlist1">
4106 core.logAllRefUpdates
4107 </dt>
4108 <dd>
4109 <p>
4110         Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
4111         "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
4112         SHA-1, the date/time and the reason of the update, but
4113         only when the file exists.  If this configuration
4114         variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
4115         file is automatically created for branch heads (i.e. under
4116         <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
4117         note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
4118         If it is set to <code>always</code>, then a missing reflog is automatically
4119         created for any ref under <code>refs/</code>.
4120 </p>
4121 <div class="paragraph"><p>This information can be used to determine what commit
4122 was the tip of a branch "2 days ago".</p></div>
4123 <div class="paragraph"><p>This value is true by default in a repository that has
4124 a working directory associated with it, and false by
4125 default in a bare repository.</p></div>
4126 </dd>
4127 <dt class="hdlist1">
4128 core.repositoryFormatVersion
4129 </dt>
4130 <dd>
4131 <p>
4132         Internal variable identifying the repository format and layout
4133         version.
4134 </p>
4135 </dd>
4136 <dt class="hdlist1">
4137 core.sharedRepository
4138 </dt>
4139 <dd>
4140 <p>
4141         When <em>group</em> (or <em>true</em>), the repository is made shareable between
4142         several users in a group (making sure all the files and objects are
4143         group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
4144         repository will be readable by all users, additionally to being
4145         group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
4146         reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
4147         files in the repository will have this mode value. <em>0xxx</em> will override
4148         user&#8217;s umask value (whereas the other options will only override
4149         requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
4150         the repo read/write-able for the owner and group, but inaccessible to
4151         others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
4152         repository that is group-readable but not group-writable.
4153         See <a href="git-init.html">git-init(1)</a>. False by default.
4154 </p>
4155 </dd>
4156 <dt class="hdlist1">
4157 core.warnAmbiguousRefs
4158 </dt>
4159 <dd>
4160 <p>
4161         If true, Git will warn you if the ref name you passed it is ambiguous
4162         and might match multiple refs in the repository. True by default.
4163 </p>
4164 </dd>
4165 <dt class="hdlist1">
4166 core.compression
4167 </dt>
4168 <dd>
4169 <p>
4170         An integer -1..9, indicating a default compression level.
4171         -1 is the zlib default. 0 means no compression,
4172         and 1..9 are various speed/size tradeoffs, 9 being slowest.
4173         If set, this provides a default to other compression variables,
4174         such as <code>core.looseCompression</code> and <code>pack.compression</code>.
4175 </p>
4176 </dd>
4177 <dt class="hdlist1">
4178 core.looseCompression
4179 </dt>
4180 <dd>
4181 <p>
4182         An integer -1..9, indicating the compression level for objects that
4183         are not in a pack file. -1 is the zlib default. 0 means no
4184         compression, and 1..9 are various speed/size tradeoffs, 9 being
4185         slowest.  If not set,  defaults to core.compression.  If that is
4186         not set,  defaults to 1 (best speed).
4187 </p>
4188 </dd>
4189 <dt class="hdlist1">
4190 core.packedGitWindowSize
4191 </dt>
4192 <dd>
4193 <p>
4194         Number of bytes of a pack file to map into memory in a
4195         single mapping operation.  Larger window sizes may allow
4196         your system to process a smaller number of large pack files
4197         more quickly.  Smaller window sizes will negatively affect
4198         performance due to increased calls to the operating system&#8217;s
4199         memory manager, but may improve performance when accessing
4200         a large number of large pack files.
4201 </p>
4202 <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
4203 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
4204 be reasonable for all users/operating systems.  You probably do
4205 not need to adjust this value.</p></div>
4206 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4207 </dd>
4208 <dt class="hdlist1">
4209 core.packedGitLimit
4210 </dt>
4211 <dd>
4212 <p>
4213         Maximum number of bytes to map simultaneously into memory
4214         from pack files.  If Git needs to access more than this many
4215         bytes at once to complete an operation it will unmap existing
4216         regions to reclaim virtual address space within the process.
4217 </p>
4218 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
4219 unlimited) on 64 bit platforms.
4220 This should be reasonable for all users/operating systems, except on
4221 the largest projects.  You probably do not need to adjust this value.</p></div>
4222 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4223 </dd>
4224 <dt class="hdlist1">
4225 core.deltaBaseCacheLimit
4226 </dt>
4227 <dd>
4228 <p>
4229         Maximum number of bytes per thread to reserve for caching base objects
4230         that may be referenced by multiple deltified objects.  By storing the
4231         entire decompressed base objects in a cache Git is able
4232         to avoid unpacking and decompressing frequently used base
4233         objects multiple times.
4234 </p>
4235 <div class="paragraph"><p>Default is 96 MiB on all platforms.  This should be reasonable
4236 for all users/operating systems, except on the largest projects.
4237 You probably do not need to adjust this value.</p></div>
4238 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4239 </dd>
4240 <dt class="hdlist1">
4241 core.bigFileThreshold
4242 </dt>
4243 <dd>
4244 <p>
4245         The size of files considered "big", which as discussed below
4246         changes the behavior of numerous git commands, as well as how
4247         such files are stored within the repository. The default is
4248         512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
4249         supported.
4250 </p>
4251 <div class="paragraph"><p>Files above the configured limit will be:</p></div>
4252 <div class="ulist"><ul>
4253 <li>
4254 <p>
4255 Stored deflated in packfiles, without attempting delta compression.
4256 </p>
4257 <div class="paragraph"><p>The default limit is primarily set with this use-case in mind. With it,
4258 most projects will have their source code and other text files delta
4259 compressed, but not larger binary media files.</p></div>
4260 <div class="paragraph"><p>Storing large files without delta compression avoids excessive memory
4261 usage, at the slight expense of increased disk usage.</p></div>
4262 </li>
4263 <li>
4264 <p>
4265 Will be treated as if they were labeled "binary" (see
4266   <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
4267   <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.
4268 </p>
4269 </li>
4270 <li>
4271 <p>
4272 Will generally be streamed when written, which avoids excessive
4273 memory usage, at the cost of some fixed overhead. Commands that make
4274 use of this include <a href="git-archive.html">git-archive(1)</a>,
4275 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
4276 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.
4277 </p>
4278 </li>
4279 </ul></div>
4280 </dd>
4281 <dt class="hdlist1">
4282 core.excludesFile
4283 </dt>
4284 <dd>
4285 <p>
4286         Specifies the pathname to the file that contains patterns to
4287         describe paths that are not meant to be tracked, in addition
4288         to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
4289         Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
4290         If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
4291         is used instead. See <a href="gitignore.html">gitignore(5)</a>.
4292 </p>
4293 </dd>
4294 <dt class="hdlist1">
4295 core.askPass
4296 </dt>
4297 <dd>
4298 <p>
4299         Some commands (e.g. svn and http interfaces) that interactively
4300         ask for a password can be told to use an external program given
4301         via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
4302         environment variable. If not set, fall back to the value of the
4303         <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
4304         prompt. The external program shall be given a suitable prompt as
4305         command-line argument and write the password on its STDOUT.
4306 </p>
4307 </dd>
4308 <dt class="hdlist1">
4309 core.attributesFile
4310 </dt>
4311 <dd>
4312 <p>
4313         In addition to <code>.gitattributes</code> (per-directory) and
4314         <code>.git/info/attributes</code>, Git looks into this file for attributes
4315         (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
4316         way as for <code>core.excludesFile</code>. Its default value is
4317         <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
4318         set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
4319 </p>
4320 </dd>
4321 <dt class="hdlist1">
4322 core.hooksPath
4323 </dt>
4324 <dd>
4325 <p>
4326         By default Git will look for your hooks in the
4327         <code>$GIT_DIR/hooks</code> directory. Set this to different path,
4328         e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
4329         that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
4330         in <code>$GIT_DIR/hooks/pre-receive</code>.
4331 </p>
4332 <div class="paragraph"><p>The path can be either absolute or relative. A relative path is
4333 taken as relative to the directory where the hooks are run (see
4334 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
4335 <div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
4336 centrally configure your Git hooks instead of configuring them on a
4337 per-repository basis, or as a more flexible and centralized
4338 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
4339 default hooks.</p></div>
4340 </dd>
4341 <dt class="hdlist1">
4342 core.editor
4343 </dt>
4344 <dd>
4345 <p>
4346         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4347         messages by launching an editor use the value of this
4348         variable when it is set, and the environment variable
4349         <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.
4350 </p>
4351 </dd>
4352 <dt class="hdlist1">
4353 core.commentChar
4354 </dt>
4355 <dt class="hdlist1">
4356 core.commentString
4357 </dt>
4358 <dd>
4359 <p>
4360         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4361         messages consider a line that begins with this character
4362         commented, and removes them after the editor returns
4363         (default <em>#</em>).
4364 </p>
4365 <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
4366 the beginning character of any line in existing commit messages.</p></div>
4367 <div class="paragraph"><p>Note that these two variables are aliases of each other, and in modern
4368 versions of Git you are free to use a string (e.g., <code>//</code> or <code>⁑⁕⁑</code>) with
4369 <code>commentChar</code>. Versions of Git prior to v2.45.0 will ignore
4370 <code>commentString</code> but will reject a value of <code>commentChar</code> that consists
4371 of more than a single ASCII byte. If you plan to use your config with
4372 older and newer versions of Git, you may want to specify both:</p></div>
4373 <div class="literalblock">
4374 <div class="content">
4375 <pre><code>[core]
4376 # single character for older versions
4377 commentChar = "#"
4378 # string for newer versions (which will override commentChar
4379 # because it comes later in the file)
4380 commentString = "//"</code></pre>
4381 </div></div>
4382 </dd>
4383 <dt class="hdlist1">
4384 core.filesRefLockTimeout
4385 </dt>
4386 <dd>
4387 <p>
4388         The length of time, in milliseconds, to retry when trying to
4389         lock an individual reference. Value 0 means not to retry at
4390         all; -1 means to try indefinitely. Default is 100 (i.e.,
4391         retry for 100ms).
4392 </p>
4393 </dd>
4394 <dt class="hdlist1">
4395 core.packedRefsTimeout
4396 </dt>
4397 <dd>
4398 <p>
4399         The length of time, in milliseconds, to retry when trying to
4400         lock the <code>packed-refs</code> file. Value 0 means not to retry at
4401         all; -1 means to try indefinitely. Default is 1000 (i.e.,
4402         retry for 1 second).
4403 </p>
4404 </dd>
4405 <dt class="hdlist1">
4406 core.pager
4407 </dt>
4408 <dd>
4409 <p>
4410         Text viewer for use by Git commands (e.g., <em>less</em>).  The value
4411         is meant to be interpreted by the shell.  The order of preference
4412         is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
4413         configuration, then <code>$PAGER</code>, and then the default chosen at
4414         compile time (usually <em>less</em>).
4415 </p>
4416 <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
4417 (if <code>LESS</code> environment variable is set, Git does not change it at
4418 all).  If you want to selectively override Git&#8217;s default setting
4419 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
4420 be passed to the shell by Git, which will translate the final
4421 command to <code>LESS=FRX less -S</code>. The environment does not set the
4422 <code>S</code> option but the command line does, instructing less to truncate
4423 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
4424 deactivate the <code>F</code> option specified by the environment from the
4425 command-line, deactivating the "quit if one screen" behavior of
4426 <code>less</code>.  One can specifically activate some flags for particular
4427 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
4428 line truncation only for <code>git blame</code>.</p></div>
4429 <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
4430 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
4431 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
4432 </dd>
4433 <dt class="hdlist1">
4434 core.whitespace
4435 </dt>
4436 <dd>
4437 <p>
4438         A comma separated list of common whitespace problems to
4439         notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
4440         highlight them, and <em>git apply --whitespace=error</em> will
4441         consider them as errors.  You can prefix <code>-</code> to disable
4442         any of them (e.g. <code>-trailing-space</code>):
4443 </p>
4444 <div class="ulist"><ul>
4445 <li>
4446 <p>
4447 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
4448   as an error (enabled by default).
4449 </p>
4450 </li>
4451 <li>
4452 <p>
4453 <code>space-before-tab</code> treats a space character that appears immediately
4454   before a tab character in the initial indent part of the line as an
4455   error (enabled by default).
4456 </p>
4457 </li>
4458 <li>
4459 <p>
4460 <code>indent-with-non-tab</code> treats a line that is indented with space
4461   characters instead of the equivalent tabs as an error (not enabled by
4462   default).
4463 </p>
4464 </li>
4465 <li>
4466 <p>
4467 <code>tab-in-indent</code> treats a tab character in the initial indent part of
4468   the line as an error (not enabled by default).
4469 </p>
4470 </li>
4471 <li>
4472 <p>
4473 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
4474   (enabled by default).
4475 </p>
4476 </li>
4477 <li>
4478 <p>
4479 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
4480   <code>blank-at-eof</code>.
4481 </p>
4482 </li>
4483 <li>
4484 <p>
4485 <code>cr-at-eol</code> treats a carriage-return at the end of line as
4486   part of the line terminator, i.e. with it, <code>trailing-space</code>
4487   does not trigger if the character before such a carriage-return
4488   is not a whitespace (not enabled by default).
4489 </p>
4490 </li>
4491 <li>
4492 <p>
4493 <code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
4494   is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
4495   errors. The default tab width is 8. Allowed values are 1 to 63.
4496 </p>
4497 </li>
4498 </ul></div>
4499 </dd>
4500 <dt class="hdlist1">
4501 core.fsync
4502 </dt>
4503 <dd>
4504 <p>
4505         A comma-separated list of components of the repository that
4506         should be hardened via the core.fsyncMethod when created or
4507         modified.  You can disable hardening of any component by
4508         prefixing it with a <em>-</em>.  Items that are not hardened may be
4509         lost in the event of an unclean system shutdown. Unless you
4510         have special requirements, it is recommended that you leave
4511         this option empty or pick one of <code>committed</code>, <code>added</code>,
4512         or <code>all</code>.
4513 </p>
4514 <div class="paragraph"><p>When this configuration is encountered, the set of components starts with
4515 the platform default value, disabled components are removed, and additional
4516 components are added. <code>none</code> resets the state so that the platform default
4517 is ignored.</p></div>
4518 <div class="paragraph"><p>The empty string resets the fsync configuration to the platform
4519 default. The default on most platforms is equivalent to
4520 <code>core.fsync=committed,-loose-object</code>, which has good performance,
4521 but risks losing recent work in the event of an unclean system shutdown.</p></div>
4522 <div class="ulist"><ul>
4523 <li>
4524 <p>
4525 <code>none</code> clears the set of fsynced components.
4526 </p>
4527 </li>
4528 <li>
4529 <p>
4530 <code>loose-object</code> hardens objects added to the repo in loose-object form.
4531 </p>
4532 </li>
4533 <li>
4534 <p>
4535 <code>pack</code> hardens objects added to the repo in packfile form.
4536 </p>
4537 </li>
4538 <li>
4539 <p>
4540 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
4541 </p>
4542 </li>
4543 <li>
4544 <p>
4545 <code>commit-graph</code> hardens the commit-graph file.
4546 </p>
4547 </li>
4548 <li>
4549 <p>
4550 <code>index</code> hardens the index when it is modified.
4551 </p>
4552 </li>
4553 <li>
4554 <p>
4555 <code>objects</code> is an aggregate option that is equivalent to
4556   <code>loose-object,pack</code>.
4557 </p>
4558 </li>
4559 <li>
4560 <p>
4561 <code>reference</code> hardens references modified in the repo.
4562 </p>
4563 </li>
4564 <li>
4565 <p>
4566 <code>derived-metadata</code> is an aggregate option that is equivalent to
4567   <code>pack-metadata,commit-graph</code>.
4568 </p>
4569 </li>
4570 <li>
4571 <p>
4572 <code>committed</code> is an aggregate option that is currently equivalent to
4573   <code>objects</code>. This mode sacrifices some performance to ensure that work
4574   that is committed to the repository with <code>git commit</code> or similar commands
4575   is hardened.
4576 </p>
4577 </li>
4578 <li>
4579 <p>
4580 <code>added</code> is an aggregate option that is currently equivalent to
4581   <code>committed,index</code>. This mode sacrifices additional performance to
4582   ensure that the results of commands like <code>git add</code> and similar operations
4583   are hardened.
4584 </p>
4585 </li>
4586 <li>
4587 <p>
4588 <code>all</code> is an aggregate option that syncs all individual components above.
4589 </p>
4590 </li>
4591 </ul></div>
4592 </dd>
4593 <dt class="hdlist1">
4594 core.fsyncMethod
4595 </dt>
4596 <dd>
4597 <p>
4598         A value indicating the strategy Git will use to harden repository data
4599         using fsync and related primitives.
4600 </p>
4601 <div class="ulist"><ul>
4602 <li>
4603 <p>
4604 <code>fsync</code> uses the fsync() system call or platform equivalents.
4605 </p>
4606 </li>
4607 <li>
4608 <p>
4609 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
4610   filesystem and storage hardware, data added to the repository may not be
4611   durable in the event of a system crash. This is the default mode on macOS.
4612 </p>
4613 </li>
4614 <li>
4615 <p>
4616 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
4617   updates in the disk writeback cache and then does a single full fsync of
4618   a dummy file to trigger the disk cache flush at the end of the operation.
4619 </p>
4620 <div class="paragraph"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
4621 data is made durable as if <code>fsync</code> was specified. This mode is expected to
4622 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
4623 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
4624 </li>
4625 </ul></div>
4626 </dd>
4627 <dt class="hdlist1">
4628 core.fsyncObjectFiles
4629 </dt>
4630 <dd>
4631 <p>
4632         This boolean will enable <em>fsync()</em> when writing object files.
4633         This setting is deprecated. Use core.fsync instead.
4634 </p>
4635 <div class="paragraph"><p>This setting affects data added to the Git repository in loose-object
4636 form. When set to true, Git will issue an fsync or similar system call
4637 to flush caches so that loose-objects remain consistent in the face
4638 of a unclean system shutdown.</p></div>
4639 </dd>
4640 <dt class="hdlist1">
4641 core.preloadIndex
4642 </dt>
4643 <dd>
4644 <p>
4645         Enable parallel index preload for operations like <em>git diff</em>
4646 </p>
4647 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
4648 on filesystems like NFS that have weak caching semantics and thus
4649 relatively high IO latencies.  When enabled, Git will do the
4650 index comparison to the filesystem data in parallel, allowing
4651 overlapping IO&#8217;s.  Defaults to true.</p></div>
4652 </dd>
4653 <dt class="hdlist1">
4654 core.unsetenvvars
4655 </dt>
4656 <dd>
4657 <p>
4658         Windows-only: comma-separated list of environment variables'
4659         names that need to be unset before spawning any other process.
4660         Defaults to <code>PERL5LIB</code> to account for the fact that Git for
4661         Windows insists on using its own Perl interpreter.
4662 </p>
4663 </dd>
4664 <dt class="hdlist1">
4665 core.restrictinheritedhandles
4666 </dt>
4667 <dd>
4668 <p>
4669         Windows-only: override whether spawned processes inherit only standard
4670         file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
4671         <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
4672         Windows 7 and later, and <code>false</code> on older Windows versions.
4673 </p>
4674 </dd>
4675 <dt class="hdlist1">
4676 core.createObject
4677 </dt>
4678 <dd>
4679 <p>
4680         You can set this to <em>link</em>, in which case a hardlink followed by
4681         a delete of the source are used to make sure that object creation
4682         will not overwrite existing objects.
4683 </p>
4684 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
4685 Set this config setting to <em>rename</em> there; however, this will remove the
4686 check that makes sure that existing object files will not get overwritten.</p></div>
4687 </dd>
4688 <dt class="hdlist1">
4689 core.notesRef
4690 </dt>
4691 <dd>
4692 <p>
4693         When showing commit messages, also show notes which are stored in
4694         the given ref.  The ref must be fully qualified.  If the given
4695         ref does not exist, it is not an error but means that no
4696         notes should be printed.
4697 </p>
4698 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
4699 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p></div>
4700 </dd>
4701 <dt class="hdlist1">
4702 core.commitGraph
4703 </dt>
4704 <dd>
4705 <p>
4706         If true, then git will read the commit-graph file (if it exists)
4707         to parse the graph structure of commits. Defaults to true. See
4708         <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
4709 </p>
4710 </dd>
4711 <dt class="hdlist1">
4712 core.useReplaceRefs
4713 </dt>
4714 <dd>
4715 <p>
4716         If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
4717         option was given on the command line. See <a href="git.html">git(1)</a> and
4718         <a href="git-replace.html">git-replace(1)</a> for more information.
4719 </p>
4720 </dd>
4721 <dt class="hdlist1">
4722 core.multiPackIndex
4723 </dt>
4724 <dd>
4725 <p>
4726         Use the multi-pack-index file to track multiple packfiles using a
4727         single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
4728         information. Defaults to true.
4729 </p>
4730 </dd>
4731 <dt class="hdlist1">
4732 core.sparseCheckout
4733 </dt>
4734 <dd>
4735 <p>
4736         Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
4737         for more information.
4738 </p>
4739 </dd>
4740 <dt class="hdlist1">
4741 core.sparseCheckoutCone
4742 </dt>
4743 <dd>
4744 <p>
4745         Enables the "cone mode" of the sparse checkout feature. When the
4746         sparse-checkout file contains a limited set of patterns, this
4747         mode provides significant performance advantages. The "non-cone
4748         mode" can be requested to allow specifying more flexible
4749         patterns by setting this variable to <em>false</em>. See
4750         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.
4751 </p>
4752 </dd>
4753 <dt class="hdlist1">
4754 core.abbrev
4755 </dt>
4756 <dd>
4757 <p>
4758         Set the length object names are abbreviated to.  If
4759         unspecified or set to "auto", an appropriate value is
4760         computed based on the approximate number of packed objects
4761         in your repository, which hopefully is enough for
4762         abbreviated object names to stay unique for some time.
4763         If set to "no", no abbreviation is made and the object names
4764         are shown in their full length.
4765         The minimum length is 4.
4766 </p>
4767 </dd>
4768 <dt class="hdlist1">
4769 core.maxTreeDepth
4770 </dt>
4771 <dd>
4772 <p>
4773         The maximum depth Git is willing to recurse while traversing a
4774         tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
4775         to allow Git to abort cleanly, and should not generally need to
4776         be adjusted. The default is 4096.
4777 </p>
4778 </dd>
4779 <dt class="hdlist1">
4780 credential.helper
4781 </dt>
4782 <dd>
4783 <p>
4784         Specify an external helper to be called when a username or
4785         password credential is needed; the helper may consult external
4786         storage to avoid prompting the user for the credentials. This is
4787         normally the name of a credential helper with possible
4788         arguments, but may also be an absolute path with arguments or, if
4789         preceded by <code>!</code>, shell commands.
4790 </p>
4791 <div class="paragraph"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
4792 for details and examples.</p></div>
4793 </dd>
4794 <dt class="hdlist1">
4795 credential.useHttpPath
4796 </dt>
4797 <dd>
4798 <p>
4799         When acquiring credentials, consider the "path" component of an http
4800         or https URL to be important. Defaults to false. See
4801         <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
4802 </p>
4803 </dd>
4804 <dt class="hdlist1">
4805 credential.username
4806 </dt>
4807 <dd>
4808 <p>
4809         If no username is set for a network authentication, use this username
4810         by default. See credential.&lt;context&gt;.* below, and
4811         <a href="gitcredentials.html">gitcredentials(7)</a>.
4812 </p>
4813 </dd>
4814 <dt class="hdlist1">
4815 credential.&lt;url&gt;.*
4816 </dt>
4817 <dd>
4818 <p>
4819         Any of the credential.* options above can be applied selectively to
4820         some credentials. For example, "credential.https://example.com.username"
4821         would set the default username only for https connections to
4822         example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
4823         matched.
4824 </p>
4825 </dd>
4826 <dt class="hdlist1">
4827 credentialCache.ignoreSIGHUP
4828 </dt>
4829 <dd>
4830 <p>
4831         Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
4832 </p>
4833 </dd>
4834 <dt class="hdlist1">
4835 credentialStore.lockTimeoutMS
4836 </dt>
4837 <dd>
4838 <p>
4839         The length of time, in milliseconds, for git-credential-store to retry
4840         when trying to lock the credentials file. A value of 0 means not to retry at
4841         all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
4842         1s).
4843 </p>
4844 </dd>
4845 <dt class="hdlist1">
4846 diff.autoRefreshIndex
4847 </dt>
4848 <dd>
4849 <p>
4850         When using <em>git diff</em> to compare with work tree
4851         files, do not consider stat-only changes as changed.
4852         Instead, silently run <code>git update-index --refresh</code> to
4853         update the cached stat information for paths whose
4854         contents in the work tree match the contents in the
4855         index.  This option defaults to true.  Note that this
4856         affects only <em>git diff</em> Porcelain, and not lower level
4857         <em>diff</em> commands such as <em>git diff-files</em>.
4858 </p>
4859 </dd>
4860 <dt class="hdlist1">
4861 diff.dirstat
4862 </dt>
4863 <dd>
4864 <p>
4865         A comma separated list of <code>--dirstat</code> parameters specifying the
4866         default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
4867         and friends. The defaults can be overridden on the command line
4868         (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
4869         (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
4870         The following parameters are available:
4871 </p>
4872 <div class="openblock">
4873 <div class="content">
4874 <div class="dlist"><dl>
4875 <dt class="hdlist1">
4876 <code>changes</code>
4877 </dt>
4878 <dd>
4879 <p>
4880         Compute the dirstat numbers by counting the lines that have been
4881         removed from the source, or added to the destination. This ignores
4882         the amount of pure code movements within a file.  In other words,
4883         rearranging lines in a file is not counted as much as other changes.
4884         This is the default behavior when no parameter is given.
4885 </p>
4886 </dd>
4887 <dt class="hdlist1">
4888 <code>lines</code>
4889 </dt>
4890 <dd>
4891 <p>
4892         Compute the dirstat numbers by doing the regular line-based diff
4893         analysis, and summing the removed/added line counts. (For binary
4894         files, count 64-byte chunks instead, since binary files have no
4895         natural concept of lines). This is a more expensive <code>--dirstat</code>
4896         behavior than the <code>changes</code> behavior, but it does count rearranged
4897         lines within a file as much as other changes. The resulting output
4898         is consistent with what you get from the other <code>--*stat</code> options.
4899 </p>
4900 </dd>
4901 <dt class="hdlist1">
4902 <code>files</code>
4903 </dt>
4904 <dd>
4905 <p>
4906         Compute the dirstat numbers by counting the number of files changed.
4907         Each changed file counts equally in the dirstat analysis. This is
4908         the computationally cheapest <code>--dirstat</code> behavior, since it does
4909         not have to look at the file contents at all.
4910 </p>
4911 </dd>
4912 <dt class="hdlist1">
4913 <code>cumulative</code>
4914 </dt>
4915 <dd>
4916 <p>
4917         Count changes in a child directory for the parent directory as well.
4918         Note that when using <code>cumulative</code>, the sum of the percentages
4919         reported may exceed 100%. The default (non-cumulative) behavior can
4920         be specified with the <code>noncumulative</code> parameter.
4921 </p>
4922 </dd>
4923 <dt class="hdlist1">
4924 &lt;limit&gt;
4925 </dt>
4926 <dd>
4927 <p>
4928         An integer parameter specifies a cut-off percent (3% by default).
4929         Directories contributing less than this percentage of the changes
4930         are not shown in the output.
4931 </p>
4932 </dd>
4933 </dl></div>
4934 </div></div>
4935 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
4936 directories with less than 10% of the total amount of changed files,
4937 and accumulating child directory counts in the parent directories:
4938 <code>files,10,cumulative</code>.</p></div>
4939 </dd>
4940 <dt class="hdlist1">
4941 diff.statNameWidth
4942 </dt>
4943 <dd>
4944 <p>
4945         Limit the width of the filename part in --stat output. If set, applies
4946         to all commands generating --stat output except format-patch.
4947 </p>
4948 </dd>
4949 <dt class="hdlist1">
4950 diff.statGraphWidth
4951 </dt>
4952 <dd>
4953 <p>
4954         Limit the width of the graph part in --stat output. If set, applies
4955         to all commands generating --stat output except format-patch.
4956 </p>
4957 </dd>
4958 <dt class="hdlist1">
4959 diff.context
4960 </dt>
4961 <dd>
4962 <p>
4963         Generate diffs with &lt;n&gt; lines of context instead of the default
4964         of 3. This value is overridden by the -U option.
4965 </p>
4966 </dd>
4967 <dt class="hdlist1">
4968 diff.interHunkContext
4969 </dt>
4970 <dd>
4971 <p>
4972         Show the context between diff hunks, up to the specified number
4973         of lines, thereby fusing the hunks that are close to each other.
4974         This value serves as the default for the <code>--inter-hunk-context</code>
4975         command line option.
4976 </p>
4977 </dd>
4978 <dt class="hdlist1">
4979 diff.external
4980 </dt>
4981 <dd>
4982 <p>
4983         If this config variable is set, diff generation is not
4984         performed using the internal diff machinery, but using the
4985         given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
4986         environment variable.  The command is called with parameters
4987         as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
4988         you want to use an external diff program only on a subset of
4989         your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
4990 </p>
4991 </dd>
4992 <dt class="hdlist1">
4993 diff.ignoreSubmodules
4994 </dt>
4995 <dd>
4996 <p>
4997         Sets the default value of --ignore-submodules. Note that this
4998         affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
4999         commands such as <em>git diff-files</em>. <em>git checkout</em>
5000         and <em>git switch</em> also honor
5001         this setting when reporting uncommitted changes. Setting it to
5002         <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
5003         and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
5004         overridden by using the --ignore-submodules command-line option.
5005         The <em>git submodule</em> commands are not affected by this setting.
5006         By default this is set to untracked so that any untracked
5007         submodules are ignored.
5008 </p>
5009 </dd>
5010 <dt class="hdlist1">
5011 diff.mnemonicPrefix
5012 </dt>
5013 <dd>
5014 <p>
5015         If set, <em>git diff</em> uses a prefix pair that is different from the
5016         standard "a/" and "b/" depending on what is being compared.  When
5017         this configuration is in effect, reverse diff output also swaps
5018         the order of the prefixes:
5019 </p>
5020 <div class="dlist"><dl>
5021 <dt class="hdlist1">
5022 <code>git diff</code>
5023 </dt>
5024 <dd>
5025 <p>
5026         compares the (i)ndex and the (w)ork tree;
5027 </p>
5028 </dd>
5029 <dt class="hdlist1">
5030 <code>git diff HEAD</code>
5031 </dt>
5032 <dd>
5033 <p>
5034          compares a (c)ommit and the (w)ork tree;
5035 </p>
5036 </dd>
5037 <dt class="hdlist1">
5038 <code>git diff --cached</code>
5039 </dt>
5040 <dd>
5041 <p>
5042         compares a (c)ommit and the (i)ndex;
5043 </p>
5044 </dd>
5045 <dt class="hdlist1">
5046 <code>git diff HEAD:file1 file2</code>
5047 </dt>
5048 <dd>
5049 <p>
5050         compares an (o)bject and a (w)ork tree entity;
5051 </p>
5052 </dd>
5053 <dt class="hdlist1">
5054 <code>git diff --no-index a b</code>
5055 </dt>
5056 <dd>
5057 <p>
5058         compares two non-git things (1) and (2).
5059 </p>
5060 </dd>
5061 </dl></div>
5062 </dd>
5063 <dt class="hdlist1">
5064 diff.noPrefix
5065 </dt>
5066 <dd>
5067 <p>
5068         If set, <em>git diff</em> does not show any source or destination prefix.
5069 </p>
5070 </dd>
5071 <dt class="hdlist1">
5072 diff.srcPrefix
5073 </dt>
5074 <dd>
5075 <p>
5076         If set, <em>git diff</em> uses this source prefix. Defaults to "a/".
5077 </p>
5078 </dd>
5079 <dt class="hdlist1">
5080 diff.dstPrefix
5081 </dt>
5082 <dd>
5083 <p>
5084         If set, <em>git diff</em> uses this destination prefix. Defaults to "b/".
5085 </p>
5086 </dd>
5087 <dt class="hdlist1">
5088 diff.relative
5089 </dt>
5090 <dd>
5091 <p>
5092         If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
5093         and show pathnames relative to the current directory.
5094 </p>
5095 </dd>
5096 <dt class="hdlist1">
5097 diff.orderFile
5098 </dt>
5099 <dd>
5100 <p>
5101         File indicating how to order files within a diff.
5102         See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
5103         If <code>diff.orderFile</code> is a relative pathname, it is treated as
5104         relative to the top of the working tree.
5105 </p>
5106 </dd>
5107 <dt class="hdlist1">
5108 diff.renameLimit
5109 </dt>
5110 <dd>
5111 <p>
5112         The number of files to consider in the exhaustive portion of
5113         copy/rename detection; equivalent to the <em>git diff</em> option
5114         <code>-l</code>.  If not set, the default value is currently 1000.  This
5115         setting has no effect if rename detection is turned off.
5116 </p>
5117 </dd>
5118 <dt class="hdlist1">
5119 diff.renames
5120 </dt>
5121 <dd>
5122 <p>
5123         Whether and how Git detects renames.  If set to "false",
5124         rename detection is disabled. If set to "true", basic rename
5125         detection is enabled.  If set to "copies" or "copy", Git will
5126         detect copies, as well.  Defaults to true.  Note that this
5127         affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
5128         <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
5129         <a href="git-diff-files.html">git-diff-files(1)</a>.
5130 </p>
5131 </dd>
5132 <dt class="hdlist1">
5133 diff.suppressBlankEmpty
5134 </dt>
5135 <dd>
5136 <p>
5137         A boolean to inhibit the standard behavior of printing a space
5138         before each empty output line. Defaults to false.
5139 </p>
5140 </dd>
5141 <dt class="hdlist1">
5142 diff.submodule
5143 </dt>
5144 <dd>
5145 <p>
5146         Specify the format in which differences in submodules are
5147         shown.  The "short" format just shows the names of the commits
5148         at the beginning and end of the range. The "log" format lists
5149         the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
5150         does. The "diff" format shows an inline diff of the changed
5151         contents of the submodule. Defaults to "short".
5152 </p>
5153 </dd>
5154 <dt class="hdlist1">
5155 diff.wordRegex
5156 </dt>
5157 <dd>
5158 <p>
5159         A POSIX Extended Regular Expression used to determine what is a "word"
5160         when performing word-by-word difference calculations.  Character
5161         sequences that match the regular expression are "words", all other
5162         characters are <strong>ignorable</strong> whitespace.
5163 </p>
5164 </dd>
5165 <dt class="hdlist1">
5166 diff.&lt;driver&gt;.command
5167 </dt>
5168 <dd>
5169 <p>
5170         The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
5171         for details.
5172 </p>
5173 </dd>
5174 <dt class="hdlist1">
5175 diff.&lt;driver&gt;.xfuncname
5176 </dt>
5177 <dd>
5178 <p>
5179         The regular expression that the diff driver should use to
5180         recognize the hunk header.  A built-in pattern may also be used.
5181         See <a href="gitattributes.html">gitattributes(5)</a> for details.
5182 </p>
5183 </dd>
5184 <dt class="hdlist1">
5185 diff.&lt;driver&gt;.binary
5186 </dt>
5187 <dd>
5188 <p>
5189         Set this option to true to make the diff driver treat files as
5190         binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5191 </p>
5192 </dd>
5193 <dt class="hdlist1">
5194 diff.&lt;driver&gt;.textconv
5195 </dt>
5196 <dd>
5197 <p>
5198         The command that the diff driver should call to generate the
5199         text-converted version of a file.  The result of the
5200         conversion is used to generate a human-readable diff.  See
5201         <a href="gitattributes.html">gitattributes(5)</a> for details.
5202 </p>
5203 </dd>
5204 <dt class="hdlist1">
5205 diff.&lt;driver&gt;.wordRegex
5206 </dt>
5207 <dd>
5208 <p>
5209         The regular expression that the diff driver should use to
5210         split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
5211         details.
5212 </p>
5213 </dd>
5214 <dt class="hdlist1">
5215 diff.&lt;driver&gt;.cachetextconv
5216 </dt>
5217 <dd>
5218 <p>
5219         Set this option to true to make the diff driver cache the text
5220         conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5221 </p>
5222 <div class="dlist"><dl>
5223 <dt class="hdlist1">
5224 <code>araxis</code>
5225 </dt>
5226 <dd>
5227 <p>
5228 Use Araxis Merge (requires a graphical session)
5229 </p>
5230 </dd>
5231 <dt class="hdlist1">
5232 <code>bc</code>
5233 </dt>
5234 <dd>
5235 <p>
5236 Use Beyond Compare (requires a graphical session)
5237 </p>
5238 </dd>
5239 <dt class="hdlist1">
5240 <code>bc3</code>
5241 </dt>
5242 <dd>
5243 <p>
5244 Use Beyond Compare (requires a graphical session)
5245 </p>
5246 </dd>
5247 <dt class="hdlist1">
5248 <code>bc4</code>
5249 </dt>
5250 <dd>
5251 <p>
5252 Use Beyond Compare (requires a graphical session)
5253 </p>
5254 </dd>
5255 <dt class="hdlist1">
5256 <code>codecompare</code>
5257 </dt>
5258 <dd>
5259 <p>
5260 Use Code Compare (requires a graphical session)
5261 </p>
5262 </dd>
5263 <dt class="hdlist1">
5264 <code>deltawalker</code>
5265 </dt>
5266 <dd>
5267 <p>
5268 Use DeltaWalker (requires a graphical session)
5269 </p>
5270 </dd>
5271 <dt class="hdlist1">
5272 <code>diffmerge</code>
5273 </dt>
5274 <dd>
5275 <p>
5276 Use DiffMerge (requires a graphical session)
5277 </p>
5278 </dd>
5279 <dt class="hdlist1">
5280 <code>diffuse</code>
5281 </dt>
5282 <dd>
5283 <p>
5284 Use Diffuse (requires a graphical session)
5285 </p>
5286 </dd>
5287 <dt class="hdlist1">
5288 <code>ecmerge</code>
5289 </dt>
5290 <dd>
5291 <p>
5292 Use ECMerge (requires a graphical session)
5293 </p>
5294 </dd>
5295 <dt class="hdlist1">
5296 <code>emerge</code>
5297 </dt>
5298 <dd>
5299 <p>
5300 Use Emacs' Emerge
5301 </p>
5302 </dd>
5303 <dt class="hdlist1">
5304 <code>examdiff</code>
5305 </dt>
5306 <dd>
5307 <p>
5308 Use ExamDiff Pro (requires a graphical session)
5309 </p>
5310 </dd>
5311 <dt class="hdlist1">
5312 <code>guiffy</code>
5313 </dt>
5314 <dd>
5315 <p>
5316 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
5317 </p>
5318 </dd>
5319 <dt class="hdlist1">
5320 <code>gvimdiff</code>
5321 </dt>
5322 <dd>
5323 <p>
5324 Use gVim (requires a graphical session)
5325 </p>
5326 </dd>
5327 <dt class="hdlist1">
5328 <code>kdiff3</code>
5329 </dt>
5330 <dd>
5331 <p>
5332 Use KDiff3 (requires a graphical session)
5333 </p>
5334 </dd>
5335 <dt class="hdlist1">
5336 <code>kompare</code>
5337 </dt>
5338 <dd>
5339 <p>
5340 Use Kompare (requires a graphical session)
5341 </p>
5342 </dd>
5343 <dt class="hdlist1">
5344 <code>meld</code>
5345 </dt>
5346 <dd>
5347 <p>
5348 Use Meld (requires a graphical session)
5349 </p>
5350 </dd>
5351 <dt class="hdlist1">
5352 <code>nvimdiff</code>
5353 </dt>
5354 <dd>
5355 <p>
5356 Use Neovim
5357 </p>
5358 </dd>
5359 <dt class="hdlist1">
5360 <code>opendiff</code>
5361 </dt>
5362 <dd>
5363 <p>
5364 Use FileMerge (requires a graphical session)
5365 </p>
5366 </dd>
5367 <dt class="hdlist1">
5368 <code>p4merge</code>
5369 </dt>
5370 <dd>
5371 <p>
5372 Use HelixCore P4Merge (requires a graphical session)
5373 </p>
5374 </dd>
5375 <dt class="hdlist1">
5376 <code>smerge</code>
5377 </dt>
5378 <dd>
5379 <p>
5380 Use Sublime Merge (requires a graphical session)
5381 </p>
5382 </dd>
5383 <dt class="hdlist1">
5384 <code>tkdiff</code>
5385 </dt>
5386 <dd>
5387 <p>
5388 Use TkDiff (requires a graphical session)
5389 </p>
5390 </dd>
5391 <dt class="hdlist1">
5392 <code>vimdiff</code>
5393 </dt>
5394 <dd>
5395 <p>
5396 Use Vim
5397 </p>
5398 </dd>
5399 <dt class="hdlist1">
5400 <code>winmerge</code>
5401 </dt>
5402 <dd>
5403 <p>
5404 Use WinMerge (requires a graphical session)
5405 </p>
5406 </dd>
5407 <dt class="hdlist1">
5408 <code>xxdiff</code>
5409 </dt>
5410 <dd>
5411 <p>
5412 Use xxdiff (requires a graphical session)
5413 </p>
5414 </dd>
5415 </dl></div>
5416 </dd>
5417 <dt class="hdlist1">
5418 diff.indentHeuristic
5419 </dt>
5420 <dd>
5421 <p>
5422         Set this option to <code>false</code> to disable the default heuristics
5423         that shift diff hunk boundaries to make patches easier to read.
5424 </p>
5425 </dd>
5426 <dt class="hdlist1">
5427 diff.algorithm
5428 </dt>
5429 <dd>
5430 <p>
5431         Choose a diff algorithm.  The variants are as follows:
5432 </p>
5433 <div class="openblock">
5434 <div class="content">
5435 <div class="dlist"><dl>
5436 <dt class="hdlist1">
5437 <code>default</code>, <code>myers</code>
5438 </dt>
5439 <dd>
5440 <p>
5441         The basic greedy diff algorithm. Currently, this is the default.
5442 </p>
5443 </dd>
5444 <dt class="hdlist1">
5445 <code>minimal</code>
5446 </dt>
5447 <dd>
5448 <p>
5449         Spend extra time to make sure the smallest possible diff is
5450         produced.
5451 </p>
5452 </dd>
5453 <dt class="hdlist1">
5454 <code>patience</code>
5455 </dt>
5456 <dd>
5457 <p>
5458         Use "patience diff" algorithm when generating patches.
5459 </p>
5460 </dd>
5461 <dt class="hdlist1">
5462 <code>histogram</code>
5463 </dt>
5464 <dd>
5465 <p>
5466         This algorithm extends the patience algorithm to "support
5467         low-occurrence common elements".
5468 </p>
5469 </dd>
5470 </dl></div>
5471 </div></div>
5472 </dd>
5473 <dt class="hdlist1">
5474 diff.wsErrorHighlight
5475 </dt>
5476 <dd>
5477 <p>
5478         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5479         lines of the diff.  Multiple values are separated by comma,
5480         <code>none</code> resets previous values, <code>default</code> reset the list to
5481         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
5482         whitespace errors are colored with <code>color.diff.whitespace</code>.
5483         The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
5484         overrides this setting.
5485 </p>
5486 </dd>
5487 <dt class="hdlist1">
5488 diff.colorMoved
5489 </dt>
5490 <dd>
5491 <p>
5492         If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
5493         in a diff are colored differently, for details of valid modes
5494         see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
5495         true the default color mode will be used. When set to false,
5496         moved lines are not colored.
5497 </p>
5498 </dd>
5499 <dt class="hdlist1">
5500 diff.colorMovedWS
5501 </dt>
5502 <dd>
5503 <p>
5504         When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5505         this option controls the <code>&lt;mode&gt;</code> how spaces are treated.
5506         For details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.
5507 </p>
5508 </dd>
5509 <dt class="hdlist1">
5510 diff.tool
5511 </dt>
5512 <dd>
5513 <p>
5514         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
5515         This variable overrides the value configured in <code>merge.tool</code>.
5516         The list below shows the valid built-in values.
5517         Any other value is treated as a custom diff tool and requires
5518         that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
5519 </p>
5520 </dd>
5521 <dt class="hdlist1">
5522 diff.guitool
5523 </dt>
5524 <dd>
5525 <p>
5526         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
5527         the -g/--gui flag is specified. This variable overrides the value
5528         configured in <code>merge.guitool</code>. The list below shows the valid
5529         built-in values. Any other value is treated as a custom diff tool
5530         and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
5531         is defined.
5532 </p>
5533 </dd>
5534 <dt class="hdlist1">
5535 difftool.&lt;tool&gt;.cmd
5536 </dt>
5537 <dd>
5538 <p>
5539         Specify the command to invoke the specified diff tool.
5540         The specified command is evaluated in shell with the following
5541         variables available:  <em>LOCAL</em> is set to the name of the temporary
5542         file containing the contents of the diff pre-image and <em>REMOTE</em>
5543         is set to the name of the temporary file containing the contents
5544         of the diff post-image.
5545 </p>
5546 <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>
5547 </dd>
5548 <dt class="hdlist1">
5549 difftool.&lt;tool&gt;.path
5550 </dt>
5551 <dd>
5552 <p>
5553         Override the path for the given tool.  This is useful in case
5554         your tool is not in the PATH.
5555 </p>
5556 </dd>
5557 <dt class="hdlist1">
5558 difftool.trustExitCode
5559 </dt>
5560 <dd>
5561 <p>
5562         Exit difftool if the invoked diff tool returns a non-zero exit status.
5563 </p>
5564 <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>
5565 </dd>
5566 <dt class="hdlist1">
5567 difftool.prompt
5568 </dt>
5569 <dd>
5570 <p>
5571         Prompt before each invocation of the diff tool.
5572 </p>
5573 </dd>
5574 <dt class="hdlist1">
5575 difftool.guiDefault
5576 </dt>
5577 <dd>
5578 <p>
5579         Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5580         the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5581         depending on the presence of a <code>DISPLAY</code> environment variable value. The
5582         default is <code>false</code>, where the <code>--gui</code> argument must be provided
5583         explicitly for the <code>diff.guitool</code> to be used.
5584 </p>
5585 </dd>
5586 <dt class="hdlist1">
5587 extensions.objectFormat
5588 </dt>
5589 <dd>
5590 <p>
5591         Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
5592         <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
5593         this key unless <code>core.repositoryFormatVersion</code> is 1.
5594 </p>
5595 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5596 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
5597 work and will produce hard-to-diagnose issues.</p></div>
5598 </dd>
5599 <dt class="hdlist1">
5600 extensions.compatObjectFormat
5601 </dt>
5602 <dd>
5603 <p>
5604         Specify a compatitbility hash algorithm to use.  The acceptable values
5605         are <code>sha1</code> and <code>sha256</code>.  The value specified must be different from the
5606         value of extensions.objectFormat.  This allows client level
5607         interoperability between git repositories whose objectFormat matches
5608         this compatObjectFormat.  In particular when fully implemented the
5609         pushes and pulls from a repository in whose objectFormat matches
5610         compatObjectFormat.  As well as being able to use oids encoded in
5611         compatObjectFormat in addition to oids encoded with objectFormat to
5612         locally specify objects.
5613 </p>
5614 </dd>
5615 <dt class="hdlist1">
5616 extensions.refStorage
5617 </dt>
5618 <dd>
5619 <p>
5620         Specify the ref storage format to use. The acceptable values are:
5621 </p>
5622 <div class="ulist"><ul>
5623 <li>
5624 <p>
5625 <code>files</code> for loose files with packed-refs. This is the default.
5626 </p>
5627 </li>
5628 <li>
5629 <p>
5630 <code>reftable</code> for the reftable format. This format is experimental and its
5631   internals are subject to change.
5632 </p>
5633 <div class="paragraph"><p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p></div>
5634 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5635 <a href="git-clone.html">git-clone(1)</a>. Trying to change it after initialization will not
5636 work and will produce hard-to-diagnose issues.</p></div>
5637 </li>
5638 </ul></div>
5639 </dd>
5640 <dt class="hdlist1">
5641 extensions.worktreeConfig
5642 </dt>
5643 <dd>
5644 <p>
5645         If enabled, then worktrees will load config settings from the
5646         <code>$GIT_DIR/config.worktree</code> file in addition to the
5647         <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5648         <code>$GIT_DIR</code> are the same for the main working tree, while other
5649         working trees have <code>$GIT_DIR</code> equal to
5650         <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
5651         <code>config.worktree</code> file will override settings from any other
5652         config files.
5653 </p>
5654 <div class="paragraph"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5655 certain values from the common config file to the main working tree&#8217;s
5656 <code>config.worktree</code> file, if present:</p></div>
5657 <div class="ulist"><ul>
5658 <li>
5659 <p>
5660 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5661   <code>$GIT_COMMON_DIR/config.worktree</code>.
5662 </p>
5663 </li>
5664 <li>
5665 <p>
5666 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5667   to <code>$GIT_COMMON_DIR/config.worktree</code>.
5668 </p>
5669 <div class="paragraph"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5670 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5671 sparse-checkout settings for each worktree. By default, the <code>git
5672 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5673 these config values on a per-worktree basis, and uses the
5674 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5675 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
5676 details.</p></div>
5677 <div class="paragraph"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5678 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5679 </li>
5680 </ul></div>
5681 </dd>
5682 <dt class="hdlist1">
5683 fastimport.unpackLimit
5684 </dt>
5685 <dd>
5686 <p>
5687         If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
5688         is below this limit, then the objects will be unpacked into
5689         loose object files.  However, if the number of imported objects
5690         equals or exceeds this limit, then the pack will be stored as a
5691         pack.  Storing the pack from a fast-import can make the import
5692         operation complete faster, especially on slow filesystems.  If
5693         not set, the value of <code>transfer.unpackLimit</code> is used instead.
5694 </p>
5695 </dd>
5696 <dt class="hdlist1">
5697 feature.*
5698 </dt>
5699 <dd>
5700 <p>
5701         The config settings that start with <code>feature.</code> modify the defaults of
5702         a group of other config settings. These groups are created by the Git
5703         developer community as recommended defaults and are subject to change.
5704         In particular, new config options may be added with different defaults.
5705 </p>
5706 </dd>
5707 <dt class="hdlist1">
5708 feature.experimental
5709 </dt>
5710 <dd>
5711 <p>
5712         Enable config options that are new to Git, and are being considered for
5713         future defaults. Config settings included here may be added or removed
5714         with each release, including minor version updates. These settings may
5715         have unintended interactions since they are so new. Please enable this
5716         setting if you are interested in providing feedback on experimental
5717         features. The new default values are:
5718 </p>
5719 <div class="ulist"><ul>
5720 <li>
5721 <p>
5722 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5723 skipping more commits at a time, reducing the number of round trips.
5724 </p>
5725 </li>
5726 <li>
5727 <p>
5728 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5729 walking fewer objects.
5730 </p>
5731 </li>
5732 <li>
5733 <p>
5734 <code>pack.allowPackReuse=multi</code> may improve the time it takes to create a pack by
5735 reusing objects from multiple packs instead of just one.
5736 </p>
5737 </li>
5738 </ul></div>
5739 </dd>
5740 <dt class="hdlist1">
5741 feature.manyFiles
5742 </dt>
5743 <dd>
5744 <p>
5745         Enable config options that optimize for repos with many files in the
5746         working directory. With many files, commands such as <code>git status</code> and
5747         <code>git checkout</code> may be slow and these new defaults improve performance:
5748 </p>
5749 <div class="ulist"><ul>
5750 <li>
5751 <p>
5752 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5753   checksum. Note that this will cause Git versions earlier than 2.13.0 to
5754   refuse to parse the index and Git versions earlier than 2.40.0 will report
5755   a corrupted index during <code>git fsck</code>.
5756 </p>
5757 </li>
5758 <li>
5759 <p>
5760 <code>index.version=4</code> enables path-prefix compression in the index.
5761 </p>
5762 </li>
5763 <li>
5764 <p>
5765 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5766 that mtime is working on your machine.
5767 </p>
5768 </li>
5769 </ul></div>
5770 </dd>
5771 <dt class="hdlist1">
5772 fetch.recurseSubmodules
5773 </dt>
5774 <dd>
5775 <p>
5776         This option controls whether <code>git fetch</code> (and the underlying fetch
5777         in <code>git pull</code>) will recursively fetch into populated submodules.
5778         This option can be set either to a boolean value or to <em>on-demand</em>.
5779         Setting it to a boolean changes the behavior of fetch and pull to
5780         recurse unconditionally into submodules when set to true or to not
5781         recurse at all when set to false. When set to <em>on-demand</em>, fetch and
5782         pull will only recurse into a populated submodule when its
5783         superproject retrieves a commit that updates the submodule&#8217;s
5784         reference.
5785         Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
5786 </p>
5787 </dd>
5788 <dt class="hdlist1">
5789 fetch.fsckObjects
5790 </dt>
5791 <dd>
5792 <p>
5793         If it is set to true, git-fetch-pack will check all fetched
5794         objects. See <code>transfer.fsckObjects</code> for what&#8217;s
5795         checked. Defaults to false. If not set, the value of
5796         <code>transfer.fsckObjects</code> is used instead.
5797 </p>
5798 </dd>
5799 <dt class="hdlist1">
5800 fetch.fsck.&lt;msg-id&gt;
5801 </dt>
5802 <dd>
5803 <p>
5804         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
5805         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5806         the <code>fsck.&lt;msg-id&gt;</code> documentation for details.
5807 </p>
5808 </dd>
5809 <dt class="hdlist1">
5810 fetch.fsck.skipList
5811 </dt>
5812 <dd>
5813 <p>
5814         Acts like <code>fsck.skipList</code>, but is used by
5815         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5816         the <code>fsck.skipList</code> documentation for details.
5817 </p>
5818 </dd>
5819 <dt class="hdlist1">
5820 fetch.unpackLimit
5821 </dt>
5822 <dd>
5823 <p>
5824         If the number of objects fetched over the Git native
5825         transfer is below this
5826         limit, then the objects will be unpacked into loose object
5827         files. However if the number of received objects equals or
5828         exceeds this limit then the received pack will be stored as
5829         a pack, after adding any missing delta bases.  Storing the
5830         pack from a push can make the push operation complete faster,
5831         especially on slow filesystems.  If not set, the value of
5832         <code>transfer.unpackLimit</code> is used instead.
5833 </p>
5834 </dd>
5835 <dt class="hdlist1">
5836 fetch.prune
5837 </dt>
5838 <dd>
5839 <p>
5840         If true, fetch will automatically behave as if the <code>--prune</code>
5841         option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
5842         and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.
5843 </p>
5844 </dd>
5845 <dt class="hdlist1">
5846 fetch.pruneTags
5847 </dt>
5848 <dd>
5849 <p>
5850         If true, fetch will automatically behave as if the
5851         <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
5852         if not set already. This allows for setting both this option
5853         and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
5854         refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
5855         section of <a href="git-fetch.html">git-fetch(1)</a>.
5856 </p>
5857 </dd>
5858 <dt class="hdlist1">
5859 fetch.all
5860 </dt>
5861 <dd>
5862 <p>
5863         If true, fetch will attempt to update all available remotes.
5864         This behavior can be overridden by passing <code>--no-all</code> or by
5865         explicitly specifying one or more remote(s) to fetch from.
5866         Defaults to false.
5867 </p>
5868 </dd>
5869 <dt class="hdlist1">
5870 fetch.output
5871 </dt>
5872 <dd>
5873 <p>
5874         Control how ref update status is printed. Valid values are
5875         <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
5876         OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.
5877 </p>
5878 </dd>
5879 <dt class="hdlist1">
5880 fetch.negotiationAlgorithm
5881 </dt>
5882 <dd>
5883 <p>
5884         Control how information about the commits in the local repository
5885         is sent when negotiating the contents of the packfile to be sent by
5886         the server.  Set to "consecutive" to use an algorithm that walks
5887         over consecutive commits checking each one.  Set to "skipping" to
5888         use an algorithm that skips commits in an effort to converge
5889         faster, but may result in a larger-than-necessary packfile; or set
5890         to "noop" to not send any information at all, which will almost
5891         certainly result in a larger-than-necessary packfile, but will skip
5892         the negotiation step.  Set to "default" to override settings made
5893         previously and use the default behaviour.  The default is normally
5894         "consecutive", but if <code>feature.experimental</code> is true, then the
5895         default is "skipping".  Unknown values will cause <em>git fetch</em> to
5896         error out.
5897 </p>
5898 <div class="paragraph"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
5899 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
5900 </dd>
5901 <dt class="hdlist1">
5902 fetch.showForcedUpdates
5903 </dt>
5904 <dd>
5905 <p>
5906         Set to false to enable <code>--no-show-forced-updates</code> in
5907         <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
5908         Defaults to true.
5909 </p>
5910 </dd>
5911 <dt class="hdlist1">
5912 fetch.parallel
5913 </dt>
5914 <dd>
5915 <p>
5916         Specifies the maximal number of fetch operations to be run in parallel
5917         at a time (submodules, or remotes when the <code>--multiple</code> option of
5918         <a href="git-fetch.html">git-fetch(1)</a> is in effect).
5919 </p>
5920 <div class="paragraph"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
5921 <div class="paragraph"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
5922 config setting.</p></div>
5923 </dd>
5924 <dt class="hdlist1">
5925 fetch.writeCommitGraph
5926 </dt>
5927 <dd>
5928 <p>
5929         Set to true to write a commit-graph after every <code>git fetch</code> command
5930         that downloads a pack-file from a remote. Using the <code>--split</code> option,
5931         most executions will create a very small commit-graph file on top of
5932         the existing commit-graph file(s). Occasionally, these files will
5933         merge and the write may take longer. Having an updated commit-graph
5934         file helps performance of many Git commands, including <code>git merge-base</code>,
5935         <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
5936 </p>
5937 </dd>
5938 <dt class="hdlist1">
5939 fetch.bundleURI
5940 </dt>
5941 <dd>
5942 <p>
5943         This value stores a URI for downloading Git object data from a bundle
5944         URI before performing an incremental fetch from the origin Git server.
5945         This is similar to how the <code>--bundle-uri</code> option behaves in
5946         <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
5947         <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
5948         list that is organized for incremental fetches.
5949 </p>
5950 <div class="paragraph"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
5951 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
5952 the new bundle URI.</p></div>
5953 </dd>
5954 <dt class="hdlist1">
5955 fetch.bundleCreationToken
5956 </dt>
5957 <dd>
5958 <p>
5959         When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
5960         list that uses the "creationToken" heuristic, this config value
5961         stores the maximum <code>creationToken</code> value of the downloaded bundles.
5962         This value is used to prevent downloading bundles in the future
5963         if the advertised <code>creationToken</code> is not strictly larger than this
5964         value.
5965 </p>
5966 <div class="paragraph"><p>The creation token values are chosen by the provider serving the specific
5967 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
5968 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
5969 </dd>
5970 <dt class="hdlist1">
5971 filter.&lt;driver&gt;.clean
5972 </dt>
5973 <dd>
5974 <p>
5975         The command which is used to convert the content of a worktree
5976         file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
5977         details.
5978 </p>
5979 </dd>
5980 <dt class="hdlist1">
5981 filter.&lt;driver&gt;.smudge
5982 </dt>
5983 <dd>
5984 <p>
5985         The command which is used to convert the content of a blob
5986         object to a worktree file upon checkout.  See
5987         <a href="gitattributes.html">gitattributes(5)</a> for details.
5988 </p>
5989 </dd>
5990 <dt class="hdlist1">
5991 format.attach
5992 </dt>
5993 <dd>
5994 <p>
5995         Enable multipart/mixed attachments as the default for
5996         <em>format-patch</em>.  The value can also be a double quoted string
5997         which will enable attachments as the default and set the
5998         value as the boundary.  See the --attach option in
5999         <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
6000         value, set it to an empty string.
6001 </p>
6002 </dd>
6003 <dt class="hdlist1">
6004 format.from
6005 </dt>
6006 <dd>
6007 <p>
6008         Provides the default value for the <code>--from</code> option to format-patch.
6009         Accepts a boolean value, or a name and email address.  If false,
6010         format-patch defaults to <code>--no-from</code>, using commit authors directly in
6011         the "From:" field of patch mails.  If true, format-patch defaults to
6012         <code>--from</code>, using your committer identity in the "From:" field of patch
6013         mails and including a "From:" field in the body of the patch mail if
6014         different.  If set to a non-boolean value, format-patch uses that
6015         value instead of your committer identity.  Defaults to false.
6016 </p>
6017 </dd>
6018 <dt class="hdlist1">
6019 format.forceInBodyFrom
6020 </dt>
6021 <dd>
6022 <p>
6023         Provides the default value for the <code>--[no-]force-in-body-from</code>
6024         option to format-patch.  Defaults to false.
6025 </p>
6026 </dd>
6027 <dt class="hdlist1">
6028 format.numbered
6029 </dt>
6030 <dd>
6031 <p>
6032         A boolean which can enable or disable sequence numbers in patch
6033         subjects.  It defaults to "auto" which enables it only if there
6034         is more than one patch.  It can be enabled or disabled for all
6035         messages by setting it to "true" or "false".  See --numbered
6036         option in <a href="git-format-patch.html">git-format-patch(1)</a>.
6037 </p>
6038 </dd>
6039 <dt class="hdlist1">
6040 format.headers
6041 </dt>
6042 <dd>
6043 <p>
6044         Additional email headers to include in a patch to be submitted
6045         by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.
6046 </p>
6047 </dd>
6048 <dt class="hdlist1">
6049 format.to
6050 </dt>
6051 <dt class="hdlist1">
6052 format.cc
6053 </dt>
6054 <dd>
6055 <p>
6056         Additional recipients to include in a patch to be submitted
6057         by mail.  See the --to and --cc options in
6058         <a href="git-format-patch.html">git-format-patch(1)</a>.
6059 </p>
6060 </dd>
6061 <dt class="hdlist1">
6062 format.subjectPrefix
6063 </dt>
6064 <dd>
6065 <p>
6066         The default for format-patch is to output files with the <em>[PATCH]</em>
6067         subject prefix. Use this variable to change that prefix.
6068 </p>
6069 </dd>
6070 <dt class="hdlist1">
6071 format.coverFromDescription
6072 </dt>
6073 <dd>
6074 <p>
6075         The default mode for format-patch to determine which parts of
6076         the cover letter will be populated using the branch&#8217;s
6077         description. See the <code>--cover-from-description</code> option in
6078         <a href="git-format-patch.html">git-format-patch(1)</a>.
6079 </p>
6080 </dd>
6081 <dt class="hdlist1">
6082 format.signature
6083 </dt>
6084 <dd>
6085 <p>
6086         The default for format-patch is to output a signature containing
6087         the Git version number. Use this variable to change that default.
6088         Set this variable to the empty string ("") to suppress
6089         signature generation.
6090 </p>
6091 </dd>
6092 <dt class="hdlist1">
6093 format.signatureFile
6094 </dt>
6095 <dd>
6096 <p>
6097         Works just like format.signature except the contents of the
6098         file specified by this variable will be used as the signature.
6099 </p>
6100 </dd>
6101 <dt class="hdlist1">
6102 format.suffix
6103 </dt>
6104 <dd>
6105 <p>
6106         The default for format-patch is to output files with the suffix
6107         <code>.patch</code>. Use this variable to change that suffix (make sure to
6108         include the dot if you want it).
6109 </p>
6110 </dd>
6111 <dt class="hdlist1">
6112 format.encodeEmailHeaders
6113 </dt>
6114 <dd>
6115 <p>
6116         Encode email headers that have non-ASCII characters with
6117         "Q-encoding" (described in RFC 2047) for email transmission.
6118         Defaults to true.
6119 </p>
6120 </dd>
6121 <dt class="hdlist1">
6122 format.pretty
6123 </dt>
6124 <dd>
6125 <p>
6126         The default pretty format for log/show/whatchanged command.
6127         See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
6128         <a href="git-whatchanged.html">git-whatchanged(1)</a>.
6129 </p>
6130 </dd>
6131 <dt class="hdlist1">
6132 format.thread
6133 </dt>
6134 <dd>
6135 <p>
6136         The default threading style for <em>git format-patch</em>.  Can be
6137         a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
6138         makes every mail a reply to the head of the series,
6139         where the head is chosen from the cover letter, the
6140         <code>--in-reply-to</code>, and the first patch mail, in this order.
6141         <code>deep</code> threading makes every mail a reply to the previous one.
6142         A true boolean value is the same as <code>shallow</code>, and a false
6143         value disables threading.
6144 </p>
6145 </dd>
6146 <dt class="hdlist1">
6147 format.signOff
6148 </dt>
6149 <dd>
6150 <p>
6151         A boolean value which lets you enable the <code>-s/--signoff</code> option of
6152         format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
6153         patch should be a conscious act and means that you certify you have
6154         the rights to submit this work under the same open source license.
6155         Please see the <em>SubmittingPatches</em> document for further discussion.
6156 </p>
6157 </dd>
6158 <dt class="hdlist1">
6159 format.coverLetter
6160 </dt>
6161 <dd>
6162 <p>
6163         A boolean that controls whether to generate a cover-letter when
6164         format-patch is invoked, but in addition can be set to "auto", to
6165         generate a cover-letter only when there&#8217;s more than one patch.
6166         Default is false.
6167 </p>
6168 </dd>
6169 <dt class="hdlist1">
6170 format.outputDirectory
6171 </dt>
6172 <dd>
6173 <p>
6174         Set a custom directory to store the resulting files instead of the
6175         current working directory. All directory components will be created.
6176 </p>
6177 </dd>
6178 <dt class="hdlist1">
6179 format.filenameMaxLength
6180 </dt>
6181 <dd>
6182 <p>
6183         The maximum length of the output filenames generated by the
6184         <code>format-patch</code> command; defaults to 64.  Can be overridden
6185         by the <code>--filename-max-length=&lt;n&gt;</code> command line option.
6186 </p>
6187 </dd>
6188 <dt class="hdlist1">
6189 format.useAutoBase
6190 </dt>
6191 <dd>
6192 <p>
6193         A boolean value which lets you enable the <code>--base=auto</code> option of
6194         format-patch by default. Can also be set to "whenAble" to allow
6195         enabling <code>--base=auto</code> if a suitable base is available, but to skip
6196         adding base info otherwise without the format dying.
6197 </p>
6198 </dd>
6199 <dt class="hdlist1">
6200 format.notes
6201 </dt>
6202 <dd>
6203 <p>
6204         Provides the default value for the <code>--notes</code> option to
6205         format-patch. Accepts a boolean value, or a ref which specifies
6206         where to get notes. If false, format-patch defaults to
6207         <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
6208         set to a non-boolean value, format-patch defaults to
6209         <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
6210         to false.
6211 </p>
6212 <div class="paragraph"><p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
6213 instead.</p></div>
6214 <div class="paragraph"><p>This configuration can be specified multiple times in order to allow
6215 multiple notes refs to be included. In that case, it will behave
6216 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
6217 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
6218 also show notes from that notes ref and a value of <code>false</code> will negate
6219 previous configurations and not show notes.</p></div>
6220 <div class="paragraph"><p>For example,</p></div>
6221 <div class="listingblock">
6222 <div class="content">
6223 <pre><code>[format]
6224         notes = true
6225         notes = foo
6226         notes = false
6227         notes = bar</code></pre>
6228 </div></div>
6229 <div class="paragraph"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
6230 </dd>
6231 <dt class="hdlist1">
6232 format.mboxrd
6233 </dt>
6234 <dd>
6235 <p>
6236         A boolean value which enables the robust "mboxrd" format when
6237         <code>--stdout</code> is in use to escape "^&gt;+From " lines.
6238 </p>
6239 </dd>
6240 <dt class="hdlist1">
6241 format.noprefix
6242 </dt>
6243 <dd>
6244 <p>
6245         If set, do not show any source or destination prefix in patches.
6246         This is equivalent to the <code>diff.noprefix</code> option used by <code>git
6247         diff</code> (but which is not respected by <code>format-patch</code>). Note that
6248         by setting this, the receiver of any patches you generate will
6249         have to apply them using the <code>-p0</code> option.
6250 </p>
6251 </dd>
6252 <dt class="hdlist1">
6253 fsck.&lt;msg-id&gt;
6254 </dt>
6255 <dd>
6256 <p>
6257         During fsck git may find issues with legacy data which
6258         wouldn&#8217;t be generated by current versions of git, and which
6259         wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
6260         set. This feature is intended to support working with legacy
6261         repositories containing such data.
6262 </p>
6263 <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
6264 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
6265 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
6266 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
6267 same applies for the corresponding <code>receive.fsck.*</code> and
6268 <code>fetch.fsck.*</code>. variables.</p></div>
6269 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
6270 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
6271 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
6272 uniformly configure the same fsck settings in different circumstances,
6273 all three of them must be set to the same values.</p></div>
6274 <div class="paragraph"><p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
6275 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
6276 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
6277 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
6278 with the message ID, e.g. "missingEmail: invalid author/committer
6279 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
6280 will hide that issue.</p></div>
6281 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
6282 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6283 problematic objects share to be ignored, as doing the latter will
6284 allow new instances of the same breakages go unnoticed.</p></div>
6285 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
6286 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
6287 will only cause git to warn.</p></div>
6288 <div class="paragraph"><p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
6289 values of <code>&lt;msg-id&gt;</code>.</p></div>
6290 </dd>
6291 <dt class="hdlist1">
6292 fsck.skipList
6293 </dt>
6294 <dd>
6295 <p>
6296         The path to a list of object names (i.e. one unabbreviated SHA-1 per
6297         line) that are known to be broken in a non-fatal way and should
6298         be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
6299         lines, and any leading and trailing whitespace are ignored. Everything
6300         but a SHA-1 per line will error out on older versions.
6301 </p>
6302 <div class="paragraph"><p>This feature is useful when an established project should be accepted
6303 despite early commits containing errors that can be safely ignored,
6304 such as invalid committer email addresses.  Note: corrupt objects
6305 cannot be skipped with this setting.</p></div>
6306 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
6307 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6308 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6309 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6310 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
6311 uniformly configure the same fsck settings in different circumstances,
6312 all three of them must be set to the same values.</p></div>
6313 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
6314 list should be sorted. This was never a requirement; the object names
6315 could appear in any order, but when reading the list we tracked whether
6316 the list was sorted for the purposes of an internal binary search
6317 implementation, which could save itself some work with an already sorted
6318 list. Unless you had a humongous list there was no reason to go out of
6319 your way to pre-sort the list. After Git version 2.20 a hash implementation
6320 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
6321 </dd>
6322 <dt class="hdlist1">
6323 fsmonitor.allowRemote
6324 </dt>
6325 <dd>
6326 <p>
6327     By default, the fsmonitor daemon refuses to work with network-mounted
6328     repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6329     behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6330 </p>
6331 </dd>
6332 <dt class="hdlist1">
6333 fsmonitor.socketDir
6334 </dt>
6335 <dd>
6336 <p>
6337     This Mac OS-specific option, if set, specifies the directory in
6338     which to create the Unix domain socket used for communication
6339     between the fsmonitor daemon and various Git commands. The directory must
6340     reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
6341     is set to <code>true</code>.
6342 </p>
6343 </dd>
6344 <dt class="hdlist1">
6345 gc.aggressiveDepth
6346 </dt>
6347 <dd>
6348 <p>
6349         The depth parameter used in the delta compression
6350         algorithm used by <em>git gc --aggressive</em>.  This defaults
6351         to 50, which is the default for the <code>--depth</code> option when
6352         <code>--aggressive</code> isn&#8217;t in use.
6353 </p>
6354 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
6355 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6356 </dd>
6357 <dt class="hdlist1">
6358 gc.aggressiveWindow
6359 </dt>
6360 <dd>
6361 <p>
6362         The window size parameter used in the delta compression
6363         algorithm used by <em>git gc --aggressive</em>.  This defaults
6364         to 250, which is a much more aggressive window size than
6365         the default <code>--window</code> of 10.
6366 </p>
6367 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
6368 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6369 </dd>
6370 <dt class="hdlist1">
6371 gc.auto
6372 </dt>
6373 <dd>
6374 <p>
6375         When there are approximately more than this many loose
6376         objects in the repository, <code>git gc --auto</code> will pack them.
6377         Some Porcelain commands use this command to perform a
6378         light-weight garbage collection from time to time.  The
6379         default value is 6700.
6380 </p>
6381 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
6382 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
6383 otherwise use to determine if there&#8217;s work to do, such as
6384 <code>gc.autoPackLimit</code>.</p></div>
6385 </dd>
6386 <dt class="hdlist1">
6387 gc.autoPackLimit
6388 </dt>
6389 <dd>
6390 <p>
6391         When there are more than this many packs that are not
6392         marked with <code>*.keep</code> file in the repository, <code>git gc
6393         --auto</code> consolidates them into one larger pack.  The
6394         default value is 50.  Setting this to 0 disables it.
6395         Setting <code>gc.auto</code> to 0 will also disable this.
6396 </p>
6397 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6398 use, it&#8217;ll affect how the auto pack limit works.</p></div>
6399 </dd>
6400 <dt class="hdlist1">
6401 gc.autoDetach
6402 </dt>
6403 <dd>
6404 <p>
6405         Make <code>git gc --auto</code> return immediately and run in the background
6406         if the system supports it. Default is true.
6407 </p>
6408 </dd>
6409 <dt class="hdlist1">
6410 gc.bigPackThreshold
6411 </dt>
6412 <dd>
6413 <p>
6414         If non-zero, all non-cruft packs larger than this limit are kept
6415         when <code>git gc</code> is run. This is very similar to
6416         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6417         the threshold are kept, not just the largest pack. Defaults to
6418         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6419 </p>
6420 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6421 this configuration variable is ignored, all packs except the base pack
6422 will be repacked. After this the number of packs should go below
6423 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6424 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6425 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6426 will also be excluded (this is the equivalent of running <code>git gc</code> with
6427 <code>--keep-largest-pack</code>).</p></div>
6428 </dd>
6429 <dt class="hdlist1">
6430 gc.writeCommitGraph
6431 </dt>
6432 <dd>
6433 <p>
6434         If true, then gc will rewrite the commit-graph file when
6435         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6436         the commit-graph will be updated if housekeeping is
6437         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
6438         for details.
6439 </p>
6440 </dd>
6441 <dt class="hdlist1">
6442 gc.logExpiry
6443 </dt>
6444 <dd>
6445 <p>
6446         If the file gc.log exists, then <code>git gc --auto</code> will print
6447         its content and exit with status zero instead of running
6448         unless that file is more than <em>gc.logExpiry</em> old.  Default is
6449         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
6450         value.
6451 </p>
6452 </dd>
6453 <dt class="hdlist1">
6454 gc.packRefs
6455 </dt>
6456 <dd>
6457 <p>
6458         Running <code>git pack-refs</code> in a repository renders it
6459         unclonable by Git versions prior to 1.5.1.2 over dumb
6460         transports such as HTTP.  This variable determines whether
6461         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6462         to enable it within all non-bare repos or it can be set to a
6463         boolean value.  The default is <code>true</code>.
6464 </p>
6465 </dd>
6466 <dt class="hdlist1">
6467 gc.cruftPacks
6468 </dt>
6469 <dd>
6470 <p>
6471         Store unreachable objects in a cruft pack (see
6472         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
6473         is <code>true</code>.
6474 </p>
6475 </dd>
6476 <dt class="hdlist1">
6477 gc.maxCruftSize
6478 </dt>
6479 <dd>
6480 <p>
6481         Limit the size of new cruft packs when repacking. When
6482         specified in addition to <code>--max-cruft-size</code>, the command line
6483         option takes priority. See the <code>--max-cruft-size</code> option of
6484         <a href="git-repack.html">git-repack(1)</a>.
6485 </p>
6486 </dd>
6487 <dt class="hdlist1">
6488 gc.pruneExpire
6489 </dt>
6490 <dd>
6491 <p>
6492         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6493         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6494         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
6495         grace period with this config variable.  The value "now" may be
6496         used to disable this grace period and always prune unreachable
6497         objects immediately, or "never" may be used to suppress pruning.
6498         This feature helps prevent corruption when <em>git gc</em> runs
6499         concurrently with another process writing to the repository; see
6500         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
6501 </p>
6502 </dd>
6503 <dt class="hdlist1">
6504 gc.worktreePruneExpire
6505 </dt>
6506 <dd>
6507 <p>
6508         When <em>git gc</em> is run, it calls
6509         <em>git worktree prune --expire 3.months.ago</em>.
6510         This config variable can be used to set a different grace
6511         period. The value "now" may be used to disable the grace
6512         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
6513         may be used to suppress pruning.
6514 </p>
6515 </dd>
6516 <dt class="hdlist1">
6517 gc.reflogExpire
6518 </dt>
6519 <dt class="hdlist1">
6520 gc.&lt;pattern&gt;.reflogExpire
6521 </dt>
6522 <dd>
6523 <p>
6524         <em>git reflog expire</em> removes reflog entries older than
6525         this time; defaults to 90 days. The value "now" expires all
6526         entries immediately, and "never" suppresses expiration
6527         altogether. With "&lt;pattern&gt;" (e.g.
6528         "refs/stash") in the middle the setting applies only to
6529         the refs that match the &lt;pattern&gt;.
6530 </p>
6531 </dd>
6532 <dt class="hdlist1">
6533 gc.reflogExpireUnreachable
6534 </dt>
6535 <dt class="hdlist1">
6536 gc.&lt;pattern&gt;.reflogExpireUnreachable
6537 </dt>
6538 <dd>
6539 <p>
6540         <em>git reflog expire</em> removes reflog entries older than
6541         this time and are not reachable from the current tip;
6542         defaults to 30 days. The value "now" expires all entries
6543         immediately, and "never" suppresses expiration altogether.
6544         With "&lt;pattern&gt;" (e.g. "refs/stash")
6545         in the middle, the setting applies only to the refs that
6546         match the &lt;pattern&gt;.
6547 </p>
6548 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
6549 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6550 or rebase occurring.  Since these changes are not part of the current
6551 project most users will want to expire them sooner, which is why the
6552 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6553 </dd>
6554 <dt class="hdlist1">
6555 gc.recentObjectsHook
6556 </dt>
6557 <dd>
6558 <p>
6559         When considering whether or not to remove an object (either when
6560         generating a cruft pack or storing unreachable objects as
6561         loose), use the shell to execute the specified command(s).
6562         Interpret their output as object IDs which Git will consider as
6563         "recent", regardless of their age. By treating their mtimes as
6564         "now", any objects (and their descendants) mentioned in the
6565         output will be kept regardless of their true age.
6566 </p>
6567 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
6568 else. Objects which cannot be found in the repository are ignored.
6569 Multiple hooks are supported, but all must exit successfully, else the
6570 operation (either generating a cruft pack or unpacking unreachable
6571 objects) will be halted.</p></div>
6572 </dd>
6573 <dt class="hdlist1">
6574 gc.repackFilter
6575 </dt>
6576 <dd>
6577 <p>
6578         When repacking, use the specified filter to move certain
6579         objects into a separate packfile.  See the
6580         <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.
6581 </p>
6582 </dd>
6583 <dt class="hdlist1">
6584 gc.repackFilterTo
6585 </dt>
6586 <dd>
6587 <p>
6588         When repacking and using a filter, see <code>gc.repackFilter</code>, the
6589         specified location will be used to create the packfile
6590         containing the filtered out objects. <strong>WARNING:</strong> The
6591         specified location should be accessible, using for example the
6592         Git alternates mechanism, otherwise the repo could be
6593         considered corrupt by Git as it migh not be able to access the
6594         objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
6595         of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
6596         section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.
6597 </p>
6598 </dd>
6599 <dt class="hdlist1">
6600 gc.rerereResolved
6601 </dt>
6602 <dd>
6603 <p>
6604         Records of conflicted merge you resolved earlier are
6605         kept for this many days when <em>git rerere gc</em> is run.
6606         You can also use more human-readable "1.month.ago", etc.
6607         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6608 </p>
6609 </dd>
6610 <dt class="hdlist1">
6611 gc.rerereUnresolved
6612 </dt>
6613 <dd>
6614 <p>
6615         Records of conflicted merge you have not resolved are
6616         kept for this many days when <em>git rerere gc</em> is run.
6617         You can also use more human-readable "1.month.ago", etc.
6618         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6619 </p>
6620 </dd>
6621 <dt class="hdlist1">
6622 gitcvs.commitMsgAnnotation
6623 </dt>
6624 <dd>
6625 <p>
6626         Append this string to each commit message. Set to empty string
6627         to disable this feature. Defaults to "via git-CVS emulator".
6628 </p>
6629 </dd>
6630 <dt class="hdlist1">
6631 gitcvs.enabled
6632 </dt>
6633 <dd>
6634 <p>
6635         Whether the CVS server interface is enabled for this repository.
6636         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6637 </p>
6638 </dd>
6639 <dt class="hdlist1">
6640 gitcvs.logFile
6641 </dt>
6642 <dd>
6643 <p>
6644         Path to a log file where the CVS server interface well&#8230; logs
6645         various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6646 </p>
6647 </dd>
6648 <dt class="hdlist1">
6649 gitcvs.usecrlfattr
6650 </dt>
6651 <dd>
6652 <p>
6653         If true, the server will look up the end-of-line conversion
6654         attributes for files to determine the <code>-k</code> modes to use. If
6655         the attributes force Git to treat a file as text,
6656         the <code>-k</code> mode will be left blank so CVS clients will
6657         treat it as text. If they suppress text conversion, the file
6658         will be set with <em>-kb</em> mode, which suppresses any newline munging
6659         the client might otherwise do. If the attributes do not allow
6660         the file type to be determined, then <code>gitcvs.allBinary</code> is
6661         used. See <a href="gitattributes.html">gitattributes(5)</a>.
6662 </p>
6663 </dd>
6664 <dt class="hdlist1">
6665 gitcvs.allBinary
6666 </dt>
6667 <dd>
6668 <p>
6669         This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6670         the correct <em>-kb</em> mode to use. If true, all
6671         unresolved files are sent to the client in
6672         mode <em>-kb</em>. This causes the client to treat them
6673         as binary files, which suppresses any newline munging it
6674         otherwise might do. Alternatively, if it is set to "guess",
6675         then the contents of the file are examined to decide if
6676         it is binary, similar to <code>core.autocrlf</code>.
6677 </p>
6678 </dd>
6679 <dt class="hdlist1">
6680 gitcvs.dbName
6681 </dt>
6682 <dd>
6683 <p>
6684         Database used by git-cvsserver to cache revision information
6685         derived from the Git repository. The exact meaning depends on the
6686         used database driver, for SQLite (which is the default driver) this
6687         is a filename. Supports variable substitution (see
6688         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6689         Default: <em>%Ggitcvs.%m.sqlite</em>
6690 </p>
6691 </dd>
6692 <dt class="hdlist1">
6693 gitcvs.dbDriver
6694 </dt>
6695 <dd>
6696 <p>
6697         Used Perl DBI driver. You can specify any available driver
6698         for this here, but it might not work. git-cvsserver is tested
6699         with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6700         reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6701         May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6702         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6703 </p>
6704 </dd>
6705 <dt class="hdlist1">
6706 gitcvs.dbUser, gitcvs.dbPass
6707 </dt>
6708 <dd>
6709 <p>
6710         Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6711         since SQLite has no concept of database users and/or passwords.
6712         <em>gitcvs.dbUser</em> supports variable substitution (see
6713         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
6714 </p>
6715 </dd>
6716 <dt class="hdlist1">
6717 gitcvs.dbTableNamePrefix
6718 </dt>
6719 <dd>
6720 <p>
6721         Database table name prefix.  Prepended to the names of any
6722         database tables used, allowing a single database to be used
6723         for several repositories.  Supports variable substitution (see
6724         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
6725         characters will be replaced with underscores.
6726 </p>
6727 </dd>
6728 </dl></div>
6729 <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6730 <code>gitcvs.allBinary</code> can also be specified as
6731 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
6732 is one of "ext" and "pserver") to make them apply only for the given
6733 access method.</p></div>
6734 <div class="dlist"><dl>
6735 <dt class="hdlist1">
6736 gitweb.category
6737 </dt>
6738 <dt class="hdlist1">
6739 gitweb.description
6740 </dt>
6741 <dt class="hdlist1">
6742 gitweb.owner
6743 </dt>
6744 <dt class="hdlist1">
6745 gitweb.url
6746 </dt>
6747 <dd>
6748 <p>
6749         See <a href="gitweb.html">gitweb(1)</a> for description.
6750 </p>
6751 </dd>
6752 <dt class="hdlist1">
6753 gitweb.avatar
6754 </dt>
6755 <dt class="hdlist1">
6756 gitweb.blame
6757 </dt>
6758 <dt class="hdlist1">
6759 gitweb.grep
6760 </dt>
6761 <dt class="hdlist1">
6762 gitweb.highlight
6763 </dt>
6764 <dt class="hdlist1">
6765 gitweb.patches
6766 </dt>
6767 <dt class="hdlist1">
6768 gitweb.pickaxe
6769 </dt>
6770 <dt class="hdlist1">
6771 gitweb.remote_heads
6772 </dt>
6773 <dt class="hdlist1">
6774 gitweb.showSizes
6775 </dt>
6776 <dt class="hdlist1">
6777 gitweb.snapshot
6778 </dt>
6779 <dd>
6780 <p>
6781         See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
6782 </p>
6783 </dd>
6784 <dt class="hdlist1">
6785 gpg.program
6786 </dt>
6787 <dd>
6788 <p>
6789         Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
6790         making or verifying a PGP signature. The program must support the
6791         same command-line interface as GPG, namely, to verify a detached
6792         signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
6793         program is expected to signal a good signature by exiting with
6794         code 0.  To generate an ASCII-armored detached signature, the
6795         standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
6796         signed, and the program is expected to send the result to its
6797         standard output.
6798 </p>
6799 </dd>
6800 <dt class="hdlist1">
6801 gpg.format
6802 </dt>
6803 <dd>
6804 <p>
6805         Specifies which key format to use when signing with <code>--gpg-sign</code>.
6806         Default is "openpgp". Other possible values are "x509", "ssh".
6807 </p>
6808 <div class="paragraph"><p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
6809 based on the selected <code>gpg.format</code>.</p></div>
6810 </dd>
6811 <dt class="hdlist1">
6812 gpg.&lt;format&gt;.program
6813 </dt>
6814 <dd>
6815 <p>
6816         Use this to customize the program used for the signing format you
6817         chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
6818         be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
6819         value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".
6820 </p>
6821 </dd>
6822 <dt class="hdlist1">
6823 gpg.minTrustLevel
6824 </dt>
6825 <dd>
6826 <p>
6827         Specifies a minimum trust level for signature verification.  If
6828         this option is unset, then signature verification for merge
6829         operations requires a key with at least <code>marginal</code> trust.  Other
6830         operations that perform signature verification require a key
6831         with at least <code>undefined</code> trust.  Setting this option overrides
6832         the required trust-level for all operations.  Supported values,
6833         in increasing order of significance:
6834 </p>
6835 <div class="ulist"><ul>
6836 <li>
6837 <p>
6838 <code>undefined</code>
6839 </p>
6840 </li>
6841 <li>
6842 <p>
6843 <code>never</code>
6844 </p>
6845 </li>
6846 <li>
6847 <p>
6848 <code>marginal</code>
6849 </p>
6850 </li>
6851 <li>
6852 <p>
6853 <code>fully</code>
6854 </p>
6855 </li>
6856 <li>
6857 <p>
6858 <code>ultimate</code>
6859 </p>
6860 </li>
6861 </ul></div>
6862 </dd>
6863 <dt class="hdlist1">
6864 gpg.ssh.defaultKeyCommand
6865 </dt>
6866 <dd>
6867 <p>
6868         This command will be run when user.signingkey is not set and a ssh
6869         signature is requested. On successful exit a valid ssh public key
6870         prefixed with <code>key::</code> is expected in the first line of its output.
6871         This allows for a script doing a dynamic lookup of the correct public
6872         key when it is impractical to statically configure <code>user.signingKey</code>.
6873         For example when keys or SSH Certificates are rotated frequently or
6874         selection of the right key depends on external factors unknown to git.
6875 </p>
6876 </dd>
6877 <dt class="hdlist1">
6878 gpg.ssh.allowedSignersFile
6879 </dt>
6880 <dd>
6881 <p>
6882         A file containing ssh public keys which you are willing to trust.
6883         The file consists of one or more lines of principals followed by an ssh
6884         public key.
6885         e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
6886         See ssh-keygen(1) "ALLOWED SIGNERS" for details.
6887         The principal is only used to identify the key and is available when
6888         verifying a signature.
6889 </p>
6890 <div class="paragraph"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
6891 between valid signatures and trusted signatures the trust level of a signature
6892 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
6893 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
6894 <div class="paragraph"><p>This file can be set to a location outside of the repository and every developer
6895 maintains their own trust store. A central repository server could generate this
6896 file automatically from ssh keys with push access to verify the code against.
6897 In a corporate setting this file is probably generated at a global location
6898 from automation that already handles developer ssh keys.</p></div>
6899 <div class="paragraph"><p>A repository that only allows signed commits can store the file
6900 in the repository itself using a path relative to the top-level of the working tree.
6901 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
6902 <div class="paragraph"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
6903 valid-before options. Git will mark signatures as valid if the signing key was
6904 valid at the time of the signature&#8217;s creation. This allows users to change a
6905 signing key without invalidating all previously made signatures.</p></div>
6906 <div class="paragraph"><p>Using a SSH CA key with the cert-authority option
6907 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p></div>
6908 </dd>
6909 <dt class="hdlist1">
6910 gpg.ssh.revocationFile
6911 </dt>
6912 <dd>
6913 <p>
6914         Either a SSH KRL or a list of revoked public keys (without the principal prefix).
6915         See ssh-keygen(1) for details.
6916         If a public key is found in this file then it will always be treated
6917         as having trust level "never" and signatures will show as invalid.
6918 </p>
6919 </dd>
6920 <dt class="hdlist1">
6921 grep.lineNumber
6922 </dt>
6923 <dd>
6924 <p>
6925         If set to true, enable <code>-n</code> option by default.
6926 </p>
6927 </dd>
6928 <dt class="hdlist1">
6929 grep.column
6930 </dt>
6931 <dd>
6932 <p>
6933         If set to true, enable the <code>--column</code> option by default.
6934 </p>
6935 </dd>
6936 <dt class="hdlist1">
6937 grep.patternType
6938 </dt>
6939 <dd>
6940 <p>
6941         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
6942         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
6943         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
6944         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
6945         between <em>basic</em> and <em>extended</em>.
6946 </p>
6947 </dd>
6948 <dt class="hdlist1">
6949 grep.extendedRegexp
6950 </dt>
6951 <dd>
6952 <p>
6953         If set to true, enable <code>--extended-regexp</code> option by default. This
6954         option is ignored when the <code>grep.patternType</code> option is set to a value
6955         other than <em>default</em>.
6956 </p>
6957 </dd>
6958 <dt class="hdlist1">
6959 grep.threads
6960 </dt>
6961 <dd>
6962 <p>
6963         Number of grep worker threads to use. If unset (or set to 0), Git will
6964         use as many threads as the number of logical cores available.
6965 </p>
6966 </dd>
6967 <dt class="hdlist1">
6968 grep.fullName
6969 </dt>
6970 <dd>
6971 <p>
6972         If set to true, enable <code>--full-name</code> option by default.
6973 </p>
6974 </dd>
6975 <dt class="hdlist1">
6976 grep.fallbackToNoIndex
6977 </dt>
6978 <dd>
6979 <p>
6980         If set to true, fall back to <code>git grep --no-index</code> if <code>git grep</code>
6981         is executed outside of a git repository.  Defaults to false.
6982 </p>
6983 </dd>
6984 <dt class="hdlist1">
6985 gui.commitMsgWidth
6986 </dt>
6987 <dd>
6988 <p>
6989         Defines how wide the commit message window is in the
6990         <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
6991 </p>
6992 </dd>
6993 <dt class="hdlist1">
6994 gui.diffContext
6995 </dt>
6996 <dd>
6997 <p>
6998         Specifies how many context lines should be used in calls to diff
6999         made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
7000 </p>
7001 </dd>
7002 <dt class="hdlist1">
7003 gui.displayUntracked
7004 </dt>
7005 <dd>
7006 <p>
7007         Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
7008         in the file list. The default is "true".
7009 </p>
7010 </dd>
7011 <dt class="hdlist1">
7012 gui.encoding
7013 </dt>
7014 <dd>
7015 <p>
7016         Specifies the default character encoding to use for displaying of
7017         file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
7018         It can be overridden by setting the <em>encoding</em> attribute
7019         for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
7020         If this option is not set, the tools default to the
7021         locale encoding.
7022 </p>
7023 </dd>
7024 <dt class="hdlist1">
7025 gui.matchTrackingBranch
7026 </dt>
7027 <dd>
7028 <p>
7029         Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
7030         default to tracking remote branches with matching names or
7031         not. Default: "false".
7032 </p>
7033 </dd>
7034 <dt class="hdlist1">
7035 gui.newBranchTemplate
7036 </dt>
7037 <dd>
7038 <p>
7039         Is used as a suggested name when creating new branches using the
7040         <a href="git-gui.html">git-gui(1)</a>.
7041 </p>
7042 </dd>
7043 <dt class="hdlist1">
7044 gui.pruneDuringFetch
7045 </dt>
7046 <dd>
7047 <p>
7048         "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
7049         performing a fetch. The default value is "false".
7050 </p>
7051 </dd>
7052 <dt class="hdlist1">
7053 gui.trustmtime
7054 </dt>
7055 <dd>
7056 <p>
7057         Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
7058         timestamp or not. By default the timestamps are not trusted.
7059 </p>
7060 </dd>
7061 <dt class="hdlist1">
7062 gui.spellingDictionary
7063 </dt>
7064 <dd>
7065 <p>
7066         Specifies the dictionary used for spell checking commit messages in
7067         the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
7068         off.
7069 </p>
7070 </dd>
7071 <dt class="hdlist1">
7072 gui.fastCopyBlame
7073 </dt>
7074 <dd>
7075 <p>
7076         If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
7077         location detection. It makes blame significantly faster on huge
7078         repositories at the expense of less thorough copy detection.
7079 </p>
7080 </dd>
7081 <dt class="hdlist1">
7082 gui.copyBlameThreshold
7083 </dt>
7084 <dd>
7085 <p>
7086         Specifies the threshold to use in <em>git gui blame</em> original location
7087         detection, measured in alphanumeric characters. See the
7088         <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
7089 </p>
7090 </dd>
7091 <dt class="hdlist1">
7092 gui.blamehistoryctx
7093 </dt>
7094 <dd>
7095 <p>
7096         Specifies the radius of history context in days to show in
7097         <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
7098         Context</code> menu item is invoked from <em>git gui blame</em>. If this
7099         variable is set to zero, the whole history is shown.
7100 </p>
7101 </dd>
7102 <dt class="hdlist1">
7103 guitool.&lt;name&gt;.cmd
7104 </dt>
7105 <dd>
7106 <p>
7107         Specifies the shell command line to execute when the corresponding item
7108         of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
7109         mandatory for every tool. The command is executed from the root of
7110         the working directory, and in the environment it receives the name of
7111         the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
7112         <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
7113         the head is detached, <em>CUR_BRANCH</em> is empty).
7114 </p>
7115 </dd>
7116 <dt class="hdlist1">
7117 guitool.&lt;name&gt;.needsFile
7118 </dt>
7119 <dd>
7120 <p>
7121         Run the tool only if a diff is selected in the GUI. It guarantees
7122         that <em>FILENAME</em> is not empty.
7123 </p>
7124 </dd>
7125 <dt class="hdlist1">
7126 guitool.&lt;name&gt;.noConsole
7127 </dt>
7128 <dd>
7129 <p>
7130         Run the command silently, without creating a window to display its
7131         output.
7132 </p>
7133 </dd>
7134 <dt class="hdlist1">
7135 guitool.&lt;name&gt;.noRescan
7136 </dt>
7137 <dd>
7138 <p>
7139         Don&#8217;t rescan the working directory for changes after the tool
7140         finishes execution.
7141 </p>
7142 </dd>
7143 <dt class="hdlist1">
7144 guitool.&lt;name&gt;.confirm
7145 </dt>
7146 <dd>
7147 <p>
7148         Show a confirmation dialog before actually running the tool.
7149 </p>
7150 </dd>
7151 <dt class="hdlist1">
7152 guitool.&lt;name&gt;.argPrompt
7153 </dt>
7154 <dd>
7155 <p>
7156         Request a string argument from the user, and pass it to the tool
7157         through the <code>ARGS</code> environment variable. Since requesting an
7158         argument implies confirmation, the <em>confirm</em> option has no effect
7159         if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
7160         the dialog uses a built-in generic prompt; otherwise the exact
7161         value of the variable is used.
7162 </p>
7163 </dd>
7164 <dt class="hdlist1">
7165 guitool.&lt;name&gt;.revPrompt
7166 </dt>
7167 <dd>
7168 <p>
7169         Request a single valid revision from the user, and set the
7170         <code>REVISION</code> environment variable. In other aspects this option
7171         is similar to <em>argPrompt</em>, and can be used together with it.
7172 </p>
7173 </dd>
7174 <dt class="hdlist1">
7175 guitool.&lt;name&gt;.revUnmerged
7176 </dt>
7177 <dd>
7178 <p>
7179         Show only unmerged branches in the <em>revPrompt</em> subdialog.
7180         This is useful for tools similar to merge or rebase, but not
7181         for things like checkout or reset.
7182 </p>
7183 </dd>
7184 <dt class="hdlist1">
7185 guitool.&lt;name&gt;.title
7186 </dt>
7187 <dd>
7188 <p>
7189         Specifies the title to use for the prompt dialog. The default
7190         is the tool name.
7191 </p>
7192 </dd>
7193 <dt class="hdlist1">
7194 guitool.&lt;name&gt;.prompt
7195 </dt>
7196 <dd>
7197 <p>
7198         Specifies the general prompt string to display at the top of
7199         the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
7200         The default value includes the actual command.
7201 </p>
7202 </dd>
7203 <dt class="hdlist1">
7204 help.browser
7205 </dt>
7206 <dd>
7207 <p>
7208         Specify the browser that will be used to display help in the
7209         <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
7210 </p>
7211 </dd>
7212 <dt class="hdlist1">
7213 help.format
7214 </dt>
7215 <dd>
7216 <p>
7217         Override the default help format used by <a href="git-help.html">git-help(1)</a>.
7218         Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
7219         the default. <em>web</em> and <em>html</em> are the same.
7220 </p>
7221 </dd>
7222 <dt class="hdlist1">
7223 help.autoCorrect
7224 </dt>
7225 <dd>
7226 <p>
7227         If git detects typos and can identify exactly one valid command similar
7228         to the error, git will try to suggest the correct command or even
7229         run the suggestion automatically. Possible config values are:
7230 </p>
7231 <div class="ulist"><ul>
7232 <li>
7233 <p>
7234 0 (default): show the suggested command.
7235 </p>
7236 </li>
7237 <li>
7238 <p>
7239 positive number: run the suggested command after specified
7240 deciseconds (0.1 sec).
7241 </p>
7242 </li>
7243 <li>
7244 <p>
7245 "immediate": run the suggested command immediately.
7246 </p>
7247 </li>
7248 <li>
7249 <p>
7250 "prompt": show the suggestion and prompt for confirmation to run
7251 the command.
7252 </p>
7253 </li>
7254 <li>
7255 <p>
7256 "never": don&#8217;t run or show any suggested command.
7257 </p>
7258 </li>
7259 </ul></div>
7260 </dd>
7261 <dt class="hdlist1">
7262 help.htmlPath
7263 </dt>
7264 <dd>
7265 <p>
7266         Specify the path where the HTML documentation resides. File system paths
7267         and URLs are supported. HTML pages will be prefixed with this path when
7268         help is displayed in the <em>web</em> format. This defaults to the documentation
7269         path of your Git installation.
7270 </p>
7271 </dd>
7272 <dt class="hdlist1">
7273 http.proxy
7274 </dt>
7275 <dd>
7276 <p>
7277         Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
7278         <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
7279         addition to the syntax understood by curl, it is possible to specify a
7280         proxy string with a user name but no password, in which case git will
7281         attempt to acquire one in the same way it does for other credentials. See
7282         <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
7283         <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
7284         on a per-remote basis; see remote.&lt;name&gt;.proxy
7285 </p>
7286 </dd>
7287 <dt class="hdlist1">
7288 http.proxyAuthMethod
7289 </dt>
7290 <dd>
7291 <p>
7292         Set the method with which to authenticate against the HTTP proxy. This
7293         only takes effect if the configured proxy string contains a user name part
7294         (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
7295         overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
7296         Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
7297         variable.  Possible values are:
7298 </p>
7299 <div class="openblock">
7300 <div class="content">
7301 <div class="ulist"><ul>
7302 <li>
7303 <p>
7304 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
7305   assumed that the proxy answers an unauthenticated request with a 407
7306   status code and one or more Proxy-authenticate headers with supported
7307   authentication methods. This is the default.
7308 </p>
7309 </li>
7310 <li>
7311 <p>
7312 <code>basic</code> - HTTP Basic authentication
7313 </p>
7314 </li>
7315 <li>
7316 <p>
7317 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
7318   transmitted to the proxy in clear text
7319 </p>
7320 </li>
7321 <li>
7322 <p>
7323 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7324   of <code>curl(1)</code>)
7325 </p>
7326 </li>
7327 <li>
7328 <p>
7329 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7330 </p>
7331 </li>
7332 </ul></div>
7333 </div></div>
7334 </dd>
7335 <dt class="hdlist1">
7336 http.proxySSLCert
7337 </dt>
7338 <dd>
7339 <p>
7340         The pathname of a file that stores a client certificate to use to authenticate
7341         with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7342         variable.
7343 </p>
7344 </dd>
7345 <dt class="hdlist1">
7346 http.proxySSLKey
7347 </dt>
7348 <dd>
7349 <p>
7350         The pathname of a file that stores a private key to use to authenticate with
7351         an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7352         variable.
7353 </p>
7354 </dd>
7355 <dt class="hdlist1">
7356 http.proxySSLCertPasswordProtected
7357 </dt>
7358 <dd>
7359 <p>
7360         Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
7361         will prompt the user, possibly many times, if the certificate or private key
7362         is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7363         environment variable.
7364 </p>
7365 </dd>
7366 <dt class="hdlist1">
7367 http.proxySSLCAInfo
7368 </dt>
7369 <dd>
7370 <p>
7371         Pathname to the file containing the certificate bundle that should be used to
7372         verify the proxy with when using an HTTPS proxy. Can be overridden by the
7373         <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7374 </p>
7375 </dd>
7376 <dt class="hdlist1">
7377 http.emptyAuth
7378 </dt>
7379 <dd>
7380 <p>
7381         Attempt authentication without seeking a username or password.  This
7382         can be used to attempt GSS-Negotiate authentication without specifying
7383         a username in the URL, as libcurl normally requires a username for
7384         authentication.
7385 </p>
7386 </dd>
7387 <dt class="hdlist1">
7388 http.delegation
7389 </dt>
7390 <dd>
7391 <p>
7392         Control GSSAPI credential delegation. The delegation is disabled
7393         by default in libcurl since version 7.21.7. Set parameter to tell
7394         the server what it is allowed to delegate when it comes to user
7395         credentials. Used with GSS/kerberos. Possible values are:
7396 </p>
7397 <div class="openblock">
7398 <div class="content">
7399 <div class="ulist"><ul>
7400 <li>
7401 <p>
7402 <code>none</code> - Don&#8217;t allow any delegation.
7403 </p>
7404 </li>
7405 <li>
7406 <p>
7407 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7408   Kerberos service ticket, which is a matter of realm policy.
7409 </p>
7410 </li>
7411 <li>
7412 <p>
7413 <code>always</code> - Unconditionally allow the server to delegate.
7414 </p>
7415 </li>
7416 </ul></div>
7417 </div></div>
7418 </dd>
7419 <dt class="hdlist1">
7420 http.extraHeader
7421 </dt>
7422 <dd>
7423 <p>
7424         Pass an additional HTTP header when communicating with a server.  If
7425         more than one such entry exists, all of them are added as extra
7426         headers.  To allow overriding the settings inherited from the system
7427         config, an empty value will reset the extra headers to the empty list.
7428 </p>
7429 </dd>
7430 <dt class="hdlist1">
7431 http.cookieFile
7432 </dt>
7433 <dd>
7434 <p>
7435         The pathname of a file containing previously stored cookie lines,
7436         which should be used
7437         in the Git http session, if they match the server. The file format
7438         of the file to read cookies from should be plain HTTP headers or
7439         the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7440         NOTE that the file specified with http.cookieFile is used only as
7441         input unless http.saveCookies is set.
7442 </p>
7443 </dd>
7444 <dt class="hdlist1">
7445 http.saveCookies
7446 </dt>
7447 <dd>
7448 <p>
7449         If set, store cookies received during requests to the file specified by
7450         http.cookieFile. Has no effect if http.cookieFile is unset.
7451 </p>
7452 </dd>
7453 <dt class="hdlist1">
7454 http.version
7455 </dt>
7456 <dd>
7457 <p>
7458         Use the specified HTTP protocol version when communicating with a server.
7459         If you want to force the default. The available and default version depend
7460         on libcurl. Currently the possible values of
7461         this option are:
7462 </p>
7463 <div class="ulist"><ul>
7464 <li>
7465 <p>
7466 HTTP/2
7467 </p>
7468 </li>
7469 <li>
7470 <p>
7471 HTTP/1.1
7472 </p>
7473 </li>
7474 </ul></div>
7475 </dd>
7476 <dt class="hdlist1">
7477 http.curloptResolve
7478 </dt>
7479 <dd>
7480 <p>
7481         Hostname resolution information that will be used first by
7482         libcurl when sending HTTP requests.  This information should
7483         be in one of the following formats:
7484 </p>
7485 <div class="ulist"><ul>
7486 <li>
7487 <p>
7488 [+]HOST:PORT:ADDRESS[,ADDRESS]
7489 </p>
7490 </li>
7491 <li>
7492 <p>
7493 -HOST:PORT
7494 </p>
7495 </li>
7496 </ul></div>
7497 <div class="paragraph"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7498 to the provided <code>ADDRESS</code>(s). The second format clears all
7499 previous config values for that <code>HOST:PORT</code> combination.  To
7500 allow easy overriding of all the settings inherited from the
7501 system config, an empty value will reset all resolution
7502 information to the empty list.</p></div>
7503 </dd>
7504 <dt class="hdlist1">
7505 http.sslVersion
7506 </dt>
7507 <dd>
7508 <p>
7509         The SSL version to use when negotiating an SSL connection, if you
7510         want to force the default.  The available and default version
7511         depend on whether libcurl was built against NSS or OpenSSL and the
7512         particular configuration of the crypto library in use. Internally
7513         this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7514         documentation for more details on the format of this option and
7515         for the ssl version supported. Currently the possible values of
7516         this option are:
7517 </p>
7518 <div class="ulist"><ul>
7519 <li>
7520 <p>
7521 sslv2
7522 </p>
7523 </li>
7524 <li>
7525 <p>
7526 sslv3
7527 </p>
7528 </li>
7529 <li>
7530 <p>
7531 tlsv1
7532 </p>
7533 </li>
7534 <li>
7535 <p>
7536 tlsv1.0
7537 </p>
7538 </li>
7539 <li>
7540 <p>
7541 tlsv1.1
7542 </p>
7543 </li>
7544 <li>
7545 <p>
7546 tlsv1.2
7547 </p>
7548 </li>
7549 <li>
7550 <p>
7551 tlsv1.3
7552 </p>
7553 </li>
7554 </ul></div>
7555 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7556 To force git to use libcurl&#8217;s default ssl version and ignore any
7557 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7558 empty string.</p></div>
7559 </dd>
7560 <dt class="hdlist1">
7561 http.sslCipherList
7562 </dt>
7563 <dd>
7564 <p>
7565   A list of SSL ciphers to use when negotiating an SSL connection.
7566   The available ciphers depend on whether libcurl was built against
7567   NSS or OpenSSL and the particular configuration of the crypto
7568   library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7569   option; see the libcurl documentation for more details on the format
7570   of this list.
7571 </p>
7572 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7573 To force git to use libcurl&#8217;s default cipher list and ignore any
7574 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7575 empty string.</p></div>
7576 </dd>
7577 <dt class="hdlist1">
7578 http.sslVerify
7579 </dt>
7580 <dd>
7581 <p>
7582         Whether to verify the SSL certificate when fetching or pushing
7583         over HTTPS. Defaults to true. Can be overridden by the
7584         <code>GIT_SSL_NO_VERIFY</code> environment variable.
7585 </p>
7586 </dd>
7587 <dt class="hdlist1">
7588 http.sslCert
7589 </dt>
7590 <dd>
7591 <p>
7592         File containing the SSL certificate when fetching or pushing
7593         over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7594         variable.
7595 </p>
7596 </dd>
7597 <dt class="hdlist1">
7598 http.sslKey
7599 </dt>
7600 <dd>
7601 <p>
7602         File containing the SSL private key when fetching or pushing
7603         over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7604         variable.
7605 </p>
7606 </dd>
7607 <dt class="hdlist1">
7608 http.sslCertPasswordProtected
7609 </dt>
7610 <dd>
7611 <p>
7612         Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
7613         OpenSSL will prompt the user, possibly many times, if the
7614         certificate or private key is encrypted.  Can be overridden by the
7615         <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7616 </p>
7617 </dd>
7618 <dt class="hdlist1">
7619 http.sslCAInfo
7620 </dt>
7621 <dd>
7622 <p>
7623         File containing the certificates to verify the peer with when
7624         fetching or pushing over HTTPS. Can be overridden by the
7625         <code>GIT_SSL_CAINFO</code> environment variable.
7626 </p>
7627 </dd>
7628 <dt class="hdlist1">
7629 http.sslCAPath
7630 </dt>
7631 <dd>
7632 <p>
7633         Path containing files with the CA certificates to verify the peer
7634         with when fetching or pushing over HTTPS. Can be overridden
7635         by the <code>GIT_SSL_CAPATH</code> environment variable.
7636 </p>
7637 </dd>
7638 <dt class="hdlist1">
7639 http.sslBackend
7640 </dt>
7641 <dd>
7642 <p>
7643         Name of the SSL backend to use (e.g. "openssl" or "schannel").
7644         This option is ignored if cURL lacks support for choosing the SSL
7645         backend at runtime.
7646 </p>
7647 </dd>
7648 <dt class="hdlist1">
7649 http.schannelCheckRevoke
7650 </dt>
7651 <dd>
7652 <p>
7653         Used to enforce or disable certificate revocation checks in cURL
7654         when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
7655         unset. Only necessary to disable this if Git consistently errors
7656         and the message is about checking the revocation status of a
7657         certificate. This option is ignored if cURL lacks support for
7658         setting the relevant SSL option at runtime.
7659 </p>
7660 </dd>
7661 <dt class="hdlist1">
7662 http.schannelUseSSLCAInfo
7663 </dt>
7664 <dd>
7665 <p>
7666         As of cURL v7.60.0, the Secure Channel backend can use the
7667         certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7668         override the Windows Certificate Store. Since this is not desirable
7669         by default, Git will tell cURL not to use that bundle by default
7670         when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7671         unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7672 </p>
7673 </dd>
7674 <dt class="hdlist1">
7675 http.pinnedPubkey
7676 </dt>
7677 <dd>
7678 <p>
7679         Public key of the https service. It may either be the filename of
7680         a PEM or DER encoded public key file or a string starting with
7681         <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7682         public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7683         exit with an error if this option is set but not supported by
7684         cURL.
7685 </p>
7686 </dd>
7687 <dt class="hdlist1">
7688 http.sslTry
7689 </dt>
7690 <dd>
7691 <p>
7692         Attempt to use AUTH SSL/TLS and encrypted data transfers
7693         when connecting via regular FTP protocol. This might be needed
7694         if the FTP server requires it for security reasons or you wish
7695         to connect securely whenever remote FTP server supports it.
7696         Default is false since it might trigger certificate verification
7697         errors on misconfigured servers.
7698 </p>
7699 </dd>
7700 <dt class="hdlist1">
7701 http.maxRequests
7702 </dt>
7703 <dd>
7704 <p>
7705         How many HTTP requests to launch in parallel. Can be overridden
7706         by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7707 </p>
7708 </dd>
7709 <dt class="hdlist1">
7710 http.minSessions
7711 </dt>
7712 <dd>
7713 <p>
7714         The number of curl sessions (counted across slots) to be kept across
7715         requests. They will not be ended with curl_easy_cleanup() until
7716         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7717         value will be capped at 1. Defaults to 1.
7718 </p>
7719 </dd>
7720 <dt class="hdlist1">
7721 http.postBuffer
7722 </dt>
7723 <dd>
7724 <p>
7725         Maximum size in bytes of the buffer used by smart HTTP
7726         transports when POSTing data to the remote system.
7727         For requests larger than this buffer size, HTTP/1.1 and
7728         Transfer-Encoding: chunked is used to avoid creating a
7729         massive pack file locally.  Default is 1 MiB, which is
7730         sufficient for most requests.
7731 </p>
7732 <div class="paragraph"><p>Note that raising this limit is only effective for disabling chunked
7733 transfer encoding and therefore should be used only where the remote
7734 server or a proxy only supports HTTP/1.0 or is noncompliant with the
7735 HTTP standard.  Raising this is not, in general, an effective solution
7736 for most push problems, but can increase memory consumption
7737 significantly since the entire buffer is allocated even for small
7738 pushes.</p></div>
7739 </dd>
7740 <dt class="hdlist1">
7741 http.lowSpeedLimit, http.lowSpeedTime
7742 </dt>
7743 <dd>
7744 <p>
7745         If the HTTP transfer speed, in bytes per second, is less than
7746         <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
7747         the transfer is aborted.
7748         Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
7749         <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
7750 </p>
7751 </dd>
7752 <dt class="hdlist1">
7753 http.noEPSV
7754 </dt>
7755 <dd>
7756 <p>
7757         A boolean which disables using of EPSV ftp command by curl.
7758         This can be helpful with some "poor" ftp servers which don&#8217;t
7759         support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
7760         environment variable. Default is false (curl will use EPSV).
7761 </p>
7762 </dd>
7763 <dt class="hdlist1">
7764 http.userAgent
7765 </dt>
7766 <dd>
7767 <p>
7768         The HTTP USER_AGENT string presented to an HTTP server.  The default
7769         value represents the version of the Git client such as git/1.7.1.
7770         This option allows you to override this value to a more common value
7771         such as Mozilla/4.0.  This may be necessary, for instance, if
7772         connecting through a firewall that restricts HTTP connections to a set
7773         of common USER_AGENT strings (but not including those like git/1.7.1).
7774         Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
7775 </p>
7776 </dd>
7777 <dt class="hdlist1">
7778 http.followRedirects
7779 </dt>
7780 <dd>
7781 <p>
7782         Whether git should follow HTTP redirects. If set to <code>true</code>, git
7783         will transparently follow any redirect issued by a server it
7784         encounters. If set to <code>false</code>, git will treat all redirects as
7785         errors. If set to <code>initial</code>, git will follow redirects only for
7786         the initial request to a remote, but not for subsequent
7787         follow-up HTTP requests. Since git uses the redirected URL as
7788         the base for the follow-up requests, this is generally
7789         sufficient. The default is <code>initial</code>.
7790 </p>
7791 </dd>
7792 <dt class="hdlist1">
7793 http.&lt;url&gt;.*
7794 </dt>
7795 <dd>
7796 <p>
7797         Any of the http.* options above can be applied selectively to some URLs.
7798         For a config key to match a URL, each element of the config key is
7799         compared to that of the URL, in the following order:
7800 </p>
7801 <div class="openblock">
7802 <div class="content">
7803 <div class="olist arabic"><ol class="arabic">
7804 <li>
7805 <p>
7806 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
7807   must match exactly between the config key and the URL.
7808 </p>
7809 </li>
7810 <li>
7811 <p>
7812 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
7813   This field must match between the config key and the URL. It is
7814   possible to specify a <code>*</code> as part of the host name to match all subdomains
7815   at this level. <code>https://*.example.com/</code> for example would match
7816   <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
7817 </p>
7818 </li>
7819 <li>
7820 <p>
7821 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
7822   This field must match exactly between the config key and the URL.
7823   Omitted port numbers are automatically converted to the correct
7824   default for the scheme before matching.
7825 </p>
7826 </li>
7827 <li>
7828 <p>
7829 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
7830   path field of the config key must match the path field of the URL
7831   either exactly or as a prefix of slash-delimited path elements.  This means
7832   a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
7833   match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
7834   key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
7835   key with just path <code>foo/</code>).
7836 </p>
7837 </li>
7838 <li>
7839 <p>
7840 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
7841   the config key has a user name it must match the user name in the
7842   URL exactly. If the config key does not have a user name, that
7843   config key will match a URL with any user name (including none),
7844   but at a lower precedence than a config key with a user name.
7845 </p>
7846 </li>
7847 </ol></div>
7848 </div></div>
7849 <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
7850 a config key&#8217;s path is preferred to one that matches its user name. For example,
7851 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
7852 <code>https://example.com/foo</code> will be preferred over a config key match of
7853 <code>https://user@example.com</code>.</p></div>
7854 <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
7855 if embedded in the URL, is always ignored for matching purposes) so that
7856 equivalent URLs that are simply spelled differently will match properly.
7857 Environment variable settings always override any matches.  The URLs that are
7858 matched against are those given directly to Git commands.  This means any URLs
7859 visited as a result of a redirection do not participate in matching.</p></div>
7860 </dd>
7861 <dt class="hdlist1">
7862 i18n.commitEncoding
7863 </dt>
7864 <dd>
7865 <p>
7866         Character encoding the commit messages are stored in; Git itself
7867         does not care per se, but this information is necessary e.g. when
7868         importing commits from emails or in the gitk graphical history
7869         browser (and possibly in other places in the future or in other
7870         porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
7871 </p>
7872 </dd>
7873 <dt class="hdlist1">
7874 i18n.logOutputEncoding
7875 </dt>
7876 <dd>
7877 <p>
7878         Character encoding the commit messages are converted to when
7879         running <em>git log</em> and friends.
7880 </p>
7881 </dd>
7882 <dt class="hdlist1">
7883 imap.folder
7884 </dt>
7885 <dd>
7886 <p>
7887         The folder to drop the mails into, which is typically the Drafts
7888         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
7889         "[Gmail]/Drafts". Required.
7890 </p>
7891 </dd>
7892 <dt class="hdlist1">
7893 imap.tunnel
7894 </dt>
7895 <dd>
7896 <p>
7897         Command used to set up a tunnel to the IMAP server through which
7898         commands will be piped instead of using a direct network connection
7899         to the server. Required when imap.host is not set.
7900 </p>
7901 </dd>
7902 <dt class="hdlist1">
7903 imap.host
7904 </dt>
7905 <dd>
7906 <p>
7907         A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
7908         connections and an <code>imaps://</code> prefix for secure connections.
7909         Ignored when imap.tunnel is set, but required otherwise.
7910 </p>
7911 </dd>
7912 <dt class="hdlist1">
7913 imap.user
7914 </dt>
7915 <dd>
7916 <p>
7917         The username to use when logging in to the server.
7918 </p>
7919 </dd>
7920 <dt class="hdlist1">
7921 imap.pass
7922 </dt>
7923 <dd>
7924 <p>
7925         The password to use when logging in to the server.
7926 </p>
7927 </dd>
7928 <dt class="hdlist1">
7929 imap.port
7930 </dt>
7931 <dd>
7932 <p>
7933         An integer port number to connect to on the server.
7934         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
7935         Ignored when imap.tunnel is set.
7936 </p>
7937 </dd>
7938 <dt class="hdlist1">
7939 imap.sslverify
7940 </dt>
7941 <dd>
7942 <p>
7943         A boolean to enable/disable verification of the server certificate
7944         used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
7945         imap.tunnel is set.
7946 </p>
7947 </dd>
7948 <dt class="hdlist1">
7949 imap.preformattedHTML
7950 </dt>
7951 <dd>
7952 <p>
7953         A boolean to enable/disable the use of html encoding when sending
7954         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
7955         and have a content type of text/html.  Ironically, enabling this
7956         option causes Thunderbird to send the patch as a plain/text,
7957         format=fixed email.  Default is <code>false</code>.
7958 </p>
7959 </dd>
7960 <dt class="hdlist1">
7961 imap.authMethod
7962 </dt>
7963 <dd>
7964 <p>
7965         Specify the authentication method for authenticating with the IMAP server.
7966         If Git was built with the NO_CURL option, or if your curl version is older
7967         than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
7968         option, the only supported method is <em>CRAM-MD5</em>. If this is not set
7969         then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
7970 </p>
7971 </dd>
7972 <dt class="hdlist1">
7973 include.path
7974 </dt>
7975 <dt class="hdlist1">
7976 includeIf.&lt;condition&gt;.path
7977 </dt>
7978 <dd>
7979 <p>
7980         Special variables to include other configuration files. See
7981         the "CONFIGURATION FILE" section in the main
7982         <a href="git-config.html">git-config(1)</a> documentation,
7983         specifically the "Includes" and "Conditional Includes" subsections.
7984 </p>
7985 </dd>
7986 <dt class="hdlist1">
7987 index.recordEndOfIndexEntries
7988 </dt>
7989 <dd>
7990 <p>
7991         Specifies whether the index file should include an "End Of Index
7992         Entry" section. This reduces index load time on multiprocessor
7993         machines but produces a message "ignoring EOIE extension" when
7994         reading the index using Git versions before 2.20. Defaults to
7995         <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
7996         otherwise.
7997 </p>
7998 </dd>
7999 <dt class="hdlist1">
8000 index.recordOffsetTable
8001 </dt>
8002 <dd>
8003 <p>
8004         Specifies whether the index file should include an "Index Entry
8005         Offset Table" section. This reduces index load time on
8006         multiprocessor machines but produces a message "ignoring IEOT
8007         extension" when reading the index using Git versions before 2.20.
8008         Defaults to <em>true</em> if index.threads has been explicitly enabled,
8009         <em>false</em> otherwise.
8010 </p>
8011 </dd>
8012 <dt class="hdlist1">
8013 index.sparse
8014 </dt>
8015 <dd>
8016 <p>
8017         When enabled, write the index using sparse-directory entries. This
8018         has no effect unless <code>core.sparseCheckout</code> and
8019         <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
8020 </p>
8021 </dd>
8022 <dt class="hdlist1">
8023 index.threads
8024 </dt>
8025 <dd>
8026 <p>
8027         Specifies the number of threads to spawn when loading the index.
8028         This is meant to reduce index load time on multiprocessor machines.
8029         Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
8030         CPUs and set the number of threads accordingly. Specifying 1 or
8031         <em>false</em> will disable multithreading. Defaults to <em>true</em>.
8032 </p>
8033 </dd>
8034 <dt class="hdlist1">
8035 index.version
8036 </dt>
8037 <dd>
8038 <p>
8039         Specify the version with which new index files should be
8040         initialized.  This does not affect existing repositories.
8041         If <code>feature.manyFiles</code> is enabled, then the default is 4.
8042 </p>
8043 </dd>
8044 <dt class="hdlist1">
8045 index.skipHash
8046 </dt>
8047 <dd>
8048 <p>
8049         When enabled, do not compute the trailing hash for the index file.
8050         This accelerates Git commands that manipulate the index, such as
8051         <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
8052         checksum, write a trailing set of bytes with value zero, indicating
8053         that the computation was skipped.
8054 </p>
8055 <div class="paragraph"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
8056 refuse to parse the index and Git clients older than 2.40.0 will report an
8057 error during <code>git fsck</code>.</p></div>
8058 </dd>
8059 </dl></div>
8060 <div class="dlist"><dl>
8061 <dt class="hdlist1">
8062 <code>init.templateDir</code>
8063 </dt>
8064 <dd>
8065 <p>
8066         Specify the directory from which templates will be copied. (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
8067 </p>
8068 </dd>
8069 <dt class="hdlist1">
8070 <code>init.defaultBranch</code>
8071 </dt>
8072 <dd>
8073 <p>
8074         Allows overriding the default branch name e.g. when initializing
8075         a new repository.
8076 </p>
8077 </dd>
8078 <dt class="hdlist1">
8079 instaweb.browser
8080 </dt>
8081 <dd>
8082 <p>
8083         Specify the program that will be used to browse your working
8084         repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
8085 </p>
8086 </dd>
8087 <dt class="hdlist1">
8088 instaweb.httpd
8089 </dt>
8090 <dd>
8091 <p>
8092         The HTTP daemon command-line to start gitweb on your working
8093         repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
8094 </p>
8095 </dd>
8096 <dt class="hdlist1">
8097 instaweb.local
8098 </dt>
8099 <dd>
8100 <p>
8101         If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
8102         be bound to the local IP (127.0.0.1).
8103 </p>
8104 </dd>
8105 <dt class="hdlist1">
8106 instaweb.modulePath
8107 </dt>
8108 <dd>
8109 <p>
8110         The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
8111         instead of /usr/lib/apache2/modules.  Only used if httpd
8112         is Apache.
8113 </p>
8114 </dd>
8115 <dt class="hdlist1">
8116 instaweb.port
8117 </dt>
8118 <dd>
8119 <p>
8120         The port number to bind the gitweb httpd to. See
8121         <a href="git-instaweb.html">git-instaweb(1)</a>.
8122 </p>
8123 </dd>
8124 <dt class="hdlist1">
8125 interactive.singleKey
8126 </dt>
8127 <dd>
8128 <p>
8129         In interactive commands, allow the user to provide one-letter
8130         input with a single key (i.e., without hitting enter).
8131         Currently this is used by the <code>--patch</code> mode of
8132         <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
8133         <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
8134         <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>.
8135 </p>
8136 </dd>
8137 <dt class="hdlist1">
8138 interactive.diffFilter
8139 </dt>
8140 <dd>
8141 <p>
8142         When an interactive command (such as <code>git add --patch</code>) shows
8143         a colorized diff, git will pipe the diff through the shell
8144         command defined by this configuration variable. The command may
8145         mark up the diff further for human consumption, provided that it
8146         retains a one-to-one correspondence with the lines in the
8147         original diff. Defaults to disabled (no filtering).
8148 </p>
8149 </dd>
8150 <dt class="hdlist1">
8151 log.abbrevCommit
8152 </dt>
8153 <dd>
8154 <p>
8155         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8156         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
8157         override this option with <code>--no-abbrev-commit</code>.
8158 </p>
8159 </dd>
8160 <dt class="hdlist1">
8161 log.date
8162 </dt>
8163 <dd>
8164 <p>
8165         Set the default date-time mode for the <em>log</em> command.
8166         Setting a value for log.date is similar to using <em>git log</em>'s
8167         <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.
8168 </p>
8169 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
8170 "foo" will be used for the date format. Otherwise, "default" will
8171 be used.</p></div>
8172 </dd>
8173 <dt class="hdlist1">
8174 log.decorate
8175 </dt>
8176 <dd>
8177 <p>
8178         Print out the ref names of any commits that are shown by the log
8179         command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
8180         <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
8181         specified, the full ref name (including prefix) will be printed.
8182         If <em>auto</em> is specified, then if the output is going to a terminal,
8183         the ref names are shown as if <em>short</em> were given, otherwise no ref
8184         names are shown. This is the same as the <code>--decorate</code> option
8185         of the <code>git log</code>.
8186 </p>
8187 </dd>
8188 <dt class="hdlist1">
8189 log.initialDecorationSet
8190 </dt>
8191 <dd>
8192 <p>
8193         By default, <code>git log</code> only shows decorations for certain known ref
8194         namespaces. If <em>all</em> is specified, then show all refs as
8195         decorations.
8196 </p>
8197 </dd>
8198 <dt class="hdlist1">
8199 log.excludeDecoration
8200 </dt>
8201 <dd>
8202 <p>
8203         Exclude the specified patterns from the log decorations. This is
8204         similar to the <code>--decorate-refs-exclude</code> command-line option, but
8205         the config option can be overridden by the <code>--decorate-refs</code>
8206         option.
8207 </p>
8208 </dd>
8209 <dt class="hdlist1">
8210 log.diffMerges
8211 </dt>
8212 <dd>
8213 <p>
8214         Set diff format to be used when <code>--diff-merges=on</code> is
8215         specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
8216         details. Defaults to <code>separate</code>.
8217 </p>
8218 </dd>
8219 <dt class="hdlist1">
8220 log.follow
8221 </dt>
8222 <dd>
8223 <p>
8224         If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
8225         a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
8226         i.e. it cannot be used to follow multiple files and does not work well
8227         on non-linear history.
8228 </p>
8229 </dd>
8230 <dt class="hdlist1">
8231 log.graphColors
8232 </dt>
8233 <dd>
8234 <p>
8235         A list of colors, separated by commas, that can be used to draw
8236         history lines in <code>git log --graph</code>.
8237 </p>
8238 </dd>
8239 <dt class="hdlist1">
8240 log.showRoot
8241 </dt>
8242 <dd>
8243 <p>
8244         If true, the initial commit will be shown as a big creation event.
8245         This is equivalent to a diff against an empty tree.
8246         Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
8247         normally hide the root commit will now show it. True by default.
8248 </p>
8249 </dd>
8250 <dt class="hdlist1">
8251 log.showSignature
8252 </dt>
8253 <dd>
8254 <p>
8255         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8256         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
8257 </p>
8258 </dd>
8259 <dt class="hdlist1">
8260 log.mailmap
8261 </dt>
8262 <dd>
8263 <p>
8264         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8265         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
8266         assume <code>--no-use-mailmap</code>. True by default.
8267 </p>
8268 </dd>
8269 <dt class="hdlist1">
8270 lsrefs.unborn
8271 </dt>
8272 <dd>
8273 <p>
8274         May be "advertise" (the default), "allow", or "ignore". If "advertise",
8275         the server will respond to the client sending "unborn" (as described in
8276         <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
8277         protocol v2 capability advertisement. "allow" is the same as
8278         "advertise" except that the server will not advertise support for this
8279         feature; this is useful for load-balanced servers that cannot be
8280         updated atomically (for example), since the administrator could
8281         configure "allow", then after a delay, configure "advertise".
8282 </p>
8283 </dd>
8284 <dt class="hdlist1">
8285 mailinfo.scissors
8286 </dt>
8287 <dd>
8288 <p>
8289         If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
8290         <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
8291         was provided on the command-line. When active, this feature
8292         removes everything from the message body before a scissors
8293         line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
8294 </p>
8295 </dd>
8296 <dt class="hdlist1">
8297 mailmap.file
8298 </dt>
8299 <dd>
8300 <p>
8301         The location of an augmenting mailmap file. The default
8302         mailmap, located in the root of the repository, is loaded
8303         first, then the mailmap file pointed to by this variable.
8304         The location of the mailmap file may be in a repository
8305         subdirectory, or somewhere outside of the repository itself.
8306         See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
8307 </p>
8308 </dd>
8309 <dt class="hdlist1">
8310 mailmap.blob
8311 </dt>
8312 <dd>
8313 <p>
8314         Like <code>mailmap.file</code>, but consider the value as a reference to a
8315         blob in the repository. If both <code>mailmap.file</code> and
8316         <code>mailmap.blob</code> are given, both are parsed, with entries from
8317         <code>mailmap.file</code> taking precedence. In a bare repository, this
8318         defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8319         defaults to empty.
8320 </p>
8321 </dd>
8322 <dt class="hdlist1">
8323 maintenance.auto
8324 </dt>
8325 <dd>
8326 <p>
8327         This boolean config option controls whether some commands run
8328         <code>git maintenance run --auto</code> after doing their normal work. Defaults
8329         to true.
8330 </p>
8331 </dd>
8332 <dt class="hdlist1">
8333 maintenance.strategy
8334 </dt>
8335 <dd>
8336 <p>
8337         This string config option provides a way to specify one of a few
8338         recommended schedules for background maintenance. This only affects
8339         which tasks are run during <code>git maintenance run --schedule=X</code>
8340         commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
8341         Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
8342         then that value is used instead of the one provided by
8343         <code>maintenance.strategy</code>. The possible strategy strings are:
8344 </p>
8345 <div class="ulist"><ul>
8346 <li>
8347 <p>
8348 <code>none</code>: This default setting implies no tasks are run at any schedule.
8349 </p>
8350 </li>
8351 <li>
8352 <p>
8353 <code>incremental</code>: This setting optimizes for performing small maintenance
8354   activities that do not delete any data. This does not schedule the <code>gc</code>
8355   task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8356   <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8357   task weekly.
8358 </p>
8359 </li>
8360 </ul></div>
8361 </dd>
8362 <dt class="hdlist1">
8363 maintenance.&lt;task&gt;.enabled
8364 </dt>
8365 <dd>
8366 <p>
8367         This boolean config option controls whether the maintenance task
8368         with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
8369         <code>git maintenance run</code>. These config values are ignored if a
8370         <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8371         is true.
8372 </p>
8373 </dd>
8374 <dt class="hdlist1">
8375 maintenance.&lt;task&gt;.schedule
8376 </dt>
8377 <dd>
8378 <p>
8379         This config option controls whether or not the given <code>&lt;task&gt;</code> runs
8380         during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
8381         value must be one of "hourly", "daily", or "weekly".
8382 </p>
8383 </dd>
8384 <dt class="hdlist1">
8385 maintenance.commit-graph.auto
8386 </dt>
8387 <dd>
8388 <p>
8389         This integer config option controls how often the <code>commit-graph</code> task
8390         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8391         the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8392         negative value will force the task to run every time. Otherwise, a
8393         positive value implies the command should run when the number of
8394         reachable commits that are not in the commit-graph file is at least
8395         the value of <code>maintenance.commit-graph.auto</code>. The default value is
8396         100.
8397 </p>
8398 </dd>
8399 <dt class="hdlist1">
8400 maintenance.loose-objects.auto
8401 </dt>
8402 <dd>
8403 <p>
8404         This integer config option controls how often the <code>loose-objects</code> task
8405         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8406         the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8407         negative value will force the task to run every time. Otherwise, a
8408         positive value implies the command should run when the number of
8409         loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8410         The default value is 100.
8411 </p>
8412 </dd>
8413 <dt class="hdlist1">
8414 maintenance.incremental-repack.auto
8415 </dt>
8416 <dd>
8417 <p>
8418         This integer config option controls how often the <code>incremental-repack</code>
8419         task should be run as part of <code>git maintenance run --auto</code>. If zero,
8420         then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8421         option. A negative value will force the task to run every time.
8422         Otherwise, a positive value implies the command should run when the
8423         number of pack-files not in the multi-pack-index is at least the value
8424         of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8425 </p>
8426 </dd>
8427 <dt class="hdlist1">
8428 man.viewer
8429 </dt>
8430 <dd>
8431 <p>
8432         Specify the programs that may be used to display help in the
8433         <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8434 </p>
8435 </dd>
8436 <dt class="hdlist1">
8437 man.&lt;tool&gt;.cmd
8438 </dt>
8439 <dd>
8440 <p>
8441         Specify the command to invoke the specified man viewer. The
8442         specified command is evaluated in shell with the man page
8443         passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)
8444 </p>
8445 </dd>
8446 <dt class="hdlist1">
8447 man.&lt;tool&gt;.path
8448 </dt>
8449 <dd>
8450 <p>
8451         Override the path for the given tool that may be used to
8452         display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8453 </p>
8454 </dd>
8455 <dt class="hdlist1">
8456 merge.conflictStyle
8457 </dt>
8458 <dd>
8459 <p>
8460         Specify the style in which conflicted hunks are written out to
8461         working tree files upon merge.  The default is "merge", which
8462         shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
8463         a <code>=======</code> marker, changes made by the other side, and then
8464         a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
8465         marker and the original text before the <code>=======</code> marker.  The
8466         "merge" style tends to produce smaller conflict regions than diff3,
8467         both because of the exclusion of the original text, and because
8468         when a subset of lines match on the two sides, they are just pulled
8469         out of the conflict region.  Another alternate style, "zdiff3", is
8470         similar to diff3 but removes matching lines on the two sides from
8471         the conflict region when those matching lines appear near either
8472         the beginning or end of a conflict region.
8473 </p>
8474 </dd>
8475 <dt class="hdlist1">
8476 merge.defaultToUpstream
8477 </dt>
8478 <dd>
8479 <p>
8480         If merge is called without any commit argument, merge the upstream
8481         branches configured for the current branch by using their last
8482         observed values stored in their remote-tracking branches.
8483         The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
8484         branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
8485         are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
8486         to their corresponding remote-tracking branches, and the tips of
8487         these tracking branches are merged. Defaults to true.
8488 </p>
8489 </dd>
8490 <dt class="hdlist1">
8491 merge.ff
8492 </dt>
8493 <dd>
8494 <p>
8495         By default, Git does not create an extra merge commit when merging
8496         a commit that is a descendant of the current commit. Instead, the
8497         tip of the current branch is fast-forwarded. When set to <code>false</code>,
8498         this variable tells Git to create an extra merge commit in such
8499         a case (equivalent to giving the <code>--no-ff</code> option from the command
8500         line). When set to <code>only</code>, only such fast-forward merges are
8501         allowed (equivalent to giving the <code>--ff-only</code> option from the
8502         command line).
8503 </p>
8504 </dd>
8505 <dt class="hdlist1">
8506 merge.verifySignatures
8507 </dt>
8508 <dd>
8509 <p>
8510         If true, this is equivalent to the --verify-signatures command
8511         line option. See <a href="git-merge.html">git-merge(1)</a> for details.
8512 </p>
8513 </dd>
8514 <dt class="hdlist1">
8515 merge.branchdesc
8516 </dt>
8517 <dd>
8518 <p>
8519         In addition to branch names, populate the log message with
8520         the branch description text associated with them.  Defaults
8521         to false.
8522 </p>
8523 </dd>
8524 <dt class="hdlist1">
8525 merge.log
8526 </dt>
8527 <dd>
8528 <p>
8529         In addition to branch names, populate the log message with at
8530         most the specified number of one-line descriptions from the
8531         actual commits that are being merged.  Defaults to false, and
8532         true is a synonym for 20.
8533 </p>
8534 </dd>
8535 <dt class="hdlist1">
8536 merge.suppressDest
8537 </dt>
8538 <dd>
8539 <p>
8540         By adding a glob that matches the names of integration
8541         branches to this multi-valued configuration variable, the
8542         default merge message computed for merges into these
8543         integration branches will omit "into &lt;branch name&gt;" from
8544         its title.
8545 </p>
8546 <div class="paragraph"><p>An element with an empty value can be used to clear the list
8547 of globs accumulated from previous configuration entries.
8548 When there is no <code>merge.suppressDest</code> variable defined, the
8549 default value of <code>master</code> is used for backward compatibility.</p></div>
8550 </dd>
8551 <dt class="hdlist1">
8552 merge.renameLimit
8553 </dt>
8554 <dd>
8555 <p>
8556         The number of files to consider in the exhaustive portion of
8557         rename detection during a merge.  If not specified, defaults
8558         to the value of diff.renameLimit.  If neither
8559         merge.renameLimit nor diff.renameLimit are specified,
8560         currently defaults to 7000.  This setting has no effect if
8561         rename detection is turned off.
8562 </p>
8563 </dd>
8564 <dt class="hdlist1">
8565 merge.renames
8566 </dt>
8567 <dd>
8568 <p>
8569         Whether Git detects renames.  If set to "false", rename detection
8570         is disabled. If set to "true", basic rename detection is enabled.
8571         Defaults to the value of diff.renames.
8572 </p>
8573 </dd>
8574 <dt class="hdlist1">
8575 merge.directoryRenames
8576 </dt>
8577 <dd>
8578 <p>
8579         Whether Git detects directory renames, affecting what happens at
8580         merge time to new files added to a directory on one side of
8581         history when that directory was renamed on the other side of
8582         history.  If merge.directoryRenames is set to "false", directory
8583         rename detection is disabled, meaning that such new files will be
8584         left behind in the old directory.  If set to "true", directory
8585         rename detection is enabled, meaning that such new files will be
8586         moved into the new directory.  If set to "conflict", a conflict
8587         will be reported for such paths.  If merge.renames is false,
8588         merge.directoryRenames is ignored and treated as false.  Defaults
8589         to "conflict".
8590 </p>
8591 </dd>
8592 <dt class="hdlist1">
8593 merge.renormalize
8594 </dt>
8595 <dd>
8596 <p>
8597         Tell Git that canonical representation of files in the
8598         repository has changed over time (e.g. earlier commits record
8599         text files with CRLF line endings, but recent ones use LF line
8600         endings).  In such a repository, Git can convert the data
8601         recorded in commits to a canonical form before performing a
8602         merge to reduce unnecessary conflicts.  For more information,
8603         see section "Merging branches with differing checkin/checkout
8604         attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
8605 </p>
8606 </dd>
8607 <dt class="hdlist1">
8608 merge.stat
8609 </dt>
8610 <dd>
8611 <p>
8612         Whether to print the diffstat between ORIG_HEAD and the merge result
8613         at the end of the merge.  True by default.
8614 </p>
8615 </dd>
8616 <dt class="hdlist1">
8617 merge.autoStash
8618 </dt>
8619 <dd>
8620 <p>
8621         When set to true, automatically create a temporary stash entry
8622         before the operation begins, and apply it after the operation
8623         ends.  This means that you can run merge on a dirty worktree.
8624         However, use with care: the final stash application after a
8625         successful merge might result in non-trivial conflicts.
8626         This option can be overridden by the <code>--no-autostash</code> and
8627         <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
8628         Defaults to false.
8629 </p>
8630 </dd>
8631 <dt class="hdlist1">
8632 merge.tool
8633 </dt>
8634 <dd>
8635 <p>
8636         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
8637         The list below shows the valid built-in values.
8638         Any other value is treated as a custom merge tool and requires
8639         that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
8640 </p>
8641 </dd>
8642 <dt class="hdlist1">
8643 merge.guitool
8644 </dt>
8645 <dd>
8646 <p>
8647         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
8648         -g/--gui flag is specified. The list below shows the valid built-in values.
8649         Any other value is treated as a custom merge tool and requires that a
8650         corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.
8651 </p>
8652 <div class="dlist"><dl>
8653 <dt class="hdlist1">
8654 <code>araxis</code>
8655 </dt>
8656 <dd>
8657 <p>
8658 Use Araxis Merge (requires a graphical session)
8659 </p>
8660 </dd>
8661 <dt class="hdlist1">
8662 <code>bc</code>
8663 </dt>
8664 <dd>
8665 <p>
8666 Use Beyond Compare (requires a graphical session)
8667 </p>
8668 </dd>
8669 <dt class="hdlist1">
8670 <code>bc3</code>
8671 </dt>
8672 <dd>
8673 <p>
8674 Use Beyond Compare (requires a graphical session)
8675 </p>
8676 </dd>
8677 <dt class="hdlist1">
8678 <code>bc4</code>
8679 </dt>
8680 <dd>
8681 <p>
8682 Use Beyond Compare (requires a graphical session)
8683 </p>
8684 </dd>
8685 <dt class="hdlist1">
8686 <code>codecompare</code>
8687 </dt>
8688 <dd>
8689 <p>
8690 Use Code Compare (requires a graphical session)
8691 </p>
8692 </dd>
8693 <dt class="hdlist1">
8694 <code>deltawalker</code>
8695 </dt>
8696 <dd>
8697 <p>
8698 Use DeltaWalker (requires a graphical session)
8699 </p>
8700 </dd>
8701 <dt class="hdlist1">
8702 <code>diffmerge</code>
8703 </dt>
8704 <dd>
8705 <p>
8706 Use DiffMerge (requires a graphical session)
8707 </p>
8708 </dd>
8709 <dt class="hdlist1">
8710 <code>diffuse</code>
8711 </dt>
8712 <dd>
8713 <p>
8714 Use Diffuse (requires a graphical session)
8715 </p>
8716 </dd>
8717 <dt class="hdlist1">
8718 <code>ecmerge</code>
8719 </dt>
8720 <dd>
8721 <p>
8722 Use ECMerge (requires a graphical session)
8723 </p>
8724 </dd>
8725 <dt class="hdlist1">
8726 <code>emerge</code>
8727 </dt>
8728 <dd>
8729 <p>
8730 Use Emacs' Emerge
8731 </p>
8732 </dd>
8733 <dt class="hdlist1">
8734 <code>examdiff</code>
8735 </dt>
8736 <dd>
8737 <p>
8738 Use ExamDiff Pro (requires a graphical session)
8739 </p>
8740 </dd>
8741 <dt class="hdlist1">
8742 <code>guiffy</code>
8743 </dt>
8744 <dd>
8745 <p>
8746 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
8747 </p>
8748 </dd>
8749 <dt class="hdlist1">
8750 <code>gvimdiff</code>
8751 </dt>
8752 <dd>
8753 <p>
8754 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8755 </p>
8756 </dd>
8757 <dt class="hdlist1">
8758 <code>gvimdiff1</code>
8759 </dt>
8760 <dd>
8761 <p>
8762 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
8763 </p>
8764 </dd>
8765 <dt class="hdlist1">
8766 <code>gvimdiff2</code>
8767 </dt>
8768 <dd>
8769 <p>
8770 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
8771 </p>
8772 </dd>
8773 <dt class="hdlist1">
8774 <code>gvimdiff3</code>
8775 </dt>
8776 <dd>
8777 <p>
8778 Use gVim (requires a graphical session) where only the MERGED file is shown
8779 </p>
8780 </dd>
8781 <dt class="hdlist1">
8782 <code>kdiff3</code>
8783 </dt>
8784 <dd>
8785 <p>
8786 Use KDiff3 (requires a graphical session)
8787 </p>
8788 </dd>
8789 <dt class="hdlist1">
8790 <code>meld</code>
8791 </dt>
8792 <dd>
8793 <p>
8794 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
8795 </p>
8796 </dd>
8797 <dt class="hdlist1">
8798 <code>nvimdiff</code>
8799 </dt>
8800 <dd>
8801 <p>
8802 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8803 </p>
8804 </dd>
8805 <dt class="hdlist1">
8806 <code>nvimdiff1</code>
8807 </dt>
8808 <dd>
8809 <p>
8810 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
8811 </p>
8812 </dd>
8813 <dt class="hdlist1">
8814 <code>nvimdiff2</code>
8815 </dt>
8816 <dd>
8817 <p>
8818 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8819 </p>
8820 </dd>
8821 <dt class="hdlist1">
8822 <code>nvimdiff3</code>
8823 </dt>
8824 <dd>
8825 <p>
8826 Use Neovim where only the MERGED file is shown
8827 </p>
8828 </dd>
8829 <dt class="hdlist1">
8830 <code>opendiff</code>
8831 </dt>
8832 <dd>
8833 <p>
8834 Use FileMerge (requires a graphical session)
8835 </p>
8836 </dd>
8837 <dt class="hdlist1">
8838 <code>p4merge</code>
8839 </dt>
8840 <dd>
8841 <p>
8842 Use HelixCore P4Merge (requires a graphical session)
8843 </p>
8844 </dd>
8845 <dt class="hdlist1">
8846 <code>smerge</code>
8847 </dt>
8848 <dd>
8849 <p>
8850 Use Sublime Merge (requires a graphical session)
8851 </p>
8852 </dd>
8853 <dt class="hdlist1">
8854 <code>tkdiff</code>
8855 </dt>
8856 <dd>
8857 <p>
8858 Use TkDiff (requires a graphical session)
8859 </p>
8860 </dd>
8861 <dt class="hdlist1">
8862 <code>tortoisemerge</code>
8863 </dt>
8864 <dd>
8865 <p>
8866 Use TortoiseMerge (requires a graphical session)
8867 </p>
8868 </dd>
8869 <dt class="hdlist1">
8870 <code>vimdiff</code>
8871 </dt>
8872 <dd>
8873 <p>
8874 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8875 </p>
8876 </dd>
8877 <dt class="hdlist1">
8878 <code>vimdiff1</code>
8879 </dt>
8880 <dd>
8881 <p>
8882 Use Vim with a 2 panes layout (LOCAL and REMOTE)
8883 </p>
8884 </dd>
8885 <dt class="hdlist1">
8886 <code>vimdiff2</code>
8887 </dt>
8888 <dd>
8889 <p>
8890 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8891 </p>
8892 </dd>
8893 <dt class="hdlist1">
8894 <code>vimdiff3</code>
8895 </dt>
8896 <dd>
8897 <p>
8898 Use Vim where only the MERGED file is shown
8899 </p>
8900 </dd>
8901 <dt class="hdlist1">
8902 <code>winmerge</code>
8903 </dt>
8904 <dd>
8905 <p>
8906 Use WinMerge (requires a graphical session)
8907 </p>
8908 </dd>
8909 <dt class="hdlist1">
8910 <code>xxdiff</code>
8911 </dt>
8912 <dd>
8913 <p>
8914 Use xxdiff (requires a graphical session)
8915 </p>
8916 </dd>
8917 </dl></div>
8918 </dd>
8919 <dt class="hdlist1">
8920 merge.verbosity
8921 </dt>
8922 <dd>
8923 <p>
8924         Controls the amount of output shown by the recursive merge
8925         strategy.  Level 0 outputs nothing except a final error
8926         message if conflicts were detected. Level 1 outputs only
8927         conflicts, 2 outputs conflicts and file changes.  Level 5 and
8928         above outputs debugging information.  The default is level 2.
8929         Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
8930 </p>
8931 </dd>
8932 <dt class="hdlist1">
8933 merge.&lt;driver&gt;.name
8934 </dt>
8935 <dd>
8936 <p>
8937         Defines a human-readable name for a custom low-level
8938         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8939 </p>
8940 </dd>
8941 <dt class="hdlist1">
8942 merge.&lt;driver&gt;.driver
8943 </dt>
8944 <dd>
8945 <p>
8946         Defines the command that implements a custom low-level
8947         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8948 </p>
8949 </dd>
8950 <dt class="hdlist1">
8951 merge.&lt;driver&gt;.recursive
8952 </dt>
8953 <dd>
8954 <p>
8955         Names a low-level merge driver to be used when
8956         performing an internal merge between common ancestors.
8957         See <a href="gitattributes.html">gitattributes(5)</a> for details.
8958 </p>
8959 </dd>
8960 <dt class="hdlist1">
8961 mergetool.&lt;tool&gt;.path
8962 </dt>
8963 <dd>
8964 <p>
8965         Override the path for the given tool.  This is useful in case
8966         your tool is not in the PATH.
8967 </p>
8968 </dd>
8969 <dt class="hdlist1">
8970 mergetool.&lt;tool&gt;.cmd
8971 </dt>
8972 <dd>
8973 <p>
8974         Specify the command to invoke the specified merge tool.  The
8975         specified command is evaluated in shell with the following
8976         variables available: <em>BASE</em> is the name of a temporary file
8977         containing the common base of the files to be merged, if available;
8978         <em>LOCAL</em> is the name of a temporary file containing the contents of
8979         the file on the current branch; <em>REMOTE</em> is the name of a temporary
8980         file containing the contents of the file from the branch being
8981         merged; <em>MERGED</em> contains the name of the file to which the merge
8982         tool should write the results of a successful merge.
8983 </p>
8984 </dd>
8985 <dt class="hdlist1">
8986 mergetool.&lt;tool&gt;.hideResolved
8987 </dt>
8988 <dd>
8989 <p>
8990         Allows the user to override the global <code>mergetool.hideResolved</code> value
8991         for a specific tool. See <code>mergetool.hideResolved</code> for the full
8992         description.
8993 </p>
8994 </dd>
8995 <dt class="hdlist1">
8996 mergetool.&lt;tool&gt;.trustExitCode
8997 </dt>
8998 <dd>
8999 <p>
9000         For a custom merge command, specify whether the exit code of
9001         the merge command can be used to determine whether the merge was
9002         successful.  If this is not set to true then the merge target file
9003         timestamp is checked, and the merge is assumed to have been successful
9004         if the file has been updated; otherwise, the user is prompted to
9005         indicate the success of the merge.
9006 </p>
9007 </dd>
9008 <dt class="hdlist1">
9009 mergetool.meld.hasOutput
9010 </dt>
9011 <dd>
9012 <p>
9013         Older versions of <code>meld</code> do not support the <code>--output</code> option.
9014         Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
9015         by inspecting the output of <code>meld --help</code>.  Configuring
9016         <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
9017         use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
9018         to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
9019         and <code>false</code> avoids using <code>--output</code>.
9020 </p>
9021 </dd>
9022 <dt class="hdlist1">
9023 mergetool.meld.useAutoMerge
9024 </dt>
9025 <dd>
9026 <p>
9027         When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
9028         parts automatically, highlight the conflicting parts, and wait for
9029         user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
9030         Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
9031         Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
9032         is supported and will only use <code>--auto-merge</code> when available.  A
9033         value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
9034         default value.
9035 </p>
9036 </dd>
9037 <dt class="hdlist1">
9038 mergetool.&lt;vimdiff variant&gt;.layout
9039 </dt>
9040 <dd>
9041 <p>
9042         Configure the split window layout for vimdiff&#8217;s <code>&lt;variant&gt;</code>, which is any of <code>vimdiff</code>,
9043         <code>nvimdiff</code>, <code>gvimdiff</code>.
9044         Upon launching <code>git mergetool</code> with <code>--tool=&lt;variant&gt;</code> (or without <code>--tool</code>
9045         if <code>merge.tool</code> is configured as <code>&lt;variant&gt;</code>), Git will consult
9046         <code>mergetool.&lt;variant&gt;.layout</code> to determine the tool&#8217;s layout. If the
9047         variant-specific configuration is not available, <code>vimdiff</code>'s is used as
9048         fallback.  If that too is not available, a default layout with 4 windows
9049         will be used.  To configure the layout, see the <code>BACKEND SPECIFIC HINTS</code>
9050         section in <a href="git-mergetool.html">git-mergetool(1)</a>.
9051 </p>
9052 </dd>
9053 <dt class="hdlist1">
9054 mergetool.hideResolved
9055 </dt>
9056 <dd>
9057 <p>
9058         During a merge, Git will automatically resolve as many conflicts as
9059         possible and write the <em>MERGED</em> file containing conflict markers around
9060         any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
9061         represent the versions of the file from before Git&#8217;s conflict
9062         resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
9063         that only the unresolved conflicts are presented to the merge tool. Can
9064         be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
9065         configuration variable. Defaults to <code>false</code>.
9066 </p>
9067 </dd>
9068 <dt class="hdlist1">
9069 mergetool.keepBackup
9070 </dt>
9071 <dd>
9072 <p>
9073         After performing a merge, the original file with conflict markers
9074         can be saved as a file with a <code>.orig</code> extension.  If this variable
9075         is set to <code>false</code> then this file is not preserved.  Defaults to
9076         <code>true</code> (i.e. keep the backup files).
9077 </p>
9078 </dd>
9079 <dt class="hdlist1">
9080 mergetool.keepTemporaries
9081 </dt>
9082 <dd>
9083 <p>
9084         When invoking a custom merge tool, Git uses a set of temporary
9085         files to pass to the tool. If the tool returns an error and this
9086         variable is set to <code>true</code>, then these temporary files will be
9087         preserved; otherwise, they will be removed after the tool has
9088         exited. Defaults to <code>false</code>.
9089 </p>
9090 </dd>
9091 <dt class="hdlist1">
9092 mergetool.writeToTemp
9093 </dt>
9094 <dd>
9095 <p>
9096         Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
9097         conflicting files in the worktree by default.  Git will attempt
9098         to use a temporary directory for these files when set <code>true</code>.
9099         Defaults to <code>false</code>.
9100 </p>
9101 </dd>
9102 <dt class="hdlist1">
9103 mergetool.prompt
9104 </dt>
9105 <dd>
9106 <p>
9107         Prompt before each invocation of the merge resolution program.
9108 </p>
9109 </dd>
9110 <dt class="hdlist1">
9111 mergetool.guiDefault
9112 </dt>
9113 <dd>
9114 <p>
9115         Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
9116         specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
9117         or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
9118         variable value. The default is <code>false</code>, where the <code>--gui</code> argument
9119         must be provided explicitly for the <code>merge.guitool</code> to be used.
9120 </p>
9121 </dd>
9122 <dt class="hdlist1">
9123 notes.mergeStrategy
9124 </dt>
9125 <dd>
9126 <p>
9127         Which merge strategy to choose by default when resolving notes
9128         conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
9129         <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
9130         section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
9131 </p>
9132 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
9133 <a href="git-notes.html">git-notes(1)</a>.</p></div>
9134 </dd>
9135 <dt class="hdlist1">
9136 notes.&lt;name&gt;.mergeStrategy
9137 </dt>
9138 <dd>
9139 <p>
9140         Which merge strategy to choose when doing a notes merge into
9141         refs/notes/&lt;name&gt;.  This overrides the more general
9142         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
9143         <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
9144 </p>
9145 </dd>
9146 <dt class="hdlist1">
9147 notes.displayRef
9148 </dt>
9149 <dd>
9150 <p>
9151         Which ref (or refs, if a glob or specified more than once), in
9152         addition to the default set by <code>core.notesRef</code> or
9153         <code>GIT_NOTES_REF</code>, to read notes from when showing commit
9154         messages with the <em>git log</em> family of commands.
9155 </p>
9156 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
9157 environment variable, which must be a colon separated list of refs or
9158 globs.</p></div>
9159 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
9160 but a glob that does not match any refs is silently ignored.</p></div>
9161 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
9162 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
9163 those commands.</p></div>
9164 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
9165 GIT_NOTES_REF) is also implicitly added to the list of refs to be
9166 displayed.</p></div>
9167 </dd>
9168 <dt class="hdlist1">
9169 notes.rewrite.&lt;command&gt;
9170 </dt>
9171 <dd>
9172 <p>
9173         When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
9174         <code>rebase</code>), if this variable is <code>false</code>, git will not copy
9175         notes from the original to the rewritten commit.  Defaults to
9176         <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.
9177 </p>
9178 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
9179 environment variable, which must be a colon separated list of refs or
9180 globs.</p></div>
9181 </dd>
9182 <dt class="hdlist1">
9183 notes.rewriteMode
9184 </dt>
9185 <dd>
9186 <p>
9187         When copying notes during a rewrite (see the
9188         "notes.rewrite.&lt;command&gt;" option), determines what to do if
9189         the target commit already has a note.  Must be one of
9190         <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
9191         Defaults to <code>concatenate</code>.
9192 </p>
9193 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
9194 environment variable.</p></div>
9195 </dd>
9196 <dt class="hdlist1">
9197 notes.rewriteRef
9198 </dt>
9199 <dd>
9200 <p>
9201         When copying notes during a rewrite, specifies the (fully
9202         qualified) ref whose notes should be copied.  May be a glob,
9203         in which case notes in all matching refs will be copied.  You
9204         may also specify this configuration several times.
9205 </p>
9206 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
9207 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
9208 rewriting for the default commit notes.</p></div>
9209 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
9210 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
9211 </dd>
9212 <dt class="hdlist1">
9213 pack.window
9214 </dt>
9215 <dd>
9216 <p>
9217         The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9218         window size is given on the command line. Defaults to 10.
9219 </p>
9220 </dd>
9221 <dt class="hdlist1">
9222 pack.depth
9223 </dt>
9224 <dd>
9225 <p>
9226         The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9227         maximum depth is given on the command line. Defaults to 50.
9228         Maximum value is 4095.
9229 </p>
9230 </dd>
9231 <dt class="hdlist1">
9232 pack.windowMemory
9233 </dt>
9234 <dd>
9235 <p>
9236         The maximum size of memory that is consumed by each thread
9237         in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
9238         no limit is given on the command line.  The value can be
9239         suffixed with "k", "m", or "g".  When left unconfigured (or
9240         set explicitly to 0), there will be no limit.
9241 </p>
9242 </dd>
9243 <dt class="hdlist1">
9244 pack.compression
9245 </dt>
9246 <dd>
9247 <p>
9248         An integer -1..9, indicating the compression level for objects
9249         in a pack file. -1 is the zlib default. 0 means no
9250         compression, and 1..9 are various speed/size tradeoffs, 9 being
9251         slowest.  If not set,  defaults to core.compression.  If that is
9252         not set,  defaults to -1, the zlib default, which is "a default
9253         compromise between speed and compression (currently equivalent
9254         to level 6)."
9255 </p>
9256 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
9257 all existing objects. You can force recompression by passing the -F option
9258 to <a href="git-repack.html">git-repack(1)</a>.</p></div>
9259 </dd>
9260 <dt class="hdlist1">
9261 pack.allowPackReuse
9262 </dt>
9263 <dd>
9264 <p>
9265         When true or "single", and when reachability bitmaps are
9266         enabled, pack-objects will try to send parts of the bitmapped
9267         packfile verbatim. When "multi", and when a multi-pack
9268         reachability bitmap is available, pack-objects will try to send
9269         parts of all packs in the MIDX.
9270 </p>
9271 <div class="paragraph"><p>If only a single pack bitmap is available, and <code>pack.allowPackReuse</code>
9272 is set to "multi", reuse parts of just the bitmapped packfile. This
9273 can reduce memory and CPU usage to serve fetches, but might result in
9274 sending a slightly larger pack. Defaults to true.</p></div>
9275 </dd>
9276 <dt class="hdlist1">
9277 pack.island
9278 </dt>
9279 <dd>
9280 <p>
9281         An extended regular expression configuring a set of delta
9282         islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
9283         for details.
9284 </p>
9285 </dd>
9286 <dt class="hdlist1">
9287 pack.islandCore
9288 </dt>
9289 <dd>
9290 <p>
9291         Specify an island name which gets to have its objects be
9292         packed first. This creates a kind of pseudo-pack at the front
9293         of one pack, so that the objects from the specified island are
9294         hopefully faster to copy into any pack that should be served
9295         to a user requesting these objects. In practice this means
9296         that the island specified should likely correspond to what is
9297         the most commonly cloned in the repo. See also "DELTA ISLANDS"
9298         in <a href="git-pack-objects.html">git-pack-objects(1)</a>.
9299 </p>
9300 </dd>
9301 <dt class="hdlist1">
9302 pack.deltaCacheSize
9303 </dt>
9304 <dd>
9305 <p>
9306         The maximum memory in bytes used for caching deltas in
9307         <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
9308         This cache is used to speed up the writing object phase by not
9309         having to recompute the final delta result once the best match
9310         for all objects is found.  Repacking large repositories on machines
9311         which are tight with memory might be badly impacted by this though,
9312         especially if this cache pushes the system into swapping.
9313         A value of 0 means no limit. The smallest size of 1 byte may be
9314         used to virtually disable this cache. Defaults to 256 MiB.
9315 </p>
9316 </dd>
9317 <dt class="hdlist1">
9318 pack.deltaCacheLimit
9319 </dt>
9320 <dd>
9321 <p>
9322         The maximum size of a delta, that is cached in
9323         <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
9324         writing object phase by not having to recompute the final delta
9325         result once the best match for all objects is found.
9326         Defaults to 1000. Maximum value is 65535.
9327 </p>
9328 </dd>
9329 <dt class="hdlist1">
9330 pack.threads
9331 </dt>
9332 <dd>
9333 <p>
9334         Specifies the number of threads to spawn when searching for best
9335         delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
9336         be compiled with pthreads otherwise this option is ignored with a
9337         warning. This is meant to reduce packing time on multiprocessor
9338         machines. The required amount of memory for the delta search window
9339         is however multiplied by the number of threads.
9340         Specifying 0 will cause Git to auto-detect the number of CPUs
9341         and set the number of threads accordingly.
9342 </p>
9343 </dd>
9344 <dt class="hdlist1">
9345 pack.indexVersion
9346 </dt>
9347 <dd>
9348 <p>
9349         Specify the default pack index version.  Valid values are 1 for
9350         legacy pack index used by Git versions prior to 1.5.2, and 2 for
9351         the new pack index with capabilities for packs larger than 4 GB
9352         as well as proper protection against the repacking of corrupted
9353         packs.  Version 2 is the default.  Note that version 2 is enforced
9354         and this config option is ignored whenever the corresponding pack is
9355         larger than 2 GB.
9356 </p>
9357 <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9358 cloning or fetching over a non-native protocol (e.g. "http")
9359 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9360 other side may give you a repository that cannot be accessed with your
9361 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9362 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
9363 the <code>*.idx</code> file.</p></div>
9364 </dd>
9365 <dt class="hdlist1">
9366 pack.packSizeLimit
9367 </dt>
9368 <dd>
9369 <p>
9370         The maximum size of a pack.  This setting only affects
9371         packing to a file when repacking, i.e. the git:// protocol
9372         is unaffected.  It can be overridden by the <code>--max-pack-size</code>
9373         option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
9374         in the creation of multiple packfiles.
9375 </p>
9376 <div class="paragraph"><p>Note that this option is rarely useful, and may result in a larger total
9377 on-disk size (because Git will not store deltas between packs) and
9378 worse runtime performance (object lookup within multiple packs is
9379 slower than a single pack, and optimizations like reachability bitmaps
9380 cannot cope with multiple packs).</p></div>
9381 <div class="paragraph"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9382 filesystem does not support large files), this option may help. But if
9383 your goal is to transmit a packfile over a medium that supports limited
9384 sizes (e.g., removable media that cannot store the whole repository),
9385 you are likely better off creating a single large packfile and splitting
9386 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9387 <div class="paragraph"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9388 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9389 </dd>
9390 <dt class="hdlist1">
9391 pack.useBitmaps
9392 </dt>
9393 <dd>
9394 <p>
9395         When true, git will use pack bitmaps (if available) when packing
9396         to stdout (e.g., during the server side of a fetch). Defaults to
9397         true. You should not generally need to turn this off unless
9398         you are debugging pack bitmaps.
9399 </p>
9400 </dd>
9401 <dt class="hdlist1">
9402 pack.useBitmapBoundaryTraversal
9403 </dt>
9404 <dd>
9405 <p>
9406         When true, Git will use an experimental algorithm for computing
9407         reachability queries with bitmaps. Instead of building up
9408         complete bitmaps for all of the negated tips and then OR-ing
9409         them together, consider negated tips with existing bitmaps as
9410         additive (i.e. OR-ing them into the result if they exist,
9411         ignoring them otherwise), and build up a bitmap at the boundary
9412         instead.
9413 </p>
9414 <div class="paragraph"><p>When using this algorithm, Git may include too many objects as a result
9415 of not opening up trees belonging to certain UNINTERESTING commits. This
9416 inexactness matches the non-bitmap traversal algorithm.</p></div>
9417 <div class="paragraph"><p>In many cases, this can provide a speed-up over the exact algorithm,
9418 particularly when there is poor bitmap coverage of the negated side of
9419 the query.</p></div>
9420 </dd>
9421 <dt class="hdlist1">
9422 pack.useSparse
9423 </dt>
9424 <dd>
9425 <p>
9426         When true, git will default to using the <em>--sparse</em> option in
9427         <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9428         algorithm only walks trees that appear in paths that introduce new
9429         objects. This can have significant performance benefits when
9430         computing a pack to send a small change. However, it is possible
9431         that extra objects are added to the pack-file if the included
9432         commits contain certain types of direct renames. Default is
9433         <code>true</code>.
9434 </p>
9435 </dd>
9436 <dt class="hdlist1">
9437 pack.preferBitmapTips
9438 </dt>
9439 <dd>
9440 <p>
9441         When selecting which commits will receive bitmaps, prefer a
9442         commit at the tip of any reference that is a suffix of any value
9443         of this configuration over any other commits in the "selection
9444         window".
9445 </p>
9446 <div class="paragraph"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9447 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9448 necessarily be selected. This is because commits are selected for
9449 bitmaps from within a series of windows of variable length.</p></div>
9450 <div class="paragraph"><p>If a commit at the tip of any reference which is a suffix of any value
9451 of this configuration is seen in a window, it is immediately given
9452 preference over any other commit in that window.</p></div>
9453 </dd>
9454 <dt class="hdlist1">
9455 pack.writeBitmaps (deprecated)
9456 </dt>
9457 <dd>
9458 <p>
9459         This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9460 </p>
9461 </dd>
9462 <dt class="hdlist1">
9463 pack.writeBitmapHashCache
9464 </dt>
9465 <dd>
9466 <p>
9467         When true, git will include a "hash cache" section in the bitmap
9468         index (if one is written). This cache can be used to feed git&#8217;s
9469         delta heuristics, potentially leading to better deltas between
9470         bitmapped and non-bitmapped objects (e.g., when serving a fetch
9471         between an older, bitmapped pack and objects that have been
9472         pushed since the last gc). The downside is that it consumes 4
9473         bytes per object of disk space. Defaults to true.
9474 </p>
9475 <div class="paragraph"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9476 computed; instead, any namehashes stored in an existing bitmap are
9477 permuted into their appropriate location when writing a new bitmap.</p></div>
9478 </dd>
9479 <dt class="hdlist1">
9480 pack.writeBitmapLookupTable
9481 </dt>
9482 <dd>
9483 <p>
9484         When true, Git will include a "lookup table" section in the
9485         bitmap index (if one is written). This table is used to defer
9486         loading individual bitmaps as late as possible. This can be
9487         beneficial in repositories that have relatively large bitmap
9488         indexes. Defaults to false.
9489 </p>
9490 </dd>
9491 <dt class="hdlist1">
9492 pack.readReverseIndex
9493 </dt>
9494 <dd>
9495 <p>
9496         When true, git will read any .rev file(s) that may be available
9497         (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
9498         will be generated from scratch and stored in memory. Defaults to
9499         true.
9500 </p>
9501 </dd>
9502 <dt class="hdlist1">
9503 pack.writeReverseIndex
9504 </dt>
9505 <dd>
9506 <p>
9507         When true, git will write a corresponding .rev file (see:
9508         <a href="gitformat-pack.html">gitformat-pack(5)</a>)
9509         for each new packfile that it writes in all places except for
9510         <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
9511         Defaults to true.
9512 </p>
9513 </dd>
9514 <dt class="hdlist1">
9515 pager.&lt;cmd&gt;
9516 </dt>
9517 <dd>
9518 <p>
9519         If the value is boolean, turns on or off pagination of the
9520         output of a particular Git subcommand when writing to a tty.
9521         Otherwise, turns on pagination for the subcommand using the
9522         pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
9523         or <code>--no-pager</code> is specified on the command line, it takes
9524         precedence over this option.  To disable pagination for all
9525         commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9526 </p>
9527 </dd>
9528 <dt class="hdlist1">
9529 pretty.&lt;name&gt;
9530 </dt>
9531 <dd>
9532 <p>
9533         Alias for a --pretty= format string, as specified in
9534         <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
9535         as the built-in pretty formats could. For example,
9536         running <code>git config pretty.changelog "format:* %H %s"</code>
9537         would cause the invocation <code>git log --pretty=changelog</code>
9538         to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
9539         Note that an alias with the same name as a built-in format
9540         will be silently ignored.
9541 </p>
9542 </dd>
9543 <dt class="hdlist1">
9544 protocol.allow
9545 </dt>
9546 <dd>
9547 <p>
9548         If set, provide a user defined default policy for all protocols which
9549         don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
9550         if unset, known-safe protocols (http, https, git, ssh) have a
9551         default policy of <code>always</code>, known-dangerous protocols (ext) have a
9552         default policy of <code>never</code>, and all other protocols (including file)
9553         have a default policy of <code>user</code>.  Supported policies:
9554 </p>
9555 <div class="openblock">
9556 <div class="content">
9557 <div class="ulist"><ul>
9558 <li>
9559 <p>
9560 <code>always</code> - protocol is always able to be used.
9561 </p>
9562 </li>
9563 <li>
9564 <p>
9565 <code>never</code> - protocol is never able to be used.
9566 </p>
9567 </li>
9568 <li>
9569 <p>
9570 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9571   either unset or has a value of 1.  This policy should be used when you want a
9572   protocol to be directly usable by the user but don&#8217;t want it used by commands which
9573   execute clone/fetch/push commands without user input, e.g. recursive
9574   submodule initialization.
9575 </p>
9576 </li>
9577 </ul></div>
9578 </div></div>
9579 </dd>
9580 <dt class="hdlist1">
9581 protocol.&lt;name&gt;.allow
9582 </dt>
9583 <dd>
9584 <p>
9585         Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
9586         commands. See <code>protocol.allow</code> above for the available policies.
9587 </p>
9588 <div class="paragraph"><p>The protocol names currently used by git are:</p></div>
9589 <div class="openblock">
9590 <div class="content">
9591 <div class="ulist"><ul>
9592 <li>
9593 <p>
9594 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9595     or local paths)
9596 </p>
9597 </li>
9598 <li>
9599 <p>
9600 <code>git</code>: the anonymous git protocol over a direct TCP
9601     connection (or proxy, if configured)
9602 </p>
9603 </li>
9604 <li>
9605 <p>
9606 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9607     <code>ssh://</code>, etc).
9608 </p>
9609 </li>
9610 <li>
9611 <p>
9612 <code>http</code>: git over http, both "smart http" and "dumb http".
9613     Note that this does <em>not</em> include <code>https</code>; if you want to configure
9614     both, you must do so individually.
9615 </p>
9616 </li>
9617 <li>
9618 <p>
9619 any external helpers are named by their protocol (e.g., use
9620     <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9621 </p>
9622 </li>
9623 </ul></div>
9624 </div></div>
9625 </dd>
9626 <dt class="hdlist1">
9627 protocol.version
9628 </dt>
9629 <dd>
9630 <p>
9631         If set, clients will attempt to communicate with a server
9632         using the specified protocol version.  If the server does
9633         not support it, communication falls back to version 0.
9634         If unset, the default is <code>2</code>.
9635         Supported versions:
9636 </p>
9637 <div class="openblock">
9638 <div class="content">
9639 <div class="ulist"><ul>
9640 <li>
9641 <p>
9642 <code>0</code> - the original wire protocol.
9643 </p>
9644 </li>
9645 <li>
9646 <p>
9647 <code>1</code> - the original wire protocol with the addition of a version string
9648   in the initial response from the server.
9649 </p>
9650 </li>
9651 <li>
9652 <p>
9653 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.
9654 </p>
9655 </li>
9656 </ul></div>
9657 </div></div>
9658 </dd>
9659 <dt class="hdlist1">
9660 pull.ff
9661 </dt>
9662 <dd>
9663 <p>
9664         By default, Git does not create an extra merge commit when merging
9665         a commit that is a descendant of the current commit. Instead, the
9666         tip of the current branch is fast-forwarded. When set to <code>false</code>,
9667         this variable tells Git to create an extra merge commit in such
9668         a case (equivalent to giving the <code>--no-ff</code> option from the command
9669         line). When set to <code>only</code>, only such fast-forward merges are
9670         allowed (equivalent to giving the <code>--ff-only</code> option from the
9671         command line). This setting overrides <code>merge.ff</code> when pulling.
9672 </p>
9673 </dd>
9674 <dt class="hdlist1">
9675 pull.rebase
9676 </dt>
9677 <dd>
9678 <p>
9679         When true, rebase branches on top of the fetched branch, instead
9680         of merging the default branch from the default remote when "git
9681         pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
9682         per-branch basis.
9683 </p>
9684 <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>
9685 so that the local merge commits are included in the rebase (see
9686 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
9687 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9688 mode.</p></div>
9689 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9690 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
9691 for details).</p></div>
9692 </dd>
9693 <dt class="hdlist1">
9694 pull.octopus
9695 </dt>
9696 <dd>
9697 <p>
9698         The default merge strategy to use when pulling multiple branches
9699         at once.
9700 </p>
9701 </dd>
9702 <dt class="hdlist1">
9703 pull.twohead
9704 </dt>
9705 <dd>
9706 <p>
9707         The default merge strategy to use when pulling a single branch.
9708 </p>
9709 </dd>
9710 <dt class="hdlist1">
9711 push.autoSetupRemote
9712 </dt>
9713 <dd>
9714 <p>
9715         If set to "true" assume <code>--set-upstream</code> on default push when no
9716         upstream tracking exists for the current branch; this option
9717         takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9718         and <em>current</em>. It is useful if by default you want new branches
9719         to be pushed to the default remote (like the behavior of
9720         <em>push.default=current</em>) and you also want the upstream tracking
9721         to be set. Workflows most likely to benefit from this option are
9722         <em>simple</em> central workflows where all branches are expected to
9723         have the same name on the remote.
9724 </p>
9725 </dd>
9726 <dt class="hdlist1">
9727 push.default
9728 </dt>
9729 <dd>
9730 <p>
9731         Defines the action <code>git push</code> should take if no refspec is
9732         given (whether from the command-line, config, or elsewhere).
9733         Different values are well-suited for
9734         specific workflows; for instance, in a purely central workflow
9735         (i.e. the fetch source is equal to the push destination),
9736         <code>upstream</code> is probably what you want.  Possible values are:
9737 </p>
9738 <div class="openblock">
9739 <div class="content">
9740 <div class="ulist"><ul>
9741 <li>
9742 <p>
9743 <code>nothing</code> - do not push anything (error out) unless a refspec is
9744   given. This is primarily meant for people who want to
9745   avoid mistakes by always being explicit.
9746 </p>
9747 </li>
9748 <li>
9749 <p>
9750 <code>current</code> - push the current branch to update a branch with the same
9751   name on the receiving end.  Works in both central and non-central
9752   workflows.
9753 </p>
9754 </li>
9755 <li>
9756 <p>
9757 <code>upstream</code> - push the current branch back to the branch whose
9758   changes are usually integrated into the current branch (which is
9759   called <code>@{upstream}</code>).  This mode only makes sense if you are
9760   pushing to the same repository you would normally pull from
9761   (i.e. central workflow).
9762 </p>
9763 </li>
9764 <li>
9765 <p>
9766 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
9767 </p>
9768 </li>
9769 <li>
9770 <p>
9771 <code>simple</code> - push the current branch with the same name on the remote.
9772 </p>
9773 <div class="paragraph"><p>If you are working on a centralized workflow (pushing to the same repository you
9774 pull from, which is typically <code>origin</code>), then you need to configure an upstream
9775 branch with the same name.</p></div>
9776 <div class="paragraph"><p>This mode is the default since Git 2.0, and is the safest option suited for
9777 beginners.</p></div>
9778 </li>
9779 <li>
9780 <p>
9781 <code>matching</code> - push all branches having the same name on both ends.
9782   This makes the repository you are pushing to remember the set of
9783   branches that will be pushed out (e.g. if you always push <em>maint</em>
9784   and <em>master</em> there and no other branches, the repository you push
9785   to will have these two branches, and your local <em>maint</em> and
9786   <em>master</em> will be pushed there).
9787 </p>
9788 <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
9789 branches you would push out are ready to be pushed out before
9790 running <em>git push</em>, as the whole point of this mode is to allow you
9791 to push all of the branches in one go.  If you usually finish work
9792 on only one branch and push out the result, while other branches are
9793 unfinished, this mode is not for you.  Also this mode is not
9794 suitable for pushing into a shared central repository, as other
9795 people may add new branches there, or update the tip of existing
9796 branches outside your control.</p></div>
9797 <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
9798 new default).</p></div>
9799 </li>
9800 </ul></div>
9801 </div></div>
9802 </dd>
9803 <dt class="hdlist1">
9804 push.followTags
9805 </dt>
9806 <dd>
9807 <p>
9808         If set to true, enable <code>--follow-tags</code> option by default.  You
9809         may override this configuration at time of push by specifying
9810         <code>--no-follow-tags</code>.
9811 </p>
9812 </dd>
9813 <dt class="hdlist1">
9814 push.gpgSign
9815 </dt>
9816 <dd>
9817 <p>
9818         May be set to a boolean value, or the string <em>if-asked</em>. A true
9819         value causes all pushes to be GPG signed, as if <code>--signed</code> is
9820         passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
9821         pushes to be signed if the server supports it, as if
9822         <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
9823         override a value from a lower-priority config file. An explicit
9824         command-line flag always overrides this config option.
9825 </p>
9826 </dd>
9827 <dt class="hdlist1">
9828 push.pushOption
9829 </dt>
9830 <dd>
9831 <p>
9832         When no <code>--push-option=&lt;option&gt;</code> argument is given from the
9833         command line, <code>git push</code> behaves as if each &lt;value&gt; of
9834         this variable is given as <code>--push-option=&lt;value&gt;</code>.
9835 </p>
9836 <div class="paragraph"><p>This is a multi-valued variable, and an empty value can be used in a
9837 higher priority configuration file (e.g. <code>.git/config</code> in a
9838 repository) to clear the values inherited from a lower priority
9839 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
9840 <div class="listingblock">
9841 <div class="content">
9842 <pre><code>Example:
9843
9844 /etc/gitconfig
9845   push.pushoption = a
9846   push.pushoption = b
9847
9848 ~/.gitconfig
9849   push.pushoption = c
9850
9851 repo/.git/config
9852   push.pushoption =
9853   push.pushoption = b
9854
9855 This will result in only b (a and c are cleared).</code></pre>
9856 </div></div>
9857 </dd>
9858 <dt class="hdlist1">
9859 push.recurseSubmodules
9860 </dt>
9861 <dd>
9862 <p>
9863         May be "check", "on-demand", "only", or "no", with the same behavior
9864         as that of "push --recurse-submodules".
9865         If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
9866         set (in which case a <em>true</em> value means <em>on-demand</em>).
9867 </p>
9868 </dd>
9869 <dt class="hdlist1">
9870 push.useForceIfIncludes
9871 </dt>
9872 <dd>
9873 <p>
9874         If set to "true", it is equivalent to specifying
9875         <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
9876         in the command line. Adding <code>--no-force-if-includes</code> at the
9877         time of push overrides this configuration setting.
9878 </p>
9879 </dd>
9880 <dt class="hdlist1">
9881 push.negotiate
9882 </dt>
9883 <dd>
9884 <p>
9885         If set to "true", attempt to reduce the size of the packfile
9886         sent by rounds of negotiation in which the client and the
9887         server attempt to find commits in common. If "false", Git will
9888         rely solely on the server&#8217;s ref advertisement to find commits
9889         in common.
9890 </p>
9891 </dd>
9892 <dt class="hdlist1">
9893 push.useBitmaps
9894 </dt>
9895 <dd>
9896 <p>
9897         If set to "false", disable use of bitmaps for "git push" even if
9898         <code>pack.useBitmaps</code> is "true", without preventing other git operations
9899         from using bitmaps. Default is true.
9900 </p>
9901 </dd>
9902 <dt class="hdlist1">
9903 rebase.backend
9904 </dt>
9905 <dd>
9906 <p>
9907         Default backend to use for rebasing.  Possible choices are
9908         <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
9909         all remaining capabilities of the apply backend, this setting
9910         may become unused.
9911 </p>
9912 </dd>
9913 <dt class="hdlist1">
9914 rebase.stat
9915 </dt>
9916 <dd>
9917 <p>
9918         Whether to show a diffstat of what changed upstream since the last
9919         rebase. False by default.
9920 </p>
9921 </dd>
9922 <dt class="hdlist1">
9923 rebase.autoSquash
9924 </dt>
9925 <dd>
9926 <p>
9927         If set to true, enable the <code>--autosquash</code> option of
9928         <a href="git-rebase.html">git-rebase(1)</a> by default for interactive mode.
9929         This can be overridden with the <code>--no-autosquash</code> option.
9930 </p>
9931 </dd>
9932 <dt class="hdlist1">
9933 rebase.autoStash
9934 </dt>
9935 <dd>
9936 <p>
9937         When set to true, automatically create a temporary stash entry
9938         before the operation begins, and apply it after the operation
9939         ends.  This means that you can run rebase on a dirty worktree.
9940         However, use with care: the final stash application after a
9941         successful rebase might result in non-trivial conflicts.
9942         This option can be overridden by the <code>--no-autostash</code> and
9943         <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
9944         Defaults to false.
9945 </p>
9946 </dd>
9947 <dt class="hdlist1">
9948 rebase.updateRefs
9949 </dt>
9950 <dd>
9951 <p>
9952         If set to true enable <code>--update-refs</code> option by default.
9953 </p>
9954 </dd>
9955 <dt class="hdlist1">
9956 rebase.missingCommitsCheck
9957 </dt>
9958 <dd>
9959 <p>
9960         If set to "warn", git rebase -i will print a warning if some
9961         commits are removed (e.g. a line was deleted), however the
9962         rebase will still proceed. If set to "error", it will print
9963         the previous warning and stop the rebase, <em>git rebase
9964         --edit-todo</em> can then be used to correct the error. If set to
9965         "ignore", no checking is done.
9966         To drop a commit without warning or error, use the <code>drop</code>
9967         command in the todo list.
9968         Defaults to "ignore".
9969 </p>
9970 </dd>
9971 <dt class="hdlist1">
9972 rebase.instructionFormat
9973 </dt>
9974 <dd>
9975 <p>
9976         A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
9977         todo list during an interactive rebase.  The format will
9978         automatically have the commit hash prepended to the format.
9979 </p>
9980 </dd>
9981 <dt class="hdlist1">
9982 rebase.abbreviateCommands
9983 </dt>
9984 <dd>
9985 <p>
9986         If set to true, <code>git rebase</code> will use abbreviated command names in the
9987         todo list resulting in something like this:
9988 </p>
9989 <div class="listingblock">
9990 <div class="content">
9991 <pre><code>        p deadbee The oneline of the commit
9992         p fa1afe1 The oneline of the next commit
9993         ...</code></pre>
9994 </div></div>
9995 <div class="paragraph"><p>instead of:</p></div>
9996 <div class="listingblock">
9997 <div class="content">
9998 <pre><code>        pick deadbee The oneline of the commit
9999         pick fa1afe1 The oneline of the next commit
10000         ...</code></pre>
10001 </div></div>
10002 <div class="paragraph"><p>Defaults to false.</p></div>
10003 </dd>
10004 <dt class="hdlist1">
10005 rebase.rescheduleFailedExec
10006 </dt>
10007 <dd>
10008 <p>
10009         Automatically reschedule <code>exec</code> commands that failed. This only makes
10010         sense in interactive mode (or when an <code>--exec</code> option was provided).
10011         This is the same as specifying the <code>--reschedule-failed-exec</code> option.
10012 </p>
10013 </dd>
10014 <dt class="hdlist1">
10015 rebase.forkPoint
10016 </dt>
10017 <dd>
10018 <p>
10019         If set to false set <code>--no-fork-point</code> option by default.
10020 </p>
10021 </dd>
10022 <dt class="hdlist1">
10023 rebase.rebaseMerges
10024 </dt>
10025 <dd>
10026 <p>
10027         Whether and how to set the <code>--rebase-merges</code> option by default. Can
10028         be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
10029         true or to <code>no-rebase-cousins</code> is equivalent to
10030         <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
10031         equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
10032         equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
10033         command line, with or without an argument, overrides any
10034         <code>rebase.rebaseMerges</code> configuration.
10035 </p>
10036 </dd>
10037 <dt class="hdlist1">
10038 rebase.maxLabelLength
10039 </dt>
10040 <dd>
10041 <p>
10042         When generating label names from commit subjects, truncate the names to
10043         this length. By default, the names are truncated to a little less than
10044         <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
10045         corresponding loose refs).
10046 </p>
10047 </dd>
10048 <dt class="hdlist1">
10049 receive.advertiseAtomic
10050 </dt>
10051 <dd>
10052 <p>
10053         By default, git-receive-pack will advertise the atomic push
10054         capability to its clients. If you don&#8217;t want to advertise this
10055         capability, set this variable to false.
10056 </p>
10057 </dd>
10058 <dt class="hdlist1">
10059 receive.advertisePushOptions
10060 </dt>
10061 <dd>
10062 <p>
10063         When set to true, git-receive-pack will advertise the push options
10064         capability to its clients. False by default.
10065 </p>
10066 </dd>
10067 <dt class="hdlist1">
10068 receive.autogc
10069 </dt>
10070 <dd>
10071 <p>
10072         By default, git-receive-pack will run "git maintenance run --auto" after
10073         receiving data from git-push and updating refs.  You can stop
10074         it by setting this variable to false.
10075 </p>
10076 </dd>
10077 <dt class="hdlist1">
10078 receive.certNonceSeed
10079 </dt>
10080 <dd>
10081 <p>
10082         By setting this variable to a string, <code>git receive-pack</code>
10083         will accept a <code>git push --signed</code> and verify it by using
10084         a "nonce" protected by HMAC using this string as a secret
10085         key.
10086 </p>
10087 </dd>
10088 <dt class="hdlist1">
10089 receive.certNonceSlop
10090 </dt>
10091 <dd>
10092 <p>
10093         When a <code>git push --signed</code> sends a push certificate with a
10094         "nonce" that was issued by a receive-pack serving the same
10095         repository within this many seconds, export the "nonce"
10096         found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
10097         hooks (instead of what the receive-pack asked the sending
10098         side to include).  This may allow writing checks in
10099         <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
10100         checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
10101         that records by how many seconds the nonce is stale to
10102         decide if they want to accept the certificate, they only
10103         can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
10104 </p>
10105 </dd>
10106 <dt class="hdlist1">
10107 receive.fsckObjects
10108 </dt>
10109 <dd>
10110 <p>
10111         If it is set to true, git-receive-pack will check all received
10112         objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
10113         Defaults to false. If not set, the value of
10114         <code>transfer.fsckObjects</code> is used instead.
10115 </p>
10116 </dd>
10117 <dt class="hdlist1">
10118 receive.fsck.&lt;msg-id&gt;
10119 </dt>
10120 <dd>
10121 <p>
10122         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
10123         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
10124         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
10125         details.
10126 </p>
10127 </dd>
10128 <dt class="hdlist1">
10129 receive.fsck.skipList
10130 </dt>
10131 <dd>
10132 <p>
10133         Acts like <code>fsck.skipList</code>, but is used by
10134         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
10135         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
10136         details.
10137 </p>
10138 </dd>
10139 <dt class="hdlist1">
10140 receive.keepAlive
10141 </dt>
10142 <dd>
10143 <p>
10144         After receiving the pack from the client, <code>receive-pack</code> may
10145         produce no output (if <code>--quiet</code> was specified) while processing
10146         the pack, causing some networks to drop the TCP connection.
10147         With this option set, if <code>receive-pack</code> does not transmit
10148         any data in this phase for <code>receive.keepAlive</code> seconds, it will
10149         send a short keepalive packet.  The default is 5 seconds; set
10150         to 0 to disable keepalives entirely.
10151 </p>
10152 </dd>
10153 <dt class="hdlist1">
10154 receive.unpackLimit
10155 </dt>
10156 <dd>
10157 <p>
10158         If the number of objects received in a push is below this
10159         limit then the objects will be unpacked into loose object
10160         files. However if the number of received objects equals or
10161         exceeds this limit then the received pack will be stored as
10162         a pack, after adding any missing delta bases.  Storing the
10163         pack from a push can make the push operation complete faster,
10164         especially on slow filesystems.  If not set, the value of
10165         <code>transfer.unpackLimit</code> is used instead.
10166 </p>
10167 </dd>
10168 <dt class="hdlist1">
10169 receive.maxInputSize
10170 </dt>
10171 <dd>
10172 <p>
10173         If the size of the incoming pack stream is larger than this
10174         limit, then git-receive-pack will error out, instead of
10175         accepting the pack file. If not set or set to 0, then the size
10176         is unlimited.
10177 </p>
10178 </dd>
10179 <dt class="hdlist1">
10180 receive.denyDeletes
10181 </dt>
10182 <dd>
10183 <p>
10184         If set to true, git-receive-pack will deny a ref update that deletes
10185         the ref. Use this to prevent such a ref deletion via a push.
10186 </p>
10187 </dd>
10188 <dt class="hdlist1">
10189 receive.denyDeleteCurrent
10190 </dt>
10191 <dd>
10192 <p>
10193         If set to true, git-receive-pack will deny a ref update that
10194         deletes the currently checked out branch of a non-bare repository.
10195 </p>
10196 </dd>
10197 <dt class="hdlist1">
10198 receive.denyCurrentBranch
10199 </dt>
10200 <dd>
10201 <p>
10202         If set to true or "refuse", git-receive-pack will deny a ref update
10203         to the currently checked out branch of a non-bare repository.
10204         Such a push is potentially dangerous because it brings the HEAD
10205         out of sync with the index and working tree. If set to "warn",
10206         print a warning of such a push to stderr, but allow the push to
10207         proceed. If set to false or "ignore", allow such pushes with no
10208         message. Defaults to "refuse".
10209 </p>
10210 <div class="paragraph"><p>Another option is "updateInstead" which will update the working
10211 tree if pushing into the current branch.  This option is
10212 intended for synchronizing working directories when one side is not easily
10213 accessible via interactive ssh (e.g. a live web site, hence the requirement
10214 that the working directory be clean). This mode also comes in handy when
10215 developing inside a VM to test and fix code on different Operating Systems.</p></div>
10216 <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
10217 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
10218 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p></div>
10219 </dd>
10220 <dt class="hdlist1">
10221 receive.denyNonFastForwards
10222 </dt>
10223 <dd>
10224 <p>
10225         If set to true, git-receive-pack will deny a ref update which is
10226         not a fast-forward. Use this to prevent such an update via a push,
10227         even if that push is forced. This configuration variable is
10228         set when initializing a shared repository.
10229 </p>
10230 </dd>
10231 <dt class="hdlist1">
10232 receive.hideRefs
10233 </dt>
10234 <dd>
10235 <p>
10236         This variable is the same as <code>transfer.hideRefs</code>, but applies
10237         only to <code>receive-pack</code> (and so affects pushes, but not fetches).
10238         An attempt to update or delete a hidden ref by <code>git push</code> is
10239         rejected.
10240 </p>
10241 </dd>
10242 <dt class="hdlist1">
10243 receive.procReceiveRefs
10244 </dt>
10245 <dd>
10246 <p>
10247         This is a multi-valued variable that defines reference prefixes
10248         to match the commands in <code>receive-pack</code>.  Commands matching the
10249         prefixes will be executed by an external hook "proc-receive",
10250         instead of the internal <code>execute_commands</code> function.  If this
10251         variable is not defined, the "proc-receive" hook will never be
10252         used, and all commands will be executed by the internal
10253         <code>execute_commands</code> function.
10254 </p>
10255 <div class="paragraph"><p>For example, if this variable is set to "refs/for", pushing to reference
10256 such as "refs/for/master" will not create or update a reference named
10257 "refs/for/master", but may create or update a pull request directly by
10258 running the hook "proc-receive".</p></div>
10259 <div class="paragraph"><p>Optional modifiers can be provided in the beginning of the value to filter
10260 commands for specific actions: create (a), modify (m), delete (d).
10261 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
10262 E.g.:</p></div>
10263 <div class="literalblock">
10264 <div class="content">
10265 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
10266 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
10267 </div></div>
10268 </dd>
10269 <dt class="hdlist1">
10270 receive.updateServerInfo
10271 </dt>
10272 <dd>
10273 <p>
10274         If set to true, git-receive-pack will run git-update-server-info
10275         after receiving data from git-push and updating refs.
10276 </p>
10277 </dd>
10278 <dt class="hdlist1">
10279 receive.shallowUpdate
10280 </dt>
10281 <dd>
10282 <p>
10283         If set to true, .git/shallow can be updated when new refs
10284         require new shallow roots. Otherwise those refs are rejected.
10285 </p>
10286 </dd>
10287 <dt class="hdlist1">
10288 remote.pushDefault
10289 </dt>
10290 <dd>
10291 <p>
10292         The remote to push to by default.  Overrides
10293         <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
10294         <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
10295 </p>
10296 </dd>
10297 <dt class="hdlist1">
10298 remote.&lt;name&gt;.url
10299 </dt>
10300 <dd>
10301 <p>
10302         The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
10303         <a href="git-push.html">git-push(1)</a>.
10304 </p>
10305 </dd>
10306 <dt class="hdlist1">
10307 remote.&lt;name&gt;.pushurl
10308 </dt>
10309 <dd>
10310 <p>
10311         The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
10312 </p>
10313 </dd>
10314 <dt class="hdlist1">
10315 remote.&lt;name&gt;.proxy
10316 </dt>
10317 <dd>
10318 <p>
10319         For remotes that require curl (http, https and ftp), the URL to
10320         the proxy to use for that remote.  Set to the empty string to
10321         disable proxying for that remote.
10322 </p>
10323 </dd>
10324 <dt class="hdlist1">
10325 remote.&lt;name&gt;.proxyAuthMethod
10326 </dt>
10327 <dd>
10328 <p>
10329         For remotes that require curl (http, https and ftp), the method to use for
10330         authenticating against the proxy in use (probably set in
10331         <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
10332 </p>
10333 </dd>
10334 <dt class="hdlist1">
10335 remote.&lt;name&gt;.fetch
10336 </dt>
10337 <dd>
10338 <p>
10339         The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
10340         <a href="git-fetch.html">git-fetch(1)</a>.
10341 </p>
10342 </dd>
10343 <dt class="hdlist1">
10344 remote.&lt;name&gt;.push
10345 </dt>
10346 <dd>
10347 <p>
10348         The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
10349         <a href="git-push.html">git-push(1)</a>.
10350 </p>
10351 </dd>
10352 <dt class="hdlist1">
10353 remote.&lt;name&gt;.mirror
10354 </dt>
10355 <dd>
10356 <p>
10357         If true, pushing to this remote will automatically behave
10358         as if the <code>--mirror</code> option was given on the command line.
10359 </p>
10360 </dd>
10361 <dt class="hdlist1">
10362 remote.&lt;name&gt;.skipDefaultUpdate
10363 </dt>
10364 <dd>
10365 <p>
10366         If true, this remote will be skipped by default when updating
10367         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10368         <a href="git-remote.html">git-remote(1)</a>.
10369 </p>
10370 </dd>
10371 <dt class="hdlist1">
10372 remote.&lt;name&gt;.skipFetchAll
10373 </dt>
10374 <dd>
10375 <p>
10376         If true, this remote will be skipped by default when updating
10377         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10378         <a href="git-remote.html">git-remote(1)</a>.
10379 </p>
10380 </dd>
10381 <dt class="hdlist1">
10382 remote.&lt;name&gt;.receivepack
10383 </dt>
10384 <dd>
10385 <p>
10386         The default program to execute on the remote side when pushing.  See
10387         option --receive-pack of <a href="git-push.html">git-push(1)</a>.
10388 </p>
10389 </dd>
10390 <dt class="hdlist1">
10391 remote.&lt;name&gt;.uploadpack
10392 </dt>
10393 <dd>
10394 <p>
10395         The default program to execute on the remote side when fetching.  See
10396         option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
10397 </p>
10398 </dd>
10399 <dt class="hdlist1">
10400 remote.&lt;name&gt;.tagOpt
10401 </dt>
10402 <dd>
10403 <p>
10404         Setting this value to --no-tags disables automatic tag following when
10405         fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
10406         tag from remote &lt;name&gt;, even if they are not reachable from remote
10407         branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
10408         override this setting. See options --tags and --no-tags of
10409         <a href="git-fetch.html">git-fetch(1)</a>.
10410 </p>
10411 </dd>
10412 <dt class="hdlist1">
10413 remote.&lt;name&gt;.vcs
10414 </dt>
10415 <dd>
10416 <p>
10417         Setting this to a value &lt;vcs&gt; will cause Git to interact with
10418         the remote with the git-remote-&lt;vcs&gt; helper.
10419 </p>
10420 </dd>
10421 <dt class="hdlist1">
10422 remote.&lt;name&gt;.prune
10423 </dt>
10424 <dd>
10425 <p>
10426         When set to true, fetching from this remote by default will also
10427         remove any remote-tracking references that no longer exist on the
10428         remote (as if the <code>--prune</code> option was given on the command line).
10429         Overrides <code>fetch.prune</code> settings, if any.
10430 </p>
10431 </dd>
10432 <dt class="hdlist1">
10433 remote.&lt;name&gt;.pruneTags
10434 </dt>
10435 <dd>
10436 <p>
10437         When set to true, fetching from this remote by default will also
10438         remove any local tags that no longer exist on the remote if pruning
10439         is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
10440         <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10441 </p>
10442 <div class="paragraph"><p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
10443 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
10444 </dd>
10445 <dt class="hdlist1">
10446 remote.&lt;name&gt;.promisor
10447 </dt>
10448 <dd>
10449 <p>
10450         When set to true, this remote will be used to fetch promisor
10451         objects.
10452 </p>
10453 </dd>
10454 <dt class="hdlist1">
10455 remote.&lt;name&gt;.partialclonefilter
10456 </dt>
10457 <dd>
10458 <p>
10459         The filter that will be applied when fetching from this promisor remote.
10460         Changing or clearing this value will only affect fetches for new commits.
10461         To fetch associated objects for commits already present in the local object
10462         database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.
10463 </p>
10464 </dd>
10465 <dt class="hdlist1">
10466 remotes.&lt;group&gt;
10467 </dt>
10468 <dd>
10469 <p>
10470         The list of remotes which are fetched by "git remote update
10471         &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.
10472 </p>
10473 </dd>
10474 <dt class="hdlist1">
10475 repack.useDeltaBaseOffset
10476 </dt>
10477 <dd>
10478 <p>
10479         By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
10480         delta-base offset. If you need to share your repository with
10481         Git older than version 1.4.4, either directly or via a dumb
10482         protocol such as http, then you need to set this option to
10483         "false" and repack. Access from old Git versions over the
10484         native protocol are unaffected by this option.
10485 </p>
10486 </dd>
10487 <dt class="hdlist1">
10488 repack.packKeptObjects
10489 </dt>
10490 <dd>
10491 <p>
10492         If set to true, makes <code>git repack</code> act as if
10493         <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
10494         details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10495         index is being written (either via <code>--write-bitmap-index</code> or
10496         <code>repack.writeBitmaps</code>).
10497 </p>
10498 </dd>
10499 <dt class="hdlist1">
10500 repack.useDeltaIslands
10501 </dt>
10502 <dd>
10503 <p>
10504         If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10505         was passed. Defaults to <code>false</code>.
10506 </p>
10507 </dd>
10508 <dt class="hdlist1">
10509 repack.writeBitmaps
10510 </dt>
10511 <dd>
10512 <p>
10513         When true, git will write a bitmap index when packing all
10514         objects to disk (e.g., when <code>git repack -a</code> is run).  This
10515         index can speed up the "counting objects" phase of subsequent
10516         packs created for clones and fetches, at the cost of some disk
10517         space and extra time spent on the initial repack.  This has
10518         no effect if multiple packfiles are created.
10519         Defaults to true on bare repos, false otherwise.
10520 </p>
10521 </dd>
10522 <dt class="hdlist1">
10523 repack.updateServerInfo
10524 </dt>
10525 <dd>
10526 <p>
10527         If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
10528         <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10529         when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.
10530 </p>
10531 </dd>
10532 <dt class="hdlist1">
10533 repack.cruftWindow
10534 </dt>
10535 <dt class="hdlist1">
10536 repack.cruftWindowMemory
10537 </dt>
10538 <dt class="hdlist1">
10539 repack.cruftDepth
10540 </dt>
10541 <dt class="hdlist1">
10542 repack.cruftThreads
10543 </dt>
10544 <dd>
10545 <p>
10546         Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
10547         a cruft pack and the respective parameters are not given over
10548         the command line. See similarly named <code>pack.*</code> configuration
10549         variables for defaults and meaning.
10550 </p>
10551 </dd>
10552 <dt class="hdlist1">
10553 rerere.autoUpdate
10554 </dt>
10555 <dd>
10556 <p>
10557         When set to true, <code>git-rerere</code> updates the index with the
10558         resulting contents after it cleanly resolves conflicts using
10559         previously recorded resolutions.  Defaults to false.
10560 </p>
10561 </dd>
10562 <dt class="hdlist1">
10563 rerere.enabled
10564 </dt>
10565 <dd>
10566 <p>
10567         Activate recording of resolved conflicts, so that identical
10568         conflict hunks can be resolved automatically, should they be
10569         encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
10570         enabled if there is an <code>rr-cache</code> directory under the
10571         <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
10572         repository.
10573 </p>
10574 </dd>
10575 <dt class="hdlist1">
10576 revert.reference
10577 </dt>
10578 <dd>
10579 <p>
10580         Setting this variable to true makes <code>git revert</code> behave
10581         as if the <code>--reference</code> option is given.
10582 </p>
10583 </dd>
10584 <dt class="hdlist1">
10585 safe.bareRepository
10586 </dt>
10587 <dd>
10588 <p>
10589         Specifies which bare repositories Git will work with. The currently
10590         supported values are:
10591 </p>
10592 <div class="ulist"><ul>
10593 <li>
10594 <p>
10595 <code>all</code>: Git works with all bare repositories. This is the default.
10596 </p>
10597 </li>
10598 <li>
10599 <p>
10600 <code>explicit</code>: Git only works with bare repositories specified via
10601   the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10602   environment variable (see <a href="git.html">git(1)</a>).
10603 </p>
10604 <div class="paragraph"><p>If you do not use bare repositories in your workflow, then it may be
10605 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10606 config. This will protect you from attacks that involve cloning a
10607 repository that contains a bare repository and running a Git command
10608 within that directory.</p></div>
10609 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10610 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with
10611 this value.</p></div>
10612 </li>
10613 </ul></div>
10614 </dd>
10615 <dt class="hdlist1">
10616 safe.directory
10617 </dt>
10618 <dd>
10619 <p>
10620         These config entries specify Git-tracked directories that are
10621         considered safe even if they are owned by someone other than the
10622         current user. By default, Git will refuse to even parse a Git
10623         config of a repository owned by someone else, let alone run its
10624         hooks, and this config setting allows users to specify exceptions,
10625         e.g. for intentionally shared repositories (see the <code>--shared</code>
10626         option in <a href="git-init.html">git-init(1)</a>).
10627 </p>
10628 <div class="paragraph"><p>This is a multi-valued setting, i.e. you can add more than one directory
10629 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10630 override any such directories specified in the system config), add a
10631 <code>safe.directory</code> entry with an empty value.</p></div>
10632 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10633 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with this
10634 value.</p></div>
10635 <div class="paragraph"><p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
10636 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
10637 path relative to Git&#8217;s (runtime) prefix.</p></div>
10638 <div class="paragraph"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10639 string <code>*</code>. This will allow all repositories to be treated as if their
10640 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10641 is set in system config and you want to re-enable this protection, then
10642 initialize your list with an empty value before listing the repositories
10643 that you deem safe.</p></div>
10644 <div class="paragraph"><p>As explained, Git only allows you to access repositories owned by
10645 yourself, i.e. the user who is running Git, by default.  When Git
10646 is running as <em>root</em> in a non Windows platform that provides sudo,
10647 however, git checks the SUDO_UID environment variable that sudo creates
10648 and will allow access to the uid recorded as its value in addition to
10649 the id from <em>root</em>.
10650 This is to make it easy to perform a common sequence during installation
10651 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
10652 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
10653 which id the original user has.
10654 If that is not what you would prefer and want git to only trust
10655 repositories that are owned by root instead, then you can remove
10656 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p></div>
10657 </dd>
10658 <dt class="hdlist1">
10659 sendemail.identity
10660 </dt>
10661 <dd>
10662 <p>
10663         A configuration identity. When given, causes values in the
10664         <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
10665         values in the <em>sendemail</em> section. The default identity is
10666         the value of <code>sendemail.identity</code>.
10667 </p>
10668 </dd>
10669 <dt class="hdlist1">
10670 sendemail.smtpEncryption
10671 </dt>
10672 <dd>
10673 <p>
10674         See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
10675         setting is not subject to the <em>identity</em> mechanism.
10676 </p>
10677 </dd>
10678 <dt class="hdlist1">
10679 sendemail.smtpSSLCertPath
10680 </dt>
10681 <dd>
10682 <p>
10683         Path to ca-certificates (either a directory or a single file).
10684         Set it to an empty string to disable certificate verification.
10685 </p>
10686 </dd>
10687 <dt class="hdlist1">
10688 sendemail.&lt;identity&gt;.*
10689 </dt>
10690 <dd>
10691 <p>
10692         Identity-specific versions of the <em>sendemail.*</em> parameters
10693         found below, taking precedence over those when this
10694         identity is selected, through either the command-line or
10695         <code>sendemail.identity</code>.
10696 </p>
10697 </dd>
10698 <dt class="hdlist1">
10699 sendemail.multiEdit
10700 </dt>
10701 <dd>
10702 <p>
10703         If true (default), a single editor instance will be spawned to edit
10704         files you have to edit (patches when <code>--annotate</code> is used, and the
10705         summary when <code>--compose</code> is used). If false, files will be edited one
10706         after the other, spawning a new editor each time.
10707 </p>
10708 </dd>
10709 <dt class="hdlist1">
10710 sendemail.confirm
10711 </dt>
10712 <dd>
10713 <p>
10714         Sets the default for whether to confirm before sending. Must be
10715         one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
10716         in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
10717         values.
10718 </p>
10719 </dd>
10720 <dt class="hdlist1">
10721 sendemail.aliasesFile
10722 </dt>
10723 <dd>
10724 <p>
10725         To avoid typing long email addresses, point this to one or more
10726         email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.
10727 </p>
10728 </dd>
10729 <dt class="hdlist1">
10730 sendemail.aliasFileType
10731 </dt>
10732 <dd>
10733 <p>
10734         Format of the file(s) specified in sendemail.aliasesFile. Must be
10735         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.
10736 </p>
10737 <div class="paragraph"><p>What an alias file in each format looks like can be found in
10738 the documentation of the email program of the same name. The
10739 differences and limitations from the standard formats are
10740 described below:</p></div>
10741 <div class="openblock">
10742 <div class="content">
10743 <div class="dlist"><dl>
10744 <dt class="hdlist1">
10745 sendmail
10746 </dt>
10747 <dd>
10748 <div class="ulist"><ul>
10749 <li>
10750 <p>
10751 Quoted aliases and quoted addresses are not supported: lines that
10752         contain a <code>"</code> symbol are ignored.
10753 </p>
10754 </li>
10755 <li>
10756 <p>
10757 Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
10758         supported.
10759 </p>
10760 </li>
10761 <li>
10762 <p>
10763 File inclusion (<code>:include: /path/name</code>) is not supported.
10764 </p>
10765 </li>
10766 <li>
10767 <p>
10768 Warnings are printed on the standard error output for any
10769         explicitly unsupported constructs, and any other lines that are not
10770         recognized by the parser.
10771 </p>
10772 </li>
10773 </ul></div>
10774 </dd>
10775 </dl></div>
10776 </div></div>
10777 </dd>
10778 <dt class="hdlist1">
10779 sendemail.annotate
10780 </dt>
10781 <dt class="hdlist1">
10782 sendemail.bcc
10783 </dt>
10784 <dt class="hdlist1">
10785 sendemail.cc
10786 </dt>
10787 <dt class="hdlist1">
10788 sendemail.ccCmd
10789 </dt>
10790 <dt class="hdlist1">
10791 sendemail.chainReplyTo
10792 </dt>
10793 <dt class="hdlist1">
10794 sendemail.envelopeSender
10795 </dt>
10796 <dt class="hdlist1">
10797 sendemail.from
10798 </dt>
10799 <dt class="hdlist1">
10800 sendemail.headerCmd
10801 </dt>
10802 <dt class="hdlist1">
10803 sendemail.signedOffByCc
10804 </dt>
10805 <dt class="hdlist1">
10806 sendemail.smtpPass
10807 </dt>
10808 <dt class="hdlist1">
10809 sendemail.suppressCc
10810 </dt>
10811 <dt class="hdlist1">
10812 sendemail.suppressFrom
10813 </dt>
10814 <dt class="hdlist1">
10815 sendemail.to
10816 </dt>
10817 <dt class="hdlist1">
10818 sendemail.toCmd
10819 </dt>
10820 <dt class="hdlist1">
10821 sendemail.smtpDomain
10822 </dt>
10823 <dt class="hdlist1">
10824 sendemail.smtpServer
10825 </dt>
10826 <dt class="hdlist1">
10827 sendemail.smtpServerPort
10828 </dt>
10829 <dt class="hdlist1">
10830 sendemail.smtpServerOption
10831 </dt>
10832 <dt class="hdlist1">
10833 sendemail.smtpUser
10834 </dt>
10835 <dt class="hdlist1">
10836 sendemail.thread
10837 </dt>
10838 <dt class="hdlist1">
10839 sendemail.transferEncoding
10840 </dt>
10841 <dt class="hdlist1">
10842 sendemail.validate
10843 </dt>
10844 <dt class="hdlist1">
10845 sendemail.xmailer
10846 </dt>
10847 <dd>
10848 <p>
10849         These configuration variables all provide a default for
10850         <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
10851         documentation for details.
10852 </p>
10853 </dd>
10854 <dt class="hdlist1">
10855 sendemail.signedOffCc (deprecated)
10856 </dt>
10857 <dd>
10858 <p>
10859         Deprecated alias for <code>sendemail.signedOffByCc</code>.
10860 </p>
10861 </dd>
10862 <dt class="hdlist1">
10863 sendemail.smtpBatchSize
10864 </dt>
10865 <dd>
10866 <p>
10867         Number of messages to be sent per connection, after that a relogin
10868         will happen.  If the value is 0 or undefined, send all messages in
10869         one connection.
10870         See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10871 </p>
10872 </dd>
10873 <dt class="hdlist1">
10874 sendemail.smtpReloginDelay
10875 </dt>
10876 <dd>
10877 <p>
10878         Seconds to wait before reconnecting to the smtp server.
10879         See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10880 </p>
10881 </dd>
10882 <dt class="hdlist1">
10883 sendemail.forbidSendmailVariables
10884 </dt>
10885 <dd>
10886 <p>
10887         To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
10888         will abort with a warning if any configuration options for "sendmail"
10889         exist. Set this variable to bypass the check.
10890 </p>
10891 </dd>
10892 <dt class="hdlist1">
10893 sequence.editor
10894 </dt>
10895 <dd>
10896 <p>
10897         Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
10898         The value is meant to be interpreted by the shell when it is used.
10899         It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
10900         When not configured, the default commit message editor is used instead.
10901 </p>
10902 </dd>
10903 <dt class="hdlist1">
10904 showBranch.default
10905 </dt>
10906 <dd>
10907 <p>
10908         The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
10909         See <a href="git-show-branch.html">git-show-branch(1)</a>.
10910 </p>
10911 </dd>
10912 <dt class="hdlist1">
10913 sparse.expectFilesOutsideOfPatterns
10914 </dt>
10915 <dd>
10916 <p>
10917         Typically with sparse checkouts, files not matching any
10918         sparsity patterns are marked with a SKIP_WORKTREE bit in the
10919         index and are missing from the working tree.  Accordingly, Git
10920         will ordinarily check whether files with the SKIP_WORKTREE bit
10921         are in fact present in the working tree contrary to
10922         expectations.  If Git finds any, it marks those paths as
10923         present by clearing the relevant SKIP_WORKTREE bits.  This
10924         option can be used to tell Git that such
10925         present-despite-skipped files are expected and to stop
10926         checking for them.
10927 </p>
10928 <div class="paragraph"><p>The default is <code>false</code>, which allows Git to automatically recover
10929 from the list of files in the index and working tree falling out of
10930 sync.</p></div>
10931 <div class="paragraph"><p>Set this to <code>true</code> if you are in a setup where some external factor
10932 relieves Git of the responsibility for maintaining the consistency
10933 between the presence of working tree files and sparsity patterns.  For
10934 example, if you have a Git-aware virtual file system that has a robust
10935 mechanism for keeping the working tree and the sparsity patterns up to
10936 date based on access patterns.</p></div>
10937 <div class="paragraph"><p>Regardless of this setting, Git does not check for
10938 present-despite-skipped files unless sparse checkout is enabled, so
10939 this config option has no effect unless <code>core.sparseCheckout</code> is
10940 <code>true</code>.</p></div>
10941 </dd>
10942 <dt class="hdlist1">
10943 splitIndex.maxPercentChange
10944 </dt>
10945 <dd>
10946 <p>
10947         When the split index feature is used, this specifies the
10948         percent of entries the split index can contain compared to the
10949         total number of entries in both the split index and the shared
10950         index before a new shared index is written.
10951         The value should be between 0 and 100. If the value is 0, then
10952         a new shared index is always written; if it is 100, a new
10953         shared index is never written.
10954         By default, the value is 20, so a new shared index is written
10955         if the number of entries in the split index would be greater
10956         than 20 percent of the total number of entries.
10957         See <a href="git-update-index.html">git-update-index(1)</a>.
10958 </p>
10959 </dd>
10960 <dt class="hdlist1">
10961 splitIndex.sharedIndexExpire
10962 </dt>
10963 <dd>
10964 <p>
10965         When the split index feature is used, shared index files that
10966         were not modified since the time this variable specifies will
10967         be removed when a new shared index file is created. The value
10968         "now" expires all entries immediately, and "never" suppresses
10969         expiration altogether.
10970         The default value is "2.weeks.ago".
10971         Note that a shared index file is considered modified (for the
10972         purpose of expiration) each time a new split-index file is
10973         either created based on it or read from it.
10974         See <a href="git-update-index.html">git-update-index(1)</a>.
10975 </p>
10976 </dd>
10977 <dt class="hdlist1">
10978 ssh.variant
10979 </dt>
10980 <dd>
10981 <p>
10982         By default, Git determines the command line arguments to use
10983         based on the basename of the configured SSH command (configured
10984         using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
10985         the config setting <code>core.sshCommand</code>). If the basename is
10986         unrecognized, Git will attempt to detect support of OpenSSH
10987         options by first invoking the configured SSH command with the
10988         <code>-G</code> (print configuration) option and will subsequently use
10989         OpenSSH options (if that is successful) or no options besides
10990         the host and remote command (if it fails).
10991 </p>
10992 <div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this detection.
10993 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
10994 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
10995 The default auto-detection can be explicitly requested using the value
10996 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
10997 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
10998 <div class="paragraph"><p>The current command-line parameters used for each variant are as
10999 follows:</p></div>
11000 <div class="openblock">
11001 <div class="content">
11002 <div class="ulist"><ul>
11003 <li>
11004 <p>
11005 <code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command
11006 </p>
11007 </li>
11008 <li>
11009 <p>
11010 <code>simple</code> - [username@]host command
11011 </p>
11012 </li>
11013 <li>
11014 <p>
11015 <code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command
11016 </p>
11017 </li>
11018 <li>
11019 <p>
11020 <code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command
11021 </p>
11022 </li>
11023 </ul></div>
11024 </div></div>
11025 <div class="paragraph"><p>Except for the <code>simple</code> variant, command-line parameters are likely to
11026 change as git gains new features.</p></div>
11027 </dd>
11028 <dt class="hdlist1">
11029 stash.showIncludeUntracked
11030 </dt>
11031 <dd>
11032 <p>
11033         If this is set to true, the <code>git stash show</code> command will show
11034         the untracked files of a stash entry.  Defaults to false. See
11035         the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11036 </p>
11037 </dd>
11038 <dt class="hdlist1">
11039 stash.showPatch
11040 </dt>
11041 <dd>
11042 <p>
11043         If this is set to true, the <code>git stash show</code> command without an
11044         option will show the stash entry in patch form.  Defaults to false.
11045         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11046 </p>
11047 </dd>
11048 <dt class="hdlist1">
11049 stash.showStat
11050 </dt>
11051 <dd>
11052 <p>
11053         If this is set to true, the <code>git stash show</code> command without an
11054         option will show a diffstat of the stash entry.  Defaults to true.
11055         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
11056 </p>
11057 </dd>
11058 <dt class="hdlist1">
11059 status.relativePaths
11060 </dt>
11061 <dd>
11062 <p>
11063         By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
11064         current directory. Setting this variable to <code>false</code> shows paths
11065         relative to the repository root (this was the default for Git
11066         prior to v1.5.4).
11067 </p>
11068 </dd>
11069 <dt class="hdlist1">
11070 status.short
11071 </dt>
11072 <dd>
11073 <p>
11074         Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
11075         The option --no-short takes precedence over this variable.
11076 </p>
11077 </dd>
11078 <dt class="hdlist1">
11079 status.branch
11080 </dt>
11081 <dd>
11082 <p>
11083         Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
11084         The option --no-branch takes precedence over this variable.
11085 </p>
11086 </dd>
11087 <dt class="hdlist1">
11088 status.aheadBehind
11089 </dt>
11090 <dd>
11091 <p>
11092         Set to true to enable <code>--ahead-behind</code> and false to enable
11093         <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
11094         non-porcelain status formats.  Defaults to true.
11095 </p>
11096 </dd>
11097 <dt class="hdlist1">
11098 status.displayCommentPrefix
11099 </dt>
11100 <dd>
11101 <p>
11102         If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
11103         prefix before each output line (starting with
11104         <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
11105         behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
11106         Defaults to false.
11107 </p>
11108 </dd>
11109 <dt class="hdlist1">
11110 status.renameLimit
11111 </dt>
11112 <dd>
11113 <p>
11114         The number of files to consider when performing rename detection
11115         in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
11116         the value of diff.renameLimit.
11117 </p>
11118 </dd>
11119 <dt class="hdlist1">
11120 status.renames
11121 </dt>
11122 <dd>
11123 <p>
11124         Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
11125         <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
11126         disabled. If set to "true", basic rename detection is enabled.
11127         If set to "copies" or "copy", Git will detect copies, as well.
11128         Defaults to the value of diff.renames.
11129 </p>
11130 </dd>
11131 <dt class="hdlist1">
11132 status.showStash
11133 </dt>
11134 <dd>
11135 <p>
11136         If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
11137         entries currently stashed away.
11138         Defaults to false.
11139 </p>
11140 </dd>
11141 <dt class="hdlist1">
11142 status.showUntrackedFiles
11143 </dt>
11144 <dd>
11145 <p>
11146         By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
11147         files which are not currently tracked by Git. Directories which
11148         contain only untracked files, are shown with the directory name
11149         only. Showing untracked files means that Git needs to lstat() all
11150         the files in the whole repository, which might be slow on some
11151         systems. So, this variable controls how the commands display
11152         the untracked files. Possible values are:
11153 </p>
11154 <div class="openblock">
11155 <div class="content">
11156 <div class="ulist"><ul>
11157 <li>
11158 <p>
11159 <code>no</code> - Show no untracked files.
11160 </p>
11161 </li>
11162 <li>
11163 <p>
11164 <code>normal</code> - Show untracked files and directories.
11165 </p>
11166 </li>
11167 <li>
11168 <p>
11169 <code>all</code> - Show also individual files in untracked directories.
11170 </p>
11171 </li>
11172 </ul></div>
11173 </div></div>
11174 <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
11175 All usual spellings for Boolean value <code>true</code> are taken as <code>normal</code>
11176 and <code>false</code> as <code>no</code>.
11177 This variable can be overridden with the -u|--untracked-files option
11178 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
11179 </dd>
11180 <dt class="hdlist1">
11181 status.submoduleSummary
11182 </dt>
11183 <dd>
11184 <p>
11185         Defaults to false.
11186         If this is set to a non-zero number or true (identical to -1 or an
11187         unlimited number), the submodule summary will be enabled and a
11188         summary of commits for modified submodules will be shown (see
11189         --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
11190         that the summary output command will be suppressed for all
11191         submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
11192         for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
11193         exception to that rule is that status and commit will show staged
11194         submodule changes. To
11195         also view the summary for ignored submodules you can either use
11196         the --ignore-submodules=dirty command-line option or the <em>git
11197         submodule summary</em> command, which shows a similar output but does
11198         not honor these settings.
11199 </p>
11200 </dd>
11201 <dt class="hdlist1">
11202 submodule.&lt;name&gt;.url
11203 </dt>
11204 <dd>
11205 <p>
11206         The URL for a submodule. This variable is copied from the .gitmodules
11207         file to the git config via <em>git submodule init</em>. The user can change
11208         the configured URL before obtaining the submodule via <em>git submodule
11209         update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
11210         set, the presence of this variable is used as a fallback to indicate
11211         whether the submodule is of interest to git commands.
11212         See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
11213 </p>
11214 </dd>
11215 <dt class="hdlist1">
11216 submodule.&lt;name&gt;.update
11217 </dt>
11218 <dd>
11219 <p>
11220         The method by which a submodule is updated by <em>git submodule update</em>,
11221         which is the only affected command, others such as
11222         <em>git checkout --recurse-submodules</em> are unaffected. It exists for
11223         historical reasons, when <em>git submodule</em> was the only command to
11224         interact with submodules; settings like <code>submodule.active</code>
11225         and <code>pull.rebase</code> are more specific. It is populated by
11226         <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
11227         See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.
11228 </p>
11229 </dd>
11230 <dt class="hdlist1">
11231 submodule.&lt;name&gt;.branch
11232 </dt>
11233 <dd>
11234 <p>
11235         The remote branch name for a submodule, used by <code>git submodule
11236         update --remote</code>.  Set this option to override the value found in
11237         the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
11238         <a href="gitmodules.html">gitmodules(5)</a> for details.
11239 </p>
11240 </dd>
11241 <dt class="hdlist1">
11242 submodule.&lt;name&gt;.fetchRecurseSubmodules
11243 </dt>
11244 <dd>
11245 <p>
11246         This option can be used to control recursive fetching of this
11247         submodule. It can be overridden by using the --[no-]recurse-submodules
11248         command-line option to "git fetch" and "git pull".
11249         This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
11250         file.
11251 </p>
11252 </dd>
11253 <dt class="hdlist1">
11254 submodule.&lt;name&gt;.ignore
11255 </dt>
11256 <dd>
11257 <p>
11258         Defines under what circumstances "git status" and the diff family show
11259         a submodule as modified. When set to "all", it will never be considered
11260         modified (but it will nonetheless show up in the output of status and
11261         commit when it has been staged), "dirty" will ignore all changes
11262         to the submodule&#8217;s work tree and
11263         takes only differences between the HEAD of the submodule and the commit
11264         recorded in the superproject into account. "untracked" will additionally
11265         let submodules with modified tracked files in their work tree show up.
11266         Using "none" (the default when this option is not set) also shows
11267         submodules that have untracked files in their work tree as changed.
11268         This setting overrides any setting made in .gitmodules for this submodule,
11269         both settings can be overridden on the command line by using the
11270         "--ignore-submodules" option. The <em>git submodule</em> commands are not
11271         affected by this setting.
11272 </p>
11273 </dd>
11274 <dt class="hdlist1">
11275 submodule.&lt;name&gt;.active
11276 </dt>
11277 <dd>
11278 <p>
11279         Boolean value indicating if the submodule is of interest to git
11280         commands.  This config option takes precedence over the
11281         submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
11282         details.
11283 </p>
11284 </dd>
11285 <dt class="hdlist1">
11286 submodule.active
11287 </dt>
11288 <dd>
11289 <p>
11290         A repeated field which contains a pathspec used to match against a
11291         submodule&#8217;s path to determine if the submodule is of interest to git
11292         commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.
11293 </p>
11294 </dd>
11295 <dt class="hdlist1">
11296 submodule.recurse
11297 </dt>
11298 <dd>
11299 <p>
11300         A boolean indicating if commands should enable the <code>--recurse-submodules</code>
11301         option by default. Defaults to false.
11302 </p>
11303 <div class="paragraph"><p>When set to true, it can be deactivated via the
11304 <code>--no-recurse-submodules</code> option. Note that some Git commands
11305 lacking this option may call some of the above commands affected by
11306 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
11307 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
11308 For these commands a workaround is to temporarily change the
11309 configuration value by using <code>git -c submodule.recurse=0</code>.</p></div>
11310 <div class="paragraph"><p>The following list shows the commands that accept
11311 <code>--recurse-submodules</code> and whether they are supported by this
11312 setting.</p></div>
11313 <div class="ulist"><ul>
11314 <li>
11315 <p>
11316 <code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
11317 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.
11318 </p>
11319 </li>
11320 <li>
11321 <p>
11322 <code>clone</code> and <code>ls-files</code> are not supported.
11323 </p>
11324 </li>
11325 <li>
11326 <p>
11327 <code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
11328 enabled
11329 </p>
11330 </li>
11331 </ul></div>
11332 </dd>
11333 <dt class="hdlist1">
11334 submodule.propagateBranches
11335 </dt>
11336 <dd>
11337 <p>
11338         [EXPERIMENTAL] A boolean that enables branching support when
11339         using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
11340         Enabling this will allow certain commands to accept
11341         <code>--recurse-submodules</code> and certain commands that already accept
11342         <code>--recurse-submodules</code> will now consider branches.
11343         Defaults to false.
11344 </p>
11345 </dd>
11346 <dt class="hdlist1">
11347 submodule.fetchJobs
11348 </dt>
11349 <dd>
11350 <p>
11351         Specifies how many submodules are fetched/cloned at the same time.
11352         A positive integer allows up to that number of submodules fetched
11353         in parallel. A value of 0 will give some reasonable default.
11354         If unset, it defaults to 1.
11355 </p>
11356 </dd>
11357 <dt class="hdlist1">
11358 submodule.alternateLocation
11359 </dt>
11360 <dd>
11361 <p>
11362         Specifies how the submodules obtain alternates when submodules are
11363         cloned. Possible values are <code>no</code>, <code>superproject</code>.
11364         By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
11365         value is set to <code>superproject</code> the submodule to be cloned computes
11366         its alternates location relative to the superprojects alternate.
11367 </p>
11368 </dd>
11369 <dt class="hdlist1">
11370 submodule.alternateErrorStrategy
11371 </dt>
11372 <dd>
11373 <p>
11374         Specifies how to treat errors with the alternates for a submodule
11375         as computed via <code>submodule.alternateLocation</code>. Possible values are
11376         <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
11377         or <code>info</code>, and if there is an error with the computed alternate, the
11378         clone proceeds as if no alternate was specified.
11379 </p>
11380 </dd>
11381 <dt class="hdlist1">
11382 tag.forceSignAnnotated
11383 </dt>
11384 <dd>
11385 <p>
11386         A boolean to specify whether annotated tags created should be GPG signed.
11387         If <code>--annotate</code> is specified on the command line, it takes
11388         precedence over this option.
11389 </p>
11390 </dd>
11391 <dt class="hdlist1">
11392 tag.sort
11393 </dt>
11394 <dd>
11395 <p>
11396         This variable controls the sort ordering of tags when displayed by
11397         <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
11398         value of this variable will be used as the default.
11399 </p>
11400 </dd>
11401 <dt class="hdlist1">
11402 tag.gpgSign
11403 </dt>
11404 <dd>
11405 <p>
11406         A boolean to specify whether all tags should be GPG signed.
11407         Use of this option when running in an automated script can
11408         result in a large number of tags being signed. It is therefore
11409         convenient to use an agent to avoid typing your gpg passphrase
11410         several times. Note that this option doesn&#8217;t affect tag signing
11411         behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.
11412 </p>
11413 </dd>
11414 <dt class="hdlist1">
11415 tar.umask
11416 </dt>
11417 <dd>
11418 <p>
11419         This variable can be used to restrict the permission bits of
11420         tar archive entries.  The default is 0002, which turns off the
11421         world write bit.  The special value "user" indicates that the
11422         archiving user&#8217;s umask will be used instead.  See umask(2) and
11423         <a href="git-archive.html">git-archive(1)</a>.
11424 </p>
11425 </dd>
11426 </dl></div>
11427 <div class="paragraph"><p>Trace2 config settings are only read from the system and global
11428 config files; repository local and worktree config files and <code>-c</code>
11429 command line arguments are not respected.</p></div>
11430 <div class="dlist"><dl>
11431 <dt class="hdlist1">
11432 trace2.normalTarget
11433 </dt>
11434 <dd>
11435 <p>
11436         This variable controls the normal target destination.
11437         It may be overridden by the <code>GIT_TRACE2</code> environment variable.
11438         The following table shows possible values.
11439 </p>
11440 </dd>
11441 <dt class="hdlist1">
11442 trace2.perfTarget
11443 </dt>
11444 <dd>
11445 <p>
11446         This variable controls the performance target destination.
11447         It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
11448         The following table shows possible values.
11449 </p>
11450 </dd>
11451 <dt class="hdlist1">
11452 trace2.eventTarget
11453 </dt>
11454 <dd>
11455 <p>
11456         This variable controls the event target destination.
11457         It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
11458         The following table shows possible values.
11459 </p>
11460 <div class="openblock">
11461 <div class="content">
11462 <div class="ulist"><ul>
11463 <li>
11464 <p>
11465 <code>0</code> or <code>false</code> - Disables the target.
11466 </p>
11467 </li>
11468 <li>
11469 <p>
11470 <code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.
11471 </p>
11472 </li>
11473 <li>
11474 <p>
11475 <code>[2-9]</code> - Writes to the already opened file descriptor.
11476 </p>
11477 </li>
11478 <li>
11479 <p>
11480 <code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
11481 already exists and is a directory, the traces will be written to files (one
11482 per process) underneath the given directory.
11483 </p>
11484 </li>
11485 <li>
11486 <p>
11487 <code>af_unix:[&lt;socket-type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
11488 Unix DomainSocket (on platforms that support them).  Socket
11489 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
11490 try both.
11491 </p>
11492 </li>
11493 </ul></div>
11494 </div></div>
11495 </dd>
11496 <dt class="hdlist1">
11497 trace2.normalBrief
11498 </dt>
11499 <dd>
11500 <p>
11501         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11502         omitted from normal output.  May be overridden by the
11503         <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.
11504 </p>
11505 </dd>
11506 <dt class="hdlist1">
11507 trace2.perfBrief
11508 </dt>
11509 <dd>
11510 <p>
11511         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11512         omitted from PERF output.  May be overridden by the
11513         <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.
11514 </p>
11515 </dd>
11516 <dt class="hdlist1">
11517 trace2.eventBrief
11518 </dt>
11519 <dd>
11520 <p>
11521         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11522         omitted from event output.  May be overridden by the
11523         <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.
11524 </p>
11525 </dd>
11526 <dt class="hdlist1">
11527 trace2.eventNesting
11528 </dt>
11529 <dd>
11530 <p>
11531         Integer.  Specifies desired depth of nested regions in the
11532         event output.  Regions deeper than this value will be
11533         omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
11534         environment variable.  Defaults to 2.
11535 </p>
11536 </dd>
11537 <dt class="hdlist1">
11538 trace2.configParams
11539 </dt>
11540 <dd>
11541 <p>
11542         A comma-separated list of patterns of "important" config
11543         settings that should be recorded in the trace2 output.
11544         For example, <code>core.*,remote.*.url</code> would cause the trace2
11545         output to contain events listing each configured remote.
11546         May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
11547         variable.  Unset by default.
11548 </p>
11549 </dd>
11550 <dt class="hdlist1">
11551 trace2.envVars
11552 </dt>
11553 <dd>
11554 <p>
11555         A comma-separated list of "important" environment variables that should
11556         be recorded in the trace2 output.  For example,
11557         <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
11558         contain events listing the overrides for HTTP user agent and the
11559         location of the Git configuration file (assuming any are set).  May be
11560         overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
11561         default.
11562 </p>
11563 </dd>
11564 <dt class="hdlist1">
11565 trace2.destinationDebug
11566 </dt>
11567 <dd>
11568 <p>
11569         Boolean.  When true Git will print error messages when a
11570         trace target destination cannot be opened for writing.
11571         By default, these errors are suppressed and tracing is
11572         silently disabled.  May be overridden by the
11573         <code>GIT_TRACE2_DST_DEBUG</code> environment variable.
11574 </p>
11575 </dd>
11576 <dt class="hdlist1">
11577 trace2.maxFiles
11578 </dt>
11579 <dd>
11580 <p>
11581         Integer.  When writing trace files to a target directory, do not
11582         write additional traces if doing so would exceed this many files. Instead,
11583         write a sentinel file that will block further tracing to this
11584         directory. Defaults to 0, which disables this check.
11585 </p>
11586 </dd>
11587 <dt class="hdlist1">
11588 transfer.credentialsInUrl
11589 </dt>
11590 <dd>
11591 <p>
11592         A configured URL can contain plaintext credentials in the form
11593         <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
11594         to warn or forbid the use of such configuration (in favor of
11595         using <a href="git-credential.html">git-credential(1)</a>). This will be used on
11596         <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>,
11597         and any other direct use of the configured URL.
11598 </p>
11599 <div class="paragraph"><p>Note that this is currently limited to detecting credentials in
11600 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
11601 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p></div>
11602 <div class="paragraph"><p>You might want to enable this to prevent inadvertent credentials
11603 exposure, e.g. because:</p></div>
11604 <div class="ulist"><ul>
11605 <li>
11606 <p>
11607 The OS or system where you&#8217;re running git may not provide a way or
11608   otherwise allow you to configure the permissions of the
11609   configuration file where the username and/or password are stored.
11610 </p>
11611 </li>
11612 <li>
11613 <p>
11614 Even if it does, having such data stored "at rest" might expose you
11615   in other ways, e.g. a backup process might copy the data to another
11616   system.
11617 </p>
11618 </li>
11619 <li>
11620 <p>
11621 The git programs will pass the full URL to one another as arguments
11622   on the command-line, meaning the credentials will be exposed to other
11623   unprivileged users on systems that allow them to see the full
11624   process list of other users. On linux the "hidepid" setting
11625   documented in procfs(5) allows for configuring this behavior.
11626 </p>
11627 <div class="paragraph"><p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
11628 concerned about credentials exposure due to storing sensitive
11629 data in git&#8217;s configuration files. If you do want to use this, set
11630 <code>transfer.credentialsInUrl</code> to one of these values:</p></div>
11631 </li>
11632 <li>
11633 <p>
11634 <code>allow</code> (default): Git will proceed with its activity without warning.
11635 </p>
11636 </li>
11637 <li>
11638 <p>
11639 <code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
11640   with a plaintext credential.
11641 </p>
11642 </li>
11643 <li>
11644 <p>
11645 <code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
11646   with a plaintext credential.
11647 </p>
11648 </li>
11649 </ul></div>
11650 </dd>
11651 <dt class="hdlist1">
11652 transfer.fsckObjects
11653 </dt>
11654 <dd>
11655 <p>
11656         When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
11657         not set, the value of this variable is used instead.
11658         Defaults to false.
11659 </p>
11660 <div class="paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
11661 object or a link to a nonexistent object. In addition, various other
11662 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
11663 and potential security issues like the existence of a <code>.GIT</code> directory
11664 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
11665 and v2.17.1 for details). Other sanity and security checks may be
11666 added in future releases.</p></div>
11667 <div class="paragraph"><p>On the receiving side, failing fsckObjects will make those objects
11668 unreachable, see "QUARANTINE ENVIRONMENT" in
11669 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
11670 instead be left unreferenced in the repository.</p></div>
11671 <div class="paragraph"><p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
11672 implementation it cannot be relied upon to leave the object store
11673 clean like <code>receive.fsckObjects</code> can.</p></div>
11674 <div class="paragraph"><p>As objects are unpacked they&#8217;re written to the object store, so there
11675 can be cases where malicious objects get introduced even though the
11676 "fetch" failed, only to have a subsequent "fetch" succeed because only
11677 new incoming objects are checked, not those that have already been
11678 written to the object store. That difference in behavior should not be
11679 relied upon. In the future, such objects may be quarantined for
11680 "fetch" as well.</p></div>
11681 <div class="paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
11682 environment if they&#8217;d like the same protection as "push". E.g. in the
11683 case of an internal mirror do the mirroring in two steps, one to fetch
11684 the untrusted objects, and then do a second "push" (which will use the
11685 quarantine) to another internal repo, and have internal clients
11686 consume this pushed-to repository, or embargo internal fetches and
11687 only allow them once a full "fsck" has run (and no new fetches have
11688 happened in the meantime).</p></div>
11689 </dd>
11690 <dt class="hdlist1">
11691 transfer.hideRefs
11692 </dt>
11693 <dd>
11694 <p>
11695         String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
11696         refs to omit from their initial advertisements.  Use more than
11697         one definition to specify multiple prefix strings. A ref that is
11698         under the hierarchies listed in the value of this variable is
11699         excluded, and is hidden when responding to <code>git push</code> or <code>git
11700         fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
11701         program-specific versions of this config.
11702 </p>
11703 <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
11704 explicitly exposing it, even if an earlier entry marked it as hidden.
11705 If you have multiple hideRefs values, later entries override earlier ones
11706 (and entries in more-specific config files override less-specific ones).</p></div>
11707 <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
11708 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
11709 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
11710 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
11711 <div class="paragraph"><p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
11712 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
11713 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
11714 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
11715 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
11716 <code>receive-pack</code>, on the other hand, will still advertise the object id the
11717 ref is pointing to without mentioning its name (a so-called ".have" line).</p></div>
11718 <div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
11719 objects via the techniques described in the "SECURITY" section of the
11720 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
11721 separate repository.</p></div>
11722 </dd>
11723 <dt class="hdlist1">
11724 transfer.unpackLimit
11725 </dt>
11726 <dd>
11727 <p>
11728         When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
11729         not set, the value of this variable is used instead.
11730         The default value is 100.
11731 </p>
11732 </dd>
11733 <dt class="hdlist1">
11734 transfer.advertiseSID
11735 </dt>
11736 <dd>
11737 <p>
11738         Boolean. When true, client and server processes will advertise their
11739         unique session IDs to their remote counterpart. Defaults to false.
11740 </p>
11741 </dd>
11742 <dt class="hdlist1">
11743 transfer.bundleURI
11744 </dt>
11745 <dd>
11746 <p>
11747         When <code>true</code>, local <code>git clone</code> commands will request bundle
11748         information from the remote server (if advertised) and download
11749         bundles before continuing the clone through the Git protocol.
11750         Defaults to <code>false</code>.
11751 </p>
11752 </dd>
11753 <dt class="hdlist1">
11754 transfer.advertiseObjectInfo
11755 </dt>
11756 <dd>
11757 <p>
11758         When <code>true</code>, the <code>object-info</code> capability is advertised by
11759         servers. Defaults to false.
11760 </p>
11761 </dd>
11762 <dt class="hdlist1">
11763 uploadarchive.allowUnreachable
11764 </dt>
11765 <dd>
11766 <p>
11767         If true, allow clients to use <code>git archive --remote</code> to request
11768         any tree, whether reachable from the ref tips or not. See the
11769         discussion in the "SECURITY" section of
11770         <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
11771         <code>false</code>.
11772 </p>
11773 </dd>
11774 <dt class="hdlist1">
11775 uploadpack.hideRefs
11776 </dt>
11777 <dd>
11778 <p>
11779         This variable is the same as <code>transfer.hideRefs</code>, but applies
11780         only to <code>upload-pack</code> (and so affects only fetches, not pushes).
11781         An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
11782         also <code>uploadpack.allowTipSHA1InWant</code>.
11783 </p>
11784 </dd>
11785 <dt class="hdlist1">
11786 uploadpack.allowTipSHA1InWant
11787 </dt>
11788 <dd>
11789 <p>
11790         When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
11791         to accept a fetch request that asks for an object at the tip
11792         of a hidden ref (by default, such a request is rejected).
11793         See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
11794         may be able to steal objects via the techniques described in the
11795         "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
11796         best to keep private data in a separate repository.
11797 </p>
11798 </dd>
11799 <dt class="hdlist1">
11800 uploadpack.allowReachableSHA1InWant
11801 </dt>
11802 <dd>
11803 <p>
11804         Allow <code>upload-pack</code> to accept a fetch request that asks for an
11805         object that is reachable from any ref tip. However, note that
11806         calculating object reachability is computationally expensive.
11807         Defaults to <code>false</code>.  Even if this is false, a client may be able
11808         to steal objects via the techniques described in the "SECURITY"
11809         section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
11810         keep private data in a separate repository.
11811 </p>
11812 </dd>
11813 <dt class="hdlist1">
11814 uploadpack.allowAnySHA1InWant
11815 </dt>
11816 <dd>
11817 <p>
11818         Allow <code>upload-pack</code> to accept a fetch request that asks for any
11819         object at all.
11820         Defaults to <code>false</code>.
11821 </p>
11822 </dd>
11823 <dt class="hdlist1">
11824 uploadpack.keepAlive
11825 </dt>
11826 <dd>
11827 <p>
11828         When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
11829         quiet period while <code>pack-objects</code> prepares the pack. Normally
11830         it would output progress information, but if <code>--quiet</code> was used
11831         for the fetch, <code>pack-objects</code> will output nothing at all until
11832         the pack data begins. Some clients and networks may consider
11833         the server to be hung and give up. Setting this option instructs
11834         <code>upload-pack</code> to send an empty keepalive packet every
11835         <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
11836         disables keepalive packets entirely. The default is 5 seconds.
11837 </p>
11838 </dd>
11839 <dt class="hdlist1">
11840 uploadpack.packObjectsHook
11841 </dt>
11842 <dd>
11843 <p>
11844         If this option is set, when <code>upload-pack</code> would run
11845         <code>git pack-objects</code> to create a packfile for a client, it will
11846         run this shell command instead.  The <code>pack-objects</code> command and
11847         arguments it <em>would</em> have run (including the <code>git pack-objects</code>
11848         at the beginning) are appended to the shell command. The stdin
11849         and stdout of the hook are treated as if <code>pack-objects</code> itself
11850         was run. I.e., <code>upload-pack</code> will feed input intended for
11851         <code>pack-objects</code> to the hook, and expects a completed packfile on
11852         stdout.
11853 </p>
11854 <div class="paragraph"><p>Note that this configuration variable is only respected when it is specified
11855 in protected configuration (see <a href="#SCOPES">[SCOPES]</a>). This is a safety measure
11856 against fetching from untrusted repositories.</p></div>
11857 </dd>
11858 <dt class="hdlist1">
11859 uploadpack.allowFilter
11860 </dt>
11861 <dd>
11862 <p>
11863         If this option is set, <code>upload-pack</code> will support partial
11864         clone and partial fetch object filtering.
11865 </p>
11866 </dd>
11867 <dt class="hdlist1">
11868 uploadpackfilter.allow
11869 </dt>
11870 <dd>
11871 <p>
11872         Provides a default value for unspecified object filters (see: the
11873         below configuration variable). If set to <code>true</code>, this will also
11874         enable all filters which get added in the future.
11875         Defaults to <code>true</code>.
11876 </p>
11877 </dd>
11878 <dt class="hdlist1">
11879 uploadpackfilter.&lt;filter&gt;.allow
11880 </dt>
11881 <dd>
11882 <p>
11883         Explicitly allow or ban the object filter corresponding to
11884         <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
11885         <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
11886         If using combined filters, both <code>combine</code> and all of the nested
11887         filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.
11888 </p>
11889 </dd>
11890 <dt class="hdlist1">
11891 uploadpackfilter.tree.maxDepth
11892 </dt>
11893 <dd>
11894 <p>
11895         Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
11896         <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
11897         <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
11898         variable had already been set. Has no effect if unset.
11899 </p>
11900 </dd>
11901 <dt class="hdlist1">
11902 uploadpack.allowRefInWant
11903 </dt>
11904 <dd>
11905 <p>
11906         If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
11907         feature of the protocol version 2 <code>fetch</code> command.  This feature
11908         is intended for the benefit of load-balanced servers which may
11909         not have the same view of what OIDs their refs point to due to
11910         replication delay.
11911 </p>
11912 </dd>
11913 <dt class="hdlist1">
11914 url.&lt;base&gt;.insteadOf
11915 </dt>
11916 <dd>
11917 <p>
11918         Any URL that starts with this value will be rewritten to
11919         start, instead, with &lt;base&gt;. In cases where some site serves a
11920         large number of repositories, and serves them with multiple
11921         access methods, and some users need to use different access
11922         methods, this feature allows people to specify any of the
11923         equivalent URLs and have Git automatically rewrite the URL to
11924         the best alternative for the particular user, even for a
11925         never-before-seen repository on the site.  When more than one
11926         insteadOf strings match a given URL, the longest match is used.
11927 </p>
11928 <div class="paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
11929 URL. If the rewrite changes the URL to use a custom protocol or remote
11930 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
11931 the request.  In particular, protocols you expect to use for submodules
11932 must be set to <code>always</code> rather than the default of <code>user</code>. See the
11933 description of <code>protocol.allow</code> above.</p></div>
11934 </dd>
11935 <dt class="hdlist1">
11936 url.&lt;base&gt;.pushInsteadOf
11937 </dt>
11938 <dd>
11939 <p>
11940         Any URL that starts with this value will not be pushed to;
11941         instead, it will be rewritten to start with &lt;base&gt;, and the
11942         resulting URL will be pushed to. In cases where some site serves
11943         a large number of repositories, and serves them with multiple
11944         access methods, some of which do not allow push, this feature
11945         allows people to specify a pull-only URL and have Git
11946         automatically use an appropriate URL to push, even for a
11947         never-before-seen repository on the site.  When more than one
11948         pushInsteadOf strings match a given URL, the longest match is
11949         used.  If a remote has an explicit pushurl, Git will ignore this
11950         setting for that remote.
11951 </p>
11952 </dd>
11953 <dt class="hdlist1">
11954 user.name
11955 </dt>
11956 <dt class="hdlist1">
11957 user.email
11958 </dt>
11959 <dt class="hdlist1">
11960 author.name
11961 </dt>
11962 <dt class="hdlist1">
11963 author.email
11964 </dt>
11965 <dt class="hdlist1">
11966 committer.name
11967 </dt>
11968 <dt class="hdlist1">
11969 committer.email
11970 </dt>
11971 <dd>
11972 <p>
11973         The <code>user.name</code> and <code>user.email</code> variables determine what ends
11974         up in the <code>author</code> and <code>committer</code> fields of commit
11975         objects.
11976         If you need the <code>author</code> or <code>committer</code> to be different, the
11977         <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
11978         <code>committer.email</code> variables can be set.
11979         All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
11980         <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
11981         <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.
11982 </p>
11983 <div class="paragraph"><p>Note that the <code>name</code> forms of these variables conventionally refer to
11984 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
11985 environment variables section of <a href="git.html">git(1)</a> for more information on
11986 these settings and the <code>credential.username</code> option if you&#8217;re looking
11987 for authentication credentials instead.</p></div>
11988 </dd>
11989 <dt class="hdlist1">
11990 user.useConfigOnly
11991 </dt>
11992 <dd>
11993 <p>
11994         Instruct Git to avoid trying to guess defaults for <code>user.email</code>
11995         and <code>user.name</code>, and instead retrieve the values only from the
11996         configuration. For example, if you have multiple email addresses
11997         and would like to use a different one for each repository, then
11998         with this configuration option set to <code>true</code> in the global config
11999         along with a name, Git will prompt you to set up an email before
12000         making new commits in a newly cloned repository.
12001         Defaults to <code>false</code>.
12002 </p>
12003 </dd>
12004 <dt class="hdlist1">
12005 user.signingKey
12006 </dt>
12007 <dd>
12008 <p>
12009         If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
12010         key you want it to automatically when creating a signed tag or
12011         commit, you can override the default selection with this variable.
12012         This option is passed unchanged to gpg&#8217;s --local-user parameter,
12013         so you may specify a key using any method that gpg supports.
12014         If gpg.format is set to <code>ssh</code> this can contain the path to either
12015         your private ssh key or the public key when ssh-agent is used.
12016         Alternatively it can contain a public key prefixed with <code>key::</code>
12017         directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
12018         needs to be available via ssh-agent. If not set Git will call
12019         gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
12020         first key available. For backward compatibility, a raw key which
12021         begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
12022         as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
12023         use the <code>key::</code> form instead.
12024 </p>
12025 </dd>
12026 <dt class="hdlist1">
12027 versionsort.prereleaseSuffix (deprecated)
12028 </dt>
12029 <dd>
12030 <p>
12031         Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
12032         <code>versionsort.suffix</code> is set.
12033 </p>
12034 </dd>
12035 <dt class="hdlist1">
12036 versionsort.suffix
12037 </dt>
12038 <dd>
12039 <p>
12040         Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
12041         with the same base version but different suffixes are still sorted
12042         lexicographically, resulting e.g. in prerelease tags appearing
12043         after the main release (e.g. "1.0-rc1" after "1.0").  This
12044         variable can be specified to determine the sorting order of tags
12045         with different suffixes.
12046 </p>
12047 <div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
12048 that suffix will appear before the corresponding main release.  E.g. if
12049 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
12050 "1.0".  If specified multiple times, once per suffix, then the order of
12051 suffixes in the configuration will determine the sorting order of tagnames
12052 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
12053 configuration, then all "1.0-preX" tags will be listed before any
12054 "1.0-rcX" tags.  The placement of the main release tag relative to tags
12055 with various suffixes can be determined by specifying the empty suffix
12056 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
12057 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
12058 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
12059 "v4.8-bfsX".</p></div>
12060 <div class="paragraph"><p>If more than one suffix matches the same tagname, then that tagname will
12061 be sorted according to the suffix which starts at the earliest position in
12062 the tagname.  If more than one different matching suffix starts at
12063 that earliest position, then that tagname will be sorted according to the
12064 longest of those suffixes.
12065 The sorting order between different suffixes is undefined if they are
12066 in multiple config files.</p></div>
12067 </dd>
12068 <dt class="hdlist1">
12069 web.browser
12070 </dt>
12071 <dd>
12072 <p>
12073         Specify a web browser that may be used by some commands.
12074         Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
12075         may use it.
12076 </p>
12077 </dd>
12078 <dt class="hdlist1">
12079 worktree.guessRemote
12080 </dt>
12081 <dd>
12082 <p>
12083         If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
12084         <code>--detach</code> is used, then <code>git worktree add</code> defaults to
12085         creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
12086         set to true, <code>worktree add</code> tries to find a remote-tracking
12087         branch whose name uniquely matches the new branch name.  If
12088         such a branch exists, it is checked out and set as "upstream"
12089         for the new branch.  If no such match can be found, it falls
12090         back to creating a new branch from the current HEAD.
12091 </p>
12092 </dd>
12093 </dl></div>
12094 </div>
12095 </div>
12096 </div>
12097 <div class="sect1">
12098 <h2 id="_bugs">BUGS</h2>
12099 <div class="sectionbody">
12100 <div class="paragraph"><p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
12101 will result in adding a multi-line key instead of a change, if the subsection
12102 is given with at least one uppercase character. For example when the config
12103 looks like</p></div>
12104 <div class="listingblock">
12105 <div class="content">
12106 <pre><code>  [section.subsection]
12107     key = value1</code></pre>
12108 </div></div>
12109 <div class="paragraph"><p>and running <code>git config section.Subsection.key value2</code> will result in</p></div>
12110 <div class="listingblock">
12111 <div class="content">
12112 <pre><code>  [section.subsection]
12113     key = value1
12114     key = value2</code></pre>
12115 </div></div>
12116 </div>
12117 </div>
12118 <div class="sect1">
12119 <h2 id="_git">GIT</h2>
12120 <div class="sectionbody">
12121 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
12122 </div>
12123 </div>
12124 </div>
12125 <div id="footnotes"><hr /></div>
12126 <div id="footer">
12127 <div id="footer-text">
12128 Last updated
12129  2024-05-16 11:09:25 PDT
12130 </div>
12131 </div>
12132 </body>
12133 </html>