git-config.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-config(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-config(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-config -
 743    Get and set repository or global options
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] &lt;name&gt; [&lt;value&gt; [&lt;value-pattern&gt;]]
 753 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] --add &lt;name&gt; &lt;value&gt;
 754 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--fixed-value] --replace-all &lt;name&gt; &lt;value&gt; [&lt;value-pattern&gt;]
 755 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get &lt;name&gt; [&lt;value-pattern&gt;]
 756 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all &lt;name&gt; [&lt;value-pattern&gt;]
 757 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp &lt;name-regex&gt; [&lt;value-pattern&gt;]
 758 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [-z|--null] --get-urlmatch &lt;name&gt; &lt;URL&gt;
 759 <em>git config</em> [&lt;file-option&gt;] [--fixed-value] --unset &lt;name&gt; [&lt;value-pattern&gt;]
 760 <em>git config</em> [&lt;file-option&gt;] [--fixed-value] --unset-all &lt;name&gt; [&lt;value-pattern&gt;]
 761 <em>git config</em> [&lt;file-option&gt;] --rename-section &lt;old-name&gt; &lt;new-name&gt;
 762 <em>git config</em> [&lt;file-option&gt;] --remove-section &lt;name&gt;
 763 <em>git config</em> [&lt;file-option&gt;] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
 764 <em>git config</em> [&lt;file-option&gt;] --get-color &lt;name&gt; [&lt;default&gt;]
 765 <em>git config</em> [&lt;file-option&gt;] --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]
 766 <em>git config</em> [&lt;file-option&gt;] -e | --edit</pre>
 767 <div class="attribution">
 768 </div></div>
 769 </div>
 770 </div>
 771 <div class="sect1">
 772 <h2 id="_description">DESCRIPTION</h2>
 773 <div class="sectionbody">
 774 <div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is
 775 actually the section and the key separated by a dot, and the value will be
 776 escaped.</p></div>
 777 <div class="paragraph"><p>Multiple lines can be added to an option by using the <code>--add</code> option.
 778 If you want to update or unset an option which can occur on multiple
 779 lines, a <code>value-pattern</code> (which is an extended regular expression,
 780 unless the <code>--fixed-value</code> option is given) needs to be given.  Only the
 781 existing values that match the pattern are updated or unset.  If
 782 you want to handle the lines that do <strong>not</strong> match the pattern, just
 783 prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>),
 784 but note that this only works when the <code>--fixed-value</code> option is not
 785 in use.</p></div>
 786 <div class="paragraph"><p>The <code>--type=&lt;type&gt;</code> option instructs <em>git config</em> to ensure that incoming and
 787 outgoing values are canonicalize-able under the given &lt;type&gt;.  If no
 788 <code>--type=&lt;type&gt;</code> is given, no canonicalization will be performed. Callers may
 789 unset an existing <code>--type</code> specifier with <code>--no-type</code>.</p></div>
 790 <div class="paragraph"><p>When reading, the values are read from the system, global and
 791 repository local configuration files by default, and options
 792 <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code> and
 793 <code>--file &lt;filename&gt;</code> can be used to tell the command to read from only
 794 that location (see <a href="#FILES">[FILES]</a>).</p></div>
 795 <div class="paragraph"><p>When writing, the new value is written to the repository local
 796 configuration file by default, and options <code>--system</code>, <code>--global</code>,
 797 <code>--worktree</code>, <code>--file &lt;filename&gt;</code> can be used to tell the command to
 798 write to that location (you can say <code>--local</code> but that is the
 799 default).</p></div>
 800 <div class="paragraph"><p>This command will fail with non-zero status upon error.  Some exit
 801 codes are:</p></div>
 802 <div class="ulist"><ul>
 803 <li>
 804 <p>
 805 The section or key is invalid (ret=1),
 806 </p>
 807 </li>
 808 <li>
 809 <p>
 810 no section or name was provided (ret=2),
 811 </p>
 812 </li>
 813 <li>
 814 <p>
 815 the config file is invalid (ret=3),
 816 </p>
 817 </li>
 818 <li>
 819 <p>
 820 the config file cannot be written (ret=4),
 821 </p>
 822 </li>
 823 <li>
 824 <p>
 825 you try to unset an option which does not exist (ret=5),
 826 </p>
 827 </li>
 828 <li>
 829 <p>
 830 you try to unset/set an option for which multiple lines match (ret=5), or
 831 </p>
 832 </li>
 833 <li>
 834 <p>
 835 you try to use an invalid regexp (ret=6).
 836 </p>
 837 </li>
 838 </ul></div>
 839 <div class="paragraph"><p>On success, the command returns the exit code 0.</p></div>
 840 <div class="paragraph"><p>A list of all available configuration variables can be obtained using the
 841 <code>git help --config</code> command.</p></div>
 842 </div>
 843 </div>
 844 <div class="sect1">
 845 <h2 id="OPTIONS">OPTIONS</h2>
 846 <div class="sectionbody">
 847 <div class="dlist"><dl>
 848 <dt class="hdlist1">
 849 --replace-all
 850 </dt>
 851 <dd>
 852 <p>
 853         Default behavior is to replace at most one line. This replaces
 854         all lines matching the key (and optionally the <code>value-pattern</code>).
 855 </p>
 856 </dd>
 857 <dt class="hdlist1">
 858 --add
 859 </dt>
 860 <dd>
 861 <p>
 862         Adds a new line to the option without altering any existing
 863         values.  This is the same as providing <em>^$</em> as the <code>value-pattern</code>
 864         in <code>--replace-all</code>.
 865 </p>
 866 </dd>
 867 <dt class="hdlist1">
 868 --get
 869 </dt>
 870 <dd>
 871 <p>
 872         Get the value for a given key (optionally filtered by a regex
 873         matching the value). Returns error code 1 if the key was not
 874         found and the last value if multiple key values were found.
 875 </p>
 876 </dd>
 877 <dt class="hdlist1">
 878 --get-all
 879 </dt>
 880 <dd>
 881 <p>
 882         Like get, but returns all values for a multi-valued key.
 883 </p>
 884 </dd>
 885 <dt class="hdlist1">
 886 --get-regexp
 887 </dt>
 888 <dd>
 889 <p>
 890         Like --get-all, but interprets the name as a regular expression and
 891         writes out the key names.  Regular expression matching is currently
 892         case-sensitive and done against a canonicalized version of the key
 893         in which section and variable names are lowercased, but subsection
 894         names are not.
 895 </p>
 896 </dd>
 897 <dt class="hdlist1">
 898 --get-urlmatch &lt;name&gt; &lt;URL&gt;
 899 </dt>
 900 <dd>
 901 <p>
 902         When given a two-part &lt;name&gt; as &lt;section&gt;.&lt;key&gt;, the value for
 903         &lt;section&gt;.&lt;URL&gt;.&lt;key&gt; whose &lt;URL&gt; part matches the best to the
 904         given URL is returned (if no such key exists, the value for
 905         &lt;section&gt;.&lt;key&gt; is used as a fallback).  When given just the
 906         &lt;section&gt; as name, do so for all the keys in the section and
 907         list them.  Returns error code 1 if no value is found.
 908 </p>
 909 </dd>
 910 <dt class="hdlist1">
 911 --global
 912 </dt>
 913 <dd>
 914 <p>
 915         For writing options: write to global <code>~/.gitconfig</code> file
 916         rather than the repository <code>.git/config</code>, write to
 917         <code>$XDG_CONFIG_HOME/git/config</code> file if this file exists and the
 918         <code>~/.gitconfig</code> file doesn&#8217;t.
 919 </p>
 920 <div class="paragraph"><p>For reading options: read only from global <code>~/.gitconfig</code> and from
 921 <code>$XDG_CONFIG_HOME/git/config</code> rather than from all available files.</p></div>
 922 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 923 </dd>
 924 <dt class="hdlist1">
 925 --system
 926 </dt>
 927 <dd>
 928 <p>
 929         For writing options: write to system-wide
 930         <code>$(prefix)/etc/gitconfig</code> rather than the repository
 931         <code>.git/config</code>.
 932 </p>
 933 <div class="paragraph"><p>For reading options: read only from system-wide <code>$(prefix)/etc/gitconfig</code>
 934 rather than from all available files.</p></div>
 935 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 936 </dd>
 937 <dt class="hdlist1">
 938 --local
 939 </dt>
 940 <dd>
 941 <p>
 942         For writing options: write to the repository <code>.git/config</code> file.
 943         This is the default behavior.
 944 </p>
 945 <div class="paragraph"><p>For reading options: read only from the repository <code>.git/config</code> rather than
 946 from all available files.</p></div>
 947 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 948 </dd>
 949 <dt class="hdlist1">
 950 --worktree
 951 </dt>
 952 <dd>
 953 <p>
 954         Similar to <code>--local</code> except that <code>$GIT_DIR/config.worktree</code> is
 955         read from or written to if <code>extensions.worktreeConfig</code> is
 956         enabled. If not it&#8217;s the same as <code>--local</code>. Note that <code>$GIT_DIR</code>
 957         is equal to <code>$GIT_COMMON_DIR</code> for the main working tree, but is of
 958         the form <code>$GIT_DIR/worktrees/&lt;id&gt;/</code> for other working trees. See
 959         <a href="git-worktree.html">git-worktree(1)</a> to learn how to enable
 960         <code>extensions.worktreeConfig</code>.
 961 </p>
 962 </dd>
 963 <dt class="hdlist1">
 964 -f &lt;config-file&gt;
 965 </dt>
 966 <dt class="hdlist1">
 967 --file &lt;config-file&gt;
 968 </dt>
 969 <dd>
 970 <p>
 971         For writing options: write to the specified file rather than the
 972         repository <code>.git/config</code>.
 973 </p>
 974 <div class="paragraph"><p>For reading options: read only from the specified file rather than from all
 975 available files.</p></div>
 976 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 977 </dd>
 978 <dt class="hdlist1">
 979 --blob &lt;blob&gt;
 980 </dt>
 981 <dd>
 982 <p>
 983         Similar to <code>--file</code> but use the given blob instead of a file. E.g.
 984         you can use <em>master:.gitmodules</em> to read values from the file
 985         <em>.gitmodules</em> in the master branch. See "SPECIFYING REVISIONS"
 986         section in <a href="gitrevisions.html">gitrevisions(7)</a> for a more complete list of
 987         ways to spell blob names.
 988 </p>
 989 </dd>
 990 <dt class="hdlist1">
 991 --remove-section
 992 </dt>
 993 <dd>
 994 <p>
 995         Remove the given section from the configuration file.
 996 </p>
 997 </dd>
 998 <dt class="hdlist1">
 999 --rename-section
1000 </dt>
1001 <dd>
1002 <p>
1003         Rename the given section to a new name.
1004 </p>
1005 </dd>
1006 <dt class="hdlist1">
1007 --unset
1008 </dt>
1009 <dd>
1010 <p>
1011         Remove the line matching the key from config file.
1012 </p>
1013 </dd>
1014 <dt class="hdlist1">
1015 --unset-all
1016 </dt>
1017 <dd>
1018 <p>
1019         Remove all lines matching the key from config file.
1020 </p>
1021 </dd>
1022 <dt class="hdlist1">
1023 -l
1024 </dt>
1025 <dt class="hdlist1">
1026 --list
1027 </dt>
1028 <dd>
1029 <p>
1030         List all variables set in config file, along with their values.
1031 </p>
1032 </dd>
1033 <dt class="hdlist1">
1034 --fixed-value
1035 </dt>
1036 <dd>
1037 <p>
1038         When used with the <code>value-pattern</code> argument, treat <code>value-pattern</code> as
1039         an exact string instead of a regular expression. This will restrict
1040         the name/value pairs that are matched to only those where the value
1041         is exactly equal to the <code>value-pattern</code>.
1042 </p>
1043 </dd>
1044 <dt class="hdlist1">
1045 --type &lt;type&gt;
1046 </dt>
1047 <dd>
1048 <p>
1049   <em>git config</em> will ensure that any input or output is valid under the given
1050   type constraint(s), and will canonicalize outgoing values in <code>&lt;type&gt;</code>'s
1051   canonical form.
1052 </p>
1053 <div class="paragraph"><p>Valid <code>&lt;type&gt;</code>'s include:</p></div>
1054 <div class="ulist"><ul>
1055 <li>
1056 <p>
1057 <em>bool</em>: canonicalize values as either "true" or "false".
1058 </p>
1059 </li>
1060 <li>
1061 <p>
1062 <em>int</em>: canonicalize values as simple decimal numbers. An optional suffix of
1063   <em>k</em>, <em>m</em>, or <em>g</em> will cause the value to be multiplied by 1024, 1048576, or
1064   1073741824 upon input.
1065 </p>
1066 </li>
1067 <li>
1068 <p>
1069 <em>bool-or-int</em>: canonicalize according to either <em>bool</em> or <em>int</em>, as described
1070   above.
1071 </p>
1072 </li>
1073 <li>
1074 <p>
1075 <em>path</em>: canonicalize by expanding a leading <code>~</code> to the value of <code>$HOME</code> and
1076   <code>~user</code> to the home directory for the specified user. This specifier has no
1077   effect when setting the value (but you can use <code>git config section.variable
1078   ~/</code> from the command line to let your shell do the expansion.)
1079 </p>
1080 </li>
1081 <li>
1082 <p>
1083 <em>expiry-date</em>: canonicalize by converting from a fixed or relative date-string
1084   to a timestamp. This specifier has no effect when setting the value.
1085 </p>
1086 </li>
1087 <li>
1088 <p>
1089 <em>color</em>: When getting a value, canonicalize by converting to an ANSI color
1090   escape sequence. When setting a value, a sanity-check is performed to ensure
1091   that the given value is canonicalize-able as an ANSI color, but it is written
1092   as-is.
1093 </p>
1094 </li>
1095 </ul></div>
1096 </dd>
1097 <dt class="hdlist1">
1098 --bool
1099 </dt>
1100 <dt class="hdlist1">
1101 --int
1102 </dt>
1103 <dt class="hdlist1">
1104 --bool-or-int
1105 </dt>
1106 <dt class="hdlist1">
1107 --path
1108 </dt>
1109 <dt class="hdlist1">
1110 --expiry-date
1111 </dt>
1112 <dd>
1113 <p>
1114   Historical options for selecting a type specifier. Prefer instead <code>--type</code>
1115   (see above).
1116 </p>
1117 </dd>
1118 <dt class="hdlist1">
1119 --no-type
1120 </dt>
1121 <dd>
1122 <p>
1123   Un-sets the previously set type specifier (if one was previously set). This
1124   option requests that <em>git config</em> not canonicalize the retrieved variable.
1125   <code>--no-type</code> has no effect without <code>--type=&lt;type&gt;</code> or <code>--&lt;type&gt;</code>.
1126 </p>
1127 </dd>
1128 <dt class="hdlist1">
1129 -z
1130 </dt>
1131 <dt class="hdlist1">
1132 --null
1133 </dt>
1134 <dd>
1135 <p>
1136         For all options that output values and/or keys, always
1137         end values with the null character (instead of a
1138         newline). Use newline instead as a delimiter between
1139         key and value. This allows for secure parsing of the
1140         output without getting confused e.g. by values that
1141         contain line breaks.
1142 </p>
1143 </dd>
1144 <dt class="hdlist1">
1145 --name-only
1146 </dt>
1147 <dd>
1148 <p>
1149         Output only the names of config variables for <code>--list</code> or
1150         <code>--get-regexp</code>.
1151 </p>
1152 </dd>
1153 <dt class="hdlist1">
1154 --show-origin
1155 </dt>
1156 <dd>
1157 <p>
1158         Augment the output of all queried config options with the
1159         origin type (file, standard input, blob, command line) and
1160         the actual origin (config file path, ref, or blob id if
1161         applicable).
1162 </p>
1163 </dd>
1164 <dt class="hdlist1">
1165 --show-scope
1166 </dt>
1167 <dd>
1168 <p>
1169         Similar to <code>--show-origin</code> in that it augments the output of
1170         all queried config options with the scope of that value
1171         (worktree, local, global, system, command).
1172 </p>
1173 </dd>
1174 <dt class="hdlist1">
1175 --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]
1176 </dt>
1177 <dd>
1178 <p>
1179         Find the color setting for <code>&lt;name&gt;</code> (e.g. <code>color.diff</code>) and output
1180         "true" or "false".  <code>&lt;stdout-is-tty&gt;</code> should be either "true" or
1181         "false", and is taken into account when configuration says
1182         "auto".  If <code>&lt;stdout-is-tty&gt;</code> is missing, then checks the standard
1183         output of the command itself, and exits with status 0 if color
1184         is to be used, or exits with status 1 otherwise.
1185         When the color setting for <code>name</code> is undefined, the command uses
1186         <code>color.ui</code> as fallback.
1187 </p>
1188 </dd>
1189 <dt class="hdlist1">
1190 --get-color &lt;name&gt; [&lt;default&gt;]
1191 </dt>
1192 <dd>
1193 <p>
1194         Find the color configured for <code>name</code> (e.g. <code>color.diff.new</code>) and
1195         output it as the ANSI color escape sequence to the standard
1196         output.  The optional <code>default</code> parameter is used instead, if
1197         there is no color configured for <code>name</code>.
1198 </p>
1199 <div class="paragraph"><p><code>--type=color [--default=&lt;default&gt;]</code> is preferred over <code>--get-color</code>
1200 (but note that <code>--get-color</code> will omit the trailing newline printed by
1201 <code>--type=color</code>).</p></div>
1202 </dd>
1203 <dt class="hdlist1">
1204 -e
1205 </dt>
1206 <dt class="hdlist1">
1207 --edit
1208 </dt>
1209 <dd>
1210 <p>
1211         Opens an editor to modify the specified config file; either
1212         <code>--system</code>, <code>--global</code>, or repository (default).
1213 </p>
1214 </dd>
1215 <dt class="hdlist1">
1216 --[no-]includes
1217 </dt>
1218 <dd>
1219 <p>
1220         Respect <code>include.*</code> directives in config files when looking up
1221         values. Defaults to <code>off</code> when a specific file is given (e.g.,
1222         using <code>--file</code>, <code>--global</code>, etc) and <code>on</code> when searching all
1223         config files.
1224 </p>
1225 </dd>
1226 <dt class="hdlist1">
1227 --default &lt;value&gt;
1228 </dt>
1229 <dd>
1230 <p>
1231   When using <code>--get</code>, and the requested variable is not found, behave as if
1232   &lt;value&gt; were the value assigned to the that variable.
1233 </p>
1234 </dd>
1235 </dl></div>
1236 </div>
1237 </div>
1238 <div class="sect1">
1239 <h2 id="_configuration">CONFIGURATION</h2>
1240 <div class="sectionbody">
1241 <div class="paragraph"><p><code>pager.config</code> is only respected when listing configuration, i.e., when
1242 using <code>--list</code> or any of the <code>--get-*</code> which may return multiple results.
1243 The default is to use a pager.</p></div>
1244 </div>
1245 </div>
1246 <div class="sect1">
1247 <h2 id="FILES">FILES</h2>
1248 <div class="sectionbody">
1249 <div class="paragraph"><p>By default, <em>git config</em> will read configuration options from multiple
1250 files:</p></div>
1251 <div class="dlist"><dl>
1252 <dt class="hdlist1">
1253 $(prefix)/etc/gitconfig
1254 </dt>
1255 <dd>
1256 <p>
1257         System-wide configuration file.
1258 </p>
1259 </dd>
1260 <dt class="hdlist1">
1261 $XDG_CONFIG_HOME/git/config
1262 </dt>
1263 <dt class="hdlist1">
1264 ~/.gitconfig
1265 </dt>
1266 <dd>
1267 <p>
1268         User-specific configuration files. When the XDG_CONFIG_HOME environment
1269         variable is not set or empty, $HOME/.config/ is used as
1270         $XDG_CONFIG_HOME.
1271 </p>
1272 <div class="paragraph"><p>These are also called "global" configuration files. If both files exist, both
1273 files are read in the order given above.</p></div>
1274 </dd>
1275 <dt class="hdlist1">
1276 $GIT_DIR/config
1277 </dt>
1278 <dd>
1279 <p>
1280         Repository specific configuration file.
1281 </p>
1282 </dd>
1283 <dt class="hdlist1">
1284 $GIT_DIR/config.worktree
1285 </dt>
1286 <dd>
1287 <p>
1288         This is optional and is only searched when
1289         <code>extensions.worktreeConfig</code> is present in $GIT_DIR/config.
1290 </p>
1291 </dd>
1292 </dl></div>
1293 <div class="paragraph"><p>You may also provide additional configuration parameters when running any
1294 git command by using the <code>-c</code> option. See <a href="git.html">git(1)</a> for details.</p></div>
1295 <div class="paragraph"><p>Options will be read from all of these files that are available. If the
1296 global or the system-wide configuration files are missing or unreadable they
1297 will be ignored. If the repository configuration file is missing or unreadable,
1298 <em>git config</em> will exit with a non-zero error code. An error message is produced
1299 if the file is unreadable, but not if it is missing.</p></div>
1300 <div class="paragraph"><p>The files are read in the order given above, with last value found taking
1301 precedence over values read earlier.  When multiple values are taken then all
1302 values of a key from all files will be used.</p></div>
1303 <div class="paragraph"><p>By default, options are only written to the repository specific
1304 configuration file. Note that this also affects options like <code>--replace-all</code>
1305 and <code>--unset</code>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
1306 <div class="paragraph"><p>You can limit which configuration sources are read from or written to by
1307 specifying the path of a file with the <code>--file</code> option, or by specifying a
1308 configuration scope with <code>--system</code>, <code>--global</code>, <code>--local</code>, or <code>--worktree</code>.
1309 For more, see <a href="#OPTIONS">[OPTIONS]</a> above.</p></div>
1310 </div>
1311 </div>
1312 <div class="sect1">
1313 <h2 id="SCOPES">SCOPES</h2>
1314 <div class="sectionbody">
1315 <div class="paragraph"><p>Each configuration source falls within a configuration scope. The scopes
1316 are:</p></div>
1317 <div class="dlist"><dl>
1318 <dt class="hdlist1">
1319 system
1320 </dt>
1321 <dd>
1322 <p>
1323         $(prefix)/etc/gitconfig
1324 </p>
1325 </dd>
1326 <dt class="hdlist1">
1327 global
1328 </dt>
1329 <dd>
1330 <p>
1331         $XDG_CONFIG_HOME/git/config
1332 </p>
1333 <div class="paragraph"><p>~/.gitconfig</p></div>
1334 </dd>
1335 <dt class="hdlist1">
1336 local
1337 </dt>
1338 <dd>
1339 <p>
1340         $GIT_DIR/config
1341 </p>
1342 </dd>
1343 <dt class="hdlist1">
1344 worktree
1345 </dt>
1346 <dd>
1347 <p>
1348         $GIT_DIR/config.worktree
1349 </p>
1350 </dd>
1351 <dt class="hdlist1">
1352 command
1353 </dt>
1354 <dd>
1355 <p>
1356         GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see <a href="#ENVIRONMENT">[ENVIRONMENT]</a>
1357         below)
1358 </p>
1359 <div class="paragraph"><p>the <code>-c</code> option</p></div>
1360 </dd>
1361 </dl></div>
1362 <div class="paragraph"><p>With the exception of <em>command</em>, each scope corresponds to a command line
1363 option: <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code>.</p></div>
1364 <div class="paragraph"><p>When reading options, specifying a scope will only read options from the
1365 files within that scope. When writing options, specifying a scope will write
1366 to the files within that scope (instead of the repository specific
1367 configuration file). See <a href="#OPTIONS">[OPTIONS]</a> above for a complete description.</p></div>
1368 <div class="paragraph"><p>Most configuration options are respected regardless of the scope it is
1369 defined in, but some options are only respected in certain scopes. See the
1370 respective option&#8217;s documentation for the full details.</p></div>
1371 <div class="sect2">
1372 <h3 id="_protected_configuration">Protected configuration</h3>
1373 <div class="paragraph"><p>Protected configuration refers to the <em>system</em>, <em>global</em>, and <em>command</em> scopes.
1374 For security reasons, certain options are only respected when they are
1375 specified in protected configuration, and ignored otherwise.</p></div>
1376 <div class="paragraph"><p>Git treats these scopes as if they are controlled by the user or a trusted
1377 administrator. This is because an attacker who controls these scopes can do
1378 substantial harm without using Git, so it is assumed that the user&#8217;s environment
1379 protects these scopes against attackers.</p></div>
1380 </div>
1381 </div>
1382 </div>
1383 <div class="sect1">
1384 <h2 id="ENVIRONMENT">ENVIRONMENT</h2>
1385 <div class="sectionbody">
1386 <div class="dlist"><dl>
1387 <dt class="hdlist1">
1388 GIT_CONFIG_GLOBAL
1389 </dt>
1390 <dt class="hdlist1">
1391 GIT_CONFIG_SYSTEM
1392 </dt>
1393 <dd>
1394 <p>
1395         Take the configuration from the given files instead from global or
1396         system-level configuration. See <a href="git.html">git(1)</a> for details.
1397 </p>
1398 </dd>
1399 <dt class="hdlist1">
1400 GIT_CONFIG_NOSYSTEM
1401 </dt>
1402 <dd>
1403 <p>
1404         Whether to skip reading settings from the system-wide
1405         $(prefix)/etc/gitconfig file. See <a href="git.html">git(1)</a> for details.
1406 </p>
1407 </dd>
1408 </dl></div>
1409 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1410 <div class="dlist"><dl>
1411 <dt class="hdlist1">
1412 GIT_CONFIG_COUNT
1413 </dt>
1414 <dt class="hdlist1">
1415 GIT_CONFIG_KEY_&lt;n&gt;
1416 </dt>
1417 <dt class="hdlist1">
1418 GIT_CONFIG_VALUE_&lt;n&gt;
1419 </dt>
1420 <dd>
1421 <p>
1422         If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
1423         GIT_CONFIG_KEY_&lt;n&gt; and GIT_CONFIG_VALUE_&lt;n&gt; up to that number will be
1424         added to the process&#8217;s runtime configuration. The config pairs are
1425         zero-indexed. Any missing key or value is treated as an error. An empty
1426         GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
1427         pairs are processed. These environment variables will override values
1428         in configuration files, but will be overridden by any explicit options
1429         passed via <code>git -c</code>.
1430 </p>
1431 <div class="paragraph"><p>This is useful for cases where you want to spawn multiple git commands
1432 with a common configuration but cannot depend on a configuration file,
1433 for example when writing scripts.</p></div>
1434 </dd>
1435 <dt class="hdlist1">
1436 GIT_CONFIG
1437 </dt>
1438 <dd>
1439 <p>
1440         If no <code>--file</code> option is provided to <code>git config</code>, use the file
1441         given by <code>GIT_CONFIG</code> as if it were provided via <code>--file</code>. This
1442         variable has no effect on other Git commands, and is mostly for
1443         historical compatibility; there is generally no reason to use it
1444         instead of the <code>--file</code> option.
1445 </p>
1446 </dd>
1447 </dl></div>
1448 </div>
1449 </div>
1450 <div class="sect1">
1451 <h2 id="EXAMPLES">EXAMPLES</h2>
1452 <div class="sectionbody">
1453 <div class="paragraph"><p>Given a .git/config like this:</p></div>
1454 <div class="listingblock">
1455 <div class="content">
1456 <pre><code>#
1457 # This is the config file, and
1458 # a '#' or ';' character indicates
1459 # a comment
1460 #
1461
1462 ; core variables
1463 [core]
1464         ; Don't trust file modes
1465         filemode = false
1466
1467 ; Our diff algorithm
1468 [diff]
1469         external = /usr/local/bin/diff-wrapper
1470         renames = true
1471
1472 ; Proxy settings
1473 [core]
1474         gitproxy=proxy-command for kernel.org
1475         gitproxy=default-proxy ; for all the rest
1476
1477 ; HTTP
1478 [http]
1479         sslVerify
1480 [http "https://weak.example.com"]
1481         sslVerify = false
1482         cookieFile = /tmp/cookie.txt</code></pre>
1483 </div></div>
1484 <div class="paragraph"><p>you can set the filemode to true with</p></div>
1485 <div class="listingblock">
1486 <div class="content">
1487 <pre><code>% git config core.filemode true</code></pre>
1488 </div></div>
1489 <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
1490 what URL they apply to. Here is how to change the entry for kernel.org
1491 to "ssh".</p></div>
1492 <div class="listingblock">
1493 <div class="content">
1494 <pre><code>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</code></pre>
1495 </div></div>
1496 <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
1497 <div class="paragraph"><p>To delete the entry for renames, do</p></div>
1498 <div class="listingblock">
1499 <div class="content">
1500 <pre><code>% git config --unset diff.renames</code></pre>
1501 </div></div>
1502 <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
1503 you have to provide a regex matching the value of exactly one line.</p></div>
1504 <div class="paragraph"><p>To query the value for a given key, do</p></div>
1505 <div class="listingblock">
1506 <div class="content">
1507 <pre><code>% git config --get core.filemode</code></pre>
1508 </div></div>
1509 <div class="paragraph"><p>or</p></div>
1510 <div class="listingblock">
1511 <div class="content">
1512 <pre><code>% git config core.filemode</code></pre>
1513 </div></div>
1514 <div class="paragraph"><p>or, to query a multivar:</p></div>
1515 <div class="listingblock">
1516 <div class="content">
1517 <pre><code>% git config --get core.gitproxy "for kernel.org$"</code></pre>
1518 </div></div>
1519 <div class="paragraph"><p>If you want to know all the values for a multivar, do:</p></div>
1520 <div class="listingblock">
1521 <div class="content">
1522 <pre><code>% git config --get-all core.gitproxy</code></pre>
1523 </div></div>
1524 <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
1525 new one with</p></div>
1526 <div class="listingblock">
1527 <div class="content">
1528 <pre><code>% git config --replace-all core.gitproxy ssh</code></pre>
1529 </div></div>
1530 <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy,
1531 i.e. the one without a "for &#8230;" postfix, do something like this:</p></div>
1532 <div class="listingblock">
1533 <div class="content">
1534 <pre><code>% git config core.gitproxy ssh '! for '</code></pre>
1535 </div></div>
1536 <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div>
1537 <div class="listingblock">
1538 <div class="content">
1539 <pre><code>% git config section.key value '[!]'</code></pre>
1540 </div></div>
1541 <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
1542 <div class="listingblock">
1543 <div class="content">
1544 <pre><code>% git config --add core.gitproxy '"proxy-command" for example.com'</code></pre>
1545 </div></div>
1546 <div class="paragraph"><p>An example to use customized color from the configuration in your
1547 script:</p></div>
1548 <div class="listingblock">
1549 <div class="content">
1550 <pre><code>#!/bin/sh
1551 WS=$(git config --get-color color.diff.whitespace "blue reverse")
1552 RESET=$(git config --get-color "" "reset")
1553 echo "${WS}your whitespace color or blue reverse${RESET}"</code></pre>
1554 </div></div>
1555 <div class="paragraph"><p>For URLs in <code>https://weak.example.com</code>, <code>http.sslVerify</code> is set to
1556 false, while it is set to <code>true</code> for all others:</p></div>
1557 <div class="listingblock">
1558 <div class="content">
1559 <pre><code>% git config --type=bool --get-urlmatch http.sslverify https://good.example.com
1560 true
1561 % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com
1562 false
1563 % git config --get-urlmatch http https://weak.example.com
1564 http.cookieFile /tmp/cookie.txt
1565 http.sslverify false</code></pre>
1566 </div></div>
1567 </div>
1568 </div>
1569 <div class="sect1">
1570 <h2 id="_configuration_file">CONFIGURATION FILE</h2>
1571 <div class="sectionbody">
1572 <div class="paragraph"><p>The Git configuration file contains a number of variables that affect
1573 the Git commands' behavior. The files <code>.git/config</code> and optionally
1574 <code>config.worktree</code> (see the "CONFIGURATION FILE" section of
1575 <a href="git-worktree.html">git-worktree(1)</a>) in each repository are used to store the
1576 configuration for that repository, and <code>$HOME/.gitconfig</code> is used to
1577 store a per-user configuration as fallback values for the <code>.git/config</code>
1578 file. The file <code>/etc/gitconfig</code> can be used to store a system-wide
1579 default configuration.</p></div>
1580 <div class="paragraph"><p>The configuration variables are used by both the Git plumbing
1581 and the porcelain commands. The variables are divided into sections, wherein
1582 the fully qualified variable name of the variable itself is the last
1583 dot-separated segment and the section name is everything before the last
1584 dot. The variable names are case-insensitive, allow only alphanumeric
1585 characters and <code>-</code>, and must start with an alphabetic character.  Some
1586 variables may appear multiple times; we say then that the variable is
1587 multivalued.</p></div>
1588 <div class="sect2">
1589 <h3 id="_syntax">Syntax</h3>
1590 <div class="paragraph"><p>The syntax is fairly flexible and permissive; whitespaces are mostly
1591 ignored.  The <em>#</em> and <em>;</em> characters begin comments to the end of line,
1592 blank lines are ignored.</p></div>
1593 <div class="paragraph"><p>The file consists of sections and variables.  A section begins with
1594 the name of the section in square brackets and continues until the next
1595 section begins.  Section names are case-insensitive.  Only alphanumeric
1596 characters, <code>-</code> and <code>.</code> are allowed in section names.  Each variable
1597 must belong to some section, which means that there must be a section
1598 header before the first setting of a variable.</p></div>
1599 <div class="paragraph"><p>Sections can be further divided into subsections.  To begin a subsection
1600 put its name in double quotes, separated by space from the section name,
1601 in the section header, like in the example below:</p></div>
1602 <div class="listingblock">
1603 <div class="content">
1604 <pre><code>        [section "subsection"]</code></pre>
1605 </div></div>
1606 <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
1607 newline and the null byte. Doublequote <code>"</code> and backslash can be included
1608 by escaping them as <code>\"</code> and <code>\\</code>, respectively. Backslashes preceding
1609 other characters are dropped when reading; for example, <code>\t</code> is read as
1610 <code>t</code> and <code>\0</code> is read as <code>0</code>. Section headers cannot span multiple lines.
1611 Variables may belong directly to a section or to a given subsection. You
1612 can have <code>[section]</code> if you have <code>[section "subsection"]</code>, but you don&#8217;t
1613 need to.</p></div>
1614 <div class="paragraph"><p>There is also a deprecated <code>[section.subsection]</code> syntax. With this
1615 syntax, the subsection name is converted to lower-case and is also
1616 compared case sensitively. These subsection names follow the same
1617 restrictions as section names.</p></div>
1618 <div class="paragraph"><p>All the other lines (and the remainder of the line after the section
1619 header) are recognized as setting variables, in the form
1620 <em>name = value</em> (or just <em>name</em>, which is a short-hand to say that
1621 the variable is the boolean "true").
1622 The variable names are case-insensitive, allow only alphanumeric characters
1623 and <code>-</code>, and must start with an alphabetic character.</p></div>
1624 <div class="paragraph"><p>A line that defines a value can be continued to the next line by
1625 ending it with a <code>\</code>; the backslash and the end-of-line are
1626 stripped.  Leading whitespaces after <em>name =</em>, the remainder of the
1627 line after the first comment character <em>#</em> or <em>;</em>, and trailing
1628 whitespaces of the line are discarded unless they are enclosed in
1629 double quotes.  Internal whitespaces within the value are retained
1630 verbatim.</p></div>
1631 <div class="paragraph"><p>Inside double quotes, double quote <code>"</code> and backslash <code>\</code> characters
1632 must be escaped: use <code>\"</code> for <code>"</code> and <code>\\</code> for <code>\</code>.</p></div>
1633 <div class="paragraph"><p>The following escape sequences (beside <code>\"</code> and <code>\\</code>) are recognized:
1634 <code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB)
1635 and <code>\b</code> for backspace (BS).  Other char escape sequences (including octal
1636 escape sequences) are invalid.</p></div>
1637 </div>
1638 <div class="sect2">
1639 <h3 id="_includes">Includes</h3>
1640 <div class="paragraph"><p>The <code>include</code> and <code>includeIf</code> sections allow you to include config
1641 directives from another source. These sections behave identically to
1642 each other with the exception that <code>includeIf</code> sections may be ignored
1643 if their condition does not evaluate to true; see "Conditional includes"
1644 below.</p></div>
1645 <div class="paragraph"><p>You can include a config file from another by setting the special
1646 <code>include.path</code> (or <code>includeIf.*.path</code>) variable to the name of the file
1647 to be included. The variable takes a pathname as its value, and is
1648 subject to tilde expansion. These variables can be given multiple times.</p></div>
1649 <div class="paragraph"><p>The contents of the included file are inserted immediately, as if they
1650 had been found at the location of the include directive. If the value of the
1651 variable is a relative path, the path is considered to
1652 be relative to the configuration file in which the include directive
1653 was found.  See below for examples.</p></div>
1654 </div>
1655 <div class="sect2">
1656 <h3 id="_conditional_includes">Conditional includes</h3>
1657 <div class="paragraph"><p>You can conditionally include a config file from another by setting an
1658 <code>includeIf.&lt;condition&gt;.path</code> variable to the name of the file to be
1659 included.</p></div>
1660 <div class="paragraph"><p>The condition starts with a keyword followed by a colon and some data
1661 whose format and meaning depends on the keyword. Supported keywords
1662 are:</p></div>
1663 <div class="dlist"><dl>
1664 <dt class="hdlist1">
1665 <code>gitdir</code>
1666 </dt>
1667 <dd>
1668 <p>
1669         The data that follows the keyword <code>gitdir:</code> is used as a glob
1670         pattern. If the location of the .git directory matches the
1671         pattern, the include condition is met.
1672 </p>
1673 <div class="paragraph"><p>The .git location may be auto-discovered, or come from <code>$GIT_DIR</code>
1674 environment variable. If the repository is auto-discovered via a .git
1675 file (e.g. from submodules, or a linked worktree), the .git location
1676 would be the final location where the .git directory is, not where the
1677 .git file is.</p></div>
1678 <div class="paragraph"><p>The pattern can contain standard globbing wildcards and two additional
1679 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components. Please
1680 refer to <a href="gitignore.html">gitignore(5)</a> for details. For convenience:</p></div>
1681 <div class="ulist"><ul>
1682 <li>
1683 <p>
1684 If the pattern starts with <code>~/</code>, <code>~</code> will be substituted with the
1685    content of the environment variable <code>HOME</code>.
1686 </p>
1687 </li>
1688 <li>
1689 <p>
1690 If the pattern starts with <code>./</code>, it is replaced with the directory
1691    containing the current config file.
1692 </p>
1693 </li>
1694 <li>
1695 <p>
1696 If the pattern does not start with either <code>~/</code>, <code>./</code> or <code>/</code>, <code>**/</code>
1697    will be automatically prepended. For example, the pattern <code>foo/bar</code>
1698    becomes <code>**/foo/bar</code> and would match <code>/any/path/to/foo/bar</code>.
1699 </p>
1700 </li>
1701 <li>
1702 <p>
1703 If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1704    example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it
1705    matches "foo" and everything inside, recursively.
1706 </p>
1707 </li>
1708 </ul></div>
1709 </dd>
1710 <dt class="hdlist1">
1711 <code>gitdir/i</code>
1712 </dt>
1713 <dd>
1714 <p>
1715         This is the same as <code>gitdir</code> except that matching is done
1716         case-insensitively (e.g. on case-insensitive file systems)
1717 </p>
1718 </dd>
1719 <dt class="hdlist1">
1720 <code>onbranch</code>
1721 </dt>
1722 <dd>
1723 <p>
1724         The data that follows the keyword <code>onbranch:</code> is taken to be a
1725         pattern with standard globbing wildcards and two additional
1726         ones, <code>**/</code> and <code>/**</code>, that can match multiple path components.
1727         If we are in a worktree where the name of the branch that is
1728         currently checked out matches the pattern, the include condition
1729         is met.
1730 </p>
1731 <div class="paragraph"><p>If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1732 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it matches
1733 all branches that begin with <code>foo/</code>. This is useful if your branches are
1734 organized hierarchically and you would like to apply a configuration to
1735 all the branches in that hierarchy.</p></div>
1736 </dd>
1737 <dt class="hdlist1">
1738 <code>hasconfig:remote.*.url:</code>
1739 </dt>
1740 <dd>
1741 <p>
1742         The data that follows this keyword is taken to
1743         be a pattern with standard globbing wildcards and two
1744         additional ones, <code>**/</code> and <code>/**</code>, that can match multiple
1745         components. The first time this keyword is seen, the rest of
1746         the config files will be scanned for remote URLs (without
1747         applying any values). If there exists at least one remote URL
1748         that matches this pattern, the include condition is met.
1749 </p>
1750 <div class="paragraph"><p>Files included by this option (directly or indirectly) are not allowed
1751 to contain remote URLs.</p></div>
1752 <div class="paragraph"><p>Note that unlike other includeIf conditions, resolving this condition
1753 relies on information that is not yet known at the point of reading the
1754 condition. A typical use case is this option being present as a
1755 system-level or global-level config, and the remote URL being in a
1756 local-level config; hence the need to scan ahead when resolving this
1757 condition. In order to avoid the chicken-and-egg problem in which
1758 potentially-included files can affect whether such files are potentially
1759 included, Git breaks the cycle by prohibiting these files from affecting
1760 the resolution of these conditions (thus, prohibiting them from
1761 declaring remote URLs).</p></div>
1762 <div class="paragraph"><p>As for the naming of this keyword, it is for forwards compatibility with
1763 a naming scheme that supports more variable-based include conditions,
1764 but currently Git only supports the exact keyword described above.</p></div>
1765 </dd>
1766 </dl></div>
1767 <div class="paragraph"><p>A few more notes on matching via <code>gitdir</code> and <code>gitdir/i</code>:</p></div>
1768 <div class="ulist"><ul>
1769 <li>
1770 <p>
1771 Symlinks in <code>$GIT_DIR</code> are not resolved before matching.
1772 </p>
1773 </li>
1774 <li>
1775 <p>
1776 Both the symlink &amp; realpath versions of paths will be matched
1777    outside of <code>$GIT_DIR</code>. E.g. if ~/git is a symlink to
1778    /mnt/storage/git, both <code>gitdir:~/git</code> and <code>gitdir:/mnt/storage/git</code>
1779    will match.
1780 </p>
1781 <div class="paragraph"><p>This was not the case in the initial release of this feature in
1782 v2.13.0, which only matched the realpath version. Configuration that
1783 wants to be compatible with the initial release of this feature needs
1784 to either specify only the realpath version, or both versions.</p></div>
1785 </li>
1786 <li>
1787 <p>
1788 Note that "../" is not special and will match literally, which is
1789    unlikely what you want.
1790 </p>
1791 </li>
1792 </ul></div>
1793 </div>
1794 <div class="sect2">
1795 <h3 id="_example">Example</h3>
1796 <div class="listingblock">
1797 <div class="content">
1798 <pre><code># Core variables
1799 [core]
1800         ; Don't trust file modes
1801         filemode = false
1802
1803 # Our diff algorithm
1804 [diff]
1805         external = /usr/local/bin/diff-wrapper
1806         renames = true
1807
1808 [branch "devel"]
1809         remote = origin
1810         merge = refs/heads/devel
1811
1812 # Proxy settings
1813 [core]
1814         gitProxy="ssh" for "kernel.org"
1815         gitProxy=default-proxy ; for the rest
1816
1817 [include]
1818         path = /path/to/foo.inc ; include by absolute path
1819         path = foo.inc ; find "foo.inc" relative to the current file
1820         path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
1821
1822 ; include if $GIT_DIR is /path/to/foo/.git
1823 [includeIf "gitdir:/path/to/foo/.git"]
1824         path = /path/to/foo.inc
1825
1826 ; include for all repositories inside /path/to/group
1827 [includeIf "gitdir:/path/to/group/"]
1828         path = /path/to/foo.inc
1829
1830 ; include for all repositories inside $HOME/to/group
1831 [includeIf "gitdir:~/to/group/"]
1832         path = /path/to/foo.inc
1833
1834 ; relative paths are always relative to the including
1835 ; file (if the condition is true); their location is not
1836 ; affected by the condition
1837 [includeIf "gitdir:/path/to/group/"]
1838         path = foo.inc
1839
1840 ; include only if we are in a worktree where foo-branch is
1841 ; currently checked out
1842 [includeIf "onbranch:foo-branch"]
1843         path = foo.inc
1844
1845 ; include only if a remote with the given URL exists (note
1846 ; that such a URL may be provided later in a file or in a
1847 ; file read after this file is read, as seen in this example)
1848 [includeIf "hasconfig:remote.*.url:https://example.com/**"]
1849         path = foo.inc
1850 [remote "origin"]
1851         url = https://example.com/git</code></pre>
1852 </div></div>
1853 </div>
1854 <div class="sect2">
1855 <h3 id="_values">Values</h3>
1856 <div class="paragraph"><p>Values of many variables are treated as a simple string, but there
1857 are variables that take values of specific types and there are rules
1858 as to how to spell them.</p></div>
1859 <div class="dlist"><dl>
1860 <dt class="hdlist1">
1861 boolean
1862 </dt>
1863 <dd>
1864 <p>
1865        When a variable is said to take a boolean value, many
1866        synonyms are accepted for <em>true</em> and <em>false</em>; these are all
1867        case-insensitive.
1868 </p>
1869 <div class="dlist"><dl>
1870 <dt class="hdlist1">
1871 true
1872 </dt>
1873 <dd>
1874 <p>
1875 Boolean true literals are <code>yes</code>, <code>on</code>, <code>true</code>,
1876                 and <code>1</code>.  Also, a variable defined without <code>= &lt;value&gt;</code>
1877                 is taken as true.
1878 </p>
1879 </dd>
1880 <dt class="hdlist1">
1881 false
1882 </dt>
1883 <dd>
1884 <p>
1885 Boolean false literals are <code>no</code>, <code>off</code>, <code>false</code>,
1886                 <code>0</code> and the empty string.
1887 </p>
1888 <div class="paragraph"><p>When converting a value to its canonical form using the <code>--type=bool</code> type
1889 specifier, <em>git config</em> will ensure that the output is "true" or
1890 "false" (spelled in lowercase).</p></div>
1891 </dd>
1892 </dl></div>
1893 </dd>
1894 <dt class="hdlist1">
1895 integer
1896 </dt>
1897 <dd>
1898 <p>
1899        The value for many variables that specify various sizes can
1900        be suffixed with <code>k</code>, <code>M</code>,&#8230; to mean "scale the number by
1901        1024", "by 1024x1024", etc.
1902 </p>
1903 </dd>
1904 <dt class="hdlist1">
1905 color
1906 </dt>
1907 <dd>
1908 <p>
1909        The value for a variable that takes a color is a list of
1910        colors (at most two, one for foreground and one for background)
1911        and attributes (as many as you want), separated by spaces.
1912 </p>
1913 <div class="paragraph"><p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>,
1914 <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code> and <code>default</code>.  The first
1915 color given is the foreground; the second is the background.  All the
1916 basic colors except <code>normal</code> and <code>default</code> have a bright variant that can
1917 be specified by prefixing the color with <code>bright</code>, like <code>brightred</code>.</p></div>
1918 <div class="paragraph"><p>The color <code>normal</code> makes no change to the color. It is the same as an
1919 empty string, but can be used as the foreground color when specifying a
1920 background color alone (for example, "normal red").</p></div>
1921 <div class="paragraph"><p>The color <code>default</code> explicitly resets the color to the terminal default,
1922 for example to specify a cleared background. Although it varies between
1923 terminals, this is usually not the same as setting to "white black".</p></div>
1924 <div class="paragraph"><p>Colors may also be given as numbers between 0 and 255; these use ANSI
1925 256-color mode (but note that not all terminals may support this).  If
1926 your terminal supports it, you may also specify 24-bit RGB values as
1927 hex, like <code>#ff0ab3</code>.</p></div>
1928 <div class="paragraph"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
1929 <code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters).
1930 The position of any attributes with respect to the colors
1931 (before, after, or in between), doesn&#8217;t matter. Specific attributes may
1932 be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>,
1933 <code>no-ul</code>, etc).</p></div>
1934 <div class="paragraph"><p>The pseudo-attribute <code>reset</code> resets all colors and attributes before
1935 applying the specified coloring. For example, <code>reset green</code> will result
1936 in a green foreground and default background without any active
1937 attributes.</p></div>
1938 <div class="paragraph"><p>An empty color string produces no color effect at all. This can be used
1939 to avoid coloring specific elements without disabling color entirely.</p></div>
1940 <div class="paragraph"><p>For git&#8217;s pre-defined color slots, the attributes are meant to be reset
1941 at the beginning of each item in the colored output. So setting
1942 <code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a
1943 plain <code>black</code>, even if the previous thing on the same output line (e.g.
1944 opening parenthesis before the list of branch names in <code>log --decorate</code>
1945 output) is set to be painted with <code>bold</code> or some other attribute.
1946 However, custom log formats may do more complicated and layered
1947 coloring, and the negated forms may be useful there.</p></div>
1948 </dd>
1949 <dt class="hdlist1">
1950 pathname
1951 </dt>
1952 <dd>
1953 <p>
1954         A variable that takes a pathname value can be given a
1955         string that begins with "<code>~/</code>" or "<code>~user/</code>", and the usual
1956         tilde expansion happens to such a string: <code>~/</code>
1957         is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the
1958         specified user&#8217;s home directory.
1959 </p>
1960 <div class="paragraph"><p>If a path starts with <code>%(prefix)/</code>, the remainder is interpreted as a
1961 path relative to Git&#8217;s "runtime prefix", i.e. relative to the location
1962 where Git itself was installed. For example, <code>%(prefix)/bin/</code> refers to
1963 the directory in which the Git executable itself lives. If Git was
1964 compiled without runtime prefix support, the compiled-in prefix will be
1965 substituted instead. In the unlikely event that a literal path needs to
1966 be specified that should <em>not</em> be expanded, it needs to be prefixed by
1967 <code>./</code>, like so: <code>./%(prefix)/bin</code>.</p></div>
1968 </dd>
1969 </dl></div>
1970 </div>
1971 <div class="sect2">
1972 <h3 id="_variables">Variables</h3>
1973 <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
1974 For command-specific variables, you will find a more detailed description
1975 in the appropriate manual page.</p></div>
1976 <div class="paragraph"><p>Other git-related tools may and do use their own variables.  When
1977 inventing new variables for use in your own tool, make sure their
1978 names do not conflict with those that are used by Git itself and
1979 other popular tools, and describe them in your documentation.</p></div>
1980 <div class="dlist"><dl>
1981 <dt class="hdlist1">
1982 add.ignoreErrors
1983 </dt>
1984 <dt class="hdlist1">
1985 add.ignore-errors (deprecated)
1986 </dt>
1987 <dd>
1988 <p>
1989         Tells <em>git add</em> to continue adding files when some files cannot be
1990         added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
1991         option of <a href="git-add.html">git-add(1)</a>.  <code>add.ignore-errors</code> is deprecated,
1992         as it does not follow the usual naming convention for configuration
1993         variables.
1994 </p>
1995 </dd>
1996 <dt class="hdlist1">
1997 add.interactive.useBuiltin
1998 </dt>
1999 <dd>
2000 <p>
2001         Unused configuration variable. Used in Git versions v2.25.0 to
2002         v2.36.0 to enable the built-in version of <a href="git-add.html">git-add(1)</a>'s
2003         interactive mode, which then became the default in Git
2004         versions v2.37.0 to v2.39.0.
2005 </p>
2006 </dd>
2007 <dt class="hdlist1">
2008 advice.*
2009 </dt>
2010 <dd>
2011 <p>
2012         These variables control various optional help messages designed to
2013         aid new users.  When left unconfigured, Git will give the message
2014         alongside instructions on how to squelch it.  You can tell Git
2015         that you do not need the help message by setting these to <code>false</code>:
2016 </p>
2017 <div class="openblock">
2018 <div class="content">
2019 <div class="dlist"><dl>
2020 <dt class="hdlist1">
2021 addEmbeddedRepo
2022 </dt>
2023 <dd>
2024 <p>
2025                 Shown when the user accidentally adds one
2026                 git repo inside of another.
2027 </p>
2028 </dd>
2029 <dt class="hdlist1">
2030 addEmptyPathspec
2031 </dt>
2032 <dd>
2033 <p>
2034                 Shown when the user runs <code>git add</code> without providing
2035                 the pathspec parameter.
2036 </p>
2037 </dd>
2038 <dt class="hdlist1">
2039 addIgnoredFile
2040 </dt>
2041 <dd>
2042 <p>
2043                 Shown when the user attempts to add an ignored file to
2044                 the index.
2045 </p>
2046 </dd>
2047 <dt class="hdlist1">
2048 amWorkDir
2049 </dt>
2050 <dd>
2051 <p>
2052                 Shown when <a href="git-am.html">git-am(1)</a> fails to apply a patch
2053                 file, to tell the user the location of the file.
2054 </p>
2055 </dd>
2056 <dt class="hdlist1">
2057 ambiguousFetchRefspec
2058 </dt>
2059 <dd>
2060 <p>
2061                 Shown when a fetch refspec for multiple remotes maps to
2062                 the same remote-tracking branch namespace and causes branch
2063                 tracking set-up to fail.
2064 </p>
2065 </dd>
2066 <dt class="hdlist1">
2067 checkoutAmbiguousRemoteBranchName
2068 </dt>
2069 <dd>
2070 <p>
2071                 Shown when the argument to
2072                 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
2073                 ambiguously resolves to a
2074                 remote tracking branch on more than one remote in
2075                 situations where an unambiguous argument would have
2076                 otherwise caused a remote-tracking branch to be
2077                 checked out. See the <code>checkout.defaultRemote</code>
2078                 configuration variable for how to set a given remote
2079                 to be used by default in some situations where this
2080                 advice would be printed.
2081 </p>
2082 </dd>
2083 <dt class="hdlist1">
2084 commitBeforeMerge
2085 </dt>
2086 <dd>
2087 <p>
2088                 Shown when <a href="git-merge.html">git-merge(1)</a> refuses to
2089                 merge to avoid overwriting local changes.
2090 </p>
2091 </dd>
2092 <dt class="hdlist1">
2093 detachedHead
2094 </dt>
2095 <dd>
2096 <p>
2097                 Shown when the user uses
2098                 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
2099                 to move to the detached HEAD state, to tell the user how
2100                 to create a local branch after the fact.
2101 </p>
2102 </dd>
2103 <dt class="hdlist1">
2104 diverging
2105 </dt>
2106 <dd>
2107 <p>
2108                 Shown when a fast-forward is not possible.
2109 </p>
2110 </dd>
2111 <dt class="hdlist1">
2112 fetchShowForcedUpdates
2113 </dt>
2114 <dd>
2115 <p>
2116                 Shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
2117                 to calculate forced updates after ref updates, or to warn
2118                 that the check is disabled.
2119 </p>
2120 </dd>
2121 <dt class="hdlist1">
2122 forceDeleteBranch
2123 </dt>
2124 <dd>
2125 <p>
2126                 Shown when the user tries to delete a not fully merged
2127                 branch without the force option set.
2128 </p>
2129 </dd>
2130 <dt class="hdlist1">
2131 ignoredHook
2132 </dt>
2133 <dd>
2134 <p>
2135                 Shown when a hook is ignored because the hook is not
2136                 set as executable.
2137 </p>
2138 </dd>
2139 <dt class="hdlist1">
2140 implicitIdentity
2141 </dt>
2142 <dd>
2143 <p>
2144                 Shown when the user&#8217;s information is guessed from the
2145                 system username and domain name, to tell the user how to
2146                 set their identity configuration.
2147 </p>
2148 </dd>
2149 <dt class="hdlist1">
2150 nestedTag
2151 </dt>
2152 <dd>
2153 <p>
2154                 Shown when a user attempts to recursively tag a tag object.
2155 </p>
2156 </dd>
2157 <dt class="hdlist1">
2158 pushAlreadyExists
2159 </dt>
2160 <dd>
2161 <p>
2162                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2163                 does not qualify for fast-forwarding (e.g., a tag.)
2164 </p>
2165 </dd>
2166 <dt class="hdlist1">
2167 pushFetchFirst
2168 </dt>
2169 <dd>
2170 <p>
2171                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2172                 tries to overwrite a remote ref that points at an
2173                 object we do not have.
2174 </p>
2175 </dd>
2176 <dt class="hdlist1">
2177 pushNeedsForce
2178 </dt>
2179 <dd>
2180 <p>
2181                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2182                 tries to overwrite a remote ref that points at an
2183                 object that is not a commit-ish, or make the remote
2184                 ref point at an object that is not a commit-ish.
2185 </p>
2186 </dd>
2187 <dt class="hdlist1">
2188 pushNonFFCurrent
2189 </dt>
2190 <dd>
2191 <p>
2192                 Shown when <a href="git-push.html">git-push(1)</a> fails due to a
2193                 non-fast-forward update to the current branch.
2194 </p>
2195 </dd>
2196 <dt class="hdlist1">
2197 pushNonFFMatching
2198 </dt>
2199 <dd>
2200 <p>
2201                 Shown when the user ran <a href="git-push.html">git-push(1)</a> and pushed
2202                 "matching refs" explicitly (i.e. used <code>:</code>, or
2203                 specified a refspec that isn&#8217;t the current branch) and
2204                 it resulted in a non-fast-forward error.
2205 </p>
2206 </dd>
2207 <dt class="hdlist1">
2208 pushRefNeedsUpdate
2209 </dt>
2210 <dd>
2211 <p>
2212                 Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
2213                 a branch when its remote-tracking ref has updates that we
2214                 do not have locally.
2215 </p>
2216 </dd>
2217 <dt class="hdlist1">
2218 pushUnqualifiedRefname
2219 </dt>
2220 <dd>
2221 <p>
2222                 Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
2223                 guess based on the source and destination refs what
2224                 remote ref namespace the source belongs in, but where
2225                 we can still suggest that the user push to either
2226                 <code>refs/heads/*</code> or <code>refs/tags/*</code> based on the type of the
2227                 source object.
2228 </p>
2229 </dd>
2230 <dt class="hdlist1">
2231 pushUpdateRejected
2232 </dt>
2233 <dd>
2234 <p>
2235                 Set this variable to <code>false</code> if you want to disable
2236                 <code>pushNonFFCurrent</code>, <code>pushNonFFMatching</code>, <code>pushAlreadyExists</code>,
2237                 <code>pushFetchFirst</code>, <code>pushNeedsForce</code>, and <code>pushRefNeedsUpdate</code>
2238                 simultaneously.
2239 </p>
2240 </dd>
2241 <dt class="hdlist1">
2242 refSyntax
2243 </dt>
2244 <dd>
2245 <p>
2246                 Shown when the user provides an illegal ref name, to
2247                 tell the user about the ref syntax documentation.
2248 </p>
2249 </dd>
2250 <dt class="hdlist1">
2251 resetNoRefresh
2252 </dt>
2253 <dd>
2254 <p>
2255                 Shown when <a href="git-reset.html">git-reset(1)</a> takes more than 2
2256                 seconds to refresh the index after reset, to tell the user
2257                 that they can use the <code>--no-refresh</code> option.
2258 </p>
2259 </dd>
2260 <dt class="hdlist1">
2261 resolveConflict
2262 </dt>
2263 <dd>
2264 <p>
2265                 Shown by various commands when conflicts
2266                 prevent the operation from being performed.
2267 </p>
2268 </dd>
2269 <dt class="hdlist1">
2270 rmHints
2271 </dt>
2272 <dd>
2273 <p>
2274                 Shown on failure in the output of <a href="git-rm.html">git-rm(1)</a>, to
2275                 give directions on how to proceed from the current state.
2276 </p>
2277 </dd>
2278 <dt class="hdlist1">
2279 sequencerInUse
2280 </dt>
2281 <dd>
2282 <p>
2283                 Shown when a sequencer command is already in progress.
2284 </p>
2285 </dd>
2286 <dt class="hdlist1">
2287 skippedCherryPicks
2288 </dt>
2289 <dd>
2290 <p>
2291                 Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
2292                 been cherry-picked onto the upstream branch.
2293 </p>
2294 </dd>
2295 <dt class="hdlist1">
2296 statusAheadBehind
2297 </dt>
2298 <dd>
2299 <p>
2300                 Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
2301                 counts for a local ref compared to its remote tracking ref,
2302                 and that calculation takes longer than expected. Will not
2303                 appear if <code>status.aheadBehind</code> is false or the option
2304                 <code>--no-ahead-behind</code> is given.
2305 </p>
2306 </dd>
2307 <dt class="hdlist1">
2308 statusHints
2309 </dt>
2310 <dd>
2311 <p>
2312                 Show directions on how to proceed from the current
2313                 state in the output of <a href="git-status.html">git-status(1)</a>, in
2314                 the template shown when writing commit messages in
2315                 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
2316                 by <a href="git-switch.html">git-switch(1)</a> or
2317                 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.
2318 </p>
2319 </dd>
2320 <dt class="hdlist1">
2321 statusUoption
2322 </dt>
2323 <dd>
2324 <p>
2325                 Shown when <a href="git-status.html">git-status(1)</a> takes more than 2
2326                 seconds to enumerate untracked files, to tell the user that
2327                 they can use the <code>-u</code> option.
2328 </p>
2329 </dd>
2330 <dt class="hdlist1">
2331 submoduleAlternateErrorStrategyDie
2332 </dt>
2333 <dd>
2334 <p>
2335                 Shown when a submodule.alternateErrorStrategy option
2336                 configured to "die" causes a fatal error.
2337 </p>
2338 </dd>
2339 <dt class="hdlist1">
2340 submoduleMergeConflict
2341 </dt>
2342 <dd>
2343 <p>
2344                 Advice shown when a non-trivial submodule merge conflict is
2345                 encountered.
2346 </p>
2347 </dd>
2348 <dt class="hdlist1">
2349 submodulesNotUpdated
2350 </dt>
2351 <dd>
2352 <p>
2353                 Shown when a user runs a submodule command that fails
2354                 because <code>git submodule update --init</code> was not run.
2355 </p>
2356 </dd>
2357 <dt class="hdlist1">
2358 suggestDetachingHead
2359 </dt>
2360 <dd>
2361 <p>
2362                 Shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
2363                 without the explicit <code>--detach</code> option.
2364 </p>
2365 </dd>
2366 <dt class="hdlist1">
2367 updateSparsePath
2368 </dt>
2369 <dd>
2370 <p>
2371                 Shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
2372                 is asked to update index entries outside the current sparse
2373                 checkout.
2374 </p>
2375 </dd>
2376 <dt class="hdlist1">
2377 waitingForEditor
2378 </dt>
2379 <dd>
2380 <p>
2381                 Shown when Git is waiting for editor input. Relevant
2382                 when e.g. the editor is not launched inside the terminal.
2383 </p>
2384 </dd>
2385 <dt class="hdlist1">
2386 worktreeAddOrphan
2387 </dt>
2388 <dd>
2389 <p>
2390                 Shown when the user tries to create a worktree from an
2391                 invalid reference, to tell the user how to create a new unborn
2392                 branch instead.
2393 </p>
2394 </dd>
2395 </dl></div>
2396 </div></div>
2397 </dd>
2398 <dt class="hdlist1">
2399 alias.*
2400 </dt>
2401 <dd>
2402 <p>
2403         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
2404         after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
2405         <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
2406         confusion and troubles with script usage, aliases that
2407         hide existing Git commands are ignored. Arguments are split by
2408         spaces, the usual shell quoting and escaping are supported.
2409         A quote pair or a backslash can be used to quote them.
2410 </p>
2411 <div class="paragraph"><p>Note that the first word of an alias does not necessarily have to be a
2412 command. It can be a command-line option that will be passed into the
2413 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
2414 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
2415 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
2416 running <code>git loud-rebase</code> would be equivalent to
2417 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
2418 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
2419 where the original command does not.</p></div>
2420 <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
2421 it will be treated as a shell command.  For example, defining
2422 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
2423 <code>git new</code> is equivalent to running the shell command
2424 <code>gitk --all --not ORIG_HEAD</code>.  Note that shell commands will be
2425 executed from the top-level directory of a repository, which may
2426 not necessarily be the current directory.
2427 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
2428 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
2429 </dd>
2430 <dt class="hdlist1">
2431 am.keepcr
2432 </dt>
2433 <dd>
2434 <p>
2435         If true, git-am will call git-mailsplit for patches in mbox format
2436         with parameter <code>--keep-cr</code>. In this case git-mailsplit will
2437         not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
2438         by giving <code>--no-keep-cr</code> from the command line.
2439         See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
2440 </p>
2441 </dd>
2442 <dt class="hdlist1">
2443 am.threeWay
2444 </dt>
2445 <dd>
2446 <p>
2447         By default, <code>git am</code> will fail if the patch does not apply cleanly. When
2448         set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
2449         the patch records the identity of blobs it is supposed to apply to and
2450         we have those blobs available locally (equivalent to giving the <code>--3way</code>
2451         option from the command line). Defaults to <code>false</code>.
2452         See <a href="git-am.html">git-am(1)</a>.
2453 </p>
2454 </dd>
2455 <dt class="hdlist1">
2456 apply.ignoreWhitespace
2457 </dt>
2458 <dd>
2459 <p>
2460         When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
2461         whitespace, in the same way as the <code>--ignore-space-change</code>
2462         option.
2463         When set to one of: no, none, never, false, it tells <em>git apply</em> to
2464         respect all whitespace differences.
2465         See <a href="git-apply.html">git-apply(1)</a>.
2466 </p>
2467 </dd>
2468 <dt class="hdlist1">
2469 apply.whitespace
2470 </dt>
2471 <dd>
2472 <p>
2473         Tells <em>git apply</em> how to handle whitespace, in the same way
2474         as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
2475 </p>
2476 </dd>
2477 <dt class="hdlist1">
2478 attr.tree
2479 </dt>
2480 <dd>
2481 <p>
2482         A reference to a tree in the repository from which to read attributes,
2483         instead of the <code>.gitattributes</code> file in the working tree. In a bare
2484         repository, this defaults to <code>HEAD:.gitattributes</code>. If the value does
2485         not resolve to a valid tree object, an empty tree is used instead.
2486         When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2487         command line option are used, this configuration variable has no effect.
2488 </p>
2489 </dd>
2490 <dt class="hdlist1">
2491 blame.blankBoundary
2492 </dt>
2493 <dd>
2494 <p>
2495         Show blank commit object name for boundary commits in
2496         <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.
2497 </p>
2498 </dd>
2499 <dt class="hdlist1">
2500 blame.coloring
2501 </dt>
2502 <dd>
2503 <p>
2504         This determines the coloring scheme to be applied to blame
2505         output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
2506         or <em>none</em> which is the default.
2507 </p>
2508 </dd>
2509 <dt class="hdlist1">
2510 blame.date
2511 </dt>
2512 <dd>
2513 <p>
2514         Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
2515         If unset the iso format is used. For supported values,
2516         see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.
2517 </p>
2518 </dd>
2519 <dt class="hdlist1">
2520 blame.showEmail
2521 </dt>
2522 <dd>
2523 <p>
2524         Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
2525         This option defaults to false.
2526 </p>
2527 </dd>
2528 <dt class="hdlist1">
2529 blame.showRoot
2530 </dt>
2531 <dd>
2532 <p>
2533         Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
2534         This option defaults to false.
2535 </p>
2536 </dd>
2537 <dt class="hdlist1">
2538 blame.ignoreRevsFile
2539 </dt>
2540 <dd>
2541 <p>
2542         Ignore revisions listed in the file, one unabbreviated object name per
2543         line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
2544         <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
2545         file names will reset the list of ignored revisions.  This option will
2546         be handled before the command line option <code>--ignore-revs-file</code>.
2547 </p>
2548 </dd>
2549 <dt class="hdlist1">
2550 blame.markUnblamableLines
2551 </dt>
2552 <dd>
2553 <p>
2554         Mark lines that were changed by an ignored revision that we could not
2555         attribute to another commit with a <em>*</em> in the output of
2556         <a href="git-blame.html">git-blame(1)</a>.
2557 </p>
2558 </dd>
2559 <dt class="hdlist1">
2560 blame.markIgnoredLines
2561 </dt>
2562 <dd>
2563 <p>
2564         Mark lines that were changed by an ignored revision that we attributed to
2565         another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.
2566 </p>
2567 </dd>
2568 <dt class="hdlist1">
2569 branch.autoSetupMerge
2570 </dt>
2571 <dd>
2572 <p>
2573         Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
2574         so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
2575         starting point branch. Note that even if this option is not set,
2576         this behavior can be chosen per-branch using the <code>--track</code>
2577         and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
2578         automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
2579         starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;        automatic setup is done when the starting point is either a
2580         local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
2581         has a tracking configuration, it is copied to the new
2582         branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
2583         is a remote-tracking branch and the new branch has the same name as the
2584         remote branch. This option defaults to true.
2585 </p>
2586 </dd>
2587 <dt class="hdlist1">
2588 branch.autoSetupRebase
2589 </dt>
2590 <dd>
2591 <p>
2592         When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
2593         that tracks another branch, this variable tells Git to set
2594         up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
2595         When <code>never</code>, rebase is never automatically set to true.
2596         When <code>local</code>, rebase is set to true for tracked branches of
2597         other local branches.
2598         When <code>remote</code>, rebase is set to true for tracked branches of
2599         remote-tracking branches.
2600         When <code>always</code>, rebase will be set to true for all tracking
2601         branches.
2602         See "branch.autoSetupMerge" for details on how to set up a
2603         branch to track another branch.
2604         This option defaults to never.
2605 </p>
2606 </dd>
2607 <dt class="hdlist1">
2608 branch.sort
2609 </dt>
2610 <dd>
2611 <p>
2612         This variable controls the sort ordering of branches when displayed by
2613         <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
2614         value of this variable will be used as the default.
2615         See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.
2616 </p>
2617 </dd>
2618 <dt class="hdlist1">
2619 branch.&lt;name&gt;.remote
2620 </dt>
2621 <dd>
2622 <p>
2623         When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
2624         which remote to fetch from or push to.  The remote to push to
2625         may be overridden with <code>remote.pushDefault</code> (for all branches).
2626         The remote to push to, for the current branch, may be further
2627         overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
2628         configured, or if you are not on any branch and there is more than
2629         one remote defined in the repository, it defaults to <code>origin</code> for
2630         fetching and <code>remote.pushDefault</code> for pushing.
2631         Additionally, <code>.</code> (a period) is the current local repository
2632         (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
2633 </p>
2634 </dd>
2635 <dt class="hdlist1">
2636 branch.&lt;name&gt;.pushRemote
2637 </dt>
2638 <dd>
2639 <p>
2640         When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
2641         pushing.  It also overrides <code>remote.pushDefault</code> for pushing
2642         from branch &lt;name&gt;.  When you pull from one place (e.g. your
2643         upstream) and push to another place (e.g. your own publishing
2644         repository), you would want to set <code>remote.pushDefault</code> to
2645         specify the remote to push to for all branches, and use this
2646         option to override it for a specific branch.
2647 </p>
2648 </dd>
2649 <dt class="hdlist1">
2650 branch.&lt;name&gt;.merge
2651 </dt>
2652 <dd>
2653 <p>
2654         Defines, together with branch.&lt;name&gt;.remote, the upstream branch
2655         for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
2656         branch to merge and can also affect <em>git push</em> (see push.default).
2657         When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
2658         refspec to be marked for merging in FETCH_HEAD. The value is
2659         handled like the remote part of a refspec, and must match a
2660         ref which is fetched from the remote given by
2661         "branch.&lt;name&gt;.remote".
2662         The merge information is used by <em>git pull</em> (which first calls
2663         <em>git fetch</em>) to lookup the default branch for merging. Without
2664         this option, <em>git pull</em> defaults to merge the first refspec fetched.
2665         Specify multiple values to get an octopus merge.
2666         If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
2667         another branch in the local repository, you can point
2668         branch.&lt;name&gt;.merge to the desired branch, and use the relative path
2669         setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
2670 </p>
2671 </dd>
2672 <dt class="hdlist1">
2673 branch.&lt;name&gt;.mergeOptions
2674 </dt>
2675 <dd>
2676 <p>
2677         Sets default options for merging into branch &lt;name&gt;. The syntax and
2678         supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
2679         option values containing whitespace characters are currently not
2680         supported.
2681 </p>
2682 </dd>
2683 <dt class="hdlist1">
2684 branch.&lt;name&gt;.rebase
2685 </dt>
2686 <dd>
2687 <p>
2688         When true, rebase the branch &lt;name&gt; on top of the fetched branch,
2689         instead of merging the default branch from the default remote when
2690         "git pull" is run. See "pull.rebase" for doing this in a non
2691         branch-specific manner.
2692 </p>
2693 <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>
2694 so that the local merge commits are included in the rebase (see
2695 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
2696 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
2697 mode.</p></div>
2698 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
2699 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
2700 for details).</p></div>
2701 </dd>
2702 <dt class="hdlist1">
2703 branch.&lt;name&gt;.description
2704 </dt>
2705 <dd>
2706 <p>
2707         Branch description, can be edited with
2708         <code>git branch --edit-description</code>. Branch description is
2709         automatically added to the format-patch cover letter or
2710         request-pull summary.
2711 </p>
2712 </dd>
2713 <dt class="hdlist1">
2714 browser.&lt;tool&gt;.cmd
2715 </dt>
2716 <dd>
2717 <p>
2718         Specify the command to invoke the specified browser. The
2719         specified command is evaluated in shell with the URLs passed
2720         as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
2721 </p>
2722 </dd>
2723 <dt class="hdlist1">
2724 browser.&lt;tool&gt;.path
2725 </dt>
2726 <dd>
2727 <p>
2728         Override the path for the given tool that may be used to
2729         browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
2730         working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
2731 </p>
2732 </dd>
2733 <dt class="hdlist1">
2734 bundle.*
2735 </dt>
2736 <dd>
2737 <p>
2738         The <code>bundle.*</code> keys may appear in a bundle list file found via the
2739         <code>git clone --bundle-uri</code> option. These keys currently have no effect
2740         if placed in a repository config file, though this will change in the
2741         future. See <a href="technical/bundle-uri.html">the bundle URI design
2742         document</a> for more details.
2743 </p>
2744 </dd>
2745 <dt class="hdlist1">
2746 bundle.version
2747 </dt>
2748 <dd>
2749 <p>
2750         This integer value advertises the version of the bundle list format
2751         used by the bundle list. Currently, the only accepted value is <code>1</code>.
2752 </p>
2753 </dd>
2754 <dt class="hdlist1">
2755 bundle.mode
2756 </dt>
2757 <dd>
2758 <p>
2759         This string value should be either <code>all</code> or <code>any</code>. This value describes
2760         whether all of the advertised bundles are required to unbundle a
2761         complete understanding of the bundled information (<code>all</code>) or if any one
2762         of the listed bundle URIs is sufficient (<code>any</code>).
2763 </p>
2764 </dd>
2765 <dt class="hdlist1">
2766 bundle.heuristic
2767 </dt>
2768 <dd>
2769 <p>
2770         If this string-valued key exists, then the bundle list is designed to
2771         work well with incremental <code>git fetch</code> commands. The heuristic signals
2772         that there are additional keys available for each bundle that help
2773         determine which subset of bundles the client should download. The
2774         only value currently understood is <code>creationToken</code>.
2775 </p>
2776 </dd>
2777 <dt class="hdlist1">
2778 bundle.&lt;id&gt;.*
2779 </dt>
2780 <dd>
2781 <p>
2782         The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
2783         bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.
2784 </p>
2785 </dd>
2786 <dt class="hdlist1">
2787 bundle.&lt;id&gt;.uri
2788 </dt>
2789 <dd>
2790 <p>
2791         This string value defines the URI by which Git can reach the contents
2792         of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.
2793 </p>
2794 </dd>
2795 <dt class="hdlist1">
2796 checkout.defaultRemote
2797 </dt>
2798 <dd>
2799 <p>
2800         When you run <code>git checkout &lt;something&gt;</code>
2801         or <code>git switch &lt;something&gt;</code> and only have one
2802         remote, it may implicitly fall back on checking out and
2803         tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
2804         as you have more than one remote with a <code>&lt;something&gt;</code>
2805         reference. This setting allows for setting the name of a
2806         preferred remote that should always win when it comes to
2807         disambiguation. The typical use-case is to set this to
2808         <code>origin</code>.
2809 </p>
2810 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
2811 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
2812 or <code>git switch &lt;something&gt;</code>
2813 will checkout the <code>&lt;something&gt;</code> branch on another remote,
2814 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
2815 remote branch. This setting might be used for other checkout-like
2816 commands or functionality in the future.</p></div>
2817 </dd>
2818 <dt class="hdlist1">
2819 checkout.guess
2820 </dt>
2821 <dd>
2822 <p>
2823         Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
2824         option in <code>git checkout</code> and <code>git switch</code>. See
2825         <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
2826 </p>
2827 </dd>
2828 <dt class="hdlist1">
2829 checkout.workers
2830 </dt>
2831 <dd>
2832 <p>
2833         The number of parallel workers to use when updating the working tree.
2834         The default is one, i.e. sequential execution. If set to a value less
2835         than one, Git will use as many workers as the number of logical cores
2836         available. This setting and <code>checkout.thresholdForParallelism</code> affect
2837         all commands that perform checkout. E.g. checkout, clone, reset,
2838         sparse-checkout, etc.
2839 </p>
2840 <div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories
2841 located on SSDs or over NFS. For repositories on spinning disks and/or machines
2842 with a small number of cores, the default sequential checkout often performs
2843 better. The size and compression level of a repository might also influence how
2844 well the parallel version performs.</p></div>
2845 </dd>
2846 <dt class="hdlist1">
2847 checkout.thresholdForParallelism
2848 </dt>
2849 <dd>
2850 <p>
2851         When running parallel checkout with a small number of files, the cost
2852         of subprocess spawning and inter-process communication might outweigh
2853         the parallelization gains. This setting allows you to define the minimum
2854         number of files for which parallel checkout should be attempted. The
2855         default is 100.
2856 </p>
2857 </dd>
2858 <dt class="hdlist1">
2859 clean.requireForce
2860 </dt>
2861 <dd>
2862 <p>
2863         A boolean to make git-clean refuse to delete files unless -f
2864         is given. Defaults to true.
2865 </p>
2866 </dd>
2867 <dt class="hdlist1">
2868 clone.defaultRemoteName
2869 </dt>
2870 <dd>
2871 <p>
2872         The name of the remote to create when cloning a repository.  Defaults to
2873         <code>origin</code>, and can be overridden by passing the <code>--origin</code> command-line
2874         option to <a href="git-clone.html">git-clone(1)</a>.
2875 </p>
2876 </dd>
2877 <dt class="hdlist1">
2878 clone.rejectShallow
2879 </dt>
2880 <dd>
2881 <p>
2882         Reject cloning a repository if it is a shallow one; this can be overridden by
2883         passing the <code>--reject-shallow</code> option on the command line. See <a href="git-clone.html">git-clone(1)</a>
2884 </p>
2885 </dd>
2886 <dt class="hdlist1">
2887 clone.filterSubmodules
2888 </dt>
2889 <dd>
2890 <p>
2891         If a partial clone filter is provided (see <code>--filter</code> in
2892         <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
2893         the filter to submodules.
2894 </p>
2895 </dd>
2896 <dt class="hdlist1">
2897 color.advice
2898 </dt>
2899 <dd>
2900 <p>
2901         A boolean to enable/disable color in hints (e.g. when a push
2902         failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
2903         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
2904         are used only when the error output goes to a terminal. If
2905         unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
2906 </p>
2907 </dd>
2908 <dt class="hdlist1">
2909 color.advice.hint
2910 </dt>
2911 <dd>
2912 <p>
2913         Use customized color for hints.
2914 </p>
2915 </dd>
2916 <dt class="hdlist1">
2917 color.blame.highlightRecent
2918 </dt>
2919 <dd>
2920 <p>
2921         Specify the line annotation color for <code>git blame --color-by-age</code>
2922         depending upon the age of the line.
2923 </p>
2924 <div class="paragraph"><p>This setting should be set to a comma-separated list of color and
2925 date settings, starting and ending with a color, the dates should be
2926 set from oldest to newest. The metadata will be colored with the
2927 specified colors if the line was introduced before the given
2928 timestamp, overwriting older timestamped colors.</p></div>
2929 <div class="paragraph"><p>Instead of an absolute timestamp relative timestamps work as well,
2930 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
2931 <div class="paragraph"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
2932 colors everything older than one year blue, recent changes between
2933 one month and one year old are kept white, and lines introduced
2934 within the last month are colored red.</p></div>
2935 </dd>
2936 <dt class="hdlist1">
2937 color.blame.repeatedLines
2938 </dt>
2939 <dd>
2940 <p>
2941         Use the specified color to colorize line annotations for
2942         <code>git blame --color-lines</code>, if they come from the same commit as the
2943         preceding line. Defaults to cyan.
2944 </p>
2945 </dd>
2946 <dt class="hdlist1">
2947 color.branch
2948 </dt>
2949 <dd>
2950 <p>
2951         A boolean to enable/disable color in the output of
2952         <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
2953         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
2954         only when the output is to a terminal. If unset, then the
2955         value of <code>color.ui</code> is used (<code>auto</code> by default).
2956 </p>
2957 </dd>
2958 <dt class="hdlist1">
2959 color.branch.&lt;slot&gt;
2960 </dt>
2961 <dd>
2962 <p>
2963         Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
2964         <code>current</code> (the current branch), <code>local</code> (a local branch),
2965         <code>remote</code> (a remote-tracking branch in refs/remotes/),
2966         <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
2967         refs).
2968 </p>
2969 </dd>
2970 <dt class="hdlist1">
2971 color.diff
2972 </dt>
2973 <dd>
2974 <p>
2975         Whether to use ANSI escape sequences to add color to patches.
2976         If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
2977         <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
2978         for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
2979         commands will only use color when output is to the terminal.
2980         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
2981         default).
2982 </p>
2983 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
2984 <em>git-diff-&#42;</em> plumbing commands.  Can be overridden on the
2985 command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
2986 </dd>
2987 <dt class="hdlist1">
2988 color.diff.&lt;slot&gt;
2989 </dt>
2990 <dd>
2991 <p>
2992         Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
2993         which part of the patch to use the specified color, and is one
2994         of <code>context</code> (context text - <code>plain</code> is a historical synonym),
2995         <code>meta</code> (metainformation), <code>frag</code>
2996         (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
2997         <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
2998         (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
2999         <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
3000         <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
3001         <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
3002         setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
3003         <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
3004         <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).
3005 </p>
3006 </dd>
3007 <dt class="hdlist1">
3008 color.decorate.&lt;slot&gt;
3009 </dt>
3010 <dd>
3011 <p>
3012         Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
3013         of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
3014         branches, remote-tracking branches, tags, stash and HEAD, respectively
3015         and <code>grafted</code> for grafted commits.
3016 </p>
3017 </dd>
3018 <dt class="hdlist1">
3019 color.grep
3020 </dt>
3021 <dd>
3022 <p>
3023         When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
3024         <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
3025         when the output is written to the terminal.  If unset, then the
3026         value of <code>color.ui</code> is used (<code>auto</code> by default).
3027 </p>
3028 </dd>
3029 <dt class="hdlist1">
3030 color.grep.&lt;slot&gt;
3031 </dt>
3032 <dd>
3033 <p>
3034         Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
3035         part of the line to use the specified color, and is one of
3036 </p>
3037 <div class="openblock">
3038 <div class="content">
3039 <div class="dlist"><dl>
3040 <dt class="hdlist1">
3041 <code>context</code>
3042 </dt>
3043 <dd>
3044 <p>
3045         non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
3046 </p>
3047 </dd>
3048 <dt class="hdlist1">
3049 <code>filename</code>
3050 </dt>
3051 <dd>
3052 <p>
3053         filename prefix (when not using <code>-h</code>)
3054 </p>
3055 </dd>
3056 <dt class="hdlist1">
3057 <code>function</code>
3058 </dt>
3059 <dd>
3060 <p>
3061         function name lines (when using <code>-p</code>)
3062 </p>
3063 </dd>
3064 <dt class="hdlist1">
3065 <code>lineNumber</code>
3066 </dt>
3067 <dd>
3068 <p>
3069         line number prefix (when using <code>-n</code>)
3070 </p>
3071 </dd>
3072 <dt class="hdlist1">
3073 <code>column</code>
3074 </dt>
3075 <dd>
3076 <p>
3077         column number prefix (when using <code>--column</code>)
3078 </p>
3079 </dd>
3080 <dt class="hdlist1">
3081 <code>match</code>
3082 </dt>
3083 <dd>
3084 <p>
3085         matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
3086 </p>
3087 </dd>
3088 <dt class="hdlist1">
3089 <code>matchContext</code>
3090 </dt>
3091 <dd>
3092 <p>
3093         matching text in context lines
3094 </p>
3095 </dd>
3096 <dt class="hdlist1">
3097 <code>matchSelected</code>
3098 </dt>
3099 <dd>
3100 <p>
3101         matching text in selected lines. Also, used to customize the following
3102         <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.
3103 </p>
3104 </dd>
3105 <dt class="hdlist1">
3106 <code>selected</code>
3107 </dt>
3108 <dd>
3109 <p>
3110         non-matching text in selected lines. Also, used to customize the
3111         following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
3112         <code>--committer</code>.
3113 </p>
3114 </dd>
3115 <dt class="hdlist1">
3116 <code>separator</code>
3117 </dt>
3118 <dd>
3119 <p>
3120         separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
3121         and between hunks (<code>--</code>)
3122 </p>
3123 </dd>
3124 </dl></div>
3125 </div></div>
3126 </dd>
3127 <dt class="hdlist1">
3128 color.interactive
3129 </dt>
3130 <dd>
3131 <p>
3132         When set to <code>always</code>, always use colors for interactive prompts
3133         and displays (such as those used by "git-add --interactive" and
3134         "git-clean --interactive"). When false (or <code>never</code>), never.
3135         When set to <code>true</code> or <code>auto</code>, use colors only when the output is
3136         to the terminal. If unset, then the value of <code>color.ui</code> is
3137         used (<code>auto</code> by default).
3138 </p>
3139 </dd>
3140 <dt class="hdlist1">
3141 color.interactive.&lt;slot&gt;
3142 </dt>
3143 <dd>
3144 <p>
3145         Use customized color for <em>git add --interactive</em> and <em>git clean
3146         --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
3147         or <code>error</code>, for four distinct types of normal output from
3148         interactive commands.
3149 </p>
3150 </dd>
3151 <dt class="hdlist1">
3152 color.pager
3153 </dt>
3154 <dd>
3155 <p>
3156         A boolean to specify whether <code>auto</code> color modes should colorize
3157         output going to the pager. Defaults to true; set this to false
3158         if your pager does not understand ANSI color codes.
3159 </p>
3160 </dd>
3161 <dt class="hdlist1">
3162 color.push
3163 </dt>
3164 <dd>
3165 <p>
3166         A boolean to enable/disable color in push errors. May be set to
3167         <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3168         case colors are used only when the error output goes to a terminal.
3169         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3170 </p>
3171 </dd>
3172 <dt class="hdlist1">
3173 color.push.error
3174 </dt>
3175 <dd>
3176 <p>
3177         Use customized color for push errors.
3178 </p>
3179 </dd>
3180 <dt class="hdlist1">
3181 color.remote
3182 </dt>
3183 <dd>
3184 <p>
3185         If set, keywords at the start of the line are highlighted. The
3186         keywords are "error", "warning", "hint" and "success", and are
3187         matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
3188         <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
3189         <code>color.ui</code> is used (<code>auto</code> by default).
3190 </p>
3191 </dd>
3192 <dt class="hdlist1">
3193 color.remote.&lt;slot&gt;
3194 </dt>
3195 <dd>
3196 <p>
3197         Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
3198         <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
3199         corresponding keyword.
3200 </p>
3201 </dd>
3202 <dt class="hdlist1">
3203 color.showBranch
3204 </dt>
3205 <dd>
3206 <p>
3207         A boolean to enable/disable color in the output of
3208         <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
3209         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3210         only when the output is to a terminal. If unset, then the
3211         value of <code>color.ui</code> is used (<code>auto</code> by default).
3212 </p>
3213 </dd>
3214 <dt class="hdlist1">
3215 color.status
3216 </dt>
3217 <dd>
3218 <p>
3219         A boolean to enable/disable color in the output of
3220         <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
3221         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3222         only when the output is to a terminal. If unset, then the
3223         value of <code>color.ui</code> is used (<code>auto</code> by default).
3224 </p>
3225 </dd>
3226 <dt class="hdlist1">
3227 color.status.&lt;slot&gt;
3228 </dt>
3229 <dd>
3230 <p>
3231         Use customized color for status colorization. <code>&lt;slot&gt;</code> is
3232         one of <code>header</code> (the header text of the status message),
3233         <code>added</code> or <code>updated</code> (files which are added but not committed),
3234         <code>changed</code> (files which are changed but not added in the index),
3235         <code>untracked</code> (files which are not tracked by Git),
3236         <code>branch</code> (the current branch),
3237         <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
3238         to red),
3239         <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
3240         respectively, when branch and tracking information is displayed in the
3241         status short-format), or
3242         <code>unmerged</code> (files which have unmerged changes).
3243 </p>
3244 </dd>
3245 <dt class="hdlist1">
3246 color.transport
3247 </dt>
3248 <dd>
3249 <p>
3250         A boolean to enable/disable color when pushes are rejected. May be
3251         set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3252         case colors are used only when the error output goes to a terminal.
3253         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3254 </p>
3255 </dd>
3256 <dt class="hdlist1">
3257 color.transport.rejected
3258 </dt>
3259 <dd>
3260 <p>
3261         Use customized color when a push was rejected.
3262 </p>
3263 </dd>
3264 <dt class="hdlist1">
3265 color.ui
3266 </dt>
3267 <dd>
3268 <p>
3269         This variable determines the default value for variables such
3270         as <code>color.diff</code> and <code>color.grep</code> that control the use of color
3271         per command family. Its scope will expand as more commands learn
3272         configuration to set a default for the <code>--color</code> option.  Set it
3273         to <code>false</code> or <code>never</code> if you prefer Git commands not to use
3274         color unless enabled explicitly with some other configuration
3275         or the <code>--color</code> option. Set it to <code>always</code> if you want all
3276         output not intended for machine consumption to use color, to
3277         <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
3278         want such output to use color when written to the terminal.
3279 </p>
3280 </dd>
3281 <dt class="hdlist1">
3282 column.ui
3283 </dt>
3284 <dd>
3285 <p>
3286         Specify whether supported commands should output in columns.
3287         This variable consists of a list of tokens separated by spaces
3288         or commas:
3289 </p>
3290 <div class="paragraph"><p>These options control when the feature should be enabled
3291 (defaults to <em>never</em>):</p></div>
3292 <div class="openblock">
3293 <div class="content">
3294 <div class="dlist"><dl>
3295 <dt class="hdlist1">
3296 <code>always</code>
3297 </dt>
3298 <dd>
3299 <p>
3300         always show in columns
3301 </p>
3302 </dd>
3303 <dt class="hdlist1">
3304 <code>never</code>
3305 </dt>
3306 <dd>
3307 <p>
3308         never show in columns
3309 </p>
3310 </dd>
3311 <dt class="hdlist1">
3312 <code>auto</code>
3313 </dt>
3314 <dd>
3315 <p>
3316         show in columns if the output is to the terminal
3317 </p>
3318 </dd>
3319 </dl></div>
3320 </div></div>
3321 <div class="paragraph"><p>These options control layout (defaults to <em>column</em>).  Setting any
3322 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
3323 specified.</p></div>
3324 <div class="openblock">
3325 <div class="content">
3326 <div class="dlist"><dl>
3327 <dt class="hdlist1">
3328 <code>column</code>
3329 </dt>
3330 <dd>
3331 <p>
3332         fill columns before rows
3333 </p>
3334 </dd>
3335 <dt class="hdlist1">
3336 <code>row</code>
3337 </dt>
3338 <dd>
3339 <p>
3340         fill rows before columns
3341 </p>
3342 </dd>
3343 <dt class="hdlist1">
3344 <code>plain</code>
3345 </dt>
3346 <dd>
3347 <p>
3348         show in one column
3349 </p>
3350 </dd>
3351 </dl></div>
3352 </div></div>
3353 <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
3354 to <em>nodense</em>):</p></div>
3355 <div class="openblock">
3356 <div class="content">
3357 <div class="dlist"><dl>
3358 <dt class="hdlist1">
3359 <code>dense</code>
3360 </dt>
3361 <dd>
3362 <p>
3363         make unequal size columns to utilize more space
3364 </p>
3365 </dd>
3366 <dt class="hdlist1">
3367 <code>nodense</code>
3368 </dt>
3369 <dd>
3370 <p>
3371         make equal size columns
3372 </p>
3373 </dd>
3374 </dl></div>
3375 </div></div>
3376 </dd>
3377 <dt class="hdlist1">
3378 column.branch
3379 </dt>
3380 <dd>
3381 <p>
3382         Specify whether to output branch listing in <code>git branch</code> in columns.
3383         See <code>column.ui</code> for details.
3384 </p>
3385 </dd>
3386 <dt class="hdlist1">
3387 column.clean
3388 </dt>
3389 <dd>
3390 <p>
3391         Specify the layout when listing items in <code>git clean -i</code>, which always
3392         shows files and directories in columns. See <code>column.ui</code> for details.
3393 </p>
3394 </dd>
3395 <dt class="hdlist1">
3396 column.status
3397 </dt>
3398 <dd>
3399 <p>
3400         Specify whether to output untracked files in <code>git status</code> in columns.
3401         See <code>column.ui</code> for details.
3402 </p>
3403 </dd>
3404 <dt class="hdlist1">
3405 column.tag
3406 </dt>
3407 <dd>
3408 <p>
3409         Specify whether to output tag listings in <code>git tag</code> in columns.
3410         See <code>column.ui</code> for details.
3411 </p>
3412 </dd>
3413 <dt class="hdlist1">
3414 commit.cleanup
3415 </dt>
3416 <dd>
3417 <p>
3418         This setting overrides the default of the <code>--cleanup</code> option in
3419         <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
3420         default can be useful when you always want to keep lines that begin
3421         with the comment character <code>#</code> in your log message, in which case you
3422         would do <code>git config commit.cleanup whitespace</code> (note that you will
3423         have to remove the help lines that begin with <code>#</code> in the commit log
3424         template yourself, if you do this).
3425 </p>
3426 </dd>
3427 <dt class="hdlist1">
3428 commit.gpgSign
3429 </dt>
3430 <dd>
3431 <p>
3432         A boolean to specify whether all commits should be GPG signed.
3433         Use of this option when doing operations such as rebase can
3434         result in a large number of commits being signed. It may be
3435         convenient to use an agent to avoid typing your GPG passphrase
3436         several times.
3437 </p>
3438 </dd>
3439 <dt class="hdlist1">
3440 commit.status
3441 </dt>
3442 <dd>
3443 <p>
3444         A boolean to enable/disable inclusion of status information in the
3445         commit message template when using an editor to prepare the commit
3446         message.  Defaults to true.
3447 </p>
3448 </dd>
3449 <dt class="hdlist1">
3450 commit.template
3451 </dt>
3452 <dd>
3453 <p>
3454         Specify the pathname of a file to use as the template for
3455         new commit messages.
3456 </p>
3457 </dd>
3458 <dt class="hdlist1">
3459 commit.verbose
3460 </dt>
3461 <dd>
3462 <p>
3463         A boolean or int to specify the level of verbosity with <code>git commit</code>.
3464         See <a href="git-commit.html">git-commit(1)</a>.
3465 </p>
3466 </dd>
3467 <dt class="hdlist1">
3468 commitGraph.generationVersion
3469 </dt>
3470 <dd>
3471 <p>
3472         Specifies the type of generation number version to use when writing
3473         or reading the commit-graph file. If version 1 is specified, then
3474         the corrected commit dates will not be written or read. Defaults to
3475         2.
3476 </p>
3477 </dd>
3478 <dt class="hdlist1">
3479 commitGraph.maxNewFilters
3480 </dt>
3481 <dd>
3482 <p>
3483         Specifies the default value for the <code>--max-new-filters</code> option of <code>git
3484         commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).
3485 </p>
3486 </dd>
3487 <dt class="hdlist1">
3488 commitGraph.readChangedPaths
3489 </dt>
3490 <dd>
3491 <p>
3492         If true, then git will use the changed-path Bloom filters in the
3493         commit-graph file (if it exists, and they are present). Defaults to
3494         true. See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
3495 </p>
3496 </dd>
3497 <dt class="hdlist1">
3498 completion.commands
3499 </dt>
3500 <dd>
3501 <p>
3502         This is only used by git-completion.bash to add or remove
3503         commands from the list of completed commands. Normally only
3504         porcelain commands and a few select others are completed. You
3505         can add more commands, separated by space, in this
3506         variable. Prefixing the command with <em>-</em> will remove it from
3507         the existing list.
3508 </p>
3509 </dd>
3510 <dt class="hdlist1">
3511 core.fileMode
3512 </dt>
3513 <dd>
3514 <p>
3515         Tells Git if the executable bit of files in the working tree
3516         is to be honored.
3517 </p>
3518 <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
3519 marked as executable is checked out, or checks out a
3520 non-executable file with executable bit on.
3521 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
3522 to see if it handles the executable bit correctly
3523 and this variable is automatically set as necessary.</p></div>
3524 <div class="paragraph"><p>A repository, however, may be on a filesystem that handles
3525 the filemode correctly, and this variable is set to <em>true</em>
3526 when created, but later may be made accessible from another
3527 environment that loses the filemode (e.g. exporting ext4 via
3528 CIFS mount, visiting a Cygwin created repository with
3529 Git for Windows or Eclipse).
3530 In such a case it may be necessary to set this variable to <em>false</em>.
3531 See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
3532 <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
3533 </dd>
3534 <dt class="hdlist1">
3535 core.hideDotFiles
3536 </dt>
3537 <dd>
3538 <p>
3539         (Windows-only) If true, mark newly-created directories and files whose
3540         name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
3541         directory is hidden, but no other files starting with a dot.  The
3542         default mode is <em>dotGitOnly</em>.
3543 </p>
3544 </dd>
3545 <dt class="hdlist1">
3546 core.ignoreCase
3547 </dt>
3548 <dd>
3549 <p>
3550         Internal variable which enables various workarounds to enable
3551         Git to work better on filesystems that are not case sensitive,
3552         like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
3553         finds "makefile" when Git expects "Makefile", Git will assume
3554         it is really the same file, and continue to remember it as
3555         "Makefile".
3556 </p>
3557 <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>
3558 will probe and set core.ignoreCase true if appropriate when the repository
3559 is created.</p></div>
3560 <div class="paragraph"><p>Git relies on the proper configuration of this variable for your operating
3561 and file system. Modifying this value may result in unexpected behavior.</p></div>
3562 </dd>
3563 <dt class="hdlist1">
3564 core.precomposeUnicode
3565 </dt>
3566 <dd>
3567 <p>
3568         This option is only used by Mac OS implementation of Git.
3569         When core.precomposeUnicode=true, Git reverts the unicode decomposition
3570         of filenames done by Mac OS. This is useful when sharing a repository
3571         between Mac OS and Linux or Windows.
3572         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
3573         When false, file names are handled fully transparent by Git,
3574         which is backward compatible with older versions of Git.
3575 </p>
3576 </dd>
3577 <dt class="hdlist1">
3578 core.protectHFS
3579 </dt>
3580 <dd>
3581 <p>
3582         If set to true, do not allow checkout of paths that would
3583         be considered equivalent to <code>.git</code> on an HFS+ filesystem.
3584         Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
3585 </p>
3586 </dd>
3587 <dt class="hdlist1">
3588 core.protectNTFS
3589 </dt>
3590 <dd>
3591 <p>
3592         If set to true, do not allow checkout of paths that would
3593         cause problems with the NTFS filesystem, e.g. conflict with
3594         8.3 "short" names.
3595         Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
3596 </p>
3597 </dd>
3598 <dt class="hdlist1">
3599 core.fsmonitor
3600 </dt>
3601 <dd>
3602 <p>
3603         If set to true, enable the built-in file system monitor
3604         daemon for this working directory (<a href="git-fsmonitor&#45;&#45;daemon.html">git-fsmonitor&#45;&#45;daemon(1)</a>).
3605 </p>
3606 <div class="paragraph"><p>Like hook-based file system monitors, the built-in file system monitor
3607 can speed up Git commands that need to refresh the Git index
3608 (e.g. <code>git status</code>) in a working directory with many files.  The
3609 built-in monitor eliminates the need to install and maintain an
3610 external third-party tool.</p></div>
3611 <div class="paragraph"><p>The built-in file system monitor is currently available only on a
3612 limited set of supported platforms.  Currently, this includes Windows
3613 and MacOS.</p></div>
3614 <div class="literalblock">
3615 <div class="content">
3616 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor"
3617 hook command.</code></pre>
3618 </div></div>
3619 <div class="paragraph"><p>This hook command is used to identify all files that may have changed
3620 since the requested date/time. This information is used to speed up
3621 git by avoiding unnecessary scanning of files that have not changed.</p></div>
3622 <div class="paragraph"><p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p></div>
3623 <div class="paragraph"><p>Note that if you concurrently use multiple versions of Git, such
3624 as one version on the command line and another version in an IDE
3625 tool, that the definition of <code>core.fsmonitor</code> was extended to
3626 allow boolean values in addition to hook pathnames.  Git versions
3627 2.35.1 and prior will not understand the boolean values and will
3628 consider the "true" or "false" values as hook pathnames to be
3629 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
3630 V2 and will fall back to no fsmonitor (full scan).  Git versions
3631 prior to 2.26 default to hook protocol V1 and will silently
3632 assume there were no changes to report (no scan), so status
3633 commands may report incomplete results.  For this reason, it is
3634 best to upgrade all of your Git versions before using the built-in
3635 file system monitor.</p></div>
3636 </dd>
3637 <dt class="hdlist1">
3638 core.fsmonitorHookVersion
3639 </dt>
3640 <dd>
3641 <p>
3642         Sets the protocol version to be used when invoking the
3643         "fsmonitor" hook.
3644 </p>
3645 <div class="paragraph"><p>There are currently versions 1 and 2. When this is not set,
3646 version 2 will be tried first and if it fails then version 1
3647 will be tried. Version 1 uses a timestamp as input to determine
3648 which files have changes since that time but some monitors
3649 like Watchman have race conditions when used with a timestamp.
3650 Version 2 uses an opaque string so that the monitor can return
3651 something that can be used to determine what files have changed
3652 without race conditions.</p></div>
3653 </dd>
3654 <dt class="hdlist1">
3655 core.trustctime
3656 </dt>
3657 <dd>
3658 <p>
3659         If false, the ctime differences between the index and the
3660         working tree are ignored; useful when the inode change time
3661         is regularly modified by something outside Git (file system
3662         crawlers and some backup systems).
3663         See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
3664 </p>
3665 </dd>
3666 <dt class="hdlist1">
3667 core.splitIndex
3668 </dt>
3669 <dd>
3670 <p>
3671         If true, the split-index feature of the index will be used.
3672         See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
3673 </p>
3674 </dd>
3675 <dt class="hdlist1">
3676 core.untrackedCache
3677 </dt>
3678 <dd>
3679 <p>
3680         Determines what to do about the untracked cache feature of the
3681         index. It will be kept, if this variable is unset or set to
3682         <code>keep</code>. It will automatically be added if set to <code>true</code>. And
3683         it will automatically be removed, if set to <code>false</code>. Before
3684         setting it to <code>true</code>, you should check that mtime is working
3685         properly on your system.
3686         See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
3687         <code>feature.manyFiles</code> is enabled which sets this setting to
3688         <code>true</code> by default.
3689 </p>
3690 </dd>
3691 <dt class="hdlist1">
3692 core.checkStat
3693 </dt>
3694 <dd>
3695 <p>
3696         When missing or is set to <code>default</code>, many fields in the stat
3697         structure are checked to detect if a file has been modified
3698         since Git looked at it.  When this configuration variable is
3699         set to <code>minimal</code>, sub-second part of mtime and ctime, the
3700         uid and gid of the owner of the file, the inode number (and
3701         the device number, if Git was compiled to use it), are
3702         excluded from the check among these fields, leaving only the
3703         whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
3704         is set) and the filesize to be checked.
3705 </p>
3706 <div class="paragraph"><p>There are implementations of Git that do not leave usable values in
3707 some fields (e.g. JGit); by excluding these fields from the
3708 comparison, the <code>minimal</code> mode may help interoperability when the
3709 same repository is used by these other systems at the same time.</p></div>
3710 </dd>
3711 <dt class="hdlist1">
3712 core.quotePath
3713 </dt>
3714 <dd>
3715 <p>
3716         Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
3717         quote "unusual" characters in the pathname by enclosing the
3718         pathname in double-quotes and escaping those characters with
3719         backslashes in the same way C escapes control characters (e.g.
3720         <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
3721         values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
3722         UTF-8).  If this variable is set to false, bytes higher than
3723         0x80 are not considered "unusual" any more. Double-quotes,
3724         backslash and control characters are always escaped regardless
3725         of the setting of this variable.  A simple space character is
3726         not considered "unusual".  Many commands can output pathnames
3727         completely verbatim using the <code>-z</code> option. The default value
3728         is true.
3729 </p>
3730 </dd>
3731 <dt class="hdlist1">
3732 core.eol
3733 </dt>
3734 <dd>
3735 <p>
3736         Sets the line ending type to use in the working directory for
3737         files that are marked as text (either by having the <code>text</code>
3738         attribute set, or by having <code>text=auto</code> and Git auto-detecting
3739         the contents as text).
3740         Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
3741         native line ending.  The default value is <code>native</code>.  See
3742         <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
3743         conversion. Note that this value is ignored if <code>core.autocrlf</code>
3744         is set to <code>true</code> or <code>input</code>.
3745 </p>
3746 </dd>
3747 <dt class="hdlist1">
3748 core.safecrlf
3749 </dt>
3750 <dd>
3751 <p>
3752         If true, makes Git check if converting <code>CRLF</code> is reversible when
3753         end-of-line conversion is active.  Git will verify if a command
3754         modifies a file in the work tree either directly or indirectly.
3755         For example, committing a file followed by checking out the
3756         same file should yield the original file in the work tree.  If
3757         this is not the case for the current setting of
3758         <code>core.autocrlf</code>, Git will reject the file.  The variable can
3759         be set to "warn", in which case Git will only warn about an
3760         irreversible conversion but continue the operation.
3761 </p>
3762 <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
3763 When it is enabled, Git will convert CRLF to LF during commit and LF to
3764 CRLF during checkout.  A file that contains a mixture of LF and
3765 CRLF before the commit cannot be recreated by Git.  For text
3766 files this is the right thing to do: it corrects line endings
3767 such that we have only LF line endings in the repository.
3768 But for binary files that are accidentally classified as text the
3769 conversion can corrupt data.</p></div>
3770 <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
3771 setting the conversion type explicitly in .gitattributes.  Right
3772 after committing you still have the original file in your work
3773 tree and this file is not yet corrupted.  You can explicitly tell
3774 Git that this file is binary and Git will handle the file
3775 appropriately.</p></div>
3776 <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
3777 mixed line endings and the undesired effect of corrupting binary
3778 files cannot be distinguished.  In both cases CRLFs are removed
3779 in an irreversible way.  For text files this is the right thing
3780 to do because CRLFs are line endings, while for binary files
3781 converting CRLFs corrupts data.</p></div>
3782 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
3783 file identical to the original file for a different setting of
3784 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
3785 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
3786 and could later be checked out with <code>core.eol=crlf</code>, in which case the
3787 resulting file would contain <code>CRLF</code>, although the original file
3788 contained <code>LF</code>.  However, in both work trees the line endings would be
3789 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
3790 file with mixed line endings would be reported by the <code>core.safecrlf</code>
3791 mechanism.</p></div>
3792 </dd>
3793 <dt class="hdlist1">
3794 core.autocrlf
3795 </dt>
3796 <dd>
3797 <p>
3798         Setting this variable to "true" is the same as setting
3799         the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
3800         Set to true if you want to have <code>CRLF</code> line endings in your
3801         working directory and the repository has LF line endings.
3802         This variable can be set to <em>input</em>,
3803         in which case no output conversion is performed.
3804 </p>
3805 </dd>
3806 <dt class="hdlist1">
3807 core.checkRoundtripEncoding
3808 </dt>
3809 <dd>
3810 <p>
3811         A comma and/or whitespace separated list of encodings that Git
3812         performs UTF-8 round trip checks on if they are used in an
3813         <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
3814         The default value is <code>SHIFT-JIS</code>.
3815 </p>
3816 </dd>
3817 <dt class="hdlist1">
3818 core.symlinks
3819 </dt>
3820 <dd>
3821 <p>
3822         If false, symbolic links are checked out as small plain files that
3823         contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
3824         <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
3825         file. Useful on filesystems like FAT that do not support
3826         symbolic links.
3827 </p>
3828 <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>
3829 will probe and set core.symlinks false if appropriate when the repository
3830 is created.</p></div>
3831 </dd>
3832 <dt class="hdlist1">
3833 core.gitProxy
3834 </dt>
3835 <dd>
3836 <p>
3837         A "proxy command" to execute (as <em>command host port</em>) instead
3838         of establishing direct connection to the remote server when
3839         using the Git protocol for fetching. If the variable value is
3840         in the "COMMAND for DOMAIN" format, the command is applied only
3841         on hostnames ending with the specified domain string. This variable
3842         may be set multiple times and is matched in the given order;
3843         the first match wins.
3844 </p>
3845 <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
3846 (which always applies universally, without the special "for"
3847 handling).</p></div>
3848 <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
3849 specify that no proxy be used for a given domain pattern.
3850 This is useful for excluding servers inside a firewall from
3851 proxy use, while defaulting to a common proxy for external domains.</p></div>
3852 </dd>
3853 <dt class="hdlist1">
3854 core.sshCommand
3855 </dt>
3856 <dd>
3857 <p>
3858         If this variable is set, <code>git fetch</code> and <code>git push</code> will
3859         use the specified command instead of <code>ssh</code> when they need to
3860         connect to a remote system. The command is in the same form as
3861         the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
3862         when the environment variable is set.
3863 </p>
3864 </dd>
3865 <dt class="hdlist1">
3866 core.ignoreStat
3867 </dt>
3868 <dd>
3869 <p>
3870         If true, Git will avoid using lstat() calls to detect if files have
3871         changed by setting the "assume-unchanged" bit for those tracked files
3872         which it has updated identically in both the index and working tree.
3873 </p>
3874 <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
3875 the modified files explicitly (e.g. see <em>Examples</em> section in
3876 <a href="git-update-index.html">git-update-index(1)</a>).
3877 Git will not normally detect changes to those files.</p></div>
3878 <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
3879 CIFS/Microsoft Windows.</p></div>
3880 <div class="paragraph"><p>False by default.</p></div>
3881 </dd>
3882 <dt class="hdlist1">
3883 core.preferSymlinkRefs
3884 </dt>
3885 <dd>
3886 <p>
3887         Instead of the default "symref" format for HEAD
3888         and other symbolic reference files, use symbolic links.
3889         This is sometimes needed to work with old scripts that
3890         expect HEAD to be a symbolic link.
3891 </p>
3892 </dd>
3893 <dt class="hdlist1">
3894 core.alternateRefsCommand
3895 </dt>
3896 <dd>
3897 <p>
3898         When advertising tips of available history from an alternate, use the shell to
3899         execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
3900         first argument is the absolute path of the alternate. Output must contain one
3901         hex object id per line (i.e., the same as produced by <code>git for-each-ref
3902         --format='%(objectname)'</code>).
3903 </p>
3904 <div class="paragraph"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
3905 value, as it does not take a repository path as an argument (but you can wrap
3906 the command above in a shell script).</p></div>
3907 </dd>
3908 <dt class="hdlist1">
3909 core.alternateRefsPrefixes
3910 </dt>
3911 <dd>
3912 <p>
3913         When listing references from an alternate, list only references that begin
3914         with the given prefix. Prefixes match as if they were given as arguments to
3915         <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
3916         whitespace. If <code>core.alternateRefsCommand</code> is set, setting
3917         <code>core.alternateRefsPrefixes</code> has no effect.
3918 </p>
3919 </dd>
3920 <dt class="hdlist1">
3921 core.bare
3922 </dt>
3923 <dd>
3924 <p>
3925         If true this repository is assumed to be <em>bare</em> and has no
3926         working directory associated with it.  If this is the case a
3927         number of commands that require a working directory will be
3928         disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
3929 </p>
3930 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
3931 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
3932 repository that ends in "/.git" is assumed to be not bare (bare =
3933 false), while all other repositories are assumed to be bare (bare
3934 = true).</p></div>
3935 </dd>
3936 <dt class="hdlist1">
3937 core.worktree
3938 </dt>
3939 <dd>
3940 <p>
3941         Set the path to the root of the working tree.
3942         If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
3943         is ignored and not used for determining the root of working tree.
3944         This can be overridden by the <code>GIT_WORK_TREE</code> environment
3945         variable and the <code>--work-tree</code> command-line option.
3946         The value can be an absolute path or relative to the path to
3947         the .git directory, which is either specified by --git-dir
3948         or GIT_DIR, or automatically discovered.
3949         If --git-dir or GIT_DIR is specified but none of
3950         --work-tree, GIT_WORK_TREE and core.worktree is specified,
3951         the current working directory is regarded as the top level
3952         of your working tree.
3953 </p>
3954 <div class="paragraph"><p>Note that this variable is honored even when set in a configuration
3955 file in a ".git" subdirectory of a directory and its value differs
3956 from the latter directory (e.g. "/path/to/.git/config" has
3957 core.worktree set to "/different/path"), which is most likely a
3958 misconfiguration.  Running Git commands in the "/path/to" directory will
3959 still use "/different/path" as the root of the work tree and can cause
3960 confusion unless you know what you are doing (e.g. you are creating a
3961 read-only snapshot of the same index to a location different from the
3962 repository&#8217;s usual working tree).</p></div>
3963 </dd>
3964 <dt class="hdlist1">
3965 core.logAllRefUpdates
3966 </dt>
3967 <dd>
3968 <p>
3969         Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
3970         "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
3971         SHA-1, the date/time and the reason of the update, but
3972         only when the file exists.  If this configuration
3973         variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
3974         file is automatically created for branch heads (i.e. under
3975         <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
3976         note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
3977         If it is set to <code>always</code>, then a missing reflog is automatically
3978         created for any ref under <code>refs/</code>.
3979 </p>
3980 <div class="paragraph"><p>This information can be used to determine what commit
3981 was the tip of a branch "2 days ago".</p></div>
3982 <div class="paragraph"><p>This value is true by default in a repository that has
3983 a working directory associated with it, and false by
3984 default in a bare repository.</p></div>
3985 </dd>
3986 <dt class="hdlist1">
3987 core.repositoryFormatVersion
3988 </dt>
3989 <dd>
3990 <p>
3991         Internal variable identifying the repository format and layout
3992         version.
3993 </p>
3994 </dd>
3995 <dt class="hdlist1">
3996 core.sharedRepository
3997 </dt>
3998 <dd>
3999 <p>
4000         When <em>group</em> (or <em>true</em>), the repository is made shareable between
4001         several users in a group (making sure all the files and objects are
4002         group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
4003         repository will be readable by all users, additionally to being
4004         group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
4005         reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
4006         files in the repository will have this mode value. <em>0xxx</em> will override
4007         user&#8217;s umask value (whereas the other options will only override
4008         requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
4009         the repo read/write-able for the owner and group, but inaccessible to
4010         others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
4011         repository that is group-readable but not group-writable.
4012         See <a href="git-init.html">git-init(1)</a>. False by default.
4013 </p>
4014 </dd>
4015 <dt class="hdlist1">
4016 core.warnAmbiguousRefs
4017 </dt>
4018 <dd>
4019 <p>
4020         If true, Git will warn you if the ref name you passed it is ambiguous
4021         and might match multiple refs in the repository. True by default.
4022 </p>
4023 </dd>
4024 <dt class="hdlist1">
4025 core.compression
4026 </dt>
4027 <dd>
4028 <p>
4029         An integer -1..9, indicating a default compression level.
4030         -1 is the zlib default. 0 means no compression,
4031         and 1..9 are various speed/size tradeoffs, 9 being slowest.
4032         If set, this provides a default to other compression variables,
4033         such as <code>core.looseCompression</code> and <code>pack.compression</code>.
4034 </p>
4035 </dd>
4036 <dt class="hdlist1">
4037 core.looseCompression
4038 </dt>
4039 <dd>
4040 <p>
4041         An integer -1..9, indicating the compression level for objects that
4042         are not in a pack file. -1 is the zlib default. 0 means no
4043         compression, and 1..9 are various speed/size tradeoffs, 9 being
4044         slowest.  If not set,  defaults to core.compression.  If that is
4045         not set,  defaults to 1 (best speed).
4046 </p>
4047 </dd>
4048 <dt class="hdlist1">
4049 core.packedGitWindowSize
4050 </dt>
4051 <dd>
4052 <p>
4053         Number of bytes of a pack file to map into memory in a
4054         single mapping operation.  Larger window sizes may allow
4055         your system to process a smaller number of large pack files
4056         more quickly.  Smaller window sizes will negatively affect
4057         performance due to increased calls to the operating system&#8217;s
4058         memory manager, but may improve performance when accessing
4059         a large number of large pack files.
4060 </p>
4061 <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
4062 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
4063 be reasonable for all users/operating systems.  You probably do
4064 not need to adjust this value.</p></div>
4065 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4066 </dd>
4067 <dt class="hdlist1">
4068 core.packedGitLimit
4069 </dt>
4070 <dd>
4071 <p>
4072         Maximum number of bytes to map simultaneously into memory
4073         from pack files.  If Git needs to access more than this many
4074         bytes at once to complete an operation it will unmap existing
4075         regions to reclaim virtual address space within the process.
4076 </p>
4077 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
4078 unlimited) on 64 bit platforms.
4079 This should be reasonable for all users/operating systems, except on
4080 the largest projects.  You probably do not need to adjust this value.</p></div>
4081 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4082 </dd>
4083 <dt class="hdlist1">
4084 core.deltaBaseCacheLimit
4085 </dt>
4086 <dd>
4087 <p>
4088         Maximum number of bytes per thread to reserve for caching base objects
4089         that may be referenced by multiple deltified objects.  By storing the
4090         entire decompressed base objects in a cache Git is able
4091         to avoid unpacking and decompressing frequently used base
4092         objects multiple times.
4093 </p>
4094 <div class="paragraph"><p>Default is 96 MiB on all platforms.  This should be reasonable
4095 for all users/operating systems, except on the largest projects.
4096 You probably do not need to adjust this value.</p></div>
4097 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4098 </dd>
4099 <dt class="hdlist1">
4100 core.bigFileThreshold
4101 </dt>
4102 <dd>
4103 <p>
4104         The size of files considered "big", which as discussed below
4105         changes the behavior of numerous git commands, as well as how
4106         such files are stored within the repository. The default is
4107         512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
4108         supported.
4109 </p>
4110 <div class="paragraph"><p>Files above the configured limit will be:</p></div>
4111 <div class="ulist"><ul>
4112 <li>
4113 <p>
4114 Stored deflated in packfiles, without attempting delta compression.
4115 </p>
4116 <div class="paragraph"><p>The default limit is primarily set with this use-case in mind. With it,
4117 most projects will have their source code and other text files delta
4118 compressed, but not larger binary media files.</p></div>
4119 <div class="paragraph"><p>Storing large files without delta compression avoids excessive memory
4120 usage, at the slight expense of increased disk usage.</p></div>
4121 </li>
4122 <li>
4123 <p>
4124 Will be treated as if they were labeled "binary" (see
4125   <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
4126   <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.
4127 </p>
4128 </li>
4129 <li>
4130 <p>
4131 Will generally be streamed when written, which avoids excessive
4132 memory usage, at the cost of some fixed overhead. Commands that make
4133 use of this include <a href="git-archive.html">git-archive(1)</a>,
4134 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
4135 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.
4136 </p>
4137 </li>
4138 </ul></div>
4139 </dd>
4140 <dt class="hdlist1">
4141 core.excludesFile
4142 </dt>
4143 <dd>
4144 <p>
4145         Specifies the pathname to the file that contains patterns to
4146         describe paths that are not meant to be tracked, in addition
4147         to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
4148         Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
4149         If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
4150         is used instead. See <a href="gitignore.html">gitignore(5)</a>.
4151 </p>
4152 </dd>
4153 <dt class="hdlist1">
4154 core.askPass
4155 </dt>
4156 <dd>
4157 <p>
4158         Some commands (e.g. svn and http interfaces) that interactively
4159         ask for a password can be told to use an external program given
4160         via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
4161         environment variable. If not set, fall back to the value of the
4162         <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
4163         prompt. The external program shall be given a suitable prompt as
4164         command-line argument and write the password on its STDOUT.
4165 </p>
4166 </dd>
4167 <dt class="hdlist1">
4168 core.attributesFile
4169 </dt>
4170 <dd>
4171 <p>
4172         In addition to <code>.gitattributes</code> (per-directory) and
4173         <code>.git/info/attributes</code>, Git looks into this file for attributes
4174         (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
4175         way as for <code>core.excludesFile</code>. Its default value is
4176         <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
4177         set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
4178 </p>
4179 </dd>
4180 <dt class="hdlist1">
4181 core.hooksPath
4182 </dt>
4183 <dd>
4184 <p>
4185         By default Git will look for your hooks in the
4186         <code>$GIT_DIR/hooks</code> directory. Set this to different path,
4187         e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
4188         that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
4189         in <code>$GIT_DIR/hooks/pre-receive</code>.
4190 </p>
4191 <div class="paragraph"><p>The path can be either absolute or relative. A relative path is
4192 taken as relative to the directory where the hooks are run (see
4193 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
4194 <div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
4195 centrally configure your Git hooks instead of configuring them on a
4196 per-repository basis, or as a more flexible and centralized
4197 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
4198 default hooks.</p></div>
4199 </dd>
4200 <dt class="hdlist1">
4201 core.editor
4202 </dt>
4203 <dd>
4204 <p>
4205         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4206         messages by launching an editor use the value of this
4207         variable when it is set, and the environment variable
4208         <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.
4209 </p>
4210 </dd>
4211 <dt class="hdlist1">
4212 core.commentChar
4213 </dt>
4214 <dd>
4215 <p>
4216         Commands such as <code>commit</code> and <code>tag</code> that let you edit
4217         messages consider a line that begins with this ASCII character
4218         commented, and removes them after the editor returns
4219         (default <em>#</em>).
4220 </p>
4221 <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
4222 the beginning character of any line in existing commit messages.</p></div>
4223 </dd>
4224 <dt class="hdlist1">
4225 core.filesRefLockTimeout
4226 </dt>
4227 <dd>
4228 <p>
4229         The length of time, in milliseconds, to retry when trying to
4230         lock an individual reference. Value 0 means not to retry at
4231         all; -1 means to try indefinitely. Default is 100 (i.e.,
4232         retry for 100ms).
4233 </p>
4234 </dd>
4235 <dt class="hdlist1">
4236 core.packedRefsTimeout
4237 </dt>
4238 <dd>
4239 <p>
4240         The length of time, in milliseconds, to retry when trying to
4241         lock the <code>packed-refs</code> file. Value 0 means not to retry at
4242         all; -1 means to try indefinitely. Default is 1000 (i.e.,
4243         retry for 1 second).
4244 </p>
4245 </dd>
4246 <dt class="hdlist1">
4247 core.pager
4248 </dt>
4249 <dd>
4250 <p>
4251         Text viewer for use by Git commands (e.g., <em>less</em>).  The value
4252         is meant to be interpreted by the shell.  The order of preference
4253         is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
4254         configuration, then <code>$PAGER</code>, and then the default chosen at
4255         compile time (usually <em>less</em>).
4256 </p>
4257 <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
4258 (if <code>LESS</code> environment variable is set, Git does not change it at
4259 all).  If you want to selectively override Git&#8217;s default setting
4260 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
4261 be passed to the shell by Git, which will translate the final
4262 command to <code>LESS=FRX less -S</code>. The environment does not set the
4263 <code>S</code> option but the command line does, instructing less to truncate
4264 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
4265 deactivate the <code>F</code> option specified by the environment from the
4266 command-line, deactivating the "quit if one screen" behavior of
4267 <code>less</code>.  One can specifically activate some flags for particular
4268 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
4269 line truncation only for <code>git blame</code>.</p></div>
4270 <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
4271 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
4272 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
4273 </dd>
4274 <dt class="hdlist1">
4275 core.whitespace
4276 </dt>
4277 <dd>
4278 <p>
4279         A comma separated list of common whitespace problems to
4280         notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
4281         highlight them, and <em>git apply --whitespace=error</em> will
4282         consider them as errors.  You can prefix <code>-</code> to disable
4283         any of them (e.g. <code>-trailing-space</code>):
4284 </p>
4285 <div class="ulist"><ul>
4286 <li>
4287 <p>
4288 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
4289   as an error (enabled by default).
4290 </p>
4291 </li>
4292 <li>
4293 <p>
4294 <code>space-before-tab</code> treats a space character that appears immediately
4295   before a tab character in the initial indent part of the line as an
4296   error (enabled by default).
4297 </p>
4298 </li>
4299 <li>
4300 <p>
4301 <code>indent-with-non-tab</code> treats a line that is indented with space
4302   characters instead of the equivalent tabs as an error (not enabled by
4303   default).
4304 </p>
4305 </li>
4306 <li>
4307 <p>
4308 <code>tab-in-indent</code> treats a tab character in the initial indent part of
4309   the line as an error (not enabled by default).
4310 </p>
4311 </li>
4312 <li>
4313 <p>
4314 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
4315   (enabled by default).
4316 </p>
4317 </li>
4318 <li>
4319 <p>
4320 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
4321   <code>blank-at-eof</code>.
4322 </p>
4323 </li>
4324 <li>
4325 <p>
4326 <code>cr-at-eol</code> treats a carriage-return at the end of line as
4327   part of the line terminator, i.e. with it, <code>trailing-space</code>
4328   does not trigger if the character before such a carriage-return
4329   is not a whitespace (not enabled by default).
4330 </p>
4331 </li>
4332 <li>
4333 <p>
4334 <code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
4335   is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
4336   errors. The default tab width is 8. Allowed values are 1 to 63.
4337 </p>
4338 </li>
4339 </ul></div>
4340 </dd>
4341 <dt class="hdlist1">
4342 core.fsync
4343 </dt>
4344 <dd>
4345 <p>
4346         A comma-separated list of components of the repository that
4347         should be hardened via the core.fsyncMethod when created or
4348         modified.  You can disable hardening of any component by
4349         prefixing it with a <em>-</em>.  Items that are not hardened may be
4350         lost in the event of an unclean system shutdown. Unless you
4351         have special requirements, it is recommended that you leave
4352         this option empty or pick one of <code>committed</code>, <code>added</code>,
4353         or <code>all</code>.
4354 </p>
4355 <div class="paragraph"><p>When this configuration is encountered, the set of components starts with
4356 the platform default value, disabled components are removed, and additional
4357 components are added. <code>none</code> resets the state so that the platform default
4358 is ignored.</p></div>
4359 <div class="paragraph"><p>The empty string resets the fsync configuration to the platform
4360 default. The default on most platforms is equivalent to
4361 <code>core.fsync=committed,-loose-object</code>, which has good performance,
4362 but risks losing recent work in the event of an unclean system shutdown.</p></div>
4363 <div class="ulist"><ul>
4364 <li>
4365 <p>
4366 <code>none</code> clears the set of fsynced components.
4367 </p>
4368 </li>
4369 <li>
4370 <p>
4371 <code>loose-object</code> hardens objects added to the repo in loose-object form.
4372 </p>
4373 </li>
4374 <li>
4375 <p>
4376 <code>pack</code> hardens objects added to the repo in packfile form.
4377 </p>
4378 </li>
4379 <li>
4380 <p>
4381 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
4382 </p>
4383 </li>
4384 <li>
4385 <p>
4386 <code>commit-graph</code> hardens the commit-graph file.
4387 </p>
4388 </li>
4389 <li>
4390 <p>
4391 <code>index</code> hardens the index when it is modified.
4392 </p>
4393 </li>
4394 <li>
4395 <p>
4396 <code>objects</code> is an aggregate option that is equivalent to
4397   <code>loose-object,pack</code>.
4398 </p>
4399 </li>
4400 <li>
4401 <p>
4402 <code>reference</code> hardens references modified in the repo.
4403 </p>
4404 </li>
4405 <li>
4406 <p>
4407 <code>derived-metadata</code> is an aggregate option that is equivalent to
4408   <code>pack-metadata,commit-graph</code>.
4409 </p>
4410 </li>
4411 <li>
4412 <p>
4413 <code>committed</code> is an aggregate option that is currently equivalent to
4414   <code>objects</code>. This mode sacrifices some performance to ensure that work
4415   that is committed to the repository with <code>git commit</code> or similar commands
4416   is hardened.
4417 </p>
4418 </li>
4419 <li>
4420 <p>
4421 <code>added</code> is an aggregate option that is currently equivalent to
4422   <code>committed,index</code>. This mode sacrifices additional performance to
4423   ensure that the results of commands like <code>git add</code> and similar operations
4424   are hardened.
4425 </p>
4426 </li>
4427 <li>
4428 <p>
4429 <code>all</code> is an aggregate option that syncs all individual components above.
4430 </p>
4431 </li>
4432 </ul></div>
4433 </dd>
4434 <dt class="hdlist1">
4435 core.fsyncMethod
4436 </dt>
4437 <dd>
4438 <p>
4439         A value indicating the strategy Git will use to harden repository data
4440         using fsync and related primitives.
4441 </p>
4442 <div class="ulist"><ul>
4443 <li>
4444 <p>
4445 <code>fsync</code> uses the fsync() system call or platform equivalents.
4446 </p>
4447 </li>
4448 <li>
4449 <p>
4450 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
4451   filesystem and storage hardware, data added to the repository may not be
4452   durable in the event of a system crash. This is the default mode on macOS.
4453 </p>
4454 </li>
4455 <li>
4456 <p>
4457 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
4458   updates in the disk writeback cache and then does a single full fsync of
4459   a dummy file to trigger the disk cache flush at the end of the operation.
4460 </p>
4461 <div class="paragraph"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
4462 data is made durable as if <code>fsync</code> was specified. This mode is expected to
4463 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
4464 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
4465 </li>
4466 </ul></div>
4467 </dd>
4468 <dt class="hdlist1">
4469 core.fsyncObjectFiles
4470 </dt>
4471 <dd>
4472 <p>
4473         This boolean will enable <em>fsync()</em> when writing object files.
4474         This setting is deprecated. Use core.fsync instead.
4475 </p>
4476 <div class="paragraph"><p>This setting affects data added to the Git repository in loose-object
4477 form. When set to true, Git will issue an fsync or similar system call
4478 to flush caches so that loose-objects remain consistent in the face
4479 of a unclean system shutdown.</p></div>
4480 </dd>
4481 <dt class="hdlist1">
4482 core.preloadIndex
4483 </dt>
4484 <dd>
4485 <p>
4486         Enable parallel index preload for operations like <em>git diff</em>
4487 </p>
4488 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
4489 on filesystems like NFS that have weak caching semantics and thus
4490 relatively high IO latencies.  When enabled, Git will do the
4491 index comparison to the filesystem data in parallel, allowing
4492 overlapping IO&#8217;s.  Defaults to true.</p></div>
4493 </dd>
4494 <dt class="hdlist1">
4495 core.unsetenvvars
4496 </dt>
4497 <dd>
4498 <p>
4499         Windows-only: comma-separated list of environment variables'
4500         names that need to be unset before spawning any other process.
4501         Defaults to <code>PERL5LIB</code> to account for the fact that Git for
4502         Windows insists on using its own Perl interpreter.
4503 </p>
4504 </dd>
4505 <dt class="hdlist1">
4506 core.restrictinheritedhandles
4507 </dt>
4508 <dd>
4509 <p>
4510         Windows-only: override whether spawned processes inherit only standard
4511         file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
4512         <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
4513         Windows 7 and later, and <code>false</code> on older Windows versions.
4514 </p>
4515 </dd>
4516 <dt class="hdlist1">
4517 core.createObject
4518 </dt>
4519 <dd>
4520 <p>
4521         You can set this to <em>link</em>, in which case a hardlink followed by
4522         a delete of the source are used to make sure that object creation
4523         will not overwrite existing objects.
4524 </p>
4525 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
4526 Set this config setting to <em>rename</em> there; However, This will remove the
4527 check that makes sure that existing object files will not get overwritten.</p></div>
4528 </dd>
4529 <dt class="hdlist1">
4530 core.notesRef
4531 </dt>
4532 <dd>
4533 <p>
4534         When showing commit messages, also show notes which are stored in
4535         the given ref.  The ref must be fully qualified.  If the given
4536         ref does not exist, it is not an error but means that no
4537         notes should be printed.
4538 </p>
4539 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
4540 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p></div>
4541 </dd>
4542 <dt class="hdlist1">
4543 core.commitGraph
4544 </dt>
4545 <dd>
4546 <p>
4547         If true, then git will read the commit-graph file (if it exists)
4548         to parse the graph structure of commits. Defaults to true. See
4549         <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
4550 </p>
4551 </dd>
4552 <dt class="hdlist1">
4553 core.useReplaceRefs
4554 </dt>
4555 <dd>
4556 <p>
4557         If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
4558         option was given on the command line. See <a href="git.html">git(1)</a> and
4559         <a href="git-replace.html">git-replace(1)</a> for more information.
4560 </p>
4561 </dd>
4562 <dt class="hdlist1">
4563 core.multiPackIndex
4564 </dt>
4565 <dd>
4566 <p>
4567         Use the multi-pack-index file to track multiple packfiles using a
4568         single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
4569         information. Defaults to true.
4570 </p>
4571 </dd>
4572 <dt class="hdlist1">
4573 core.sparseCheckout
4574 </dt>
4575 <dd>
4576 <p>
4577         Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
4578         for more information.
4579 </p>
4580 </dd>
4581 <dt class="hdlist1">
4582 core.sparseCheckoutCone
4583 </dt>
4584 <dd>
4585 <p>
4586         Enables the "cone mode" of the sparse checkout feature. When the
4587         sparse-checkout file contains a limited set of patterns, this
4588         mode provides significant performance advantages. The "non-cone
4589         mode" can be requested to allow specifying more flexible
4590         patterns by setting this variable to <em>false</em>. See
4591         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.
4592 </p>
4593 </dd>
4594 <dt class="hdlist1">
4595 core.abbrev
4596 </dt>
4597 <dd>
4598 <p>
4599         Set the length object names are abbreviated to.  If
4600         unspecified or set to "auto", an appropriate value is
4601         computed based on the approximate number of packed objects
4602         in your repository, which hopefully is enough for
4603         abbreviated object names to stay unique for some time.
4604         If set to "no", no abbreviation is made and the object names
4605         are shown in their full length.
4606         The minimum length is 4.
4607 </p>
4608 </dd>
4609 <dt class="hdlist1">
4610 core.maxTreeDepth
4611 </dt>
4612 <dd>
4613 <p>
4614         The maximum depth Git is willing to recurse while traversing a
4615         tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
4616         to allow Git to abort cleanly, and should not generally need to
4617         be adjusted. The default is 4096.
4618 </p>
4619 </dd>
4620 <dt class="hdlist1">
4621 credential.helper
4622 </dt>
4623 <dd>
4624 <p>
4625         Specify an external helper to be called when a username or
4626         password credential is needed; the helper may consult external
4627         storage to avoid prompting the user for the credentials. This is
4628         normally the name of a credential helper with possible
4629         arguments, but may also be an absolute path with arguments or, if
4630         preceded by <code>!</code>, shell commands.
4631 </p>
4632 <div class="paragraph"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
4633 for details and examples.</p></div>
4634 </dd>
4635 <dt class="hdlist1">
4636 credential.useHttpPath
4637 </dt>
4638 <dd>
4639 <p>
4640         When acquiring credentials, consider the "path" component of an http
4641         or https URL to be important. Defaults to false. See
4642         <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
4643 </p>
4644 </dd>
4645 <dt class="hdlist1">
4646 credential.username
4647 </dt>
4648 <dd>
4649 <p>
4650         If no username is set for a network authentication, use this username
4651         by default. See credential.&lt;context&gt;.* below, and
4652         <a href="gitcredentials.html">gitcredentials(7)</a>.
4653 </p>
4654 </dd>
4655 <dt class="hdlist1">
4656 credential.&lt;url&gt;.*
4657 </dt>
4658 <dd>
4659 <p>
4660         Any of the credential.* options above can be applied selectively to
4661         some credentials. For example, "credential.https://example.com.username"
4662         would set the default username only for https connections to
4663         example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
4664         matched.
4665 </p>
4666 </dd>
4667 <dt class="hdlist1">
4668 credentialCache.ignoreSIGHUP
4669 </dt>
4670 <dd>
4671 <p>
4672         Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
4673 </p>
4674 </dd>
4675 <dt class="hdlist1">
4676 credentialStore.lockTimeoutMS
4677 </dt>
4678 <dd>
4679 <p>
4680         The length of time, in milliseconds, for git-credential-store to retry
4681         when trying to lock the credentials file. A value of 0 means not to retry at
4682         all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
4683         1s).
4684 </p>
4685 </dd>
4686 <dt class="hdlist1">
4687 diff.autoRefreshIndex
4688 </dt>
4689 <dd>
4690 <p>
4691         When using <em>git diff</em> to compare with work tree
4692         files, do not consider stat-only changes as changed.
4693         Instead, silently run <code>git update-index --refresh</code> to
4694         update the cached stat information for paths whose
4695         contents in the work tree match the contents in the
4696         index.  This option defaults to true.  Note that this
4697         affects only <em>git diff</em> Porcelain, and not lower level
4698         <em>diff</em> commands such as <em>git diff-files</em>.
4699 </p>
4700 </dd>
4701 <dt class="hdlist1">
4702 diff.dirstat
4703 </dt>
4704 <dd>
4705 <p>
4706         A comma separated list of <code>--dirstat</code> parameters specifying the
4707         default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
4708         and friends. The defaults can be overridden on the command line
4709         (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
4710         (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
4711         The following parameters are available:
4712 </p>
4713 <div class="openblock">
4714 <div class="content">
4715 <div class="dlist"><dl>
4716 <dt class="hdlist1">
4717 <code>changes</code>
4718 </dt>
4719 <dd>
4720 <p>
4721         Compute the dirstat numbers by counting the lines that have been
4722         removed from the source, or added to the destination. This ignores
4723         the amount of pure code movements within a file.  In other words,
4724         rearranging lines in a file is not counted as much as other changes.
4725         This is the default behavior when no parameter is given.
4726 </p>
4727 </dd>
4728 <dt class="hdlist1">
4729 <code>lines</code>
4730 </dt>
4731 <dd>
4732 <p>
4733         Compute the dirstat numbers by doing the regular line-based diff
4734         analysis, and summing the removed/added line counts. (For binary
4735         files, count 64-byte chunks instead, since binary files have no
4736         natural concept of lines). This is a more expensive <code>--dirstat</code>
4737         behavior than the <code>changes</code> behavior, but it does count rearranged
4738         lines within a file as much as other changes. The resulting output
4739         is consistent with what you get from the other <code>--*stat</code> options.
4740 </p>
4741 </dd>
4742 <dt class="hdlist1">
4743 <code>files</code>
4744 </dt>
4745 <dd>
4746 <p>
4747         Compute the dirstat numbers by counting the number of files changed.
4748         Each changed file counts equally in the dirstat analysis. This is
4749         the computationally cheapest <code>--dirstat</code> behavior, since it does
4750         not have to look at the file contents at all.
4751 </p>
4752 </dd>
4753 <dt class="hdlist1">
4754 <code>cumulative</code>
4755 </dt>
4756 <dd>
4757 <p>
4758         Count changes in a child directory for the parent directory as well.
4759         Note that when using <code>cumulative</code>, the sum of the percentages
4760         reported may exceed 100%. The default (non-cumulative) behavior can
4761         be specified with the <code>noncumulative</code> parameter.
4762 </p>
4763 </dd>
4764 <dt class="hdlist1">
4765 &lt;limit&gt;
4766 </dt>
4767 <dd>
4768 <p>
4769         An integer parameter specifies a cut-off percent (3% by default).
4770         Directories contributing less than this percentage of the changes
4771         are not shown in the output.
4772 </p>
4773 </dd>
4774 </dl></div>
4775 </div></div>
4776 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
4777 directories with less than 10% of the total amount of changed files,
4778 and accumulating child directory counts in the parent directories:
4779 <code>files,10,cumulative</code>.</p></div>
4780 </dd>
4781 <dt class="hdlist1">
4782 diff.statNameWidth
4783 </dt>
4784 <dd>
4785 <p>
4786         Limit the width of the filename part in --stat output. If set, applies
4787         to all commands generating --stat output except format-patch.
4788 </p>
4789 </dd>
4790 <dt class="hdlist1">
4791 diff.statGraphWidth
4792 </dt>
4793 <dd>
4794 <p>
4795         Limit the width of the graph part in --stat output. If set, applies
4796         to all commands generating --stat output except format-patch.
4797 </p>
4798 </dd>
4799 <dt class="hdlist1">
4800 diff.context
4801 </dt>
4802 <dd>
4803 <p>
4804         Generate diffs with &lt;n&gt; lines of context instead of the default
4805         of 3. This value is overridden by the -U option.
4806 </p>
4807 </dd>
4808 <dt class="hdlist1">
4809 diff.interHunkContext
4810 </dt>
4811 <dd>
4812 <p>
4813         Show the context between diff hunks, up to the specified number
4814         of lines, thereby fusing the hunks that are close to each other.
4815         This value serves as the default for the <code>--inter-hunk-context</code>
4816         command line option.
4817 </p>
4818 </dd>
4819 <dt class="hdlist1">
4820 diff.external
4821 </dt>
4822 <dd>
4823 <p>
4824         If this config variable is set, diff generation is not
4825         performed using the internal diff machinery, but using the
4826         given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
4827         environment variable.  The command is called with parameters
4828         as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
4829         you want to use an external diff program only on a subset of
4830         your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
4831 </p>
4832 </dd>
4833 <dt class="hdlist1">
4834 diff.ignoreSubmodules
4835 </dt>
4836 <dd>
4837 <p>
4838         Sets the default value of --ignore-submodules. Note that this
4839         affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
4840         commands such as <em>git diff-files</em>. <em>git checkout</em>
4841         and <em>git switch</em> also honor
4842         this setting when reporting uncommitted changes. Setting it to
4843         <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
4844         and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
4845         overridden by using the --ignore-submodules command-line option.
4846         The <em>git submodule</em> commands are not affected by this setting.
4847         By default this is set to untracked so that any untracked
4848         submodules are ignored.
4849 </p>
4850 </dd>
4851 <dt class="hdlist1">
4852 diff.mnemonicPrefix
4853 </dt>
4854 <dd>
4855 <p>
4856         If set, <em>git diff</em> uses a prefix pair that is different from the
4857         standard "a/" and "b/" depending on what is being compared.  When
4858         this configuration is in effect, reverse diff output also swaps
4859         the order of the prefixes:
4860 </p>
4861 <div class="dlist"><dl>
4862 <dt class="hdlist1">
4863 <code>git diff</code>
4864 </dt>
4865 <dd>
4866 <p>
4867         compares the (i)ndex and the (w)ork tree;
4868 </p>
4869 </dd>
4870 <dt class="hdlist1">
4871 <code>git diff HEAD</code>
4872 </dt>
4873 <dd>
4874 <p>
4875          compares a (c)ommit and the (w)ork tree;
4876 </p>
4877 </dd>
4878 <dt class="hdlist1">
4879 <code>git diff --cached</code>
4880 </dt>
4881 <dd>
4882 <p>
4883         compares a (c)ommit and the (i)ndex;
4884 </p>
4885 </dd>
4886 <dt class="hdlist1">
4887 <code>git diff HEAD:file1 file2</code>
4888 </dt>
4889 <dd>
4890 <p>
4891         compares an (o)bject and a (w)ork tree entity;
4892 </p>
4893 </dd>
4894 <dt class="hdlist1">
4895 <code>git diff --no-index a b</code>
4896 </dt>
4897 <dd>
4898 <p>
4899         compares two non-git things (1) and (2).
4900 </p>
4901 </dd>
4902 </dl></div>
4903 </dd>
4904 <dt class="hdlist1">
4905 diff.noprefix
4906 </dt>
4907 <dd>
4908 <p>
4909         If set, <em>git diff</em> does not show any source or destination prefix.
4910 </p>
4911 </dd>
4912 <dt class="hdlist1">
4913 diff.relative
4914 </dt>
4915 <dd>
4916 <p>
4917         If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
4918         and show pathnames relative to the current directory.
4919 </p>
4920 </dd>
4921 <dt class="hdlist1">
4922 diff.orderFile
4923 </dt>
4924 <dd>
4925 <p>
4926         File indicating how to order files within a diff.
4927         See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
4928         If <code>diff.orderFile</code> is a relative pathname, it is treated as
4929         relative to the top of the working tree.
4930 </p>
4931 </dd>
4932 <dt class="hdlist1">
4933 diff.renameLimit
4934 </dt>
4935 <dd>
4936 <p>
4937         The number of files to consider in the exhaustive portion of
4938         copy/rename detection; equivalent to the <em>git diff</em> option
4939         <code>-l</code>.  If not set, the default value is currently 1000.  This
4940         setting has no effect if rename detection is turned off.
4941 </p>
4942 </dd>
4943 <dt class="hdlist1">
4944 diff.renames
4945 </dt>
4946 <dd>
4947 <p>
4948         Whether and how Git detects renames.  If set to "false",
4949         rename detection is disabled. If set to "true", basic rename
4950         detection is enabled.  If set to "copies" or "copy", Git will
4951         detect copies, as well.  Defaults to true.  Note that this
4952         affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
4953         <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
4954         <a href="git-diff-files.html">git-diff-files(1)</a>.
4955 </p>
4956 </dd>
4957 <dt class="hdlist1">
4958 diff.suppressBlankEmpty
4959 </dt>
4960 <dd>
4961 <p>
4962         A boolean to inhibit the standard behavior of printing a space
4963         before each empty output line. Defaults to false.
4964 </p>
4965 </dd>
4966 <dt class="hdlist1">
4967 diff.submodule
4968 </dt>
4969 <dd>
4970 <p>
4971         Specify the format in which differences in submodules are
4972         shown.  The "short" format just shows the names of the commits
4973         at the beginning and end of the range. The "log" format lists
4974         the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
4975         does. The "diff" format shows an inline diff of the changed
4976         contents of the submodule. Defaults to "short".
4977 </p>
4978 </dd>
4979 <dt class="hdlist1">
4980 diff.wordRegex
4981 </dt>
4982 <dd>
4983 <p>
4984         A POSIX Extended Regular Expression used to determine what is a "word"
4985         when performing word-by-word difference calculations.  Character
4986         sequences that match the regular expression are "words", all other
4987         characters are <strong>ignorable</strong> whitespace.
4988 </p>
4989 </dd>
4990 <dt class="hdlist1">
4991 diff.&lt;driver&gt;.command
4992 </dt>
4993 <dd>
4994 <p>
4995         The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
4996         for details.
4997 </p>
4998 </dd>
4999 <dt class="hdlist1">
5000 diff.&lt;driver&gt;.xfuncname
5001 </dt>
5002 <dd>
5003 <p>
5004         The regular expression that the diff driver should use to
5005         recognize the hunk header.  A built-in pattern may also be used.
5006         See <a href="gitattributes.html">gitattributes(5)</a> for details.
5007 </p>
5008 </dd>
5009 <dt class="hdlist1">
5010 diff.&lt;driver&gt;.binary
5011 </dt>
5012 <dd>
5013 <p>
5014         Set this option to true to make the diff driver treat files as
5015         binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5016 </p>
5017 </dd>
5018 <dt class="hdlist1">
5019 diff.&lt;driver&gt;.textconv
5020 </dt>
5021 <dd>
5022 <p>
5023         The command that the diff driver should call to generate the
5024         text-converted version of a file.  The result of the
5025         conversion is used to generate a human-readable diff.  See
5026         <a href="gitattributes.html">gitattributes(5)</a> for details.
5027 </p>
5028 </dd>
5029 <dt class="hdlist1">
5030 diff.&lt;driver&gt;.wordRegex
5031 </dt>
5032 <dd>
5033 <p>
5034         The regular expression that the diff driver should use to
5035         split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
5036         details.
5037 </p>
5038 </dd>
5039 <dt class="hdlist1">
5040 diff.&lt;driver&gt;.cachetextconv
5041 </dt>
5042 <dd>
5043 <p>
5044         Set this option to true to make the diff driver cache the text
5045         conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5046 </p>
5047 <div class="dlist"><dl>
5048 <dt class="hdlist1">
5049 <code>araxis</code>
5050 </dt>
5051 <dd>
5052 <p>
5053 Use Araxis Merge (requires a graphical session)
5054 </p>
5055 </dd>
5056 <dt class="hdlist1">
5057 <code>bc</code>
5058 </dt>
5059 <dd>
5060 <p>
5061 Use Beyond Compare (requires a graphical session)
5062 </p>
5063 </dd>
5064 <dt class="hdlist1">
5065 <code>bc3</code>
5066 </dt>
5067 <dd>
5068 <p>
5069 Use Beyond Compare (requires a graphical session)
5070 </p>
5071 </dd>
5072 <dt class="hdlist1">
5073 <code>bc4</code>
5074 </dt>
5075 <dd>
5076 <p>
5077 Use Beyond Compare (requires a graphical session)
5078 </p>
5079 </dd>
5080 <dt class="hdlist1">
5081 <code>codecompare</code>
5082 </dt>
5083 <dd>
5084 <p>
5085 Use Code Compare (requires a graphical session)
5086 </p>
5087 </dd>
5088 <dt class="hdlist1">
5089 <code>deltawalker</code>
5090 </dt>
5091 <dd>
5092 <p>
5093 Use DeltaWalker (requires a graphical session)
5094 </p>
5095 </dd>
5096 <dt class="hdlist1">
5097 <code>diffmerge</code>
5098 </dt>
5099 <dd>
5100 <p>
5101 Use DiffMerge (requires a graphical session)
5102 </p>
5103 </dd>
5104 <dt class="hdlist1">
5105 <code>diffuse</code>
5106 </dt>
5107 <dd>
5108 <p>
5109 Use Diffuse (requires a graphical session)
5110 </p>
5111 </dd>
5112 <dt class="hdlist1">
5113 <code>ecmerge</code>
5114 </dt>
5115 <dd>
5116 <p>
5117 Use ECMerge (requires a graphical session)
5118 </p>
5119 </dd>
5120 <dt class="hdlist1">
5121 <code>emerge</code>
5122 </dt>
5123 <dd>
5124 <p>
5125 Use Emacs' Emerge
5126 </p>
5127 </dd>
5128 <dt class="hdlist1">
5129 <code>examdiff</code>
5130 </dt>
5131 <dd>
5132 <p>
5133 Use ExamDiff Pro (requires a graphical session)
5134 </p>
5135 </dd>
5136 <dt class="hdlist1">
5137 <code>guiffy</code>
5138 </dt>
5139 <dd>
5140 <p>
5141 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
5142 </p>
5143 </dd>
5144 <dt class="hdlist1">
5145 <code>gvimdiff</code>
5146 </dt>
5147 <dd>
5148 <p>
5149 Use gVim (requires a graphical session)
5150 </p>
5151 </dd>
5152 <dt class="hdlist1">
5153 <code>kdiff3</code>
5154 </dt>
5155 <dd>
5156 <p>
5157 Use KDiff3 (requires a graphical session)
5158 </p>
5159 </dd>
5160 <dt class="hdlist1">
5161 <code>kompare</code>
5162 </dt>
5163 <dd>
5164 <p>
5165 Use Kompare (requires a graphical session)
5166 </p>
5167 </dd>
5168 <dt class="hdlist1">
5169 <code>meld</code>
5170 </dt>
5171 <dd>
5172 <p>
5173 Use Meld (requires a graphical session)
5174 </p>
5175 </dd>
5176 <dt class="hdlist1">
5177 <code>nvimdiff</code>
5178 </dt>
5179 <dd>
5180 <p>
5181 Use Neovim
5182 </p>
5183 </dd>
5184 <dt class="hdlist1">
5185 <code>opendiff</code>
5186 </dt>
5187 <dd>
5188 <p>
5189 Use FileMerge (requires a graphical session)
5190 </p>
5191 </dd>
5192 <dt class="hdlist1">
5193 <code>p4merge</code>
5194 </dt>
5195 <dd>
5196 <p>
5197 Use HelixCore P4Merge (requires a graphical session)
5198 </p>
5199 </dd>
5200 <dt class="hdlist1">
5201 <code>smerge</code>
5202 </dt>
5203 <dd>
5204 <p>
5205 Use Sublime Merge (requires a graphical session)
5206 </p>
5207 </dd>
5208 <dt class="hdlist1">
5209 <code>tkdiff</code>
5210 </dt>
5211 <dd>
5212 <p>
5213 Use TkDiff (requires a graphical session)
5214 </p>
5215 </dd>
5216 <dt class="hdlist1">
5217 <code>vimdiff</code>
5218 </dt>
5219 <dd>
5220 <p>
5221 Use Vim
5222 </p>
5223 </dd>
5224 <dt class="hdlist1">
5225 <code>winmerge</code>
5226 </dt>
5227 <dd>
5228 <p>
5229 Use WinMerge (requires a graphical session)
5230 </p>
5231 </dd>
5232 <dt class="hdlist1">
5233 <code>xxdiff</code>
5234 </dt>
5235 <dd>
5236 <p>
5237 Use xxdiff (requires a graphical session)
5238 </p>
5239 </dd>
5240 </dl></div>
5241 </dd>
5242 <dt class="hdlist1">
5243 diff.indentHeuristic
5244 </dt>
5245 <dd>
5246 <p>
5247         Set this option to <code>false</code> to disable the default heuristics
5248         that shift diff hunk boundaries to make patches easier to read.
5249 </p>
5250 </dd>
5251 <dt class="hdlist1">
5252 diff.algorithm
5253 </dt>
5254 <dd>
5255 <p>
5256         Choose a diff algorithm.  The variants are as follows:
5257 </p>
5258 <div class="openblock">
5259 <div class="content">
5260 <div class="dlist"><dl>
5261 <dt class="hdlist1">
5262 <code>default</code>, <code>myers</code>
5263 </dt>
5264 <dd>
5265 <p>
5266         The basic greedy diff algorithm. Currently, this is the default.
5267 </p>
5268 </dd>
5269 <dt class="hdlist1">
5270 <code>minimal</code>
5271 </dt>
5272 <dd>
5273 <p>
5274         Spend extra time to make sure the smallest possible diff is
5275         produced.
5276 </p>
5277 </dd>
5278 <dt class="hdlist1">
5279 <code>patience</code>
5280 </dt>
5281 <dd>
5282 <p>
5283         Use "patience diff" algorithm when generating patches.
5284 </p>
5285 </dd>
5286 <dt class="hdlist1">
5287 <code>histogram</code>
5288 </dt>
5289 <dd>
5290 <p>
5291         This algorithm extends the patience algorithm to "support
5292         low-occurrence common elements".
5293 </p>
5294 </dd>
5295 </dl></div>
5296 </div></div>
5297 </dd>
5298 <dt class="hdlist1">
5299 diff.wsErrorHighlight
5300 </dt>
5301 <dd>
5302 <p>
5303         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5304         lines of the diff.  Multiple values are separated by comma,
5305         <code>none</code> resets previous values, <code>default</code> reset the list to
5306         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
5307         whitespace errors are colored with <code>color.diff.whitespace</code>.
5308         The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
5309         overrides this setting.
5310 </p>
5311 </dd>
5312 <dt class="hdlist1">
5313 diff.colorMoved
5314 </dt>
5315 <dd>
5316 <p>
5317         If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
5318         in a diff are colored differently, for details of valid modes
5319         see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
5320         true the default color mode will be used. When set to false,
5321         moved lines are not colored.
5322 </p>
5323 </dd>
5324 <dt class="hdlist1">
5325 diff.colorMovedWS
5326 </dt>
5327 <dd>
5328 <p>
5329         When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5330         this option controls the <code>&lt;mode&gt;</code> how spaces are treated.
5331         For details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.
5332 </p>
5333 </dd>
5334 <dt class="hdlist1">
5335 diff.tool
5336 </dt>
5337 <dd>
5338 <p>
5339         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
5340         This variable overrides the value configured in <code>merge.tool</code>.
5341         The list below shows the valid built-in values.
5342         Any other value is treated as a custom diff tool and requires
5343         that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
5344 </p>
5345 </dd>
5346 <dt class="hdlist1">
5347 diff.guitool
5348 </dt>
5349 <dd>
5350 <p>
5351         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
5352         the -g/--gui flag is specified. This variable overrides the value
5353         configured in <code>merge.guitool</code>. The list below shows the valid
5354         built-in values. Any other value is treated as a custom diff tool
5355         and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
5356         is defined.
5357 </p>
5358 </dd>
5359 <dt class="hdlist1">
5360 difftool.&lt;tool&gt;.cmd
5361 </dt>
5362 <dd>
5363 <p>
5364         Specify the command to invoke the specified diff tool.
5365         The specified command is evaluated in shell with the following
5366         variables available:  <em>LOCAL</em> is set to the name of the temporary
5367         file containing the contents of the diff pre-image and <em>REMOTE</em>
5368         is set to the name of the temporary file containing the contents
5369         of the diff post-image.
5370 </p>
5371 <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>
5372 </dd>
5373 <dt class="hdlist1">
5374 difftool.&lt;tool&gt;.path
5375 </dt>
5376 <dd>
5377 <p>
5378         Override the path for the given tool.  This is useful in case
5379         your tool is not in the PATH.
5380 </p>
5381 </dd>
5382 <dt class="hdlist1">
5383 difftool.trustExitCode
5384 </dt>
5385 <dd>
5386 <p>
5387         Exit difftool if the invoked diff tool returns a non-zero exit status.
5388 </p>
5389 <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>
5390 </dd>
5391 <dt class="hdlist1">
5392 difftool.prompt
5393 </dt>
5394 <dd>
5395 <p>
5396         Prompt before each invocation of the diff tool.
5397 </p>
5398 </dd>
5399 <dt class="hdlist1">
5400 difftool.guiDefault
5401 </dt>
5402 <dd>
5403 <p>
5404         Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5405         the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5406         depending on the presence of a <code>DISPLAY</code> environment variable value. The
5407         default is <code>false</code>, where the <code>--gui</code> argument must be provided
5408         explicitly for the <code>diff.guitool</code> to be used.
5409 </p>
5410 </dd>
5411 <dt class="hdlist1">
5412 extensions.objectFormat
5413 </dt>
5414 <dd>
5415 <p>
5416         Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
5417         <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
5418         this key unless <code>core.repositoryFormatVersion</code> is 1.
5419 </p>
5420 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5421 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
5422 work and will produce hard-to-diagnose issues.</p></div>
5423 </dd>
5424 <dt class="hdlist1">
5425 extensions.refStorage
5426 </dt>
5427 <dd>
5428 <p>
5429         Specify the ref storage format to use. The acceptable values are:
5430 </p>
5431 <div class="ulist"><ul>
5432 <li>
5433 <p>
5434 <code>files</code> for loose files with packed-refs. This is the default.
5435 </p>
5436 </li>
5437 <li>
5438 <p>
5439 <code>reftable</code> for the reftable format. This format is experimental and its
5440   internals are subject to change.
5441 </p>
5442 <div class="paragraph"><p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p></div>
5443 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5444 <a href="git-clone.html">git-clone(1)</a>. Trying to change it after initialization will not
5445 work and will produce hard-to-diagnose issues.</p></div>
5446 </li>
5447 </ul></div>
5448 </dd>
5449 <dt class="hdlist1">
5450 extensions.worktreeConfig
5451 </dt>
5452 <dd>
5453 <p>
5454         If enabled, then worktrees will load config settings from the
5455         <code>$GIT_DIR/config.worktree</code> file in addition to the
5456         <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5457         <code>$GIT_DIR</code> are the same for the main working tree, while other
5458         working trees have <code>$GIT_DIR</code> equal to
5459         <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
5460         <code>config.worktree</code> file will override settings from any other
5461         config files.
5462 </p>
5463 <div class="paragraph"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5464 certain values from the common config file to the main working tree&#8217;s
5465 <code>config.worktree</code> file, if present:</p></div>
5466 <div class="ulist"><ul>
5467 <li>
5468 <p>
5469 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5470   <code>$GIT_COMMON_DIR/config.worktree</code>.
5471 </p>
5472 </li>
5473 <li>
5474 <p>
5475 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5476   to <code>$GIT_COMMON_DIR/config.worktree</code>.
5477 </p>
5478 <div class="paragraph"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5479 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5480 sparse-checkout settings for each worktree. By default, the <code>git
5481 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5482 these config values on a per-worktree basis, and uses the
5483 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5484 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
5485 details.</p></div>
5486 <div class="paragraph"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5487 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5488 </li>
5489 </ul></div>
5490 </dd>
5491 <dt class="hdlist1">
5492 fastimport.unpackLimit
5493 </dt>
5494 <dd>
5495 <p>
5496         If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
5497         is below this limit, then the objects will be unpacked into
5498         loose object files.  However, if the number of imported objects
5499         equals or exceeds this limit, then the pack will be stored as a
5500         pack.  Storing the pack from a fast-import can make the import
5501         operation complete faster, especially on slow filesystems.  If
5502         not set, the value of <code>transfer.unpackLimit</code> is used instead.
5503 </p>
5504 </dd>
5505 <dt class="hdlist1">
5506 feature.*
5507 </dt>
5508 <dd>
5509 <p>
5510         The config settings that start with <code>feature.</code> modify the defaults of
5511         a group of other config settings. These groups are created by the Git
5512         developer community as recommended defaults and are subject to change.
5513         In particular, new config options may be added with different defaults.
5514 </p>
5515 </dd>
5516 <dt class="hdlist1">
5517 feature.experimental
5518 </dt>
5519 <dd>
5520 <p>
5521         Enable config options that are new to Git, and are being considered for
5522         future defaults. Config settings included here may be added or removed
5523         with each release, including minor version updates. These settings may
5524         have unintended interactions since they are so new. Please enable this
5525         setting if you are interested in providing feedback on experimental
5526         features. The new default values are:
5527 </p>
5528 <div class="ulist"><ul>
5529 <li>
5530 <p>
5531 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5532 skipping more commits at a time, reducing the number of round trips.
5533 </p>
5534 </li>
5535 <li>
5536 <p>
5537 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5538 walking fewer objects.
5539 </p>
5540 </li>
5541 <li>
5542 <p>
5543 <code>pack.allowPackReuse=multi</code> may improve the time it takes to create a pack by
5544 reusing objects from multiple packs instead of just one.
5545 </p>
5546 </li>
5547 </ul></div>
5548 </dd>
5549 <dt class="hdlist1">
5550 feature.manyFiles
5551 </dt>
5552 <dd>
5553 <p>
5554         Enable config options that optimize for repos with many files in the
5555         working directory. With many files, commands such as <code>git status</code> and
5556         <code>git checkout</code> may be slow and these new defaults improve performance:
5557 </p>
5558 <div class="ulist"><ul>
5559 <li>
5560 <p>
5561 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5562   checksum. Note that this will cause Git versions earlier than 2.13.0 to
5563   refuse to parse the index and Git versions earlier than 2.40.0 will report
5564   a corrupted index during <code>git fsck</code>.
5565 </p>
5566 </li>
5567 <li>
5568 <p>
5569 <code>index.version=4</code> enables path-prefix compression in the index.
5570 </p>
5571 </li>
5572 <li>
5573 <p>
5574 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5575 that mtime is working on your machine.
5576 </p>
5577 </li>
5578 </ul></div>
5579 </dd>
5580 <dt class="hdlist1">
5581 fetch.recurseSubmodules
5582 </dt>
5583 <dd>
5584 <p>
5585         This option controls whether <code>git fetch</code> (and the underlying fetch
5586         in <code>git pull</code>) will recursively fetch into populated submodules.
5587         This option can be set either to a boolean value or to <em>on-demand</em>.
5588         Setting it to a boolean changes the behavior of fetch and pull to
5589         recurse unconditionally into submodules when set to true or to not
5590         recurse at all when set to false. When set to <em>on-demand</em>, fetch and
5591         pull will only recurse into a populated submodule when its
5592         superproject retrieves a commit that updates the submodule&#8217;s
5593         reference.
5594         Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
5595 </p>
5596 </dd>
5597 <dt class="hdlist1">
5598 fetch.fsckObjects
5599 </dt>
5600 <dd>
5601 <p>
5602         If it is set to true, git-fetch-pack will check all fetched
5603         objects. See <code>transfer.fsckObjects</code> for what&#8217;s
5604         checked. Defaults to false. If not set, the value of
5605         <code>transfer.fsckObjects</code> is used instead.
5606 </p>
5607 </dd>
5608 <dt class="hdlist1">
5609 fetch.fsck.&lt;msg-id&gt;
5610 </dt>
5611 <dd>
5612 <p>
5613         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
5614         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5615         the <code>fsck.&lt;msg-id&gt;</code> documentation for details.
5616 </p>
5617 </dd>
5618 <dt class="hdlist1">
5619 fetch.fsck.skipList
5620 </dt>
5621 <dd>
5622 <p>
5623         Acts like <code>fsck.skipList</code>, but is used by
5624         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5625         the <code>fsck.skipList</code> documentation for details.
5626 </p>
5627 </dd>
5628 <dt class="hdlist1">
5629 fetch.unpackLimit
5630 </dt>
5631 <dd>
5632 <p>
5633         If the number of objects fetched over the Git native
5634         transfer is below this
5635         limit, then the objects will be unpacked into loose object
5636         files. However if the number of received objects equals or
5637         exceeds this limit then the received pack will be stored as
5638         a pack, after adding any missing delta bases.  Storing the
5639         pack from a push can make the push operation complete faster,
5640         especially on slow filesystems.  If not set, the value of
5641         <code>transfer.unpackLimit</code> is used instead.
5642 </p>
5643 </dd>
5644 <dt class="hdlist1">
5645 fetch.prune
5646 </dt>
5647 <dd>
5648 <p>
5649         If true, fetch will automatically behave as if the <code>--prune</code>
5650         option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
5651         and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.
5652 </p>
5653 </dd>
5654 <dt class="hdlist1">
5655 fetch.pruneTags
5656 </dt>
5657 <dd>
5658 <p>
5659         If true, fetch will automatically behave as if the
5660         <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
5661         if not set already. This allows for setting both this option
5662         and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
5663         refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
5664         section of <a href="git-fetch.html">git-fetch(1)</a>.
5665 </p>
5666 </dd>
5667 <dt class="hdlist1">
5668 fetch.all
5669 </dt>
5670 <dd>
5671 <p>
5672         If true, fetch will attempt to update all available remotes.
5673         This behavior can be overridden by passing <code>--no-all</code> or by
5674         explicitly specifying one or more remote(s) to fetch from.
5675         Defaults to false.
5676 </p>
5677 </dd>
5678 <dt class="hdlist1">
5679 fetch.output
5680 </dt>
5681 <dd>
5682 <p>
5683         Control how ref update status is printed. Valid values are
5684         <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
5685         OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.
5686 </p>
5687 </dd>
5688 <dt class="hdlist1">
5689 fetch.negotiationAlgorithm
5690 </dt>
5691 <dd>
5692 <p>
5693         Control how information about the commits in the local repository
5694         is sent when negotiating the contents of the packfile to be sent by
5695         the server.  Set to "consecutive" to use an algorithm that walks
5696         over consecutive commits checking each one.  Set to "skipping" to
5697         use an algorithm that skips commits in an effort to converge
5698         faster, but may result in a larger-than-necessary packfile; or set
5699         to "noop" to not send any information at all, which will almost
5700         certainly result in a larger-than-necessary packfile, but will skip
5701         the negotiation step.  Set to "default" to override settings made
5702         previously and use the default behaviour.  The default is normally
5703         "consecutive", but if <code>feature.experimental</code> is true, then the
5704         default is "skipping".  Unknown values will cause <em>git fetch</em> to
5705         error out.
5706 </p>
5707 <div class="paragraph"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
5708 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
5709 </dd>
5710 <dt class="hdlist1">
5711 fetch.showForcedUpdates
5712 </dt>
5713 <dd>
5714 <p>
5715         Set to false to enable <code>--no-show-forced-updates</code> in
5716         <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
5717         Defaults to true.
5718 </p>
5719 </dd>
5720 <dt class="hdlist1">
5721 fetch.parallel
5722 </dt>
5723 <dd>
5724 <p>
5725         Specifies the maximal number of fetch operations to be run in parallel
5726         at a time (submodules, or remotes when the <code>--multiple</code> option of
5727         <a href="git-fetch.html">git-fetch(1)</a> is in effect).
5728 </p>
5729 <div class="paragraph"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
5730 <div class="paragraph"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
5731 config setting.</p></div>
5732 </dd>
5733 <dt class="hdlist1">
5734 fetch.writeCommitGraph
5735 </dt>
5736 <dd>
5737 <p>
5738         Set to true to write a commit-graph after every <code>git fetch</code> command
5739         that downloads a pack-file from a remote. Using the <code>--split</code> option,
5740         most executions will create a very small commit-graph file on top of
5741         the existing commit-graph file(s). Occasionally, these files will
5742         merge and the write may take longer. Having an updated commit-graph
5743         file helps performance of many Git commands, including <code>git merge-base</code>,
5744         <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
5745 </p>
5746 </dd>
5747 <dt class="hdlist1">
5748 fetch.bundleURI
5749 </dt>
5750 <dd>
5751 <p>
5752         This value stores a URI for downloading Git object data from a bundle
5753         URI before performing an incremental fetch from the origin Git server.
5754         This is similar to how the <code>--bundle-uri</code> option behaves in
5755         <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
5756         <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
5757         list that is organized for incremental fetches.
5758 </p>
5759 <div class="paragraph"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
5760 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
5761 the new bundle URI.</p></div>
5762 </dd>
5763 <dt class="hdlist1">
5764 fetch.bundleCreationToken
5765 </dt>
5766 <dd>
5767 <p>
5768         When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
5769         list that uses the "creationToken" heuristic, this config value
5770         stores the maximum <code>creationToken</code> value of the downloaded bundles.
5771         This value is used to prevent downloading bundles in the future
5772         if the advertised <code>creationToken</code> is not strictly larger than this
5773         value.
5774 </p>
5775 <div class="paragraph"><p>The creation token values are chosen by the provider serving the specific
5776 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
5777 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
5778 </dd>
5779 <dt class="hdlist1">
5780 filter.&lt;driver&gt;.clean
5781 </dt>
5782 <dd>
5783 <p>
5784         The command which is used to convert the content of a worktree
5785         file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
5786         details.
5787 </p>
5788 </dd>
5789 <dt class="hdlist1">
5790 filter.&lt;driver&gt;.smudge
5791 </dt>
5792 <dd>
5793 <p>
5794         The command which is used to convert the content of a blob
5795         object to a worktree file upon checkout.  See
5796         <a href="gitattributes.html">gitattributes(5)</a> for details.
5797 </p>
5798 </dd>
5799 <dt class="hdlist1">
5800 format.attach
5801 </dt>
5802 <dd>
5803 <p>
5804         Enable multipart/mixed attachments as the default for
5805         <em>format-patch</em>.  The value can also be a double quoted string
5806         which will enable attachments as the default and set the
5807         value as the boundary.  See the --attach option in
5808         <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
5809         value, set it to an empty string.
5810 </p>
5811 </dd>
5812 <dt class="hdlist1">
5813 format.from
5814 </dt>
5815 <dd>
5816 <p>
5817         Provides the default value for the <code>--from</code> option to format-patch.
5818         Accepts a boolean value, or a name and email address.  If false,
5819         format-patch defaults to <code>--no-from</code>, using commit authors directly in
5820         the "From:" field of patch mails.  If true, format-patch defaults to
5821         <code>--from</code>, using your committer identity in the "From:" field of patch
5822         mails and including a "From:" field in the body of the patch mail if
5823         different.  If set to a non-boolean value, format-patch uses that
5824         value instead of your committer identity.  Defaults to false.
5825 </p>
5826 </dd>
5827 <dt class="hdlist1">
5828 format.forceInBodyFrom
5829 </dt>
5830 <dd>
5831 <p>
5832         Provides the default value for the <code>--[no-]force-in-body-from</code>
5833         option to format-patch.  Defaults to false.
5834 </p>
5835 </dd>
5836 <dt class="hdlist1">
5837 format.numbered
5838 </dt>
5839 <dd>
5840 <p>
5841         A boolean which can enable or disable sequence numbers in patch
5842         subjects.  It defaults to "auto" which enables it only if there
5843         is more than one patch.  It can be enabled or disabled for all
5844         messages by setting it to "true" or "false".  See --numbered
5845         option in <a href="git-format-patch.html">git-format-patch(1)</a>.
5846 </p>
5847 </dd>
5848 <dt class="hdlist1">
5849 format.headers
5850 </dt>
5851 <dd>
5852 <p>
5853         Additional email headers to include in a patch to be submitted
5854         by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.
5855 </p>
5856 </dd>
5857 <dt class="hdlist1">
5858 format.to
5859 </dt>
5860 <dt class="hdlist1">
5861 format.cc
5862 </dt>
5863 <dd>
5864 <p>
5865         Additional recipients to include in a patch to be submitted
5866         by mail.  See the --to and --cc options in
5867         <a href="git-format-patch.html">git-format-patch(1)</a>.
5868 </p>
5869 </dd>
5870 <dt class="hdlist1">
5871 format.subjectPrefix
5872 </dt>
5873 <dd>
5874 <p>
5875         The default for format-patch is to output files with the <em>[PATCH]</em>
5876         subject prefix. Use this variable to change that prefix.
5877 </p>
5878 </dd>
5879 <dt class="hdlist1">
5880 format.coverFromDescription
5881 </dt>
5882 <dd>
5883 <p>
5884         The default mode for format-patch to determine which parts of
5885         the cover letter will be populated using the branch&#8217;s
5886         description. See the <code>--cover-from-description</code> option in
5887         <a href="git-format-patch.html">git-format-patch(1)</a>.
5888 </p>
5889 </dd>
5890 <dt class="hdlist1">
5891 format.signature
5892 </dt>
5893 <dd>
5894 <p>
5895         The default for format-patch is to output a signature containing
5896         the Git version number. Use this variable to change that default.
5897         Set this variable to the empty string ("") to suppress
5898         signature generation.
5899 </p>
5900 </dd>
5901 <dt class="hdlist1">
5902 format.signatureFile
5903 </dt>
5904 <dd>
5905 <p>
5906         Works just like format.signature except the contents of the
5907         file specified by this variable will be used as the signature.
5908 </p>
5909 </dd>
5910 <dt class="hdlist1">
5911 format.suffix
5912 </dt>
5913 <dd>
5914 <p>
5915         The default for format-patch is to output files with the suffix
5916         <code>.patch</code>. Use this variable to change that suffix (make sure to
5917         include the dot if you want it).
5918 </p>
5919 </dd>
5920 <dt class="hdlist1">
5921 format.encodeEmailHeaders
5922 </dt>
5923 <dd>
5924 <p>
5925         Encode email headers that have non-ASCII characters with
5926         "Q-encoding" (described in RFC 2047) for email transmission.
5927         Defaults to true.
5928 </p>
5929 </dd>
5930 <dt class="hdlist1">
5931 format.pretty
5932 </dt>
5933 <dd>
5934 <p>
5935         The default pretty format for log/show/whatchanged command.
5936         See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
5937         <a href="git-whatchanged.html">git-whatchanged(1)</a>.
5938 </p>
5939 </dd>
5940 <dt class="hdlist1">
5941 format.thread
5942 </dt>
5943 <dd>
5944 <p>
5945         The default threading style for <em>git format-patch</em>.  Can be
5946         a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
5947         makes every mail a reply to the head of the series,
5948         where the head is chosen from the cover letter, the
5949         <code>--in-reply-to</code>, and the first patch mail, in this order.
5950         <code>deep</code> threading makes every mail a reply to the previous one.
5951         A true boolean value is the same as <code>shallow</code>, and a false
5952         value disables threading.
5953 </p>
5954 </dd>
5955 <dt class="hdlist1">
5956 format.signOff
5957 </dt>
5958 <dd>
5959 <p>
5960         A boolean value which lets you enable the <code>-s/--signoff</code> option of
5961         format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
5962         patch should be a conscious act and means that you certify you have
5963         the rights to submit this work under the same open source license.
5964         Please see the <em>SubmittingPatches</em> document for further discussion.
5965 </p>
5966 </dd>
5967 <dt class="hdlist1">
5968 format.coverLetter
5969 </dt>
5970 <dd>
5971 <p>
5972         A boolean that controls whether to generate a cover-letter when
5973         format-patch is invoked, but in addition can be set to "auto", to
5974         generate a cover-letter only when there&#8217;s more than one patch.
5975         Default is false.
5976 </p>
5977 </dd>
5978 <dt class="hdlist1">
5979 format.outputDirectory
5980 </dt>
5981 <dd>
5982 <p>
5983         Set a custom directory to store the resulting files instead of the
5984         current working directory. All directory components will be created.
5985 </p>
5986 </dd>
5987 <dt class="hdlist1">
5988 format.filenameMaxLength
5989 </dt>
5990 <dd>
5991 <p>
5992         The maximum length of the output filenames generated by the
5993         <code>format-patch</code> command; defaults to 64.  Can be overridden
5994         by the <code>--filename-max-length=&lt;n&gt;</code> command line option.
5995 </p>
5996 </dd>
5997 <dt class="hdlist1">
5998 format.useAutoBase
5999 </dt>
6000 <dd>
6001 <p>
6002         A boolean value which lets you enable the <code>--base=auto</code> option of
6003         format-patch by default. Can also be set to "whenAble" to allow
6004         enabling <code>--base=auto</code> if a suitable base is available, but to skip
6005         adding base info otherwise without the format dying.
6006 </p>
6007 </dd>
6008 <dt class="hdlist1">
6009 format.notes
6010 </dt>
6011 <dd>
6012 <p>
6013         Provides the default value for the <code>--notes</code> option to
6014         format-patch. Accepts a boolean value, or a ref which specifies
6015         where to get notes. If false, format-patch defaults to
6016         <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
6017         set to a non-boolean value, format-patch defaults to
6018         <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
6019         to false.
6020 </p>
6021 <div class="paragraph"><p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
6022 instead.</p></div>
6023 <div class="paragraph"><p>This configuration can be specified multiple times in order to allow
6024 multiple notes refs to be included. In that case, it will behave
6025 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
6026 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
6027 also show notes from that notes ref and a value of <code>false</code> will negate
6028 previous configurations and not show notes.</p></div>
6029 <div class="paragraph"><p>For example,</p></div>
6030 <div class="listingblock">
6031 <div class="content">
6032 <pre><code>[format]
6033         notes = true
6034         notes = foo
6035         notes = false
6036         notes = bar</code></pre>
6037 </div></div>
6038 <div class="paragraph"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
6039 </dd>
6040 <dt class="hdlist1">
6041 format.mboxrd
6042 </dt>
6043 <dd>
6044 <p>
6045         A boolean value which enables the robust "mboxrd" format when
6046         <code>--stdout</code> is in use to escape "^&gt;+From " lines.
6047 </p>
6048 </dd>
6049 <dt class="hdlist1">
6050 format.noprefix
6051 </dt>
6052 <dd>
6053 <p>
6054         If set, do not show any source or destination prefix in patches.
6055         This is equivalent to the <code>diff.noprefix</code> option used by <code>git
6056         diff</code> (but which is not respected by <code>format-patch</code>). Note that
6057         by setting this, the receiver of any patches you generate will
6058         have to apply them using the <code>-p0</code> option.
6059 </p>
6060 </dd>
6061 <dt class="hdlist1">
6062 fsck.&lt;msg-id&gt;
6063 </dt>
6064 <dd>
6065 <p>
6066         During fsck git may find issues with legacy data which
6067         wouldn&#8217;t be generated by current versions of git, and which
6068         wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
6069         set. This feature is intended to support working with legacy
6070         repositories containing such data.
6071 </p>
6072 <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
6073 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
6074 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
6075 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
6076 same applies for the corresponding <code>receive.fsck.*</code> and
6077 <code>fetch.fsck.*</code>. variables.</p></div>
6078 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
6079 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
6080 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
6081 uniformly configure the same fsck settings in different circumstances,
6082 all three of them must be set to the same values.</p></div>
6083 <div class="paragraph"><p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
6084 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
6085 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
6086 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
6087 with the message ID, e.g. "missingEmail: invalid author/committer
6088 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
6089 will hide that issue.</p></div>
6090 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
6091 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6092 problematic objects share to be ignored, as doing the latter will
6093 allow new instances of the same breakages go unnoticed.</p></div>
6094 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
6095 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
6096 will only cause git to warn.</p></div>
6097 <div class="paragraph"><p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
6098 values of <code>&lt;msg-id&gt;</code>.</p></div>
6099 </dd>
6100 <dt class="hdlist1">
6101 fsck.skipList
6102 </dt>
6103 <dd>
6104 <p>
6105         The path to a list of object names (i.e. one unabbreviated SHA-1 per
6106         line) that are known to be broken in a non-fatal way and should
6107         be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
6108         lines, and any leading and trailing whitespace are ignored. Everything
6109         but a SHA-1 per line will error out on older versions.
6110 </p>
6111 <div class="paragraph"><p>This feature is useful when an established project should be accepted
6112 despite early commits containing errors that can be safely ignored,
6113 such as invalid committer email addresses.  Note: corrupt objects
6114 cannot be skipped with this setting.</p></div>
6115 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
6116 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6117 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6118 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6119 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
6120 uniformly configure the same fsck settings in different circumstances,
6121 all three of them must be set to the same values.</p></div>
6122 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
6123 list should be sorted. This was never a requirement; the object names
6124 could appear in any order, but when reading the list we tracked whether
6125 the list was sorted for the purposes of an internal binary search
6126 implementation, which could save itself some work with an already sorted
6127 list. Unless you had a humongous list there was no reason to go out of
6128 your way to pre-sort the list. After Git version 2.20 a hash implementation
6129 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
6130 </dd>
6131 <dt class="hdlist1">
6132 fsmonitor.allowRemote
6133 </dt>
6134 <dd>
6135 <p>
6136     By default, the fsmonitor daemon refuses to work with network-mounted
6137     repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6138     behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6139 </p>
6140 </dd>
6141 <dt class="hdlist1">
6142 fsmonitor.socketDir
6143 </dt>
6144 <dd>
6145 <p>
6146     This Mac OS-specific option, if set, specifies the directory in
6147     which to create the Unix domain socket used for communication
6148     between the fsmonitor daemon and various Git commands. The directory must
6149     reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
6150     is set to <code>true</code>.
6151 </p>
6152 </dd>
6153 <dt class="hdlist1">
6154 gc.aggressiveDepth
6155 </dt>
6156 <dd>
6157 <p>
6158         The depth parameter used in the delta compression
6159         algorithm used by <em>git gc --aggressive</em>.  This defaults
6160         to 50, which is the default for the <code>--depth</code> option when
6161         <code>--aggressive</code> isn&#8217;t in use.
6162 </p>
6163 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
6164 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6165 </dd>
6166 <dt class="hdlist1">
6167 gc.aggressiveWindow
6168 </dt>
6169 <dd>
6170 <p>
6171         The window size parameter used in the delta compression
6172         algorithm used by <em>git gc --aggressive</em>.  This defaults
6173         to 250, which is a much more aggressive window size than
6174         the default <code>--window</code> of 10.
6175 </p>
6176 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
6177 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6178 </dd>
6179 <dt class="hdlist1">
6180 gc.auto
6181 </dt>
6182 <dd>
6183 <p>
6184         When there are approximately more than this many loose
6185         objects in the repository, <code>git gc --auto</code> will pack them.
6186         Some Porcelain commands use this command to perform a
6187         light-weight garbage collection from time to time.  The
6188         default value is 6700.
6189 </p>
6190 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
6191 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
6192 otherwise use to determine if there&#8217;s work to do, such as
6193 <code>gc.autoPackLimit</code>.</p></div>
6194 </dd>
6195 <dt class="hdlist1">
6196 gc.autoPackLimit
6197 </dt>
6198 <dd>
6199 <p>
6200         When there are more than this many packs that are not
6201         marked with <code>*.keep</code> file in the repository, <code>git gc
6202         --auto</code> consolidates them into one larger pack.  The
6203         default value is 50.  Setting this to 0 disables it.
6204         Setting <code>gc.auto</code> to 0 will also disable this.
6205 </p>
6206 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6207 use, it&#8217;ll affect how the auto pack limit works.</p></div>
6208 </dd>
6209 <dt class="hdlist1">
6210 gc.autoDetach
6211 </dt>
6212 <dd>
6213 <p>
6214         Make <code>git gc --auto</code> return immediately and run in the background
6215         if the system supports it. Default is true.
6216 </p>
6217 </dd>
6218 <dt class="hdlist1">
6219 gc.bigPackThreshold
6220 </dt>
6221 <dd>
6222 <p>
6223         If non-zero, all non-cruft packs larger than this limit are kept
6224         when <code>git gc</code> is run. This is very similar to
6225         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6226         the threshold are kept, not just the largest pack. Defaults to
6227         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6228 </p>
6229 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6230 this configuration variable is ignored, all packs except the base pack
6231 will be repacked. After this the number of packs should go below
6232 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6233 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6234 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6235 will also be excluded (this is the equivalent of running <code>git gc</code> with
6236 <code>--keep-largest-pack</code>).</p></div>
6237 </dd>
6238 <dt class="hdlist1">
6239 gc.writeCommitGraph
6240 </dt>
6241 <dd>
6242 <p>
6243         If true, then gc will rewrite the commit-graph file when
6244         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6245         the commit-graph will be updated if housekeeping is
6246         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
6247         for details.
6248 </p>
6249 </dd>
6250 <dt class="hdlist1">
6251 gc.logExpiry
6252 </dt>
6253 <dd>
6254 <p>
6255         If the file gc.log exists, then <code>git gc --auto</code> will print
6256         its content and exit with status zero instead of running
6257         unless that file is more than <em>gc.logExpiry</em> old.  Default is
6258         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
6259         value.
6260 </p>
6261 </dd>
6262 <dt class="hdlist1">
6263 gc.packRefs
6264 </dt>
6265 <dd>
6266 <p>
6267         Running <code>git pack-refs</code> in a repository renders it
6268         unclonable by Git versions prior to 1.5.1.2 over dumb
6269         transports such as HTTP.  This variable determines whether
6270         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6271         to enable it within all non-bare repos or it can be set to a
6272         boolean value.  The default is <code>true</code>.
6273 </p>
6274 </dd>
6275 <dt class="hdlist1">
6276 gc.cruftPacks
6277 </dt>
6278 <dd>
6279 <p>
6280         Store unreachable objects in a cruft pack (see
6281         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
6282         is <code>true</code>.
6283 </p>
6284 </dd>
6285 <dt class="hdlist1">
6286 gc.maxCruftSize
6287 </dt>
6288 <dd>
6289 <p>
6290         Limit the size of new cruft packs when repacking. When
6291         specified in addition to <code>--max-cruft-size</code>, the command line
6292         option takes priority. See the <code>--max-cruft-size</code> option of
6293         <a href="git-repack.html">git-repack(1)</a>.
6294 </p>
6295 </dd>
6296 <dt class="hdlist1">
6297 gc.pruneExpire
6298 </dt>
6299 <dd>
6300 <p>
6301         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6302         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6303         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
6304         grace period with this config variable.  The value "now" may be
6305         used to disable this grace period and always prune unreachable
6306         objects immediately, or "never" may be used to suppress pruning.
6307         This feature helps prevent corruption when <em>git gc</em> runs
6308         concurrently with another process writing to the repository; see
6309         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
6310 </p>
6311 </dd>
6312 <dt class="hdlist1">
6313 gc.worktreePruneExpire
6314 </dt>
6315 <dd>
6316 <p>
6317         When <em>git gc</em> is run, it calls
6318         <em>git worktree prune --expire 3.months.ago</em>.
6319         This config variable can be used to set a different grace
6320         period. The value "now" may be used to disable the grace
6321         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
6322         may be used to suppress pruning.
6323 </p>
6324 </dd>
6325 <dt class="hdlist1">
6326 gc.reflogExpire
6327 </dt>
6328 <dt class="hdlist1">
6329 gc.&lt;pattern&gt;.reflogExpire
6330 </dt>
6331 <dd>
6332 <p>
6333         <em>git reflog expire</em> removes reflog entries older than
6334         this time; defaults to 90 days. The value "now" expires all
6335         entries immediately, and "never" suppresses expiration
6336         altogether. With "&lt;pattern&gt;" (e.g.
6337         "refs/stash") in the middle the setting applies only to
6338         the refs that match the &lt;pattern&gt;.
6339 </p>
6340 </dd>
6341 <dt class="hdlist1">
6342 gc.reflogExpireUnreachable
6343 </dt>
6344 <dt class="hdlist1">
6345 gc.&lt;pattern&gt;.reflogExpireUnreachable
6346 </dt>
6347 <dd>
6348 <p>
6349         <em>git reflog expire</em> removes reflog entries older than
6350         this time and are not reachable from the current tip;
6351         defaults to 30 days. The value "now" expires all entries
6352         immediately, and "never" suppresses expiration altogether.
6353         With "&lt;pattern&gt;" (e.g. "refs/stash")
6354         in the middle, the setting applies only to the refs that
6355         match the &lt;pattern&gt;.
6356 </p>
6357 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
6358 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6359 or rebase occurring.  Since these changes are not part of the current
6360 project most users will want to expire them sooner, which is why the
6361 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6362 </dd>
6363 <dt class="hdlist1">
6364 gc.recentObjectsHook
6365 </dt>
6366 <dd>
6367 <p>
6368         When considering whether or not to remove an object (either when
6369         generating a cruft pack or storing unreachable objects as
6370         loose), use the shell to execute the specified command(s).
6371         Interpret their output as object IDs which Git will consider as
6372         "recent", regardless of their age. By treating their mtimes as
6373         "now", any objects (and their descendants) mentioned in the
6374         output will be kept regardless of their true age.
6375 </p>
6376 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
6377 else. Objects which cannot be found in the repository are ignored.
6378 Multiple hooks are supported, but all must exit successfully, else the
6379 operation (either generating a cruft pack or unpacking unreachable
6380 objects) will be halted.</p></div>
6381 </dd>
6382 <dt class="hdlist1">
6383 gc.repackFilter
6384 </dt>
6385 <dd>
6386 <p>
6387         When repacking, use the specified filter to move certain
6388         objects into a separate packfile.  See the
6389         <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.
6390 </p>
6391 </dd>
6392 <dt class="hdlist1">
6393 gc.repackFilterTo
6394 </dt>
6395 <dd>
6396 <p>
6397         When repacking and using a filter, see <code>gc.repackFilter</code>, the
6398         specified location will be used to create the packfile
6399         containing the filtered out objects. <strong>WARNING:</strong> The
6400         specified location should be accessible, using for example the
6401         Git alternates mechanism, otherwise the repo could be
6402         considered corrupt by Git as it migh not be able to access the
6403         objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
6404         of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
6405         section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.
6406 </p>
6407 </dd>
6408 <dt class="hdlist1">
6409 gc.rerereResolved
6410 </dt>
6411 <dd>
6412 <p>
6413         Records of conflicted merge you resolved earlier are
6414         kept for this many days when <em>git rerere gc</em> is run.
6415         You can also use more human-readable "1.month.ago", etc.
6416         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6417 </p>
6418 </dd>
6419 <dt class="hdlist1">
6420 gc.rerereUnresolved
6421 </dt>
6422 <dd>
6423 <p>
6424         Records of conflicted merge you have not resolved are
6425         kept for this many days when <em>git rerere gc</em> is run.
6426         You can also use more human-readable "1.month.ago", etc.
6427         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6428 </p>
6429 </dd>
6430 <dt class="hdlist1">
6431 gitcvs.commitMsgAnnotation
6432 </dt>
6433 <dd>
6434 <p>
6435         Append this string to each commit message. Set to empty string
6436         to disable this feature. Defaults to "via git-CVS emulator".
6437 </p>
6438 </dd>
6439 <dt class="hdlist1">
6440 gitcvs.enabled
6441 </dt>
6442 <dd>
6443 <p>
6444         Whether the CVS server interface is enabled for this repository.
6445         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6446 </p>
6447 </dd>
6448 <dt class="hdlist1">
6449 gitcvs.logFile
6450 </dt>
6451 <dd>
6452 <p>
6453         Path to a log file where the CVS server interface well&#8230; logs
6454         various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6455 </p>
6456 </dd>
6457 <dt class="hdlist1">
6458 gitcvs.usecrlfattr
6459 </dt>
6460 <dd>
6461 <p>
6462         If true, the server will look up the end-of-line conversion
6463         attributes for files to determine the <code>-k</code> modes to use. If
6464         the attributes force Git to treat a file as text,
6465         the <code>-k</code> mode will be left blank so CVS clients will
6466         treat it as text. If they suppress text conversion, the file
6467         will be set with <em>-kb</em> mode, which suppresses any newline munging
6468         the client might otherwise do. If the attributes do not allow
6469         the file type to be determined, then <code>gitcvs.allBinary</code> is
6470         used. See <a href="gitattributes.html">gitattributes(5)</a>.
6471 </p>
6472 </dd>
6473 <dt class="hdlist1">
6474 gitcvs.allBinary
6475 </dt>
6476 <dd>
6477 <p>
6478         This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6479         the correct <em>-kb</em> mode to use. If true, all
6480         unresolved files are sent to the client in
6481         mode <em>-kb</em>. This causes the client to treat them
6482         as binary files, which suppresses any newline munging it
6483         otherwise might do. Alternatively, if it is set to "guess",
6484         then the contents of the file are examined to decide if
6485         it is binary, similar to <code>core.autocrlf</code>.
6486 </p>
6487 </dd>
6488 <dt class="hdlist1">
6489 gitcvs.dbName
6490 </dt>
6491 <dd>
6492 <p>
6493         Database used by git-cvsserver to cache revision information
6494         derived from the Git repository. The exact meaning depends on the
6495         used database driver, for SQLite (which is the default driver) this
6496         is a filename. Supports variable substitution (see
6497         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6498         Default: <em>%Ggitcvs.%m.sqlite</em>
6499 </p>
6500 </dd>
6501 <dt class="hdlist1">
6502 gitcvs.dbDriver
6503 </dt>
6504 <dd>
6505 <p>
6506         Used Perl DBI driver. You can specify any available driver
6507         for this here, but it might not work. git-cvsserver is tested
6508         with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6509         reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6510         May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6511         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6512 </p>
6513 </dd>
6514 <dt class="hdlist1">
6515 gitcvs.dbUser, gitcvs.dbPass
6516 </dt>
6517 <dd>
6518 <p>
6519         Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6520         since SQLite has no concept of database users and/or passwords.
6521         <em>gitcvs.dbUser</em> supports variable substitution (see
6522         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
6523 </p>
6524 </dd>
6525 <dt class="hdlist1">
6526 gitcvs.dbTableNamePrefix
6527 </dt>
6528 <dd>
6529 <p>
6530         Database table name prefix.  Prepended to the names of any
6531         database tables used, allowing a single database to be used
6532         for several repositories.  Supports variable substitution (see
6533         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
6534         characters will be replaced with underscores.
6535 </p>
6536 </dd>
6537 </dl></div>
6538 <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6539 <code>gitcvs.allBinary</code> can also be specified as
6540 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
6541 is one of "ext" and "pserver") to make them apply only for the given
6542 access method.</p></div>
6543 <div class="dlist"><dl>
6544 <dt class="hdlist1">
6545 gitweb.category
6546 </dt>
6547 <dt class="hdlist1">
6548 gitweb.description
6549 </dt>
6550 <dt class="hdlist1">
6551 gitweb.owner
6552 </dt>
6553 <dt class="hdlist1">
6554 gitweb.url
6555 </dt>
6556 <dd>
6557 <p>
6558         See <a href="gitweb.html">gitweb(1)</a> for description.
6559 </p>
6560 </dd>
6561 <dt class="hdlist1">
6562 gitweb.avatar
6563 </dt>
6564 <dt class="hdlist1">
6565 gitweb.blame
6566 </dt>
6567 <dt class="hdlist1">
6568 gitweb.grep
6569 </dt>
6570 <dt class="hdlist1">
6571 gitweb.highlight
6572 </dt>
6573 <dt class="hdlist1">
6574 gitweb.patches
6575 </dt>
6576 <dt class="hdlist1">
6577 gitweb.pickaxe
6578 </dt>
6579 <dt class="hdlist1">
6580 gitweb.remote_heads
6581 </dt>
6582 <dt class="hdlist1">
6583 gitweb.showSizes
6584 </dt>
6585 <dt class="hdlist1">
6586 gitweb.snapshot
6587 </dt>
6588 <dd>
6589 <p>
6590         See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
6591 </p>
6592 </dd>
6593 <dt class="hdlist1">
6594 gpg.program
6595 </dt>
6596 <dd>
6597 <p>
6598         Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
6599         making or verifying a PGP signature. The program must support the
6600         same command-line interface as GPG, namely, to verify a detached
6601         signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
6602         program is expected to signal a good signature by exiting with
6603         code 0.  To generate an ASCII-armored detached signature, the
6604         standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
6605         signed, and the program is expected to send the result to its
6606         standard output.
6607 </p>
6608 </dd>
6609 <dt class="hdlist1">
6610 gpg.format
6611 </dt>
6612 <dd>
6613 <p>
6614         Specifies which key format to use when signing with <code>--gpg-sign</code>.
6615         Default is "openpgp". Other possible values are "x509", "ssh".
6616 </p>
6617 <div class="paragraph"><p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
6618 based on the selected <code>gpg.format</code>.</p></div>
6619 </dd>
6620 <dt class="hdlist1">
6621 gpg.&lt;format&gt;.program
6622 </dt>
6623 <dd>
6624 <p>
6625         Use this to customize the program used for the signing format you
6626         chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
6627         be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
6628         value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".
6629 </p>
6630 </dd>
6631 <dt class="hdlist1">
6632 gpg.minTrustLevel
6633 </dt>
6634 <dd>
6635 <p>
6636         Specifies a minimum trust level for signature verification.  If
6637         this option is unset, then signature verification for merge
6638         operations requires a key with at least <code>marginal</code> trust.  Other
6639         operations that perform signature verification require a key
6640         with at least <code>undefined</code> trust.  Setting this option overrides
6641         the required trust-level for all operations.  Supported values,
6642         in increasing order of significance:
6643 </p>
6644 <div class="ulist"><ul>
6645 <li>
6646 <p>
6647 <code>undefined</code>
6648 </p>
6649 </li>
6650 <li>
6651 <p>
6652 <code>never</code>
6653 </p>
6654 </li>
6655 <li>
6656 <p>
6657 <code>marginal</code>
6658 </p>
6659 </li>
6660 <li>
6661 <p>
6662 <code>fully</code>
6663 </p>
6664 </li>
6665 <li>
6666 <p>
6667 <code>ultimate</code>
6668 </p>
6669 </li>
6670 </ul></div>
6671 </dd>
6672 <dt class="hdlist1">
6673 gpg.ssh.defaultKeyCommand
6674 </dt>
6675 <dd>
6676 <p>
6677         This command will be run when user.signingkey is not set and a ssh
6678         signature is requested. On successful exit a valid ssh public key
6679         prefixed with <code>key::</code> is expected in the first line of its output.
6680         This allows for a script doing a dynamic lookup of the correct public
6681         key when it is impractical to statically configure <code>user.signingKey</code>.
6682         For example when keys or SSH Certificates are rotated frequently or
6683         selection of the right key depends on external factors unknown to git.
6684 </p>
6685 </dd>
6686 <dt class="hdlist1">
6687 gpg.ssh.allowedSignersFile
6688 </dt>
6689 <dd>
6690 <p>
6691         A file containing ssh public keys which you are willing to trust.
6692         The file consists of one or more lines of principals followed by an ssh
6693         public key.
6694         e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
6695         See ssh-keygen(1) "ALLOWED SIGNERS" for details.
6696         The principal is only used to identify the key and is available when
6697         verifying a signature.
6698 </p>
6699 <div class="paragraph"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
6700 between valid signatures and trusted signatures the trust level of a signature
6701 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
6702 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
6703 <div class="paragraph"><p>This file can be set to a location outside of the repository and every developer
6704 maintains their own trust store. A central repository server could generate this
6705 file automatically from ssh keys with push access to verify the code against.
6706 In a corporate setting this file is probably generated at a global location
6707 from automation that already handles developer ssh keys.</p></div>
6708 <div class="paragraph"><p>A repository that only allows signed commits can store the file
6709 in the repository itself using a path relative to the top-level of the working tree.
6710 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
6711 <div class="paragraph"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
6712 valid-before options. Git will mark signatures as valid if the signing key was
6713 valid at the time of the signature&#8217;s creation. This allows users to change a
6714 signing key without invalidating all previously made signatures.</p></div>
6715 <div class="paragraph"><p>Using a SSH CA key with the cert-authority option
6716 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p></div>
6717 </dd>
6718 <dt class="hdlist1">
6719 gpg.ssh.revocationFile
6720 </dt>
6721 <dd>
6722 <p>
6723         Either a SSH KRL or a list of revoked public keys (without the principal prefix).
6724         See ssh-keygen(1) for details.
6725         If a public key is found in this file then it will always be treated
6726         as having trust level "never" and signatures will show as invalid.
6727 </p>
6728 </dd>
6729 <dt class="hdlist1">
6730 grep.lineNumber
6731 </dt>
6732 <dd>
6733 <p>
6734         If set to true, enable <code>-n</code> option by default.
6735 </p>
6736 </dd>
6737 <dt class="hdlist1">
6738 grep.column
6739 </dt>
6740 <dd>
6741 <p>
6742         If set to true, enable the <code>--column</code> option by default.
6743 </p>
6744 </dd>
6745 <dt class="hdlist1">
6746 grep.patternType
6747 </dt>
6748 <dd>
6749 <p>
6750         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
6751         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
6752         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
6753         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
6754         between <em>basic</em> and <em>extended</em>.
6755 </p>
6756 </dd>
6757 <dt class="hdlist1">
6758 grep.extendedRegexp
6759 </dt>
6760 <dd>
6761 <p>
6762         If set to true, enable <code>--extended-regexp</code> option by default. This
6763         option is ignored when the <code>grep.patternType</code> option is set to a value
6764         other than <em>default</em>.
6765 </p>
6766 </dd>
6767 <dt class="hdlist1">
6768 grep.threads
6769 </dt>
6770 <dd>
6771 <p>
6772         Number of grep worker threads to use. If unset (or set to 0), Git will
6773         use as many threads as the number of logical cores available.
6774 </p>
6775 </dd>
6776 <dt class="hdlist1">
6777 grep.fullName
6778 </dt>
6779 <dd>
6780 <p>
6781         If set to true, enable <code>--full-name</code> option by default.
6782 </p>
6783 </dd>
6784 <dt class="hdlist1">
6785 grep.fallbackToNoIndex
6786 </dt>
6787 <dd>
6788 <p>
6789         If set to true, fall back to git grep --no-index if git grep
6790         is executed outside of a git repository.  Defaults to false.
6791 </p>
6792 </dd>
6793 <dt class="hdlist1">
6794 gui.commitMsgWidth
6795 </dt>
6796 <dd>
6797 <p>
6798         Defines how wide the commit message window is in the
6799         <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
6800 </p>
6801 </dd>
6802 <dt class="hdlist1">
6803 gui.diffContext
6804 </dt>
6805 <dd>
6806 <p>
6807         Specifies how many context lines should be used in calls to diff
6808         made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
6809 </p>
6810 </dd>
6811 <dt class="hdlist1">
6812 gui.displayUntracked
6813 </dt>
6814 <dd>
6815 <p>
6816         Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
6817         in the file list. The default is "true".
6818 </p>
6819 </dd>
6820 <dt class="hdlist1">
6821 gui.encoding
6822 </dt>
6823 <dd>
6824 <p>
6825         Specifies the default character encoding to use for displaying of
6826         file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
6827         It can be overridden by setting the <em>encoding</em> attribute
6828         for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
6829         If this option is not set, the tools default to the
6830         locale encoding.
6831 </p>
6832 </dd>
6833 <dt class="hdlist1">
6834 gui.matchTrackingBranch
6835 </dt>
6836 <dd>
6837 <p>
6838         Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
6839         default to tracking remote branches with matching names or
6840         not. Default: "false".
6841 </p>
6842 </dd>
6843 <dt class="hdlist1">
6844 gui.newBranchTemplate
6845 </dt>
6846 <dd>
6847 <p>
6848         Is used as a suggested name when creating new branches using the
6849         <a href="git-gui.html">git-gui(1)</a>.
6850 </p>
6851 </dd>
6852 <dt class="hdlist1">
6853 gui.pruneDuringFetch
6854 </dt>
6855 <dd>
6856 <p>
6857         "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
6858         performing a fetch. The default value is "false".
6859 </p>
6860 </dd>
6861 <dt class="hdlist1">
6862 gui.trustmtime
6863 </dt>
6864 <dd>
6865 <p>
6866         Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
6867         timestamp or not. By default the timestamps are not trusted.
6868 </p>
6869 </dd>
6870 <dt class="hdlist1">
6871 gui.spellingDictionary
6872 </dt>
6873 <dd>
6874 <p>
6875         Specifies the dictionary used for spell checking commit messages in
6876         the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
6877         off.
6878 </p>
6879 </dd>
6880 <dt class="hdlist1">
6881 gui.fastCopyBlame
6882 </dt>
6883 <dd>
6884 <p>
6885         If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
6886         location detection. It makes blame significantly faster on huge
6887         repositories at the expense of less thorough copy detection.
6888 </p>
6889 </dd>
6890 <dt class="hdlist1">
6891 gui.copyBlameThreshold
6892 </dt>
6893 <dd>
6894 <p>
6895         Specifies the threshold to use in <em>git gui blame</em> original location
6896         detection, measured in alphanumeric characters. See the
6897         <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
6898 </p>
6899 </dd>
6900 <dt class="hdlist1">
6901 gui.blamehistoryctx
6902 </dt>
6903 <dd>
6904 <p>
6905         Specifies the radius of history context in days to show in
6906         <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
6907         Context</code> menu item is invoked from <em>git gui blame</em>. If this
6908         variable is set to zero, the whole history is shown.
6909 </p>
6910 </dd>
6911 <dt class="hdlist1">
6912 guitool.&lt;name&gt;.cmd
6913 </dt>
6914 <dd>
6915 <p>
6916         Specifies the shell command line to execute when the corresponding item
6917         of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
6918         mandatory for every tool. The command is executed from the root of
6919         the working directory, and in the environment it receives the name of
6920         the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
6921         <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
6922         the head is detached, <em>CUR_BRANCH</em> is empty).
6923 </p>
6924 </dd>
6925 <dt class="hdlist1">
6926 guitool.&lt;name&gt;.needsFile
6927 </dt>
6928 <dd>
6929 <p>
6930         Run the tool only if a diff is selected in the GUI. It guarantees
6931         that <em>FILENAME</em> is not empty.
6932 </p>
6933 </dd>
6934 <dt class="hdlist1">
6935 guitool.&lt;name&gt;.noConsole
6936 </dt>
6937 <dd>
6938 <p>
6939         Run the command silently, without creating a window to display its
6940         output.
6941 </p>
6942 </dd>
6943 <dt class="hdlist1">
6944 guitool.&lt;name&gt;.noRescan
6945 </dt>
6946 <dd>
6947 <p>
6948         Don&#8217;t rescan the working directory for changes after the tool
6949         finishes execution.
6950 </p>
6951 </dd>
6952 <dt class="hdlist1">
6953 guitool.&lt;name&gt;.confirm
6954 </dt>
6955 <dd>
6956 <p>
6957         Show a confirmation dialog before actually running the tool.
6958 </p>
6959 </dd>
6960 <dt class="hdlist1">
6961 guitool.&lt;name&gt;.argPrompt
6962 </dt>
6963 <dd>
6964 <p>
6965         Request a string argument from the user, and pass it to the tool
6966         through the <code>ARGS</code> environment variable. Since requesting an
6967         argument implies confirmation, the <em>confirm</em> option has no effect
6968         if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
6969         the dialog uses a built-in generic prompt; otherwise the exact
6970         value of the variable is used.
6971 </p>
6972 </dd>
6973 <dt class="hdlist1">
6974 guitool.&lt;name&gt;.revPrompt
6975 </dt>
6976 <dd>
6977 <p>
6978         Request a single valid revision from the user, and set the
6979         <code>REVISION</code> environment variable. In other aspects this option
6980         is similar to <em>argPrompt</em>, and can be used together with it.
6981 </p>
6982 </dd>
6983 <dt class="hdlist1">
6984 guitool.&lt;name&gt;.revUnmerged
6985 </dt>
6986 <dd>
6987 <p>
6988         Show only unmerged branches in the <em>revPrompt</em> subdialog.
6989         This is useful for tools similar to merge or rebase, but not
6990         for things like checkout or reset.
6991 </p>
6992 </dd>
6993 <dt class="hdlist1">
6994 guitool.&lt;name&gt;.title
6995 </dt>
6996 <dd>
6997 <p>
6998         Specifies the title to use for the prompt dialog. The default
6999         is the tool name.
7000 </p>
7001 </dd>
7002 <dt class="hdlist1">
7003 guitool.&lt;name&gt;.prompt
7004 </dt>
7005 <dd>
7006 <p>
7007         Specifies the general prompt string to display at the top of
7008         the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
7009         The default value includes the actual command.
7010 </p>
7011 </dd>
7012 <dt class="hdlist1">
7013 help.browser
7014 </dt>
7015 <dd>
7016 <p>
7017         Specify the browser that will be used to display help in the
7018         <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
7019 </p>
7020 </dd>
7021 <dt class="hdlist1">
7022 help.format
7023 </dt>
7024 <dd>
7025 <p>
7026         Override the default help format used by <a href="git-help.html">git-help(1)</a>.
7027         Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
7028         the default. <em>web</em> and <em>html</em> are the same.
7029 </p>
7030 </dd>
7031 <dt class="hdlist1">
7032 help.autoCorrect
7033 </dt>
7034 <dd>
7035 <p>
7036         If git detects typos and can identify exactly one valid command similar
7037         to the error, git will try to suggest the correct command or even
7038         run the suggestion automatically. Possible config values are:
7039 </p>
7040 <div class="ulist"><ul>
7041 <li>
7042 <p>
7043 0 (default): show the suggested command.
7044 </p>
7045 </li>
7046 <li>
7047 <p>
7048 positive number: run the suggested command after specified
7049 deciseconds (0.1 sec).
7050 </p>
7051 </li>
7052 <li>
7053 <p>
7054 "immediate": run the suggested command immediately.
7055 </p>
7056 </li>
7057 <li>
7058 <p>
7059 "prompt": show the suggestion and prompt for confirmation to run
7060 the command.
7061 </p>
7062 </li>
7063 <li>
7064 <p>
7065 "never": don&#8217;t run or show any suggested command.
7066 </p>
7067 </li>
7068 </ul></div>
7069 </dd>
7070 <dt class="hdlist1">
7071 help.htmlPath
7072 </dt>
7073 <dd>
7074 <p>
7075         Specify the path where the HTML documentation resides. File system paths
7076         and URLs are supported. HTML pages will be prefixed with this path when
7077         help is displayed in the <em>web</em> format. This defaults to the documentation
7078         path of your Git installation.
7079 </p>
7080 </dd>
7081 <dt class="hdlist1">
7082 http.proxy
7083 </dt>
7084 <dd>
7085 <p>
7086         Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
7087         <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
7088         addition to the syntax understood by curl, it is possible to specify a
7089         proxy string with a user name but no password, in which case git will
7090         attempt to acquire one in the same way it does for other credentials. See
7091         <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
7092         <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
7093         on a per-remote basis; see remote.&lt;name&gt;.proxy
7094 </p>
7095 </dd>
7096 <dt class="hdlist1">
7097 http.proxyAuthMethod
7098 </dt>
7099 <dd>
7100 <p>
7101         Set the method with which to authenticate against the HTTP proxy. This
7102         only takes effect if the configured proxy string contains a user name part
7103         (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
7104         overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
7105         Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
7106         variable.  Possible values are:
7107 </p>
7108 <div class="openblock">
7109 <div class="content">
7110 <div class="ulist"><ul>
7111 <li>
7112 <p>
7113 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
7114   assumed that the proxy answers an unauthenticated request with a 407
7115   status code and one or more Proxy-authenticate headers with supported
7116   authentication methods. This is the default.
7117 </p>
7118 </li>
7119 <li>
7120 <p>
7121 <code>basic</code> - HTTP Basic authentication
7122 </p>
7123 </li>
7124 <li>
7125 <p>
7126 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
7127   transmitted to the proxy in clear text
7128 </p>
7129 </li>
7130 <li>
7131 <p>
7132 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7133   of <code>curl(1)</code>)
7134 </p>
7135 </li>
7136 <li>
7137 <p>
7138 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7139 </p>
7140 </li>
7141 </ul></div>
7142 </div></div>
7143 </dd>
7144 <dt class="hdlist1">
7145 http.proxySSLCert
7146 </dt>
7147 <dd>
7148 <p>
7149         The pathname of a file that stores a client certificate to use to authenticate
7150         with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7151         variable.
7152 </p>
7153 </dd>
7154 <dt class="hdlist1">
7155 http.proxySSLKey
7156 </dt>
7157 <dd>
7158 <p>
7159         The pathname of a file that stores a private key to use to authenticate with
7160         an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7161         variable.
7162 </p>
7163 </dd>
7164 <dt class="hdlist1">
7165 http.proxySSLCertPasswordProtected
7166 </dt>
7167 <dd>
7168 <p>
7169         Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
7170         will prompt the user, possibly many times, if the certificate or private key
7171         is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7172         environment variable.
7173 </p>
7174 </dd>
7175 <dt class="hdlist1">
7176 http.proxySSLCAInfo
7177 </dt>
7178 <dd>
7179 <p>
7180         Pathname to the file containing the certificate bundle that should be used to
7181         verify the proxy with when using an HTTPS proxy. Can be overridden by the
7182         <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7183 </p>
7184 </dd>
7185 <dt class="hdlist1">
7186 http.emptyAuth
7187 </dt>
7188 <dd>
7189 <p>
7190         Attempt authentication without seeking a username or password.  This
7191         can be used to attempt GSS-Negotiate authentication without specifying
7192         a username in the URL, as libcurl normally requires a username for
7193         authentication.
7194 </p>
7195 </dd>
7196 <dt class="hdlist1">
7197 http.delegation
7198 </dt>
7199 <dd>
7200 <p>
7201         Control GSSAPI credential delegation. The delegation is disabled
7202         by default in libcurl since version 7.21.7. Set parameter to tell
7203         the server what it is allowed to delegate when it comes to user
7204         credentials. Used with GSS/kerberos. Possible values are:
7205 </p>
7206 <div class="openblock">
7207 <div class="content">
7208 <div class="ulist"><ul>
7209 <li>
7210 <p>
7211 <code>none</code> - Don&#8217;t allow any delegation.
7212 </p>
7213 </li>
7214 <li>
7215 <p>
7216 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7217   Kerberos service ticket, which is a matter of realm policy.
7218 </p>
7219 </li>
7220 <li>
7221 <p>
7222 <code>always</code> - Unconditionally allow the server to delegate.
7223 </p>
7224 </li>
7225 </ul></div>
7226 </div></div>
7227 </dd>
7228 <dt class="hdlist1">
7229 http.extraHeader
7230 </dt>
7231 <dd>
7232 <p>
7233         Pass an additional HTTP header when communicating with a server.  If
7234         more than one such entry exists, all of them are added as extra
7235         headers.  To allow overriding the settings inherited from the system
7236         config, an empty value will reset the extra headers to the empty list.
7237 </p>
7238 </dd>
7239 <dt class="hdlist1">
7240 http.cookieFile
7241 </dt>
7242 <dd>
7243 <p>
7244         The pathname of a file containing previously stored cookie lines,
7245         which should be used
7246         in the Git http session, if they match the server. The file format
7247         of the file to read cookies from should be plain HTTP headers or
7248         the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7249         NOTE that the file specified with http.cookieFile is used only as
7250         input unless http.saveCookies is set.
7251 </p>
7252 </dd>
7253 <dt class="hdlist1">
7254 http.saveCookies
7255 </dt>
7256 <dd>
7257 <p>
7258         If set, store cookies received during requests to the file specified by
7259         http.cookieFile. Has no effect if http.cookieFile is unset.
7260 </p>
7261 </dd>
7262 <dt class="hdlist1">
7263 http.version
7264 </dt>
7265 <dd>
7266 <p>
7267         Use the specified HTTP protocol version when communicating with a server.
7268         If you want to force the default. The available and default version depend
7269         on libcurl. Currently the possible values of
7270         this option are:
7271 </p>
7272 <div class="ulist"><ul>
7273 <li>
7274 <p>
7275 HTTP/2
7276 </p>
7277 </li>
7278 <li>
7279 <p>
7280 HTTP/1.1
7281 </p>
7282 </li>
7283 </ul></div>
7284 </dd>
7285 <dt class="hdlist1">
7286 http.curloptResolve
7287 </dt>
7288 <dd>
7289 <p>
7290         Hostname resolution information that will be used first by
7291         libcurl when sending HTTP requests.  This information should
7292         be in one of the following formats:
7293 </p>
7294 <div class="ulist"><ul>
7295 <li>
7296 <p>
7297 [+]HOST:PORT:ADDRESS[,ADDRESS]
7298 </p>
7299 </li>
7300 <li>
7301 <p>
7302 -HOST:PORT
7303 </p>
7304 </li>
7305 </ul></div>
7306 <div class="paragraph"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7307 to the provided <code>ADDRESS</code>(s). The second format clears all
7308 previous config values for that <code>HOST:PORT</code> combination.  To
7309 allow easy overriding of all the settings inherited from the
7310 system config, an empty value will reset all resolution
7311 information to the empty list.</p></div>
7312 </dd>
7313 <dt class="hdlist1">
7314 http.sslVersion
7315 </dt>
7316 <dd>
7317 <p>
7318         The SSL version to use when negotiating an SSL connection, if you
7319         want to force the default.  The available and default version
7320         depend on whether libcurl was built against NSS or OpenSSL and the
7321         particular configuration of the crypto library in use. Internally
7322         this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7323         documentation for more details on the format of this option and
7324         for the ssl version supported. Currently the possible values of
7325         this option are:
7326 </p>
7327 <div class="ulist"><ul>
7328 <li>
7329 <p>
7330 sslv2
7331 </p>
7332 </li>
7333 <li>
7334 <p>
7335 sslv3
7336 </p>
7337 </li>
7338 <li>
7339 <p>
7340 tlsv1
7341 </p>
7342 </li>
7343 <li>
7344 <p>
7345 tlsv1.0
7346 </p>
7347 </li>
7348 <li>
7349 <p>
7350 tlsv1.1
7351 </p>
7352 </li>
7353 <li>
7354 <p>
7355 tlsv1.2
7356 </p>
7357 </li>
7358 <li>
7359 <p>
7360 tlsv1.3
7361 </p>
7362 </li>
7363 </ul></div>
7364 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7365 To force git to use libcurl&#8217;s default ssl version and ignore any
7366 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7367 empty string.</p></div>
7368 </dd>
7369 <dt class="hdlist1">
7370 http.sslCipherList
7371 </dt>
7372 <dd>
7373 <p>
7374   A list of SSL ciphers to use when negotiating an SSL connection.
7375   The available ciphers depend on whether libcurl was built against
7376   NSS or OpenSSL and the particular configuration of the crypto
7377   library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7378   option; see the libcurl documentation for more details on the format
7379   of this list.
7380 </p>
7381 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7382 To force git to use libcurl&#8217;s default cipher list and ignore any
7383 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7384 empty string.</p></div>
7385 </dd>
7386 <dt class="hdlist1">
7387 http.sslVerify
7388 </dt>
7389 <dd>
7390 <p>
7391         Whether to verify the SSL certificate when fetching or pushing
7392         over HTTPS. Defaults to true. Can be overridden by the
7393         <code>GIT_SSL_NO_VERIFY</code> environment variable.
7394 </p>
7395 </dd>
7396 <dt class="hdlist1">
7397 http.sslCert
7398 </dt>
7399 <dd>
7400 <p>
7401         File containing the SSL certificate when fetching or pushing
7402         over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7403         variable.
7404 </p>
7405 </dd>
7406 <dt class="hdlist1">
7407 http.sslKey
7408 </dt>
7409 <dd>
7410 <p>
7411         File containing the SSL private key when fetching or pushing
7412         over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7413         variable.
7414 </p>
7415 </dd>
7416 <dt class="hdlist1">
7417 http.sslCertPasswordProtected
7418 </dt>
7419 <dd>
7420 <p>
7421         Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
7422         OpenSSL will prompt the user, possibly many times, if the
7423         certificate or private key is encrypted.  Can be overridden by the
7424         <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7425 </p>
7426 </dd>
7427 <dt class="hdlist1">
7428 http.sslCAInfo
7429 </dt>
7430 <dd>
7431 <p>
7432         File containing the certificates to verify the peer with when
7433         fetching or pushing over HTTPS. Can be overridden by the
7434         <code>GIT_SSL_CAINFO</code> environment variable.
7435 </p>
7436 </dd>
7437 <dt class="hdlist1">
7438 http.sslCAPath
7439 </dt>
7440 <dd>
7441 <p>
7442         Path containing files with the CA certificates to verify the peer
7443         with when fetching or pushing over HTTPS. Can be overridden
7444         by the <code>GIT_SSL_CAPATH</code> environment variable.
7445 </p>
7446 </dd>
7447 <dt class="hdlist1">
7448 http.sslBackend
7449 </dt>
7450 <dd>
7451 <p>
7452         Name of the SSL backend to use (e.g. "openssl" or "schannel").
7453         This option is ignored if cURL lacks support for choosing the SSL
7454         backend at runtime.
7455 </p>
7456 </dd>
7457 <dt class="hdlist1">
7458 http.schannelCheckRevoke
7459 </dt>
7460 <dd>
7461 <p>
7462         Used to enforce or disable certificate revocation checks in cURL
7463         when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
7464         unset. Only necessary to disable this if Git consistently errors
7465         and the message is about checking the revocation status of a
7466         certificate. This option is ignored if cURL lacks support for
7467         setting the relevant SSL option at runtime.
7468 </p>
7469 </dd>
7470 <dt class="hdlist1">
7471 http.schannelUseSSLCAInfo
7472 </dt>
7473 <dd>
7474 <p>
7475         As of cURL v7.60.0, the Secure Channel backend can use the
7476         certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7477         override the Windows Certificate Store. Since this is not desirable
7478         by default, Git will tell cURL not to use that bundle by default
7479         when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7480         unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7481 </p>
7482 </dd>
7483 <dt class="hdlist1">
7484 http.pinnedPubkey
7485 </dt>
7486 <dd>
7487 <p>
7488         Public key of the https service. It may either be the filename of
7489         a PEM or DER encoded public key file or a string starting with
7490         <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7491         public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7492         exit with an error if this option is set but not supported by
7493         cURL.
7494 </p>
7495 </dd>
7496 <dt class="hdlist1">
7497 http.sslTry
7498 </dt>
7499 <dd>
7500 <p>
7501         Attempt to use AUTH SSL/TLS and encrypted data transfers
7502         when connecting via regular FTP protocol. This might be needed
7503         if the FTP server requires it for security reasons or you wish
7504         to connect securely whenever remote FTP server supports it.
7505         Default is false since it might trigger certificate verification
7506         errors on misconfigured servers.
7507 </p>
7508 </dd>
7509 <dt class="hdlist1">
7510 http.maxRequests
7511 </dt>
7512 <dd>
7513 <p>
7514         How many HTTP requests to launch in parallel. Can be overridden
7515         by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7516 </p>
7517 </dd>
7518 <dt class="hdlist1">
7519 http.minSessions
7520 </dt>
7521 <dd>
7522 <p>
7523         The number of curl sessions (counted across slots) to be kept across
7524         requests. They will not be ended with curl_easy_cleanup() until
7525         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7526         value will be capped at 1. Defaults to 1.
7527 </p>
7528 </dd>
7529 <dt class="hdlist1">
7530 http.postBuffer
7531 </dt>
7532 <dd>
7533 <p>
7534         Maximum size in bytes of the buffer used by smart HTTP
7535         transports when POSTing data to the remote system.
7536         For requests larger than this buffer size, HTTP/1.1 and
7537         Transfer-Encoding: chunked is used to avoid creating a
7538         massive pack file locally.  Default is 1 MiB, which is
7539         sufficient for most requests.
7540 </p>
7541 <div class="paragraph"><p>Note that raising this limit is only effective for disabling chunked
7542 transfer encoding and therefore should be used only where the remote
7543 server or a proxy only supports HTTP/1.0 or is noncompliant with the
7544 HTTP standard.  Raising this is not, in general, an effective solution
7545 for most push problems, but can increase memory consumption
7546 significantly since the entire buffer is allocated even for small
7547 pushes.</p></div>
7548 </dd>
7549 <dt class="hdlist1">
7550 http.lowSpeedLimit, http.lowSpeedTime
7551 </dt>
7552 <dd>
7553 <p>
7554         If the HTTP transfer speed, in bytes per second, is less than
7555         <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
7556         the transfer is aborted.
7557         Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
7558         <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
7559 </p>
7560 </dd>
7561 <dt class="hdlist1">
7562 http.noEPSV
7563 </dt>
7564 <dd>
7565 <p>
7566         A boolean which disables using of EPSV ftp command by curl.
7567         This can be helpful with some "poor" ftp servers which don&#8217;t
7568         support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
7569         environment variable. Default is false (curl will use EPSV).
7570 </p>
7571 </dd>
7572 <dt class="hdlist1">
7573 http.userAgent
7574 </dt>
7575 <dd>
7576 <p>
7577         The HTTP USER_AGENT string presented to an HTTP server.  The default
7578         value represents the version of the Git client such as git/1.7.1.
7579         This option allows you to override this value to a more common value
7580         such as Mozilla/4.0.  This may be necessary, for instance, if
7581         connecting through a firewall that restricts HTTP connections to a set
7582         of common USER_AGENT strings (but not including those like git/1.7.1).
7583         Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
7584 </p>
7585 </dd>
7586 <dt class="hdlist1">
7587 http.followRedirects
7588 </dt>
7589 <dd>
7590 <p>
7591         Whether git should follow HTTP redirects. If set to <code>true</code>, git
7592         will transparently follow any redirect issued by a server it
7593         encounters. If set to <code>false</code>, git will treat all redirects as
7594         errors. If set to <code>initial</code>, git will follow redirects only for
7595         the initial request to a remote, but not for subsequent
7596         follow-up HTTP requests. Since git uses the redirected URL as
7597         the base for the follow-up requests, this is generally
7598         sufficient. The default is <code>initial</code>.
7599 </p>
7600 </dd>
7601 <dt class="hdlist1">
7602 http.&lt;url&gt;.*
7603 </dt>
7604 <dd>
7605 <p>
7606         Any of the http.* options above can be applied selectively to some URLs.
7607         For a config key to match a URL, each element of the config key is
7608         compared to that of the URL, in the following order:
7609 </p>
7610 <div class="openblock">
7611 <div class="content">
7612 <div class="olist arabic"><ol class="arabic">
7613 <li>
7614 <p>
7615 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
7616   must match exactly between the config key and the URL.
7617 </p>
7618 </li>
7619 <li>
7620 <p>
7621 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
7622   This field must match between the config key and the URL. It is
7623   possible to specify a <code>*</code> as part of the host name to match all subdomains
7624   at this level. <code>https://*.example.com/</code> for example would match
7625   <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
7626 </p>
7627 </li>
7628 <li>
7629 <p>
7630 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
7631   This field must match exactly between the config key and the URL.
7632   Omitted port numbers are automatically converted to the correct
7633   default for the scheme before matching.
7634 </p>
7635 </li>
7636 <li>
7637 <p>
7638 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
7639   path field of the config key must match the path field of the URL
7640   either exactly or as a prefix of slash-delimited path elements.  This means
7641   a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
7642   match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
7643   key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
7644   key with just path <code>foo/</code>).
7645 </p>
7646 </li>
7647 <li>
7648 <p>
7649 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
7650   the config key has a user name it must match the user name in the
7651   URL exactly. If the config key does not have a user name, that
7652   config key will match a URL with any user name (including none),
7653   but at a lower precedence than a config key with a user name.
7654 </p>
7655 </li>
7656 </ol></div>
7657 </div></div>
7658 <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
7659 a config key&#8217;s path is preferred to one that matches its user name. For example,
7660 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
7661 <code>https://example.com/foo</code> will be preferred over a config key match of
7662 <code>https://user@example.com</code>.</p></div>
7663 <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
7664 if embedded in the URL, is always ignored for matching purposes) so that
7665 equivalent URLs that are simply spelled differently will match properly.
7666 Environment variable settings always override any matches.  The URLs that are
7667 matched against are those given directly to Git commands.  This means any URLs
7668 visited as a result of a redirection do not participate in matching.</p></div>
7669 </dd>
7670 <dt class="hdlist1">
7671 i18n.commitEncoding
7672 </dt>
7673 <dd>
7674 <p>
7675         Character encoding the commit messages are stored in; Git itself
7676         does not care per se, but this information is necessary e.g. when
7677         importing commits from emails or in the gitk graphical history
7678         browser (and possibly in other places in the future or in other
7679         porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
7680 </p>
7681 </dd>
7682 <dt class="hdlist1">
7683 i18n.logOutputEncoding
7684 </dt>
7685 <dd>
7686 <p>
7687         Character encoding the commit messages are converted to when
7688         running <em>git log</em> and friends.
7689 </p>
7690 </dd>
7691 <dt class="hdlist1">
7692 imap.folder
7693 </dt>
7694 <dd>
7695 <p>
7696         The folder to drop the mails into, which is typically the Drafts
7697         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
7698         "[Gmail]/Drafts". Required.
7699 </p>
7700 </dd>
7701 <dt class="hdlist1">
7702 imap.tunnel
7703 </dt>
7704 <dd>
7705 <p>
7706         Command used to set up a tunnel to the IMAP server through which
7707         commands will be piped instead of using a direct network connection
7708         to the server. Required when imap.host is not set.
7709 </p>
7710 </dd>
7711 <dt class="hdlist1">
7712 imap.host
7713 </dt>
7714 <dd>
7715 <p>
7716         A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
7717         connections and an <code>imaps://</code> prefix for secure connections.
7718         Ignored when imap.tunnel is set, but required otherwise.
7719 </p>
7720 </dd>
7721 <dt class="hdlist1">
7722 imap.user
7723 </dt>
7724 <dd>
7725 <p>
7726         The username to use when logging in to the server.
7727 </p>
7728 </dd>
7729 <dt class="hdlist1">
7730 imap.pass
7731 </dt>
7732 <dd>
7733 <p>
7734         The password to use when logging in to the server.
7735 </p>
7736 </dd>
7737 <dt class="hdlist1">
7738 imap.port
7739 </dt>
7740 <dd>
7741 <p>
7742         An integer port number to connect to on the server.
7743         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
7744         Ignored when imap.tunnel is set.
7745 </p>
7746 </dd>
7747 <dt class="hdlist1">
7748 imap.sslverify
7749 </dt>
7750 <dd>
7751 <p>
7752         A boolean to enable/disable verification of the server certificate
7753         used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
7754         imap.tunnel is set.
7755 </p>
7756 </dd>
7757 <dt class="hdlist1">
7758 imap.preformattedHTML
7759 </dt>
7760 <dd>
7761 <p>
7762         A boolean to enable/disable the use of html encoding when sending
7763         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
7764         and have a content type of text/html.  Ironically, enabling this
7765         option causes Thunderbird to send the patch as a plain/text,
7766         format=fixed email.  Default is <code>false</code>.
7767 </p>
7768 </dd>
7769 <dt class="hdlist1">
7770 imap.authMethod
7771 </dt>
7772 <dd>
7773 <p>
7774         Specify the authentication method for authenticating with the IMAP server.
7775         If Git was built with the NO_CURL option, or if your curl version is older
7776         than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
7777         option, the only supported method is <em>CRAM-MD5</em>. If this is not set
7778         then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
7779 </p>
7780 </dd>
7781 <dt class="hdlist1">
7782 include.path
7783 </dt>
7784 <dt class="hdlist1">
7785 includeIf.&lt;condition&gt;.path
7786 </dt>
7787 <dd>
7788 <p>
7789         Special variables to include other configuration files. See
7790         the "CONFIGURATION FILE" section in the main
7791         <a href="git-config.html">git-config(1)</a> documentation,
7792         specifically the "Includes" and "Conditional Includes" subsections.
7793 </p>
7794 </dd>
7795 <dt class="hdlist1">
7796 index.recordEndOfIndexEntries
7797 </dt>
7798 <dd>
7799 <p>
7800         Specifies whether the index file should include an "End Of Index
7801         Entry" section. This reduces index load time on multiprocessor
7802         machines but produces a message "ignoring EOIE extension" when
7803         reading the index using Git versions before 2.20. Defaults to
7804         <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
7805         otherwise.
7806 </p>
7807 </dd>
7808 <dt class="hdlist1">
7809 index.recordOffsetTable
7810 </dt>
7811 <dd>
7812 <p>
7813         Specifies whether the index file should include an "Index Entry
7814         Offset Table" section. This reduces index load time on
7815         multiprocessor machines but produces a message "ignoring IEOT
7816         extension" when reading the index using Git versions before 2.20.
7817         Defaults to <em>true</em> if index.threads has been explicitly enabled,
7818         <em>false</em> otherwise.
7819 </p>
7820 </dd>
7821 <dt class="hdlist1">
7822 index.sparse
7823 </dt>
7824 <dd>
7825 <p>
7826         When enabled, write the index using sparse-directory entries. This
7827         has no effect unless <code>core.sparseCheckout</code> and
7828         <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
7829 </p>
7830 </dd>
7831 <dt class="hdlist1">
7832 index.threads
7833 </dt>
7834 <dd>
7835 <p>
7836         Specifies the number of threads to spawn when loading the index.
7837         This is meant to reduce index load time on multiprocessor machines.
7838         Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
7839         CPUs and set the number of threads accordingly. Specifying 1 or
7840         <em>false</em> will disable multithreading. Defaults to <em>true</em>.
7841 </p>
7842 </dd>
7843 <dt class="hdlist1">
7844 index.version
7845 </dt>
7846 <dd>
7847 <p>
7848         Specify the version with which new index files should be
7849         initialized.  This does not affect existing repositories.
7850         If <code>feature.manyFiles</code> is enabled, then the default is 4.
7851 </p>
7852 </dd>
7853 <dt class="hdlist1">
7854 index.skipHash
7855 </dt>
7856 <dd>
7857 <p>
7858         When enabled, do not compute the trailing hash for the index file.
7859         This accelerates Git commands that manipulate the index, such as
7860         <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
7861         checksum, write a trailing set of bytes with value zero, indicating
7862         that the computation was skipped.
7863 </p>
7864 <div class="paragraph"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
7865 refuse to parse the index and Git clients older than 2.40.0 will report an
7866 error during <code>git fsck</code>.</p></div>
7867 </dd>
7868 </dl></div>
7869 <div class="dlist"><dl>
7870 <dt class="hdlist1">
7871 init.templateDir
7872 </dt>
7873 <dd>
7874 <p>
7875         Specify the directory from which templates will be copied. (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
7876 </p>
7877 </dd>
7878 <dt class="hdlist1">
7879 init.defaultBranch
7880 </dt>
7881 <dd>
7882 <p>
7883         Allows overriding the default branch name e.g. when initializing
7884         a new repository.
7885 </p>
7886 </dd>
7887 <dt class="hdlist1">
7888 instaweb.browser
7889 </dt>
7890 <dd>
7891 <p>
7892         Specify the program that will be used to browse your working
7893         repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7894 </p>
7895 </dd>
7896 <dt class="hdlist1">
7897 instaweb.httpd
7898 </dt>
7899 <dd>
7900 <p>
7901         The HTTP daemon command-line to start gitweb on your working
7902         repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7903 </p>
7904 </dd>
7905 <dt class="hdlist1">
7906 instaweb.local
7907 </dt>
7908 <dd>
7909 <p>
7910         If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
7911         be bound to the local IP (127.0.0.1).
7912 </p>
7913 </dd>
7914 <dt class="hdlist1">
7915 instaweb.modulePath
7916 </dt>
7917 <dd>
7918 <p>
7919         The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
7920         instead of /usr/lib/apache2/modules.  Only used if httpd
7921         is Apache.
7922 </p>
7923 </dd>
7924 <dt class="hdlist1">
7925 instaweb.port
7926 </dt>
7927 <dd>
7928 <p>
7929         The port number to bind the gitweb httpd to. See
7930         <a href="git-instaweb.html">git-instaweb(1)</a>.
7931 </p>
7932 </dd>
7933 <dt class="hdlist1">
7934 interactive.singleKey
7935 </dt>
7936 <dd>
7937 <p>
7938         In interactive commands, allow the user to provide one-letter
7939         input with a single key (i.e., without hitting enter).
7940         Currently this is used by the <code>--patch</code> mode of
7941         <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
7942         <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
7943         <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>.
7944 </p>
7945 </dd>
7946 <dt class="hdlist1">
7947 interactive.diffFilter
7948 </dt>
7949 <dd>
7950 <p>
7951         When an interactive command (such as <code>git add --patch</code>) shows
7952         a colorized diff, git will pipe the diff through the shell
7953         command defined by this configuration variable. The command may
7954         mark up the diff further for human consumption, provided that it
7955         retains a one-to-one correspondence with the lines in the
7956         original diff. Defaults to disabled (no filtering).
7957 </p>
7958 </dd>
7959 <dt class="hdlist1">
7960 log.abbrevCommit
7961 </dt>
7962 <dd>
7963 <p>
7964         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
7965         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
7966         override this option with <code>--no-abbrev-commit</code>.
7967 </p>
7968 </dd>
7969 <dt class="hdlist1">
7970 log.date
7971 </dt>
7972 <dd>
7973 <p>
7974         Set the default date-time mode for the <em>log</em> command.
7975         Setting a value for log.date is similar to using <em>git log</em>'s
7976         <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.
7977 </p>
7978 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
7979 "foo" will be used for the date format. Otherwise, "default" will
7980 be used.</p></div>
7981 </dd>
7982 <dt class="hdlist1">
7983 log.decorate
7984 </dt>
7985 <dd>
7986 <p>
7987         Print out the ref names of any commits that are shown by the log
7988         command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
7989         <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
7990         specified, the full ref name (including prefix) will be printed.
7991         If <em>auto</em> is specified, then if the output is going to a terminal,
7992         the ref names are shown as if <em>short</em> were given, otherwise no ref
7993         names are shown. This is the same as the <code>--decorate</code> option
7994         of the <code>git log</code>.
7995 </p>
7996 </dd>
7997 <dt class="hdlist1">
7998 log.initialDecorationSet
7999 </dt>
8000 <dd>
8001 <p>
8002         By default, <code>git log</code> only shows decorations for certain known ref
8003         namespaces. If <em>all</em> is specified, then show all refs as
8004         decorations.
8005 </p>
8006 </dd>
8007 <dt class="hdlist1">
8008 log.excludeDecoration
8009 </dt>
8010 <dd>
8011 <p>
8012         Exclude the specified patterns from the log decorations. This is
8013         similar to the <code>--decorate-refs-exclude</code> command-line option, but
8014         the config option can be overridden by the <code>--decorate-refs</code>
8015         option.
8016 </p>
8017 </dd>
8018 <dt class="hdlist1">
8019 log.diffMerges
8020 </dt>
8021 <dd>
8022 <p>
8023         Set diff format to be used when <code>--diff-merges=on</code> is
8024         specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
8025         details. Defaults to <code>separate</code>.
8026 </p>
8027 </dd>
8028 <dt class="hdlist1">
8029 log.follow
8030 </dt>
8031 <dd>
8032 <p>
8033         If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
8034         a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
8035         i.e. it cannot be used to follow multiple files and does not work well
8036         on non-linear history.
8037 </p>
8038 </dd>
8039 <dt class="hdlist1">
8040 log.graphColors
8041 </dt>
8042 <dd>
8043 <p>
8044         A list of colors, separated by commas, that can be used to draw
8045         history lines in <code>git log --graph</code>.
8046 </p>
8047 </dd>
8048 <dt class="hdlist1">
8049 log.showRoot
8050 </dt>
8051 <dd>
8052 <p>
8053         If true, the initial commit will be shown as a big creation event.
8054         This is equivalent to a diff against an empty tree.
8055         Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
8056         normally hide the root commit will now show it. True by default.
8057 </p>
8058 </dd>
8059 <dt class="hdlist1">
8060 log.showSignature
8061 </dt>
8062 <dd>
8063 <p>
8064         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8065         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
8066 </p>
8067 </dd>
8068 <dt class="hdlist1">
8069 log.mailmap
8070 </dt>
8071 <dd>
8072 <p>
8073         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8074         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
8075         assume <code>--no-use-mailmap</code>. True by default.
8076 </p>
8077 </dd>
8078 <dt class="hdlist1">
8079 lsrefs.unborn
8080 </dt>
8081 <dd>
8082 <p>
8083         May be "advertise" (the default), "allow", or "ignore". If "advertise",
8084         the server will respond to the client sending "unborn" (as described in
8085         <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
8086         protocol v2 capability advertisement. "allow" is the same as
8087         "advertise" except that the server will not advertise support for this
8088         feature; this is useful for load-balanced servers that cannot be
8089         updated atomically (for example), since the administrator could
8090         configure "allow", then after a delay, configure "advertise".
8091 </p>
8092 </dd>
8093 <dt class="hdlist1">
8094 mailinfo.scissors
8095 </dt>
8096 <dd>
8097 <p>
8098         If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
8099         <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
8100         was provided on the command-line. When active, this feature
8101         removes everything from the message body before a scissors
8102         line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
8103 </p>
8104 </dd>
8105 <dt class="hdlist1">
8106 mailmap.file
8107 </dt>
8108 <dd>
8109 <p>
8110         The location of an augmenting mailmap file. The default
8111         mailmap, located in the root of the repository, is loaded
8112         first, then the mailmap file pointed to by this variable.
8113         The location of the mailmap file may be in a repository
8114         subdirectory, or somewhere outside of the repository itself.
8115         See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
8116 </p>
8117 </dd>
8118 <dt class="hdlist1">
8119 mailmap.blob
8120 </dt>
8121 <dd>
8122 <p>
8123         Like <code>mailmap.file</code>, but consider the value as a reference to a
8124         blob in the repository. If both <code>mailmap.file</code> and
8125         <code>mailmap.blob</code> are given, both are parsed, with entries from
8126         <code>mailmap.file</code> taking precedence. In a bare repository, this
8127         defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8128         defaults to empty.
8129 </p>
8130 </dd>
8131 <dt class="hdlist1">
8132 maintenance.auto
8133 </dt>
8134 <dd>
8135 <p>
8136         This boolean config option controls whether some commands run
8137         <code>git maintenance run --auto</code> after doing their normal work. Defaults
8138         to true.
8139 </p>
8140 </dd>
8141 <dt class="hdlist1">
8142 maintenance.strategy
8143 </dt>
8144 <dd>
8145 <p>
8146         This string config option provides a way to specify one of a few
8147         recommended schedules for background maintenance. This only affects
8148         which tasks are run during <code>git maintenance run --schedule=X</code>
8149         commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
8150         Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
8151         then that value is used instead of the one provided by
8152         <code>maintenance.strategy</code>. The possible strategy strings are:
8153 </p>
8154 <div class="ulist"><ul>
8155 <li>
8156 <p>
8157 <code>none</code>: This default setting implies no tasks are run at any schedule.
8158 </p>
8159 </li>
8160 <li>
8161 <p>
8162 <code>incremental</code>: This setting optimizes for performing small maintenance
8163   activities that do not delete any data. This does not schedule the <code>gc</code>
8164   task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8165   <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8166   task weekly.
8167 </p>
8168 </li>
8169 </ul></div>
8170 </dd>
8171 <dt class="hdlist1">
8172 maintenance.&lt;task&gt;.enabled
8173 </dt>
8174 <dd>
8175 <p>
8176         This boolean config option controls whether the maintenance task
8177         with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
8178         <code>git maintenance run</code>. These config values are ignored if a
8179         <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8180         is true.
8181 </p>
8182 </dd>
8183 <dt class="hdlist1">
8184 maintenance.&lt;task&gt;.schedule
8185 </dt>
8186 <dd>
8187 <p>
8188         This config option controls whether or not the given <code>&lt;task&gt;</code> runs
8189         during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
8190         value must be one of "hourly", "daily", or "weekly".
8191 </p>
8192 </dd>
8193 <dt class="hdlist1">
8194 maintenance.commit-graph.auto
8195 </dt>
8196 <dd>
8197 <p>
8198         This integer config option controls how often the <code>commit-graph</code> task
8199         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8200         the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8201         negative value will force the task to run every time. Otherwise, a
8202         positive value implies the command should run when the number of
8203         reachable commits that are not in the commit-graph file is at least
8204         the value of <code>maintenance.commit-graph.auto</code>. The default value is
8205         100.
8206 </p>
8207 </dd>
8208 <dt class="hdlist1">
8209 maintenance.loose-objects.auto
8210 </dt>
8211 <dd>
8212 <p>
8213         This integer config option controls how often the <code>loose-objects</code> task
8214         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8215         the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8216         negative value will force the task to run every time. Otherwise, a
8217         positive value implies the command should run when the number of
8218         loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8219         The default value is 100.
8220 </p>
8221 </dd>
8222 <dt class="hdlist1">
8223 maintenance.incremental-repack.auto
8224 </dt>
8225 <dd>
8226 <p>
8227         This integer config option controls how often the <code>incremental-repack</code>
8228         task should be run as part of <code>git maintenance run --auto</code>. If zero,
8229         then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8230         option. A negative value will force the task to run every time.
8231         Otherwise, a positive value implies the command should run when the
8232         number of pack-files not in the multi-pack-index is at least the value
8233         of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8234 </p>
8235 </dd>
8236 <dt class="hdlist1">
8237 man.viewer
8238 </dt>
8239 <dd>
8240 <p>
8241         Specify the programs that may be used to display help in the
8242         <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8243 </p>
8244 </dd>
8245 <dt class="hdlist1">
8246 man.&lt;tool&gt;.cmd
8247 </dt>
8248 <dd>
8249 <p>
8250         Specify the command to invoke the specified man viewer. The
8251         specified command is evaluated in shell with the man page
8252         passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)
8253 </p>
8254 </dd>
8255 <dt class="hdlist1">
8256 man.&lt;tool&gt;.path
8257 </dt>
8258 <dd>
8259 <p>
8260         Override the path for the given tool that may be used to
8261         display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8262 </p>
8263 </dd>
8264 <dt class="hdlist1">
8265 merge.conflictStyle
8266 </dt>
8267 <dd>
8268 <p>
8269         Specify the style in which conflicted hunks are written out to
8270         working tree files upon merge.  The default is "merge", which
8271         shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
8272         a <code>=======</code> marker, changes made by the other side, and then
8273         a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
8274         marker and the original text before the <code>=======</code> marker.  The
8275         "merge" style tends to produce smaller conflict regions than diff3,
8276         both because of the exclusion of the original text, and because
8277         when a subset of lines match on the two sides, they are just pulled
8278         out of the conflict region.  Another alternate style, "zdiff3", is
8279         similar to diff3 but removes matching lines on the two sides from
8280         the conflict region when those matching lines appear near either
8281         the beginning or end of a conflict region.
8282 </p>
8283 </dd>
8284 <dt class="hdlist1">
8285 merge.defaultToUpstream
8286 </dt>
8287 <dd>
8288 <p>
8289         If merge is called without any commit argument, merge the upstream
8290         branches configured for the current branch by using their last
8291         observed values stored in their remote-tracking branches.
8292         The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
8293         branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
8294         are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
8295         to their corresponding remote-tracking branches, and the tips of
8296         these tracking branches are merged. Defaults to true.
8297 </p>
8298 </dd>
8299 <dt class="hdlist1">
8300 merge.ff
8301 </dt>
8302 <dd>
8303 <p>
8304         By default, Git does not create an extra merge commit when merging
8305         a commit that is a descendant of the current commit. Instead, the
8306         tip of the current branch is fast-forwarded. When set to <code>false</code>,
8307         this variable tells Git to create an extra merge commit in such
8308         a case (equivalent to giving the <code>--no-ff</code> option from the command
8309         line). When set to <code>only</code>, only such fast-forward merges are
8310         allowed (equivalent to giving the <code>--ff-only</code> option from the
8311         command line).
8312 </p>
8313 </dd>
8314 <dt class="hdlist1">
8315 merge.verifySignatures
8316 </dt>
8317 <dd>
8318 <p>
8319         If true, this is equivalent to the --verify-signatures command
8320         line option. See <a href="git-merge.html">git-merge(1)</a> for details.
8321 </p>
8322 </dd>
8323 <dt class="hdlist1">
8324 merge.branchdesc
8325 </dt>
8326 <dd>
8327 <p>
8328         In addition to branch names, populate the log message with
8329         the branch description text associated with them.  Defaults
8330         to false.
8331 </p>
8332 </dd>
8333 <dt class="hdlist1">
8334 merge.log
8335 </dt>
8336 <dd>
8337 <p>
8338         In addition to branch names, populate the log message with at
8339         most the specified number of one-line descriptions from the
8340         actual commits that are being merged.  Defaults to false, and
8341         true is a synonym for 20.
8342 </p>
8343 </dd>
8344 <dt class="hdlist1">
8345 merge.suppressDest
8346 </dt>
8347 <dd>
8348 <p>
8349         By adding a glob that matches the names of integration
8350         branches to this multi-valued configuration variable, the
8351         default merge message computed for merges into these
8352         integration branches will omit "into &lt;branch name&gt;" from
8353         its title.
8354 </p>
8355 <div class="paragraph"><p>An element with an empty value can be used to clear the list
8356 of globs accumulated from previous configuration entries.
8357 When there is no <code>merge.suppressDest</code> variable defined, the
8358 default value of <code>master</code> is used for backward compatibility.</p></div>
8359 </dd>
8360 <dt class="hdlist1">
8361 merge.renameLimit
8362 </dt>
8363 <dd>
8364 <p>
8365         The number of files to consider in the exhaustive portion of
8366         rename detection during a merge.  If not specified, defaults
8367         to the value of diff.renameLimit.  If neither
8368         merge.renameLimit nor diff.renameLimit are specified,
8369         currently defaults to 7000.  This setting has no effect if
8370         rename detection is turned off.
8371 </p>
8372 </dd>
8373 <dt class="hdlist1">
8374 merge.renames
8375 </dt>
8376 <dd>
8377 <p>
8378         Whether Git detects renames.  If set to "false", rename detection
8379         is disabled. If set to "true", basic rename detection is enabled.
8380         Defaults to the value of diff.renames.
8381 </p>
8382 </dd>
8383 <dt class="hdlist1">
8384 merge.directoryRenames
8385 </dt>
8386 <dd>
8387 <p>
8388         Whether Git detects directory renames, affecting what happens at
8389         merge time to new files added to a directory on one side of
8390         history when that directory was renamed on the other side of
8391         history.  If merge.directoryRenames is set to "false", directory
8392         rename detection is disabled, meaning that such new files will be
8393         left behind in the old directory.  If set to "true", directory
8394         rename detection is enabled, meaning that such new files will be
8395         moved into the new directory.  If set to "conflict", a conflict
8396         will be reported for such paths.  If merge.renames is false,
8397         merge.directoryRenames is ignored and treated as false.  Defaults
8398         to "conflict".
8399 </p>
8400 </dd>
8401 <dt class="hdlist1">
8402 merge.renormalize
8403 </dt>
8404 <dd>
8405 <p>
8406         Tell Git that canonical representation of files in the
8407         repository has changed over time (e.g. earlier commits record
8408         text files with CRLF line endings, but recent ones use LF line
8409         endings).  In such a repository, Git can convert the data
8410         recorded in commits to a canonical form before performing a
8411         merge to reduce unnecessary conflicts.  For more information,
8412         see section "Merging branches with differing checkin/checkout
8413         attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
8414 </p>
8415 </dd>
8416 <dt class="hdlist1">
8417 merge.stat
8418 </dt>
8419 <dd>
8420 <p>
8421         Whether to print the diffstat between ORIG_HEAD and the merge result
8422         at the end of the merge.  True by default.
8423 </p>
8424 </dd>
8425 <dt class="hdlist1">
8426 merge.autoStash
8427 </dt>
8428 <dd>
8429 <p>
8430         When set to true, automatically create a temporary stash entry
8431         before the operation begins, and apply it after the operation
8432         ends.  This means that you can run merge on a dirty worktree.
8433         However, use with care: the final stash application after a
8434         successful merge might result in non-trivial conflicts.
8435         This option can be overridden by the <code>--no-autostash</code> and
8436         <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
8437         Defaults to false.
8438 </p>
8439 </dd>
8440 <dt class="hdlist1">
8441 merge.tool
8442 </dt>
8443 <dd>
8444 <p>
8445         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
8446         The list below shows the valid built-in values.
8447         Any other value is treated as a custom merge tool and requires
8448         that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
8449 </p>
8450 </dd>
8451 <dt class="hdlist1">
8452 merge.guitool
8453 </dt>
8454 <dd>
8455 <p>
8456         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
8457         -g/--gui flag is specified. The list below shows the valid built-in values.
8458         Any other value is treated as a custom merge tool and requires that a
8459         corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.
8460 </p>
8461 <div class="dlist"><dl>
8462 <dt class="hdlist1">
8463 <code>araxis</code>
8464 </dt>
8465 <dd>
8466 <p>
8467 Use Araxis Merge (requires a graphical session)
8468 </p>
8469 </dd>
8470 <dt class="hdlist1">
8471 <code>bc</code>
8472 </dt>
8473 <dd>
8474 <p>
8475 Use Beyond Compare (requires a graphical session)
8476 </p>
8477 </dd>
8478 <dt class="hdlist1">
8479 <code>bc3</code>
8480 </dt>
8481 <dd>
8482 <p>
8483 Use Beyond Compare (requires a graphical session)
8484 </p>
8485 </dd>
8486 <dt class="hdlist1">
8487 <code>bc4</code>
8488 </dt>
8489 <dd>
8490 <p>
8491 Use Beyond Compare (requires a graphical session)
8492 </p>
8493 </dd>
8494 <dt class="hdlist1">
8495 <code>codecompare</code>
8496 </dt>
8497 <dd>
8498 <p>
8499 Use Code Compare (requires a graphical session)
8500 </p>
8501 </dd>
8502 <dt class="hdlist1">
8503 <code>deltawalker</code>
8504 </dt>
8505 <dd>
8506 <p>
8507 Use DeltaWalker (requires a graphical session)
8508 </p>
8509 </dd>
8510 <dt class="hdlist1">
8511 <code>diffmerge</code>
8512 </dt>
8513 <dd>
8514 <p>
8515 Use DiffMerge (requires a graphical session)
8516 </p>
8517 </dd>
8518 <dt class="hdlist1">
8519 <code>diffuse</code>
8520 </dt>
8521 <dd>
8522 <p>
8523 Use Diffuse (requires a graphical session)
8524 </p>
8525 </dd>
8526 <dt class="hdlist1">
8527 <code>ecmerge</code>
8528 </dt>
8529 <dd>
8530 <p>
8531 Use ECMerge (requires a graphical session)
8532 </p>
8533 </dd>
8534 <dt class="hdlist1">
8535 <code>emerge</code>
8536 </dt>
8537 <dd>
8538 <p>
8539 Use Emacs' Emerge
8540 </p>
8541 </dd>
8542 <dt class="hdlist1">
8543 <code>examdiff</code>
8544 </dt>
8545 <dd>
8546 <p>
8547 Use ExamDiff Pro (requires a graphical session)
8548 </p>
8549 </dd>
8550 <dt class="hdlist1">
8551 <code>guiffy</code>
8552 </dt>
8553 <dd>
8554 <p>
8555 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
8556 </p>
8557 </dd>
8558 <dt class="hdlist1">
8559 <code>gvimdiff</code>
8560 </dt>
8561 <dd>
8562 <p>
8563 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8564 </p>
8565 </dd>
8566 <dt class="hdlist1">
8567 <code>gvimdiff1</code>
8568 </dt>
8569 <dd>
8570 <p>
8571 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
8572 </p>
8573 </dd>
8574 <dt class="hdlist1">
8575 <code>gvimdiff2</code>
8576 </dt>
8577 <dd>
8578 <p>
8579 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
8580 </p>
8581 </dd>
8582 <dt class="hdlist1">
8583 <code>gvimdiff3</code>
8584 </dt>
8585 <dd>
8586 <p>
8587 Use gVim (requires a graphical session) where only the MERGED file is shown
8588 </p>
8589 </dd>
8590 <dt class="hdlist1">
8591 <code>kdiff3</code>
8592 </dt>
8593 <dd>
8594 <p>
8595 Use KDiff3 (requires a graphical session)
8596 </p>
8597 </dd>
8598 <dt class="hdlist1">
8599 <code>meld</code>
8600 </dt>
8601 <dd>
8602 <p>
8603 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
8604 </p>
8605 </dd>
8606 <dt class="hdlist1">
8607 <code>nvimdiff</code>
8608 </dt>
8609 <dd>
8610 <p>
8611 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8612 </p>
8613 </dd>
8614 <dt class="hdlist1">
8615 <code>nvimdiff1</code>
8616 </dt>
8617 <dd>
8618 <p>
8619 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
8620 </p>
8621 </dd>
8622 <dt class="hdlist1">
8623 <code>nvimdiff2</code>
8624 </dt>
8625 <dd>
8626 <p>
8627 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8628 </p>
8629 </dd>
8630 <dt class="hdlist1">
8631 <code>nvimdiff3</code>
8632 </dt>
8633 <dd>
8634 <p>
8635 Use Neovim where only the MERGED file is shown
8636 </p>
8637 </dd>
8638 <dt class="hdlist1">
8639 <code>opendiff</code>
8640 </dt>
8641 <dd>
8642 <p>
8643 Use FileMerge (requires a graphical session)
8644 </p>
8645 </dd>
8646 <dt class="hdlist1">
8647 <code>p4merge</code>
8648 </dt>
8649 <dd>
8650 <p>
8651 Use HelixCore P4Merge (requires a graphical session)
8652 </p>
8653 </dd>
8654 <dt class="hdlist1">
8655 <code>smerge</code>
8656 </dt>
8657 <dd>
8658 <p>
8659 Use Sublime Merge (requires a graphical session)
8660 </p>
8661 </dd>
8662 <dt class="hdlist1">
8663 <code>tkdiff</code>
8664 </dt>
8665 <dd>
8666 <p>
8667 Use TkDiff (requires a graphical session)
8668 </p>
8669 </dd>
8670 <dt class="hdlist1">
8671 <code>tortoisemerge</code>
8672 </dt>
8673 <dd>
8674 <p>
8675 Use TortoiseMerge (requires a graphical session)
8676 </p>
8677 </dd>
8678 <dt class="hdlist1">
8679 <code>vimdiff</code>
8680 </dt>
8681 <dd>
8682 <p>
8683 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8684 </p>
8685 </dd>
8686 <dt class="hdlist1">
8687 <code>vimdiff1</code>
8688 </dt>
8689 <dd>
8690 <p>
8691 Use Vim with a 2 panes layout (LOCAL and REMOTE)
8692 </p>
8693 </dd>
8694 <dt class="hdlist1">
8695 <code>vimdiff2</code>
8696 </dt>
8697 <dd>
8698 <p>
8699 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8700 </p>
8701 </dd>
8702 <dt class="hdlist1">
8703 <code>vimdiff3</code>
8704 </dt>
8705 <dd>
8706 <p>
8707 Use Vim where only the MERGED file is shown
8708 </p>
8709 </dd>
8710 <dt class="hdlist1">
8711 <code>winmerge</code>
8712 </dt>
8713 <dd>
8714 <p>
8715 Use WinMerge (requires a graphical session)
8716 </p>
8717 </dd>
8718 <dt class="hdlist1">
8719 <code>xxdiff</code>
8720 </dt>
8721 <dd>
8722 <p>
8723 Use xxdiff (requires a graphical session)
8724 </p>
8725 </dd>
8726 </dl></div>
8727 </dd>
8728 <dt class="hdlist1">
8729 merge.verbosity
8730 </dt>
8731 <dd>
8732 <p>
8733         Controls the amount of output shown by the recursive merge
8734         strategy.  Level 0 outputs nothing except a final error
8735         message if conflicts were detected. Level 1 outputs only
8736         conflicts, 2 outputs conflicts and file changes.  Level 5 and
8737         above outputs debugging information.  The default is level 2.
8738         Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
8739 </p>
8740 </dd>
8741 <dt class="hdlist1">
8742 merge.&lt;driver&gt;.name
8743 </dt>
8744 <dd>
8745 <p>
8746         Defines a human-readable name for a custom low-level
8747         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8748 </p>
8749 </dd>
8750 <dt class="hdlist1">
8751 merge.&lt;driver&gt;.driver
8752 </dt>
8753 <dd>
8754 <p>
8755         Defines the command that implements a custom low-level
8756         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8757 </p>
8758 </dd>
8759 <dt class="hdlist1">
8760 merge.&lt;driver&gt;.recursive
8761 </dt>
8762 <dd>
8763 <p>
8764         Names a low-level merge driver to be used when
8765         performing an internal merge between common ancestors.
8766         See <a href="gitattributes.html">gitattributes(5)</a> for details.
8767 </p>
8768 </dd>
8769 <dt class="hdlist1">
8770 mergetool.&lt;tool&gt;.path
8771 </dt>
8772 <dd>
8773 <p>
8774         Override the path for the given tool.  This is useful in case
8775         your tool is not in the PATH.
8776 </p>
8777 </dd>
8778 <dt class="hdlist1">
8779 mergetool.&lt;tool&gt;.cmd
8780 </dt>
8781 <dd>
8782 <p>
8783         Specify the command to invoke the specified merge tool.  The
8784         specified command is evaluated in shell with the following
8785         variables available: <em>BASE</em> is the name of a temporary file
8786         containing the common base of the files to be merged, if available;
8787         <em>LOCAL</em> is the name of a temporary file containing the contents of
8788         the file on the current branch; <em>REMOTE</em> is the name of a temporary
8789         file containing the contents of the file from the branch being
8790         merged; <em>MERGED</em> contains the name of the file to which the merge
8791         tool should write the results of a successful merge.
8792 </p>
8793 </dd>
8794 <dt class="hdlist1">
8795 mergetool.&lt;tool&gt;.hideResolved
8796 </dt>
8797 <dd>
8798 <p>
8799         Allows the user to override the global <code>mergetool.hideResolved</code> value
8800         for a specific tool. See <code>mergetool.hideResolved</code> for the full
8801         description.
8802 </p>
8803 </dd>
8804 <dt class="hdlist1">
8805 mergetool.&lt;tool&gt;.trustExitCode
8806 </dt>
8807 <dd>
8808 <p>
8809         For a custom merge command, specify whether the exit code of
8810         the merge command can be used to determine whether the merge was
8811         successful.  If this is not set to true then the merge target file
8812         timestamp is checked, and the merge is assumed to have been successful
8813         if the file has been updated; otherwise, the user is prompted to
8814         indicate the success of the merge.
8815 </p>
8816 </dd>
8817 <dt class="hdlist1">
8818 mergetool.meld.hasOutput
8819 </dt>
8820 <dd>
8821 <p>
8822         Older versions of <code>meld</code> do not support the <code>--output</code> option.
8823         Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
8824         by inspecting the output of <code>meld --help</code>.  Configuring
8825         <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
8826         use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
8827         to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
8828         and <code>false</code> avoids using <code>--output</code>.
8829 </p>
8830 </dd>
8831 <dt class="hdlist1">
8832 mergetool.meld.useAutoMerge
8833 </dt>
8834 <dd>
8835 <p>
8836         When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
8837         parts automatically, highlight the conflicting parts, and wait for
8838         user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
8839         Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
8840         Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
8841         is supported and will only use <code>--auto-merge</code> when available.  A
8842         value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
8843         default value.
8844 </p>
8845 </dd>
8846 <dt class="hdlist1">
8847 mergetool.&lt;vimdiff variant&gt;.layout
8848 </dt>
8849 <dd>
8850 <p>
8851         Configure the split window layout for vimdiff&#8217;s <code>&lt;variant&gt;</code>, which is any of <code>vimdiff</code>,
8852         <code>nvimdiff</code>, <code>gvimdiff</code>.
8853         Upon launching <code>git mergetool</code> with <code>--tool=&lt;variant&gt;</code> (or without <code>--tool</code>
8854         if <code>merge.tool</code> is configured as <code>&lt;variant&gt;</code>), Git will consult
8855         <code>mergetool.&lt;variant&gt;.layout</code> to determine the tool&#8217;s layout. If the
8856         variant-specific configuration is not available, <code>vimdiff</code>'s is used as
8857         fallback.  If that too is not available, a default layout with 4 windows
8858         will be used.  To configure the layout, see the <code>BACKEND SPECIFIC HINTS</code>
8859         section in <a href="git-mergetool.html">git-mergetool(1)</a>.
8860 </p>
8861 </dd>
8862 <dt class="hdlist1">
8863 mergetool.hideResolved
8864 </dt>
8865 <dd>
8866 <p>
8867         During a merge, Git will automatically resolve as many conflicts as
8868         possible and write the <em>MERGED</em> file containing conflict markers around
8869         any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
8870         represent the versions of the file from before Git&#8217;s conflict
8871         resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
8872         that only the unresolved conflicts are presented to the merge tool. Can
8873         be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
8874         configuration variable. Defaults to <code>false</code>.
8875 </p>
8876 </dd>
8877 <dt class="hdlist1">
8878 mergetool.keepBackup
8879 </dt>
8880 <dd>
8881 <p>
8882         After performing a merge, the original file with conflict markers
8883         can be saved as a file with a <code>.orig</code> extension.  If this variable
8884         is set to <code>false</code> then this file is not preserved.  Defaults to
8885         <code>true</code> (i.e. keep the backup files).
8886 </p>
8887 </dd>
8888 <dt class="hdlist1">
8889 mergetool.keepTemporaries
8890 </dt>
8891 <dd>
8892 <p>
8893         When invoking a custom merge tool, Git uses a set of temporary
8894         files to pass to the tool. If the tool returns an error and this
8895         variable is set to <code>true</code>, then these temporary files will be
8896         preserved; otherwise, they will be removed after the tool has
8897         exited. Defaults to <code>false</code>.
8898 </p>
8899 </dd>
8900 <dt class="hdlist1">
8901 mergetool.writeToTemp
8902 </dt>
8903 <dd>
8904 <p>
8905         Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
8906         conflicting files in the worktree by default.  Git will attempt
8907         to use a temporary directory for these files when set <code>true</code>.
8908         Defaults to <code>false</code>.
8909 </p>
8910 </dd>
8911 <dt class="hdlist1">
8912 mergetool.prompt
8913 </dt>
8914 <dd>
8915 <p>
8916         Prompt before each invocation of the merge resolution program.
8917 </p>
8918 </dd>
8919 <dt class="hdlist1">
8920 mergetool.guiDefault
8921 </dt>
8922 <dd>
8923 <p>
8924         Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
8925         specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
8926         or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
8927         variable value. The default is <code>false</code>, where the <code>--gui</code> argument
8928         must be provided explicitly for the <code>merge.guitool</code> to be used.
8929 </p>
8930 </dd>
8931 <dt class="hdlist1">
8932 notes.mergeStrategy
8933 </dt>
8934 <dd>
8935 <p>
8936         Which merge strategy to choose by default when resolving notes
8937         conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
8938         <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
8939         section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
8940 </p>
8941 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
8942 <a href="git-notes.html">git-notes(1)</a>.</p></div>
8943 </dd>
8944 <dt class="hdlist1">
8945 notes.&lt;name&gt;.mergeStrategy
8946 </dt>
8947 <dd>
8948 <p>
8949         Which merge strategy to choose when doing a notes merge into
8950         refs/notes/&lt;name&gt;.  This overrides the more general
8951         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
8952         <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
8953 </p>
8954 </dd>
8955 <dt class="hdlist1">
8956 notes.displayRef
8957 </dt>
8958 <dd>
8959 <p>
8960         Which ref (or refs, if a glob or specified more than once), in
8961         addition to the default set by <code>core.notesRef</code> or
8962         <code>GIT_NOTES_REF</code>, to read notes from when showing commit
8963         messages with the <em>git log</em> family of commands.
8964 </p>
8965 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
8966 environment variable, which must be a colon separated list of refs or
8967 globs.</p></div>
8968 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
8969 but a glob that does not match any refs is silently ignored.</p></div>
8970 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
8971 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
8972 those commands.</p></div>
8973 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
8974 GIT_NOTES_REF) is also implicitly added to the list of refs to be
8975 displayed.</p></div>
8976 </dd>
8977 <dt class="hdlist1">
8978 notes.rewrite.&lt;command&gt;
8979 </dt>
8980 <dd>
8981 <p>
8982         When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
8983         <code>rebase</code>), if this variable is <code>false</code>, git will not copy
8984         notes from the original to the rewritten commit.  Defaults to
8985         <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.
8986 </p>
8987 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
8988 environment variable, which must be a colon separated list of refs or
8989 globs.</p></div>
8990 </dd>
8991 <dt class="hdlist1">
8992 notes.rewriteMode
8993 </dt>
8994 <dd>
8995 <p>
8996         When copying notes during a rewrite (see the
8997         "notes.rewrite.&lt;command&gt;" option), determines what to do if
8998         the target commit already has a note.  Must be one of
8999         <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
9000         Defaults to <code>concatenate</code>.
9001 </p>
9002 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
9003 environment variable.</p></div>
9004 </dd>
9005 <dt class="hdlist1">
9006 notes.rewriteRef
9007 </dt>
9008 <dd>
9009 <p>
9010         When copying notes during a rewrite, specifies the (fully
9011         qualified) ref whose notes should be copied.  May be a glob,
9012         in which case notes in all matching refs will be copied.  You
9013         may also specify this configuration several times.
9014 </p>
9015 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
9016 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
9017 rewriting for the default commit notes.</p></div>
9018 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
9019 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
9020 </dd>
9021 <dt class="hdlist1">
9022 pack.window
9023 </dt>
9024 <dd>
9025 <p>
9026         The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9027         window size is given on the command line. Defaults to 10.
9028 </p>
9029 </dd>
9030 <dt class="hdlist1">
9031 pack.depth
9032 </dt>
9033 <dd>
9034 <p>
9035         The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9036         maximum depth is given on the command line. Defaults to 50.
9037         Maximum value is 4095.
9038 </p>
9039 </dd>
9040 <dt class="hdlist1">
9041 pack.windowMemory
9042 </dt>
9043 <dd>
9044 <p>
9045         The maximum size of memory that is consumed by each thread
9046         in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
9047         no limit is given on the command line.  The value can be
9048         suffixed with "k", "m", or "g".  When left unconfigured (or
9049         set explicitly to 0), there will be no limit.
9050 </p>
9051 </dd>
9052 <dt class="hdlist1">
9053 pack.compression
9054 </dt>
9055 <dd>
9056 <p>
9057         An integer -1..9, indicating the compression level for objects
9058         in a pack file. -1 is the zlib default. 0 means no
9059         compression, and 1..9 are various speed/size tradeoffs, 9 being
9060         slowest.  If not set,  defaults to core.compression.  If that is
9061         not set,  defaults to -1, the zlib default, which is "a default
9062         compromise between speed and compression (currently equivalent
9063         to level 6)."
9064 </p>
9065 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
9066 all existing objects. You can force recompression by passing the -F option
9067 to <a href="git-repack.html">git-repack(1)</a>.</p></div>
9068 </dd>
9069 <dt class="hdlist1">
9070 pack.allowPackReuse
9071 </dt>
9072 <dd>
9073 <p>
9074         When true or "single", and when reachability bitmaps are
9075         enabled, pack-objects will try to send parts of the bitmapped
9076         packfile verbatim. When "multi", and when a multi-pack
9077         reachability bitmap is available, pack-objects will try to send
9078         parts of all packs in the MIDX.
9079 </p>
9080 <div class="paragraph"><p>If only a single pack bitmap is available, and <code>pack.allowPackReuse</code>
9081 is set to "multi", reuse parts of just the bitmapped packfile. This
9082 can reduce memory and CPU usage to serve fetches, but might result in
9083 sending a slightly larger pack. Defaults to true.</p></div>
9084 </dd>
9085 <dt class="hdlist1">
9086 pack.island
9087 </dt>
9088 <dd>
9089 <p>
9090         An extended regular expression configuring a set of delta
9091         islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
9092         for details.
9093 </p>
9094 </dd>
9095 <dt class="hdlist1">
9096 pack.islandCore
9097 </dt>
9098 <dd>
9099 <p>
9100         Specify an island name which gets to have its objects be
9101         packed first. This creates a kind of pseudo-pack at the front
9102         of one pack, so that the objects from the specified island are
9103         hopefully faster to copy into any pack that should be served
9104         to a user requesting these objects. In practice this means
9105         that the island specified should likely correspond to what is
9106         the most commonly cloned in the repo. See also "DELTA ISLANDS"
9107         in <a href="git-pack-objects.html">git-pack-objects(1)</a>.
9108 </p>
9109 </dd>
9110 <dt class="hdlist1">
9111 pack.deltaCacheSize
9112 </dt>
9113 <dd>
9114 <p>
9115         The maximum memory in bytes used for caching deltas in
9116         <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
9117         This cache is used to speed up the writing object phase by not
9118         having to recompute the final delta result once the best match
9119         for all objects is found.  Repacking large repositories on machines
9120         which are tight with memory might be badly impacted by this though,
9121         especially if this cache pushes the system into swapping.
9122         A value of 0 means no limit. The smallest size of 1 byte may be
9123         used to virtually disable this cache. Defaults to 256 MiB.
9124 </p>
9125 </dd>
9126 <dt class="hdlist1">
9127 pack.deltaCacheLimit
9128 </dt>
9129 <dd>
9130 <p>
9131         The maximum size of a delta, that is cached in
9132         <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
9133         writing object phase by not having to recompute the final delta
9134         result once the best match for all objects is found.
9135         Defaults to 1000. Maximum value is 65535.
9136 </p>
9137 </dd>
9138 <dt class="hdlist1">
9139 pack.threads
9140 </dt>
9141 <dd>
9142 <p>
9143         Specifies the number of threads to spawn when searching for best
9144         delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
9145         be compiled with pthreads otherwise this option is ignored with a
9146         warning. This is meant to reduce packing time on multiprocessor
9147         machines. The required amount of memory for the delta search window
9148         is however multiplied by the number of threads.
9149         Specifying 0 will cause Git to auto-detect the number of CPUs
9150         and set the number of threads accordingly.
9151 </p>
9152 </dd>
9153 <dt class="hdlist1">
9154 pack.indexVersion
9155 </dt>
9156 <dd>
9157 <p>
9158         Specify the default pack index version.  Valid values are 1 for
9159         legacy pack index used by Git versions prior to 1.5.2, and 2 for
9160         the new pack index with capabilities for packs larger than 4 GB
9161         as well as proper protection against the repacking of corrupted
9162         packs.  Version 2 is the default.  Note that version 2 is enforced
9163         and this config option is ignored whenever the corresponding pack is
9164         larger than 2 GB.
9165 </p>
9166 <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9167 cloning or fetching over a non-native protocol (e.g. "http")
9168 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9169 other side may give you a repository that cannot be accessed with your
9170 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9171 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
9172 the <code>*.idx</code> file.</p></div>
9173 </dd>
9174 <dt class="hdlist1">
9175 pack.packSizeLimit
9176 </dt>
9177 <dd>
9178 <p>
9179         The maximum size of a pack.  This setting only affects
9180         packing to a file when repacking, i.e. the git:// protocol
9181         is unaffected.  It can be overridden by the <code>--max-pack-size</code>
9182         option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
9183         in the creation of multiple packfiles.
9184 </p>
9185 <div class="paragraph"><p>Note that this option is rarely useful, and may result in a larger total
9186 on-disk size (because Git will not store deltas between packs) and
9187 worse runtime performance (object lookup within multiple packs is
9188 slower than a single pack, and optimizations like reachability bitmaps
9189 cannot cope with multiple packs).</p></div>
9190 <div class="paragraph"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9191 filesystem does not support large files), this option may help. But if
9192 your goal is to transmit a packfile over a medium that supports limited
9193 sizes (e.g., removable media that cannot store the whole repository),
9194 you are likely better off creating a single large packfile and splitting
9195 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9196 <div class="paragraph"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9197 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9198 </dd>
9199 <dt class="hdlist1">
9200 pack.useBitmaps
9201 </dt>
9202 <dd>
9203 <p>
9204         When true, git will use pack bitmaps (if available) when packing
9205         to stdout (e.g., during the server side of a fetch). Defaults to
9206         true. You should not generally need to turn this off unless
9207         you are debugging pack bitmaps.
9208 </p>
9209 </dd>
9210 <dt class="hdlist1">
9211 pack.useBitmapBoundaryTraversal
9212 </dt>
9213 <dd>
9214 <p>
9215         When true, Git will use an experimental algorithm for computing
9216         reachability queries with bitmaps. Instead of building up
9217         complete bitmaps for all of the negated tips and then OR-ing
9218         them together, consider negated tips with existing bitmaps as
9219         additive (i.e. OR-ing them into the result if they exist,
9220         ignoring them otherwise), and build up a bitmap at the boundary
9221         instead.
9222 </p>
9223 <div class="paragraph"><p>When using this algorithm, Git may include too many objects as a result
9224 of not opening up trees belonging to certain UNINTERESTING commits. This
9225 inexactness matches the non-bitmap traversal algorithm.</p></div>
9226 <div class="paragraph"><p>In many cases, this can provide a speed-up over the exact algorithm,
9227 particularly when there is poor bitmap coverage of the negated side of
9228 the query.</p></div>
9229 </dd>
9230 <dt class="hdlist1">
9231 pack.useSparse
9232 </dt>
9233 <dd>
9234 <p>
9235         When true, git will default to using the <em>--sparse</em> option in
9236         <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9237         algorithm only walks trees that appear in paths that introduce new
9238         objects. This can have significant performance benefits when
9239         computing a pack to send a small change. However, it is possible
9240         that extra objects are added to the pack-file if the included
9241         commits contain certain types of direct renames. Default is
9242         <code>true</code>.
9243 </p>
9244 </dd>
9245 <dt class="hdlist1">
9246 pack.preferBitmapTips
9247 </dt>
9248 <dd>
9249 <p>
9250         When selecting which commits will receive bitmaps, prefer a
9251         commit at the tip of any reference that is a suffix of any value
9252         of this configuration over any other commits in the "selection
9253         window".
9254 </p>
9255 <div class="paragraph"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9256 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9257 necessarily be selected. This is because commits are selected for
9258 bitmaps from within a series of windows of variable length.</p></div>
9259 <div class="paragraph"><p>If a commit at the tip of any reference which is a suffix of any value
9260 of this configuration is seen in a window, it is immediately given
9261 preference over any other commit in that window.</p></div>
9262 </dd>
9263 <dt class="hdlist1">
9264 pack.writeBitmaps (deprecated)
9265 </dt>
9266 <dd>
9267 <p>
9268         This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9269 </p>
9270 </dd>
9271 <dt class="hdlist1">
9272 pack.writeBitmapHashCache
9273 </dt>
9274 <dd>
9275 <p>
9276         When true, git will include a "hash cache" section in the bitmap
9277         index (if one is written). This cache can be used to feed git&#8217;s
9278         delta heuristics, potentially leading to better deltas between
9279         bitmapped and non-bitmapped objects (e.g., when serving a fetch
9280         between an older, bitmapped pack and objects that have been
9281         pushed since the last gc). The downside is that it consumes 4
9282         bytes per object of disk space. Defaults to true.
9283 </p>
9284 <div class="paragraph"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9285 computed; instead, any namehashes stored in an existing bitmap are
9286 permuted into their appropriate location when writing a new bitmap.</p></div>
9287 </dd>
9288 <dt class="hdlist1">
9289 pack.writeBitmapLookupTable
9290 </dt>
9291 <dd>
9292 <p>
9293         When true, Git will include a "lookup table" section in the
9294         bitmap index (if one is written). This table is used to defer
9295         loading individual bitmaps as late as possible. This can be
9296         beneficial in repositories that have relatively large bitmap
9297         indexes. Defaults to false.
9298 </p>
9299 </dd>
9300 <dt class="hdlist1">
9301 pack.readReverseIndex
9302 </dt>
9303 <dd>
9304 <p>
9305         When true, git will read any .rev file(s) that may be available
9306         (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
9307         will be generated from scratch and stored in memory. Defaults to
9308         true.
9309 </p>
9310 </dd>
9311 <dt class="hdlist1">
9312 pack.writeReverseIndex
9313 </dt>
9314 <dd>
9315 <p>
9316         When true, git will write a corresponding .rev file (see:
9317         <a href="gitformat-pack.html">gitformat-pack(5)</a>)
9318         for each new packfile that it writes in all places except for
9319         <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
9320         Defaults to true.
9321 </p>
9322 </dd>
9323 <dt class="hdlist1">
9324 pager.&lt;cmd&gt;
9325 </dt>
9326 <dd>
9327 <p>
9328         If the value is boolean, turns on or off pagination of the
9329         output of a particular Git subcommand when writing to a tty.
9330         Otherwise, turns on pagination for the subcommand using the
9331         pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
9332         or <code>--no-pager</code> is specified on the command line, it takes
9333         precedence over this option.  To disable pagination for all
9334         commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9335 </p>
9336 </dd>
9337 <dt class="hdlist1">
9338 pretty.&lt;name&gt;
9339 </dt>
9340 <dd>
9341 <p>
9342         Alias for a --pretty= format string, as specified in
9343         <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
9344         as the built-in pretty formats could. For example,
9345         running <code>git config pretty.changelog "format:* %H %s"</code>
9346         would cause the invocation <code>git log --pretty=changelog</code>
9347         to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
9348         Note that an alias with the same name as a built-in format
9349         will be silently ignored.
9350 </p>
9351 </dd>
9352 <dt class="hdlist1">
9353 protocol.allow
9354 </dt>
9355 <dd>
9356 <p>
9357         If set, provide a user defined default policy for all protocols which
9358         don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
9359         if unset, known-safe protocols (http, https, git, ssh) have a
9360         default policy of <code>always</code>, known-dangerous protocols (ext) have a
9361         default policy of <code>never</code>, and all other protocols (including file)
9362         have a default policy of <code>user</code>.  Supported policies:
9363 </p>
9364 <div class="openblock">
9365 <div class="content">
9366 <div class="ulist"><ul>
9367 <li>
9368 <p>
9369 <code>always</code> - protocol is always able to be used.
9370 </p>
9371 </li>
9372 <li>
9373 <p>
9374 <code>never</code> - protocol is never able to be used.
9375 </p>
9376 </li>
9377 <li>
9378 <p>
9379 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9380   either unset or has a value of 1.  This policy should be used when you want a
9381   protocol to be directly usable by the user but don&#8217;t want it used by commands which
9382   execute clone/fetch/push commands without user input, e.g. recursive
9383   submodule initialization.
9384 </p>
9385 </li>
9386 </ul></div>
9387 </div></div>
9388 </dd>
9389 <dt class="hdlist1">
9390 protocol.&lt;name&gt;.allow
9391 </dt>
9392 <dd>
9393 <p>
9394         Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
9395         commands. See <code>protocol.allow</code> above for the available policies.
9396 </p>
9397 <div class="paragraph"><p>The protocol names currently used by git are:</p></div>
9398 <div class="openblock">
9399 <div class="content">
9400 <div class="ulist"><ul>
9401 <li>
9402 <p>
9403 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9404     or local paths)
9405 </p>
9406 </li>
9407 <li>
9408 <p>
9409 <code>git</code>: the anonymous git protocol over a direct TCP
9410     connection (or proxy, if configured)
9411 </p>
9412 </li>
9413 <li>
9414 <p>
9415 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9416     <code>ssh://</code>, etc).
9417 </p>
9418 </li>
9419 <li>
9420 <p>
9421 <code>http</code>: git over http, both "smart http" and "dumb http".
9422     Note that this does <em>not</em> include <code>https</code>; if you want to configure
9423     both, you must do so individually.
9424 </p>
9425 </li>
9426 <li>
9427 <p>
9428 any external helpers are named by their protocol (e.g., use
9429     <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9430 </p>
9431 </li>
9432 </ul></div>
9433 </div></div>
9434 </dd>
9435 <dt class="hdlist1">
9436 protocol.version
9437 </dt>
9438 <dd>
9439 <p>
9440         If set, clients will attempt to communicate with a server
9441         using the specified protocol version.  If the server does
9442         not support it, communication falls back to version 0.
9443         If unset, the default is <code>2</code>.
9444         Supported versions:
9445 </p>
9446 <div class="openblock">
9447 <div class="content">
9448 <div class="ulist"><ul>
9449 <li>
9450 <p>
9451 <code>0</code> - the original wire protocol.
9452 </p>
9453 </li>
9454 <li>
9455 <p>
9456 <code>1</code> - the original wire protocol with the addition of a version string
9457   in the initial response from the server.
9458 </p>
9459 </li>
9460 <li>
9461 <p>
9462 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.
9463 </p>
9464 </li>
9465 </ul></div>
9466 </div></div>
9467 </dd>
9468 <dt class="hdlist1">
9469 pull.ff
9470 </dt>
9471 <dd>
9472 <p>
9473         By default, Git does not create an extra merge commit when merging
9474         a commit that is a descendant of the current commit. Instead, the
9475         tip of the current branch is fast-forwarded. When set to <code>false</code>,
9476         this variable tells Git to create an extra merge commit in such
9477         a case (equivalent to giving the <code>--no-ff</code> option from the command
9478         line). When set to <code>only</code>, only such fast-forward merges are
9479         allowed (equivalent to giving the <code>--ff-only</code> option from the
9480         command line). This setting overrides <code>merge.ff</code> when pulling.
9481 </p>
9482 </dd>
9483 <dt class="hdlist1">
9484 pull.rebase
9485 </dt>
9486 <dd>
9487 <p>
9488         When true, rebase branches on top of the fetched branch, instead
9489         of merging the default branch from the default remote when "git
9490         pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
9491         per-branch basis.
9492 </p>
9493 <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>
9494 so that the local merge commits are included in the rebase (see
9495 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
9496 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9497 mode.</p></div>
9498 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9499 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
9500 for details).</p></div>
9501 </dd>
9502 <dt class="hdlist1">
9503 pull.octopus
9504 </dt>
9505 <dd>
9506 <p>
9507         The default merge strategy to use when pulling multiple branches
9508         at once.
9509 </p>
9510 </dd>
9511 <dt class="hdlist1">
9512 pull.twohead
9513 </dt>
9514 <dd>
9515 <p>
9516         The default merge strategy to use when pulling a single branch.
9517 </p>
9518 </dd>
9519 <dt class="hdlist1">
9520 push.autoSetupRemote
9521 </dt>
9522 <dd>
9523 <p>
9524         If set to "true" assume <code>--set-upstream</code> on default push when no
9525         upstream tracking exists for the current branch; this option
9526         takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9527         and <em>current</em>. It is useful if by default you want new branches
9528         to be pushed to the default remote (like the behavior of
9529         <em>push.default=current</em>) and you also want the upstream tracking
9530         to be set. Workflows most likely to benefit from this option are
9531         <em>simple</em> central workflows where all branches are expected to
9532         have the same name on the remote.
9533 </p>
9534 </dd>
9535 <dt class="hdlist1">
9536 push.default
9537 </dt>
9538 <dd>
9539 <p>
9540         Defines the action <code>git push</code> should take if no refspec is
9541         given (whether from the command-line, config, or elsewhere).
9542         Different values are well-suited for
9543         specific workflows; for instance, in a purely central workflow
9544         (i.e. the fetch source is equal to the push destination),
9545         <code>upstream</code> is probably what you want.  Possible values are:
9546 </p>
9547 <div class="openblock">
9548 <div class="content">
9549 <div class="ulist"><ul>
9550 <li>
9551 <p>
9552 <code>nothing</code> - do not push anything (error out) unless a refspec is
9553   given. This is primarily meant for people who want to
9554   avoid mistakes by always being explicit.
9555 </p>
9556 </li>
9557 <li>
9558 <p>
9559 <code>current</code> - push the current branch to update a branch with the same
9560   name on the receiving end.  Works in both central and non-central
9561   workflows.
9562 </p>
9563 </li>
9564 <li>
9565 <p>
9566 <code>upstream</code> - push the current branch back to the branch whose
9567   changes are usually integrated into the current branch (which is
9568   called <code>@{upstream}</code>).  This mode only makes sense if you are
9569   pushing to the same repository you would normally pull from
9570   (i.e. central workflow).
9571 </p>
9572 </li>
9573 <li>
9574 <p>
9575 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
9576 </p>
9577 </li>
9578 <li>
9579 <p>
9580 <code>simple</code> - push the current branch with the same name on the remote.
9581 </p>
9582 <div class="paragraph"><p>If you are working on a centralized workflow (pushing to the same repository you
9583 pull from, which is typically <code>origin</code>), then you need to configure an upstream
9584 branch with the same name.</p></div>
9585 <div class="paragraph"><p>This mode is the default since Git 2.0, and is the safest option suited for
9586 beginners.</p></div>
9587 </li>
9588 <li>
9589 <p>
9590 <code>matching</code> - push all branches having the same name on both ends.
9591   This makes the repository you are pushing to remember the set of
9592   branches that will be pushed out (e.g. if you always push <em>maint</em>
9593   and <em>master</em> there and no other branches, the repository you push
9594   to will have these two branches, and your local <em>maint</em> and
9595   <em>master</em> will be pushed there).
9596 </p>
9597 <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
9598 branches you would push out are ready to be pushed out before
9599 running <em>git push</em>, as the whole point of this mode is to allow you
9600 to push all of the branches in one go.  If you usually finish work
9601 on only one branch and push out the result, while other branches are
9602 unfinished, this mode is not for you.  Also this mode is not
9603 suitable for pushing into a shared central repository, as other
9604 people may add new branches there, or update the tip of existing
9605 branches outside your control.</p></div>
9606 <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
9607 new default).</p></div>
9608 </li>
9609 </ul></div>
9610 </div></div>
9611 </dd>
9612 <dt class="hdlist1">
9613 push.followTags
9614 </dt>
9615 <dd>
9616 <p>
9617         If set to true, enable <code>--follow-tags</code> option by default.  You
9618         may override this configuration at time of push by specifying
9619         <code>--no-follow-tags</code>.
9620 </p>
9621 </dd>
9622 <dt class="hdlist1">
9623 push.gpgSign
9624 </dt>
9625 <dd>
9626 <p>
9627         May be set to a boolean value, or the string <em>if-asked</em>. A true
9628         value causes all pushes to be GPG signed, as if <code>--signed</code> is
9629         passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
9630         pushes to be signed if the server supports it, as if
9631         <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
9632         override a value from a lower-priority config file. An explicit
9633         command-line flag always overrides this config option.
9634 </p>
9635 </dd>
9636 <dt class="hdlist1">
9637 push.pushOption
9638 </dt>
9639 <dd>
9640 <p>
9641         When no <code>--push-option=&lt;option&gt;</code> argument is given from the
9642         command line, <code>git push</code> behaves as if each &lt;value&gt; of
9643         this variable is given as <code>--push-option=&lt;value&gt;</code>.
9644 </p>
9645 <div class="paragraph"><p>This is a multi-valued variable, and an empty value can be used in a
9646 higher priority configuration file (e.g. <code>.git/config</code> in a
9647 repository) to clear the values inherited from a lower priority
9648 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
9649 <div class="listingblock">
9650 <div class="content">
9651 <pre><code>Example:
9652
9653 /etc/gitconfig
9654   push.pushoption = a
9655   push.pushoption = b
9656
9657 ~/.gitconfig
9658   push.pushoption = c
9659
9660 repo/.git/config
9661   push.pushoption =
9662   push.pushoption = b
9663
9664 This will result in only b (a and c are cleared).</code></pre>
9665 </div></div>
9666 </dd>
9667 <dt class="hdlist1">
9668 push.recurseSubmodules
9669 </dt>
9670 <dd>
9671 <p>
9672         May be "check", "on-demand", "only", or "no", with the same behavior
9673         as that of "push --recurse-submodules".
9674         If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
9675         set (in which case a <em>true</em> value means <em>on-demand</em>).
9676 </p>
9677 </dd>
9678 <dt class="hdlist1">
9679 push.useForceIfIncludes
9680 </dt>
9681 <dd>
9682 <p>
9683         If set to "true", it is equivalent to specifying
9684         <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
9685         in the command line. Adding <code>--no-force-if-includes</code> at the
9686         time of push overrides this configuration setting.
9687 </p>
9688 </dd>
9689 <dt class="hdlist1">
9690 push.negotiate
9691 </dt>
9692 <dd>
9693 <p>
9694         If set to "true", attempt to reduce the size of the packfile
9695         sent by rounds of negotiation in which the client and the
9696         server attempt to find commits in common. If "false", Git will
9697         rely solely on the server&#8217;s ref advertisement to find commits
9698         in common.
9699 </p>
9700 </dd>
9701 <dt class="hdlist1">
9702 push.useBitmaps
9703 </dt>
9704 <dd>
9705 <p>
9706         If set to "false", disable use of bitmaps for "git push" even if
9707         <code>pack.useBitmaps</code> is "true", without preventing other git operations
9708         from using bitmaps. Default is true.
9709 </p>
9710 </dd>
9711 <dt class="hdlist1">
9712 rebase.backend
9713 </dt>
9714 <dd>
9715 <p>
9716         Default backend to use for rebasing.  Possible choices are
9717         <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
9718         all remaining capabilities of the apply backend, this setting
9719         may become unused.
9720 </p>
9721 </dd>
9722 <dt class="hdlist1">
9723 rebase.stat
9724 </dt>
9725 <dd>
9726 <p>
9727         Whether to show a diffstat of what changed upstream since the last
9728         rebase. False by default.
9729 </p>
9730 </dd>
9731 <dt class="hdlist1">
9732 rebase.autoSquash
9733 </dt>
9734 <dd>
9735 <p>
9736         If set to true, enable the <code>--autosquash</code> option of
9737         <a href="git-rebase.html">git-rebase(1)</a> by default for interactive mode.
9738         This can be overridden with the <code>--no-autosquash</code> option.
9739 </p>
9740 </dd>
9741 <dt class="hdlist1">
9742 rebase.autoStash
9743 </dt>
9744 <dd>
9745 <p>
9746         When set to true, automatically create a temporary stash entry
9747         before the operation begins, and apply it after the operation
9748         ends.  This means that you can run rebase on a dirty worktree.
9749         However, use with care: the final stash application after a
9750         successful rebase might result in non-trivial conflicts.
9751         This option can be overridden by the <code>--no-autostash</code> and
9752         <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
9753         Defaults to false.
9754 </p>
9755 </dd>
9756 <dt class="hdlist1">
9757 rebase.updateRefs
9758 </dt>
9759 <dd>
9760 <p>
9761         If set to true enable <code>--update-refs</code> option by default.
9762 </p>
9763 </dd>
9764 <dt class="hdlist1">
9765 rebase.missingCommitsCheck
9766 </dt>
9767 <dd>
9768 <p>
9769         If set to "warn", git rebase -i will print a warning if some
9770         commits are removed (e.g. a line was deleted), however the
9771         rebase will still proceed. If set to "error", it will print
9772         the previous warning and stop the rebase, <em>git rebase
9773         --edit-todo</em> can then be used to correct the error. If set to
9774         "ignore", no checking is done.
9775         To drop a commit without warning or error, use the <code>drop</code>
9776         command in the todo list.
9777         Defaults to "ignore".
9778 </p>
9779 </dd>
9780 <dt class="hdlist1">
9781 rebase.instructionFormat
9782 </dt>
9783 <dd>
9784 <p>
9785         A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
9786         todo list during an interactive rebase.  The format will
9787         automatically have the commit hash prepended to the format.
9788 </p>
9789 </dd>
9790 <dt class="hdlist1">
9791 rebase.abbreviateCommands
9792 </dt>
9793 <dd>
9794 <p>
9795         If set to true, <code>git rebase</code> will use abbreviated command names in the
9796         todo list resulting in something like this:
9797 </p>
9798 <div class="listingblock">
9799 <div class="content">
9800 <pre><code>        p deadbee The oneline of the commit
9801         p fa1afe1 The oneline of the next commit
9802         ...</code></pre>
9803 </div></div>
9804 <div class="paragraph"><p>instead of:</p></div>
9805 <div class="listingblock">
9806 <div class="content">
9807 <pre><code>        pick deadbee The oneline of the commit
9808         pick fa1afe1 The oneline of the next commit
9809         ...</code></pre>
9810 </div></div>
9811 <div class="paragraph"><p>Defaults to false.</p></div>
9812 </dd>
9813 <dt class="hdlist1">
9814 rebase.rescheduleFailedExec
9815 </dt>
9816 <dd>
9817 <p>
9818         Automatically reschedule <code>exec</code> commands that failed. This only makes
9819         sense in interactive mode (or when an <code>--exec</code> option was provided).
9820         This is the same as specifying the <code>--reschedule-failed-exec</code> option.
9821 </p>
9822 </dd>
9823 <dt class="hdlist1">
9824 rebase.forkPoint
9825 </dt>
9826 <dd>
9827 <p>
9828         If set to false set <code>--no-fork-point</code> option by default.
9829 </p>
9830 </dd>
9831 <dt class="hdlist1">
9832 rebase.rebaseMerges
9833 </dt>
9834 <dd>
9835 <p>
9836         Whether and how to set the <code>--rebase-merges</code> option by default. Can
9837         be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
9838         true or to <code>no-rebase-cousins</code> is equivalent to
9839         <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
9840         equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
9841         equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
9842         command line, with or without an argument, overrides any
9843         <code>rebase.rebaseMerges</code> configuration.
9844 </p>
9845 </dd>
9846 <dt class="hdlist1">
9847 rebase.maxLabelLength
9848 </dt>
9849 <dd>
9850 <p>
9851         When generating label names from commit subjects, truncate the names to
9852         this length. By default, the names are truncated to a little less than
9853         <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
9854         corresponding loose refs).
9855 </p>
9856 </dd>
9857 <dt class="hdlist1">
9858 receive.advertiseAtomic
9859 </dt>
9860 <dd>
9861 <p>
9862         By default, git-receive-pack will advertise the atomic push
9863         capability to its clients. If you don&#8217;t want to advertise this
9864         capability, set this variable to false.
9865 </p>
9866 </dd>
9867 <dt class="hdlist1">
9868 receive.advertisePushOptions
9869 </dt>
9870 <dd>
9871 <p>
9872         When set to true, git-receive-pack will advertise the push options
9873         capability to its clients. False by default.
9874 </p>
9875 </dd>
9876 <dt class="hdlist1">
9877 receive.autogc
9878 </dt>
9879 <dd>
9880 <p>
9881         By default, git-receive-pack will run "git-gc --auto" after
9882         receiving data from git-push and updating refs.  You can stop
9883         it by setting this variable to false.
9884 </p>
9885 </dd>
9886 <dt class="hdlist1">
9887 receive.certNonceSeed
9888 </dt>
9889 <dd>
9890 <p>
9891         By setting this variable to a string, <code>git receive-pack</code>
9892         will accept a <code>git push --signed</code> and verify it by using
9893         a "nonce" protected by HMAC using this string as a secret
9894         key.
9895 </p>
9896 </dd>
9897 <dt class="hdlist1">
9898 receive.certNonceSlop
9899 </dt>
9900 <dd>
9901 <p>
9902         When a <code>git push --signed</code> sends a push certificate with a
9903         "nonce" that was issued by a receive-pack serving the same
9904         repository within this many seconds, export the "nonce"
9905         found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
9906         hooks (instead of what the receive-pack asked the sending
9907         side to include).  This may allow writing checks in
9908         <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
9909         checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
9910         that records by how many seconds the nonce is stale to
9911         decide if they want to accept the certificate, they only
9912         can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
9913 </p>
9914 </dd>
9915 <dt class="hdlist1">
9916 receive.fsckObjects
9917 </dt>
9918 <dd>
9919 <p>
9920         If it is set to true, git-receive-pack will check all received
9921         objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
9922         Defaults to false. If not set, the value of
9923         <code>transfer.fsckObjects</code> is used instead.
9924 </p>
9925 </dd>
9926 <dt class="hdlist1">
9927 receive.fsck.&lt;msg-id&gt;
9928 </dt>
9929 <dd>
9930 <p>
9931         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
9932         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
9933         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
9934         details.
9935 </p>
9936 </dd>
9937 <dt class="hdlist1">
9938 receive.fsck.skipList
9939 </dt>
9940 <dd>
9941 <p>
9942         Acts like <code>fsck.skipList</code>, but is used by
9943         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
9944         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
9945         details.
9946 </p>
9947 </dd>
9948 <dt class="hdlist1">
9949 receive.keepAlive
9950 </dt>
9951 <dd>
9952 <p>
9953         After receiving the pack from the client, <code>receive-pack</code> may
9954         produce no output (if <code>--quiet</code> was specified) while processing
9955         the pack, causing some networks to drop the TCP connection.
9956         With this option set, if <code>receive-pack</code> does not transmit
9957         any data in this phase for <code>receive.keepAlive</code> seconds, it will
9958         send a short keepalive packet.  The default is 5 seconds; set
9959         to 0 to disable keepalives entirely.
9960 </p>
9961 </dd>
9962 <dt class="hdlist1">
9963 receive.unpackLimit
9964 </dt>
9965 <dd>
9966 <p>
9967         If the number of objects received in a push is below this
9968         limit then the objects will be unpacked into loose object
9969         files. However if the number of received objects equals or
9970         exceeds this limit then the received pack will be stored as
9971         a pack, after adding any missing delta bases.  Storing the
9972         pack from a push can make the push operation complete faster,
9973         especially on slow filesystems.  If not set, the value of
9974         <code>transfer.unpackLimit</code> is used instead.
9975 </p>
9976 </dd>
9977 <dt class="hdlist1">
9978 receive.maxInputSize
9979 </dt>
9980 <dd>
9981 <p>
9982         If the size of the incoming pack stream is larger than this
9983         limit, then git-receive-pack will error out, instead of
9984         accepting the pack file. If not set or set to 0, then the size
9985         is unlimited.
9986 </p>
9987 </dd>
9988 <dt class="hdlist1">
9989 receive.denyDeletes
9990 </dt>
9991 <dd>
9992 <p>
9993         If set to true, git-receive-pack will deny a ref update that deletes
9994         the ref. Use this to prevent such a ref deletion via a push.
9995 </p>
9996 </dd>
9997 <dt class="hdlist1">
9998 receive.denyDeleteCurrent
9999 </dt>
10000 <dd>
10001 <p>
10002         If set to true, git-receive-pack will deny a ref update that
10003         deletes the currently checked out branch of a non-bare repository.
10004 </p>
10005 </dd>
10006 <dt class="hdlist1">
10007 receive.denyCurrentBranch
10008 </dt>
10009 <dd>
10010 <p>
10011         If set to true or "refuse", git-receive-pack will deny a ref update
10012         to the currently checked out branch of a non-bare repository.
10013         Such a push is potentially dangerous because it brings the HEAD
10014         out of sync with the index and working tree. If set to "warn",
10015         print a warning of such a push to stderr, but allow the push to
10016         proceed. If set to false or "ignore", allow such pushes with no
10017         message. Defaults to "refuse".
10018 </p>
10019 <div class="paragraph"><p>Another option is "updateInstead" which will update the working
10020 tree if pushing into the current branch.  This option is
10021 intended for synchronizing working directories when one side is not easily
10022 accessible via interactive ssh (e.g. a live web site, hence the requirement
10023 that the working directory be clean). This mode also comes in handy when
10024 developing inside a VM to test and fix code on different Operating Systems.</p></div>
10025 <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
10026 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
10027 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p></div>
10028 </dd>
10029 <dt class="hdlist1">
10030 receive.denyNonFastForwards
10031 </dt>
10032 <dd>
10033 <p>
10034         If set to true, git-receive-pack will deny a ref update which is
10035         not a fast-forward. Use this to prevent such an update via a push,
10036         even if that push is forced. This configuration variable is
10037         set when initializing a shared repository.
10038 </p>
10039 </dd>
10040 <dt class="hdlist1">
10041 receive.hideRefs
10042 </dt>
10043 <dd>
10044 <p>
10045         This variable is the same as <code>transfer.hideRefs</code>, but applies
10046         only to <code>receive-pack</code> (and so affects pushes, but not fetches).
10047         An attempt to update or delete a hidden ref by <code>git push</code> is
10048         rejected.
10049 </p>
10050 </dd>
10051 <dt class="hdlist1">
10052 receive.procReceiveRefs
10053 </dt>
10054 <dd>
10055 <p>
10056         This is a multi-valued variable that defines reference prefixes
10057         to match the commands in <code>receive-pack</code>.  Commands matching the
10058         prefixes will be executed by an external hook "proc-receive",
10059         instead of the internal <code>execute_commands</code> function.  If this
10060         variable is not defined, the "proc-receive" hook will never be
10061         used, and all commands will be executed by the internal
10062         <code>execute_commands</code> function.
10063 </p>
10064 <div class="paragraph"><p>For example, if this variable is set to "refs/for", pushing to reference
10065 such as "refs/for/master" will not create or update a reference named
10066 "refs/for/master", but may create or update a pull request directly by
10067 running the hook "proc-receive".</p></div>
10068 <div class="paragraph"><p>Optional modifiers can be provided in the beginning of the value to filter
10069 commands for specific actions: create (a), modify (m), delete (d).
10070 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
10071 E.g.:</p></div>
10072 <div class="literalblock">
10073 <div class="content">
10074 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
10075 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
10076 </div></div>
10077 </dd>
10078 <dt class="hdlist1">
10079 receive.updateServerInfo
10080 </dt>
10081 <dd>
10082 <p>
10083         If set to true, git-receive-pack will run git-update-server-info
10084         after receiving data from git-push and updating refs.
10085 </p>
10086 </dd>
10087 <dt class="hdlist1">
10088 receive.shallowUpdate
10089 </dt>
10090 <dd>
10091 <p>
10092         If set to true, .git/shallow can be updated when new refs
10093         require new shallow roots. Otherwise those refs are rejected.
10094 </p>
10095 </dd>
10096 <dt class="hdlist1">
10097 remote.pushDefault
10098 </dt>
10099 <dd>
10100 <p>
10101         The remote to push to by default.  Overrides
10102         <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
10103         <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
10104 </p>
10105 </dd>
10106 <dt class="hdlist1">
10107 remote.&lt;name&gt;.url
10108 </dt>
10109 <dd>
10110 <p>
10111         The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
10112         <a href="git-push.html">git-push(1)</a>.
10113 </p>
10114 </dd>
10115 <dt class="hdlist1">
10116 remote.&lt;name&gt;.pushurl
10117 </dt>
10118 <dd>
10119 <p>
10120         The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
10121 </p>
10122 </dd>
10123 <dt class="hdlist1">
10124 remote.&lt;name&gt;.proxy
10125 </dt>
10126 <dd>
10127 <p>
10128         For remotes that require curl (http, https and ftp), the URL to
10129         the proxy to use for that remote.  Set to the empty string to
10130         disable proxying for that remote.
10131 </p>
10132 </dd>
10133 <dt class="hdlist1">
10134 remote.&lt;name&gt;.proxyAuthMethod
10135 </dt>
10136 <dd>
10137 <p>
10138         For remotes that require curl (http, https and ftp), the method to use for
10139         authenticating against the proxy in use (probably set in
10140         <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
10141 </p>
10142 </dd>
10143 <dt class="hdlist1">
10144 remote.&lt;name&gt;.fetch
10145 </dt>
10146 <dd>
10147 <p>
10148         The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
10149         <a href="git-fetch.html">git-fetch(1)</a>.
10150 </p>
10151 </dd>
10152 <dt class="hdlist1">
10153 remote.&lt;name&gt;.push
10154 </dt>
10155 <dd>
10156 <p>
10157         The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
10158         <a href="git-push.html">git-push(1)</a>.
10159 </p>
10160 </dd>
10161 <dt class="hdlist1">
10162 remote.&lt;name&gt;.mirror
10163 </dt>
10164 <dd>
10165 <p>
10166         If true, pushing to this remote will automatically behave
10167         as if the <code>--mirror</code> option was given on the command line.
10168 </p>
10169 </dd>
10170 <dt class="hdlist1">
10171 remote.&lt;name&gt;.skipDefaultUpdate
10172 </dt>
10173 <dd>
10174 <p>
10175         If true, this remote will be skipped by default when updating
10176         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10177         <a href="git-remote.html">git-remote(1)</a>.
10178 </p>
10179 </dd>
10180 <dt class="hdlist1">
10181 remote.&lt;name&gt;.skipFetchAll
10182 </dt>
10183 <dd>
10184 <p>
10185         If true, this remote will be skipped by default when updating
10186         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10187         <a href="git-remote.html">git-remote(1)</a>.
10188 </p>
10189 </dd>
10190 <dt class="hdlist1">
10191 remote.&lt;name&gt;.receivepack
10192 </dt>
10193 <dd>
10194 <p>
10195         The default program to execute on the remote side when pushing.  See
10196         option --receive-pack of <a href="git-push.html">git-push(1)</a>.
10197 </p>
10198 </dd>
10199 <dt class="hdlist1">
10200 remote.&lt;name&gt;.uploadpack
10201 </dt>
10202 <dd>
10203 <p>
10204         The default program to execute on the remote side when fetching.  See
10205         option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
10206 </p>
10207 </dd>
10208 <dt class="hdlist1">
10209 remote.&lt;name&gt;.tagOpt
10210 </dt>
10211 <dd>
10212 <p>
10213         Setting this value to --no-tags disables automatic tag following when
10214         fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
10215         tag from remote &lt;name&gt;, even if they are not reachable from remote
10216         branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
10217         override this setting. See options --tags and --no-tags of
10218         <a href="git-fetch.html">git-fetch(1)</a>.
10219 </p>
10220 </dd>
10221 <dt class="hdlist1">
10222 remote.&lt;name&gt;.vcs
10223 </dt>
10224 <dd>
10225 <p>
10226         Setting this to a value &lt;vcs&gt; will cause Git to interact with
10227         the remote with the git-remote-&lt;vcs&gt; helper.
10228 </p>
10229 </dd>
10230 <dt class="hdlist1">
10231 remote.&lt;name&gt;.prune
10232 </dt>
10233 <dd>
10234 <p>
10235         When set to true, fetching from this remote by default will also
10236         remove any remote-tracking references that no longer exist on the
10237         remote (as if the <code>--prune</code> option was given on the command line).
10238         Overrides <code>fetch.prune</code> settings, if any.
10239 </p>
10240 </dd>
10241 <dt class="hdlist1">
10242 remote.&lt;name&gt;.pruneTags
10243 </dt>
10244 <dd>
10245 <p>
10246         When set to true, fetching from this remote by default will also
10247         remove any local tags that no longer exist on the remote if pruning
10248         is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
10249         <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10250 </p>
10251 <div class="paragraph"><p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
10252 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
10253 </dd>
10254 <dt class="hdlist1">
10255 remote.&lt;name&gt;.promisor
10256 </dt>
10257 <dd>
10258 <p>
10259         When set to true, this remote will be used to fetch promisor
10260         objects.
10261 </p>
10262 </dd>
10263 <dt class="hdlist1">
10264 remote.&lt;name&gt;.partialclonefilter
10265 </dt>
10266 <dd>
10267 <p>
10268         The filter that will be applied when fetching from this promisor remote.
10269         Changing or clearing this value will only affect fetches for new commits.
10270         To fetch associated objects for commits already present in the local object
10271         database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.
10272 </p>
10273 </dd>
10274 <dt class="hdlist1">
10275 remotes.&lt;group&gt;
10276 </dt>
10277 <dd>
10278 <p>
10279         The list of remotes which are fetched by "git remote update
10280         &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.
10281 </p>
10282 </dd>
10283 <dt class="hdlist1">
10284 repack.useDeltaBaseOffset
10285 </dt>
10286 <dd>
10287 <p>
10288         By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
10289         delta-base offset. If you need to share your repository with
10290         Git older than version 1.4.4, either directly or via a dumb
10291         protocol such as http, then you need to set this option to
10292         "false" and repack. Access from old Git versions over the
10293         native protocol are unaffected by this option.
10294 </p>
10295 </dd>
10296 <dt class="hdlist1">
10297 repack.packKeptObjects
10298 </dt>
10299 <dd>
10300 <p>
10301         If set to true, makes <code>git repack</code> act as if
10302         <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
10303         details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10304         index is being written (either via <code>--write-bitmap-index</code> or
10305         <code>repack.writeBitmaps</code>).
10306 </p>
10307 </dd>
10308 <dt class="hdlist1">
10309 repack.useDeltaIslands
10310 </dt>
10311 <dd>
10312 <p>
10313         If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10314         was passed. Defaults to <code>false</code>.
10315 </p>
10316 </dd>
10317 <dt class="hdlist1">
10318 repack.writeBitmaps
10319 </dt>
10320 <dd>
10321 <p>
10322         When true, git will write a bitmap index when packing all
10323         objects to disk (e.g., when <code>git repack -a</code> is run).  This
10324         index can speed up the "counting objects" phase of subsequent
10325         packs created for clones and fetches, at the cost of some disk
10326         space and extra time spent on the initial repack.  This has
10327         no effect if multiple packfiles are created.
10328         Defaults to true on bare repos, false otherwise.
10329 </p>
10330 </dd>
10331 <dt class="hdlist1">
10332 repack.updateServerInfo
10333 </dt>
10334 <dd>
10335 <p>
10336         If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
10337         <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10338         when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.
10339 </p>
10340 </dd>
10341 <dt class="hdlist1">
10342 repack.cruftWindow
10343 </dt>
10344 <dt class="hdlist1">
10345 repack.cruftWindowMemory
10346 </dt>
10347 <dt class="hdlist1">
10348 repack.cruftDepth
10349 </dt>
10350 <dt class="hdlist1">
10351 repack.cruftThreads
10352 </dt>
10353 <dd>
10354 <p>
10355         Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
10356         a cruft pack and the respective parameters are not given over
10357         the command line. See similarly named <code>pack.*</code> configuration
10358         variables for defaults and meaning.
10359 </p>
10360 </dd>
10361 <dt class="hdlist1">
10362 rerere.autoUpdate
10363 </dt>
10364 <dd>
10365 <p>
10366         When set to true, <code>git-rerere</code> updates the index with the
10367         resulting contents after it cleanly resolves conflicts using
10368         previously recorded resolutions.  Defaults to false.
10369 </p>
10370 </dd>
10371 <dt class="hdlist1">
10372 rerere.enabled
10373 </dt>
10374 <dd>
10375 <p>
10376         Activate recording of resolved conflicts, so that identical
10377         conflict hunks can be resolved automatically, should they be
10378         encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
10379         enabled if there is an <code>rr-cache</code> directory under the
10380         <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
10381         repository.
10382 </p>
10383 </dd>
10384 <dt class="hdlist1">
10385 revert.reference
10386 </dt>
10387 <dd>
10388 <p>
10389         Setting this variable to true makes <code>git revert</code> behave
10390         as if the <code>--reference</code> option is given.
10391 </p>
10392 </dd>
10393 <dt class="hdlist1">
10394 safe.bareRepository
10395 </dt>
10396 <dd>
10397 <p>
10398         Specifies which bare repositories Git will work with. The currently
10399         supported values are:
10400 </p>
10401 <div class="ulist"><ul>
10402 <li>
10403 <p>
10404 <code>all</code>: Git works with all bare repositories. This is the default.
10405 </p>
10406 </li>
10407 <li>
10408 <p>
10409 <code>explicit</code>: Git only works with bare repositories specified via
10410   the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10411   environment variable (see <a href="git.html">git(1)</a>).
10412 </p>
10413 <div class="paragraph"><p>If you do not use bare repositories in your workflow, then it may be
10414 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10415 config. This will protect you from attacks that involve cloning a
10416 repository that contains a bare repository and running a Git command
10417 within that directory.</p></div>
10418 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10419 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with
10420 this value.</p></div>
10421 </li>
10422 </ul></div>
10423 </dd>
10424 <dt class="hdlist1">
10425 safe.directory
10426 </dt>
10427 <dd>
10428 <p>
10429         These config entries specify Git-tracked directories that are
10430         considered safe even if they are owned by someone other than the
10431         current user. By default, Git will refuse to even parse a Git
10432         config of a repository owned by someone else, let alone run its
10433         hooks, and this config setting allows users to specify exceptions,
10434         e.g. for intentionally shared repositories (see the <code>--shared</code>
10435         option in <a href="git-init.html">git-init(1)</a>).
10436 </p>
10437 <div class="paragraph"><p>This is a multi-valued setting, i.e. you can add more than one directory
10438 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10439 override any such directories specified in the system config), add a
10440 <code>safe.directory</code> entry with an empty value.</p></div>
10441 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10442 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with this
10443 value.</p></div>
10444 <div class="paragraph"><p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
10445 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
10446 path relative to Git&#8217;s (runtime) prefix.</p></div>
10447 <div class="paragraph"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10448 string <code>*</code>. This will allow all repositories to be treated as if their
10449 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10450 is set in system config and you want to re-enable this protection, then
10451 initialize your list with an empty value before listing the repositories
10452 that you deem safe.</p></div>
10453 <div class="paragraph"><p>As explained, Git only allows you to access repositories owned by
10454 yourself, i.e. the user who is running Git, by default.  When Git
10455 is running as <em>root</em> in a non Windows platform that provides sudo,
10456 however, git checks the SUDO_UID environment variable that sudo creates
10457 and will allow access to the uid recorded as its value in addition to
10458 the id from <em>root</em>.
10459 This is to make it easy to perform a common sequence during installation
10460 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
10461 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
10462 which id the original user has.
10463 If that is not what you would prefer and want git to only trust
10464 repositories that are owned by root instead, then you can remove
10465 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p></div>
10466 </dd>
10467 <dt class="hdlist1">
10468 sendemail.identity
10469 </dt>
10470 <dd>
10471 <p>
10472         A configuration identity. When given, causes values in the
10473         <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
10474         values in the <em>sendemail</em> section. The default identity is
10475         the value of <code>sendemail.identity</code>.
10476 </p>
10477 </dd>
10478 <dt class="hdlist1">
10479 sendemail.smtpEncryption
10480 </dt>
10481 <dd>
10482 <p>
10483         See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
10484         setting is not subject to the <em>identity</em> mechanism.
10485 </p>
10486 </dd>
10487 <dt class="hdlist1">
10488 sendemail.smtpSSLCertPath
10489 </dt>
10490 <dd>
10491 <p>
10492         Path to ca-certificates (either a directory or a single file).
10493         Set it to an empty string to disable certificate verification.
10494 </p>
10495 </dd>
10496 <dt class="hdlist1">
10497 sendemail.&lt;identity&gt;.*
10498 </dt>
10499 <dd>
10500 <p>
10501         Identity-specific versions of the <em>sendemail.*</em> parameters
10502         found below, taking precedence over those when this
10503         identity is selected, through either the command-line or
10504         <code>sendemail.identity</code>.
10505 </p>
10506 </dd>
10507 <dt class="hdlist1">
10508 sendemail.multiEdit
10509 </dt>
10510 <dd>
10511 <p>
10512         If true (default), a single editor instance will be spawned to edit
10513         files you have to edit (patches when <code>--annotate</code> is used, and the
10514         summary when <code>--compose</code> is used). If false, files will be edited one
10515         after the other, spawning a new editor each time.
10516 </p>
10517 </dd>
10518 <dt class="hdlist1">
10519 sendemail.confirm
10520 </dt>
10521 <dd>
10522 <p>
10523         Sets the default for whether to confirm before sending. Must be
10524         one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
10525         in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
10526         values.
10527 </p>
10528 </dd>
10529 <dt class="hdlist1">
10530 sendemail.aliasesFile
10531 </dt>
10532 <dd>
10533 <p>
10534         To avoid typing long email addresses, point this to one or more
10535         email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.
10536 </p>
10537 </dd>
10538 <dt class="hdlist1">
10539 sendemail.aliasFileType
10540 </dt>
10541 <dd>
10542 <p>
10543         Format of the file(s) specified in sendemail.aliasesFile. Must be
10544         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.
10545 </p>
10546 <div class="paragraph"><p>What an alias file in each format looks like can be found in
10547 the documentation of the email program of the same name. The
10548 differences and limitations from the standard formats are
10549 described below:</p></div>
10550 <div class="openblock">
10551 <div class="content">
10552 <div class="dlist"><dl>
10553 <dt class="hdlist1">
10554 sendmail
10555 </dt>
10556 <dd>
10557 <div class="ulist"><ul>
10558 <li>
10559 <p>
10560 Quoted aliases and quoted addresses are not supported: lines that
10561         contain a <code>"</code> symbol are ignored.
10562 </p>
10563 </li>
10564 <li>
10565 <p>
10566 Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
10567         supported.
10568 </p>
10569 </li>
10570 <li>
10571 <p>
10572 File inclusion (<code>:include: /path/name</code>) is not supported.
10573 </p>
10574 </li>
10575 <li>
10576 <p>
10577 Warnings are printed on the standard error output for any
10578         explicitly unsupported constructs, and any other lines that are not
10579         recognized by the parser.
10580 </p>
10581 </li>
10582 </ul></div>
10583 </dd>
10584 </dl></div>
10585 </div></div>
10586 </dd>
10587 <dt class="hdlist1">
10588 sendemail.annotate
10589 </dt>
10590 <dt class="hdlist1">
10591 sendemail.bcc
10592 </dt>
10593 <dt class="hdlist1">
10594 sendemail.cc
10595 </dt>
10596 <dt class="hdlist1">
10597 sendemail.ccCmd
10598 </dt>
10599 <dt class="hdlist1">
10600 sendemail.chainReplyTo
10601 </dt>
10602 <dt class="hdlist1">
10603 sendemail.envelopeSender
10604 </dt>
10605 <dt class="hdlist1">
10606 sendemail.from
10607 </dt>
10608 <dt class="hdlist1">
10609 sendemail.headerCmd
10610 </dt>
10611 <dt class="hdlist1">
10612 sendemail.signedOffByCc
10613 </dt>
10614 <dt class="hdlist1">
10615 sendemail.smtpPass
10616 </dt>
10617 <dt class="hdlist1">
10618 sendemail.suppressCc
10619 </dt>
10620 <dt class="hdlist1">
10621 sendemail.suppressFrom
10622 </dt>
10623 <dt class="hdlist1">
10624 sendemail.to
10625 </dt>
10626 <dt class="hdlist1">
10627 sendemail.toCmd
10628 </dt>
10629 <dt class="hdlist1">
10630 sendemail.smtpDomain
10631 </dt>
10632 <dt class="hdlist1">
10633 sendemail.smtpServer
10634 </dt>
10635 <dt class="hdlist1">
10636 sendemail.smtpServerPort
10637 </dt>
10638 <dt class="hdlist1">
10639 sendemail.smtpServerOption
10640 </dt>
10641 <dt class="hdlist1">
10642 sendemail.smtpUser
10643 </dt>
10644 <dt class="hdlist1">
10645 sendemail.thread
10646 </dt>
10647 <dt class="hdlist1">
10648 sendemail.transferEncoding
10649 </dt>
10650 <dt class="hdlist1">
10651 sendemail.validate
10652 </dt>
10653 <dt class="hdlist1">
10654 sendemail.xmailer
10655 </dt>
10656 <dd>
10657 <p>
10658         These configuration variables all provide a default for
10659         <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
10660         documentation for details.
10661 </p>
10662 </dd>
10663 <dt class="hdlist1">
10664 sendemail.signedOffCc (deprecated)
10665 </dt>
10666 <dd>
10667 <p>
10668         Deprecated alias for <code>sendemail.signedOffByCc</code>.
10669 </p>
10670 </dd>
10671 <dt class="hdlist1">
10672 sendemail.smtpBatchSize
10673 </dt>
10674 <dd>
10675 <p>
10676         Number of messages to be sent per connection, after that a relogin
10677         will happen.  If the value is 0 or undefined, send all messages in
10678         one connection.
10679         See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10680 </p>
10681 </dd>
10682 <dt class="hdlist1">
10683 sendemail.smtpReloginDelay
10684 </dt>
10685 <dd>
10686 <p>
10687         Seconds to wait before reconnecting to the smtp server.
10688         See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10689 </p>
10690 </dd>
10691 <dt class="hdlist1">
10692 sendemail.forbidSendmailVariables
10693 </dt>
10694 <dd>
10695 <p>
10696         To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
10697         will abort with a warning if any configuration options for "sendmail"
10698         exist. Set this variable to bypass the check.
10699 </p>
10700 </dd>
10701 <dt class="hdlist1">
10702 sequence.editor
10703 </dt>
10704 <dd>
10705 <p>
10706         Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
10707         The value is meant to be interpreted by the shell when it is used.
10708         It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
10709         When not configured, the default commit message editor is used instead.
10710 </p>
10711 </dd>
10712 <dt class="hdlist1">
10713 showBranch.default
10714 </dt>
10715 <dd>
10716 <p>
10717         The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
10718         See <a href="git-show-branch.html">git-show-branch(1)</a>.
10719 </p>
10720 </dd>
10721 <dt class="hdlist1">
10722 sparse.expectFilesOutsideOfPatterns
10723 </dt>
10724 <dd>
10725 <p>
10726         Typically with sparse checkouts, files not matching any
10727         sparsity patterns are marked with a SKIP_WORKTREE bit in the
10728         index and are missing from the working tree.  Accordingly, Git
10729         will ordinarily check whether files with the SKIP_WORKTREE bit
10730         are in fact present in the working tree contrary to
10731         expectations.  If Git finds any, it marks those paths as
10732         present by clearing the relevant SKIP_WORKTREE bits.  This
10733         option can be used to tell Git that such
10734         present-despite-skipped files are expected and to stop
10735         checking for them.
10736 </p>
10737 <div class="paragraph"><p>The default is <code>false</code>, which allows Git to automatically recover
10738 from the list of files in the index and working tree falling out of
10739 sync.</p></div>
10740 <div class="paragraph"><p>Set this to <code>true</code> if you are in a setup where some external factor
10741 relieves Git of the responsibility for maintaining the consistency
10742 between the presence of working tree files and sparsity patterns.  For
10743 example, if you have a Git-aware virtual file system that has a robust
10744 mechanism for keeping the working tree and the sparsity patterns up to
10745 date based on access patterns.</p></div>
10746 <div class="paragraph"><p>Regardless of this setting, Git does not check for
10747 present-despite-skipped files unless sparse checkout is enabled, so
10748 this config option has no effect unless <code>core.sparseCheckout</code> is
10749 <code>true</code>.</p></div>
10750 </dd>
10751 <dt class="hdlist1">
10752 splitIndex.maxPercentChange
10753 </dt>
10754 <dd>
10755 <p>
10756         When the split index feature is used, this specifies the
10757         percent of entries the split index can contain compared to the
10758         total number of entries in both the split index and the shared
10759         index before a new shared index is written.
10760         The value should be between 0 and 100. If the value is 0, then
10761         a new shared index is always written; if it is 100, a new
10762         shared index is never written.
10763         By default, the value is 20, so a new shared index is written
10764         if the number of entries in the split index would be greater
10765         than 20 percent of the total number of entries.
10766         See <a href="git-update-index.html">git-update-index(1)</a>.
10767 </p>
10768 </dd>
10769 <dt class="hdlist1">
10770 splitIndex.sharedIndexExpire
10771 </dt>
10772 <dd>
10773 <p>
10774         When the split index feature is used, shared index files that
10775         were not modified since the time this variable specifies will
10776         be removed when a new shared index file is created. The value
10777         "now" expires all entries immediately, and "never" suppresses
10778         expiration altogether.
10779         The default value is "2.weeks.ago".
10780         Note that a shared index file is considered modified (for the
10781         purpose of expiration) each time a new split-index file is
10782         either created based on it or read from it.
10783         See <a href="git-update-index.html">git-update-index(1)</a>.
10784 </p>
10785 </dd>
10786 <dt class="hdlist1">
10787 ssh.variant
10788 </dt>
10789 <dd>
10790 <p>
10791         By default, Git determines the command line arguments to use
10792         based on the basename of the configured SSH command (configured
10793         using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
10794         the config setting <code>core.sshCommand</code>). If the basename is
10795         unrecognized, Git will attempt to detect support of OpenSSH
10796         options by first invoking the configured SSH command with the
10797         <code>-G</code> (print configuration) option and will subsequently use
10798         OpenSSH options (if that is successful) or no options besides
10799         the host and remote command (if it fails).
10800 </p>
10801 <div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this detection.
10802 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
10803 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
10804 The default auto-detection can be explicitly requested using the value
10805 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
10806 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
10807 <div class="paragraph"><p>The current command-line parameters used for each variant are as
10808 follows:</p></div>
10809 <div class="openblock">
10810 <div class="content">
10811 <div class="ulist"><ul>
10812 <li>
10813 <p>
10814 <code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command
10815 </p>
10816 </li>
10817 <li>
10818 <p>
10819 <code>simple</code> - [username@]host command
10820 </p>
10821 </li>
10822 <li>
10823 <p>
10824 <code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command
10825 </p>
10826 </li>
10827 <li>
10828 <p>
10829 <code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command
10830 </p>
10831 </li>
10832 </ul></div>
10833 </div></div>
10834 <div class="paragraph"><p>Except for the <code>simple</code> variant, command-line parameters are likely to
10835 change as git gains new features.</p></div>
10836 </dd>
10837 <dt class="hdlist1">
10838 stash.showIncludeUntracked
10839 </dt>
10840 <dd>
10841 <p>
10842         If this is set to true, the <code>git stash show</code> command will show
10843         the untracked files of a stash entry.  Defaults to false. See
10844         the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10845 </p>
10846 </dd>
10847 <dt class="hdlist1">
10848 stash.showPatch
10849 </dt>
10850 <dd>
10851 <p>
10852         If this is set to true, the <code>git stash show</code> command without an
10853         option will show the stash entry in patch form.  Defaults to false.
10854         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10855 </p>
10856 </dd>
10857 <dt class="hdlist1">
10858 stash.showStat
10859 </dt>
10860 <dd>
10861 <p>
10862         If this is set to true, the <code>git stash show</code> command without an
10863         option will show a diffstat of the stash entry.  Defaults to true.
10864         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10865 </p>
10866 </dd>
10867 <dt class="hdlist1">
10868 status.relativePaths
10869 </dt>
10870 <dd>
10871 <p>
10872         By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
10873         current directory. Setting this variable to <code>false</code> shows paths
10874         relative to the repository root (this was the default for Git
10875         prior to v1.5.4).
10876 </p>
10877 </dd>
10878 <dt class="hdlist1">
10879 status.short
10880 </dt>
10881 <dd>
10882 <p>
10883         Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
10884         The option --no-short takes precedence over this variable.
10885 </p>
10886 </dd>
10887 <dt class="hdlist1">
10888 status.branch
10889 </dt>
10890 <dd>
10891 <p>
10892         Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
10893         The option --no-branch takes precedence over this variable.
10894 </p>
10895 </dd>
10896 <dt class="hdlist1">
10897 status.aheadBehind
10898 </dt>
10899 <dd>
10900 <p>
10901         Set to true to enable <code>--ahead-behind</code> and false to enable
10902         <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
10903         non-porcelain status formats.  Defaults to true.
10904 </p>
10905 </dd>
10906 <dt class="hdlist1">
10907 status.displayCommentPrefix
10908 </dt>
10909 <dd>
10910 <p>
10911         If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
10912         prefix before each output line (starting with
10913         <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
10914         behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
10915         Defaults to false.
10916 </p>
10917 </dd>
10918 <dt class="hdlist1">
10919 status.renameLimit
10920 </dt>
10921 <dd>
10922 <p>
10923         The number of files to consider when performing rename detection
10924         in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
10925         the value of diff.renameLimit.
10926 </p>
10927 </dd>
10928 <dt class="hdlist1">
10929 status.renames
10930 </dt>
10931 <dd>
10932 <p>
10933         Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
10934         <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
10935         disabled. If set to "true", basic rename detection is enabled.
10936         If set to "copies" or "copy", Git will detect copies, as well.
10937         Defaults to the value of diff.renames.
10938 </p>
10939 </dd>
10940 <dt class="hdlist1">
10941 status.showStash
10942 </dt>
10943 <dd>
10944 <p>
10945         If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
10946         entries currently stashed away.
10947         Defaults to false.
10948 </p>
10949 </dd>
10950 <dt class="hdlist1">
10951 status.showUntrackedFiles
10952 </dt>
10953 <dd>
10954 <p>
10955         By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
10956         files which are not currently tracked by Git. Directories which
10957         contain only untracked files, are shown with the directory name
10958         only. Showing untracked files means that Git needs to lstat() all
10959         the files in the whole repository, which might be slow on some
10960         systems. So, this variable controls how the commands display
10961         the untracked files. Possible values are:
10962 </p>
10963 <div class="openblock">
10964 <div class="content">
10965 <div class="ulist"><ul>
10966 <li>
10967 <p>
10968 <code>no</code> - Show no untracked files.
10969 </p>
10970 </li>
10971 <li>
10972 <p>
10973 <code>normal</code> - Show untracked files and directories.
10974 </p>
10975 </li>
10976 <li>
10977 <p>
10978 <code>all</code> - Show also individual files in untracked directories.
10979 </p>
10980 </li>
10981 </ul></div>
10982 </div></div>
10983 <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
10984 This variable can be overridden with the -u|--untracked-files option
10985 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
10986 </dd>
10987 <dt class="hdlist1">
10988 status.submoduleSummary
10989 </dt>
10990 <dd>
10991 <p>
10992         Defaults to false.
10993         If this is set to a non-zero number or true (identical to -1 or an
10994         unlimited number), the submodule summary will be enabled and a
10995         summary of commits for modified submodules will be shown (see
10996         --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
10997         that the summary output command will be suppressed for all
10998         submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
10999         for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
11000         exception to that rule is that status and commit will show staged
11001         submodule changes. To
11002         also view the summary for ignored submodules you can either use
11003         the --ignore-submodules=dirty command-line option or the <em>git
11004         submodule summary</em> command, which shows a similar output but does
11005         not honor these settings.
11006 </p>
11007 </dd>
11008 <dt class="hdlist1">
11009 submodule.&lt;name&gt;.url
11010 </dt>
11011 <dd>
11012 <p>
11013         The URL for a submodule. This variable is copied from the .gitmodules
11014         file to the git config via <em>git submodule init</em>. The user can change
11015         the configured URL before obtaining the submodule via <em>git submodule
11016         update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
11017         set, the presence of this variable is used as a fallback to indicate
11018         whether the submodule is of interest to git commands.
11019         See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
11020 </p>
11021 </dd>
11022 <dt class="hdlist1">
11023 submodule.&lt;name&gt;.update
11024 </dt>
11025 <dd>
11026 <p>
11027         The method by which a submodule is updated by <em>git submodule update</em>,
11028         which is the only affected command, others such as
11029         <em>git checkout --recurse-submodules</em> are unaffected. It exists for
11030         historical reasons, when <em>git submodule</em> was the only command to
11031         interact with submodules; settings like <code>submodule.active</code>
11032         and <code>pull.rebase</code> are more specific. It is populated by
11033         <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
11034         See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.
11035 </p>
11036 </dd>
11037 <dt class="hdlist1">
11038 submodule.&lt;name&gt;.branch
11039 </dt>
11040 <dd>
11041 <p>
11042         The remote branch name for a submodule, used by <code>git submodule
11043         update --remote</code>.  Set this option to override the value found in
11044         the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
11045         <a href="gitmodules.html">gitmodules(5)</a> for details.
11046 </p>
11047 </dd>
11048 <dt class="hdlist1">
11049 submodule.&lt;name&gt;.fetchRecurseSubmodules
11050 </dt>
11051 <dd>
11052 <p>
11053         This option can be used to control recursive fetching of this
11054         submodule. It can be overridden by using the --[no-]recurse-submodules
11055         command-line option to "git fetch" and "git pull".
11056         This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
11057         file.
11058 </p>
11059 </dd>
11060 <dt class="hdlist1">
11061 submodule.&lt;name&gt;.ignore
11062 </dt>
11063 <dd>
11064 <p>
11065         Defines under what circumstances "git status" and the diff family show
11066         a submodule as modified. When set to "all", it will never be considered
11067         modified (but it will nonetheless show up in the output of status and
11068         commit when it has been staged), "dirty" will ignore all changes
11069         to the submodule&#8217;s work tree and
11070         takes only differences between the HEAD of the submodule and the commit
11071         recorded in the superproject into account. "untracked" will additionally
11072         let submodules with modified tracked files in their work tree show up.
11073         Using "none" (the default when this option is not set) also shows
11074         submodules that have untracked files in their work tree as changed.
11075         This setting overrides any setting made in .gitmodules for this submodule,
11076         both settings can be overridden on the command line by using the
11077         "--ignore-submodules" option. The <em>git submodule</em> commands are not
11078         affected by this setting.
11079 </p>
11080 </dd>
11081 <dt class="hdlist1">
11082 submodule.&lt;name&gt;.active
11083 </dt>
11084 <dd>
11085 <p>
11086         Boolean value indicating if the submodule is of interest to git
11087         commands.  This config option takes precedence over the
11088         submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
11089         details.
11090 </p>
11091 </dd>
11092 <dt class="hdlist1">
11093 submodule.active
11094 </dt>
11095 <dd>
11096 <p>
11097         A repeated field which contains a pathspec used to match against a
11098         submodule&#8217;s path to determine if the submodule is of interest to git
11099         commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.
11100 </p>
11101 </dd>
11102 <dt class="hdlist1">
11103 submodule.recurse
11104 </dt>
11105 <dd>
11106 <p>
11107         A boolean indicating if commands should enable the <code>--recurse-submodules</code>
11108         option by default. Defaults to false.
11109 </p>
11110 <div class="paragraph"><p>When set to true, it can be deactivated via the
11111 <code>--no-recurse-submodules</code> option. Note that some Git commands
11112 lacking this option may call some of the above commands affected by
11113 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
11114 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
11115 For these commands a workaround is to temporarily change the
11116 configuration value by using <code>git -c submodule.recurse=0</code>.</p></div>
11117 <div class="paragraph"><p>The following list shows the commands that accept
11118 <code>--recurse-submodules</code> and whether they are supported by this
11119 setting.</p></div>
11120 <div class="ulist"><ul>
11121 <li>
11122 <p>
11123 <code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
11124 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.
11125 </p>
11126 </li>
11127 <li>
11128 <p>
11129 <code>clone</code> and <code>ls-files</code> are not supported.
11130 </p>
11131 </li>
11132 <li>
11133 <p>
11134 <code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
11135 enabled
11136 </p>
11137 </li>
11138 </ul></div>
11139 </dd>
11140 <dt class="hdlist1">
11141 submodule.propagateBranches
11142 </dt>
11143 <dd>
11144 <p>
11145         [EXPERIMENTAL] A boolean that enables branching support when
11146         using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
11147         Enabling this will allow certain commands to accept
11148         <code>--recurse-submodules</code> and certain commands that already accept
11149         <code>--recurse-submodules</code> will now consider branches.
11150         Defaults to false.
11151 </p>
11152 </dd>
11153 <dt class="hdlist1">
11154 submodule.fetchJobs
11155 </dt>
11156 <dd>
11157 <p>
11158         Specifies how many submodules are fetched/cloned at the same time.
11159         A positive integer allows up to that number of submodules fetched
11160         in parallel. A value of 0 will give some reasonable default.
11161         If unset, it defaults to 1.
11162 </p>
11163 </dd>
11164 <dt class="hdlist1">
11165 submodule.alternateLocation
11166 </dt>
11167 <dd>
11168 <p>
11169         Specifies how the submodules obtain alternates when submodules are
11170         cloned. Possible values are <code>no</code>, <code>superproject</code>.
11171         By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
11172         value is set to <code>superproject</code> the submodule to be cloned computes
11173         its alternates location relative to the superprojects alternate.
11174 </p>
11175 </dd>
11176 <dt class="hdlist1">
11177 submodule.alternateErrorStrategy
11178 </dt>
11179 <dd>
11180 <p>
11181         Specifies how to treat errors with the alternates for a submodule
11182         as computed via <code>submodule.alternateLocation</code>. Possible values are
11183         <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
11184         or <code>info</code>, and if there is an error with the computed alternate, the
11185         clone proceeds as if no alternate was specified.
11186 </p>
11187 </dd>
11188 <dt class="hdlist1">
11189 tag.forceSignAnnotated
11190 </dt>
11191 <dd>
11192 <p>
11193         A boolean to specify whether annotated tags created should be GPG signed.
11194         If <code>--annotate</code> is specified on the command line, it takes
11195         precedence over this option.
11196 </p>
11197 </dd>
11198 <dt class="hdlist1">
11199 tag.sort
11200 </dt>
11201 <dd>
11202 <p>
11203         This variable controls the sort ordering of tags when displayed by
11204         <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
11205         value of this variable will be used as the default.
11206 </p>
11207 </dd>
11208 <dt class="hdlist1">
11209 tag.gpgSign
11210 </dt>
11211 <dd>
11212 <p>
11213         A boolean to specify whether all tags should be GPG signed.
11214         Use of this option when running in an automated script can
11215         result in a large number of tags being signed. It is therefore
11216         convenient to use an agent to avoid typing your gpg passphrase
11217         several times. Note that this option doesn&#8217;t affect tag signing
11218         behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.
11219 </p>
11220 </dd>
11221 <dt class="hdlist1">
11222 tar.umask
11223 </dt>
11224 <dd>
11225 <p>
11226         This variable can be used to restrict the permission bits of
11227         tar archive entries.  The default is 0002, which turns off the
11228         world write bit.  The special value "user" indicates that the
11229         archiving user&#8217;s umask will be used instead.  See umask(2) and
11230         <a href="git-archive.html">git-archive(1)</a>.
11231 </p>
11232 </dd>
11233 </dl></div>
11234 <div class="paragraph"><p>Trace2 config settings are only read from the system and global
11235 config files; repository local and worktree config files and <code>-c</code>
11236 command line arguments are not respected.</p></div>
11237 <div class="dlist"><dl>
11238 <dt class="hdlist1">
11239 trace2.normalTarget
11240 </dt>
11241 <dd>
11242 <p>
11243         This variable controls the normal target destination.
11244         It may be overridden by the <code>GIT_TRACE2</code> environment variable.
11245         The following table shows possible values.
11246 </p>
11247 </dd>
11248 <dt class="hdlist1">
11249 trace2.perfTarget
11250 </dt>
11251 <dd>
11252 <p>
11253         This variable controls the performance target destination.
11254         It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
11255         The following table shows possible values.
11256 </p>
11257 </dd>
11258 <dt class="hdlist1">
11259 trace2.eventTarget
11260 </dt>
11261 <dd>
11262 <p>
11263         This variable controls the event target destination.
11264         It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
11265         The following table shows possible values.
11266 </p>
11267 <div class="openblock">
11268 <div class="content">
11269 <div class="ulist"><ul>
11270 <li>
11271 <p>
11272 <code>0</code> or <code>false</code> - Disables the target.
11273 </p>
11274 </li>
11275 <li>
11276 <p>
11277 <code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.
11278 </p>
11279 </li>
11280 <li>
11281 <p>
11282 <code>[2-9]</code> - Writes to the already opened file descriptor.
11283 </p>
11284 </li>
11285 <li>
11286 <p>
11287 <code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
11288 already exists and is a directory, the traces will be written to files (one
11289 per process) underneath the given directory.
11290 </p>
11291 </li>
11292 <li>
11293 <p>
11294 <code>af_unix:[&lt;socket-type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
11295 Unix DomainSocket (on platforms that support them).  Socket
11296 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
11297 try both.
11298 </p>
11299 </li>
11300 </ul></div>
11301 </div></div>
11302 </dd>
11303 <dt class="hdlist1">
11304 trace2.normalBrief
11305 </dt>
11306 <dd>
11307 <p>
11308         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11309         omitted from normal output.  May be overridden by the
11310         <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.
11311 </p>
11312 </dd>
11313 <dt class="hdlist1">
11314 trace2.perfBrief
11315 </dt>
11316 <dd>
11317 <p>
11318         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11319         omitted from PERF output.  May be overridden by the
11320         <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.
11321 </p>
11322 </dd>
11323 <dt class="hdlist1">
11324 trace2.eventBrief
11325 </dt>
11326 <dd>
11327 <p>
11328         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11329         omitted from event output.  May be overridden by the
11330         <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.
11331 </p>
11332 </dd>
11333 <dt class="hdlist1">
11334 trace2.eventNesting
11335 </dt>
11336 <dd>
11337 <p>
11338         Integer.  Specifies desired depth of nested regions in the
11339         event output.  Regions deeper than this value will be
11340         omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
11341         environment variable.  Defaults to 2.
11342 </p>
11343 </dd>
11344 <dt class="hdlist1">
11345 trace2.configParams
11346 </dt>
11347 <dd>
11348 <p>
11349         A comma-separated list of patterns of "important" config
11350         settings that should be recorded in the trace2 output.
11351         For example, <code>core.*,remote.*.url</code> would cause the trace2
11352         output to contain events listing each configured remote.
11353         May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
11354         variable.  Unset by default.
11355 </p>
11356 </dd>
11357 <dt class="hdlist1">
11358 trace2.envVars
11359 </dt>
11360 <dd>
11361 <p>
11362         A comma-separated list of "important" environment variables that should
11363         be recorded in the trace2 output.  For example,
11364         <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
11365         contain events listing the overrides for HTTP user agent and the
11366         location of the Git configuration file (assuming any are set).  May be
11367         overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
11368         default.
11369 </p>
11370 </dd>
11371 <dt class="hdlist1">
11372 trace2.destinationDebug
11373 </dt>
11374 <dd>
11375 <p>
11376         Boolean.  When true Git will print error messages when a
11377         trace target destination cannot be opened for writing.
11378         By default, these errors are suppressed and tracing is
11379         silently disabled.  May be overridden by the
11380         <code>GIT_TRACE2_DST_DEBUG</code> environment variable.
11381 </p>
11382 </dd>
11383 <dt class="hdlist1">
11384 trace2.maxFiles
11385 </dt>
11386 <dd>
11387 <p>
11388         Integer.  When writing trace files to a target directory, do not
11389         write additional traces if doing so would exceed this many files. Instead,
11390         write a sentinel file that will block further tracing to this
11391         directory. Defaults to 0, which disables this check.
11392 </p>
11393 </dd>
11394 <dt class="hdlist1">
11395 transfer.credentialsInUrl
11396 </dt>
11397 <dd>
11398 <p>
11399         A configured URL can contain plaintext credentials in the form
11400         <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
11401         to warn or forbid the use of such configuration (in favor of
11402         using <a href="git-credential.html">git-credential(1)</a>). This will be used on
11403         <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>,
11404         and any other direct use of the configured URL.
11405 </p>
11406 <div class="paragraph"><p>Note that this is currently limited to detecting credentials in
11407 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
11408 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p></div>
11409 <div class="paragraph"><p>You might want to enable this to prevent inadvertent credentials
11410 exposure, e.g. because:</p></div>
11411 <div class="ulist"><ul>
11412 <li>
11413 <p>
11414 The OS or system where you&#8217;re running git may not provide a way or
11415   otherwise allow you to configure the permissions of the
11416   configuration file where the username and/or password are stored.
11417 </p>
11418 </li>
11419 <li>
11420 <p>
11421 Even if it does, having such data stored "at rest" might expose you
11422   in other ways, e.g. a backup process might copy the data to another
11423   system.
11424 </p>
11425 </li>
11426 <li>
11427 <p>
11428 The git programs will pass the full URL to one another as arguments
11429   on the command-line, meaning the credentials will be exposed to other
11430   unprivileged users on systems that allow them to see the full
11431   process list of other users. On linux the "hidepid" setting
11432   documented in procfs(5) allows for configuring this behavior.
11433 </p>
11434 <div class="paragraph"><p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
11435 concerned about credentials exposure due to storing sensitive
11436 data in git&#8217;s configuration files. If you do want to use this, set
11437 <code>transfer.credentialsInUrl</code> to one of these values:</p></div>
11438 </li>
11439 <li>
11440 <p>
11441 <code>allow</code> (default): Git will proceed with its activity without warning.
11442 </p>
11443 </li>
11444 <li>
11445 <p>
11446 <code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
11447   with a plaintext credential.
11448 </p>
11449 </li>
11450 <li>
11451 <p>
11452 <code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
11453   with a plaintext credential.
11454 </p>
11455 </li>
11456 </ul></div>
11457 </dd>
11458 <dt class="hdlist1">
11459 transfer.fsckObjects
11460 </dt>
11461 <dd>
11462 <p>
11463         When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
11464         not set, the value of this variable is used instead.
11465         Defaults to false.
11466 </p>
11467 <div class="paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
11468 object or a link to a nonexistent object. In addition, various other
11469 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
11470 and potential security issues like the existence of a <code>.GIT</code> directory
11471 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
11472 and v2.17.1 for details). Other sanity and security checks may be
11473 added in future releases.</p></div>
11474 <div class="paragraph"><p>On the receiving side, failing fsckObjects will make those objects
11475 unreachable, see "QUARANTINE ENVIRONMENT" in
11476 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
11477 instead be left unreferenced in the repository.</p></div>
11478 <div class="paragraph"><p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
11479 implementation it cannot be relied upon to leave the object store
11480 clean like <code>receive.fsckObjects</code> can.</p></div>
11481 <div class="paragraph"><p>As objects are unpacked they&#8217;re written to the object store, so there
11482 can be cases where malicious objects get introduced even though the
11483 "fetch" failed, only to have a subsequent "fetch" succeed because only
11484 new incoming objects are checked, not those that have already been
11485 written to the object store. That difference in behavior should not be
11486 relied upon. In the future, such objects may be quarantined for
11487 "fetch" as well.</p></div>
11488 <div class="paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
11489 environment if they&#8217;d like the same protection as "push". E.g. in the
11490 case of an internal mirror do the mirroring in two steps, one to fetch
11491 the untrusted objects, and then do a second "push" (which will use the
11492 quarantine) to another internal repo, and have internal clients
11493 consume this pushed-to repository, or embargo internal fetches and
11494 only allow them once a full "fsck" has run (and no new fetches have
11495 happened in the meantime).</p></div>
11496 </dd>
11497 <dt class="hdlist1">
11498 transfer.hideRefs
11499 </dt>
11500 <dd>
11501 <p>
11502         String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
11503         refs to omit from their initial advertisements.  Use more than
11504         one definition to specify multiple prefix strings. A ref that is
11505         under the hierarchies listed in the value of this variable is
11506         excluded, and is hidden when responding to <code>git push</code> or <code>git
11507         fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
11508         program-specific versions of this config.
11509 </p>
11510 <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
11511 explicitly exposing it, even if an earlier entry marked it as hidden.
11512 If you have multiple hideRefs values, later entries override earlier ones
11513 (and entries in more-specific config files override less-specific ones).</p></div>
11514 <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
11515 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
11516 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
11517 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
11518 <div class="paragraph"><p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
11519 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
11520 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
11521 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
11522 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
11523 <code>receive-pack</code>, on the other hand, will still advertise the object id the
11524 ref is pointing to without mentioning its name (a so-called ".have" line).</p></div>
11525 <div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
11526 objects via the techniques described in the "SECURITY" section of the
11527 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
11528 separate repository.</p></div>
11529 </dd>
11530 <dt class="hdlist1">
11531 transfer.unpackLimit
11532 </dt>
11533 <dd>
11534 <p>
11535         When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
11536         not set, the value of this variable is used instead.
11537         The default value is 100.
11538 </p>
11539 </dd>
11540 <dt class="hdlist1">
11541 transfer.advertiseSID
11542 </dt>
11543 <dd>
11544 <p>
11545         Boolean. When true, client and server processes will advertise their
11546         unique session IDs to their remote counterpart. Defaults to false.
11547 </p>
11548 </dd>
11549 <dt class="hdlist1">
11550 transfer.bundleURI
11551 </dt>
11552 <dd>
11553 <p>
11554         When <code>true</code>, local <code>git clone</code> commands will request bundle
11555         information from the remote server (if advertised) and download
11556         bundles before continuing the clone through the Git protocol.
11557         Defaults to <code>false</code>.
11558 </p>
11559 </dd>
11560 <dt class="hdlist1">
11561 transfer.advertiseObjectInfo
11562 </dt>
11563 <dd>
11564 <p>
11565         When <code>true</code>, the <code>object-info</code> capability is advertised by
11566         servers. Defaults to false.
11567 </p>
11568 </dd>
11569 <dt class="hdlist1">
11570 uploadarchive.allowUnreachable
11571 </dt>
11572 <dd>
11573 <p>
11574         If true, allow clients to use <code>git archive --remote</code> to request
11575         any tree, whether reachable from the ref tips or not. See the
11576         discussion in the "SECURITY" section of
11577         <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
11578         <code>false</code>.
11579 </p>
11580 </dd>
11581 <dt class="hdlist1">
11582 uploadpack.hideRefs
11583 </dt>
11584 <dd>
11585 <p>
11586         This variable is the same as <code>transfer.hideRefs</code>, but applies
11587         only to <code>upload-pack</code> (and so affects only fetches, not pushes).
11588         An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
11589         also <code>uploadpack.allowTipSHA1InWant</code>.
11590 </p>
11591 </dd>
11592 <dt class="hdlist1">
11593 uploadpack.allowTipSHA1InWant
11594 </dt>
11595 <dd>
11596 <p>
11597         When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
11598         to accept a fetch request that asks for an object at the tip
11599         of a hidden ref (by default, such a request is rejected).
11600         See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
11601         may be able to steal objects via the techniques described in the
11602         "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
11603         best to keep private data in a separate repository.
11604 </p>
11605 </dd>
11606 <dt class="hdlist1">
11607 uploadpack.allowReachableSHA1InWant
11608 </dt>
11609 <dd>
11610 <p>
11611         Allow <code>upload-pack</code> to accept a fetch request that asks for an
11612         object that is reachable from any ref tip. However, note that
11613         calculating object reachability is computationally expensive.
11614         Defaults to <code>false</code>.  Even if this is false, a client may be able
11615         to steal objects via the techniques described in the "SECURITY"
11616         section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
11617         keep private data in a separate repository.
11618 </p>
11619 </dd>
11620 <dt class="hdlist1">
11621 uploadpack.allowAnySHA1InWant
11622 </dt>
11623 <dd>
11624 <p>
11625         Allow <code>upload-pack</code> to accept a fetch request that asks for any
11626         object at all.
11627         Defaults to <code>false</code>.
11628 </p>
11629 </dd>
11630 <dt class="hdlist1">
11631 uploadpack.keepAlive
11632 </dt>
11633 <dd>
11634 <p>
11635         When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
11636         quiet period while <code>pack-objects</code> prepares the pack. Normally
11637         it would output progress information, but if <code>--quiet</code> was used
11638         for the fetch, <code>pack-objects</code> will output nothing at all until
11639         the pack data begins. Some clients and networks may consider
11640         the server to be hung and give up. Setting this option instructs
11641         <code>upload-pack</code> to send an empty keepalive packet every
11642         <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
11643         disables keepalive packets entirely. The default is 5 seconds.
11644 </p>
11645 </dd>
11646 <dt class="hdlist1">
11647 uploadpack.packObjectsHook
11648 </dt>
11649 <dd>
11650 <p>
11651         If this option is set, when <code>upload-pack</code> would run
11652         <code>git pack-objects</code> to create a packfile for a client, it will
11653         run this shell command instead.  The <code>pack-objects</code> command and
11654         arguments it <em>would</em> have run (including the <code>git pack-objects</code>
11655         at the beginning) are appended to the shell command. The stdin
11656         and stdout of the hook are treated as if <code>pack-objects</code> itself
11657         was run. I.e., <code>upload-pack</code> will feed input intended for
11658         <code>pack-objects</code> to the hook, and expects a completed packfile on
11659         stdout.
11660 </p>
11661 <div class="paragraph"><p>Note that this configuration variable is only respected when it is specified
11662 in protected configuration (see <a href="#SCOPES">[SCOPES]</a>). This is a safety measure
11663 against fetching from untrusted repositories.</p></div>
11664 </dd>
11665 <dt class="hdlist1">
11666 uploadpack.allowFilter
11667 </dt>
11668 <dd>
11669 <p>
11670         If this option is set, <code>upload-pack</code> will support partial
11671         clone and partial fetch object filtering.
11672 </p>
11673 </dd>
11674 <dt class="hdlist1">
11675 uploadpackfilter.allow
11676 </dt>
11677 <dd>
11678 <p>
11679         Provides a default value for unspecified object filters (see: the
11680         below configuration variable). If set to <code>true</code>, this will also
11681         enable all filters which get added in the future.
11682         Defaults to <code>true</code>.
11683 </p>
11684 </dd>
11685 <dt class="hdlist1">
11686 uploadpackfilter.&lt;filter&gt;.allow
11687 </dt>
11688 <dd>
11689 <p>
11690         Explicitly allow or ban the object filter corresponding to
11691         <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
11692         <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
11693         If using combined filters, both <code>combine</code> and all of the nested
11694         filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.
11695 </p>
11696 </dd>
11697 <dt class="hdlist1">
11698 uploadpackfilter.tree.maxDepth
11699 </dt>
11700 <dd>
11701 <p>
11702         Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
11703         <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
11704         <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
11705         variable had already been set. Has no effect if unset.
11706 </p>
11707 </dd>
11708 <dt class="hdlist1">
11709 uploadpack.allowRefInWant
11710 </dt>
11711 <dd>
11712 <p>
11713         If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
11714         feature of the protocol version 2 <code>fetch</code> command.  This feature
11715         is intended for the benefit of load-balanced servers which may
11716         not have the same view of what OIDs their refs point to due to
11717         replication delay.
11718 </p>
11719 </dd>
11720 <dt class="hdlist1">
11721 url.&lt;base&gt;.insteadOf
11722 </dt>
11723 <dd>
11724 <p>
11725         Any URL that starts with this value will be rewritten to
11726         start, instead, with &lt;base&gt;. In cases where some site serves a
11727         large number of repositories, and serves them with multiple
11728         access methods, and some users need to use different access
11729         methods, this feature allows people to specify any of the
11730         equivalent URLs and have Git automatically rewrite the URL to
11731         the best alternative for the particular user, even for a
11732         never-before-seen repository on the site.  When more than one
11733         insteadOf strings match a given URL, the longest match is used.
11734 </p>
11735 <div class="paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
11736 URL. If the rewrite changes the URL to use a custom protocol or remote
11737 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
11738 the request.  In particular, protocols you expect to use for submodules
11739 must be set to <code>always</code> rather than the default of <code>user</code>. See the
11740 description of <code>protocol.allow</code> above.</p></div>
11741 </dd>
11742 <dt class="hdlist1">
11743 url.&lt;base&gt;.pushInsteadOf
11744 </dt>
11745 <dd>
11746 <p>
11747         Any URL that starts with this value will not be pushed to;
11748         instead, it will be rewritten to start with &lt;base&gt;, and the
11749         resulting URL will be pushed to. In cases where some site serves
11750         a large number of repositories, and serves them with multiple
11751         access methods, some of which do not allow push, this feature
11752         allows people to specify a pull-only URL and have Git
11753         automatically use an appropriate URL to push, even for a
11754         never-before-seen repository on the site.  When more than one
11755         pushInsteadOf strings match a given URL, the longest match is
11756         used.  If a remote has an explicit pushurl, Git will ignore this
11757         setting for that remote.
11758 </p>
11759 </dd>
11760 <dt class="hdlist1">
11761 user.name
11762 </dt>
11763 <dt class="hdlist1">
11764 user.email
11765 </dt>
11766 <dt class="hdlist1">
11767 author.name
11768 </dt>
11769 <dt class="hdlist1">
11770 author.email
11771 </dt>
11772 <dt class="hdlist1">
11773 committer.name
11774 </dt>
11775 <dt class="hdlist1">
11776 committer.email
11777 </dt>
11778 <dd>
11779 <p>
11780         The <code>user.name</code> and <code>user.email</code> variables determine what ends
11781         up in the <code>author</code> and <code>committer</code> fields of commit
11782         objects.
11783         If you need the <code>author</code> or <code>committer</code> to be different, the
11784         <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
11785         <code>committer.email</code> variables can be set.
11786         All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
11787         <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
11788         <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.
11789 </p>
11790 <div class="paragraph"><p>Note that the <code>name</code> forms of these variables conventionally refer to
11791 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
11792 environment variables section of <a href="git.html">git(1)</a> for more information on
11793 these settings and the <code>credential.username</code> option if you&#8217;re looking
11794 for authentication credentials instead.</p></div>
11795 </dd>
11796 <dt class="hdlist1">
11797 user.useConfigOnly
11798 </dt>
11799 <dd>
11800 <p>
11801         Instruct Git to avoid trying to guess defaults for <code>user.email</code>
11802         and <code>user.name</code>, and instead retrieve the values only from the
11803         configuration. For example, if you have multiple email addresses
11804         and would like to use a different one for each repository, then
11805         with this configuration option set to <code>true</code> in the global config
11806         along with a name, Git will prompt you to set up an email before
11807         making new commits in a newly cloned repository.
11808         Defaults to <code>false</code>.
11809 </p>
11810 </dd>
11811 <dt class="hdlist1">
11812 user.signingKey
11813 </dt>
11814 <dd>
11815 <p>
11816         If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
11817         key you want it to automatically when creating a signed tag or
11818         commit, you can override the default selection with this variable.
11819         This option is passed unchanged to gpg&#8217;s --local-user parameter,
11820         so you may specify a key using any method that gpg supports.
11821         If gpg.format is set to <code>ssh</code> this can contain the path to either
11822         your private ssh key or the public key when ssh-agent is used.
11823         Alternatively it can contain a public key prefixed with <code>key::</code>
11824         directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
11825         needs to be available via ssh-agent. If not set Git will call
11826         gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
11827         first key available. For backward compatibility, a raw key which
11828         begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
11829         as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
11830         use the <code>key::</code> form instead.
11831 </p>
11832 </dd>
11833 <dt class="hdlist1">
11834 versionsort.prereleaseSuffix (deprecated)
11835 </dt>
11836 <dd>
11837 <p>
11838         Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
11839         <code>versionsort.suffix</code> is set.
11840 </p>
11841 </dd>
11842 <dt class="hdlist1">
11843 versionsort.suffix
11844 </dt>
11845 <dd>
11846 <p>
11847         Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
11848         with the same base version but different suffixes are still sorted
11849         lexicographically, resulting e.g. in prerelease tags appearing
11850         after the main release (e.g. "1.0-rc1" after "1.0").  This
11851         variable can be specified to determine the sorting order of tags
11852         with different suffixes.
11853 </p>
11854 <div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
11855 that suffix will appear before the corresponding main release.  E.g. if
11856 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
11857 "1.0".  If specified multiple times, once per suffix, then the order of
11858 suffixes in the configuration will determine the sorting order of tagnames
11859 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
11860 configuration, then all "1.0-preX" tags will be listed before any
11861 "1.0-rcX" tags.  The placement of the main release tag relative to tags
11862 with various suffixes can be determined by specifying the empty suffix
11863 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
11864 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
11865 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
11866 "v4.8-bfsX".</p></div>
11867 <div class="paragraph"><p>If more than one suffix matches the same tagname, then that tagname will
11868 be sorted according to the suffix which starts at the earliest position in
11869 the tagname.  If more than one different matching suffix starts at
11870 that earliest position, then that tagname will be sorted according to the
11871 longest of those suffixes.
11872 The sorting order between different suffixes is undefined if they are
11873 in multiple config files.</p></div>
11874 </dd>
11875 <dt class="hdlist1">
11876 web.browser
11877 </dt>
11878 <dd>
11879 <p>
11880         Specify a web browser that may be used by some commands.
11881         Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
11882         may use it.
11883 </p>
11884 </dd>
11885 <dt class="hdlist1">
11886 worktree.guessRemote
11887 </dt>
11888 <dd>
11889 <p>
11890         If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
11891         <code>--detach</code> is used, then <code>git worktree add</code> defaults to
11892         creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
11893         set to true, <code>worktree add</code> tries to find a remote-tracking
11894         branch whose name uniquely matches the new branch name.  If
11895         such a branch exists, it is checked out and set as "upstream"
11896         for the new branch.  If no such match can be found, it falls
11897         back to creating a new branch from the current HEAD.
11898 </p>
11899 </dd>
11900 </dl></div>
11901 </div>
11902 </div>
11903 </div>
11904 <div class="sect1">
11905 <h2 id="_bugs">BUGS</h2>
11906 <div class="sectionbody">
11907 <div class="paragraph"><p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
11908 will result in adding a multi-line key instead of a change, if the subsection
11909 is given with at least one uppercase character. For example when the config
11910 looks like</p></div>
11911 <div class="listingblock">
11912 <div class="content">
11913 <pre><code>  [section.subsection]
11914     key = value1</code></pre>
11915 </div></div>
11916 <div class="paragraph"><p>and running <code>git config section.Subsection.key value2</code> will result in</p></div>
11917 <div class="listingblock">
11918 <div class="content">
11919 <pre><code>  [section.subsection]
11920     key = value1
11921     key = value2</code></pre>
11922 </div></div>
11923 </div>
11924 </div>
11925 <div class="sect1">
11926 <h2 id="_git">GIT</h2>
11927 <div class="sectionbody">
11928 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
11929 </div>
11930 </div>
11931 </div>
11932 <div id="footnotes"><hr /></div>
11933 <div id="footer">
11934 <div id="footer-text">
11935 Last updated
11936  2024-02-08 15:45:59 PST
11937 </div>
11938 </div>
11939 </body>
11940 </html>