git-config.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-config(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-config(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-config -
 743    Get and set repository or global options
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] &lt;name&gt; [&lt;value&gt; [&lt;value-pattern&gt;]]
 753 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] --add &lt;name&gt; &lt;value&gt;
 754 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--fixed-value] --replace-all &lt;name&gt; &lt;value&gt; [&lt;value-pattern&gt;]
 755 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get &lt;name&gt; [&lt;value-pattern&gt;]
 756 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all &lt;name&gt; [&lt;value-pattern&gt;]
 757 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp &lt;name-regex&gt; [&lt;value-pattern&gt;]
 758 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [-z|--null] --get-urlmatch &lt;name&gt; &lt;URL&gt;
 759 <em>git config</em> [&lt;file-option&gt;] [--fixed-value] --unset &lt;name&gt; [&lt;value-pattern&gt;]
 760 <em>git config</em> [&lt;file-option&gt;] [--fixed-value] --unset-all &lt;name&gt; [&lt;value-pattern&gt;]
 761 <em>git config</em> [&lt;file-option&gt;] --rename-section &lt;old-name&gt; &lt;new-name&gt;
 762 <em>git config</em> [&lt;file-option&gt;] --remove-section &lt;name&gt;
 763 <em>git config</em> [&lt;file-option&gt;] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
 764 <em>git config</em> [&lt;file-option&gt;] --get-color &lt;name&gt; [&lt;default&gt;]
 765 <em>git config</em> [&lt;file-option&gt;] --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]
 766 <em>git config</em> [&lt;file-option&gt;] -e | --edit</pre>
 767 <div class="attribution">
 768 </div></div>
 769 </div>
 770 </div>
 771 <div class="sect1">
 772 <h2 id="_description">DESCRIPTION</h2>
 773 <div class="sectionbody">
 774 <div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is
 775 actually the section and the key separated by a dot, and the value will be
 776 escaped.</p></div>
 777 <div class="paragraph"><p>Multiple lines can be added to an option by using the <code>--add</code> option.
 778 If you want to update or unset an option which can occur on multiple
 779 lines, a <code>value-pattern</code> (which is an extended regular expression,
 780 unless the <code>--fixed-value</code> option is given) needs to be given.  Only the
 781 existing values that match the pattern are updated or unset.  If
 782 you want to handle the lines that do <strong>not</strong> match the pattern, just
 783 prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>),
 784 but note that this only works when the <code>--fixed-value</code> option is not
 785 in use.</p></div>
 786 <div class="paragraph"><p>The <code>--type=&lt;type&gt;</code> option instructs <em>git config</em> to ensure that incoming and
 787 outgoing values are canonicalize-able under the given &lt;type&gt;.  If no
 788 <code>--type=&lt;type&gt;</code> is given, no canonicalization will be performed. Callers may
 789 unset an existing <code>--type</code> specifier with <code>--no-type</code>.</p></div>
 790 <div class="paragraph"><p>When reading, the values are read from the system, global and
 791 repository local configuration files by default, and options
 792 <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code> and
 793 <code>--file &lt;filename&gt;</code> can be used to tell the command to read from only
 794 that location (see <a href="#FILES">[FILES]</a>).</p></div>
 795 <div class="paragraph"><p>When writing, the new value is written to the repository local
 796 configuration file by default, and options <code>--system</code>, <code>--global</code>,
 797 <code>--worktree</code>, <code>--file &lt;filename&gt;</code> can be used to tell the command to
 798 write to that location (you can say <code>--local</code> but that is the
 799 default).</p></div>
 800 <div class="paragraph"><p>This command will fail with non-zero status upon error.  Some exit
 801 codes are:</p></div>
 802 <div class="ulist"><ul>
 803 <li>
 804 <p>
 805 The section or key is invalid (ret=1),
 806 </p>
 807 </li>
 808 <li>
 809 <p>
 810 no section or name was provided (ret=2),
 811 </p>
 812 </li>
 813 <li>
 814 <p>
 815 the config file is invalid (ret=3),
 816 </p>
 817 </li>
 818 <li>
 819 <p>
 820 the config file cannot be written (ret=4),
 821 </p>
 822 </li>
 823 <li>
 824 <p>
 825 you try to unset an option which does not exist (ret=5),
 826 </p>
 827 </li>
 828 <li>
 829 <p>
 830 you try to unset/set an option for which multiple lines match (ret=5), or
 831 </p>
 832 </li>
 833 <li>
 834 <p>
 835 you try to use an invalid regexp (ret=6).
 836 </p>
 837 </li>
 838 </ul></div>
 839 <div class="paragraph"><p>On success, the command returns the exit code 0.</p></div>
 840 <div class="paragraph"><p>A list of all available configuration variables can be obtained using the
 841 <code>git help --config</code> command.</p></div>
 842 </div>
 843 </div>
 844 <div class="sect1">
 845 <h2 id="OPTIONS">OPTIONS</h2>
 846 <div class="sectionbody">
 847 <div class="dlist"><dl>
 848 <dt class="hdlist1">
 849 --replace-all
 850 </dt>
 851 <dd>
 852 <p>
 853         Default behavior is to replace at most one line. This replaces
 854         all lines matching the key (and optionally the <code>value-pattern</code>).
 855 </p>
 856 </dd>
 857 <dt class="hdlist1">
 858 --add
 859 </dt>
 860 <dd>
 861 <p>
 862         Adds a new line to the option without altering any existing
 863         values.  This is the same as providing <em>^$</em> as the <code>value-pattern</code>
 864         in <code>--replace-all</code>.
 865 </p>
 866 </dd>
 867 <dt class="hdlist1">
 868 --get
 869 </dt>
 870 <dd>
 871 <p>
 872         Get the value for a given key (optionally filtered by a regex
 873         matching the value). Returns error code 1 if the key was not
 874         found and the last value if multiple key values were found.
 875 </p>
 876 </dd>
 877 <dt class="hdlist1">
 878 --get-all
 879 </dt>
 880 <dd>
 881 <p>
 882         Like get, but returns all values for a multi-valued key.
 883 </p>
 884 </dd>
 885 <dt class="hdlist1">
 886 --get-regexp
 887 </dt>
 888 <dd>
 889 <p>
 890         Like --get-all, but interprets the name as a regular expression and
 891         writes out the key names.  Regular expression matching is currently
 892         case-sensitive and done against a canonicalized version of the key
 893         in which section and variable names are lowercased, but subsection
 894         names are not.
 895 </p>
 896 </dd>
 897 <dt class="hdlist1">
 898 --get-urlmatch &lt;name&gt; &lt;URL&gt;
 899 </dt>
 900 <dd>
 901 <p>
 902         When given a two-part name section.key, the value for
 903         section.&lt;URL&gt;.key whose &lt;URL&gt; part matches the best to the
 904         given URL is returned (if no such key exists, the value for
 905         section.key is used as a fallback).  When given just the
 906         section as name, do so for all the keys in the section and
 907         list them.  Returns error code 1 if no value is found.
 908 </p>
 909 </dd>
 910 <dt class="hdlist1">
 911 --global
 912 </dt>
 913 <dd>
 914 <p>
 915         For writing options: write to global <code>~/.gitconfig</code> file
 916         rather than the repository <code>.git/config</code>, write to
 917         <code>$XDG_CONFIG_HOME/git/config</code> file if this file exists and the
 918         <code>~/.gitconfig</code> file doesn&#8217;t.
 919 </p>
 920 <div class="paragraph"><p>For reading options: read only from global <code>~/.gitconfig</code> and from
 921 <code>$XDG_CONFIG_HOME/git/config</code> rather than from all available files.</p></div>
 922 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 923 </dd>
 924 <dt class="hdlist1">
 925 --system
 926 </dt>
 927 <dd>
 928 <p>
 929         For writing options: write to system-wide
 930         <code>$(prefix)/etc/gitconfig</code> rather than the repository
 931         <code>.git/config</code>.
 932 </p>
 933 <div class="paragraph"><p>For reading options: read only from system-wide <code>$(prefix)/etc/gitconfig</code>
 934 rather than from all available files.</p></div>
 935 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 936 </dd>
 937 <dt class="hdlist1">
 938 --local
 939 </dt>
 940 <dd>
 941 <p>
 942         For writing options: write to the repository <code>.git/config</code> file.
 943         This is the default behavior.
 944 </p>
 945 <div class="paragraph"><p>For reading options: read only from the repository <code>.git/config</code> rather than
 946 from all available files.</p></div>
 947 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 948 </dd>
 949 <dt class="hdlist1">
 950 --worktree
 951 </dt>
 952 <dd>
 953 <p>
 954         Similar to <code>--local</code> except that <code>$GIT_DIR/config.worktree</code> is
 955         read from or written to if <code>extensions.worktreeConfig</code> is
 956         enabled. If not it&#8217;s the same as <code>--local</code>. Note that <code>$GIT_DIR</code>
 957         is equal to <code>$GIT_COMMON_DIR</code> for the main working tree, but is of
 958         the form <code>$GIT_DIR/worktrees/&lt;id&gt;/</code> for other working trees. See
 959         <a href="git-worktree.html">git-worktree(1)</a> to learn how to enable
 960         <code>extensions.worktreeConfig</code>.
 961 </p>
 962 </dd>
 963 <dt class="hdlist1">
 964 -f &lt;config-file&gt;
 965 </dt>
 966 <dt class="hdlist1">
 967 --file &lt;config-file&gt;
 968 </dt>
 969 <dd>
 970 <p>
 971         For writing options: write to the specified file rather than the
 972         repository <code>.git/config</code>.
 973 </p>
 974 <div class="paragraph"><p>For reading options: read only from the specified file rather than from all
 975 available files.</p></div>
 976 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 977 </dd>
 978 <dt class="hdlist1">
 979 --blob &lt;blob&gt;
 980 </dt>
 981 <dd>
 982 <p>
 983         Similar to <code>--file</code> but use the given blob instead of a file. E.g.
 984         you can use <em>master:.gitmodules</em> to read values from the file
 985         <em>.gitmodules</em> in the master branch. See "SPECIFYING REVISIONS"
 986         section in <a href="gitrevisions.html">gitrevisions(7)</a> for a more complete list of
 987         ways to spell blob names.
 988 </p>
 989 </dd>
 990 <dt class="hdlist1">
 991 --remove-section
 992 </dt>
 993 <dd>
 994 <p>
 995         Remove the given section from the configuration file.
 996 </p>
 997 </dd>
 998 <dt class="hdlist1">
 999 --rename-section
1000 </dt>
1001 <dd>
1002 <p>
1003         Rename the given section to a new name.
1004 </p>
1005 </dd>
1006 <dt class="hdlist1">
1007 --unset
1008 </dt>
1009 <dd>
1010 <p>
1011         Remove the line matching the key from config file.
1012 </p>
1013 </dd>
1014 <dt class="hdlist1">
1015 --unset-all
1016 </dt>
1017 <dd>
1018 <p>
1019         Remove all lines matching the key from config file.
1020 </p>
1021 </dd>
1022 <dt class="hdlist1">
1023 -l
1024 </dt>
1025 <dt class="hdlist1">
1026 --list
1027 </dt>
1028 <dd>
1029 <p>
1030         List all variables set in config file, along with their values.
1031 </p>
1032 </dd>
1033 <dt class="hdlist1">
1034 --fixed-value
1035 </dt>
1036 <dd>
1037 <p>
1038         When used with the <code>value-pattern</code> argument, treat <code>value-pattern</code> as
1039         an exact string instead of a regular expression. This will restrict
1040         the name/value pairs that are matched to only those where the value
1041         is exactly equal to the <code>value-pattern</code>.
1042 </p>
1043 </dd>
1044 <dt class="hdlist1">
1045 --type &lt;type&gt;
1046 </dt>
1047 <dd>
1048 <p>
1049   <em>git config</em> will ensure that any input or output is valid under the given
1050   type constraint(s), and will canonicalize outgoing values in <code>&lt;type&gt;</code>'s
1051   canonical form.
1052 </p>
1053 <div class="paragraph"><p>Valid <code>&lt;type&gt;</code>'s include:</p></div>
1054 <div class="ulist"><ul>
1055 <li>
1056 <p>
1057 <em>bool</em>: canonicalize values as either "true" or "false".
1058 </p>
1059 </li>
1060 <li>
1061 <p>
1062 <em>int</em>: canonicalize values as simple decimal numbers. An optional suffix of
1063   <em>k</em>, <em>m</em>, or <em>g</em> will cause the value to be multiplied by 1024, 1048576, or
1064   1073741824 upon input.
1065 </p>
1066 </li>
1067 <li>
1068 <p>
1069 <em>bool-or-int</em>: canonicalize according to either <em>bool</em> or <em>int</em>, as described
1070   above.
1071 </p>
1072 </li>
1073 <li>
1074 <p>
1075 <em>path</em>: canonicalize by adding 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 porcelains. 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 include a config file from another conditionally by setting a
1658 <code>includeIf.&lt;condition&gt;.path</code> variable to the name of the file to be
1659 included.</p></div>
1660 <div class="paragraph"><p>The condition starts with a keyword followed by a colon and some data
1661 whose format and meaning depends on the keyword. Supported keywords
1662 are:</p></div>
1663 <div class="dlist"><dl>
1664 <dt class="hdlist1">
1665 <code>gitdir</code>
1666 </dt>
1667 <dd>
1668 <p>
1669         The data that follows the keyword <code>gitdir:</code> is used as a glob
1670         pattern. If the location of the .git directory matches the
1671         pattern, the include condition is met.
1672 </p>
1673 <div class="paragraph"><p>The .git location may be auto-discovered, or come from <code>$GIT_DIR</code>
1674 environment variable. If the repository is auto discovered via a .git
1675 file (e.g. from submodules, or a linked worktree), the .git location
1676 would be the final location where the .git directory is, not where the
1677 .git file is.</p></div>
1678 <div class="paragraph"><p>The pattern can contain standard globbing wildcards and two additional
1679 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components. Please
1680 refer to <a href="gitignore.html">gitignore(5)</a> for details. For convenience:</p></div>
1681 <div class="ulist"><ul>
1682 <li>
1683 <p>
1684 If the pattern starts with <code>~/</code>, <code>~</code> will be substituted with the
1685    content of the environment variable <code>HOME</code>.
1686 </p>
1687 </li>
1688 <li>
1689 <p>
1690 If the pattern starts with <code>./</code>, it is replaced with the directory
1691    containing the current config file.
1692 </p>
1693 </li>
1694 <li>
1695 <p>
1696 If the pattern does not start with either <code>~/</code>, <code>./</code> or <code>/</code>, <code>**/</code>
1697    will be automatically prepended. For example, the pattern <code>foo/bar</code>
1698    becomes <code>**/foo/bar</code> and would match <code>/any/path/to/foo/bar</code>.
1699 </p>
1700 </li>
1701 <li>
1702 <p>
1703 If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1704    example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it
1705    matches "foo" and everything inside, recursively.
1706 </p>
1707 </li>
1708 </ul></div>
1709 </dd>
1710 <dt class="hdlist1">
1711 <code>gitdir/i</code>
1712 </dt>
1713 <dd>
1714 <p>
1715         This is the same as <code>gitdir</code> except that matching is done
1716         case-insensitively (e.g. on case-insensitive file systems)
1717 </p>
1718 </dd>
1719 <dt class="hdlist1">
1720 <code>onbranch</code>
1721 </dt>
1722 <dd>
1723 <p>
1724         The data that follows the keyword <code>onbranch:</code> is taken to be a
1725         pattern with standard globbing wildcards and two additional
1726         ones, <code>**/</code> and <code>/**</code>, that can match multiple path components.
1727         If we are in a worktree where the name of the branch that is
1728         currently checked out matches the pattern, the include condition
1729         is met.
1730 </p>
1731 <div class="paragraph"><p>If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1732 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it matches
1733 all branches that begin with <code>foo/</code>. This is useful if your branches are
1734 organized hierarchically and you would like to apply a configuration to
1735 all the branches in that hierarchy.</p></div>
1736 </dd>
1737 <dt class="hdlist1">
1738 <code>hasconfig:remote.*.url:</code>
1739 </dt>
1740 <dd>
1741 <p>
1742         The data that follows this keyword is taken to
1743         be a pattern with standard globbing wildcards and two
1744         additional ones, <code>**/</code> and <code>/**</code>, that can match multiple
1745         components. The first time this keyword is seen, the rest of
1746         the config files will be scanned for remote URLs (without
1747         applying any values). If there exists at least one remote URL
1748         that matches this pattern, the include condition is met.
1749 </p>
1750 <div class="paragraph"><p>Files included by this option (directly or indirectly) are not allowed
1751 to contain remote URLs.</p></div>
1752 <div class="paragraph"><p>Note that unlike other includeIf conditions, resolving this condition
1753 relies on information that is not yet known at the point of reading the
1754 condition. A typical use case is this option being present as a
1755 system-level or global-level config, and the remote URL being in a
1756 local-level config; hence the need to scan ahead when resolving this
1757 condition. In order to avoid the chicken-and-egg problem in which
1758 potentially-included files can affect whether such files are potentially
1759 included, Git breaks the cycle by prohibiting these files from affecting
1760 the resolution of these conditions (thus, prohibiting them from
1761 declaring remote URLs).</p></div>
1762 <div class="paragraph"><p>As for the naming of this keyword, it is for forwards compatibility with
1763 a naming scheme that supports more variable-based include conditions,
1764 but currently Git only supports the exact keyword described above.</p></div>
1765 </dd>
1766 </dl></div>
1767 <div class="paragraph"><p>A few more notes on matching via <code>gitdir</code> and <code>gitdir/i</code>:</p></div>
1768 <div class="ulist"><ul>
1769 <li>
1770 <p>
1771 Symlinks in <code>$GIT_DIR</code> are not resolved before matching.
1772 </p>
1773 </li>
1774 <li>
1775 <p>
1776 Both the symlink &amp; realpath versions of paths will be matched
1777    outside of <code>$GIT_DIR</code>. E.g. if ~/git is a symlink to
1778    /mnt/storage/git, both <code>gitdir:~/git</code> and <code>gitdir:/mnt/storage/git</code>
1779    will match.
1780 </p>
1781 <div class="paragraph"><p>This was not the case in the initial release of this feature in
1782 v2.13.0, which only matched the realpath version. Configuration that
1783 wants to be compatible with the initial release of this feature needs
1784 to either specify only the realpath version, or both versions.</p></div>
1785 </li>
1786 <li>
1787 <p>
1788 Note that "../" is not special and will match literally, which is
1789    unlikely what you want.
1790 </p>
1791 </li>
1792 </ul></div>
1793 </div>
1794 <div class="sect2">
1795 <h3 id="_example">Example</h3>
1796 <div class="listingblock">
1797 <div class="content">
1798 <pre><code># Core variables
1799 [core]
1800         ; Don't trust file modes
1801         filemode = false
1802
1803 # Our diff algorithm
1804 [diff]
1805         external = /usr/local/bin/diff-wrapper
1806         renames = true
1807
1808 [branch "devel"]
1809         remote = origin
1810         merge = refs/heads/devel
1811
1812 # Proxy settings
1813 [core]
1814         gitProxy="ssh" for "kernel.org"
1815         gitProxy=default-proxy ; for the rest
1816
1817 [include]
1818         path = /path/to/foo.inc ; include by absolute path
1819         path = foo.inc ; find "foo.inc" relative to the current file
1820         path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
1821
1822 ; include if $GIT_DIR is /path/to/foo/.git
1823 [includeIf "gitdir:/path/to/foo/.git"]
1824         path = /path/to/foo.inc
1825
1826 ; include for all repositories inside /path/to/group
1827 [includeIf "gitdir:/path/to/group/"]
1828         path = /path/to/foo.inc
1829
1830 ; include for all repositories inside $HOME/to/group
1831 [includeIf "gitdir:~/to/group/"]
1832         path = /path/to/foo.inc
1833
1834 ; relative paths are always relative to the including
1835 ; file (if the condition is true); their location is not
1836 ; affected by the condition
1837 [includeIf "gitdir:/path/to/group/"]
1838         path = foo.inc
1839
1840 ; include only if we are in a worktree where foo-branch is
1841 ; currently checked out
1842 [includeIf "onbranch:foo-branch"]
1843         path = foo.inc
1844
1845 ; include only if a remote with the given URL exists (note
1846 ; that such a URL may be provided later in a file or in a
1847 ; file read after this file is read, as seen in this example)
1848 [includeIf "hasconfig:remote.*.url:https://example.com/**"]
1849         path = foo.inc
1850 [remote "origin"]
1851         url = https://example.com/git</code></pre>
1852 </div></div>
1853 </div>
1854 <div class="sect2">
1855 <h3 id="_values">Values</h3>
1856 <div class="paragraph"><p>Values of many variables are treated as a simple string, but there
1857 are variables that take values of specific types and there are rules
1858 as to how to spell them.</p></div>
1859 <div class="dlist"><dl>
1860 <dt class="hdlist1">
1861 boolean
1862 </dt>
1863 <dd>
1864 <p>
1865        When a variable is said to take a boolean value, many
1866        synonyms are accepted for <em>true</em> and <em>false</em>; these are all
1867        case-insensitive.
1868 </p>
1869 <div class="dlist"><dl>
1870 <dt class="hdlist1">
1871 true
1872 </dt>
1873 <dd>
1874 <p>
1875 Boolean true literals are <code>yes</code>, <code>on</code>, <code>true</code>,
1876                 and <code>1</code>.  Also, a variable defined without <code>= &lt;value&gt;</code>
1877                 is taken as true.
1878 </p>
1879 </dd>
1880 <dt class="hdlist1">
1881 false
1882 </dt>
1883 <dd>
1884 <p>
1885 Boolean false literals are <code>no</code>, <code>off</code>, <code>false</code>,
1886                 <code>0</code> and the empty string.
1887 </p>
1888 <div class="paragraph"><p>When converting a value to its canonical form using the <code>--type=bool</code> type
1889 specifier, <em>git config</em> will ensure that the output is "true" or
1890 "false" (spelled in lowercase).</p></div>
1891 </dd>
1892 </dl></div>
1893 </dd>
1894 <dt class="hdlist1">
1895 integer
1896 </dt>
1897 <dd>
1898 <p>
1899        The value for many variables that specify various sizes can
1900        be suffixed with <code>k</code>, <code>M</code>,&#8230; to mean "scale the number by
1901        1024", "by 1024x1024", etc.
1902 </p>
1903 </dd>
1904 <dt class="hdlist1">
1905 color
1906 </dt>
1907 <dd>
1908 <p>
1909        The value for a variable that takes a color is a list of
1910        colors (at most two, one for foreground and one for background)
1911        and attributes (as many as you want), separated by spaces.
1912 </p>
1913 <div class="paragraph"><p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>,
1914 <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code> and <code>default</code>.  The first
1915 color given is the foreground; the second is the background.  All the
1916 basic colors except <code>normal</code> and <code>default</code> have a bright variant that can
1917 be specified by prefixing the color with <code>bright</code>, like <code>brightred</code>.</p></div>
1918 <div class="paragraph"><p>The color <code>normal</code> makes no change to the color. It is the same as an
1919 empty string, but can be used as the foreground color when specifying a
1920 background color alone (for example, "normal red").</p></div>
1921 <div class="paragraph"><p>The color <code>default</code> explicitly resets the color to the terminal default,
1922 for example to specify a cleared background. Although it varies between
1923 terminals, this is usually not the same as setting to "white black".</p></div>
1924 <div class="paragraph"><p>Colors may also be given as numbers between 0 and 255; these use ANSI
1925 256-color mode (but note that not all terminals may support this).  If
1926 your terminal supports it, you may also specify 24-bit RGB values as
1927 hex, like <code>#ff0ab3</code>.</p></div>
1928 <div class="paragraph"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
1929 <code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters).
1930 The position of any attributes with respect to the colors
1931 (before, after, or in between), doesn&#8217;t matter. Specific attributes may
1932 be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>,
1933 <code>no-ul</code>, etc).</p></div>
1934 <div class="paragraph"><p>The pseudo-attribute <code>reset</code> resets all colors and attributes before
1935 applying the specified coloring. For example, <code>reset green</code> will result
1936 in a green foreground and default background without any active
1937 attributes.</p></div>
1938 <div class="paragraph"><p>An empty color string produces no color effect at all. This can be used
1939 to avoid coloring specific elements without disabling color entirely.</p></div>
1940 <div class="paragraph"><p>For git&#8217;s pre-defined color slots, the attributes are meant to be reset
1941 at the beginning of each item in the colored output. So setting
1942 <code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a
1943 plain <code>black</code>, even if the previous thing on the same output line (e.g.
1944 opening parenthesis before the list of branch names in <code>log --decorate</code>
1945 output) is set to be painted with <code>bold</code> or some other attribute.
1946 However, custom log formats may do more complicated and layered
1947 coloring, and the negated forms may be useful there.</p></div>
1948 </dd>
1949 <dt class="hdlist1">
1950 pathname
1951 </dt>
1952 <dd>
1953 <p>
1954         A variable that takes a pathname value can be given a
1955         string that begins with "<code>~/</code>" or "<code>~user/</code>", and the usual
1956         tilde expansion happens to such a string: <code>~/</code>
1957         is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the
1958         specified user&#8217;s home directory.
1959 </p>
1960 <div class="paragraph"><p>If a path starts with <code>%(prefix)/</code>, the remainder is interpreted as a
1961 path relative to Git&#8217;s "runtime prefix", i.e. relative to the location
1962 where Git itself was installed. For example, <code>%(prefix)/bin/</code> refers to
1963 the directory in which the Git executable itself lives. If Git was
1964 compiled without runtime prefix support, the compiled-in prefix will be
1965 substituted instead. In the unlikely event that a literal path needs to
1966 be specified that should <em>not</em> be expanded, it needs to be prefixed by
1967 <code>./</code>, like so: <code>./%(prefix)/bin</code>.</p></div>
1968 </dd>
1969 </dl></div>
1970 </div>
1971 <div class="sect2">
1972 <h3 id="_variables">Variables</h3>
1973 <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
1974 For command-specific variables, you will find a more detailed description
1975 in the appropriate manual page.</p></div>
1976 <div class="paragraph"><p>Other git-related tools may and do use their own variables.  When
1977 inventing new variables for use in your own tool, make sure their
1978 names do not conflict with those that are used by Git itself and
1979 other popular tools, and describe them in your documentation.</p></div>
1980 <div class="dlist"><dl>
1981 <dt class="hdlist1">
1982 advice.*
1983 </dt>
1984 <dd>
1985 <p>
1986         These variables control various optional help messages designed to
1987         aid new users. All <em>advice.*</em> variables default to <em>true</em>, and you
1988         can tell Git that you do not need help by setting these to <em>false</em>:
1989 </p>
1990 <div class="openblock">
1991 <div class="content">
1992 <div class="dlist"><dl>
1993 <dt class="hdlist1">
1994 ambiguousFetchRefspec
1995 </dt>
1996 <dd>
1997 <p>
1998                 Advice shown when fetch refspec for multiple remotes map to
1999                 the same remote-tracking branch namespace and causes branch
2000                 tracking set-up to fail.
2001 </p>
2002 </dd>
2003 <dt class="hdlist1">
2004 fetchShowForcedUpdates
2005 </dt>
2006 <dd>
2007 <p>
2008                 Advice shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
2009                 to calculate forced updates after ref updates, or to warn
2010                 that the check is disabled.
2011 </p>
2012 </dd>
2013 <dt class="hdlist1">
2014 pushUpdateRejected
2015 </dt>
2016 <dd>
2017 <p>
2018                 Set this variable to <em>false</em> if you want to disable
2019                 <em>pushNonFFCurrent</em>, <em>pushNonFFMatching</em>, <em>pushAlreadyExists</em>,
2020                 <em>pushFetchFirst</em>, <em>pushNeedsForce</em>, and <em>pushRefNeedsUpdate</em>
2021                 simultaneously.
2022 </p>
2023 </dd>
2024 <dt class="hdlist1">
2025 pushNonFFCurrent
2026 </dt>
2027 <dd>
2028 <p>
2029                 Advice shown when <a href="git-push.html">git-push(1)</a> fails due to a
2030                 non-fast-forward update to the current branch.
2031 </p>
2032 </dd>
2033 <dt class="hdlist1">
2034 pushNonFFMatching
2035 </dt>
2036 <dd>
2037 <p>
2038                 Advice shown when you ran <a href="git-push.html">git-push(1)</a> and pushed
2039                 <em>matching refs</em> explicitly (i.e. you used <em>:</em>, or
2040                 specified a refspec that isn&#8217;t your current branch) and
2041                 it resulted in a non-fast-forward error.
2042 </p>
2043 </dd>
2044 <dt class="hdlist1">
2045 pushAlreadyExists
2046 </dt>
2047 <dd>
2048 <p>
2049                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2050                 does not qualify for fast-forwarding (e.g., a tag.)
2051 </p>
2052 </dd>
2053 <dt class="hdlist1">
2054 pushFetchFirst
2055 </dt>
2056 <dd>
2057 <p>
2058                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2059                 tries to overwrite a remote ref that points at an
2060                 object we do not have.
2061 </p>
2062 </dd>
2063 <dt class="hdlist1">
2064 pushNeedsForce
2065 </dt>
2066 <dd>
2067 <p>
2068                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2069                 tries to overwrite a remote ref that points at an
2070                 object that is not a commit-ish, or make the remote
2071                 ref point at an object that is not a commit-ish.
2072 </p>
2073 </dd>
2074 <dt class="hdlist1">
2075 pushUnqualifiedRefname
2076 </dt>
2077 <dd>
2078 <p>
2079                 Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
2080                 guess based on the source and destination refs what
2081                 remote ref namespace the source belongs in, but where
2082                 we can still suggest that the user push to either
2083                 refs/heads/* or refs/tags/* based on the type of the
2084                 source object.
2085 </p>
2086 </dd>
2087 <dt class="hdlist1">
2088 pushRefNeedsUpdate
2089 </dt>
2090 <dd>
2091 <p>
2092                 Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
2093                 a branch when its remote-tracking ref has updates that we
2094                 do not have locally.
2095 </p>
2096 </dd>
2097 <dt class="hdlist1">
2098 skippedCherryPicks
2099 </dt>
2100 <dd>
2101 <p>
2102                 Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
2103                 been cherry-picked onto the upstream branch.
2104 </p>
2105 </dd>
2106 <dt class="hdlist1">
2107 statusAheadBehind
2108 </dt>
2109 <dd>
2110 <p>
2111                 Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
2112                 counts for a local ref compared to its remote tracking ref,
2113                 and that calculation takes longer than expected. Will not
2114                 appear if <code>status.aheadBehind</code> is false or the option
2115                 <code>--no-ahead-behind</code> is given.
2116 </p>
2117 </dd>
2118 <dt class="hdlist1">
2119 statusHints
2120 </dt>
2121 <dd>
2122 <p>
2123                 Show directions on how to proceed from the current
2124                 state in the output of <a href="git-status.html">git-status(1)</a>, in
2125                 the template shown when writing commit messages in
2126                 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
2127                 by <a href="git-switch.html">git-switch(1)</a> or
2128                 <a href="git-checkout.html">git-checkout(1)</a> when switching branch.
2129 </p>
2130 </dd>
2131 <dt class="hdlist1">
2132 statusUoption
2133 </dt>
2134 <dd>
2135 <p>
2136                 Advise to consider using the <code>-u</code> option to <a href="git-status.html">git-status(1)</a>
2137                 when the command takes more than 2 seconds to enumerate untracked
2138                 files.
2139 </p>
2140 </dd>
2141 <dt class="hdlist1">
2142 commitBeforeMerge
2143 </dt>
2144 <dd>
2145 <p>
2146                 Advice shown when <a href="git-merge.html">git-merge(1)</a> refuses to
2147                 merge to avoid overwriting local changes.
2148 </p>
2149 </dd>
2150 <dt class="hdlist1">
2151 resetNoRefresh
2152 </dt>
2153 <dd>
2154 <p>
2155                 Advice to consider using the <code>--no-refresh</code> option to
2156                 <a href="git-reset.html">git-reset(1)</a> when the command takes more than 2 seconds
2157                 to refresh the index after reset.
2158 </p>
2159 </dd>
2160 <dt class="hdlist1">
2161 resolveConflict
2162 </dt>
2163 <dd>
2164 <p>
2165                 Advice shown by various commands when conflicts
2166                 prevent the operation from being performed.
2167 </p>
2168 </dd>
2169 <dt class="hdlist1">
2170 sequencerInUse
2171 </dt>
2172 <dd>
2173 <p>
2174                 Advice shown when a sequencer command is already in progress.
2175 </p>
2176 </dd>
2177 <dt class="hdlist1">
2178 implicitIdentity
2179 </dt>
2180 <dd>
2181 <p>
2182                 Advice on how to set your identity configuration when
2183                 your information is guessed from the system username and
2184                 domain name.
2185 </p>
2186 </dd>
2187 <dt class="hdlist1">
2188 detachedHead
2189 </dt>
2190 <dd>
2191 <p>
2192                 Advice shown when you used
2193                 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
2194                 to move to the detach HEAD state, to instruct how to
2195                 create a local branch after the fact.
2196 </p>
2197 </dd>
2198 <dt class="hdlist1">
2199 suggestDetachingHead
2200 </dt>
2201 <dd>
2202 <p>
2203                 Advice shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
2204                 without the explicit <code>--detach</code> option.
2205 </p>
2206 </dd>
2207 <dt class="hdlist1">
2208 checkoutAmbiguousRemoteBranchName
2209 </dt>
2210 <dd>
2211 <p>
2212                 Advice shown when the argument to
2213                 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
2214                 ambiguously resolves to a
2215                 remote tracking branch on more than one remote in
2216                 situations where an unambiguous argument would have
2217                 otherwise caused a remote-tracking branch to be
2218                 checked out. See the <code>checkout.defaultRemote</code>
2219                 configuration variable for how to set a given remote
2220                 to used by default in some situations where this
2221                 advice would be printed.
2222 </p>
2223 </dd>
2224 <dt class="hdlist1">
2225 amWorkDir
2226 </dt>
2227 <dd>
2228 <p>
2229                 Advice that shows the location of the patch file when
2230                 <a href="git-am.html">git-am(1)</a> fails to apply it.
2231 </p>
2232 </dd>
2233 <dt class="hdlist1">
2234 rmHints
2235 </dt>
2236 <dd>
2237 <p>
2238                 In case of failure in the output of <a href="git-rm.html">git-rm(1)</a>,
2239                 show directions on how to proceed from the current state.
2240 </p>
2241 </dd>
2242 <dt class="hdlist1">
2243 addEmbeddedRepo
2244 </dt>
2245 <dd>
2246 <p>
2247                 Advice on what to do when you&#8217;ve accidentally added one
2248                 git repo inside of another.
2249 </p>
2250 </dd>
2251 <dt class="hdlist1">
2252 ignoredHook
2253 </dt>
2254 <dd>
2255 <p>
2256                 Advice shown if a hook is ignored because the hook is not
2257                 set as executable.
2258 </p>
2259 </dd>
2260 <dt class="hdlist1">
2261 waitingForEditor
2262 </dt>
2263 <dd>
2264 <p>
2265                 Print a message to the terminal whenever Git is waiting for
2266                 editor input from the user.
2267 </p>
2268 </dd>
2269 <dt class="hdlist1">
2270 nestedTag
2271 </dt>
2272 <dd>
2273 <p>
2274                 Advice shown if a user attempts to recursively tag a tag object.
2275 </p>
2276 </dd>
2277 <dt class="hdlist1">
2278 submoduleAlternateErrorStrategyDie
2279 </dt>
2280 <dd>
2281 <p>
2282                 Advice shown when a submodule.alternateErrorStrategy option
2283                 configured to "die" causes a fatal error.
2284 </p>
2285 </dd>
2286 <dt class="hdlist1">
2287 submodulesNotUpdated
2288 </dt>
2289 <dd>
2290 <p>
2291                 Advice shown when a user runs a submodule command that fails
2292                 because <code>git submodule update --init</code> was not run.
2293 </p>
2294 </dd>
2295 <dt class="hdlist1">
2296 addIgnoredFile
2297 </dt>
2298 <dd>
2299 <p>
2300                 Advice shown if a user attempts to add an ignored file to
2301                 the index.
2302 </p>
2303 </dd>
2304 <dt class="hdlist1">
2305 addEmptyPathspec
2306 </dt>
2307 <dd>
2308 <p>
2309                 Advice shown if a user runs the add command without providing
2310                 the pathspec parameter.
2311 </p>
2312 </dd>
2313 <dt class="hdlist1">
2314 updateSparsePath
2315 </dt>
2316 <dd>
2317 <p>
2318                 Advice shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
2319                 is asked to update index entries outside the current sparse
2320                 checkout.
2321 </p>
2322 </dd>
2323 <dt class="hdlist1">
2324 diverging
2325 </dt>
2326 <dd>
2327 <p>
2328                 Advice shown when a fast-forward is not possible.
2329 </p>
2330 </dd>
2331 <dt class="hdlist1">
2332 worktreeAddOrphan
2333 </dt>
2334 <dd>
2335 <p>
2336                 Advice shown when a user tries to create a worktree from an
2337                 invalid reference, to instruct how to create a new orphan
2338                 branch instead.
2339 </p>
2340 </dd>
2341 </dl></div>
2342 </div></div>
2343 </dd>
2344 <dt class="hdlist1">
2345 core.fileMode
2346 </dt>
2347 <dd>
2348 <p>
2349         Tells Git if the executable bit of files in the working tree
2350         is to be honored.
2351 </p>
2352 <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
2353 marked as executable is checked out, or checks out a
2354 non-executable file with executable bit on.
2355 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
2356 to see if it handles the executable bit correctly
2357 and this variable is automatically set as necessary.</p></div>
2358 <div class="paragraph"><p>A repository, however, may be on a filesystem that handles
2359 the filemode correctly, and this variable is set to <em>true</em>
2360 when created, but later may be made accessible from another
2361 environment that loses the filemode (e.g. exporting ext4 via
2362 CIFS mount, visiting a Cygwin created repository with
2363 Git for Windows or Eclipse).
2364 In such a case it may be necessary to set this variable to <em>false</em>.
2365 See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
2366 <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
2367 </dd>
2368 <dt class="hdlist1">
2369 core.hideDotFiles
2370 </dt>
2371 <dd>
2372 <p>
2373         (Windows-only) If true, mark newly-created directories and files whose
2374         name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
2375         directory is hidden, but no other files starting with a dot.  The
2376         default mode is <em>dotGitOnly</em>.
2377 </p>
2378 </dd>
2379 <dt class="hdlist1">
2380 core.ignoreCase
2381 </dt>
2382 <dd>
2383 <p>
2384         Internal variable which enables various workarounds to enable
2385         Git to work better on filesystems that are not case sensitive,
2386         like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
2387         finds "makefile" when Git expects "Makefile", Git will assume
2388         it is really the same file, and continue to remember it as
2389         "Makefile".
2390 </p>
2391 <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>
2392 will probe and set core.ignoreCase true if appropriate when the repository
2393 is created.</p></div>
2394 <div class="paragraph"><p>Git relies on the proper configuration of this variable for your operating
2395 and file system. Modifying this value may result in unexpected behavior.</p></div>
2396 </dd>
2397 <dt class="hdlist1">
2398 core.precomposeUnicode
2399 </dt>
2400 <dd>
2401 <p>
2402         This option is only used by Mac OS implementation of Git.
2403         When core.precomposeUnicode=true, Git reverts the unicode decomposition
2404         of filenames done by Mac OS. This is useful when sharing a repository
2405         between Mac OS and Linux or Windows.
2406         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
2407         When false, file names are handled fully transparent by Git,
2408         which is backward compatible with older versions of Git.
2409 </p>
2410 </dd>
2411 <dt class="hdlist1">
2412 core.protectHFS
2413 </dt>
2414 <dd>
2415 <p>
2416         If set to true, do not allow checkout of paths that would
2417         be considered equivalent to <code>.git</code> on an HFS+ filesystem.
2418         Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
2419 </p>
2420 </dd>
2421 <dt class="hdlist1">
2422 core.protectNTFS
2423 </dt>
2424 <dd>
2425 <p>
2426         If set to true, do not allow checkout of paths that would
2427         cause problems with the NTFS filesystem, e.g. conflict with
2428         8.3 "short" names.
2429         Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
2430 </p>
2431 </dd>
2432 <dt class="hdlist1">
2433 core.fsmonitor
2434 </dt>
2435 <dd>
2436 <p>
2437         If set to true, enable the built-in file system monitor
2438         daemon for this working directory (<a href="git-fsmonitor&#45;&#45;daemon.html">git-fsmonitor&#45;&#45;daemon(1)</a>).
2439 </p>
2440 <div class="paragraph"><p>Like hook-based file system monitors, the built-in file system monitor
2441 can speed up Git commands that need to refresh the Git index
2442 (e.g. <code>git status</code>) in a working directory with many files.  The
2443 built-in monitor eliminates the need to install and maintain an
2444 external third-party tool.</p></div>
2445 <div class="paragraph"><p>The built-in file system monitor is currently available only on a
2446 limited set of supported platforms.  Currently, this includes Windows
2447 and MacOS.</p></div>
2448 <div class="literalblock">
2449 <div class="content">
2450 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor"
2451 hook command.</code></pre>
2452 </div></div>
2453 <div class="paragraph"><p>This hook command is used to identify all files that may have changed
2454 since the requested date/time. This information is used to speed up
2455 git by avoiding unnecessary scanning of files that have not changed.</p></div>
2456 <div class="paragraph"><p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p></div>
2457 <div class="paragraph"><p>Note that if you concurrently use multiple versions of Git, such
2458 as one version on the command line and another version in an IDE
2459 tool, that the definition of <code>core.fsmonitor</code> was extended to
2460 allow boolean values in addition to hook pathnames.  Git versions
2461 2.35.1 and prior will not understand the boolean values and will
2462 consider the "true" or "false" values as hook pathnames to be
2463 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
2464 V2 and will fall back to no fsmonitor (full scan).  Git versions
2465 prior to 2.26 default to hook protocol V1 and will silently
2466 assume there were no changes to report (no scan), so status
2467 commands may report incomplete results.  For this reason, it is
2468 best to upgrade all of your Git versions before using the built-in
2469 file system monitor.</p></div>
2470 </dd>
2471 <dt class="hdlist1">
2472 core.fsmonitorHookVersion
2473 </dt>
2474 <dd>
2475 <p>
2476         Sets the protocol version to be used when invoking the
2477         "fsmonitor" hook.
2478 </p>
2479 <div class="paragraph"><p>There are currently versions 1 and 2. When this is not set,
2480 version 2 will be tried first and if it fails then version 1
2481 will be tried. Version 1 uses a timestamp as input to determine
2482 which files have changes since that time but some monitors
2483 like Watchman have race conditions when used with a timestamp.
2484 Version 2 uses an opaque string so that the monitor can return
2485 something that can be used to determine what files have changed
2486 without race conditions.</p></div>
2487 </dd>
2488 <dt class="hdlist1">
2489 core.trustctime
2490 </dt>
2491 <dd>
2492 <p>
2493         If false, the ctime differences between the index and the
2494         working tree are ignored; useful when the inode change time
2495         is regularly modified by something outside Git (file system
2496         crawlers and some backup systems).
2497         See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
2498 </p>
2499 </dd>
2500 <dt class="hdlist1">
2501 core.splitIndex
2502 </dt>
2503 <dd>
2504 <p>
2505         If true, the split-index feature of the index will be used.
2506         See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
2507 </p>
2508 </dd>
2509 <dt class="hdlist1">
2510 core.untrackedCache
2511 </dt>
2512 <dd>
2513 <p>
2514         Determines what to do about the untracked cache feature of the
2515         index. It will be kept, if this variable is unset or set to
2516         <code>keep</code>. It will automatically be added if set to <code>true</code>. And
2517         it will automatically be removed, if set to <code>false</code>. Before
2518         setting it to <code>true</code>, you should check that mtime is working
2519         properly on your system.
2520         See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
2521         <code>feature.manyFiles</code> is enabled which sets this setting to
2522         <code>true</code> by default.
2523 </p>
2524 </dd>
2525 <dt class="hdlist1">
2526 core.checkStat
2527 </dt>
2528 <dd>
2529 <p>
2530         When missing or is set to <code>default</code>, many fields in the stat
2531         structure are checked to detect if a file has been modified
2532         since Git looked at it.  When this configuration variable is
2533         set to <code>minimal</code>, sub-second part of mtime and ctime, the
2534         uid and gid of the owner of the file, the inode number (and
2535         the device number, if Git was compiled to use it), are
2536         excluded from the check among these fields, leaving only the
2537         whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
2538         is set) and the filesize to be checked.
2539 </p>
2540 <div class="paragraph"><p>There are implementations of Git that do not leave usable values in
2541 some fields (e.g. JGit); by excluding these fields from the
2542 comparison, the <code>minimal</code> mode may help interoperability when the
2543 same repository is used by these other systems at the same time.</p></div>
2544 </dd>
2545 <dt class="hdlist1">
2546 core.quotePath
2547 </dt>
2548 <dd>
2549 <p>
2550         Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
2551         quote "unusual" characters in the pathname by enclosing the
2552         pathname in double-quotes and escaping those characters with
2553         backslashes in the same way C escapes control characters (e.g.
2554         <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
2555         values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
2556         UTF-8).  If this variable is set to false, bytes higher than
2557         0x80 are not considered "unusual" any more. Double-quotes,
2558         backslash and control characters are always escaped regardless
2559         of the setting of this variable.  A simple space character is
2560         not considered "unusual".  Many commands can output pathnames
2561         completely verbatim using the <code>-z</code> option. The default value
2562         is true.
2563 </p>
2564 </dd>
2565 <dt class="hdlist1">
2566 core.eol
2567 </dt>
2568 <dd>
2569 <p>
2570         Sets the line ending type to use in the working directory for
2571         files that are marked as text (either by having the <code>text</code>
2572         attribute set, or by having <code>text=auto</code> and Git auto-detecting
2573         the contents as text).
2574         Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
2575         native line ending.  The default value is <code>native</code>.  See
2576         <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
2577         conversion. Note that this value is ignored if <code>core.autocrlf</code>
2578         is set to <code>true</code> or <code>input</code>.
2579 </p>
2580 </dd>
2581 <dt class="hdlist1">
2582 core.safecrlf
2583 </dt>
2584 <dd>
2585 <p>
2586         If true, makes Git check if converting <code>CRLF</code> is reversible when
2587         end-of-line conversion is active.  Git will verify if a command
2588         modifies a file in the work tree either directly or indirectly.
2589         For example, committing a file followed by checking out the
2590         same file should yield the original file in the work tree.  If
2591         this is not the case for the current setting of
2592         <code>core.autocrlf</code>, Git will reject the file.  The variable can
2593         be set to "warn", in which case Git will only warn about an
2594         irreversible conversion but continue the operation.
2595 </p>
2596 <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
2597 When it is enabled, Git will convert CRLF to LF during commit and LF to
2598 CRLF during checkout.  A file that contains a mixture of LF and
2599 CRLF before the commit cannot be recreated by Git.  For text
2600 files this is the right thing to do: it corrects line endings
2601 such that we have only LF line endings in the repository.
2602 But for binary files that are accidentally classified as text the
2603 conversion can corrupt data.</p></div>
2604 <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
2605 setting the conversion type explicitly in .gitattributes.  Right
2606 after committing you still have the original file in your work
2607 tree and this file is not yet corrupted.  You can explicitly tell
2608 Git that this file is binary and Git will handle the file
2609 appropriately.</p></div>
2610 <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
2611 mixed line endings and the undesired effect of corrupting binary
2612 files cannot be distinguished.  In both cases CRLFs are removed
2613 in an irreversible way.  For text files this is the right thing
2614 to do because CRLFs are line endings, while for binary files
2615 converting CRLFs corrupts data.</p></div>
2616 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
2617 file identical to the original file for a different setting of
2618 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
2619 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
2620 and could later be checked out with <code>core.eol=crlf</code>, in which case the
2621 resulting file would contain <code>CRLF</code>, although the original file
2622 contained <code>LF</code>.  However, in both work trees the line endings would be
2623 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
2624 file with mixed line endings would be reported by the <code>core.safecrlf</code>
2625 mechanism.</p></div>
2626 </dd>
2627 <dt class="hdlist1">
2628 core.autocrlf
2629 </dt>
2630 <dd>
2631 <p>
2632         Setting this variable to "true" is the same as setting
2633         the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
2634         Set to true if you want to have <code>CRLF</code> line endings in your
2635         working directory and the repository has LF line endings.
2636         This variable can be set to <em>input</em>,
2637         in which case no output conversion is performed.
2638 </p>
2639 </dd>
2640 <dt class="hdlist1">
2641 core.checkRoundtripEncoding
2642 </dt>
2643 <dd>
2644 <p>
2645         A comma and/or whitespace separated list of encodings that Git
2646         performs UTF-8 round trip checks on if they are used in an
2647         <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
2648         The default value is <code>SHIFT-JIS</code>.
2649 </p>
2650 </dd>
2651 <dt class="hdlist1">
2652 core.symlinks
2653 </dt>
2654 <dd>
2655 <p>
2656         If false, symbolic links are checked out as small plain files that
2657         contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
2658         <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
2659         file. Useful on filesystems like FAT that do not support
2660         symbolic links.
2661 </p>
2662 <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>
2663 will probe and set core.symlinks false if appropriate when the repository
2664 is created.</p></div>
2665 </dd>
2666 <dt class="hdlist1">
2667 core.gitProxy
2668 </dt>
2669 <dd>
2670 <p>
2671         A "proxy command" to execute (as <em>command host port</em>) instead
2672         of establishing direct connection to the remote server when
2673         using the Git protocol for fetching. If the variable value is
2674         in the "COMMAND for DOMAIN" format, the command is applied only
2675         on hostnames ending with the specified domain string. This variable
2676         may be set multiple times and is matched in the given order;
2677         the first match wins.
2678 </p>
2679 <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
2680 (which always applies universally, without the special "for"
2681 handling).</p></div>
2682 <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
2683 specify that no proxy be used for a given domain pattern.
2684 This is useful for excluding servers inside a firewall from
2685 proxy use, while defaulting to a common proxy for external domains.</p></div>
2686 </dd>
2687 <dt class="hdlist1">
2688 core.sshCommand
2689 </dt>
2690 <dd>
2691 <p>
2692         If this variable is set, <code>git fetch</code> and <code>git push</code> will
2693         use the specified command instead of <code>ssh</code> when they need to
2694         connect to a remote system. The command is in the same form as
2695         the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
2696         when the environment variable is set.
2697 </p>
2698 </dd>
2699 <dt class="hdlist1">
2700 core.ignoreStat
2701 </dt>
2702 <dd>
2703 <p>
2704         If true, Git will avoid using lstat() calls to detect if files have
2705         changed by setting the "assume-unchanged" bit for those tracked files
2706         which it has updated identically in both the index and working tree.
2707 </p>
2708 <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
2709 the modified files explicitly (e.g. see <em>Examples</em> section in
2710 <a href="git-update-index.html">git-update-index(1)</a>).
2711 Git will not normally detect changes to those files.</p></div>
2712 <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
2713 CIFS/Microsoft Windows.</p></div>
2714 <div class="paragraph"><p>False by default.</p></div>
2715 </dd>
2716 <dt class="hdlist1">
2717 core.preferSymlinkRefs
2718 </dt>
2719 <dd>
2720 <p>
2721         Instead of the default "symref" format for HEAD
2722         and other symbolic reference files, use symbolic links.
2723         This is sometimes needed to work with old scripts that
2724         expect HEAD to be a symbolic link.
2725 </p>
2726 </dd>
2727 <dt class="hdlist1">
2728 core.alternateRefsCommand
2729 </dt>
2730 <dd>
2731 <p>
2732         When advertising tips of available history from an alternate, use the shell to
2733         execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
2734         first argument is the absolute path of the alternate. Output must contain one
2735         hex object id per line (i.e., the same as produced by <code>git for-each-ref
2736         --format='%(objectname)'</code>).
2737 </p>
2738 <div class="paragraph"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
2739 value, as it does not take a repository path as an argument (but you can wrap
2740 the command above in a shell script).</p></div>
2741 </dd>
2742 <dt class="hdlist1">
2743 core.alternateRefsPrefixes
2744 </dt>
2745 <dd>
2746 <p>
2747         When listing references from an alternate, list only references that begin
2748         with the given prefix. Prefixes match as if they were given as arguments to
2749         <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
2750         whitespace. If <code>core.alternateRefsCommand</code> is set, setting
2751         <code>core.alternateRefsPrefixes</code> has no effect.
2752 </p>
2753 </dd>
2754 <dt class="hdlist1">
2755 core.bare
2756 </dt>
2757 <dd>
2758 <p>
2759         If true this repository is assumed to be <em>bare</em> and has no
2760         working directory associated with it.  If this is the case a
2761         number of commands that require a working directory will be
2762         disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
2763 </p>
2764 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
2765 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
2766 repository that ends in "/.git" is assumed to be not bare (bare =
2767 false), while all other repositories are assumed to be bare (bare
2768 = true).</p></div>
2769 </dd>
2770 <dt class="hdlist1">
2771 core.worktree
2772 </dt>
2773 <dd>
2774 <p>
2775         Set the path to the root of the working tree.
2776         If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
2777         is ignored and not used for determining the root of working tree.
2778         This can be overridden by the <code>GIT_WORK_TREE</code> environment
2779         variable and the <code>--work-tree</code> command-line option.
2780         The value can be an absolute path or relative to the path to
2781         the .git directory, which is either specified by --git-dir
2782         or GIT_DIR, or automatically discovered.
2783         If --git-dir or GIT_DIR is specified but none of
2784         --work-tree, GIT_WORK_TREE and core.worktree is specified,
2785         the current working directory is regarded as the top level
2786         of your working tree.
2787 </p>
2788 <div class="paragraph"><p>Note that this variable is honored even when set in a configuration
2789 file in a ".git" subdirectory of a directory and its value differs
2790 from the latter directory (e.g. "/path/to/.git/config" has
2791 core.worktree set to "/different/path"), which is most likely a
2792 misconfiguration.  Running Git commands in the "/path/to" directory will
2793 still use "/different/path" as the root of the work tree and can cause
2794 confusion unless you know what you are doing (e.g. you are creating a
2795 read-only snapshot of the same index to a location different from the
2796 repository&#8217;s usual working tree).</p></div>
2797 </dd>
2798 <dt class="hdlist1">
2799 core.logAllRefUpdates
2800 </dt>
2801 <dd>
2802 <p>
2803         Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
2804         "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
2805         SHA-1, the date/time and the reason of the update, but
2806         only when the file exists.  If this configuration
2807         variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
2808         file is automatically created for branch heads (i.e. under
2809         <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
2810         note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
2811         If it is set to <code>always</code>, then a missing reflog is automatically
2812         created for any ref under <code>refs/</code>.
2813 </p>
2814 <div class="paragraph"><p>This information can be used to determine what commit
2815 was the tip of a branch "2 days ago".</p></div>
2816 <div class="paragraph"><p>This value is true by default in a repository that has
2817 a working directory associated with it, and false by
2818 default in a bare repository.</p></div>
2819 </dd>
2820 <dt class="hdlist1">
2821 core.repositoryFormatVersion
2822 </dt>
2823 <dd>
2824 <p>
2825         Internal variable identifying the repository format and layout
2826         version.
2827 </p>
2828 </dd>
2829 <dt class="hdlist1">
2830 core.sharedRepository
2831 </dt>
2832 <dd>
2833 <p>
2834         When <em>group</em> (or <em>true</em>), the repository is made shareable between
2835         several users in a group (making sure all the files and objects are
2836         group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
2837         repository will be readable by all users, additionally to being
2838         group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
2839         reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
2840         files in the repository will have this mode value. <em>0xxx</em> will override
2841         user&#8217;s umask value (whereas the other options will only override
2842         requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
2843         the repo read/write-able for the owner and group, but inaccessible to
2844         others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
2845         repository that is group-readable but not group-writable.
2846         See <a href="git-init.html">git-init(1)</a>. False by default.
2847 </p>
2848 </dd>
2849 <dt class="hdlist1">
2850 core.warnAmbiguousRefs
2851 </dt>
2852 <dd>
2853 <p>
2854         If true, Git will warn you if the ref name you passed it is ambiguous
2855         and might match multiple refs in the repository. True by default.
2856 </p>
2857 </dd>
2858 <dt class="hdlist1">
2859 core.compression
2860 </dt>
2861 <dd>
2862 <p>
2863         An integer -1..9, indicating a default compression level.
2864         -1 is the zlib default. 0 means no compression,
2865         and 1..9 are various speed/size tradeoffs, 9 being slowest.
2866         If set, this provides a default to other compression variables,
2867         such as <code>core.looseCompression</code> and <code>pack.compression</code>.
2868 </p>
2869 </dd>
2870 <dt class="hdlist1">
2871 core.looseCompression
2872 </dt>
2873 <dd>
2874 <p>
2875         An integer -1..9, indicating the compression level for objects that
2876         are not in a pack file. -1 is the zlib default. 0 means no
2877         compression, and 1..9 are various speed/size tradeoffs, 9 being
2878         slowest.  If not set,  defaults to core.compression.  If that is
2879         not set,  defaults to 1 (best speed).
2880 </p>
2881 </dd>
2882 <dt class="hdlist1">
2883 core.packedGitWindowSize
2884 </dt>
2885 <dd>
2886 <p>
2887         Number of bytes of a pack file to map into memory in a
2888         single mapping operation.  Larger window sizes may allow
2889         your system to process a smaller number of large pack files
2890         more quickly.  Smaller window sizes will negatively affect
2891         performance due to increased calls to the operating system&#8217;s
2892         memory manager, but may improve performance when accessing
2893         a large number of large pack files.
2894 </p>
2895 <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
2896 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
2897 be reasonable for all users/operating systems.  You probably do
2898 not need to adjust this value.</p></div>
2899 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2900 </dd>
2901 <dt class="hdlist1">
2902 core.packedGitLimit
2903 </dt>
2904 <dd>
2905 <p>
2906         Maximum number of bytes to map simultaneously into memory
2907         from pack files.  If Git needs to access more than this many
2908         bytes at once to complete an operation it will unmap existing
2909         regions to reclaim virtual address space within the process.
2910 </p>
2911 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
2912 unlimited) on 64 bit platforms.
2913 This should be reasonable for all users/operating systems, except on
2914 the largest projects.  You probably do not need to adjust this value.</p></div>
2915 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2916 </dd>
2917 <dt class="hdlist1">
2918 core.deltaBaseCacheLimit
2919 </dt>
2920 <dd>
2921 <p>
2922         Maximum number of bytes per thread to reserve for caching base objects
2923         that may be referenced by multiple deltified objects.  By storing the
2924         entire decompressed base objects in a cache Git is able
2925         to avoid unpacking and decompressing frequently used base
2926         objects multiple times.
2927 </p>
2928 <div class="paragraph"><p>Default is 96 MiB on all platforms.  This should be reasonable
2929 for all users/operating systems, except on the largest projects.
2930 You probably do not need to adjust this value.</p></div>
2931 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2932 </dd>
2933 <dt class="hdlist1">
2934 core.bigFileThreshold
2935 </dt>
2936 <dd>
2937 <p>
2938         The size of files considered "big", which as discussed below
2939         changes the behavior of numerous git commands, as well as how
2940         such files are stored within the repository. The default is
2941         512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
2942         supported.
2943 </p>
2944 <div class="paragraph"><p>Files above the configured limit will be:</p></div>
2945 <div class="ulist"><ul>
2946 <li>
2947 <p>
2948 Stored deflated in packfiles, without attempting delta compression.
2949 </p>
2950 <div class="paragraph"><p>The default limit is primarily set with this use-case in mind. With it,
2951 most projects will have their source code and other text files delta
2952 compressed, but not larger binary media files.</p></div>
2953 <div class="paragraph"><p>Storing large files without delta compression avoids excessive memory
2954 usage, at the slight expense of increased disk usage.</p></div>
2955 </li>
2956 <li>
2957 <p>
2958 Will be treated as if they were labeled "binary" (see
2959   <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
2960   <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.
2961 </p>
2962 </li>
2963 <li>
2964 <p>
2965 Will generally be streamed when written, which avoids excessive
2966 memory usage, at the cost of some fixed overhead. Commands that make
2967 use of this include <a href="git-archive.html">git-archive(1)</a>,
2968 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
2969 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.
2970 </p>
2971 </li>
2972 </ul></div>
2973 </dd>
2974 <dt class="hdlist1">
2975 core.excludesFile
2976 </dt>
2977 <dd>
2978 <p>
2979         Specifies the pathname to the file that contains patterns to
2980         describe paths that are not meant to be tracked, in addition
2981         to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
2982         Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
2983         If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
2984         is used instead. See <a href="gitignore.html">gitignore(5)</a>.
2985 </p>
2986 </dd>
2987 <dt class="hdlist1">
2988 core.askPass
2989 </dt>
2990 <dd>
2991 <p>
2992         Some commands (e.g. svn and http interfaces) that interactively
2993         ask for a password can be told to use an external program given
2994         via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
2995         environment variable. If not set, fall back to the value of the
2996         <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
2997         prompt. The external program shall be given a suitable prompt as
2998         command-line argument and write the password on its STDOUT.
2999 </p>
3000 </dd>
3001 <dt class="hdlist1">
3002 core.attributesFile
3003 </dt>
3004 <dd>
3005 <p>
3006         In addition to <code>.gitattributes</code> (per-directory) and
3007         <code>.git/info/attributes</code>, Git looks into this file for attributes
3008         (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
3009         way as for <code>core.excludesFile</code>. Its default value is
3010         <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
3011         set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
3012 </p>
3013 </dd>
3014 <dt class="hdlist1">
3015 core.hooksPath
3016 </dt>
3017 <dd>
3018 <p>
3019         By default Git will look for your hooks in the
3020         <code>$GIT_DIR/hooks</code> directory. Set this to different path,
3021         e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
3022         that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
3023         in <code>$GIT_DIR/hooks/pre-receive</code>.
3024 </p>
3025 <div class="paragraph"><p>The path can be either absolute or relative. A relative path is
3026 taken as relative to the directory where the hooks are run (see
3027 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
3028 <div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
3029 centrally configure your Git hooks instead of configuring them on a
3030 per-repository basis, or as a more flexible and centralized
3031 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
3032 default hooks.</p></div>
3033 </dd>
3034 <dt class="hdlist1">
3035 core.editor
3036 </dt>
3037 <dd>
3038 <p>
3039         Commands such as <code>commit</code> and <code>tag</code> that let you edit
3040         messages by launching an editor use the value of this
3041         variable when it is set, and the environment variable
3042         <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.
3043 </p>
3044 </dd>
3045 <dt class="hdlist1">
3046 core.commentChar
3047 </dt>
3048 <dd>
3049 <p>
3050         Commands such as <code>commit</code> and <code>tag</code> that let you edit
3051         messages consider a line that begins with this character
3052         commented, and removes them after the editor returns
3053         (default <em>#</em>).
3054 </p>
3055 <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
3056 the beginning character of any line in existing commit messages.</p></div>
3057 </dd>
3058 <dt class="hdlist1">
3059 core.filesRefLockTimeout
3060 </dt>
3061 <dd>
3062 <p>
3063         The length of time, in milliseconds, to retry when trying to
3064         lock an individual reference. Value 0 means not to retry at
3065         all; -1 means to try indefinitely. Default is 100 (i.e.,
3066         retry for 100ms).
3067 </p>
3068 </dd>
3069 <dt class="hdlist1">
3070 core.packedRefsTimeout
3071 </dt>
3072 <dd>
3073 <p>
3074         The length of time, in milliseconds, to retry when trying to
3075         lock the <code>packed-refs</code> file. Value 0 means not to retry at
3076         all; -1 means to try indefinitely. Default is 1000 (i.e.,
3077         retry for 1 second).
3078 </p>
3079 </dd>
3080 <dt class="hdlist1">
3081 core.pager
3082 </dt>
3083 <dd>
3084 <p>
3085         Text viewer for use by Git commands (e.g., <em>less</em>).  The value
3086         is meant to be interpreted by the shell.  The order of preference
3087         is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
3088         configuration, then <code>$PAGER</code>, and then the default chosen at
3089         compile time (usually <em>less</em>).
3090 </p>
3091 <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
3092 (if <code>LESS</code> environment variable is set, Git does not change it at
3093 all).  If you want to selectively override Git&#8217;s default setting
3094 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
3095 be passed to the shell by Git, which will translate the final
3096 command to <code>LESS=FRX less -S</code>. The environment does not set the
3097 <code>S</code> option but the command line does, instructing less to truncate
3098 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
3099 deactivate the <code>F</code> option specified by the environment from the
3100 command-line, deactivating the "quit if one screen" behavior of
3101 <code>less</code>.  One can specifically activate some flags for particular
3102 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
3103 line truncation only for <code>git blame</code>.</p></div>
3104 <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
3105 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
3106 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
3107 </dd>
3108 <dt class="hdlist1">
3109 core.whitespace
3110 </dt>
3111 <dd>
3112 <p>
3113         A comma separated list of common whitespace problems to
3114         notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
3115         highlight them, and <em>git apply --whitespace=error</em> will
3116         consider them as errors.  You can prefix <code>-</code> to disable
3117         any of them (e.g. <code>-trailing-space</code>):
3118 </p>
3119 <div class="ulist"><ul>
3120 <li>
3121 <p>
3122 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
3123   as an error (enabled by default).
3124 </p>
3125 </li>
3126 <li>
3127 <p>
3128 <code>space-before-tab</code> treats a space character that appears immediately
3129   before a tab character in the initial indent part of the line as an
3130   error (enabled by default).
3131 </p>
3132 </li>
3133 <li>
3134 <p>
3135 <code>indent-with-non-tab</code> treats a line that is indented with space
3136   characters instead of the equivalent tabs as an error (not enabled by
3137   default).
3138 </p>
3139 </li>
3140 <li>
3141 <p>
3142 <code>tab-in-indent</code> treats a tab character in the initial indent part of
3143   the line as an error (not enabled by default).
3144 </p>
3145 </li>
3146 <li>
3147 <p>
3148 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
3149   (enabled by default).
3150 </p>
3151 </li>
3152 <li>
3153 <p>
3154 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
3155   <code>blank-at-eof</code>.
3156 </p>
3157 </li>
3158 <li>
3159 <p>
3160 <code>cr-at-eol</code> treats a carriage-return at the end of line as
3161   part of the line terminator, i.e. with it, <code>trailing-space</code>
3162   does not trigger if the character before such a carriage-return
3163   is not a whitespace (not enabled by default).
3164 </p>
3165 </li>
3166 <li>
3167 <p>
3168 <code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
3169   is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
3170   errors. The default tab width is 8. Allowed values are 1 to 63.
3171 </p>
3172 </li>
3173 </ul></div>
3174 </dd>
3175 <dt class="hdlist1">
3176 core.fsync
3177 </dt>
3178 <dd>
3179 <p>
3180         A comma-separated list of components of the repository that
3181         should be hardened via the core.fsyncMethod when created or
3182         modified.  You can disable hardening of any component by
3183         prefixing it with a <em>-</em>.  Items that are not hardened may be
3184         lost in the event of an unclean system shutdown. Unless you
3185         have special requirements, it is recommended that you leave
3186         this option empty or pick one of <code>committed</code>, <code>added</code>,
3187         or <code>all</code>.
3188 </p>
3189 <div class="paragraph"><p>When this configuration is encountered, the set of components starts with
3190 the platform default value, disabled components are removed, and additional
3191 components are added. <code>none</code> resets the state so that the platform default
3192 is ignored.</p></div>
3193 <div class="paragraph"><p>The empty string resets the fsync configuration to the platform
3194 default. The default on most platforms is equivalent to
3195 <code>core.fsync=committed,-loose-object</code>, which has good performance,
3196 but risks losing recent work in the event of an unclean system shutdown.</p></div>
3197 <div class="ulist"><ul>
3198 <li>
3199 <p>
3200 <code>none</code> clears the set of fsynced components.
3201 </p>
3202 </li>
3203 <li>
3204 <p>
3205 <code>loose-object</code> hardens objects added to the repo in loose-object form.
3206 </p>
3207 </li>
3208 <li>
3209 <p>
3210 <code>pack</code> hardens objects added to the repo in packfile form.
3211 </p>
3212 </li>
3213 <li>
3214 <p>
3215 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
3216 </p>
3217 </li>
3218 <li>
3219 <p>
3220 <code>commit-graph</code> hardens the commit-graph file.
3221 </p>
3222 </li>
3223 <li>
3224 <p>
3225 <code>index</code> hardens the index when it is modified.
3226 </p>
3227 </li>
3228 <li>
3229 <p>
3230 <code>objects</code> is an aggregate option that is equivalent to
3231   <code>loose-object,pack</code>.
3232 </p>
3233 </li>
3234 <li>
3235 <p>
3236 <code>reference</code> hardens references modified in the repo.
3237 </p>
3238 </li>
3239 <li>
3240 <p>
3241 <code>derived-metadata</code> is an aggregate option that is equivalent to
3242   <code>pack-metadata,commit-graph</code>.
3243 </p>
3244 </li>
3245 <li>
3246 <p>
3247 <code>committed</code> is an aggregate option that is currently equivalent to
3248   <code>objects</code>. This mode sacrifices some performance to ensure that work
3249   that is committed to the repository with <code>git commit</code> or similar commands
3250   is hardened.
3251 </p>
3252 </li>
3253 <li>
3254 <p>
3255 <code>added</code> is an aggregate option that is currently equivalent to
3256   <code>committed,index</code>. This mode sacrifices additional performance to
3257   ensure that the results of commands like <code>git add</code> and similar operations
3258   are hardened.
3259 </p>
3260 </li>
3261 <li>
3262 <p>
3263 <code>all</code> is an aggregate option that syncs all individual components above.
3264 </p>
3265 </li>
3266 </ul></div>
3267 </dd>
3268 <dt class="hdlist1">
3269 core.fsyncMethod
3270 </dt>
3271 <dd>
3272 <p>
3273         A value indicating the strategy Git will use to harden repository data
3274         using fsync and related primitives.
3275 </p>
3276 <div class="ulist"><ul>
3277 <li>
3278 <p>
3279 <code>fsync</code> uses the fsync() system call or platform equivalents.
3280 </p>
3281 </li>
3282 <li>
3283 <p>
3284 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
3285   filesystem and storage hardware, data added to the repository may not be
3286   durable in the event of a system crash. This is the default mode on macOS.
3287 </p>
3288 </li>
3289 <li>
3290 <p>
3291 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
3292   updates in the disk writeback cache and then does a single full fsync of
3293   a dummy file to trigger the disk cache flush at the end of the operation.
3294 </p>
3295 <div class="paragraph"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
3296 data is made durable as if <code>fsync</code> was specified. This mode is expected to
3297 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
3298 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
3299 </li>
3300 </ul></div>
3301 </dd>
3302 <dt class="hdlist1">
3303 core.fsyncObjectFiles
3304 </dt>
3305 <dd>
3306 <p>
3307         This boolean will enable <em>fsync()</em> when writing object files.
3308         This setting is deprecated. Use core.fsync instead.
3309 </p>
3310 <div class="paragraph"><p>This setting affects data added to the Git repository in loose-object
3311 form. When set to true, Git will issue an fsync or similar system call
3312 to flush caches so that loose-objects remain consistent in the face
3313 of a unclean system shutdown.</p></div>
3314 </dd>
3315 <dt class="hdlist1">
3316 core.preloadIndex
3317 </dt>
3318 <dd>
3319 <p>
3320         Enable parallel index preload for operations like <em>git diff</em>
3321 </p>
3322 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
3323 on filesystems like NFS that have weak caching semantics and thus
3324 relatively high IO latencies.  When enabled, Git will do the
3325 index comparison to the filesystem data in parallel, allowing
3326 overlapping IO&#8217;s.  Defaults to true.</p></div>
3327 </dd>
3328 <dt class="hdlist1">
3329 core.unsetenvvars
3330 </dt>
3331 <dd>
3332 <p>
3333         Windows-only: comma-separated list of environment variables'
3334         names that need to be unset before spawning any other process.
3335         Defaults to <code>PERL5LIB</code> to account for the fact that Git for
3336         Windows insists on using its own Perl interpreter.
3337 </p>
3338 </dd>
3339 <dt class="hdlist1">
3340 core.restrictinheritedhandles
3341 </dt>
3342 <dd>
3343 <p>
3344         Windows-only: override whether spawned processes inherit only standard
3345         file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
3346         <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
3347         Windows 7 and later, and <code>false</code> on older Windows versions.
3348 </p>
3349 </dd>
3350 <dt class="hdlist1">
3351 core.createObject
3352 </dt>
3353 <dd>
3354 <p>
3355         You can set this to <em>link</em>, in which case a hardlink followed by
3356         a delete of the source are used to make sure that object creation
3357         will not overwrite existing objects.
3358 </p>
3359 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
3360 Set this config setting to <em>rename</em> there; However, This will remove the
3361 check that makes sure that existing object files will not get overwritten.</p></div>
3362 </dd>
3363 <dt class="hdlist1">
3364 core.notesRef
3365 </dt>
3366 <dd>
3367 <p>
3368         When showing commit messages, also show notes which are stored in
3369         the given ref.  The ref must be fully qualified.  If the given
3370         ref does not exist, it is not an error but means that no
3371         notes should be printed.
3372 </p>
3373 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
3374 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p></div>
3375 </dd>
3376 <dt class="hdlist1">
3377 core.commitGraph
3378 </dt>
3379 <dd>
3380 <p>
3381         If true, then git will read the commit-graph file (if it exists)
3382         to parse the graph structure of commits. Defaults to true. See
3383         <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
3384 </p>
3385 </dd>
3386 <dt class="hdlist1">
3387 core.useReplaceRefs
3388 </dt>
3389 <dd>
3390 <p>
3391         If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
3392         option was given on the command line. See <a href="git.html">git(1)</a> and
3393         <a href="git-replace.html">git-replace(1)</a> for more information.
3394 </p>
3395 </dd>
3396 <dt class="hdlist1">
3397 core.multiPackIndex
3398 </dt>
3399 <dd>
3400 <p>
3401         Use the multi-pack-index file to track multiple packfiles using a
3402         single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
3403         information. Defaults to true.
3404 </p>
3405 </dd>
3406 <dt class="hdlist1">
3407 core.sparseCheckout
3408 </dt>
3409 <dd>
3410 <p>
3411         Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
3412         for more information.
3413 </p>
3414 </dd>
3415 <dt class="hdlist1">
3416 core.sparseCheckoutCone
3417 </dt>
3418 <dd>
3419 <p>
3420         Enables the "cone mode" of the sparse checkout feature. When the
3421         sparse-checkout file contains a limited set of patterns, this
3422         mode provides significant performance advantages. The "non-cone
3423         mode" can be requested to allow specifying more flexible
3424         patterns by setting this variable to <em>false</em>. See
3425         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.
3426 </p>
3427 </dd>
3428 <dt class="hdlist1">
3429 core.abbrev
3430 </dt>
3431 <dd>
3432 <p>
3433         Set the length object names are abbreviated to.  If
3434         unspecified or set to "auto", an appropriate value is
3435         computed based on the approximate number of packed objects
3436         in your repository, which hopefully is enough for
3437         abbreviated object names to stay unique for some time.
3438         If set to "no", no abbreviation is made and the object names
3439         are shown in their full length.
3440         The minimum length is 4.
3441 </p>
3442 </dd>
3443 <dt class="hdlist1">
3444 core.maxTreeDepth
3445 </dt>
3446 <dd>
3447 <p>
3448         The maximum depth Git is willing to recurse while traversing a
3449         tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
3450         to allow Git to abort cleanly, and should not generally need to
3451         be adjusted. The default is 4096.
3452 </p>
3453 </dd>
3454 <dt class="hdlist1">
3455 add.ignoreErrors
3456 </dt>
3457 <dt class="hdlist1">
3458 add.ignore-errors (deprecated)
3459 </dt>
3460 <dd>
3461 <p>
3462         Tells <em>git add</em> to continue adding files when some files cannot be
3463         added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
3464         option of <a href="git-add.html">git-add(1)</a>.  <code>add.ignore-errors</code> is deprecated,
3465         as it does not follow the usual naming convention for configuration
3466         variables.
3467 </p>
3468 </dd>
3469 <dt class="hdlist1">
3470 add.interactive.useBuiltin
3471 </dt>
3472 <dd>
3473 <p>
3474         Unused configuration variable. Used in Git versions v2.25.0 to
3475         v2.36.0 to enable the built-in version of <a href="git-add.html">git-add(1)</a>'s
3476         interactive mode, which then became the default in Git
3477         versions v2.37.0 to v2.39.0.
3478 </p>
3479 </dd>
3480 <dt class="hdlist1">
3481 alias.*
3482 </dt>
3483 <dd>
3484 <p>
3485         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
3486         after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
3487         <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
3488         confusion and troubles with script usage, aliases that
3489         hide existing Git commands are ignored. Arguments are split by
3490         spaces, the usual shell quoting and escaping is supported.
3491         A quote pair or a backslash can be used to quote them.
3492 </p>
3493 <div class="paragraph"><p>Note that the first word of an alias does not necessarily have to be a
3494 command. It can be a command-line option that will be passed into the
3495 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
3496 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
3497 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
3498 running <code>git loud-rebase</code> would be equivalent to
3499 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
3500 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
3501 where the original command does not.</p></div>
3502 <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
3503 it will be treated as a shell command.  For example, defining
3504 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
3505 <code>git new</code> is equivalent to running the shell command
3506 <code>gitk --all --not ORIG_HEAD</code>.  Note that shell commands will be
3507 executed from the top-level directory of a repository, which may
3508 not necessarily be the current directory.
3509 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
3510 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
3511 </dd>
3512 <dt class="hdlist1">
3513 am.keepcr
3514 </dt>
3515 <dd>
3516 <p>
3517         If true, git-am will call git-mailsplit for patches in mbox format
3518         with parameter <code>--keep-cr</code>. In this case git-mailsplit will
3519         not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
3520         by giving <code>--no-keep-cr</code> from the command line.
3521         See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
3522 </p>
3523 </dd>
3524 <dt class="hdlist1">
3525 am.threeWay
3526 </dt>
3527 <dd>
3528 <p>
3529         By default, <code>git am</code> will fail if the patch does not apply cleanly. When
3530         set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
3531         the patch records the identity of blobs it is supposed to apply to and
3532         we have those blobs available locally (equivalent to giving the <code>--3way</code>
3533         option from the command line). Defaults to <code>false</code>.
3534         See <a href="git-am.html">git-am(1)</a>.
3535 </p>
3536 </dd>
3537 <dt class="hdlist1">
3538 apply.ignoreWhitespace
3539 </dt>
3540 <dd>
3541 <p>
3542         When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
3543         whitespace, in the same way as the <code>--ignore-space-change</code>
3544         option.
3545         When set to one of: no, none, never, false tells <em>git apply</em> to
3546         respect all whitespace differences.
3547         See <a href="git-apply.html">git-apply(1)</a>.
3548 </p>
3549 </dd>
3550 <dt class="hdlist1">
3551 apply.whitespace
3552 </dt>
3553 <dd>
3554 <p>
3555         Tells <em>git apply</em> how to handle whitespaces, in the same way
3556         as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
3557 </p>
3558 </dd>
3559 <dt class="hdlist1">
3560 blame.blankBoundary
3561 </dt>
3562 <dd>
3563 <p>
3564         Show blank commit object name for boundary commits in
3565         <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.
3566 </p>
3567 </dd>
3568 <dt class="hdlist1">
3569 blame.coloring
3570 </dt>
3571 <dd>
3572 <p>
3573         This determines the coloring scheme to be applied to blame
3574         output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
3575         or <em>none</em> which is the default.
3576 </p>
3577 </dd>
3578 <dt class="hdlist1">
3579 blame.date
3580 </dt>
3581 <dd>
3582 <p>
3583         Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
3584         If unset the iso format is used. For supported values,
3585         see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.
3586 </p>
3587 </dd>
3588 <dt class="hdlist1">
3589 blame.showEmail
3590 </dt>
3591 <dd>
3592 <p>
3593         Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
3594         This option defaults to false.
3595 </p>
3596 </dd>
3597 <dt class="hdlist1">
3598 blame.showRoot
3599 </dt>
3600 <dd>
3601 <p>
3602         Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
3603         This option defaults to false.
3604 </p>
3605 </dd>
3606 <dt class="hdlist1">
3607 blame.ignoreRevsFile
3608 </dt>
3609 <dd>
3610 <p>
3611         Ignore revisions listed in the file, one unabbreviated object name per
3612         line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
3613         <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
3614         file names will reset the list of ignored revisions.  This option will
3615         be handled before the command line option <code>--ignore-revs-file</code>.
3616 </p>
3617 </dd>
3618 <dt class="hdlist1">
3619 blame.markUnblamableLines
3620 </dt>
3621 <dd>
3622 <p>
3623         Mark lines that were changed by an ignored revision that we could not
3624         attribute to another commit with a <em>*</em> in the output of
3625         <a href="git-blame.html">git-blame(1)</a>.
3626 </p>
3627 </dd>
3628 <dt class="hdlist1">
3629 blame.markIgnoredLines
3630 </dt>
3631 <dd>
3632 <p>
3633         Mark lines that were changed by an ignored revision that we attributed to
3634         another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.
3635 </p>
3636 </dd>
3637 <dt class="hdlist1">
3638 branch.autoSetupMerge
3639 </dt>
3640 <dd>
3641 <p>
3642         Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
3643         so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
3644         starting point branch. Note that even if this option is not set,
3645         this behavior can be chosen per-branch using the <code>--track</code>
3646         and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
3647         automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
3648         starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;        automatic setup is done when the starting point is either a
3649         local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
3650         has a tracking configuration, it is copied to the new
3651         branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
3652         is a remote-tracking branch and the new branch has the same name as the
3653         remote branch. This option defaults to true.
3654 </p>
3655 </dd>
3656 <dt class="hdlist1">
3657 branch.autoSetupRebase
3658 </dt>
3659 <dd>
3660 <p>
3661         When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
3662         that tracks another branch, this variable tells Git to set
3663         up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
3664         When <code>never</code>, rebase is never automatically set to true.
3665         When <code>local</code>, rebase is set to true for tracked branches of
3666         other local branches.
3667         When <code>remote</code>, rebase is set to true for tracked branches of
3668         remote-tracking branches.
3669         When <code>always</code>, rebase will be set to true for all tracking
3670         branches.
3671         See "branch.autoSetupMerge" for details on how to set up a
3672         branch to track another branch.
3673         This option defaults to never.
3674 </p>
3675 </dd>
3676 <dt class="hdlist1">
3677 branch.sort
3678 </dt>
3679 <dd>
3680 <p>
3681         This variable controls the sort ordering of branches when displayed by
3682         <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
3683         value of this variable will be used as the default.
3684         See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.
3685 </p>
3686 </dd>
3687 <dt class="hdlist1">
3688 branch.&lt;name&gt;.remote
3689 </dt>
3690 <dd>
3691 <p>
3692         When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
3693         which remote to fetch from/push to.  The remote to push to
3694         may be overridden with <code>remote.pushDefault</code> (for all branches).
3695         The remote to push to, for the current branch, may be further
3696         overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
3697         configured, or if you are not on any branch and there is more than
3698         one remote defined in the repository, it defaults to <code>origin</code> for
3699         fetching and <code>remote.pushDefault</code> for pushing.
3700         Additionally, <code>.</code> (a period) is the current local repository
3701         (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
3702 </p>
3703 </dd>
3704 <dt class="hdlist1">
3705 branch.&lt;name&gt;.pushRemote
3706 </dt>
3707 <dd>
3708 <p>
3709         When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
3710         pushing.  It also overrides <code>remote.pushDefault</code> for pushing
3711         from branch &lt;name&gt;.  When you pull from one place (e.g. your
3712         upstream) and push to another place (e.g. your own publishing
3713         repository), you would want to set <code>remote.pushDefault</code> to
3714         specify the remote to push to for all branches, and use this
3715         option to override it for a specific branch.
3716 </p>
3717 </dd>
3718 <dt class="hdlist1">
3719 branch.&lt;name&gt;.merge
3720 </dt>
3721 <dd>
3722 <p>
3723         Defines, together with branch.&lt;name&gt;.remote, the upstream branch
3724         for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
3725         branch to merge and can also affect <em>git push</em> (see push.default).
3726         When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
3727         refspec to be marked for merging in FETCH_HEAD. The value is
3728         handled like the remote part of a refspec, and must match a
3729         ref which is fetched from the remote given by
3730         "branch.&lt;name&gt;.remote".
3731         The merge information is used by <em>git pull</em> (which at first calls
3732         <em>git fetch</em>) to lookup the default branch for merging. Without
3733         this option, <em>git pull</em> defaults to merge the first refspec fetched.
3734         Specify multiple values to get an octopus merge.
3735         If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
3736         another branch in the local repository, you can point
3737         branch.&lt;name&gt;.merge to the desired branch, and use the relative path
3738         setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
3739 </p>
3740 </dd>
3741 <dt class="hdlist1">
3742 branch.&lt;name&gt;.mergeOptions
3743 </dt>
3744 <dd>
3745 <p>
3746         Sets default options for merging into branch &lt;name&gt;. The syntax and
3747         supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
3748         option values containing whitespace characters are currently not
3749         supported.
3750 </p>
3751 </dd>
3752 <dt class="hdlist1">
3753 branch.&lt;name&gt;.rebase
3754 </dt>
3755 <dd>
3756 <p>
3757         When true, rebase the branch &lt;name&gt; on top of the fetched branch,
3758         instead of merging the default branch from the default remote when
3759         "git pull" is run. See "pull.rebase" for doing this in a non
3760         branch-specific manner.
3761 </p>
3762 <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>
3763 so that the local merge commits are included in the rebase (see
3764 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
3765 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
3766 mode.</p></div>
3767 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
3768 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
3769 for details).</p></div>
3770 </dd>
3771 <dt class="hdlist1">
3772 branch.&lt;name&gt;.description
3773 </dt>
3774 <dd>
3775 <p>
3776         Branch description, can be edited with
3777         <code>git branch --edit-description</code>. Branch description is
3778         automatically added in the format-patch cover letter or
3779         request-pull summary.
3780 </p>
3781 </dd>
3782 <dt class="hdlist1">
3783 browser.&lt;tool&gt;.cmd
3784 </dt>
3785 <dd>
3786 <p>
3787         Specify the command to invoke the specified browser. The
3788         specified command is evaluated in shell with the URLs passed
3789         as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
3790 </p>
3791 </dd>
3792 <dt class="hdlist1">
3793 browser.&lt;tool&gt;.path
3794 </dt>
3795 <dd>
3796 <p>
3797         Override the path for the given tool that may be used to
3798         browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
3799         working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
3800 </p>
3801 </dd>
3802 <dt class="hdlist1">
3803 bundle.*
3804 </dt>
3805 <dd>
3806 <p>
3807         The <code>bundle.*</code> keys may appear in a bundle list file found via the
3808         <code>git clone --bundle-uri</code> option. These keys currently have no effect
3809         if placed in a repository config file, though this will change in the
3810         future. See <a href="technical/bundle-uri.html">the bundle URI design
3811         document</a> for more details.
3812 </p>
3813 </dd>
3814 <dt class="hdlist1">
3815 bundle.version
3816 </dt>
3817 <dd>
3818 <p>
3819         This integer value advertises the version of the bundle list format
3820         used by the bundle list. Currently, the only accepted value is <code>1</code>.
3821 </p>
3822 </dd>
3823 <dt class="hdlist1">
3824 bundle.mode
3825 </dt>
3826 <dd>
3827 <p>
3828         This string value should be either <code>all</code> or <code>any</code>. This value describes
3829         whether all of the advertised bundles are required to unbundle a
3830         complete understanding of the bundled information (<code>all</code>) or if any one
3831         of the listed bundle URIs is sufficient (<code>any</code>).
3832 </p>
3833 </dd>
3834 <dt class="hdlist1">
3835 bundle.heuristic
3836 </dt>
3837 <dd>
3838 <p>
3839         If this string-valued key exists, then the bundle list is designed to
3840         work well with incremental <code>git fetch</code> commands. The heuristic signals
3841         that there are additional keys available for each bundle that help
3842         determine which subset of bundles the client should download. The
3843         only value currently understood is <code>creationToken</code>.
3844 </p>
3845 </dd>
3846 <dt class="hdlist1">
3847 bundle.&lt;id&gt;.*
3848 </dt>
3849 <dd>
3850 <p>
3851         The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
3852         bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.
3853 </p>
3854 </dd>
3855 <dt class="hdlist1">
3856 bundle.&lt;id&gt;.uri
3857 </dt>
3858 <dd>
3859 <p>
3860         This string value defines the URI by which Git can reach the contents
3861         of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.
3862 </p>
3863 </dd>
3864 <dt class="hdlist1">
3865 checkout.defaultRemote
3866 </dt>
3867 <dd>
3868 <p>
3869         When you run <code>git checkout &lt;something&gt;</code>
3870         or <code>git switch &lt;something&gt;</code> and only have one
3871         remote, it may implicitly fall back on checking out and
3872         tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
3873         as you have more than one remote with a <code>&lt;something&gt;</code>
3874         reference. This setting allows for setting the name of a
3875         preferred remote that should always win when it comes to
3876         disambiguation. The typical use-case is to set this to
3877         <code>origin</code>.
3878 </p>
3879 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
3880 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
3881 or <code>git switch &lt;something&gt;</code>
3882 will checkout the <code>&lt;something&gt;</code> branch on another remote,
3883 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
3884 remote branch. This setting might be used for other checkout-like
3885 commands or functionality in the future.</p></div>
3886 </dd>
3887 <dt class="hdlist1">
3888 checkout.guess
3889 </dt>
3890 <dd>
3891 <p>
3892         Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
3893         option in <code>git checkout</code> and <code>git switch</code>. See
3894         <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
3895 </p>
3896 </dd>
3897 <dt class="hdlist1">
3898 checkout.workers
3899 </dt>
3900 <dd>
3901 <p>
3902         The number of parallel workers to use when updating the working tree.
3903         The default is one, i.e. sequential execution. If set to a value less
3904         than one, Git will use as many workers as the number of logical cores
3905         available. This setting and <code>checkout.thresholdForParallelism</code> affect
3906         all commands that perform checkout. E.g. checkout, clone, reset,
3907         sparse-checkout, etc.
3908 </p>
3909 <div class="paragraph"><p>Note: parallel checkout usually delivers better performance for repositories
3910 located on SSDs or over NFS. For repositories on spinning disks and/or machines
3911 with a small number of cores, the default sequential checkout often performs
3912 better. The size and compression level of a repository might also influence how
3913 well the parallel version performs.</p></div>
3914 </dd>
3915 <dt class="hdlist1">
3916 checkout.thresholdForParallelism
3917 </dt>
3918 <dd>
3919 <p>
3920         When running parallel checkout with a small number of files, the cost
3921         of subprocess spawning and inter-process communication might outweigh
3922         the parallelization gains. This setting allows to define the minimum
3923         number of files for which parallel checkout should be attempted. The
3924         default is 100.
3925 </p>
3926 </dd>
3927 <dt class="hdlist1">
3928 clean.requireForce
3929 </dt>
3930 <dd>
3931 <p>
3932         A boolean to make git-clean do nothing unless given -f,
3933         -i or -n.   Defaults to true.
3934 </p>
3935 </dd>
3936 <dt class="hdlist1">
3937 clone.defaultRemoteName
3938 </dt>
3939 <dd>
3940 <p>
3941         The name of the remote to create when cloning a repository.  Defaults to
3942         <code>origin</code>, and can be overridden by passing the <code>--origin</code> command-line
3943         option to <a href="git-clone.html">git-clone(1)</a>.
3944 </p>
3945 </dd>
3946 <dt class="hdlist1">
3947 clone.rejectShallow
3948 </dt>
3949 <dd>
3950 <p>
3951         Reject to clone a repository if it is a shallow one, can be overridden by
3952         passing option <code>--reject-shallow</code> in command line. See <a href="git-clone.html">git-clone(1)</a>
3953 </p>
3954 </dd>
3955 <dt class="hdlist1">
3956 clone.filterSubmodules
3957 </dt>
3958 <dd>
3959 <p>
3960         If a partial clone filter is provided (see <code>--filter</code> in
3961         <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
3962         the filter to submodules.
3963 </p>
3964 </dd>
3965 <dt class="hdlist1">
3966 color.advice
3967 </dt>
3968 <dd>
3969 <p>
3970         A boolean to enable/disable color in hints (e.g. when a push
3971         failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
3972         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
3973         are used only when the error output goes to a terminal. If
3974         unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3975 </p>
3976 </dd>
3977 <dt class="hdlist1">
3978 color.advice.hint
3979 </dt>
3980 <dd>
3981 <p>
3982         Use customized color for hints.
3983 </p>
3984 </dd>
3985 <dt class="hdlist1">
3986 color.blame.highlightRecent
3987 </dt>
3988 <dd>
3989 <p>
3990         Specify the line annotation color for <code>git blame --color-by-age</code>
3991         depending upon the age of the line.
3992 </p>
3993 <div class="paragraph"><p>This setting should be set to a comma-separated list of color and
3994 date settings, starting and ending with a color, the dates should be
3995 set from oldest to newest. The metadata will be colored with the
3996 specified colors if the line was introduced before the given
3997 timestamp, overwriting older timestamped colors.</p></div>
3998 <div class="paragraph"><p>Instead of an absolute timestamp relative timestamps work as well,
3999 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
4000 <div class="paragraph"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
4001 colors everything older than one year blue, recent changes between
4002 one month and one year old are kept white, and lines introduced
4003 within the last month are colored red.</p></div>
4004 </dd>
4005 <dt class="hdlist1">
4006 color.blame.repeatedLines
4007 </dt>
4008 <dd>
4009 <p>
4010         Use the specified color to colorize line annotations for
4011         <code>git blame --color-lines</code>, if they come from the same commit as the
4012         preceding line. Defaults to cyan.
4013 </p>
4014 </dd>
4015 <dt class="hdlist1">
4016 color.branch
4017 </dt>
4018 <dd>
4019 <p>
4020         A boolean to enable/disable color in the output of
4021         <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
4022         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4023         only when the output is to a terminal. If unset, then the
4024         value of <code>color.ui</code> is used (<code>auto</code> by default).
4025 </p>
4026 </dd>
4027 <dt class="hdlist1">
4028 color.branch.&lt;slot&gt;
4029 </dt>
4030 <dd>
4031 <p>
4032         Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
4033         <code>current</code> (the current branch), <code>local</code> (a local branch),
4034         <code>remote</code> (a remote-tracking branch in refs/remotes/),
4035         <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
4036         refs).
4037 </p>
4038 </dd>
4039 <dt class="hdlist1">
4040 color.diff
4041 </dt>
4042 <dd>
4043 <p>
4044         Whether to use ANSI escape sequences to add color to patches.
4045         If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
4046         <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
4047         for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
4048         commands will only use color when output is to the terminal.
4049         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
4050         default).
4051 </p>
4052 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
4053 <em>git-diff-&#42;</em> plumbing commands.  Can be overridden on the
4054 command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
4055 </dd>
4056 <dt class="hdlist1">
4057 color.diff.&lt;slot&gt;
4058 </dt>
4059 <dd>
4060 <p>
4061         Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
4062         which part of the patch to use the specified color, and is one
4063         of <code>context</code> (context text - <code>plain</code> is a historical synonym),
4064         <code>meta</code> (metainformation), <code>frag</code>
4065         (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
4066         <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
4067         (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
4068         <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
4069         <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
4070         <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
4071         setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
4072         <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
4073         <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).
4074 </p>
4075 </dd>
4076 <dt class="hdlist1">
4077 color.decorate.&lt;slot&gt;
4078 </dt>
4079 <dd>
4080 <p>
4081         Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
4082         of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
4083         branches, remote-tracking branches, tags, stash and HEAD, respectively
4084         and <code>grafted</code> for grafted commits.
4085 </p>
4086 </dd>
4087 <dt class="hdlist1">
4088 color.grep
4089 </dt>
4090 <dd>
4091 <p>
4092         When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
4093         <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
4094         when the output is written to the terminal.  If unset, then the
4095         value of <code>color.ui</code> is used (<code>auto</code> by default).
4096 </p>
4097 </dd>
4098 <dt class="hdlist1">
4099 color.grep.&lt;slot&gt;
4100 </dt>
4101 <dd>
4102 <p>
4103         Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
4104         part of the line to use the specified color, and is one of
4105 </p>
4106 <div class="openblock">
4107 <div class="content">
4108 <div class="dlist"><dl>
4109 <dt class="hdlist1">
4110 <code>context</code>
4111 </dt>
4112 <dd>
4113 <p>
4114         non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
4115 </p>
4116 </dd>
4117 <dt class="hdlist1">
4118 <code>filename</code>
4119 </dt>
4120 <dd>
4121 <p>
4122         filename prefix (when not using <code>-h</code>)
4123 </p>
4124 </dd>
4125 <dt class="hdlist1">
4126 <code>function</code>
4127 </dt>
4128 <dd>
4129 <p>
4130         function name lines (when using <code>-p</code>)
4131 </p>
4132 </dd>
4133 <dt class="hdlist1">
4134 <code>lineNumber</code>
4135 </dt>
4136 <dd>
4137 <p>
4138         line number prefix (when using <code>-n</code>)
4139 </p>
4140 </dd>
4141 <dt class="hdlist1">
4142 <code>column</code>
4143 </dt>
4144 <dd>
4145 <p>
4146         column number prefix (when using <code>--column</code>)
4147 </p>
4148 </dd>
4149 <dt class="hdlist1">
4150 <code>match</code>
4151 </dt>
4152 <dd>
4153 <p>
4154         matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
4155 </p>
4156 </dd>
4157 <dt class="hdlist1">
4158 <code>matchContext</code>
4159 </dt>
4160 <dd>
4161 <p>
4162         matching text in context lines
4163 </p>
4164 </dd>
4165 <dt class="hdlist1">
4166 <code>matchSelected</code>
4167 </dt>
4168 <dd>
4169 <p>
4170         matching text in selected lines. Also, used to customize the following
4171         <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and <code>--committer</code>.
4172 </p>
4173 </dd>
4174 <dt class="hdlist1">
4175 <code>selected</code>
4176 </dt>
4177 <dd>
4178 <p>
4179         non-matching text in selected lines. Also, used to customize the
4180         following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
4181         <code>--committer</code>.
4182 </p>
4183 </dd>
4184 <dt class="hdlist1">
4185 <code>separator</code>
4186 </dt>
4187 <dd>
4188 <p>
4189         separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
4190         and between hunks (<code>--</code>)
4191 </p>
4192 </dd>
4193 </dl></div>
4194 </div></div>
4195 </dd>
4196 <dt class="hdlist1">
4197 color.interactive
4198 </dt>
4199 <dd>
4200 <p>
4201         When set to <code>always</code>, always use colors for interactive prompts
4202         and displays (such as those used by "git-add --interactive" and
4203         "git-clean --interactive"). When false (or <code>never</code>), never.
4204         When set to <code>true</code> or <code>auto</code>, use colors only when the output is
4205         to the terminal. If unset, then the value of <code>color.ui</code> is
4206         used (<code>auto</code> by default).
4207 </p>
4208 </dd>
4209 <dt class="hdlist1">
4210 color.interactive.&lt;slot&gt;
4211 </dt>
4212 <dd>
4213 <p>
4214         Use customized color for <em>git add --interactive</em> and <em>git clean
4215         --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
4216         or <code>error</code>, for four distinct types of normal output from
4217         interactive commands.
4218 </p>
4219 </dd>
4220 <dt class="hdlist1">
4221 color.pager
4222 </dt>
4223 <dd>
4224 <p>
4225         A boolean to specify whether <code>auto</code> color modes should colorize
4226         output going to the pager. Defaults to true; set this to false
4227         if your pager does not understand ANSI color codes.
4228 </p>
4229 </dd>
4230 <dt class="hdlist1">
4231 color.push
4232 </dt>
4233 <dd>
4234 <p>
4235         A boolean to enable/disable color in push errors. May be set to
4236         <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
4237         case colors are used only when the error output goes to a terminal.
4238         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
4239 </p>
4240 </dd>
4241 <dt class="hdlist1">
4242 color.push.error
4243 </dt>
4244 <dd>
4245 <p>
4246         Use customized color for push errors.
4247 </p>
4248 </dd>
4249 <dt class="hdlist1">
4250 color.remote
4251 </dt>
4252 <dd>
4253 <p>
4254         If set, keywords at the start of the line are highlighted. The
4255         keywords are "error", "warning", "hint" and "success", and are
4256         matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
4257         <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
4258         <code>color.ui</code> is used (<code>auto</code> by default).
4259 </p>
4260 </dd>
4261 <dt class="hdlist1">
4262 color.remote.&lt;slot&gt;
4263 </dt>
4264 <dd>
4265 <p>
4266         Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
4267         <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
4268         corresponding keyword.
4269 </p>
4270 </dd>
4271 <dt class="hdlist1">
4272 color.showBranch
4273 </dt>
4274 <dd>
4275 <p>
4276         A boolean to enable/disable color in the output of
4277         <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
4278         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4279         only when the output is to a terminal. If unset, then the
4280         value of <code>color.ui</code> is used (<code>auto</code> by default).
4281 </p>
4282 </dd>
4283 <dt class="hdlist1">
4284 color.status
4285 </dt>
4286 <dd>
4287 <p>
4288         A boolean to enable/disable color in the output of
4289         <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
4290         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4291         only when the output is to a terminal. If unset, then the
4292         value of <code>color.ui</code> is used (<code>auto</code> by default).
4293 </p>
4294 </dd>
4295 <dt class="hdlist1">
4296 color.status.&lt;slot&gt;
4297 </dt>
4298 <dd>
4299 <p>
4300         Use customized color for status colorization. <code>&lt;slot&gt;</code> is
4301         one of <code>header</code> (the header text of the status message),
4302         <code>added</code> or <code>updated</code> (files which are added but not committed),
4303         <code>changed</code> (files which are changed but not added in the index),
4304         <code>untracked</code> (files which are not tracked by Git),
4305         <code>branch</code> (the current branch),
4306         <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
4307         to red),
4308         <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
4309         respectively, when branch and tracking information is displayed in the
4310         status short-format), or
4311         <code>unmerged</code> (files which have unmerged changes).
4312 </p>
4313 </dd>
4314 <dt class="hdlist1">
4315 color.transport
4316 </dt>
4317 <dd>
4318 <p>
4319         A boolean to enable/disable color when pushes are rejected. May be
4320         set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
4321         case colors are used only when the error output goes to a terminal.
4322         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
4323 </p>
4324 </dd>
4325 <dt class="hdlist1">
4326 color.transport.rejected
4327 </dt>
4328 <dd>
4329 <p>
4330         Use customized color when a push was rejected.
4331 </p>
4332 </dd>
4333 <dt class="hdlist1">
4334 color.ui
4335 </dt>
4336 <dd>
4337 <p>
4338         This variable determines the default value for variables such
4339         as <code>color.diff</code> and <code>color.grep</code> that control the use of color
4340         per command family. Its scope will expand as more commands learn
4341         configuration to set a default for the <code>--color</code> option.  Set it
4342         to <code>false</code> or <code>never</code> if you prefer Git commands not to use
4343         color unless enabled explicitly with some other configuration
4344         or the <code>--color</code> option. Set it to <code>always</code> if you want all
4345         output not intended for machine consumption to use color, to
4346         <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
4347         want such output to use color when written to the terminal.
4348 </p>
4349 </dd>
4350 <dt class="hdlist1">
4351 column.ui
4352 </dt>
4353 <dd>
4354 <p>
4355         Specify whether supported commands should output in columns.
4356         This variable consists of a list of tokens separated by spaces
4357         or commas:
4358 </p>
4359 <div class="paragraph"><p>These options control when the feature should be enabled
4360 (defaults to <em>never</em>):</p></div>
4361 <div class="openblock">
4362 <div class="content">
4363 <div class="dlist"><dl>
4364 <dt class="hdlist1">
4365 <code>always</code>
4366 </dt>
4367 <dd>
4368 <p>
4369         always show in columns
4370 </p>
4371 </dd>
4372 <dt class="hdlist1">
4373 <code>never</code>
4374 </dt>
4375 <dd>
4376 <p>
4377         never show in columns
4378 </p>
4379 </dd>
4380 <dt class="hdlist1">
4381 <code>auto</code>
4382 </dt>
4383 <dd>
4384 <p>
4385         show in columns if the output is to the terminal
4386 </p>
4387 </dd>
4388 </dl></div>
4389 </div></div>
4390 <div class="paragraph"><p>These options control layout (defaults to <em>column</em>).  Setting any
4391 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
4392 specified.</p></div>
4393 <div class="openblock">
4394 <div class="content">
4395 <div class="dlist"><dl>
4396 <dt class="hdlist1">
4397 <code>column</code>
4398 </dt>
4399 <dd>
4400 <p>
4401         fill columns before rows
4402 </p>
4403 </dd>
4404 <dt class="hdlist1">
4405 <code>row</code>
4406 </dt>
4407 <dd>
4408 <p>
4409         fill rows before columns
4410 </p>
4411 </dd>
4412 <dt class="hdlist1">
4413 <code>plain</code>
4414 </dt>
4415 <dd>
4416 <p>
4417         show in one column
4418 </p>
4419 </dd>
4420 </dl></div>
4421 </div></div>
4422 <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
4423 to <em>nodense</em>):</p></div>
4424 <div class="openblock">
4425 <div class="content">
4426 <div class="dlist"><dl>
4427 <dt class="hdlist1">
4428 <code>dense</code>
4429 </dt>
4430 <dd>
4431 <p>
4432         make unequal size columns to utilize more space
4433 </p>
4434 </dd>
4435 <dt class="hdlist1">
4436 <code>nodense</code>
4437 </dt>
4438 <dd>
4439 <p>
4440         make equal size columns
4441 </p>
4442 </dd>
4443 </dl></div>
4444 </div></div>
4445 </dd>
4446 <dt class="hdlist1">
4447 column.branch
4448 </dt>
4449 <dd>
4450 <p>
4451         Specify whether to output branch listing in <code>git branch</code> in columns.
4452         See <code>column.ui</code> for details.
4453 </p>
4454 </dd>
4455 <dt class="hdlist1">
4456 column.clean
4457 </dt>
4458 <dd>
4459 <p>
4460         Specify the layout when list items in <code>git clean -i</code>, which always
4461         shows files and directories in columns. See <code>column.ui</code> for details.
4462 </p>
4463 </dd>
4464 <dt class="hdlist1">
4465 column.status
4466 </dt>
4467 <dd>
4468 <p>
4469         Specify whether to output untracked files in <code>git status</code> in columns.
4470         See <code>column.ui</code> for details.
4471 </p>
4472 </dd>
4473 <dt class="hdlist1">
4474 column.tag
4475 </dt>
4476 <dd>
4477 <p>
4478         Specify whether to output tag listing in <code>git tag</code> in columns.
4479         See <code>column.ui</code> for details.
4480 </p>
4481 </dd>
4482 <dt class="hdlist1">
4483 commit.cleanup
4484 </dt>
4485 <dd>
4486 <p>
4487         This setting overrides the default of the <code>--cleanup</code> option in
4488         <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
4489         default can be useful when you always want to keep lines that begin
4490         with comment character <code>#</code> in your log message, in which case you
4491         would do <code>git config commit.cleanup whitespace</code> (note that you will
4492         have to remove the help lines that begin with <code>#</code> in the commit log
4493         template yourself, if you do this).
4494 </p>
4495 </dd>
4496 <dt class="hdlist1">
4497 commit.gpgSign
4498 </dt>
4499 <dd>
4500 <p>
4501         A boolean to specify whether all commits should be GPG signed.
4502         Use of this option when doing operations such as rebase can
4503         result in a large number of commits being signed. It may be
4504         convenient to use an agent to avoid typing your GPG passphrase
4505         several times.
4506 </p>
4507 </dd>
4508 <dt class="hdlist1">
4509 commit.status
4510 </dt>
4511 <dd>
4512 <p>
4513         A boolean to enable/disable inclusion of status information in the
4514         commit message template when using an editor to prepare the commit
4515         message.  Defaults to true.
4516 </p>
4517 </dd>
4518 <dt class="hdlist1">
4519 commit.template
4520 </dt>
4521 <dd>
4522 <p>
4523         Specify the pathname of a file to use as the template for
4524         new commit messages.
4525 </p>
4526 </dd>
4527 <dt class="hdlist1">
4528 commit.verbose
4529 </dt>
4530 <dd>
4531 <p>
4532         A boolean or int to specify the level of verbose with <code>git commit</code>.
4533         See <a href="git-commit.html">git-commit(1)</a>.
4534 </p>
4535 </dd>
4536 <dt class="hdlist1">
4537 commitGraph.generationVersion
4538 </dt>
4539 <dd>
4540 <p>
4541         Specifies the type of generation number version to use when writing
4542         or reading the commit-graph file. If version 1 is specified, then
4543         the corrected commit dates will not be written or read. Defaults to
4544         2.
4545 </p>
4546 </dd>
4547 <dt class="hdlist1">
4548 commitGraph.maxNewFilters
4549 </dt>
4550 <dd>
4551 <p>
4552         Specifies the default value for the <code>--max-new-filters</code> option of <code>git
4553         commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).
4554 </p>
4555 </dd>
4556 <dt class="hdlist1">
4557 commitGraph.readChangedPaths
4558 </dt>
4559 <dd>
4560 <p>
4561         If true, then git will use the changed-path Bloom filters in the
4562         commit-graph file (if it exists, and they are present). Defaults to
4563         true. See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
4564 </p>
4565 </dd>
4566 <dt class="hdlist1">
4567 credential.helper
4568 </dt>
4569 <dd>
4570 <p>
4571         Specify an external helper to be called when a username or
4572         password credential is needed; the helper may consult external
4573         storage to avoid prompting the user for the credentials. This is
4574         normally the name of a credential helper with possible
4575         arguments, but may also be an absolute path with arguments or, if
4576         preceded by <code>!</code>, shell commands.
4577 </p>
4578 <div class="paragraph"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
4579 for details and examples.</p></div>
4580 </dd>
4581 <dt class="hdlist1">
4582 credential.useHttpPath
4583 </dt>
4584 <dd>
4585 <p>
4586         When acquiring credentials, consider the "path" component of an http
4587         or https URL to be important. Defaults to false. See
4588         <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
4589 </p>
4590 </dd>
4591 <dt class="hdlist1">
4592 credential.username
4593 </dt>
4594 <dd>
4595 <p>
4596         If no username is set for a network authentication, use this username
4597         by default. See credential.&lt;context&gt;.* below, and
4598         <a href="gitcredentials.html">gitcredentials(7)</a>.
4599 </p>
4600 </dd>
4601 <dt class="hdlist1">
4602 credential.&lt;url&gt;.*
4603 </dt>
4604 <dd>
4605 <p>
4606         Any of the credential.* options above can be applied selectively to
4607         some credentials. For example "credential.https://example.com.username"
4608         would set the default username only for https connections to
4609         example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
4610         matched.
4611 </p>
4612 </dd>
4613 <dt class="hdlist1">
4614 credentialCache.ignoreSIGHUP
4615 </dt>
4616 <dd>
4617 <p>
4618         Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
4619 </p>
4620 </dd>
4621 <dt class="hdlist1">
4622 credentialStore.lockTimeoutMS
4623 </dt>
4624 <dd>
4625 <p>
4626         The length of time, in milliseconds, for git-credential-store to retry
4627         when trying to lock the credentials file. Value 0 means not to retry at
4628         all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
4629         1s).
4630 </p>
4631 </dd>
4632 <dt class="hdlist1">
4633 completion.commands
4634 </dt>
4635 <dd>
4636 <p>
4637         This is only used by git-completion.bash to add or remove
4638         commands from the list of completed commands. Normally only
4639         porcelain commands and a few select others are completed. You
4640         can add more commands, separated by space, in this
4641         variable. Prefixing the command with <em>-</em> will remove it from
4642         the existing list.
4643 </p>
4644 </dd>
4645 <dt class="hdlist1">
4646 diff.autoRefreshIndex
4647 </dt>
4648 <dd>
4649 <p>
4650         When using <em>git diff</em> to compare with work tree
4651         files, do not consider stat-only change as changed.
4652         Instead, silently run <code>git update-index --refresh</code> to
4653         update the cached stat information for paths whose
4654         contents in the work tree match the contents in the
4655         index.  This option defaults to true.  Note that this
4656         affects only <em>git diff</em> Porcelain, and not lower level
4657         <em>diff</em> commands such as <em>git diff-files</em>.
4658 </p>
4659 </dd>
4660 <dt class="hdlist1">
4661 diff.dirstat
4662 </dt>
4663 <dd>
4664 <p>
4665         A comma separated list of <code>--dirstat</code> parameters specifying the
4666         default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
4667         and friends. The defaults can be overridden on the command line
4668         (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
4669         (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
4670         The following parameters are available:
4671 </p>
4672 <div class="openblock">
4673 <div class="content">
4674 <div class="dlist"><dl>
4675 <dt class="hdlist1">
4676 <code>changes</code>
4677 </dt>
4678 <dd>
4679 <p>
4680         Compute the dirstat numbers by counting the lines that have been
4681         removed from the source, or added to the destination. This ignores
4682         the amount of pure code movements within a file.  In other words,
4683         rearranging lines in a file is not counted as much as other changes.
4684         This is the default behavior when no parameter is given.
4685 </p>
4686 </dd>
4687 <dt class="hdlist1">
4688 <code>lines</code>
4689 </dt>
4690 <dd>
4691 <p>
4692         Compute the dirstat numbers by doing the regular line-based diff
4693         analysis, and summing the removed/added line counts. (For binary
4694         files, count 64-byte chunks instead, since binary files have no
4695         natural concept of lines). This is a more expensive <code>--dirstat</code>
4696         behavior than the <code>changes</code> behavior, but it does count rearranged
4697         lines within a file as much as other changes. The resulting output
4698         is consistent with what you get from the other <code>--*stat</code> options.
4699 </p>
4700 </dd>
4701 <dt class="hdlist1">
4702 <code>files</code>
4703 </dt>
4704 <dd>
4705 <p>
4706         Compute the dirstat numbers by counting the number of files changed.
4707         Each changed file counts equally in the dirstat analysis. This is
4708         the computationally cheapest <code>--dirstat</code> behavior, since it does
4709         not have to look at the file contents at all.
4710 </p>
4711 </dd>
4712 <dt class="hdlist1">
4713 <code>cumulative</code>
4714 </dt>
4715 <dd>
4716 <p>
4717         Count changes in a child directory for the parent directory as well.
4718         Note that when using <code>cumulative</code>, the sum of the percentages
4719         reported may exceed 100%. The default (non-cumulative) behavior can
4720         be specified with the <code>noncumulative</code> parameter.
4721 </p>
4722 </dd>
4723 <dt class="hdlist1">
4724 &lt;limit&gt;
4725 </dt>
4726 <dd>
4727 <p>
4728         An integer parameter specifies a cut-off percent (3% by default).
4729         Directories contributing less than this percentage of the changes
4730         are not shown in the output.
4731 </p>
4732 </dd>
4733 </dl></div>
4734 </div></div>
4735 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
4736 directories with less than 10% of the total amount of changed files,
4737 and accumulating child directory counts in the parent directories:
4738 <code>files,10,cumulative</code>.</p></div>
4739 </dd>
4740 <dt class="hdlist1">
4741 diff.statGraphWidth
4742 </dt>
4743 <dd>
4744 <p>
4745         Limit the width of the graph part in --stat output. If set, applies
4746         to all commands generating --stat output except format-patch.
4747 </p>
4748 </dd>
4749 <dt class="hdlist1">
4750 diff.context
4751 </dt>
4752 <dd>
4753 <p>
4754         Generate diffs with &lt;n&gt; lines of context instead of the default
4755         of 3. This value is overridden by the -U option.
4756 </p>
4757 </dd>
4758 <dt class="hdlist1">
4759 diff.interHunkContext
4760 </dt>
4761 <dd>
4762 <p>
4763         Show the context between diff hunks, up to the specified number
4764         of lines, thereby fusing the hunks that are close to each other.
4765         This value serves as the default for the <code>--inter-hunk-context</code>
4766         command line option.
4767 </p>
4768 </dd>
4769 <dt class="hdlist1">
4770 diff.external
4771 </dt>
4772 <dd>
4773 <p>
4774         If this config variable is set, diff generation is not
4775         performed using the internal diff machinery, but using the
4776         given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
4777         environment variable.  The command is called with parameters
4778         as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
4779         you want to use an external diff program only on a subset of
4780         your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
4781 </p>
4782 </dd>
4783 <dt class="hdlist1">
4784 diff.ignoreSubmodules
4785 </dt>
4786 <dd>
4787 <p>
4788         Sets the default value of --ignore-submodules. Note that this
4789         affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
4790         commands such as <em>git diff-files</em>. <em>git checkout</em>
4791         and <em>git switch</em> also honor
4792         this setting when reporting uncommitted changes. Setting it to
4793         <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
4794         and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
4795         overridden by using the --ignore-submodules command-line option.
4796         The <em>git submodule</em> commands are not affected by this setting.
4797         By default this is set to untracked so that any untracked
4798         submodules are ignored.
4799 </p>
4800 </dd>
4801 <dt class="hdlist1">
4802 diff.mnemonicPrefix
4803 </dt>
4804 <dd>
4805 <p>
4806         If set, <em>git diff</em> uses a prefix pair that is different from the
4807         standard "a/" and "b/" depending on what is being compared.  When
4808         this configuration is in effect, reverse diff output also swaps
4809         the order of the prefixes:
4810 </p>
4811 <div class="dlist"><dl>
4812 <dt class="hdlist1">
4813 <code>git diff</code>
4814 </dt>
4815 <dd>
4816 <p>
4817         compares the (i)ndex and the (w)ork tree;
4818 </p>
4819 </dd>
4820 <dt class="hdlist1">
4821 <code>git diff HEAD</code>
4822 </dt>
4823 <dd>
4824 <p>
4825          compares a (c)ommit and the (w)ork tree;
4826 </p>
4827 </dd>
4828 <dt class="hdlist1">
4829 <code>git diff --cached</code>
4830 </dt>
4831 <dd>
4832 <p>
4833         compares a (c)ommit and the (i)ndex;
4834 </p>
4835 </dd>
4836 <dt class="hdlist1">
4837 <code>git diff HEAD:file1 file2</code>
4838 </dt>
4839 <dd>
4840 <p>
4841         compares an (o)bject and a (w)ork tree entity;
4842 </p>
4843 </dd>
4844 <dt class="hdlist1">
4845 <code>git diff --no-index a b</code>
4846 </dt>
4847 <dd>
4848 <p>
4849         compares two non-git things (1) and (2).
4850 </p>
4851 </dd>
4852 </dl></div>
4853 </dd>
4854 <dt class="hdlist1">
4855 diff.noprefix
4856 </dt>
4857 <dd>
4858 <p>
4859         If set, <em>git diff</em> does not show any source or destination prefix.
4860 </p>
4861 </dd>
4862 <dt class="hdlist1">
4863 diff.relative
4864 </dt>
4865 <dd>
4866 <p>
4867         If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
4868         and show pathnames relative to the current directory.
4869 </p>
4870 </dd>
4871 <dt class="hdlist1">
4872 diff.orderFile
4873 </dt>
4874 <dd>
4875 <p>
4876         File indicating how to order files within a diff.
4877         See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
4878         If <code>diff.orderFile</code> is a relative pathname, it is treated as
4879         relative to the top of the working tree.
4880 </p>
4881 </dd>
4882 <dt class="hdlist1">
4883 diff.renameLimit
4884 </dt>
4885 <dd>
4886 <p>
4887         The number of files to consider in the exhaustive portion of
4888         copy/rename detection; equivalent to the <em>git diff</em> option
4889         <code>-l</code>.  If not set, the default value is currently 1000.  This
4890         setting has no effect if rename detection is turned off.
4891 </p>
4892 </dd>
4893 <dt class="hdlist1">
4894 diff.renames
4895 </dt>
4896 <dd>
4897 <p>
4898         Whether and how Git detects renames.  If set to "false",
4899         rename detection is disabled. If set to "true", basic rename
4900         detection is enabled.  If set to "copies" or "copy", Git will
4901         detect copies, as well.  Defaults to true.  Note that this
4902         affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
4903         <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
4904         <a href="git-diff-files.html">git-diff-files(1)</a>.
4905 </p>
4906 </dd>
4907 <dt class="hdlist1">
4908 diff.suppressBlankEmpty
4909 </dt>
4910 <dd>
4911 <p>
4912         A boolean to inhibit the standard behavior of printing a space
4913         before each empty output line. Defaults to false.
4914 </p>
4915 </dd>
4916 <dt class="hdlist1">
4917 diff.submodule
4918 </dt>
4919 <dd>
4920 <p>
4921         Specify the format in which differences in submodules are
4922         shown.  The "short" format just shows the names of the commits
4923         at the beginning and end of the range. The "log" format lists
4924         the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
4925         does. The "diff" format shows an inline diff of the changed
4926         contents of the submodule. Defaults to "short".
4927 </p>
4928 </dd>
4929 <dt class="hdlist1">
4930 diff.wordRegex
4931 </dt>
4932 <dd>
4933 <p>
4934         A POSIX Extended Regular Expression used to determine what is a "word"
4935         when performing word-by-word difference calculations.  Character
4936         sequences that match the regular expression are "words", all other
4937         characters are <strong>ignorable</strong> whitespace.
4938 </p>
4939 </dd>
4940 <dt class="hdlist1">
4941 diff.&lt;driver&gt;.command
4942 </dt>
4943 <dd>
4944 <p>
4945         The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
4946         for details.
4947 </p>
4948 </dd>
4949 <dt class="hdlist1">
4950 diff.&lt;driver&gt;.xfuncname
4951 </dt>
4952 <dd>
4953 <p>
4954         The regular expression that the diff driver should use to
4955         recognize the hunk header.  A built-in pattern may also be used.
4956         See <a href="gitattributes.html">gitattributes(5)</a> for details.
4957 </p>
4958 </dd>
4959 <dt class="hdlist1">
4960 diff.&lt;driver&gt;.binary
4961 </dt>
4962 <dd>
4963 <p>
4964         Set this option to true to make the diff driver treat files as
4965         binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
4966 </p>
4967 </dd>
4968 <dt class="hdlist1">
4969 diff.&lt;driver&gt;.textconv
4970 </dt>
4971 <dd>
4972 <p>
4973         The command that the diff driver should call to generate the
4974         text-converted version of a file.  The result of the
4975         conversion is used to generate a human-readable diff.  See
4976         <a href="gitattributes.html">gitattributes(5)</a> for details.
4977 </p>
4978 </dd>
4979 <dt class="hdlist1">
4980 diff.&lt;driver&gt;.wordRegex
4981 </dt>
4982 <dd>
4983 <p>
4984         The regular expression that the diff driver should use to
4985         split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
4986         details.
4987 </p>
4988 </dd>
4989 <dt class="hdlist1">
4990 diff.&lt;driver&gt;.cachetextconv
4991 </dt>
4992 <dd>
4993 <p>
4994         Set this option to true to make the diff driver cache the text
4995         conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
4996 </p>
4997 <div class="dlist"><dl>
4998 <dt class="hdlist1">
4999 <code>araxis</code>
5000 </dt>
5001 <dd>
5002 <p>
5003 Use Araxis Merge (requires a graphical session)
5004 </p>
5005 </dd>
5006 <dt class="hdlist1">
5007 <code>bc</code>
5008 </dt>
5009 <dd>
5010 <p>
5011 Use Beyond Compare (requires a graphical session)
5012 </p>
5013 </dd>
5014 <dt class="hdlist1">
5015 <code>bc3</code>
5016 </dt>
5017 <dd>
5018 <p>
5019 Use Beyond Compare (requires a graphical session)
5020 </p>
5021 </dd>
5022 <dt class="hdlist1">
5023 <code>bc4</code>
5024 </dt>
5025 <dd>
5026 <p>
5027 Use Beyond Compare (requires a graphical session)
5028 </p>
5029 </dd>
5030 <dt class="hdlist1">
5031 <code>codecompare</code>
5032 </dt>
5033 <dd>
5034 <p>
5035 Use Code Compare (requires a graphical session)
5036 </p>
5037 </dd>
5038 <dt class="hdlist1">
5039 <code>deltawalker</code>
5040 </dt>
5041 <dd>
5042 <p>
5043 Use DeltaWalker (requires a graphical session)
5044 </p>
5045 </dd>
5046 <dt class="hdlist1">
5047 <code>diffmerge</code>
5048 </dt>
5049 <dd>
5050 <p>
5051 Use DiffMerge (requires a graphical session)
5052 </p>
5053 </dd>
5054 <dt class="hdlist1">
5055 <code>diffuse</code>
5056 </dt>
5057 <dd>
5058 <p>
5059 Use Diffuse (requires a graphical session)
5060 </p>
5061 </dd>
5062 <dt class="hdlist1">
5063 <code>ecmerge</code>
5064 </dt>
5065 <dd>
5066 <p>
5067 Use ECMerge (requires a graphical session)
5068 </p>
5069 </dd>
5070 <dt class="hdlist1">
5071 <code>emerge</code>
5072 </dt>
5073 <dd>
5074 <p>
5075 Use Emacs' Emerge
5076 </p>
5077 </dd>
5078 <dt class="hdlist1">
5079 <code>examdiff</code>
5080 </dt>
5081 <dd>
5082 <p>
5083 Use ExamDiff Pro (requires a graphical session)
5084 </p>
5085 </dd>
5086 <dt class="hdlist1">
5087 <code>guiffy</code>
5088 </dt>
5089 <dd>
5090 <p>
5091 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
5092 </p>
5093 </dd>
5094 <dt class="hdlist1">
5095 <code>gvimdiff</code>
5096 </dt>
5097 <dd>
5098 <p>
5099 Use gVim (requires a graphical session)
5100 </p>
5101 </dd>
5102 <dt class="hdlist1">
5103 <code>kdiff3</code>
5104 </dt>
5105 <dd>
5106 <p>
5107 Use KDiff3 (requires a graphical session)
5108 </p>
5109 </dd>
5110 <dt class="hdlist1">
5111 <code>kompare</code>
5112 </dt>
5113 <dd>
5114 <p>
5115 Use Kompare (requires a graphical session)
5116 </p>
5117 </dd>
5118 <dt class="hdlist1">
5119 <code>meld</code>
5120 </dt>
5121 <dd>
5122 <p>
5123 Use Meld (requires a graphical session)
5124 </p>
5125 </dd>
5126 <dt class="hdlist1">
5127 <code>nvimdiff</code>
5128 </dt>
5129 <dd>
5130 <p>
5131 Use Neovim
5132 </p>
5133 </dd>
5134 <dt class="hdlist1">
5135 <code>opendiff</code>
5136 </dt>
5137 <dd>
5138 <p>
5139 Use FileMerge (requires a graphical session)
5140 </p>
5141 </dd>
5142 <dt class="hdlist1">
5143 <code>p4merge</code>
5144 </dt>
5145 <dd>
5146 <p>
5147 Use HelixCore P4Merge (requires a graphical session)
5148 </p>
5149 </dd>
5150 <dt class="hdlist1">
5151 <code>smerge</code>
5152 </dt>
5153 <dd>
5154 <p>
5155 Use Sublime Merge (requires a graphical session)
5156 </p>
5157 </dd>
5158 <dt class="hdlist1">
5159 <code>tkdiff</code>
5160 </dt>
5161 <dd>
5162 <p>
5163 Use TkDiff (requires a graphical session)
5164 </p>
5165 </dd>
5166 <dt class="hdlist1">
5167 <code>vimdiff</code>
5168 </dt>
5169 <dd>
5170 <p>
5171 Use Vim
5172 </p>
5173 </dd>
5174 <dt class="hdlist1">
5175 <code>winmerge</code>
5176 </dt>
5177 <dd>
5178 <p>
5179 Use WinMerge (requires a graphical session)
5180 </p>
5181 </dd>
5182 <dt class="hdlist1">
5183 <code>xxdiff</code>
5184 </dt>
5185 <dd>
5186 <p>
5187 Use xxdiff (requires a graphical session)
5188 </p>
5189 </dd>
5190 </dl></div>
5191 </dd>
5192 <dt class="hdlist1">
5193 diff.indentHeuristic
5194 </dt>
5195 <dd>
5196 <p>
5197         Set this option to <code>false</code> to disable the default heuristics
5198         that shift diff hunk boundaries to make patches easier to read.
5199 </p>
5200 </dd>
5201 <dt class="hdlist1">
5202 diff.algorithm
5203 </dt>
5204 <dd>
5205 <p>
5206         Choose a diff algorithm.  The variants are as follows:
5207 </p>
5208 <div class="openblock">
5209 <div class="content">
5210 <div class="dlist"><dl>
5211 <dt class="hdlist1">
5212 <code>default</code>, <code>myers</code>
5213 </dt>
5214 <dd>
5215 <p>
5216         The basic greedy diff algorithm. Currently, this is the default.
5217 </p>
5218 </dd>
5219 <dt class="hdlist1">
5220 <code>minimal</code>
5221 </dt>
5222 <dd>
5223 <p>
5224         Spend extra time to make sure the smallest possible diff is
5225         produced.
5226 </p>
5227 </dd>
5228 <dt class="hdlist1">
5229 <code>patience</code>
5230 </dt>
5231 <dd>
5232 <p>
5233         Use "patience diff" algorithm when generating patches.
5234 </p>
5235 </dd>
5236 <dt class="hdlist1">
5237 <code>histogram</code>
5238 </dt>
5239 <dd>
5240 <p>
5241         This algorithm extends the patience algorithm to "support
5242         low-occurrence common elements".
5243 </p>
5244 </dd>
5245 </dl></div>
5246 </div></div>
5247 </dd>
5248 <dt class="hdlist1">
5249 diff.wsErrorHighlight
5250 </dt>
5251 <dd>
5252 <p>
5253         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5254         lines of the diff.  Multiple values are separated by comma,
5255         <code>none</code> resets previous values, <code>default</code> reset the list to
5256         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
5257         whitespace errors are colored with <code>color.diff.whitespace</code>.
5258         The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
5259         overrides this setting.
5260 </p>
5261 </dd>
5262 <dt class="hdlist1">
5263 diff.colorMoved
5264 </dt>
5265 <dd>
5266 <p>
5267         If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
5268         in a diff are colored differently, for details of valid modes
5269         see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
5270         true the default color mode will be used. When set to false,
5271         moved lines are not colored.
5272 </p>
5273 </dd>
5274 <dt class="hdlist1">
5275 diff.colorMovedWS
5276 </dt>
5277 <dd>
5278 <p>
5279         When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5280         this option controls the <code>&lt;mode&gt;</code> how spaces are treated
5281         for details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.
5282 </p>
5283 </dd>
5284 <dt class="hdlist1">
5285 diff.tool
5286 </dt>
5287 <dd>
5288 <p>
5289         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
5290         This variable overrides the value configured in <code>merge.tool</code>.
5291         The list below shows the valid built-in values.
5292         Any other value is treated as a custom diff tool and requires
5293         that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
5294 </p>
5295 </dd>
5296 <dt class="hdlist1">
5297 diff.guitool
5298 </dt>
5299 <dd>
5300 <p>
5301         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
5302         the -g/--gui flag is specified. This variable overrides the value
5303         configured in <code>merge.guitool</code>. The list below shows the valid
5304         built-in values. Any other value is treated as a custom diff tool
5305         and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
5306         is defined.
5307 </p>
5308 </dd>
5309 <dt class="hdlist1">
5310 difftool.&lt;tool&gt;.cmd
5311 </dt>
5312 <dd>
5313 <p>
5314         Specify the command to invoke the specified diff tool.
5315         The specified command is evaluated in shell with the following
5316         variables available:  <em>LOCAL</em> is set to the name of the temporary
5317         file containing the contents of the diff pre-image and <em>REMOTE</em>
5318         is set to the name of the temporary file containing the contents
5319         of the diff post-image.
5320 </p>
5321 <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>
5322 </dd>
5323 <dt class="hdlist1">
5324 difftool.&lt;tool&gt;.path
5325 </dt>
5326 <dd>
5327 <p>
5328         Override the path for the given tool.  This is useful in case
5329         your tool is not in the PATH.
5330 </p>
5331 </dd>
5332 <dt class="hdlist1">
5333 difftool.trustExitCode
5334 </dt>
5335 <dd>
5336 <p>
5337         Exit difftool if the invoked diff tool returns a non-zero exit status.
5338 </p>
5339 <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>
5340 </dd>
5341 <dt class="hdlist1">
5342 difftool.prompt
5343 </dt>
5344 <dd>
5345 <p>
5346         Prompt before each invocation of the diff tool.
5347 </p>
5348 </dd>
5349 <dt class="hdlist1">
5350 difftool.guiDefault
5351 </dt>
5352 <dd>
5353 <p>
5354         Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5355         the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5356         depending on the presence of a <code>DISPLAY</code> environment variable value. The
5357         default is <code>false</code>, where the <code>--gui</code> argument must be provided
5358         explicitly for the <code>diff.guitool</code> to be used.
5359 </p>
5360 </dd>
5361 <dt class="hdlist1">
5362 extensions.objectFormat
5363 </dt>
5364 <dd>
5365 <p>
5366         Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
5367         <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
5368         this key unless <code>core.repositoryFormatVersion</code> is 1.
5369 </p>
5370 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5371 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
5372 work and will produce hard-to-diagnose issues.</p></div>
5373 </dd>
5374 <dt class="hdlist1">
5375 extensions.worktreeConfig
5376 </dt>
5377 <dd>
5378 <p>
5379         If enabled, then worktrees will load config settings from the
5380         <code>$GIT_DIR/config.worktree</code> file in addition to the
5381         <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5382         <code>$GIT_DIR</code> are the same for the main working tree, while other
5383         working trees have <code>$GIT_DIR</code> equal to
5384         <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
5385         <code>config.worktree</code> file will override settings from any other
5386         config files.
5387 </p>
5388 <div class="paragraph"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5389 certain values from the common config file to the main working tree&#8217;s
5390 <code>config.worktree</code> file, if present:</p></div>
5391 <div class="ulist"><ul>
5392 <li>
5393 <p>
5394 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5395   <code>$GIT_COMMON_DIR/config.worktree</code>.
5396 </p>
5397 </li>
5398 <li>
5399 <p>
5400 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5401   to <code>$GIT_COMMON_DIR/config.worktree</code>.
5402 </p>
5403 <div class="paragraph"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5404 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5405 sparse-checkout settings for each worktree. By default, the <code>git
5406 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5407 these config values on a per-worktree basis, and uses the
5408 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5409 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
5410 details.</p></div>
5411 <div class="paragraph"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5412 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5413 </li>
5414 </ul></div>
5415 </dd>
5416 <dt class="hdlist1">
5417 fastimport.unpackLimit
5418 </dt>
5419 <dd>
5420 <p>
5421         If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
5422         is below this limit, then the objects will be unpacked into
5423         loose object files.  However if the number of imported objects
5424         equals or exceeds this limit then the pack will be stored as a
5425         pack.  Storing the pack from a fast-import can make the import
5426         operation complete faster, especially on slow filesystems.  If
5427         not set, the value of <code>transfer.unpackLimit</code> is used instead.
5428 </p>
5429 </dd>
5430 <dt class="hdlist1">
5431 feature.*
5432 </dt>
5433 <dd>
5434 <p>
5435         The config settings that start with <code>feature.</code> modify the defaults of
5436         a group of other config settings. These groups are created by the Git
5437         developer community as recommended defaults and are subject to change.
5438         In particular, new config options may be added with different defaults.
5439 </p>
5440 </dd>
5441 <dt class="hdlist1">
5442 feature.experimental
5443 </dt>
5444 <dd>
5445 <p>
5446         Enable config options that are new to Git, and are being considered for
5447         future defaults. Config settings included here may be added or removed
5448         with each release, including minor version updates. These settings may
5449         have unintended interactions since they are so new. Please enable this
5450         setting if you are interested in providing feedback on experimental
5451         features. The new default values are:
5452 </p>
5453 <div class="ulist"><ul>
5454 <li>
5455 <p>
5456 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5457 skipping more commits at a time, reducing the number of round trips.
5458 </p>
5459 </li>
5460 <li>
5461 <p>
5462 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5463 walking fewer objects.
5464 </p>
5465 </li>
5466 </ul></div>
5467 </dd>
5468 <dt class="hdlist1">
5469 feature.manyFiles
5470 </dt>
5471 <dd>
5472 <p>
5473         Enable config options that optimize for repos with many files in the
5474         working directory. With many files, commands such as <code>git status</code> and
5475         <code>git checkout</code> may be slow and these new defaults improve performance:
5476 </p>
5477 <div class="ulist"><ul>
5478 <li>
5479 <p>
5480 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5481   checksum. Note that this will cause Git versions earlier than 2.13.0 to
5482   refuse to parse the index and Git versions earlier than 2.40.0 will report
5483   a corrupted index during <code>git fsck</code>.
5484 </p>
5485 </li>
5486 <li>
5487 <p>
5488 <code>index.version=4</code> enables path-prefix compression in the index.
5489 </p>
5490 </li>
5491 <li>
5492 <p>
5493 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5494 that mtime is working on your machine.
5495 </p>
5496 </li>
5497 </ul></div>
5498 </dd>
5499 <dt class="hdlist1">
5500 fetch.recurseSubmodules
5501 </dt>
5502 <dd>
5503 <p>
5504         This option controls whether <code>git fetch</code> (and the underlying fetch
5505         in <code>git pull</code>) will recursively fetch into populated submodules.
5506         This option can be set either to a boolean value or to <em>on-demand</em>.
5507         Setting it to a boolean changes the behavior of fetch and pull to
5508         recurse unconditionally into submodules when set to true or to not
5509         recurse at all when set to false. When set to <em>on-demand</em>, fetch and
5510         pull will only recurse into a populated submodule when its
5511         superproject retrieves a commit that updates the submodule&#8217;s
5512         reference.
5513         Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
5514 </p>
5515 </dd>
5516 <dt class="hdlist1">
5517 fetch.fsckObjects
5518 </dt>
5519 <dd>
5520 <p>
5521         If it is set to true, git-fetch-pack will check all fetched
5522         objects. See <code>transfer.fsckObjects</code> for what&#8217;s
5523         checked. Defaults to false. If not set, the value of
5524         <code>transfer.fsckObjects</code> is used instead.
5525 </p>
5526 </dd>
5527 <dt class="hdlist1">
5528 fetch.fsck.&lt;msg-id&gt;
5529 </dt>
5530 <dd>
5531 <p>
5532         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
5533         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5534         the <code>fsck.&lt;msg-id&gt;</code> documentation for details.
5535 </p>
5536 </dd>
5537 <dt class="hdlist1">
5538 fetch.fsck.skipList
5539 </dt>
5540 <dd>
5541 <p>
5542         Acts like <code>fsck.skipList</code>, but is used by
5543         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5544         the <code>fsck.skipList</code> documentation for details.
5545 </p>
5546 </dd>
5547 <dt class="hdlist1">
5548 fetch.unpackLimit
5549 </dt>
5550 <dd>
5551 <p>
5552         If the number of objects fetched over the Git native
5553         transfer is below this
5554         limit, then the objects will be unpacked into loose object
5555         files. However if the number of received objects equals or
5556         exceeds this limit then the received pack will be stored as
5557         a pack, after adding any missing delta bases.  Storing the
5558         pack from a push can make the push operation complete faster,
5559         especially on slow filesystems.  If not set, the value of
5560         <code>transfer.unpackLimit</code> is used instead.
5561 </p>
5562 </dd>
5563 <dt class="hdlist1">
5564 fetch.prune
5565 </dt>
5566 <dd>
5567 <p>
5568         If true, fetch will automatically behave as if the <code>--prune</code>
5569         option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
5570         and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.
5571 </p>
5572 </dd>
5573 <dt class="hdlist1">
5574 fetch.pruneTags
5575 </dt>
5576 <dd>
5577 <p>
5578         If true, fetch will automatically behave as if the
5579         <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
5580         if not set already. This allows for setting both this option
5581         and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
5582         refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
5583         section of <a href="git-fetch.html">git-fetch(1)</a>.
5584 </p>
5585 </dd>
5586 <dt class="hdlist1">
5587 fetch.output
5588 </dt>
5589 <dd>
5590 <p>
5591         Control how ref update status is printed. Valid values are
5592         <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See section
5593         OUTPUT in <a href="git-fetch.html">git-fetch(1)</a> for detail.
5594 </p>
5595 </dd>
5596 <dt class="hdlist1">
5597 fetch.negotiationAlgorithm
5598 </dt>
5599 <dd>
5600 <p>
5601         Control how information about the commits in the local repository
5602         is sent when negotiating the contents of the packfile to be sent by
5603         the server.  Set to "consecutive" to use an algorithm that walks
5604         over consecutive commits checking each one.  Set to "skipping" to
5605         use an algorithm that skips commits in an effort to converge
5606         faster, but may result in a larger-than-necessary packfile; or set
5607         to "noop" to not send any information at all, which will almost
5608         certainly result in a larger-than-necessary packfile, but will skip
5609         the negotiation step.  Set to "default" to override settings made
5610         previously and use the default behaviour.  The default is normally
5611         "consecutive", but if <code>feature.experimental</code> is true, then the
5612         default is "skipping".  Unknown values will cause <em>git fetch</em> to
5613         error out.
5614 </p>
5615 <div class="paragraph"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
5616 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
5617 </dd>
5618 <dt class="hdlist1">
5619 fetch.showForcedUpdates
5620 </dt>
5621 <dd>
5622 <p>
5623         Set to false to enable <code>--no-show-forced-updates</code> in
5624         <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
5625         Defaults to true.
5626 </p>
5627 </dd>
5628 <dt class="hdlist1">
5629 fetch.parallel
5630 </dt>
5631 <dd>
5632 <p>
5633         Specifies the maximal number of fetch operations to be run in parallel
5634         at a time (submodules, or remotes when the <code>--multiple</code> option of
5635         <a href="git-fetch.html">git-fetch(1)</a> is in effect).
5636 </p>
5637 <div class="paragraph"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
5638 <div class="paragraph"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
5639 config setting.</p></div>
5640 </dd>
5641 <dt class="hdlist1">
5642 fetch.writeCommitGraph
5643 </dt>
5644 <dd>
5645 <p>
5646         Set to true to write a commit-graph after every <code>git fetch</code> command
5647         that downloads a pack-file from a remote. Using the <code>--split</code> option,
5648         most executions will create a very small commit-graph file on top of
5649         the existing commit-graph file(s). Occasionally, these files will
5650         merge and the write may take longer. Having an updated commit-graph
5651         file helps performance of many Git commands, including <code>git merge-base</code>,
5652         <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
5653 </p>
5654 </dd>
5655 <dt class="hdlist1">
5656 fetch.bundleURI
5657 </dt>
5658 <dd>
5659 <p>
5660         This value stores a URI for downloading Git object data from a bundle
5661         URI before performing an incremental fetch from the origin Git server.
5662         This is similar to how the <code>--bundle-uri</code> option behaves in
5663         <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
5664         <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
5665         list that is organized for incremental fetches.
5666 </p>
5667 <div class="paragraph"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
5668 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
5669 the new bundle URI.</p></div>
5670 </dd>
5671 <dt class="hdlist1">
5672 fetch.bundleCreationToken
5673 </dt>
5674 <dd>
5675 <p>
5676         When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
5677         list that uses the "creationToken" heuristic, this config value
5678         stores the maximum <code>creationToken</code> value of the downloaded bundles.
5679         This value is used to prevent downloading bundles in the future
5680         if the advertised <code>creationToken</code> is not strictly larger than this
5681         value.
5682 </p>
5683 <div class="paragraph"><p>The creation token values are chosen by the provider serving the specific
5684 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
5685 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
5686 </dd>
5687 <dt class="hdlist1">
5688 format.attach
5689 </dt>
5690 <dd>
5691 <p>
5692         Enable multipart/mixed attachments as the default for
5693         <em>format-patch</em>.  The value can also be a double quoted string
5694         which will enable attachments as the default and set the
5695         value as the boundary.  See the --attach option in
5696         <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
5697         value, set it to an empty string.
5698 </p>
5699 </dd>
5700 <dt class="hdlist1">
5701 format.from
5702 </dt>
5703 <dd>
5704 <p>
5705         Provides the default value for the <code>--from</code> option to format-patch.
5706         Accepts a boolean value, or a name and email address.  If false,
5707         format-patch defaults to <code>--no-from</code>, using commit authors directly in
5708         the "From:" field of patch mails.  If true, format-patch defaults to
5709         <code>--from</code>, using your committer identity in the "From:" field of patch
5710         mails and including a "From:" field in the body of the patch mail if
5711         different.  If set to a non-boolean value, format-patch uses that
5712         value instead of your committer identity.  Defaults to false.
5713 </p>
5714 </dd>
5715 <dt class="hdlist1">
5716 format.forceInBodyFrom
5717 </dt>
5718 <dd>
5719 <p>
5720         Provides the default value for the <code>--[no-]force-in-body-from</code>
5721         option to format-patch.  Defaults to false.
5722 </p>
5723 </dd>
5724 <dt class="hdlist1">
5725 format.numbered
5726 </dt>
5727 <dd>
5728 <p>
5729         A boolean which can enable or disable sequence numbers in patch
5730         subjects.  It defaults to "auto" which enables it only if there
5731         is more than one patch.  It can be enabled or disabled for all
5732         messages by setting it to "true" or "false".  See --numbered
5733         option in <a href="git-format-patch.html">git-format-patch(1)</a>.
5734 </p>
5735 </dd>
5736 <dt class="hdlist1">
5737 format.headers
5738 </dt>
5739 <dd>
5740 <p>
5741         Additional email headers to include in a patch to be submitted
5742         by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.
5743 </p>
5744 </dd>
5745 <dt class="hdlist1">
5746 format.to
5747 </dt>
5748 <dt class="hdlist1">
5749 format.cc
5750 </dt>
5751 <dd>
5752 <p>
5753         Additional recipients to include in a patch to be submitted
5754         by mail.  See the --to and --cc options in
5755         <a href="git-format-patch.html">git-format-patch(1)</a>.
5756 </p>
5757 </dd>
5758 <dt class="hdlist1">
5759 format.subjectPrefix
5760 </dt>
5761 <dd>
5762 <p>
5763         The default for format-patch is to output files with the <em>[PATCH]</em>
5764         subject prefix. Use this variable to change that prefix.
5765 </p>
5766 </dd>
5767 <dt class="hdlist1">
5768 format.coverFromDescription
5769 </dt>
5770 <dd>
5771 <p>
5772         The default mode for format-patch to determine which parts of
5773         the cover letter will be populated using the branch&#8217;s
5774         description. See the <code>--cover-from-description</code> option in
5775         <a href="git-format-patch.html">git-format-patch(1)</a>.
5776 </p>
5777 </dd>
5778 <dt class="hdlist1">
5779 format.signature
5780 </dt>
5781 <dd>
5782 <p>
5783         The default for format-patch is to output a signature containing
5784         the Git version number. Use this variable to change that default.
5785         Set this variable to the empty string ("") to suppress
5786         signature generation.
5787 </p>
5788 </dd>
5789 <dt class="hdlist1">
5790 format.signatureFile
5791 </dt>
5792 <dd>
5793 <p>
5794         Works just like format.signature except the contents of the
5795         file specified by this variable will be used as the signature.
5796 </p>
5797 </dd>
5798 <dt class="hdlist1">
5799 format.suffix
5800 </dt>
5801 <dd>
5802 <p>
5803         The default for format-patch is to output files with the suffix
5804         <code>.patch</code>. Use this variable to change that suffix (make sure to
5805         include the dot if you want it).
5806 </p>
5807 </dd>
5808 <dt class="hdlist1">
5809 format.encodeEmailHeaders
5810 </dt>
5811 <dd>
5812 <p>
5813         Encode email headers that have non-ASCII characters with
5814         "Q-encoding" (described in RFC 2047) for email transmission.
5815         Defaults to true.
5816 </p>
5817 </dd>
5818 <dt class="hdlist1">
5819 format.pretty
5820 </dt>
5821 <dd>
5822 <p>
5823         The default pretty format for log/show/whatchanged command,
5824         See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
5825         <a href="git-whatchanged.html">git-whatchanged(1)</a>.
5826 </p>
5827 </dd>
5828 <dt class="hdlist1">
5829 format.thread
5830 </dt>
5831 <dd>
5832 <p>
5833         The default threading style for <em>git format-patch</em>.  Can be
5834         a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
5835         makes every mail a reply to the head of the series,
5836         where the head is chosen from the cover letter, the
5837         <code>--in-reply-to</code>, and the first patch mail, in this order.
5838         <code>deep</code> threading makes every mail a reply to the previous one.
5839         A true boolean value is the same as <code>shallow</code>, and a false
5840         value disables threading.
5841 </p>
5842 </dd>
5843 <dt class="hdlist1">
5844 format.signOff
5845 </dt>
5846 <dd>
5847 <p>
5848         A boolean value which lets you enable the <code>-s/--signoff</code> option of
5849         format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
5850         patch should be a conscious act and means that you certify you have
5851         the rights to submit this work under the same open source license.
5852         Please see the <em>SubmittingPatches</em> document for further discussion.
5853 </p>
5854 </dd>
5855 <dt class="hdlist1">
5856 format.coverLetter
5857 </dt>
5858 <dd>
5859 <p>
5860         A boolean that controls whether to generate a cover-letter when
5861         format-patch is invoked, but in addition can be set to "auto", to
5862         generate a cover-letter only when there&#8217;s more than one patch.
5863         Default is false.
5864 </p>
5865 </dd>
5866 <dt class="hdlist1">
5867 format.outputDirectory
5868 </dt>
5869 <dd>
5870 <p>
5871         Set a custom directory to store the resulting files instead of the
5872         current working directory. All directory components will be created.
5873 </p>
5874 </dd>
5875 <dt class="hdlist1">
5876 format.filenameMaxLength
5877 </dt>
5878 <dd>
5879 <p>
5880         The maximum length of the output filenames generated by the
5881         <code>format-patch</code> command; defaults to 64.  Can be overridden
5882         by the <code>--filename-max-length=&lt;n&gt;</code> command line option.
5883 </p>
5884 </dd>
5885 <dt class="hdlist1">
5886 format.useAutoBase
5887 </dt>
5888 <dd>
5889 <p>
5890         A boolean value which lets you enable the <code>--base=auto</code> option of
5891         format-patch by default. Can also be set to "whenAble" to allow
5892         enabling <code>--base=auto</code> if a suitable base is available, but to skip
5893         adding base info otherwise without the format dying.
5894 </p>
5895 </dd>
5896 <dt class="hdlist1">
5897 format.notes
5898 </dt>
5899 <dd>
5900 <p>
5901         Provides the default value for the <code>--notes</code> option to
5902         format-patch. Accepts a boolean value, or a ref which specifies
5903         where to get notes. If false, format-patch defaults to
5904         <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
5905         set to a non-boolean value, format-patch defaults to
5906         <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
5907         to false.
5908 </p>
5909 <div class="paragraph"><p>If one wishes to use the ref <code>ref/notes/true</code>, please use that literal
5910 instead.</p></div>
5911 <div class="paragraph"><p>This configuration can be specified multiple times in order to allow
5912 multiple notes refs to be included. In that case, it will behave
5913 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
5914 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
5915 also show notes from that notes ref and a value of <code>false</code> will negate
5916 previous configurations and not show notes.</p></div>
5917 <div class="paragraph"><p>For example,</p></div>
5918 <div class="listingblock">
5919 <div class="content">
5920 <pre><code>[format]
5921         notes = true
5922         notes = foo
5923         notes = false
5924         notes = bar</code></pre>
5925 </div></div>
5926 <div class="paragraph"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
5927 </dd>
5928 <dt class="hdlist1">
5929 format.mboxrd
5930 </dt>
5931 <dd>
5932 <p>
5933         A boolean value which enables the robust "mboxrd" format when
5934         <code>--stdout</code> is in use to escape "^&gt;+From " lines.
5935 </p>
5936 </dd>
5937 <dt class="hdlist1">
5938 format.noprefix
5939 </dt>
5940 <dd>
5941 <p>
5942         If set, do not show any source or destination prefix in patches.
5943         This is equivalent to the <code>diff.noprefix</code> option used by <code>git
5944         diff</code> (but which is not respected by <code>format-patch</code>). Note that
5945         by setting this, the receiver of any patches you generate will
5946         have to apply them using the <code>-p0</code> option.
5947 </p>
5948 </dd>
5949 <dt class="hdlist1">
5950 filter.&lt;driver&gt;.clean
5951 </dt>
5952 <dd>
5953 <p>
5954         The command which is used to convert the content of a worktree
5955         file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
5956         details.
5957 </p>
5958 </dd>
5959 <dt class="hdlist1">
5960 filter.&lt;driver&gt;.smudge
5961 </dt>
5962 <dd>
5963 <p>
5964         The command which is used to convert the content of a blob
5965         object to a worktree file upon checkout.  See
5966         <a href="gitattributes.html">gitattributes(5)</a> for details.
5967 </p>
5968 </dd>
5969 <dt class="hdlist1">
5970 fsck.&lt;msg-id&gt;
5971 </dt>
5972 <dd>
5973 <p>
5974         During fsck git may find issues with legacy data which
5975         wouldn&#8217;t be generated by current versions of git, and which
5976         wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
5977         set. This feature is intended to support working with legacy
5978         repositories containing such data.
5979 </p>
5980 <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
5981 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
5982 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
5983 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
5984 same applies for the corresponding <code>receive.fsck.*</code> and
5985 <code>fetch.&lt;msg-id&gt;.*</code>. variables.</p></div>
5986 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
5987 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
5988 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
5989 uniformly configure the same fsck settings in different circumstances
5990 all three of them they must all set to the same values.</p></div>
5991 <div class="paragraph"><p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
5992 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
5993 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
5994 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
5995 with the message ID, e.g. "missingEmail: invalid author/committer
5996 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
5997 will hide that issue.</p></div>
5998 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
5999 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6000 problematic objects share to be ignored, as doing the latter will
6001 allow new instances of the same breakages go unnoticed.</p></div>
6002 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
6003 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
6004 will only cause git to warn.</p></div>
6005 <div class="paragraph"><p>See <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
6006 values of <code>&lt;msg-id&gt;</code>.</p></div>
6007 </dd>
6008 <dt class="hdlist1">
6009 fsck.skipList
6010 </dt>
6011 <dd>
6012 <p>
6013         The path to a list of object names (i.e. one unabbreviated SHA-1 per
6014         line) that are known to be broken in a non-fatal way and should
6015         be ignored. On versions of Git 2.20 and later comments (<em>#</em>), empty
6016         lines, and any leading and trailing whitespace is ignored. Everything
6017         but a SHA-1 per line will error out on older versions.
6018 </p>
6019 <div class="paragraph"><p>This feature is useful when an established project should be accepted
6020 despite early commits containing errors that can be safely ignored
6021 such as invalid committer email addresses.  Note: corrupt objects
6022 cannot be skipped with this setting.</p></div>
6023 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
6024 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6025 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6026 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6027 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
6028 uniformly configure the same fsck settings in different circumstances
6029 all three of them they must all set to the same values.</p></div>
6030 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
6031 list should be sorted. This was never a requirement, the object names
6032 could appear in any order, but when reading the list we tracked whether
6033 the list was sorted for the purposes of an internal binary search
6034 implementation, which could save itself some work with an already sorted
6035 list. Unless you had a humongous list there was no reason to go out of
6036 your way to pre-sort the list. After Git version 2.20 a hash implementation
6037 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
6038 </dd>
6039 <dt class="hdlist1">
6040 fsmonitor.allowRemote
6041 </dt>
6042 <dd>
6043 <p>
6044     By default, the fsmonitor daemon refuses to work against network-mounted
6045     repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6046     behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6047 </p>
6048 </dd>
6049 <dt class="hdlist1">
6050 fsmonitor.socketDir
6051 </dt>
6052 <dd>
6053 <p>
6054     This Mac OS-specific option, if set, specifies the directory in
6055     which to create the Unix domain socket used for communication
6056     between the fsmonitor daemon and various Git commands. The directory must
6057     reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
6058     is set to <code>true</code>.
6059 </p>
6060 </dd>
6061 <dt class="hdlist1">
6062 gc.aggressiveDepth
6063 </dt>
6064 <dd>
6065 <p>
6066         The depth parameter used in the delta compression
6067         algorithm used by <em>git gc --aggressive</em>.  This defaults
6068         to 50, which is the default for the <code>--depth</code> option when
6069         <code>--aggressive</code> isn&#8217;t in use.
6070 </p>
6071 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
6072 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6073 </dd>
6074 <dt class="hdlist1">
6075 gc.aggressiveWindow
6076 </dt>
6077 <dd>
6078 <p>
6079         The window size parameter used in the delta compression
6080         algorithm used by <em>git gc --aggressive</em>.  This defaults
6081         to 250, which is a much more aggressive window size than
6082         the default <code>--window</code> of 10.
6083 </p>
6084 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
6085 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6086 </dd>
6087 <dt class="hdlist1">
6088 gc.auto
6089 </dt>
6090 <dd>
6091 <p>
6092         When there are approximately more than this many loose
6093         objects in the repository, <code>git gc --auto</code> will pack them.
6094         Some Porcelain commands use this command to perform a
6095         light-weight garbage collection from time to time.  The
6096         default value is 6700.
6097 </p>
6098 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
6099 number of loose objects, but any other heuristic <code>git gc --auto</code> will
6100 otherwise use to determine if there&#8217;s work to do, such as
6101 <code>gc.autoPackLimit</code>.</p></div>
6102 </dd>
6103 <dt class="hdlist1">
6104 gc.autoPackLimit
6105 </dt>
6106 <dd>
6107 <p>
6108         When there are more than this many packs that are not
6109         marked with <code>*.keep</code> file in the repository, <code>git gc
6110         --auto</code> consolidates them into one larger pack.  The
6111         default value is 50.  Setting this to 0 disables it.
6112         Setting <code>gc.auto</code> to 0 will also disable this.
6113 </p>
6114 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6115 use, it&#8217;ll affect how the auto pack limit works.</p></div>
6116 </dd>
6117 <dt class="hdlist1">
6118 gc.autoDetach
6119 </dt>
6120 <dd>
6121 <p>
6122         Make <code>git gc --auto</code> return immediately and run in background
6123         if the system supports it. Default is true.
6124 </p>
6125 </dd>
6126 <dt class="hdlist1">
6127 gc.bigPackThreshold
6128 </dt>
6129 <dd>
6130 <p>
6131         If non-zero, all non-cruft packs larger than this limit are kept
6132         when <code>git gc</code> is run. This is very similar to
6133         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6134         the threshold are kept, not just the largest pack. Defaults to
6135         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6136 </p>
6137 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6138 this configuration variable is ignored, all packs except the base pack
6139 will be repacked. After this the number of packs should go below
6140 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6141 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6142 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6143 will also be excluded (this is the equivalent of running <code>git gc</code> with
6144 <code>--keep-largest-pack</code>).</p></div>
6145 </dd>
6146 <dt class="hdlist1">
6147 gc.writeCommitGraph
6148 </dt>
6149 <dd>
6150 <p>
6151         If true, then gc will rewrite the commit-graph file when
6152         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6153         the commit-graph will be updated if housekeeping is
6154         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
6155         for details.
6156 </p>
6157 </dd>
6158 <dt class="hdlist1">
6159 gc.logExpiry
6160 </dt>
6161 <dd>
6162 <p>
6163         If the file gc.log exists, then <code>git gc --auto</code> will print
6164         its content and exit with status zero instead of running
6165         unless that file is more than <em>gc.logExpiry</em> old.  Default is
6166         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
6167         value.
6168 </p>
6169 </dd>
6170 <dt class="hdlist1">
6171 gc.packRefs
6172 </dt>
6173 <dd>
6174 <p>
6175         Running <code>git pack-refs</code> in a repository renders it
6176         unclonable by Git versions prior to 1.5.1.2 over dumb
6177         transports such as HTTP.  This variable determines whether
6178         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6179         to enable it within all non-bare repos or it can be set to a
6180         boolean value.  The default is <code>true</code>.
6181 </p>
6182 </dd>
6183 <dt class="hdlist1">
6184 gc.cruftPacks
6185 </dt>
6186 <dd>
6187 <p>
6188         Store unreachable objects in a cruft pack (see
6189         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
6190         is <code>true</code>.
6191 </p>
6192 </dd>
6193 <dt class="hdlist1">
6194 gc.pruneExpire
6195 </dt>
6196 <dd>
6197 <p>
6198         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6199         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6200         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
6201         grace period with this config variable.  The value "now" may be
6202         used to disable this grace period and always prune unreachable
6203         objects immediately, or "never" may be used to suppress pruning.
6204         This feature helps prevent corruption when <em>git gc</em> runs
6205         concurrently with another process writing to the repository; see
6206         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
6207 </p>
6208 </dd>
6209 <dt class="hdlist1">
6210 gc.worktreePruneExpire
6211 </dt>
6212 <dd>
6213 <p>
6214         When <em>git gc</em> is run, it calls
6215         <em>git worktree prune --expire 3.months.ago</em>.
6216         This config variable can be used to set a different grace
6217         period. The value "now" may be used to disable the grace
6218         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
6219         may be used to suppress pruning.
6220 </p>
6221 </dd>
6222 <dt class="hdlist1">
6223 gc.reflogExpire
6224 </dt>
6225 <dt class="hdlist1">
6226 gc.&lt;pattern&gt;.reflogExpire
6227 </dt>
6228 <dd>
6229 <p>
6230         <em>git reflog expire</em> removes reflog entries older than
6231         this time; defaults to 90 days. The value "now" expires all
6232         entries immediately, and "never" suppresses expiration
6233         altogether. With "&lt;pattern&gt;" (e.g.
6234         "refs/stash") in the middle the setting applies only to
6235         the refs that match the &lt;pattern&gt;.
6236 </p>
6237 </dd>
6238 <dt class="hdlist1">
6239 gc.reflogExpireUnreachable
6240 </dt>
6241 <dt class="hdlist1">
6242 gc.&lt;pattern&gt;.reflogExpireUnreachable
6243 </dt>
6244 <dd>
6245 <p>
6246         <em>git reflog expire</em> removes reflog entries older than
6247         this time and are not reachable from the current tip;
6248         defaults to 30 days. The value "now" expires all entries
6249         immediately, and "never" suppresses expiration altogether.
6250         With "&lt;pattern&gt;" (e.g. "refs/stash")
6251         in the middle, the setting applies only to the refs that
6252         match the &lt;pattern&gt;.
6253 </p>
6254 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
6255 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6256 or rebase occurring.  Since these changes are not part of the current
6257 project most users will want to expire them sooner, which is why the
6258 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6259 </dd>
6260 <dt class="hdlist1">
6261 gc.recentObjectsHook
6262 </dt>
6263 <dd>
6264 <p>
6265         When considering whether or not to remove an object (either when
6266         generating a cruft pack or storing unreachable objects as
6267         loose), use the shell to execute the specified command(s).
6268         Interpret their output as object IDs which Git will consider as
6269         "recent", regardless of their age. By treating their mtimes as
6270         "now", any objects (and their descendants) mentioned in the
6271         output will be kept regardless of their true age.
6272 </p>
6273 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
6274 else. Objects which cannot be found in the repository are ignored.
6275 Multiple hooks are supported, but all must exit successfully, else the
6276 operation (either generating a cruft pack or unpacking unreachable
6277 objects) will be halted.</p></div>
6278 </dd>
6279 <dt class="hdlist1">
6280 gc.rerereResolved
6281 </dt>
6282 <dd>
6283 <p>
6284         Records of conflicted merge you resolved earlier are
6285         kept for this many days when <em>git rerere gc</em> is run.
6286         You can also use more human-readable "1.month.ago", etc.
6287         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6288 </p>
6289 </dd>
6290 <dt class="hdlist1">
6291 gc.rerereUnresolved
6292 </dt>
6293 <dd>
6294 <p>
6295         Records of conflicted merge you have not resolved are
6296         kept for this many days when <em>git rerere gc</em> is run.
6297         You can also use more human-readable "1.month.ago", etc.
6298         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6299 </p>
6300 </dd>
6301 <dt class="hdlist1">
6302 gitcvs.commitMsgAnnotation
6303 </dt>
6304 <dd>
6305 <p>
6306         Append this string to each commit message. Set to empty string
6307         to disable this feature. Defaults to "via git-CVS emulator".
6308 </p>
6309 </dd>
6310 <dt class="hdlist1">
6311 gitcvs.enabled
6312 </dt>
6313 <dd>
6314 <p>
6315         Whether the CVS server interface is enabled for this repository.
6316         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6317 </p>
6318 </dd>
6319 <dt class="hdlist1">
6320 gitcvs.logFile
6321 </dt>
6322 <dd>
6323 <p>
6324         Path to a log file where the CVS server interface well&#8230; logs
6325         various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6326 </p>
6327 </dd>
6328 <dt class="hdlist1">
6329 gitcvs.usecrlfattr
6330 </dt>
6331 <dd>
6332 <p>
6333         If true, the server will look up the end-of-line conversion
6334         attributes for files to determine the <code>-k</code> modes to use. If
6335         the attributes force Git to treat a file as text,
6336         the <code>-k</code> mode will be left blank so CVS clients will
6337         treat it as text. If they suppress text conversion, the file
6338         will be set with <em>-kb</em> mode, which suppresses any newline munging
6339         the client might otherwise do. If the attributes do not allow
6340         the file type to be determined, then <code>gitcvs.allBinary</code> is
6341         used. See <a href="gitattributes.html">gitattributes(5)</a>.
6342 </p>
6343 </dd>
6344 <dt class="hdlist1">
6345 gitcvs.allBinary
6346 </dt>
6347 <dd>
6348 <p>
6349         This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6350         the correct <em>-kb</em> mode to use. If true, all
6351         unresolved files are sent to the client in
6352         mode <em>-kb</em>. This causes the client to treat them
6353         as binary files, which suppresses any newline munging it
6354         otherwise might do. Alternatively, if it is set to "guess",
6355         then the contents of the file are examined to decide if
6356         it is binary, similar to <code>core.autocrlf</code>.
6357 </p>
6358 </dd>
6359 <dt class="hdlist1">
6360 gitcvs.dbName
6361 </dt>
6362 <dd>
6363 <p>
6364         Database used by git-cvsserver to cache revision information
6365         derived from the Git repository. The exact meaning depends on the
6366         used database driver, for SQLite (which is the default driver) this
6367         is a filename. Supports variable substitution (see
6368         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6369         Default: <em>%Ggitcvs.%m.sqlite</em>
6370 </p>
6371 </dd>
6372 <dt class="hdlist1">
6373 gitcvs.dbDriver
6374 </dt>
6375 <dd>
6376 <p>
6377         Used Perl DBI driver. You can specify any available driver
6378         for this here, but it might not work. git-cvsserver is tested
6379         with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6380         reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6381         May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6382         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6383 </p>
6384 </dd>
6385 <dt class="hdlist1">
6386 gitcvs.dbUser, gitcvs.dbPass
6387 </dt>
6388 <dd>
6389 <p>
6390         Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6391         since SQLite has no concept of database users and/or passwords.
6392         <em>gitcvs.dbUser</em> supports variable substitution (see
6393         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
6394 </p>
6395 </dd>
6396 <dt class="hdlist1">
6397 gitcvs.dbTableNamePrefix
6398 </dt>
6399 <dd>
6400 <p>
6401         Database table name prefix.  Prepended to the names of any
6402         database tables used, allowing a single database to be used
6403         for several repositories.  Supports variable substitution (see
6404         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
6405         characters will be replaced with underscores.
6406 </p>
6407 </dd>
6408 </dl></div>
6409 <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6410 <code>gitcvs.allBinary</code> can also be specified as
6411 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
6412 is one of "ext" and "pserver") to make them apply only for the given
6413 access method.</p></div>
6414 <div class="dlist"><dl>
6415 <dt class="hdlist1">
6416 gitweb.category
6417 </dt>
6418 <dt class="hdlist1">
6419 gitweb.description
6420 </dt>
6421 <dt class="hdlist1">
6422 gitweb.owner
6423 </dt>
6424 <dt class="hdlist1">
6425 gitweb.url
6426 </dt>
6427 <dd>
6428 <p>
6429         See <a href="gitweb.html">gitweb(1)</a> for description.
6430 </p>
6431 </dd>
6432 <dt class="hdlist1">
6433 gitweb.avatar
6434 </dt>
6435 <dt class="hdlist1">
6436 gitweb.blame
6437 </dt>
6438 <dt class="hdlist1">
6439 gitweb.grep
6440 </dt>
6441 <dt class="hdlist1">
6442 gitweb.highlight
6443 </dt>
6444 <dt class="hdlist1">
6445 gitweb.patches
6446 </dt>
6447 <dt class="hdlist1">
6448 gitweb.pickaxe
6449 </dt>
6450 <dt class="hdlist1">
6451 gitweb.remote_heads
6452 </dt>
6453 <dt class="hdlist1">
6454 gitweb.showSizes
6455 </dt>
6456 <dt class="hdlist1">
6457 gitweb.snapshot
6458 </dt>
6459 <dd>
6460 <p>
6461         See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
6462 </p>
6463 </dd>
6464 <dt class="hdlist1">
6465 grep.lineNumber
6466 </dt>
6467 <dd>
6468 <p>
6469         If set to true, enable <code>-n</code> option by default.
6470 </p>
6471 </dd>
6472 <dt class="hdlist1">
6473 grep.column
6474 </dt>
6475 <dd>
6476 <p>
6477         If set to true, enable the <code>--column</code> option by default.
6478 </p>
6479 </dd>
6480 <dt class="hdlist1">
6481 grep.patternType
6482 </dt>
6483 <dd>
6484 <p>
6485         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
6486         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
6487         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
6488         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
6489         between <em>basic</em> and <em>extended</em>.
6490 </p>
6491 </dd>
6492 <dt class="hdlist1">
6493 grep.extendedRegexp
6494 </dt>
6495 <dd>
6496 <p>
6497         If set to true, enable <code>--extended-regexp</code> option by default. This
6498         option is ignored when the <code>grep.patternType</code> option is set to a value
6499         other than <em>default</em>.
6500 </p>
6501 </dd>
6502 <dt class="hdlist1">
6503 grep.threads
6504 </dt>
6505 <dd>
6506 <p>
6507         Number of grep worker threads to use. If unset (or set to 0), Git will
6508         use as many threads as the number of logical cores available.
6509 </p>
6510 </dd>
6511 <dt class="hdlist1">
6512 grep.fullName
6513 </dt>
6514 <dd>
6515 <p>
6516         If set to true, enable <code>--full-name</code> option by default.
6517 </p>
6518 </dd>
6519 <dt class="hdlist1">
6520 grep.fallbackToNoIndex
6521 </dt>
6522 <dd>
6523 <p>
6524         If set to true, fall back to git grep --no-index if git grep
6525         is executed outside of a git repository.  Defaults to false.
6526 </p>
6527 </dd>
6528 <dt class="hdlist1">
6529 gpg.program
6530 </dt>
6531 <dd>
6532 <p>
6533         Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
6534         making or verifying a PGP signature. The program must support the
6535         same command-line interface as GPG, namely, to verify a detached
6536         signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
6537         program is expected to signal a good signature by exiting with
6538         code 0, and to generate an ASCII-armored detached signature, the
6539         standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
6540         signed, and the program is expected to send the result to its
6541         standard output.
6542 </p>
6543 </dd>
6544 <dt class="hdlist1">
6545 gpg.format
6546 </dt>
6547 <dd>
6548 <p>
6549         Specifies which key format to use when signing with <code>--gpg-sign</code>.
6550         Default is "openpgp". Other possible values are "x509", "ssh".
6551 </p>
6552 <div class="paragraph"><p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
6553 based on the selected <code>gpg.format</code>.</p></div>
6554 </dd>
6555 <dt class="hdlist1">
6556 gpg.&lt;format&gt;.program
6557 </dt>
6558 <dd>
6559 <p>
6560         Use this to customize the program used for the signing format you
6561         chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
6562         be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
6563         value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".
6564 </p>
6565 </dd>
6566 <dt class="hdlist1">
6567 gpg.minTrustLevel
6568 </dt>
6569 <dd>
6570 <p>
6571         Specifies a minimum trust level for signature verification.  If
6572         this option is unset, then signature verification for merge
6573         operations require a key with at least <code>marginal</code> trust.  Other
6574         operations that perform signature verification require a key
6575         with at least <code>undefined</code> trust.  Setting this option overrides
6576         the required trust-level for all operations.  Supported values,
6577         in increasing order of significance:
6578 </p>
6579 <div class="ulist"><ul>
6580 <li>
6581 <p>
6582 <code>undefined</code>
6583 </p>
6584 </li>
6585 <li>
6586 <p>
6587 <code>never</code>
6588 </p>
6589 </li>
6590 <li>
6591 <p>
6592 <code>marginal</code>
6593 </p>
6594 </li>
6595 <li>
6596 <p>
6597 <code>fully</code>
6598 </p>
6599 </li>
6600 <li>
6601 <p>
6602 <code>ultimate</code>
6603 </p>
6604 </li>
6605 </ul></div>
6606 </dd>
6607 <dt class="hdlist1">
6608 gpg.ssh.defaultKeyCommand
6609 </dt>
6610 <dd>
6611 <p>
6612         This command that will be run when user.signingkey is not set and a ssh
6613         signature is requested. On successful exit a valid ssh public key
6614         prefixed with <code>key::</code> is expected in the first line of its output.
6615         This allows for a script doing a dynamic lookup of the correct public
6616         key when it is impractical to statically configure <code>user.signingKey</code>.
6617         For example when keys or SSH Certificates are rotated frequently or
6618         selection of the right key depends on external factors unknown to git.
6619 </p>
6620 </dd>
6621 <dt class="hdlist1">
6622 gpg.ssh.allowedSignersFile
6623 </dt>
6624 <dd>
6625 <p>
6626         A file containing ssh public keys which you are willing to trust.
6627         The file consists of one or more lines of principals followed by an ssh
6628         public key.
6629         e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
6630         See ssh-keygen(1) "ALLOWED SIGNERS" for details.
6631         The principal is only used to identify the key and is available when
6632         verifying a signature.
6633 </p>
6634 <div class="paragraph"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
6635 between valid signatures and trusted signatures the trust level of a signature
6636 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
6637 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
6638 <div class="paragraph"><p>This file can be set to a location outside of the repository and every developer
6639 maintains their own trust store. A central repository server could generate this
6640 file automatically from ssh keys with push access to verify the code against.
6641 In a corporate setting this file is probably generated at a global location
6642 from automation that already handles developer ssh keys.</p></div>
6643 <div class="paragraph"><p>A repository that only allows signed commits can store the file
6644 in the repository itself using a path relative to the top-level of the working tree.
6645 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
6646 <div class="paragraph"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
6647 valid-before options. Git will mark signatures as valid if the signing key was
6648 valid at the time of the signature&#8217;s creation. This allows users to change a
6649 signing key without invalidating all previously made signatures.</p></div>
6650 <div class="paragraph"><p>Using a SSH CA key with the cert-authority option
6651 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p></div>
6652 </dd>
6653 <dt class="hdlist1">
6654 gpg.ssh.revocationFile
6655 </dt>
6656 <dd>
6657 <p>
6658         Either a SSH KRL or a list of revoked public keys (without the principal prefix).
6659         See ssh-keygen(1) for details.
6660         If a public key is found in this file then it will always be treated
6661         as having trust level "never" and signatures will show as invalid.
6662 </p>
6663 </dd>
6664 <dt class="hdlist1">
6665 gui.commitMsgWidth
6666 </dt>
6667 <dd>
6668 <p>
6669         Defines how wide the commit message window is in the
6670         <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
6671 </p>
6672 </dd>
6673 <dt class="hdlist1">
6674 gui.diffContext
6675 </dt>
6676 <dd>
6677 <p>
6678         Specifies how many context lines should be used in calls to diff
6679         made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
6680 </p>
6681 </dd>
6682 <dt class="hdlist1">
6683 gui.displayUntracked
6684 </dt>
6685 <dd>
6686 <p>
6687         Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
6688         in the file list. The default is "true".
6689 </p>
6690 </dd>
6691 <dt class="hdlist1">
6692 gui.encoding
6693 </dt>
6694 <dd>
6695 <p>
6696         Specifies the default character encoding to use for displaying of
6697         file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
6698         It can be overridden by setting the <em>encoding</em> attribute
6699         for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
6700         If this option is not set, the tools default to the
6701         locale encoding.
6702 </p>
6703 </dd>
6704 <dt class="hdlist1">
6705 gui.matchTrackingBranch
6706 </dt>
6707 <dd>
6708 <p>
6709         Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
6710         default to tracking remote branches with matching names or
6711         not. Default: "false".
6712 </p>
6713 </dd>
6714 <dt class="hdlist1">
6715 gui.newBranchTemplate
6716 </dt>
6717 <dd>
6718 <p>
6719         Is used as suggested name when creating new branches using the
6720         <a href="git-gui.html">git-gui(1)</a>.
6721 </p>
6722 </dd>
6723 <dt class="hdlist1">
6724 gui.pruneDuringFetch
6725 </dt>
6726 <dd>
6727 <p>
6728         "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
6729         performing a fetch. The default value is "false".
6730 </p>
6731 </dd>
6732 <dt class="hdlist1">
6733 gui.trustmtime
6734 </dt>
6735 <dd>
6736 <p>
6737         Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
6738         timestamp or not. By default the timestamps are not trusted.
6739 </p>
6740 </dd>
6741 <dt class="hdlist1">
6742 gui.spellingDictionary
6743 </dt>
6744 <dd>
6745 <p>
6746         Specifies the dictionary used for spell checking commit messages in
6747         the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
6748         off.
6749 </p>
6750 </dd>
6751 <dt class="hdlist1">
6752 gui.fastCopyBlame
6753 </dt>
6754 <dd>
6755 <p>
6756         If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
6757         location detection. It makes blame significantly faster on huge
6758         repositories at the expense of less thorough copy detection.
6759 </p>
6760 </dd>
6761 <dt class="hdlist1">
6762 gui.copyBlameThreshold
6763 </dt>
6764 <dd>
6765 <p>
6766         Specifies the threshold to use in <em>git gui blame</em> original location
6767         detection, measured in alphanumeric characters. See the
6768         <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
6769 </p>
6770 </dd>
6771 <dt class="hdlist1">
6772 gui.blamehistoryctx
6773 </dt>
6774 <dd>
6775 <p>
6776         Specifies the radius of history context in days to show in
6777         <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
6778         Context</code> menu item is invoked from <em>git gui blame</em>. If this
6779         variable is set to zero, the whole history is shown.
6780 </p>
6781 </dd>
6782 <dt class="hdlist1">
6783 guitool.&lt;name&gt;.cmd
6784 </dt>
6785 <dd>
6786 <p>
6787         Specifies the shell command line to execute when the corresponding item
6788         of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
6789         mandatory for every tool. The command is executed from the root of
6790         the working directory, and in the environment it receives the name of
6791         the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
6792         <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
6793         the head is detached, <em>CUR_BRANCH</em> is empty).
6794 </p>
6795 </dd>
6796 <dt class="hdlist1">
6797 guitool.&lt;name&gt;.needsFile
6798 </dt>
6799 <dd>
6800 <p>
6801         Run the tool only if a diff is selected in the GUI. It guarantees
6802         that <em>FILENAME</em> is not empty.
6803 </p>
6804 </dd>
6805 <dt class="hdlist1">
6806 guitool.&lt;name&gt;.noConsole
6807 </dt>
6808 <dd>
6809 <p>
6810         Run the command silently, without creating a window to display its
6811         output.
6812 </p>
6813 </dd>
6814 <dt class="hdlist1">
6815 guitool.&lt;name&gt;.noRescan
6816 </dt>
6817 <dd>
6818 <p>
6819         Don&#8217;t rescan the working directory for changes after the tool
6820         finishes execution.
6821 </p>
6822 </dd>
6823 <dt class="hdlist1">
6824 guitool.&lt;name&gt;.confirm
6825 </dt>
6826 <dd>
6827 <p>
6828         Show a confirmation dialog before actually running the tool.
6829 </p>
6830 </dd>
6831 <dt class="hdlist1">
6832 guitool.&lt;name&gt;.argPrompt
6833 </dt>
6834 <dd>
6835 <p>
6836         Request a string argument from the user, and pass it to the tool
6837         through the <code>ARGS</code> environment variable. Since requesting an
6838         argument implies confirmation, the <em>confirm</em> option has no effect
6839         if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
6840         the dialog uses a built-in generic prompt; otherwise the exact
6841         value of the variable is used.
6842 </p>
6843 </dd>
6844 <dt class="hdlist1">
6845 guitool.&lt;name&gt;.revPrompt
6846 </dt>
6847 <dd>
6848 <p>
6849         Request a single valid revision from the user, and set the
6850         <code>REVISION</code> environment variable. In other aspects this option
6851         is similar to <em>argPrompt</em>, and can be used together with it.
6852 </p>
6853 </dd>
6854 <dt class="hdlist1">
6855 guitool.&lt;name&gt;.revUnmerged
6856 </dt>
6857 <dd>
6858 <p>
6859         Show only unmerged branches in the <em>revPrompt</em> subdialog.
6860         This is useful for tools similar to merge or rebase, but not
6861         for things like checkout or reset.
6862 </p>
6863 </dd>
6864 <dt class="hdlist1">
6865 guitool.&lt;name&gt;.title
6866 </dt>
6867 <dd>
6868 <p>
6869         Specifies the title to use for the prompt dialog. The default
6870         is the tool name.
6871 </p>
6872 </dd>
6873 <dt class="hdlist1">
6874 guitool.&lt;name&gt;.prompt
6875 </dt>
6876 <dd>
6877 <p>
6878         Specifies the general prompt string to display at the top of
6879         the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
6880         The default value includes the actual command.
6881 </p>
6882 </dd>
6883 <dt class="hdlist1">
6884 help.browser
6885 </dt>
6886 <dd>
6887 <p>
6888         Specify the browser that will be used to display help in the
6889         <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
6890 </p>
6891 </dd>
6892 <dt class="hdlist1">
6893 help.format
6894 </dt>
6895 <dd>
6896 <p>
6897         Override the default help format used by <a href="git-help.html">git-help(1)</a>.
6898         Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
6899         the default. <em>web</em> and <em>html</em> are the same.
6900 </p>
6901 </dd>
6902 <dt class="hdlist1">
6903 help.autoCorrect
6904 </dt>
6905 <dd>
6906 <p>
6907         If git detects typos and can identify exactly one valid command similar
6908         to the error, git will try to suggest the correct command or even
6909         run the suggestion automatically. Possible config values are:
6910 </p>
6911 <div class="ulist"><ul>
6912 <li>
6913 <p>
6914 0 (default): show the suggested command.
6915 </p>
6916 </li>
6917 <li>
6918 <p>
6919 positive number: run the suggested command after specified
6920 deciseconds (0.1 sec).
6921 </p>
6922 </li>
6923 <li>
6924 <p>
6925 "immediate": run the suggested command immediately.
6926 </p>
6927 </li>
6928 <li>
6929 <p>
6930 "prompt": show the suggestion and prompt for confirmation to run
6931 the command.
6932 </p>
6933 </li>
6934 <li>
6935 <p>
6936 "never": don&#8217;t run or show any suggested command.
6937 </p>
6938 </li>
6939 </ul></div>
6940 </dd>
6941 <dt class="hdlist1">
6942 help.htmlPath
6943 </dt>
6944 <dd>
6945 <p>
6946         Specify the path where the HTML documentation resides. File system paths
6947         and URLs are supported. HTML pages will be prefixed with this path when
6948         help is displayed in the <em>web</em> format. This defaults to the documentation
6949         path of your Git installation.
6950 </p>
6951 </dd>
6952 <dt class="hdlist1">
6953 http.proxy
6954 </dt>
6955 <dd>
6956 <p>
6957         Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
6958         <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
6959         addition to the syntax understood by curl, it is possible to specify a
6960         proxy string with a user name but no password, in which case git will
6961         attempt to acquire one in the same way it does for other credentials. See
6962         <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
6963         <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
6964         on a per-remote basis; see remote.&lt;name&gt;.proxy
6965 </p>
6966 </dd>
6967 <dt class="hdlist1">
6968 http.proxyAuthMethod
6969 </dt>
6970 <dd>
6971 <p>
6972         Set the method with which to authenticate against the HTTP proxy. This
6973         only takes effect if the configured proxy string contains a user name part
6974         (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
6975         overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
6976         Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
6977         variable.  Possible values are:
6978 </p>
6979 <div class="openblock">
6980 <div class="content">
6981 <div class="ulist"><ul>
6982 <li>
6983 <p>
6984 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
6985   assumed that the proxy answers an unauthenticated request with a 407
6986   status code and one or more Proxy-authenticate headers with supported
6987   authentication methods. This is the default.
6988 </p>
6989 </li>
6990 <li>
6991 <p>
6992 <code>basic</code> - HTTP Basic authentication
6993 </p>
6994 </li>
6995 <li>
6996 <p>
6997 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
6998   transmitted to the proxy in clear text
6999 </p>
7000 </li>
7001 <li>
7002 <p>
7003 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7004   of <code>curl(1)</code>)
7005 </p>
7006 </li>
7007 <li>
7008 <p>
7009 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7010 </p>
7011 </li>
7012 </ul></div>
7013 </div></div>
7014 </dd>
7015 <dt class="hdlist1">
7016 http.proxySSLCert
7017 </dt>
7018 <dd>
7019 <p>
7020         The pathname of a file that stores a client certificate to use to authenticate
7021         with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7022         variable.
7023 </p>
7024 </dd>
7025 <dt class="hdlist1">
7026 http.proxySSLKey
7027 </dt>
7028 <dd>
7029 <p>
7030         The pathname of a file that stores a private key to use to authenticate with
7031         an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7032         variable.
7033 </p>
7034 </dd>
7035 <dt class="hdlist1">
7036 http.proxySSLCertPasswordProtected
7037 </dt>
7038 <dd>
7039 <p>
7040         Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
7041         will prompt the user, possibly many times, if the certificate or private key
7042         is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7043         environment variable.
7044 </p>
7045 </dd>
7046 <dt class="hdlist1">
7047 http.proxySSLCAInfo
7048 </dt>
7049 <dd>
7050 <p>
7051         Pathname to the file containing the certificate bundle that should be used to
7052         verify the proxy with when using an HTTPS proxy. Can be overridden by the
7053         <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7054 </p>
7055 </dd>
7056 <dt class="hdlist1">
7057 http.emptyAuth
7058 </dt>
7059 <dd>
7060 <p>
7061         Attempt authentication without seeking a username or password.  This
7062         can be used to attempt GSS-Negotiate authentication without specifying
7063         a username in the URL, as libcurl normally requires a username for
7064         authentication.
7065 </p>
7066 </dd>
7067 <dt class="hdlist1">
7068 http.delegation
7069 </dt>
7070 <dd>
7071 <p>
7072         Control GSSAPI credential delegation. The delegation is disabled
7073         by default in libcurl since version 7.21.7. Set parameter to tell
7074         the server what it is allowed to delegate when it comes to user
7075         credentials. Used with GSS/kerberos. Possible values are:
7076 </p>
7077 <div class="openblock">
7078 <div class="content">
7079 <div class="ulist"><ul>
7080 <li>
7081 <p>
7082 <code>none</code> - Don&#8217;t allow any delegation.
7083 </p>
7084 </li>
7085 <li>
7086 <p>
7087 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7088   Kerberos service ticket, which is a matter of realm policy.
7089 </p>
7090 </li>
7091 <li>
7092 <p>
7093 <code>always</code> - Unconditionally allow the server to delegate.
7094 </p>
7095 </li>
7096 </ul></div>
7097 </div></div>
7098 </dd>
7099 <dt class="hdlist1">
7100 http.extraHeader
7101 </dt>
7102 <dd>
7103 <p>
7104         Pass an additional HTTP header when communicating with a server.  If
7105         more than one such entry exists, all of them are added as extra
7106         headers.  To allow overriding the settings inherited from the system
7107         config, an empty value will reset the extra headers to the empty list.
7108 </p>
7109 </dd>
7110 <dt class="hdlist1">
7111 http.cookieFile
7112 </dt>
7113 <dd>
7114 <p>
7115         The pathname of a file containing previously stored cookie lines,
7116         which should be used
7117         in the Git http session, if they match the server. The file format
7118         of the file to read cookies from should be plain HTTP headers or
7119         the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7120         NOTE that the file specified with http.cookieFile is used only as
7121         input unless http.saveCookies is set.
7122 </p>
7123 </dd>
7124 <dt class="hdlist1">
7125 http.saveCookies
7126 </dt>
7127 <dd>
7128 <p>
7129         If set, store cookies received during requests to the file specified by
7130         http.cookieFile. Has no effect if http.cookieFile is unset.
7131 </p>
7132 </dd>
7133 <dt class="hdlist1">
7134 http.version
7135 </dt>
7136 <dd>
7137 <p>
7138         Use the specified HTTP protocol version when communicating with a server.
7139         If you want to force the default. The available and default version depend
7140         on libcurl. Currently the possible values of
7141         this option are:
7142 </p>
7143 <div class="ulist"><ul>
7144 <li>
7145 <p>
7146 HTTP/2
7147 </p>
7148 </li>
7149 <li>
7150 <p>
7151 HTTP/1.1
7152 </p>
7153 </li>
7154 </ul></div>
7155 </dd>
7156 <dt class="hdlist1">
7157 http.curloptResolve
7158 </dt>
7159 <dd>
7160 <p>
7161         Hostname resolution information that will be used first by
7162         libcurl when sending HTTP requests.  This information should
7163         be in one of the following formats:
7164 </p>
7165 <div class="ulist"><ul>
7166 <li>
7167 <p>
7168 [+]HOST:PORT:ADDRESS[,ADDRESS]
7169 </p>
7170 </li>
7171 <li>
7172 <p>
7173 -HOST:PORT
7174 </p>
7175 </li>
7176 </ul></div>
7177 <div class="paragraph"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7178 to the provided <code>ADDRESS</code>(s). The second format clears all
7179 previous config values for that <code>HOST:PORT</code> combination.  To
7180 allow easy overriding of all the settings inherited from the
7181 system config, an empty value will reset all resolution
7182 information to the empty list.</p></div>
7183 </dd>
7184 <dt class="hdlist1">
7185 http.sslVersion
7186 </dt>
7187 <dd>
7188 <p>
7189         The SSL version to use when negotiating an SSL connection, if you
7190         want to force the default.  The available and default version
7191         depend on whether libcurl was built against NSS or OpenSSL and the
7192         particular configuration of the crypto library in use. Internally
7193         this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7194         documentation for more details on the format of this option and
7195         for the ssl version supported. Currently the possible values of
7196         this option are:
7197 </p>
7198 <div class="ulist"><ul>
7199 <li>
7200 <p>
7201 sslv2
7202 </p>
7203 </li>
7204 <li>
7205 <p>
7206 sslv3
7207 </p>
7208 </li>
7209 <li>
7210 <p>
7211 tlsv1
7212 </p>
7213 </li>
7214 <li>
7215 <p>
7216 tlsv1.0
7217 </p>
7218 </li>
7219 <li>
7220 <p>
7221 tlsv1.1
7222 </p>
7223 </li>
7224 <li>
7225 <p>
7226 tlsv1.2
7227 </p>
7228 </li>
7229 <li>
7230 <p>
7231 tlsv1.3
7232 </p>
7233 </li>
7234 </ul></div>
7235 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7236 To force git to use libcurl&#8217;s default ssl version and ignore any
7237 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7238 empty string.</p></div>
7239 </dd>
7240 <dt class="hdlist1">
7241 http.sslCipherList
7242 </dt>
7243 <dd>
7244 <p>
7245   A list of SSL ciphers to use when negotiating an SSL connection.
7246   The available ciphers depend on whether libcurl was built against
7247   NSS or OpenSSL and the particular configuration of the crypto
7248   library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7249   option; see the libcurl documentation for more details on the format
7250   of this list.
7251 </p>
7252 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7253 To force git to use libcurl&#8217;s default cipher list and ignore any
7254 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7255 empty string.</p></div>
7256 </dd>
7257 <dt class="hdlist1">
7258 http.sslVerify
7259 </dt>
7260 <dd>
7261 <p>
7262         Whether to verify the SSL certificate when fetching or pushing
7263         over HTTPS. Defaults to true. Can be overridden by the
7264         <code>GIT_SSL_NO_VERIFY</code> environment variable.
7265 </p>
7266 </dd>
7267 <dt class="hdlist1">
7268 http.sslCert
7269 </dt>
7270 <dd>
7271 <p>
7272         File containing the SSL certificate when fetching or pushing
7273         over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7274         variable.
7275 </p>
7276 </dd>
7277 <dt class="hdlist1">
7278 http.sslKey
7279 </dt>
7280 <dd>
7281 <p>
7282         File containing the SSL private key when fetching or pushing
7283         over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7284         variable.
7285 </p>
7286 </dd>
7287 <dt class="hdlist1">
7288 http.sslCertPasswordProtected
7289 </dt>
7290 <dd>
7291 <p>
7292         Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
7293         OpenSSL will prompt the user, possibly many times, if the
7294         certificate or private key is encrypted.  Can be overridden by the
7295         <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7296 </p>
7297 </dd>
7298 <dt class="hdlist1">
7299 http.sslCAInfo
7300 </dt>
7301 <dd>
7302 <p>
7303         File containing the certificates to verify the peer with when
7304         fetching or pushing over HTTPS. Can be overridden by the
7305         <code>GIT_SSL_CAINFO</code> environment variable.
7306 </p>
7307 </dd>
7308 <dt class="hdlist1">
7309 http.sslCAPath
7310 </dt>
7311 <dd>
7312 <p>
7313         Path containing files with the CA certificates to verify the peer
7314         with when fetching or pushing over HTTPS. Can be overridden
7315         by the <code>GIT_SSL_CAPATH</code> environment variable.
7316 </p>
7317 </dd>
7318 <dt class="hdlist1">
7319 http.sslBackend
7320 </dt>
7321 <dd>
7322 <p>
7323         Name of the SSL backend to use (e.g. "openssl" or "schannel").
7324         This option is ignored if cURL lacks support for choosing the SSL
7325         backend at runtime.
7326 </p>
7327 </dd>
7328 <dt class="hdlist1">
7329 http.schannelCheckRevoke
7330 </dt>
7331 <dd>
7332 <p>
7333         Used to enforce or disable certificate revocation checks in cURL
7334         when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
7335         unset. Only necessary to disable this if Git consistently errors
7336         and the message is about checking the revocation status of a
7337         certificate. This option is ignored if cURL lacks support for
7338         setting the relevant SSL option at runtime.
7339 </p>
7340 </dd>
7341 <dt class="hdlist1">
7342 http.schannelUseSSLCAInfo
7343 </dt>
7344 <dd>
7345 <p>
7346         As of cURL v7.60.0, the Secure Channel backend can use the
7347         certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7348         override the Windows Certificate Store. Since this is not desirable
7349         by default, Git will tell cURL not to use that bundle by default
7350         when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7351         unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7352 </p>
7353 </dd>
7354 <dt class="hdlist1">
7355 http.pinnedPubkey
7356 </dt>
7357 <dd>
7358 <p>
7359         Public key of the https service. It may either be the filename of
7360         a PEM or DER encoded public key file or a string starting with
7361         <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7362         public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7363         exit with an error if this option is set but not supported by
7364         cURL.
7365 </p>
7366 </dd>
7367 <dt class="hdlist1">
7368 http.sslTry
7369 </dt>
7370 <dd>
7371 <p>
7372         Attempt to use AUTH SSL/TLS and encrypted data transfers
7373         when connecting via regular FTP protocol. This might be needed
7374         if the FTP server requires it for security reasons or you wish
7375         to connect securely whenever remote FTP server supports it.
7376         Default is false since it might trigger certificate verification
7377         errors on misconfigured servers.
7378 </p>
7379 </dd>
7380 <dt class="hdlist1">
7381 http.maxRequests
7382 </dt>
7383 <dd>
7384 <p>
7385         How many HTTP requests to launch in parallel. Can be overridden
7386         by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7387 </p>
7388 </dd>
7389 <dt class="hdlist1">
7390 http.minSessions
7391 </dt>
7392 <dd>
7393 <p>
7394         The number of curl sessions (counted across slots) to be kept across
7395         requests. They will not be ended with curl_easy_cleanup() until
7396         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7397         value will be capped at 1. Defaults to 1.
7398 </p>
7399 </dd>
7400 <dt class="hdlist1">
7401 http.postBuffer
7402 </dt>
7403 <dd>
7404 <p>
7405         Maximum size in bytes of the buffer used by smart HTTP
7406         transports when POSTing data to the remote system.
7407         For requests larger than this buffer size, HTTP/1.1 and
7408         Transfer-Encoding: chunked is used to avoid creating a
7409         massive pack file locally.  Default is 1 MiB, which is
7410         sufficient for most requests.
7411 </p>
7412 <div class="paragraph"><p>Note that raising this limit is only effective for disabling chunked
7413 transfer encoding and therefore should be used only where the remote
7414 server or a proxy only supports HTTP/1.0 or is noncompliant with the
7415 HTTP standard.  Raising this is not, in general, an effective solution
7416 for most push problems, but can increase memory consumption
7417 significantly since the entire buffer is allocated even for small
7418 pushes.</p></div>
7419 </dd>
7420 <dt class="hdlist1">
7421 http.lowSpeedLimit, http.lowSpeedTime
7422 </dt>
7423 <dd>
7424 <p>
7425         If the HTTP transfer speed, in bytes per second, is less than
7426         <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
7427         the transfer is aborted.
7428         Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
7429         <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
7430 </p>
7431 </dd>
7432 <dt class="hdlist1">
7433 http.noEPSV
7434 </dt>
7435 <dd>
7436 <p>
7437         A boolean which disables using of EPSV ftp command by curl.
7438         This can helpful with some "poor" ftp servers which don&#8217;t
7439         support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
7440         environment variable. Default is false (curl will use EPSV).
7441 </p>
7442 </dd>
7443 <dt class="hdlist1">
7444 http.userAgent
7445 </dt>
7446 <dd>
7447 <p>
7448         The HTTP USER_AGENT string presented to an HTTP server.  The default
7449         value represents the version of the client Git such as git/1.7.1.
7450         This option allows you to override this value to a more common value
7451         such as Mozilla/4.0.  This may be necessary, for instance, if
7452         connecting through a firewall that restricts HTTP connections to a set
7453         of common USER_AGENT strings (but not including those like git/1.7.1).
7454         Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
7455 </p>
7456 </dd>
7457 <dt class="hdlist1">
7458 http.followRedirects
7459 </dt>
7460 <dd>
7461 <p>
7462         Whether git should follow HTTP redirects. If set to <code>true</code>, git
7463         will transparently follow any redirect issued by a server it
7464         encounters. If set to <code>false</code>, git will treat all redirects as
7465         errors. If set to <code>initial</code>, git will follow redirects only for
7466         the initial request to a remote, but not for subsequent
7467         follow-up HTTP requests. Since git uses the redirected URL as
7468         the base for the follow-up requests, this is generally
7469         sufficient. The default is <code>initial</code>.
7470 </p>
7471 </dd>
7472 <dt class="hdlist1">
7473 http.&lt;url&gt;.*
7474 </dt>
7475 <dd>
7476 <p>
7477         Any of the http.* options above can be applied selectively to some URLs.
7478         For a config key to match a URL, each element of the config key is
7479         compared to that of the URL, in the following order:
7480 </p>
7481 <div class="openblock">
7482 <div class="content">
7483 <div class="olist arabic"><ol class="arabic">
7484 <li>
7485 <p>
7486 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
7487   must match exactly between the config key and the URL.
7488 </p>
7489 </li>
7490 <li>
7491 <p>
7492 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
7493   This field must match between the config key and the URL. It is
7494   possible to specify a <code>*</code> as part of the host name to match all subdomains
7495   at this level. <code>https://*.example.com/</code> for example would match
7496   <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
7497 </p>
7498 </li>
7499 <li>
7500 <p>
7501 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
7502   This field must match exactly between the config key and the URL.
7503   Omitted port numbers are automatically converted to the correct
7504   default for the scheme before matching.
7505 </p>
7506 </li>
7507 <li>
7508 <p>
7509 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
7510   path field of the config key must match the path field of the URL
7511   either exactly or as a prefix of slash-delimited path elements.  This means
7512   a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
7513   match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
7514   key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
7515   key with just path <code>foo/</code>).
7516 </p>
7517 </li>
7518 <li>
7519 <p>
7520 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
7521   the config key has a user name it must match the user name in the
7522   URL exactly. If the config key does not have a user name, that
7523   config key will match a URL with any user name (including none),
7524   but at a lower precedence than a config key with a user name.
7525 </p>
7526 </li>
7527 </ol></div>
7528 </div></div>
7529 <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
7530 a config key&#8217;s path is preferred to one that matches its user name. For example,
7531 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
7532 <code>https://example.com/foo</code> will be preferred over a config key match of
7533 <code>https://user@example.com</code>.</p></div>
7534 <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
7535 if embedded in the URL, is always ignored for matching purposes) so that
7536 equivalent URLs that are simply spelled differently will match properly.
7537 Environment variable settings always override any matches.  The URLs that are
7538 matched against are those given directly to Git commands.  This means any URLs
7539 visited as a result of a redirection do not participate in matching.</p></div>
7540 </dd>
7541 <dt class="hdlist1">
7542 i18n.commitEncoding
7543 </dt>
7544 <dd>
7545 <p>
7546         Character encoding the commit messages are stored in; Git itself
7547         does not care per se, but this information is necessary e.g. when
7548         importing commits from emails or in the gitk graphical history
7549         browser (and possibly at other places in the future or in other
7550         porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
7551 </p>
7552 </dd>
7553 <dt class="hdlist1">
7554 i18n.logOutputEncoding
7555 </dt>
7556 <dd>
7557 <p>
7558         Character encoding the commit messages are converted to when
7559         running <em>git log</em> and friends.
7560 </p>
7561 </dd>
7562 <dt class="hdlist1">
7563 imap.folder
7564 </dt>
7565 <dd>
7566 <p>
7567         The folder to drop the mails into, which is typically the Drafts
7568         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
7569         "[Gmail]/Drafts". Required.
7570 </p>
7571 </dd>
7572 <dt class="hdlist1">
7573 imap.tunnel
7574 </dt>
7575 <dd>
7576 <p>
7577         Command used to setup a tunnel to the IMAP server through which
7578         commands will be piped instead of using a direct network connection
7579         to the server. Required when imap.host is not set.
7580 </p>
7581 </dd>
7582 <dt class="hdlist1">
7583 imap.host
7584 </dt>
7585 <dd>
7586 <p>
7587         A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
7588         connections and an <code>imaps://</code> prefix for secure connections.
7589         Ignored when imap.tunnel is set, but required otherwise.
7590 </p>
7591 </dd>
7592 <dt class="hdlist1">
7593 imap.user
7594 </dt>
7595 <dd>
7596 <p>
7597         The username to use when logging in to the server.
7598 </p>
7599 </dd>
7600 <dt class="hdlist1">
7601 imap.pass
7602 </dt>
7603 <dd>
7604 <p>
7605         The password to use when logging in to the server.
7606 </p>
7607 </dd>
7608 <dt class="hdlist1">
7609 imap.port
7610 </dt>
7611 <dd>
7612 <p>
7613         An integer port number to connect to on the server.
7614         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
7615         Ignored when imap.tunnel is set.
7616 </p>
7617 </dd>
7618 <dt class="hdlist1">
7619 imap.sslverify
7620 </dt>
7621 <dd>
7622 <p>
7623         A boolean to enable/disable verification of the server certificate
7624         used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
7625         imap.tunnel is set.
7626 </p>
7627 </dd>
7628 <dt class="hdlist1">
7629 imap.preformattedHTML
7630 </dt>
7631 <dd>
7632 <p>
7633         A boolean to enable/disable the use of html encoding when sending
7634         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
7635         and have a content type of text/html.  Ironically, enabling this
7636         option causes Thunderbird to send the patch as a plain/text,
7637         format=fixed email.  Default is <code>false</code>.
7638 </p>
7639 </dd>
7640 <dt class="hdlist1">
7641 imap.authMethod
7642 </dt>
7643 <dd>
7644 <p>
7645         Specify authenticate method for authentication with IMAP server.
7646         If Git was built with the NO_CURL option, or if your curl version is older
7647         than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
7648         option, the only supported method is <em>CRAM-MD5</em>. If this is not set
7649         then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
7650 </p>
7651 </dd>
7652 <dt class="hdlist1">
7653 include.path
7654 </dt>
7655 <dt class="hdlist1">
7656 includeIf.&lt;condition&gt;.path
7657 </dt>
7658 <dd>
7659 <p>
7660         Special variables to include other configuration files. See
7661         the "CONFIGURATION FILE" section in the main
7662         <a href="git-config.html">git-config(1)</a> documentation,
7663         specifically the "Includes" and "Conditional Includes" subsections.
7664 </p>
7665 </dd>
7666 <dt class="hdlist1">
7667 index.recordEndOfIndexEntries
7668 </dt>
7669 <dd>
7670 <p>
7671         Specifies whether the index file should include an "End Of Index
7672         Entry" section. This reduces index load time on multiprocessor
7673         machines but produces a message "ignoring EOIE extension" when
7674         reading the index using Git versions before 2.20. Defaults to
7675         <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
7676         otherwise.
7677 </p>
7678 </dd>
7679 <dt class="hdlist1">
7680 index.recordOffsetTable
7681 </dt>
7682 <dd>
7683 <p>
7684         Specifies whether the index file should include an "Index Entry
7685         Offset Table" section. This reduces index load time on
7686         multiprocessor machines but produces a message "ignoring IEOT
7687         extension" when reading the index using Git versions before 2.20.
7688         Defaults to <em>true</em> if index.threads has been explicitly enabled,
7689         <em>false</em> otherwise.
7690 </p>
7691 </dd>
7692 <dt class="hdlist1">
7693 index.sparse
7694 </dt>
7695 <dd>
7696 <p>
7697         When enabled, write the index using sparse-directory entries. This
7698         has no effect unless <code>core.sparseCheckout</code> and
7699         <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
7700 </p>
7701 </dd>
7702 <dt class="hdlist1">
7703 index.threads
7704 </dt>
7705 <dd>
7706 <p>
7707         Specifies the number of threads to spawn when loading the index.
7708         This is meant to reduce index load time on multiprocessor machines.
7709         Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
7710         CPU&#8217;s and set the number of threads accordingly. Specifying 1 or
7711         <em>false</em> will disable multithreading. Defaults to <em>true</em>.
7712 </p>
7713 </dd>
7714 <dt class="hdlist1">
7715 index.version
7716 </dt>
7717 <dd>
7718 <p>
7719         Specify the version with which new index files should be
7720         initialized.  This does not affect existing repositories.
7721         If <code>feature.manyFiles</code> is enabled, then the default is 4.
7722 </p>
7723 </dd>
7724 <dt class="hdlist1">
7725 index.skipHash
7726 </dt>
7727 <dd>
7728 <p>
7729         When enabled, do not compute the trailing hash for the index file.
7730         This accelerates Git commands that manipulate the index, such as
7731         <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
7732         checksum, write a trailing set of bytes with value zero, indicating
7733         that the computation was skipped.
7734 </p>
7735 <div class="paragraph"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
7736 refuse to parse the index and Git clients older than 2.40.0 will report an
7737 error during <code>git fsck</code>.</p></div>
7738 </dd>
7739 <dt class="hdlist1">
7740 init.templateDir
7741 </dt>
7742 <dd>
7743 <p>
7744         Specify the directory from which templates will be copied.
7745         (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
7746 </p>
7747 </dd>
7748 <dt class="hdlist1">
7749 init.defaultBranch
7750 </dt>
7751 <dd>
7752 <p>
7753         Allows overriding the default branch name e.g. when initializing
7754         a new repository.
7755 </p>
7756 </dd>
7757 <dt class="hdlist1">
7758 instaweb.browser
7759 </dt>
7760 <dd>
7761 <p>
7762         Specify the program that will be used to browse your working
7763         repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7764 </p>
7765 </dd>
7766 <dt class="hdlist1">
7767 instaweb.httpd
7768 </dt>
7769 <dd>
7770 <p>
7771         The HTTP daemon command-line to start gitweb on your working
7772         repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7773 </p>
7774 </dd>
7775 <dt class="hdlist1">
7776 instaweb.local
7777 </dt>
7778 <dd>
7779 <p>
7780         If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
7781         be bound to the local IP (127.0.0.1).
7782 </p>
7783 </dd>
7784 <dt class="hdlist1">
7785 instaweb.modulePath
7786 </dt>
7787 <dd>
7788 <p>
7789         The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
7790         instead of /usr/lib/apache2/modules.  Only used if httpd
7791         is Apache.
7792 </p>
7793 </dd>
7794 <dt class="hdlist1">
7795 instaweb.port
7796 </dt>
7797 <dd>
7798 <p>
7799         The port number to bind the gitweb httpd to. See
7800         <a href="git-instaweb.html">git-instaweb(1)</a>.
7801 </p>
7802 </dd>
7803 <dt class="hdlist1">
7804 interactive.singleKey
7805 </dt>
7806 <dd>
7807 <p>
7808         In interactive commands, allow the user to provide one-letter
7809         input with a single key (i.e., without hitting enter).
7810         Currently this is used by the <code>--patch</code> mode of
7811         <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
7812         <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
7813         <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>. Note that this
7814         setting is silently ignored if portable keystroke input
7815         is not available; requires the Perl module Term::ReadKey.
7816 </p>
7817 </dd>
7818 <dt class="hdlist1">
7819 interactive.diffFilter
7820 </dt>
7821 <dd>
7822 <p>
7823         When an interactive command (such as <code>git add --patch</code>) shows
7824         a colorized diff, git will pipe the diff through the shell
7825         command defined by this configuration variable. The command may
7826         mark up the diff further for human consumption, provided that it
7827         retains a one-to-one correspondence with the lines in the
7828         original diff. Defaults to disabled (no filtering).
7829 </p>
7830 </dd>
7831 <dt class="hdlist1">
7832 log.abbrevCommit
7833 </dt>
7834 <dd>
7835 <p>
7836         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
7837         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
7838         override this option with <code>--no-abbrev-commit</code>.
7839 </p>
7840 </dd>
7841 <dt class="hdlist1">
7842 log.date
7843 </dt>
7844 <dd>
7845 <p>
7846         Set the default date-time mode for the <em>log</em> command.
7847         Setting a value for log.date is similar to using <em>git log</em>'s
7848         <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.
7849 </p>
7850 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
7851 "foo" will be the used for the date format. Otherwise "default" will
7852 be used.</p></div>
7853 </dd>
7854 <dt class="hdlist1">
7855 log.decorate
7856 </dt>
7857 <dd>
7858 <p>
7859         Print out the ref names of any commits that are shown by the log
7860         command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
7861         <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
7862         specified, the full ref name (including prefix) will be printed.
7863         If <em>auto</em> is specified, then if the output is going to a terminal,
7864         the ref names are shown as if <em>short</em> were given, otherwise no ref
7865         names are shown. This is the same as the <code>--decorate</code> option
7866         of the <code>git log</code>.
7867 </p>
7868 </dd>
7869 <dt class="hdlist1">
7870 log.initialDecorationSet
7871 </dt>
7872 <dd>
7873 <p>
7874         By default, <code>git log</code> only shows decorations for certain known ref
7875         namespaces. If <em>all</em> is specified, then show all refs as
7876         decorations.
7877 </p>
7878 </dd>
7879 <dt class="hdlist1">
7880 log.excludeDecoration
7881 </dt>
7882 <dd>
7883 <p>
7884         Exclude the specified patterns from the log decorations. This is
7885         similar to the <code>--decorate-refs-exclude</code> command-line option, but
7886         the config option can be overridden by the <code>--decorate-refs</code>
7887         option.
7888 </p>
7889 </dd>
7890 <dt class="hdlist1">
7891 log.diffMerges
7892 </dt>
7893 <dd>
7894 <p>
7895         Set diff format to be used when <code>--diff-merges=on</code> is
7896         specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
7897         details. Defaults to <code>separate</code>.
7898 </p>
7899 </dd>
7900 <dt class="hdlist1">
7901 log.follow
7902 </dt>
7903 <dd>
7904 <p>
7905         If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
7906         a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
7907         i.e. it cannot be used to follow multiple files and does not work well
7908         on non-linear history.
7909 </p>
7910 </dd>
7911 <dt class="hdlist1">
7912 log.graphColors
7913 </dt>
7914 <dd>
7915 <p>
7916         A list of colors, separated by commas, that can be used to draw
7917         history lines in <code>git log --graph</code>.
7918 </p>
7919 </dd>
7920 <dt class="hdlist1">
7921 log.showRoot
7922 </dt>
7923 <dd>
7924 <p>
7925         If true, the initial commit will be shown as a big creation event.
7926         This is equivalent to a diff against an empty tree.
7927         Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
7928         normally hide the root commit will now show it. True by default.
7929 </p>
7930 </dd>
7931 <dt class="hdlist1">
7932 log.showSignature
7933 </dt>
7934 <dd>
7935 <p>
7936         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
7937         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
7938 </p>
7939 </dd>
7940 <dt class="hdlist1">
7941 log.mailmap
7942 </dt>
7943 <dd>
7944 <p>
7945         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
7946         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
7947         assume <code>--no-use-mailmap</code>. True by default.
7948 </p>
7949 </dd>
7950 <dt class="hdlist1">
7951 lsrefs.unborn
7952 </dt>
7953 <dd>
7954 <p>
7955         May be "advertise" (the default), "allow", or "ignore". If "advertise",
7956         the server will respond to the client sending "unborn" (as described in
7957         <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
7958         protocol v2 capability advertisement. "allow" is the same as
7959         "advertise" except that the server will not advertise support for this
7960         feature; this is useful for load-balanced servers that cannot be
7961         updated atomically (for example), since the administrator could
7962         configure "allow", then after a delay, configure "advertise".
7963 </p>
7964 </dd>
7965 <dt class="hdlist1">
7966 mailinfo.scissors
7967 </dt>
7968 <dd>
7969 <p>
7970         If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
7971         <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
7972         was provided on the command-line. When active, this features
7973         removes everything from the message body before a scissors
7974         line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
7975 </p>
7976 </dd>
7977 <dt class="hdlist1">
7978 mailmap.file
7979 </dt>
7980 <dd>
7981 <p>
7982         The location of an augmenting mailmap file. The default
7983         mailmap, located in the root of the repository, is loaded
7984         first, then the mailmap file pointed to by this variable.
7985         The location of the mailmap file may be in a repository
7986         subdirectory, or somewhere outside of the repository itself.
7987         See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
7988 </p>
7989 </dd>
7990 <dt class="hdlist1">
7991 mailmap.blob
7992 </dt>
7993 <dd>
7994 <p>
7995         Like <code>mailmap.file</code>, but consider the value as a reference to a
7996         blob in the repository. If both <code>mailmap.file</code> and
7997         <code>mailmap.blob</code> are given, both are parsed, with entries from
7998         <code>mailmap.file</code> taking precedence. In a bare repository, this
7999         defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8000         defaults to empty.
8001 </p>
8002 </dd>
8003 <dt class="hdlist1">
8004 maintenance.auto
8005 </dt>
8006 <dd>
8007 <p>
8008         This boolean config option controls whether some commands run
8009         <code>git maintenance run --auto</code> after doing their normal work. Defaults
8010         to true.
8011 </p>
8012 </dd>
8013 <dt class="hdlist1">
8014 maintenance.strategy
8015 </dt>
8016 <dd>
8017 <p>
8018         This string config option provides a way to specify one of a few
8019         recommended schedules for background maintenance. This only affects
8020         which tasks are run during <code>git maintenance run --schedule=X</code>
8021         commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
8022         Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
8023         then that value is used instead of the one provided by
8024         <code>maintenance.strategy</code>. The possible strategy strings are:
8025 </p>
8026 <div class="ulist"><ul>
8027 <li>
8028 <p>
8029 <code>none</code>: This default setting implies no task are run at any schedule.
8030 </p>
8031 </li>
8032 <li>
8033 <p>
8034 <code>incremental</code>: This setting optimizes for performing small maintenance
8035   activities that do not delete any data. This does not schedule the <code>gc</code>
8036   task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8037   <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8038   task weekly.
8039 </p>
8040 </li>
8041 </ul></div>
8042 </dd>
8043 <dt class="hdlist1">
8044 maintenance.&lt;task&gt;.enabled
8045 </dt>
8046 <dd>
8047 <p>
8048         This boolean config option controls whether the maintenance task
8049         with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
8050         <code>git maintenance run</code>. These config values are ignored if a
8051         <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8052         is true.
8053 </p>
8054 </dd>
8055 <dt class="hdlist1">
8056 maintenance.&lt;task&gt;.schedule
8057 </dt>
8058 <dd>
8059 <p>
8060         This config option controls whether or not the given <code>&lt;task&gt;</code> runs
8061         during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
8062         value must be one of "hourly", "daily", or "weekly".
8063 </p>
8064 </dd>
8065 <dt class="hdlist1">
8066 maintenance.commit-graph.auto
8067 </dt>
8068 <dd>
8069 <p>
8070         This integer config option controls how often the <code>commit-graph</code> task
8071         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8072         the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8073         negative value will force the task to run every time. Otherwise, a
8074         positive value implies the command should run when the number of
8075         reachable commits that are not in the commit-graph file is at least
8076         the value of <code>maintenance.commit-graph.auto</code>. The default value is
8077         100.
8078 </p>
8079 </dd>
8080 <dt class="hdlist1">
8081 maintenance.loose-objects.auto
8082 </dt>
8083 <dd>
8084 <p>
8085         This integer config option controls how often the <code>loose-objects</code> task
8086         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8087         the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8088         negative value will force the task to run every time. Otherwise, a
8089         positive value implies the command should run when the number of
8090         loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8091         The default value is 100.
8092 </p>
8093 </dd>
8094 <dt class="hdlist1">
8095 maintenance.incremental-repack.auto
8096 </dt>
8097 <dd>
8098 <p>
8099         This integer config option controls how often the <code>incremental-repack</code>
8100         task should be run as part of <code>git maintenance run --auto</code>. If zero,
8101         then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8102         option. A negative value will force the task to run every time.
8103         Otherwise, a positive value implies the command should run when the
8104         number of pack-files not in the multi-pack-index is at least the value
8105         of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8106 </p>
8107 </dd>
8108 <dt class="hdlist1">
8109 man.viewer
8110 </dt>
8111 <dd>
8112 <p>
8113         Specify the programs that may be used to display help in the
8114         <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8115 </p>
8116 </dd>
8117 <dt class="hdlist1">
8118 man.&lt;tool&gt;.cmd
8119 </dt>
8120 <dd>
8121 <p>
8122         Specify the command to invoke the specified man viewer. The
8123         specified command is evaluated in shell with the man page
8124         passed as argument. (See <a href="git-help.html">git-help(1)</a>.)
8125 </p>
8126 </dd>
8127 <dt class="hdlist1">
8128 man.&lt;tool&gt;.path
8129 </dt>
8130 <dd>
8131 <p>
8132         Override the path for the given tool that may be used to
8133         display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8134 </p>
8135 </dd>
8136 <dt class="hdlist1">
8137 merge.conflictStyle
8138 </dt>
8139 <dd>
8140 <p>
8141         Specify the style in which conflicted hunks are written out to
8142         working tree files upon merge.  The default is "merge", which
8143         shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
8144         a <code>=======</code> marker, changes made by the other side, and then
8145         a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
8146         marker and the original text before the <code>=======</code> marker.  The
8147         "merge" style tends to produce smaller conflict regions than diff3,
8148         both because of the exclusion of the original text, and because
8149         when a subset of lines match on the two sides they are just pulled
8150         out of the conflict region.  Another alternate style, "zdiff3", is
8151         similar to diff3 but removes matching lines on the two sides from
8152         the conflict region when those matching lines appear near either
8153         the beginning or end of a conflict region.
8154 </p>
8155 </dd>
8156 <dt class="hdlist1">
8157 merge.defaultToUpstream
8158 </dt>
8159 <dd>
8160 <p>
8161         If merge is called without any commit argument, merge the upstream
8162         branches configured for the current branch by using their last
8163         observed values stored in their remote-tracking branches.
8164         The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
8165         branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
8166         are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
8167         to their corresponding remote-tracking branches, and the tips of
8168         these tracking branches are merged. Defaults to true.
8169 </p>
8170 </dd>
8171 <dt class="hdlist1">
8172 merge.ff
8173 </dt>
8174 <dd>
8175 <p>
8176         By default, Git does not create an extra merge commit when merging
8177         a commit that is a descendant of the current commit. Instead, the
8178         tip of the current branch is fast-forwarded. When set to <code>false</code>,
8179         this variable tells Git to create an extra merge commit in such
8180         a case (equivalent to giving the <code>--no-ff</code> option from the command
8181         line). When set to <code>only</code>, only such fast-forward merges are
8182         allowed (equivalent to giving the <code>--ff-only</code> option from the
8183         command line).
8184 </p>
8185 </dd>
8186 <dt class="hdlist1">
8187 merge.verifySignatures
8188 </dt>
8189 <dd>
8190 <p>
8191         If true, this is equivalent to the --verify-signatures command
8192         line option. See <a href="git-merge.html">git-merge(1)</a> for details.
8193 </p>
8194 </dd>
8195 <dt class="hdlist1">
8196 merge.branchdesc
8197 </dt>
8198 <dd>
8199 <p>
8200         In addition to branch names, populate the log message with
8201         the branch description text associated with them.  Defaults
8202         to false.
8203 </p>
8204 </dd>
8205 <dt class="hdlist1">
8206 merge.log
8207 </dt>
8208 <dd>
8209 <p>
8210         In addition to branch names, populate the log message with at
8211         most the specified number of one-line descriptions from the
8212         actual commits that are being merged.  Defaults to false, and
8213         true is a synonym for 20.
8214 </p>
8215 </dd>
8216 <dt class="hdlist1">
8217 merge.suppressDest
8218 </dt>
8219 <dd>
8220 <p>
8221         By adding a glob that matches the names of integration
8222         branches to this multi-valued configuration variable, the
8223         default merge message computed for merges into these
8224         integration branches will omit "into &lt;branch name&gt;" from
8225         its title.
8226 </p>
8227 <div class="paragraph"><p>An element with an empty value can be used to clear the list
8228 of globs accumulated from previous configuration entries.
8229 When there is no <code>merge.suppressDest</code> variable defined, the
8230 default value of <code>master</code> is used for backward compatibility.</p></div>
8231 </dd>
8232 <dt class="hdlist1">
8233 merge.renameLimit
8234 </dt>
8235 <dd>
8236 <p>
8237         The number of files to consider in the exhaustive portion of
8238         rename detection during a merge.  If not specified, defaults
8239         to the value of diff.renameLimit.  If neither
8240         merge.renameLimit nor diff.renameLimit are specified,
8241         currently defaults to 7000.  This setting has no effect if
8242         rename detection is turned off.
8243 </p>
8244 </dd>
8245 <dt class="hdlist1">
8246 merge.renames
8247 </dt>
8248 <dd>
8249 <p>
8250         Whether Git detects renames.  If set to "false", rename detection
8251         is disabled. If set to "true", basic rename detection is enabled.
8252         Defaults to the value of diff.renames.
8253 </p>
8254 </dd>
8255 <dt class="hdlist1">
8256 merge.directoryRenames
8257 </dt>
8258 <dd>
8259 <p>
8260         Whether Git detects directory renames, affecting what happens at
8261         merge time to new files added to a directory on one side of
8262         history when that directory was renamed on the other side of
8263         history.  If merge.directoryRenames is set to "false", directory
8264         rename detection is disabled, meaning that such new files will be
8265         left behind in the old directory.  If set to "true", directory
8266         rename detection is enabled, meaning that such new files will be
8267         moved into the new directory.  If set to "conflict", a conflict
8268         will be reported for such paths.  If merge.renames is false,
8269         merge.directoryRenames is ignored and treated as false.  Defaults
8270         to "conflict".
8271 </p>
8272 </dd>
8273 <dt class="hdlist1">
8274 merge.renormalize
8275 </dt>
8276 <dd>
8277 <p>
8278         Tell Git that canonical representation of files in the
8279         repository has changed over time (e.g. earlier commits record
8280         text files with CRLF line endings, but recent ones use LF line
8281         endings).  In such a repository, Git can convert the data
8282         recorded in commits to a canonical form before performing a
8283         merge to reduce unnecessary conflicts.  For more information,
8284         see section "Merging branches with differing checkin/checkout
8285         attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
8286 </p>
8287 </dd>
8288 <dt class="hdlist1">
8289 merge.stat
8290 </dt>
8291 <dd>
8292 <p>
8293         Whether to print the diffstat between ORIG_HEAD and the merge result
8294         at the end of the merge.  True by default.
8295 </p>
8296 </dd>
8297 <dt class="hdlist1">
8298 merge.autoStash
8299 </dt>
8300 <dd>
8301 <p>
8302         When set to true, automatically create a temporary stash entry
8303         before the operation begins, and apply it after the operation
8304         ends.  This means that you can run merge on a dirty worktree.
8305         However, use with care: the final stash application after a
8306         successful merge might result in non-trivial conflicts.
8307         This option can be overridden by the <code>--no-autostash</code> and
8308         <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
8309         Defaults to false.
8310 </p>
8311 </dd>
8312 <dt class="hdlist1">
8313 merge.tool
8314 </dt>
8315 <dd>
8316 <p>
8317         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
8318         The list below shows the valid built-in values.
8319         Any other value is treated as a custom merge tool and requires
8320         that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
8321 </p>
8322 </dd>
8323 <dt class="hdlist1">
8324 merge.guitool
8325 </dt>
8326 <dd>
8327 <p>
8328         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
8329         -g/--gui flag is specified. The list below shows the valid built-in values.
8330         Any other value is treated as a custom merge tool and requires that a
8331         corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.
8332 </p>
8333 <div class="dlist"><dl>
8334 <dt class="hdlist1">
8335 <code>araxis</code>
8336 </dt>
8337 <dd>
8338 <p>
8339 Use Araxis Merge (requires a graphical session)
8340 </p>
8341 </dd>
8342 <dt class="hdlist1">
8343 <code>bc</code>
8344 </dt>
8345 <dd>
8346 <p>
8347 Use Beyond Compare (requires a graphical session)
8348 </p>
8349 </dd>
8350 <dt class="hdlist1">
8351 <code>bc3</code>
8352 </dt>
8353 <dd>
8354 <p>
8355 Use Beyond Compare (requires a graphical session)
8356 </p>
8357 </dd>
8358 <dt class="hdlist1">
8359 <code>bc4</code>
8360 </dt>
8361 <dd>
8362 <p>
8363 Use Beyond Compare (requires a graphical session)
8364 </p>
8365 </dd>
8366 <dt class="hdlist1">
8367 <code>codecompare</code>
8368 </dt>
8369 <dd>
8370 <p>
8371 Use Code Compare (requires a graphical session)
8372 </p>
8373 </dd>
8374 <dt class="hdlist1">
8375 <code>deltawalker</code>
8376 </dt>
8377 <dd>
8378 <p>
8379 Use DeltaWalker (requires a graphical session)
8380 </p>
8381 </dd>
8382 <dt class="hdlist1">
8383 <code>diffmerge</code>
8384 </dt>
8385 <dd>
8386 <p>
8387 Use DiffMerge (requires a graphical session)
8388 </p>
8389 </dd>
8390 <dt class="hdlist1">
8391 <code>diffuse</code>
8392 </dt>
8393 <dd>
8394 <p>
8395 Use Diffuse (requires a graphical session)
8396 </p>
8397 </dd>
8398 <dt class="hdlist1">
8399 <code>ecmerge</code>
8400 </dt>
8401 <dd>
8402 <p>
8403 Use ECMerge (requires a graphical session)
8404 </p>
8405 </dd>
8406 <dt class="hdlist1">
8407 <code>emerge</code>
8408 </dt>
8409 <dd>
8410 <p>
8411 Use Emacs' Emerge
8412 </p>
8413 </dd>
8414 <dt class="hdlist1">
8415 <code>examdiff</code>
8416 </dt>
8417 <dd>
8418 <p>
8419 Use ExamDiff Pro (requires a graphical session)
8420 </p>
8421 </dd>
8422 <dt class="hdlist1">
8423 <code>guiffy</code>
8424 </dt>
8425 <dd>
8426 <p>
8427 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
8428 </p>
8429 </dd>
8430 <dt class="hdlist1">
8431 <code>gvimdiff</code>
8432 </dt>
8433 <dd>
8434 <p>
8435 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8436 </p>
8437 </dd>
8438 <dt class="hdlist1">
8439 <code>gvimdiff1</code>
8440 </dt>
8441 <dd>
8442 <p>
8443 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
8444 </p>
8445 </dd>
8446 <dt class="hdlist1">
8447 <code>gvimdiff2</code>
8448 </dt>
8449 <dd>
8450 <p>
8451 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
8452 </p>
8453 </dd>
8454 <dt class="hdlist1">
8455 <code>gvimdiff3</code>
8456 </dt>
8457 <dd>
8458 <p>
8459 Use gVim (requires a graphical session) where only the MERGED file is shown
8460 </p>
8461 </dd>
8462 <dt class="hdlist1">
8463 <code>kdiff3</code>
8464 </dt>
8465 <dd>
8466 <p>
8467 Use KDiff3 (requires a graphical session)
8468 </p>
8469 </dd>
8470 <dt class="hdlist1">
8471 <code>meld</code>
8472 </dt>
8473 <dd>
8474 <p>
8475 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
8476 </p>
8477 </dd>
8478 <dt class="hdlist1">
8479 <code>nvimdiff</code>
8480 </dt>
8481 <dd>
8482 <p>
8483 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8484 </p>
8485 </dd>
8486 <dt class="hdlist1">
8487 <code>nvimdiff1</code>
8488 </dt>
8489 <dd>
8490 <p>
8491 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
8492 </p>
8493 </dd>
8494 <dt class="hdlist1">
8495 <code>nvimdiff2</code>
8496 </dt>
8497 <dd>
8498 <p>
8499 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8500 </p>
8501 </dd>
8502 <dt class="hdlist1">
8503 <code>nvimdiff3</code>
8504 </dt>
8505 <dd>
8506 <p>
8507 Use Neovim where only the MERGED file is shown
8508 </p>
8509 </dd>
8510 <dt class="hdlist1">
8511 <code>opendiff</code>
8512 </dt>
8513 <dd>
8514 <p>
8515 Use FileMerge (requires a graphical session)
8516 </p>
8517 </dd>
8518 <dt class="hdlist1">
8519 <code>p4merge</code>
8520 </dt>
8521 <dd>
8522 <p>
8523 Use HelixCore P4Merge (requires a graphical session)
8524 </p>
8525 </dd>
8526 <dt class="hdlist1">
8527 <code>smerge</code>
8528 </dt>
8529 <dd>
8530 <p>
8531 Use Sublime Merge (requires a graphical session)
8532 </p>
8533 </dd>
8534 <dt class="hdlist1">
8535 <code>tkdiff</code>
8536 </dt>
8537 <dd>
8538 <p>
8539 Use TkDiff (requires a graphical session)
8540 </p>
8541 </dd>
8542 <dt class="hdlist1">
8543 <code>tortoisemerge</code>
8544 </dt>
8545 <dd>
8546 <p>
8547 Use TortoiseMerge (requires a graphical session)
8548 </p>
8549 </dd>
8550 <dt class="hdlist1">
8551 <code>vimdiff</code>
8552 </dt>
8553 <dd>
8554 <p>
8555 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8556 </p>
8557 </dd>
8558 <dt class="hdlist1">
8559 <code>vimdiff1</code>
8560 </dt>
8561 <dd>
8562 <p>
8563 Use Vim with a 2 panes layout (LOCAL and REMOTE)
8564 </p>
8565 </dd>
8566 <dt class="hdlist1">
8567 <code>vimdiff2</code>
8568 </dt>
8569 <dd>
8570 <p>
8571 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8572 </p>
8573 </dd>
8574 <dt class="hdlist1">
8575 <code>vimdiff3</code>
8576 </dt>
8577 <dd>
8578 <p>
8579 Use Vim where only the MERGED file is shown
8580 </p>
8581 </dd>
8582 <dt class="hdlist1">
8583 <code>winmerge</code>
8584 </dt>
8585 <dd>
8586 <p>
8587 Use WinMerge (requires a graphical session)
8588 </p>
8589 </dd>
8590 <dt class="hdlist1">
8591 <code>xxdiff</code>
8592 </dt>
8593 <dd>
8594 <p>
8595 Use xxdiff (requires a graphical session)
8596 </p>
8597 </dd>
8598 </dl></div>
8599 </dd>
8600 <dt class="hdlist1">
8601 merge.verbosity
8602 </dt>
8603 <dd>
8604 <p>
8605         Controls the amount of output shown by the recursive merge
8606         strategy.  Level 0 outputs nothing except a final error
8607         message if conflicts were detected. Level 1 outputs only
8608         conflicts, 2 outputs conflicts and file changes.  Level 5 and
8609         above outputs debugging information.  The default is level 2.
8610         Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
8611 </p>
8612 </dd>
8613 <dt class="hdlist1">
8614 merge.&lt;driver&gt;.name
8615 </dt>
8616 <dd>
8617 <p>
8618         Defines a human-readable name for a custom low-level
8619         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8620 </p>
8621 </dd>
8622 <dt class="hdlist1">
8623 merge.&lt;driver&gt;.driver
8624 </dt>
8625 <dd>
8626 <p>
8627         Defines the command that implements a custom low-level
8628         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8629 </p>
8630 </dd>
8631 <dt class="hdlist1">
8632 merge.&lt;driver&gt;.recursive
8633 </dt>
8634 <dd>
8635 <p>
8636         Names a low-level merge driver to be used when
8637         performing an internal merge between common ancestors.
8638         See <a href="gitattributes.html">gitattributes(5)</a> for details.
8639 </p>
8640 </dd>
8641 <dt class="hdlist1">
8642 mergetool.&lt;tool&gt;.path
8643 </dt>
8644 <dd>
8645 <p>
8646         Override the path for the given tool.  This is useful in case
8647         your tool is not in the PATH.
8648 </p>
8649 </dd>
8650 <dt class="hdlist1">
8651 mergetool.&lt;tool&gt;.cmd
8652 </dt>
8653 <dd>
8654 <p>
8655         Specify the command to invoke the specified merge tool.  The
8656         specified command is evaluated in shell with the following
8657         variables available: <em>BASE</em> is the name of a temporary file
8658         containing the common base of the files to be merged, if available;
8659         <em>LOCAL</em> is the name of a temporary file containing the contents of
8660         the file on the current branch; <em>REMOTE</em> is the name of a temporary
8661         file containing the contents of the file from the branch being
8662         merged; <em>MERGED</em> contains the name of the file to which the merge
8663         tool should write the results of a successful merge.
8664 </p>
8665 </dd>
8666 <dt class="hdlist1">
8667 mergetool.&lt;tool&gt;.hideResolved
8668 </dt>
8669 <dd>
8670 <p>
8671         Allows the user to override the global <code>mergetool.hideResolved</code> value
8672         for a specific tool. See <code>mergetool.hideResolved</code> for the full
8673         description.
8674 </p>
8675 </dd>
8676 <dt class="hdlist1">
8677 mergetool.&lt;tool&gt;.trustExitCode
8678 </dt>
8679 <dd>
8680 <p>
8681         For a custom merge command, specify whether the exit code of
8682         the merge command can be used to determine whether the merge was
8683         successful.  If this is not set to true then the merge target file
8684         timestamp is checked and the merge assumed to have been successful
8685         if the file has been updated, otherwise the user is prompted to
8686         indicate the success of the merge.
8687 </p>
8688 </dd>
8689 <dt class="hdlist1">
8690 mergetool.meld.hasOutput
8691 </dt>
8692 <dd>
8693 <p>
8694         Older versions of <code>meld</code> do not support the <code>--output</code> option.
8695         Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
8696         by inspecting the output of <code>meld --help</code>.  Configuring
8697         <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
8698         use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
8699         to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
8700         and <code>false</code> avoids using <code>--output</code>.
8701 </p>
8702 </dd>
8703 <dt class="hdlist1">
8704 mergetool.meld.useAutoMerge
8705 </dt>
8706 <dd>
8707 <p>
8708         When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
8709         parts automatically, highlight the conflicting parts and wait for
8710         user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
8711         Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
8712         Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
8713         is supported and will only use <code>--auto-merge</code> when available.  A
8714         value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
8715         default value.
8716 </p>
8717 </dd>
8718 <dt class="hdlist1">
8719 mergetool.vimdiff.layout
8720 </dt>
8721 <dd>
8722 <p>
8723         The vimdiff backend uses this variable to control how its split
8724         windows look like. Applies even if you are using Neovim (<code>nvim</code>) or
8725         gVim (<code>gvim</code>) as the merge tool. See BACKEND SPECIFIC HINTS section
8726         in <a href="git-mergetool.html">git-mergetool(1)</a>.
8727         for details.
8728 </p>
8729 </dd>
8730 <dt class="hdlist1">
8731 mergetool.hideResolved
8732 </dt>
8733 <dd>
8734 <p>
8735         During a merge Git will automatically resolve as many conflicts as
8736         possible and write the <em>MERGED</em> file containing conflict markers around
8737         any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
8738         represent the versions of the file from before Git&#8217;s conflict
8739         resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
8740         that only the unresolved conflicts are presented to the merge tool. Can
8741         be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
8742         configuration variable. Defaults to <code>false</code>.
8743 </p>
8744 </dd>
8745 <dt class="hdlist1">
8746 mergetool.keepBackup
8747 </dt>
8748 <dd>
8749 <p>
8750         After performing a merge, the original file with conflict markers
8751         can be saved as a file with a <code>.orig</code> extension.  If this variable
8752         is set to <code>false</code> then this file is not preserved.  Defaults to
8753         <code>true</code> (i.e. keep the backup files).
8754 </p>
8755 </dd>
8756 <dt class="hdlist1">
8757 mergetool.keepTemporaries
8758 </dt>
8759 <dd>
8760 <p>
8761         When invoking a custom merge tool, Git uses a set of temporary
8762         files to pass to the tool. If the tool returns an error and this
8763         variable is set to <code>true</code>, then these temporary files will be
8764         preserved, otherwise they will be removed after the tool has
8765         exited. Defaults to <code>false</code>.
8766 </p>
8767 </dd>
8768 <dt class="hdlist1">
8769 mergetool.writeToTemp
8770 </dt>
8771 <dd>
8772 <p>
8773         Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
8774         conflicting files in the worktree by default.  Git will attempt
8775         to use a temporary directory for these files when set <code>true</code>.
8776         Defaults to <code>false</code>.
8777 </p>
8778 </dd>
8779 <dt class="hdlist1">
8780 mergetool.prompt
8781 </dt>
8782 <dd>
8783 <p>
8784         Prompt before each invocation of the merge resolution program.
8785 </p>
8786 </dd>
8787 <dt class="hdlist1">
8788 mergetool.guiDefault
8789 </dt>
8790 <dd>
8791 <p>
8792         Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
8793         specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
8794         or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
8795         variable value. The default is <code>false</code>, where the <code>--gui</code> argument
8796         must be provided explicitly for the <code>merge.guitool</code> to be used.
8797 </p>
8798 </dd>
8799 <dt class="hdlist1">
8800 notes.mergeStrategy
8801 </dt>
8802 <dd>
8803 <p>
8804         Which merge strategy to choose by default when resolving notes
8805         conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
8806         <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See "NOTES MERGE STRATEGIES"
8807         section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
8808 </p>
8809 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
8810 <a href="git-notes.html">git-notes(1)</a>.</p></div>
8811 </dd>
8812 <dt class="hdlist1">
8813 notes.&lt;name&gt;.mergeStrategy
8814 </dt>
8815 <dd>
8816 <p>
8817         Which merge strategy to choose when doing a notes merge into
8818         refs/notes/&lt;name&gt;.  This overrides the more general
8819         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
8820         <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
8821 </p>
8822 </dd>
8823 <dt class="hdlist1">
8824 notes.displayRef
8825 </dt>
8826 <dd>
8827 <p>
8828         Which ref (or refs, if a glob or specified more than once), in
8829         addition to the default set by <code>core.notesRef</code> or
8830         <code>GIT_NOTES_REF</code>, to read notes from when showing commit
8831         messages with the <em>git log</em> family of commands.
8832 </p>
8833 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
8834 environment variable, which must be a colon separated list of refs or
8835 globs.</p></div>
8836 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
8837 but a glob that does not match any refs is silently ignored.</p></div>
8838 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
8839 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
8840 those commands.</p></div>
8841 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
8842 GIT_NOTES_REF) is also implicitly added to the list of refs to be
8843 displayed.</p></div>
8844 </dd>
8845 <dt class="hdlist1">
8846 notes.rewrite.&lt;command&gt;
8847 </dt>
8848 <dd>
8849 <p>
8850         When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
8851         <code>rebase</code>), if this variable is <code>false</code>, git will not copy
8852         notes from the original to the rewritten commit.  Defaults to
8853         <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.
8854 </p>
8855 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
8856 environment variable, which must be a colon separated list of refs or
8857 globs.</p></div>
8858 </dd>
8859 <dt class="hdlist1">
8860 notes.rewriteMode
8861 </dt>
8862 <dd>
8863 <p>
8864         When copying notes during a rewrite (see the
8865         "notes.rewrite.&lt;command&gt;" option), determines what to do if
8866         the target commit already has a note.  Must be one of
8867         <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
8868         Defaults to <code>concatenate</code>.
8869 </p>
8870 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
8871 environment variable.</p></div>
8872 </dd>
8873 <dt class="hdlist1">
8874 notes.rewriteRef
8875 </dt>
8876 <dd>
8877 <p>
8878         When copying notes during a rewrite, specifies the (fully
8879         qualified) ref whose notes should be copied.  May be a glob,
8880         in which case notes in all matching refs will be copied.  You
8881         may also specify this configuration several times.
8882 </p>
8883 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
8884 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
8885 rewriting for the default commit notes.</p></div>
8886 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
8887 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
8888 </dd>
8889 <dt class="hdlist1">
8890 pack.window
8891 </dt>
8892 <dd>
8893 <p>
8894         The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
8895         window size is given on the command line. Defaults to 10.
8896 </p>
8897 </dd>
8898 <dt class="hdlist1">
8899 pack.depth
8900 </dt>
8901 <dd>
8902 <p>
8903         The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
8904         maximum depth is given on the command line. Defaults to 50.
8905         Maximum value is 4095.
8906 </p>
8907 </dd>
8908 <dt class="hdlist1">
8909 pack.windowMemory
8910 </dt>
8911 <dd>
8912 <p>
8913         The maximum size of memory that is consumed by each thread
8914         in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
8915         no limit is given on the command line.  The value can be
8916         suffixed with "k", "m", or "g".  When left unconfigured (or
8917         set explicitly to 0), there will be no limit.
8918 </p>
8919 </dd>
8920 <dt class="hdlist1">
8921 pack.compression
8922 </dt>
8923 <dd>
8924 <p>
8925         An integer -1..9, indicating the compression level for objects
8926         in a pack file. -1 is the zlib default. 0 means no
8927         compression, and 1..9 are various speed/size tradeoffs, 9 being
8928         slowest.  If not set,  defaults to core.compression.  If that is
8929         not set,  defaults to -1, the zlib default, which is "a default
8930         compromise between speed and compression (currently equivalent
8931         to level 6)."
8932 </p>
8933 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
8934 all existing objects. You can force recompression by passing the -F option
8935 to <a href="git-repack.html">git-repack(1)</a>.</p></div>
8936 </dd>
8937 <dt class="hdlist1">
8938 pack.allowPackReuse
8939 </dt>
8940 <dd>
8941 <p>
8942         When true, and when reachability bitmaps are enabled,
8943         pack-objects will try to send parts of the bitmapped packfile
8944         verbatim. This can reduce memory and CPU usage to serve fetches,
8945         but might result in sending a slightly larger pack. Defaults to
8946         true.
8947 </p>
8948 </dd>
8949 <dt class="hdlist1">
8950 pack.island
8951 </dt>
8952 <dd>
8953 <p>
8954         An extended regular expression configuring a set of delta
8955         islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
8956         for details.
8957 </p>
8958 </dd>
8959 <dt class="hdlist1">
8960 pack.islandCore
8961 </dt>
8962 <dd>
8963 <p>
8964         Specify an island name which gets to have its objects be
8965         packed first. This creates a kind of pseudo-pack at the front
8966         of one pack, so that the objects from the specified island are
8967         hopefully faster to copy into any pack that should be served
8968         to a user requesting these objects. In practice this means
8969         that the island specified should likely correspond to what is
8970         the most commonly cloned in the repo. See also "DELTA ISLANDS"
8971         in <a href="git-pack-objects.html">git-pack-objects(1)</a>.
8972 </p>
8973 </dd>
8974 <dt class="hdlist1">
8975 pack.deltaCacheSize
8976 </dt>
8977 <dd>
8978 <p>
8979         The maximum memory in bytes used for caching deltas in
8980         <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
8981         This cache is used to speed up the writing object phase by not
8982         having to recompute the final delta result once the best match
8983         for all objects is found.  Repacking large repositories on machines
8984         which are tight with memory might be badly impacted by this though,
8985         especially if this cache pushes the system into swapping.
8986         A value of 0 means no limit. The smallest size of 1 byte may be
8987         used to virtually disable this cache. Defaults to 256 MiB.
8988 </p>
8989 </dd>
8990 <dt class="hdlist1">
8991 pack.deltaCacheLimit
8992 </dt>
8993 <dd>
8994 <p>
8995         The maximum size of a delta, that is cached in
8996         <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
8997         writing object phase by not having to recompute the final delta
8998         result once the best match for all objects is found.
8999         Defaults to 1000. Maximum value is 65535.
9000 </p>
9001 </dd>
9002 <dt class="hdlist1">
9003 pack.threads
9004 </dt>
9005 <dd>
9006 <p>
9007         Specifies the number of threads to spawn when searching for best
9008         delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
9009         be compiled with pthreads otherwise this option is ignored with a
9010         warning. This is meant to reduce packing time on multiprocessor
9011         machines. The required amount of memory for the delta search window
9012         is however multiplied by the number of threads.
9013         Specifying 0 will cause Git to auto-detect the number of CPU&#8217;s
9014         and set the number of threads accordingly.
9015 </p>
9016 </dd>
9017 <dt class="hdlist1">
9018 pack.indexVersion
9019 </dt>
9020 <dd>
9021 <p>
9022         Specify the default pack index version.  Valid values are 1 for
9023         legacy pack index used by Git versions prior to 1.5.2, and 2 for
9024         the new pack index with capabilities for packs larger than 4 GB
9025         as well as proper protection against the repacking of corrupted
9026         packs.  Version 2 is the default.  Note that version 2 is enforced
9027         and this config option ignored whenever the corresponding pack is
9028         larger than 2 GB.
9029 </p>
9030 <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9031 cloning or fetching over a non native protocol (e.g. "http")
9032 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9033 other side may give you a repository that cannot be accessed with your
9034 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9035 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
9036 the <code>*.idx</code> file.</p></div>
9037 </dd>
9038 <dt class="hdlist1">
9039 pack.packSizeLimit
9040 </dt>
9041 <dd>
9042 <p>
9043         The maximum size of a pack.  This setting only affects
9044         packing to a file when repacking, i.e. the git:// protocol
9045         is unaffected.  It can be overridden by the <code>--max-pack-size</code>
9046         option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
9047         in the creation of multiple packfiles.
9048 </p>
9049 <div class="paragraph"><p>Note that this option is rarely useful, and may result in a larger total
9050 on-disk size (because Git will not store deltas between packs), as well
9051 as worse runtime performance (object lookup within multiple packs is
9052 slower than a single pack, and optimizations like reachability bitmaps
9053 cannot cope with multiple packs).</p></div>
9054 <div class="paragraph"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9055 filesystem does not support large files), this option may help. But if
9056 your goal is to transmit a packfile over a medium that supports limited
9057 sizes (e.g., removable media that cannot store the whole repository),
9058 you are likely better off creating a single large packfile and splitting
9059 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9060 <div class="paragraph"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9061 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9062 </dd>
9063 <dt class="hdlist1">
9064 pack.useBitmaps
9065 </dt>
9066 <dd>
9067 <p>
9068         When true, git will use pack bitmaps (if available) when packing
9069         to stdout (e.g., during the server side of a fetch). Defaults to
9070         true. You should not generally need to turn this off unless
9071         you are debugging pack bitmaps.
9072 </p>
9073 </dd>
9074 <dt class="hdlist1">
9075 pack.useBitmapBoundaryTraversal
9076 </dt>
9077 <dd>
9078 <p>
9079         When true, Git will use an experimental algorithm for computing
9080         reachability queries with bitmaps. Instead of building up
9081         complete bitmaps for all of the negated tips and then OR-ing
9082         them together, consider negated tips with existing bitmaps as
9083         additive (i.e. OR-ing them into the result if they exist,
9084         ignoring them otherwise), and build up a bitmap at the boundary
9085         instead.
9086 </p>
9087 <div class="paragraph"><p>When using this algorithm, Git may include too many objects as a result
9088 of not opening up trees belonging to certain UNINTERESTING commits. This
9089 inexactness matches the non-bitmap traversal algorithm.</p></div>
9090 <div class="paragraph"><p>In many cases, this can provide a speed-up over the exact algorithm,
9091 particularly when there is poor bitmap coverage of the negated side of
9092 the query.</p></div>
9093 </dd>
9094 <dt class="hdlist1">
9095 pack.useSparse
9096 </dt>
9097 <dd>
9098 <p>
9099         When true, git will default to using the <em>--sparse</em> option in
9100         <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9101         algorithm only walks trees that appear in paths that introduce new
9102         objects. This can have significant performance benefits when
9103         computing a pack to send a small change. However, it is possible
9104         that extra objects are added to the pack-file if the included
9105         commits contain certain types of direct renames. Default is
9106         <code>true</code>.
9107 </p>
9108 </dd>
9109 <dt class="hdlist1">
9110 pack.preferBitmapTips
9111 </dt>
9112 <dd>
9113 <p>
9114         When selecting which commits will receive bitmaps, prefer a
9115         commit at the tip of any reference that is a suffix of any value
9116         of this configuration over any other commits in the "selection
9117         window".
9118 </p>
9119 <div class="paragraph"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9120 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9121 necessarily be selected. This is because commits are selected for
9122 bitmaps from within a series of windows of variable length.</p></div>
9123 <div class="paragraph"><p>If a commit at the tip of any reference which is a suffix of any value
9124 of this configuration is seen in a window, it is immediately given
9125 preference over any other commit in that window.</p></div>
9126 </dd>
9127 <dt class="hdlist1">
9128 pack.writeBitmaps (deprecated)
9129 </dt>
9130 <dd>
9131 <p>
9132         This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9133 </p>
9134 </dd>
9135 <dt class="hdlist1">
9136 pack.writeBitmapHashCache
9137 </dt>
9138 <dd>
9139 <p>
9140         When true, git will include a "hash cache" section in the bitmap
9141         index (if one is written). This cache can be used to feed git&#8217;s
9142         delta heuristics, potentially leading to better deltas between
9143         bitmapped and non-bitmapped objects (e.g., when serving a fetch
9144         between an older, bitmapped pack and objects that have been
9145         pushed since the last gc). The downside is that it consumes 4
9146         bytes per object of disk space. Defaults to true.
9147 </p>
9148 <div class="paragraph"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9149 computed; instead, any namehashes stored in an existing bitmap are
9150 permuted into their appropriate location when writing a new bitmap.</p></div>
9151 </dd>
9152 <dt class="hdlist1">
9153 pack.writeBitmapLookupTable
9154 </dt>
9155 <dd>
9156 <p>
9157         When true, Git will include a "lookup table" section in the
9158         bitmap index (if one is written). This table is used to defer
9159         loading individual bitmaps as late as possible. This can be
9160         beneficial in repositories that have relatively large bitmap
9161         indexes. Defaults to false.
9162 </p>
9163 </dd>
9164 <dt class="hdlist1">
9165 pack.readReverseIndex
9166 </dt>
9167 <dd>
9168 <p>
9169         When true, git will read any .rev file(s) that may be available
9170         (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
9171         will be generated from scratch and stored in memory. Defaults to
9172         true.
9173 </p>
9174 </dd>
9175 <dt class="hdlist1">
9176 pack.writeReverseIndex
9177 </dt>
9178 <dd>
9179 <p>
9180         When true, git will write a corresponding .rev file (see:
9181         <a href="gitformat-pack.html">gitformat-pack(5)</a>)
9182         for each new packfile that it writes in all places except for
9183         <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
9184         Defaults to true.
9185 </p>
9186 </dd>
9187 <dt class="hdlist1">
9188 pager.&lt;cmd&gt;
9189 </dt>
9190 <dd>
9191 <p>
9192         If the value is boolean, turns on or off pagination of the
9193         output of a particular Git subcommand when writing to a tty.
9194         Otherwise, turns on pagination for the subcommand using the
9195         pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
9196         or <code>--no-pager</code> is specified on the command line, it takes
9197         precedence over this option.  To disable pagination for all
9198         commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9199 </p>
9200 </dd>
9201 <dt class="hdlist1">
9202 pretty.&lt;name&gt;
9203 </dt>
9204 <dd>
9205 <p>
9206         Alias for a --pretty= format string, as specified in
9207         <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
9208         as the built-in pretty formats could. For example,
9209         running <code>git config pretty.changelog "format:* %H %s"</code>
9210         would cause the invocation <code>git log --pretty=changelog</code>
9211         to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
9212         Note that an alias with the same name as a built-in format
9213         will be silently ignored.
9214 </p>
9215 </dd>
9216 <dt class="hdlist1">
9217 protocol.allow
9218 </dt>
9219 <dd>
9220 <p>
9221         If set, provide a user defined default policy for all protocols which
9222         don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
9223         if unset, known-safe protocols (http, https, git, ssh) have a
9224         default policy of <code>always</code>, known-dangerous protocols (ext) have a
9225         default policy of <code>never</code>, and all other protocols (including file)
9226         have a default policy of <code>user</code>.  Supported policies:
9227 </p>
9228 <div class="openblock">
9229 <div class="content">
9230 <div class="ulist"><ul>
9231 <li>
9232 <p>
9233 <code>always</code> - protocol is always able to be used.
9234 </p>
9235 </li>
9236 <li>
9237 <p>
9238 <code>never</code> - protocol is never able to be used.
9239 </p>
9240 </li>
9241 <li>
9242 <p>
9243 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9244   either unset or has a value of 1.  This policy should be used when you want a
9245   protocol to be directly usable by the user but don&#8217;t want it used by commands which
9246   execute clone/fetch/push commands without user input, e.g. recursive
9247   submodule initialization.
9248 </p>
9249 </li>
9250 </ul></div>
9251 </div></div>
9252 </dd>
9253 <dt class="hdlist1">
9254 protocol.&lt;name&gt;.allow
9255 </dt>
9256 <dd>
9257 <p>
9258         Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
9259         commands. See <code>protocol.allow</code> above for the available policies.
9260 </p>
9261 <div class="paragraph"><p>The protocol names currently used by git are:</p></div>
9262 <div class="openblock">
9263 <div class="content">
9264 <div class="ulist"><ul>
9265 <li>
9266 <p>
9267 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9268     or local paths)
9269 </p>
9270 </li>
9271 <li>
9272 <p>
9273 <code>git</code>: the anonymous git protocol over a direct TCP
9274     connection (or proxy, if configured)
9275 </p>
9276 </li>
9277 <li>
9278 <p>
9279 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9280     <code>ssh://</code>, etc).
9281 </p>
9282 </li>
9283 <li>
9284 <p>
9285 <code>http</code>: git over http, both "smart http" and "dumb http".
9286     Note that this does <em>not</em> include <code>https</code>; if you want to configure
9287     both, you must do so individually.
9288 </p>
9289 </li>
9290 <li>
9291 <p>
9292 any external helpers are named by their protocol (e.g., use
9293     <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9294 </p>
9295 </li>
9296 </ul></div>
9297 </div></div>
9298 </dd>
9299 <dt class="hdlist1">
9300 protocol.version
9301 </dt>
9302 <dd>
9303 <p>
9304         If set, clients will attempt to communicate with a server
9305         using the specified protocol version.  If the server does
9306         not support it, communication falls back to version 0.
9307         If unset, the default is <code>2</code>.
9308         Supported versions:
9309 </p>
9310 <div class="openblock">
9311 <div class="content">
9312 <div class="ulist"><ul>
9313 <li>
9314 <p>
9315 <code>0</code> - the original wire protocol.
9316 </p>
9317 </li>
9318 <li>
9319 <p>
9320 <code>1</code> - the original wire protocol with the addition of a version string
9321   in the initial response from the server.
9322 </p>
9323 </li>
9324 <li>
9325 <p>
9326 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.
9327 </p>
9328 </li>
9329 </ul></div>
9330 </div></div>
9331 </dd>
9332 <dt class="hdlist1">
9333 pull.ff
9334 </dt>
9335 <dd>
9336 <p>
9337         By default, Git does not create an extra merge commit when merging
9338         a commit that is a descendant of the current commit. Instead, the
9339         tip of the current branch is fast-forwarded. When set to <code>false</code>,
9340         this variable tells Git to create an extra merge commit in such
9341         a case (equivalent to giving the <code>--no-ff</code> option from the command
9342         line). When set to <code>only</code>, only such fast-forward merges are
9343         allowed (equivalent to giving the <code>--ff-only</code> option from the
9344         command line). This setting overrides <code>merge.ff</code> when pulling.
9345 </p>
9346 </dd>
9347 <dt class="hdlist1">
9348 pull.rebase
9349 </dt>
9350 <dd>
9351 <p>
9352         When true, rebase branches on top of the fetched branch, instead
9353         of merging the default branch from the default remote when "git
9354         pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
9355         per-branch basis.
9356 </p>
9357 <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>
9358 so that the local merge commits are included in the rebase (see
9359 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
9360 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9361 mode.</p></div>
9362 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9363 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
9364 for details).</p></div>
9365 </dd>
9366 <dt class="hdlist1">
9367 pull.octopus
9368 </dt>
9369 <dd>
9370 <p>
9371         The default merge strategy to use when pulling multiple branches
9372         at once.
9373 </p>
9374 </dd>
9375 <dt class="hdlist1">
9376 pull.twohead
9377 </dt>
9378 <dd>
9379 <p>
9380         The default merge strategy to use when pulling a single branch.
9381 </p>
9382 </dd>
9383 <dt class="hdlist1">
9384 push.autoSetupRemote
9385 </dt>
9386 <dd>
9387 <p>
9388         If set to "true" assume <code>--set-upstream</code> on default push when no
9389         upstream tracking exists for the current branch; this option
9390         takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9391         and <em>current</em>. It is useful if by default you want new branches
9392         to be pushed to the default remote (like the behavior of
9393         <em>push.default=current</em>) and you also want the upstream tracking
9394         to be set. Workflows most likely to benefit from this option are
9395         <em>simple</em> central workflows where all branches are expected to
9396         have the same name on the remote.
9397 </p>
9398 </dd>
9399 <dt class="hdlist1">
9400 push.default
9401 </dt>
9402 <dd>
9403 <p>
9404         Defines the action <code>git push</code> should take if no refspec is
9405         given (whether from the command-line, config, or elsewhere).
9406         Different values are well-suited for
9407         specific workflows; for instance, in a purely central workflow
9408         (i.e. the fetch source is equal to the push destination),
9409         <code>upstream</code> is probably what you want.  Possible values are:
9410 </p>
9411 <div class="openblock">
9412 <div class="content">
9413 <div class="ulist"><ul>
9414 <li>
9415 <p>
9416 <code>nothing</code> - do not push anything (error out) unless a refspec is
9417   given. This is primarily meant for people who want to
9418   avoid mistakes by always being explicit.
9419 </p>
9420 </li>
9421 <li>
9422 <p>
9423 <code>current</code> - push the current branch to update a branch with the same
9424   name on the receiving end.  Works in both central and non-central
9425   workflows.
9426 </p>
9427 </li>
9428 <li>
9429 <p>
9430 <code>upstream</code> - push the current branch back to the branch whose
9431   changes are usually integrated into the current branch (which is
9432   called <code>@{upstream}</code>).  This mode only makes sense if you are
9433   pushing to the same repository you would normally pull from
9434   (i.e. central workflow).
9435 </p>
9436 </li>
9437 <li>
9438 <p>
9439 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
9440 </p>
9441 </li>
9442 <li>
9443 <p>
9444 <code>simple</code> - pushes the current branch with the same name on the remote.
9445 </p>
9446 <div class="paragraph"><p>If you are working on a centralized workflow (pushing to the same repository you
9447 pull from, which is typically <code>origin</code>), then you need to configure an upstream
9448 branch with the same name.</p></div>
9449 <div class="paragraph"><p>This mode is the default since Git 2.0, and is the safest option suited for
9450 beginners.</p></div>
9451 </li>
9452 <li>
9453 <p>
9454 <code>matching</code> - push all branches having the same name on both ends.
9455   This makes the repository you are pushing to remember the set of
9456   branches that will be pushed out (e.g. if you always push <em>maint</em>
9457   and <em>master</em> there and no other branches, the repository you push
9458   to will have these two branches, and your local <em>maint</em> and
9459   <em>master</em> will be pushed there).
9460 </p>
9461 <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
9462 branches you would push out are ready to be pushed out before
9463 running <em>git push</em>, as the whole point of this mode is to allow you
9464 to push all of the branches in one go.  If you usually finish work
9465 on only one branch and push out the result, while other branches are
9466 unfinished, this mode is not for you.  Also this mode is not
9467 suitable for pushing into a shared central repository, as other
9468 people may add new branches there, or update the tip of existing
9469 branches outside your control.</p></div>
9470 <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
9471 new default).</p></div>
9472 </li>
9473 </ul></div>
9474 </div></div>
9475 </dd>
9476 <dt class="hdlist1">
9477 push.followTags
9478 </dt>
9479 <dd>
9480 <p>
9481         If set to true enable <code>--follow-tags</code> option by default.  You
9482         may override this configuration at time of push by specifying
9483         <code>--no-follow-tags</code>.
9484 </p>
9485 </dd>
9486 <dt class="hdlist1">
9487 push.gpgSign
9488 </dt>
9489 <dd>
9490 <p>
9491         May be set to a boolean value, or the string <em>if-asked</em>. A true
9492         value causes all pushes to be GPG signed, as if <code>--signed</code> is
9493         passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
9494         pushes to be signed if the server supports it, as if
9495         <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
9496         override a value from a lower-priority config file. An explicit
9497         command-line flag always overrides this config option.
9498 </p>
9499 </dd>
9500 <dt class="hdlist1">
9501 push.pushOption
9502 </dt>
9503 <dd>
9504 <p>
9505         When no <code>--push-option=&lt;option&gt;</code> argument is given from the
9506         command line, <code>git push</code> behaves as if each &lt;value&gt; of
9507         this variable is given as <code>--push-option=&lt;value&gt;</code>.
9508 </p>
9509 <div class="paragraph"><p>This is a multi-valued variable, and an empty value can be used in a
9510 higher priority configuration file (e.g. <code>.git/config</code> in a
9511 repository) to clear the values inherited from a lower priority
9512 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
9513 <div class="listingblock">
9514 <div class="content">
9515 <pre><code>Example:
9516
9517 /etc/gitconfig
9518   push.pushoption = a
9519   push.pushoption = b
9520
9521 ~/.gitconfig
9522   push.pushoption = c
9523
9524 repo/.git/config
9525   push.pushoption =
9526   push.pushoption = b
9527
9528 This will result in only b (a and c are cleared).</code></pre>
9529 </div></div>
9530 </dd>
9531 <dt class="hdlist1">
9532 push.recurseSubmodules
9533 </dt>
9534 <dd>
9535 <p>
9536         May be "check", "on-demand", "only", or "no", with the same behavior
9537         as that of "push --recurse-submodules".
9538         If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
9539         set (in which case a <em>true</em> value means <em>on-demand</em>).
9540 </p>
9541 </dd>
9542 <dt class="hdlist1">
9543 push.useForceIfIncludes
9544 </dt>
9545 <dd>
9546 <p>
9547         If set to "true", it is equivalent to specifying
9548         <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
9549         in the command line. Adding <code>--no-force-if-includes</code> at the
9550         time of push overrides this configuration setting.
9551 </p>
9552 </dd>
9553 <dt class="hdlist1">
9554 push.negotiate
9555 </dt>
9556 <dd>
9557 <p>
9558         If set to "true", attempt to reduce the size of the packfile
9559         sent by rounds of negotiation in which the client and the
9560         server attempt to find commits in common. If "false", Git will
9561         rely solely on the server&#8217;s ref advertisement to find commits
9562         in common.
9563 </p>
9564 </dd>
9565 <dt class="hdlist1">
9566 push.useBitmaps
9567 </dt>
9568 <dd>
9569 <p>
9570         If set to "false", disable use of bitmaps for "git push" even if
9571         <code>pack.useBitmaps</code> is "true", without preventing other git operations
9572         from using bitmaps. Default is true.
9573 </p>
9574 </dd>
9575 <dt class="hdlist1">
9576 rebase.backend
9577 </dt>
9578 <dd>
9579 <p>
9580         Default backend to use for rebasing.  Possible choices are
9581         <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
9582         all remaining capabilities of the apply backend, this setting
9583         may become unused.
9584 </p>
9585 </dd>
9586 <dt class="hdlist1">
9587 rebase.stat
9588 </dt>
9589 <dd>
9590 <p>
9591         Whether to show a diffstat of what changed upstream since the last
9592         rebase. False by default.
9593 </p>
9594 </dd>
9595 <dt class="hdlist1">
9596 rebase.autoSquash
9597 </dt>
9598 <dd>
9599 <p>
9600         If set to true enable <code>--autosquash</code> option by default.
9601 </p>
9602 </dd>
9603 <dt class="hdlist1">
9604 rebase.autoStash
9605 </dt>
9606 <dd>
9607 <p>
9608         When set to true, automatically create a temporary stash entry
9609         before the operation begins, and apply it after the operation
9610         ends.  This means that you can run rebase on a dirty worktree.
9611         However, use with care: the final stash application after a
9612         successful rebase might result in non-trivial conflicts.
9613         This option can be overridden by the <code>--no-autostash</code> and
9614         <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
9615         Defaults to false.
9616 </p>
9617 </dd>
9618 <dt class="hdlist1">
9619 rebase.updateRefs
9620 </dt>
9621 <dd>
9622 <p>
9623         If set to true enable <code>--update-refs</code> option by default.
9624 </p>
9625 </dd>
9626 <dt class="hdlist1">
9627 rebase.missingCommitsCheck
9628 </dt>
9629 <dd>
9630 <p>
9631         If set to "warn", git rebase -i will print a warning if some
9632         commits are removed (e.g. a line was deleted), however the
9633         rebase will still proceed. If set to "error", it will print
9634         the previous warning and stop the rebase, <em>git rebase
9635         --edit-todo</em> can then be used to correct the error. If set to
9636         "ignore", no checking is done.
9637         To drop a commit without warning or error, use the <code>drop</code>
9638         command in the todo list.
9639         Defaults to "ignore".
9640 </p>
9641 </dd>
9642 <dt class="hdlist1">
9643 rebase.instructionFormat
9644 </dt>
9645 <dd>
9646 <p>
9647         A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
9648         todo list during an interactive rebase.  The format will
9649         automatically have the long commit hash prepended to the format.
9650 </p>
9651 </dd>
9652 <dt class="hdlist1">
9653 rebase.abbreviateCommands
9654 </dt>
9655 <dd>
9656 <p>
9657         If set to true, <code>git rebase</code> will use abbreviated command names in the
9658         todo list resulting in something like this:
9659 </p>
9660 <div class="listingblock">
9661 <div class="content">
9662 <pre><code>        p deadbee The oneline of the commit
9663         p fa1afe1 The oneline of the next commit
9664         ...</code></pre>
9665 </div></div>
9666 <div class="paragraph"><p>instead of:</p></div>
9667 <div class="listingblock">
9668 <div class="content">
9669 <pre><code>        pick deadbee The oneline of the commit
9670         pick fa1afe1 The oneline of the next commit
9671         ...</code></pre>
9672 </div></div>
9673 <div class="paragraph"><p>Defaults to false.</p></div>
9674 </dd>
9675 <dt class="hdlist1">
9676 rebase.rescheduleFailedExec
9677 </dt>
9678 <dd>
9679 <p>
9680         Automatically reschedule <code>exec</code> commands that failed. This only makes
9681         sense in interactive mode (or when an <code>--exec</code> option was provided).
9682         This is the same as specifying the <code>--reschedule-failed-exec</code> option.
9683 </p>
9684 </dd>
9685 <dt class="hdlist1">
9686 rebase.forkPoint
9687 </dt>
9688 <dd>
9689 <p>
9690         If set to false set <code>--no-fork-point</code> option by default.
9691 </p>
9692 </dd>
9693 <dt class="hdlist1">
9694 rebase.rebaseMerges
9695 </dt>
9696 <dd>
9697 <p>
9698         Whether and how to set the <code>--rebase-merges</code> option by default. Can
9699         be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
9700         true or to <code>no-rebase-cousins</code> is equivalent to
9701         <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
9702         equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
9703         equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
9704         command line, with or without an argument, overrides any
9705         <code>rebase.rebaseMerges</code> configuration.
9706 </p>
9707 </dd>
9708 <dt class="hdlist1">
9709 rebase.maxLabelLength
9710 </dt>
9711 <dd>
9712 <p>
9713         When generating label names from commit subjects, truncate the names to
9714         this length. By default, the names are truncated to a little less than
9715         <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
9716         corresponding loose refs).
9717 </p>
9718 </dd>
9719 <dt class="hdlist1">
9720 receive.advertiseAtomic
9721 </dt>
9722 <dd>
9723 <p>
9724         By default, git-receive-pack will advertise the atomic push
9725         capability to its clients. If you don&#8217;t want to advertise this
9726         capability, set this variable to false.
9727 </p>
9728 </dd>
9729 <dt class="hdlist1">
9730 receive.advertisePushOptions
9731 </dt>
9732 <dd>
9733 <p>
9734         When set to true, git-receive-pack will advertise the push options
9735         capability to its clients. False by default.
9736 </p>
9737 </dd>
9738 <dt class="hdlist1">
9739 receive.autogc
9740 </dt>
9741 <dd>
9742 <p>
9743         By default, git-receive-pack will run "git-gc --auto" after
9744         receiving data from git-push and updating refs.  You can stop
9745         it by setting this variable to false.
9746 </p>
9747 </dd>
9748 <dt class="hdlist1">
9749 receive.certNonceSeed
9750 </dt>
9751 <dd>
9752 <p>
9753         By setting this variable to a string, <code>git receive-pack</code>
9754         will accept a <code>git push --signed</code> and verifies it by using
9755         a "nonce" protected by HMAC using this string as a secret
9756         key.
9757 </p>
9758 </dd>
9759 <dt class="hdlist1">
9760 receive.certNonceSlop
9761 </dt>
9762 <dd>
9763 <p>
9764         When a <code>git push --signed</code> sent a push certificate with a
9765         "nonce" that was issued by a receive-pack serving the same
9766         repository within this many seconds, export the "nonce"
9767         found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
9768         hooks (instead of what the receive-pack asked the sending
9769         side to include).  This may allow writing checks in
9770         <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
9771         checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
9772         that records by how many seconds the nonce is stale to
9773         decide if they want to accept the certificate, they only
9774         can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
9775 </p>
9776 </dd>
9777 <dt class="hdlist1">
9778 receive.fsckObjects
9779 </dt>
9780 <dd>
9781 <p>
9782         If it is set to true, git-receive-pack will check all received
9783         objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
9784         Defaults to false. If not set, the value of
9785         <code>transfer.fsckObjects</code> is used instead.
9786 </p>
9787 </dd>
9788 <dt class="hdlist1">
9789 receive.fsck.&lt;msg-id&gt;
9790 </dt>
9791 <dd>
9792 <p>
9793         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
9794         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
9795         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
9796         details.
9797 </p>
9798 </dd>
9799 <dt class="hdlist1">
9800 receive.fsck.skipList
9801 </dt>
9802 <dd>
9803 <p>
9804         Acts like <code>fsck.skipList</code>, but is used by
9805         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
9806         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
9807         details.
9808 </p>
9809 </dd>
9810 <dt class="hdlist1">
9811 receive.keepAlive
9812 </dt>
9813 <dd>
9814 <p>
9815         After receiving the pack from the client, <code>receive-pack</code> may
9816         produce no output (if <code>--quiet</code> was specified) while processing
9817         the pack, causing some networks to drop the TCP connection.
9818         With this option set, if <code>receive-pack</code> does not transmit
9819         any data in this phase for <code>receive.keepAlive</code> seconds, it will
9820         send a short keepalive packet.  The default is 5 seconds; set
9821         to 0 to disable keepalives entirely.
9822 </p>
9823 </dd>
9824 <dt class="hdlist1">
9825 receive.unpackLimit
9826 </dt>
9827 <dd>
9828 <p>
9829         If the number of objects received in a push is below this
9830         limit then the objects will be unpacked into loose object
9831         files. However if the number of received objects equals or
9832         exceeds this limit then the received pack will be stored as
9833         a pack, after adding any missing delta bases.  Storing the
9834         pack from a push can make the push operation complete faster,
9835         especially on slow filesystems.  If not set, the value of
9836         <code>transfer.unpackLimit</code> is used instead.
9837 </p>
9838 </dd>
9839 <dt class="hdlist1">
9840 receive.maxInputSize
9841 </dt>
9842 <dd>
9843 <p>
9844         If the size of the incoming pack stream is larger than this
9845         limit, then git-receive-pack will error out, instead of
9846         accepting the pack file. If not set or set to 0, then the size
9847         is unlimited.
9848 </p>
9849 </dd>
9850 <dt class="hdlist1">
9851 receive.denyDeletes
9852 </dt>
9853 <dd>
9854 <p>
9855         If set to true, git-receive-pack will deny a ref update that deletes
9856         the ref. Use this to prevent such a ref deletion via a push.
9857 </p>
9858 </dd>
9859 <dt class="hdlist1">
9860 receive.denyDeleteCurrent
9861 </dt>
9862 <dd>
9863 <p>
9864         If set to true, git-receive-pack will deny a ref update that
9865         deletes the currently checked out branch of a non-bare repository.
9866 </p>
9867 </dd>
9868 <dt class="hdlist1">
9869 receive.denyCurrentBranch
9870 </dt>
9871 <dd>
9872 <p>
9873         If set to true or "refuse", git-receive-pack will deny a ref update
9874         to the currently checked out branch of a non-bare repository.
9875         Such a push is potentially dangerous because it brings the HEAD
9876         out of sync with the index and working tree. If set to "warn",
9877         print a warning of such a push to stderr, but allow the push to
9878         proceed. If set to false or "ignore", allow such pushes with no
9879         message. Defaults to "refuse".
9880 </p>
9881 <div class="paragraph"><p>Another option is "updateInstead" which will update the working
9882 tree if pushing into the current branch.  This option is
9883 intended for synchronizing working directories when one side is not easily
9884 accessible via interactive ssh (e.g. a live web site, hence the requirement
9885 that the working directory be clean). This mode also comes in handy when
9886 developing inside a VM to test and fix code on different Operating Systems.</p></div>
9887 <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
9888 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
9889 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p></div>
9890 </dd>
9891 <dt class="hdlist1">
9892 receive.denyNonFastForwards
9893 </dt>
9894 <dd>
9895 <p>
9896         If set to true, git-receive-pack will deny a ref update which is
9897         not a fast-forward. Use this to prevent such an update via a push,
9898         even if that push is forced. This configuration variable is
9899         set when initializing a shared repository.
9900 </p>
9901 </dd>
9902 <dt class="hdlist1">
9903 receive.hideRefs
9904 </dt>
9905 <dd>
9906 <p>
9907         This variable is the same as <code>transfer.hideRefs</code>, but applies
9908         only to <code>receive-pack</code> (and so affects pushes, but not fetches).
9909         An attempt to update or delete a hidden ref by <code>git push</code> is
9910         rejected.
9911 </p>
9912 </dd>
9913 <dt class="hdlist1">
9914 receive.procReceiveRefs
9915 </dt>
9916 <dd>
9917 <p>
9918         This is a multi-valued variable that defines reference prefixes
9919         to match the commands in <code>receive-pack</code>.  Commands matching the
9920         prefixes will be executed by an external hook "proc-receive",
9921         instead of the internal <code>execute_commands</code> function.  If this
9922         variable is not defined, the "proc-receive" hook will never be
9923         used, and all commands will be executed by the internal
9924         <code>execute_commands</code> function.
9925 </p>
9926 <div class="paragraph"><p>For example, if this variable is set to "refs/for", pushing to reference
9927 such as "refs/for/master" will not create or update a reference named
9928 "refs/for/master", but may create or update a pull request directly by
9929 running the hook "proc-receive".</p></div>
9930 <div class="paragraph"><p>Optional modifiers can be provided in the beginning of the value to filter
9931 commands for specific actions: create (a), modify (m), delete (d).
9932 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
9933 E.g.:</p></div>
9934 <div class="literalblock">
9935 <div class="content">
9936 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
9937 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
9938 </div></div>
9939 </dd>
9940 <dt class="hdlist1">
9941 receive.updateServerInfo
9942 </dt>
9943 <dd>
9944 <p>
9945         If set to true, git-receive-pack will run git-update-server-info
9946         after receiving data from git-push and updating refs.
9947 </p>
9948 </dd>
9949 <dt class="hdlist1">
9950 receive.shallowUpdate
9951 </dt>
9952 <dd>
9953 <p>
9954         If set to true, .git/shallow can be updated when new refs
9955         require new shallow roots. Otherwise those refs are rejected.
9956 </p>
9957 </dd>
9958 <dt class="hdlist1">
9959 remote.pushDefault
9960 </dt>
9961 <dd>
9962 <p>
9963         The remote to push to by default.  Overrides
9964         <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
9965         <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
9966 </p>
9967 </dd>
9968 <dt class="hdlist1">
9969 remote.&lt;name&gt;.url
9970 </dt>
9971 <dd>
9972 <p>
9973         The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
9974         <a href="git-push.html">git-push(1)</a>.
9975 </p>
9976 </dd>
9977 <dt class="hdlist1">
9978 remote.&lt;name&gt;.pushurl
9979 </dt>
9980 <dd>
9981 <p>
9982         The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
9983 </p>
9984 </dd>
9985 <dt class="hdlist1">
9986 remote.&lt;name&gt;.proxy
9987 </dt>
9988 <dd>
9989 <p>
9990         For remotes that require curl (http, https and ftp), the URL to
9991         the proxy to use for that remote.  Set to the empty string to
9992         disable proxying for that remote.
9993 </p>
9994 </dd>
9995 <dt class="hdlist1">
9996 remote.&lt;name&gt;.proxyAuthMethod
9997 </dt>
9998 <dd>
9999 <p>
10000         For remotes that require curl (http, https and ftp), the method to use for
10001         authenticating against the proxy in use (probably set in
10002         <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
10003 </p>
10004 </dd>
10005 <dt class="hdlist1">
10006 remote.&lt;name&gt;.fetch
10007 </dt>
10008 <dd>
10009 <p>
10010         The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
10011         <a href="git-fetch.html">git-fetch(1)</a>.
10012 </p>
10013 </dd>
10014 <dt class="hdlist1">
10015 remote.&lt;name&gt;.push
10016 </dt>
10017 <dd>
10018 <p>
10019         The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
10020         <a href="git-push.html">git-push(1)</a>.
10021 </p>
10022 </dd>
10023 <dt class="hdlist1">
10024 remote.&lt;name&gt;.mirror
10025 </dt>
10026 <dd>
10027 <p>
10028         If true, pushing to this remote will automatically behave
10029         as if the <code>--mirror</code> option was given on the command line.
10030 </p>
10031 </dd>
10032 <dt class="hdlist1">
10033 remote.&lt;name&gt;.skipDefaultUpdate
10034 </dt>
10035 <dd>
10036 <p>
10037         If true, this remote will be skipped by default when updating
10038         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10039         <a href="git-remote.html">git-remote(1)</a>.
10040 </p>
10041 </dd>
10042 <dt class="hdlist1">
10043 remote.&lt;name&gt;.skipFetchAll
10044 </dt>
10045 <dd>
10046 <p>
10047         If true, this remote will be skipped by default when updating
10048         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10049         <a href="git-remote.html">git-remote(1)</a>.
10050 </p>
10051 </dd>
10052 <dt class="hdlist1">
10053 remote.&lt;name&gt;.receivepack
10054 </dt>
10055 <dd>
10056 <p>
10057         The default program to execute on the remote side when pushing.  See
10058         option --receive-pack of <a href="git-push.html">git-push(1)</a>.
10059 </p>
10060 </dd>
10061 <dt class="hdlist1">
10062 remote.&lt;name&gt;.uploadpack
10063 </dt>
10064 <dd>
10065 <p>
10066         The default program to execute on the remote side when fetching.  See
10067         option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
10068 </p>
10069 </dd>
10070 <dt class="hdlist1">
10071 remote.&lt;name&gt;.tagOpt
10072 </dt>
10073 <dd>
10074 <p>
10075         Setting this value to --no-tags disables automatic tag following when
10076         fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
10077         tag from remote &lt;name&gt;, even if they are not reachable from remote
10078         branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
10079         override this setting. See options --tags and --no-tags of
10080         <a href="git-fetch.html">git-fetch(1)</a>.
10081 </p>
10082 </dd>
10083 <dt class="hdlist1">
10084 remote.&lt;name&gt;.vcs
10085 </dt>
10086 <dd>
10087 <p>
10088         Setting this to a value &lt;vcs&gt; will cause Git to interact with
10089         the remote with the git-remote-&lt;vcs&gt; helper.
10090 </p>
10091 </dd>
10092 <dt class="hdlist1">
10093 remote.&lt;name&gt;.prune
10094 </dt>
10095 <dd>
10096 <p>
10097         When set to true, fetching from this remote by default will also
10098         remove any remote-tracking references that no longer exist on the
10099         remote (as if the <code>--prune</code> option was given on the command line).
10100         Overrides <code>fetch.prune</code> settings, if any.
10101 </p>
10102 </dd>
10103 <dt class="hdlist1">
10104 remote.&lt;name&gt;.pruneTags
10105 </dt>
10106 <dd>
10107 <p>
10108         When set to true, fetching from this remote by default will also
10109         remove any local tags that no longer exist on the remote if pruning
10110         is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
10111         <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10112 </p>
10113 <div class="paragraph"><p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
10114 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
10115 </dd>
10116 <dt class="hdlist1">
10117 remote.&lt;name&gt;.promisor
10118 </dt>
10119 <dd>
10120 <p>
10121         When set to true, this remote will be used to fetch promisor
10122         objects.
10123 </p>
10124 </dd>
10125 <dt class="hdlist1">
10126 remote.&lt;name&gt;.partialclonefilter
10127 </dt>
10128 <dd>
10129 <p>
10130         The filter that will be applied when fetching from this promisor remote.
10131         Changing or clearing this value will only affect fetches for new commits.
10132         To fetch associated objects for commits already present in the local object
10133         database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.
10134 </p>
10135 </dd>
10136 <dt class="hdlist1">
10137 remotes.&lt;group&gt;
10138 </dt>
10139 <dd>
10140 <p>
10141         The list of remotes which are fetched by "git remote update
10142         &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.
10143 </p>
10144 </dd>
10145 <dt class="hdlist1">
10146 repack.useDeltaBaseOffset
10147 </dt>
10148 <dd>
10149 <p>
10150         By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
10151         delta-base offset. If you need to share your repository with
10152         Git older than version 1.4.4, either directly or via a dumb
10153         protocol such as http, then you need to set this option to
10154         "false" and repack. Access from old Git versions over the
10155         native protocol are unaffected by this option.
10156 </p>
10157 </dd>
10158 <dt class="hdlist1">
10159 repack.packKeptObjects
10160 </dt>
10161 <dd>
10162 <p>
10163         If set to true, makes <code>git repack</code> act as if
10164         <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
10165         details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10166         index is being written (either via <code>--write-bitmap-index</code> or
10167         <code>repack.writeBitmaps</code>).
10168 </p>
10169 </dd>
10170 <dt class="hdlist1">
10171 repack.useDeltaIslands
10172 </dt>
10173 <dd>
10174 <p>
10175         If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10176         was passed. Defaults to <code>false</code>.
10177 </p>
10178 </dd>
10179 <dt class="hdlist1">
10180 repack.writeBitmaps
10181 </dt>
10182 <dd>
10183 <p>
10184         When true, git will write a bitmap index when packing all
10185         objects to disk (e.g., when <code>git repack -a</code> is run).  This
10186         index can speed up the "counting objects" phase of subsequent
10187         packs created for clones and fetches, at the cost of some disk
10188         space and extra time spent on the initial repack.  This has
10189         no effect if multiple packfiles are created.
10190         Defaults to true on bare repos, false otherwise.
10191 </p>
10192 </dd>
10193 <dt class="hdlist1">
10194 repack.updateServerInfo
10195 </dt>
10196 <dd>
10197 <p>
10198         If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
10199         <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10200         when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.
10201 </p>
10202 </dd>
10203 <dt class="hdlist1">
10204 repack.cruftWindow
10205 </dt>
10206 <dt class="hdlist1">
10207 repack.cruftWindowMemory
10208 </dt>
10209 <dt class="hdlist1">
10210 repack.cruftDepth
10211 </dt>
10212 <dt class="hdlist1">
10213 repack.cruftThreads
10214 </dt>
10215 <dd>
10216 <p>
10217         Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
10218         a cruft pack and the respective parameters are not given over
10219         the command line. See similarly named <code>pack.*</code> configuration
10220         variables for defaults and meaning.
10221 </p>
10222 </dd>
10223 <dt class="hdlist1">
10224 rerere.autoUpdate
10225 </dt>
10226 <dd>
10227 <p>
10228         When set to true, <code>git-rerere</code> updates the index with the
10229         resulting contents after it cleanly resolves conflicts using
10230         previously recorded resolution.  Defaults to false.
10231 </p>
10232 </dd>
10233 <dt class="hdlist1">
10234 rerere.enabled
10235 </dt>
10236 <dd>
10237 <p>
10238         Activate recording of resolved conflicts, so that identical
10239         conflict hunks can be resolved automatically, should they be
10240         encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
10241         enabled if there is an <code>rr-cache</code> directory under the
10242         <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
10243         repository.
10244 </p>
10245 </dd>
10246 <dt class="hdlist1">
10247 revert.reference
10248 </dt>
10249 <dd>
10250 <p>
10251         Setting this variable to true makes <code>git revert</code> behave
10252         as if the <code>--reference</code> option is given.
10253 </p>
10254 </dd>
10255 <dt class="hdlist1">
10256 safe.bareRepository
10257 </dt>
10258 <dd>
10259 <p>
10260         Specifies which bare repositories Git will work with. The currently
10261         supported values are:
10262 </p>
10263 <div class="ulist"><ul>
10264 <li>
10265 <p>
10266 <code>all</code>: Git works with all bare repositories. This is the default.
10267 </p>
10268 </li>
10269 <li>
10270 <p>
10271 <code>explicit</code>: Git only works with bare repositories specified via
10272   the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10273   environment variable (see <a href="git.html">git(1)</a>).
10274 </p>
10275 <div class="paragraph"><p>If you do not use bare repositories in your workflow, then it may be
10276 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10277 config. This will protect you from attacks that involve cloning a
10278 repository that contains a bare repository and running a Git command
10279 within that directory.</p></div>
10280 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10281 <a href="#SCOPES">[SCOPES]</a>). This prevents the untrusted repository from tampering with
10282 this value.</p></div>
10283 </li>
10284 </ul></div>
10285 </dd>
10286 <dt class="hdlist1">
10287 safe.directory
10288 </dt>
10289 <dd>
10290 <p>
10291         These config entries specify Git-tracked directories that are
10292         considered safe even if they are owned by someone other than the
10293         current user. By default, Git will refuse to even parse a Git
10294         config of a repository owned by someone else, let alone run its
10295         hooks, and this config setting allows users to specify exceptions,
10296         e.g. for intentionally shared repositories (see the <code>--shared</code>
10297         option in <a href="git-init.html">git-init(1)</a>).
10298 </p>
10299 <div class="paragraph"><p>This is a multi-valued setting, i.e. you can add more than one directory
10300 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10301 override any such directories specified in the system config), add a
10302 <code>safe.directory</code> entry with an empty value.</p></div>
10303 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10304 <a href="#SCOPES">[SCOPES]</a>). This prevents the untrusted repository from tampering with this
10305 value.</p></div>
10306 <div class="paragraph"><p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
10307 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
10308 path relative to Git&#8217;s (runtime) prefix.</p></div>
10309 <div class="paragraph"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10310 string <code>*</code>. This will allow all repositories to be treated as if their
10311 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10312 is set in system config and you want to re-enable this protection, then
10313 initialize your list with an empty value before listing the repositories
10314 that you deem safe.</p></div>
10315 <div class="paragraph"><p>As explained, Git only allows you to access repositories owned by
10316 yourself, i.e. the user who is running Git, by default.  When Git
10317 is running as <em>root</em> in a non Windows platform that provides sudo,
10318 however, git checks the SUDO_UID environment variable that sudo creates
10319 and will allow access to the uid recorded as its value in addition to
10320 the id from <em>root</em>.
10321 This is to make it easy to perform a common sequence during installation
10322 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
10323 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
10324 which id the original user has.
10325 If that is not what you would prefer and want git to only trust
10326 repositories that are owned by root instead, then you can remove
10327 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p></div>
10328 </dd>
10329 <dt class="hdlist1">
10330 sendemail.identity
10331 </dt>
10332 <dd>
10333 <p>
10334         A configuration identity. When given, causes values in the
10335         <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
10336         values in the <em>sendemail</em> section. The default identity is
10337         the value of <code>sendemail.identity</code>.
10338 </p>
10339 </dd>
10340 <dt class="hdlist1">
10341 sendemail.smtpEncryption
10342 </dt>
10343 <dd>
10344 <p>
10345         See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
10346         setting is not subject to the <em>identity</em> mechanism.
10347 </p>
10348 </dd>
10349 <dt class="hdlist1">
10350 sendemail.smtpsslcertpath
10351 </dt>
10352 <dd>
10353 <p>
10354         Path to ca-certificates (either a directory or a single file).
10355         Set it to an empty string to disable certificate verification.
10356 </p>
10357 </dd>
10358 <dt class="hdlist1">
10359 sendemail.&lt;identity&gt;.*
10360 </dt>
10361 <dd>
10362 <p>
10363         Identity-specific versions of the <em>sendemail.*</em> parameters
10364         found below, taking precedence over those when this
10365         identity is selected, through either the command-line or
10366         <code>sendemail.identity</code>.
10367 </p>
10368 </dd>
10369 <dt class="hdlist1">
10370 sendemail.multiEdit
10371 </dt>
10372 <dd>
10373 <p>
10374         If true (default), a single editor instance will be spawned to edit
10375         files you have to edit (patches when <code>--annotate</code> is used, and the
10376         summary when <code>--compose</code> is used). If false, files will be edited one
10377         after the other, spawning a new editor each time.
10378 </p>
10379 </dd>
10380 <dt class="hdlist1">
10381 sendemail.confirm
10382 </dt>
10383 <dd>
10384 <p>
10385         Sets the default for whether to confirm before sending. Must be
10386         one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
10387         in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
10388         values.
10389 </p>
10390 </dd>
10391 <dt class="hdlist1">
10392 sendemail.aliasesFile
10393 </dt>
10394 <dd>
10395 <p>
10396         To avoid typing long email addresses, point this to one or more
10397         email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.
10398 </p>
10399 </dd>
10400 <dt class="hdlist1">
10401 sendemail.aliasFileType
10402 </dt>
10403 <dd>
10404 <p>
10405         Format of the file(s) specified in sendemail.aliasesFile. Must be
10406         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, or <em>gnus</em>, or <em>sendmail</em>.
10407 </p>
10408 <div class="paragraph"><p>What an alias file in each format looks like can be found in
10409 the documentation of the email program of the same name. The
10410 differences and limitations from the standard formats are
10411 described below:</p></div>
10412 <div class="openblock">
10413 <div class="content">
10414 <div class="dlist"><dl>
10415 <dt class="hdlist1">
10416 sendmail
10417 </dt>
10418 <dd>
10419 <div class="ulist"><ul>
10420 <li>
10421 <p>
10422 Quoted aliases and quoted addresses are not supported: lines that
10423         contain a <code>"</code> symbol are ignored.
10424 </p>
10425 </li>
10426 <li>
10427 <p>
10428 Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
10429         supported.
10430 </p>
10431 </li>
10432 <li>
10433 <p>
10434 File inclusion (<code>:include: /path/name</code>) is not supported.
10435 </p>
10436 </li>
10437 <li>
10438 <p>
10439 Warnings are printed on the standard error output for any
10440         explicitly unsupported constructs, and any other lines that are not
10441         recognized by the parser.
10442 </p>
10443 </li>
10444 </ul></div>
10445 </dd>
10446 </dl></div>
10447 </div></div>
10448 </dd>
10449 <dt class="hdlist1">
10450 sendemail.annotate
10451 </dt>
10452 <dt class="hdlist1">
10453 sendemail.bcc
10454 </dt>
10455 <dt class="hdlist1">
10456 sendemail.cc
10457 </dt>
10458 <dt class="hdlist1">
10459 sendemail.ccCmd
10460 </dt>
10461 <dt class="hdlist1">
10462 sendemail.chainReplyTo
10463 </dt>
10464 <dt class="hdlist1">
10465 sendemail.envelopeSender
10466 </dt>
10467 <dt class="hdlist1">
10468 sendemail.from
10469 </dt>
10470 <dt class="hdlist1">
10471 sendemail.headerCmd
10472 </dt>
10473 <dt class="hdlist1">
10474 sendemail.signedoffbycc
10475 </dt>
10476 <dt class="hdlist1">
10477 sendemail.smtpPass
10478 </dt>
10479 <dt class="hdlist1">
10480 sendemail.suppresscc
10481 </dt>
10482 <dt class="hdlist1">
10483 sendemail.suppressFrom
10484 </dt>
10485 <dt class="hdlist1">
10486 sendemail.to
10487 </dt>
10488 <dt class="hdlist1">
10489 sendemail.tocmd
10490 </dt>
10491 <dt class="hdlist1">
10492 sendemail.smtpDomain
10493 </dt>
10494 <dt class="hdlist1">
10495 sendemail.smtpServer
10496 </dt>
10497 <dt class="hdlist1">
10498 sendemail.smtpServerPort
10499 </dt>
10500 <dt class="hdlist1">
10501 sendemail.smtpServerOption
10502 </dt>
10503 <dt class="hdlist1">
10504 sendemail.smtpUser
10505 </dt>
10506 <dt class="hdlist1">
10507 sendemail.thread
10508 </dt>
10509 <dt class="hdlist1">
10510 sendemail.transferEncoding
10511 </dt>
10512 <dt class="hdlist1">
10513 sendemail.validate
10514 </dt>
10515 <dt class="hdlist1">
10516 sendemail.xmailer
10517 </dt>
10518 <dd>
10519 <p>
10520         These configuration variables all provide a default for
10521         <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
10522         documentation for details.
10523 </p>
10524 </dd>
10525 <dt class="hdlist1">
10526 sendemail.signedoffcc (deprecated)
10527 </dt>
10528 <dd>
10529 <p>
10530         Deprecated alias for <code>sendemail.signedoffbycc</code>.
10531 </p>
10532 </dd>
10533 <dt class="hdlist1">
10534 sendemail.smtpBatchSize
10535 </dt>
10536 <dd>
10537 <p>
10538         Number of messages to be sent per connection, after that a relogin
10539         will happen.  If the value is 0 or undefined, send all messages in
10540         one connection.
10541         See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10542 </p>
10543 </dd>
10544 <dt class="hdlist1">
10545 sendemail.smtpReloginDelay
10546 </dt>
10547 <dd>
10548 <p>
10549         Seconds wait before reconnecting to smtp server.
10550         See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10551 </p>
10552 </dd>
10553 <dt class="hdlist1">
10554 sendemail.forbidSendmailVariables
10555 </dt>
10556 <dd>
10557 <p>
10558         To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
10559         will abort with a warning if any configuration options for "sendmail"
10560         exist. Set this variable to bypass the check.
10561 </p>
10562 </dd>
10563 <dt class="hdlist1">
10564 sequence.editor
10565 </dt>
10566 <dd>
10567 <p>
10568         Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
10569         The value is meant to be interpreted by the shell when it is used.
10570         It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
10571         When not configured the default commit message editor is used instead.
10572 </p>
10573 </dd>
10574 <dt class="hdlist1">
10575 showBranch.default
10576 </dt>
10577 <dd>
10578 <p>
10579         The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
10580         See <a href="git-show-branch.html">git-show-branch(1)</a>.
10581 </p>
10582 </dd>
10583 <dt class="hdlist1">
10584 sparse.expectFilesOutsideOfPatterns
10585 </dt>
10586 <dd>
10587 <p>
10588         Typically with sparse checkouts, files not matching any
10589         sparsity patterns are marked with a SKIP_WORKTREE bit in the
10590         index and are missing from the working tree.  Accordingly, Git
10591         will ordinarily check whether files with the SKIP_WORKTREE bit
10592         are in fact present in the working tree contrary to
10593         expectations.  If Git finds any, it marks those paths as
10594         present by clearing the relevant SKIP_WORKTREE bits.  This
10595         option can be used to tell Git that such
10596         present-despite-skipped files are expected and to stop
10597         checking for them.
10598 </p>
10599 <div class="paragraph"><p>The default is <code>false</code>, which allows Git to automatically recover
10600 from the list of files in the index and working tree falling out of
10601 sync.</p></div>
10602 <div class="paragraph"><p>Set this to <code>true</code> if you are in a setup where some external factor
10603 relieves Git of the responsibility for maintaining the consistency
10604 between the presence of working tree files and sparsity patterns.  For
10605 example, if you have a Git-aware virtual file system that has a robust
10606 mechanism for keeping the working tree and the sparsity patterns up to
10607 date based on access patterns.</p></div>
10608 <div class="paragraph"><p>Regardless of this setting, Git does not check for
10609 present-despite-skipped files unless sparse checkout is enabled, so
10610 this config option has no effect unless <code>core.sparseCheckout</code> is
10611 <code>true</code>.</p></div>
10612 </dd>
10613 <dt class="hdlist1">
10614 splitIndex.maxPercentChange
10615 </dt>
10616 <dd>
10617 <p>
10618         When the split index feature is used, this specifies the
10619         percent of entries the split index can contain compared to the
10620         total number of entries in both the split index and the shared
10621         index before a new shared index is written.
10622         The value should be between 0 and 100. If the value is 0 then
10623         a new shared index is always written, if it is 100 a new
10624         shared index is never written.
10625         By default the value is 20, so a new shared index is written
10626         if the number of entries in the split index would be greater
10627         than 20 percent of the total number of entries.
10628         See <a href="git-update-index.html">git-update-index(1)</a>.
10629 </p>
10630 </dd>
10631 <dt class="hdlist1">
10632 splitIndex.sharedIndexExpire
10633 </dt>
10634 <dd>
10635 <p>
10636         When the split index feature is used, shared index files that
10637         were not modified since the time this variable specifies will
10638         be removed when a new shared index file is created. The value
10639         "now" expires all entries immediately, and "never" suppresses
10640         expiration altogether.
10641         The default value is "2.weeks.ago".
10642         Note that a shared index file is considered modified (for the
10643         purpose of expiration) each time a new split-index file is
10644         either created based on it or read from it.
10645         See <a href="git-update-index.html">git-update-index(1)</a>.
10646 </p>
10647 </dd>
10648 <dt class="hdlist1">
10649 ssh.variant
10650 </dt>
10651 <dd>
10652 <p>
10653         By default, Git determines the command line arguments to use
10654         based on the basename of the configured SSH command (configured
10655         using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
10656         the config setting <code>core.sshCommand</code>). If the basename is
10657         unrecognized, Git will attempt to detect support of OpenSSH
10658         options by first invoking the configured SSH command with the
10659         <code>-G</code> (print configuration) option and will subsequently use
10660         OpenSSH options (if that is successful) or no options besides
10661         the host and remote command (if it fails).
10662 </p>
10663 <div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this detection.
10664 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
10665 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
10666 The default auto-detection can be explicitly requested using the value
10667 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
10668 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
10669 <div class="paragraph"><p>The current command-line parameters used for each variant are as
10670 follows:</p></div>
10671 <div class="openblock">
10672 <div class="content">
10673 <div class="ulist"><ul>
10674 <li>
10675 <p>
10676 <code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command
10677 </p>
10678 </li>
10679 <li>
10680 <p>
10681 <code>simple</code> - [username@]host command
10682 </p>
10683 </li>
10684 <li>
10685 <p>
10686 <code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command
10687 </p>
10688 </li>
10689 <li>
10690 <p>
10691 <code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command
10692 </p>
10693 </li>
10694 </ul></div>
10695 </div></div>
10696 <div class="paragraph"><p>Except for the <code>simple</code> variant, command-line parameters are likely to
10697 change as git gains new features.</p></div>
10698 </dd>
10699 <dt class="hdlist1">
10700 status.relativePaths
10701 </dt>
10702 <dd>
10703 <p>
10704         By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
10705         current directory. Setting this variable to <code>false</code> shows paths
10706         relative to the repository root (this was the default for Git
10707         prior to v1.5.4).
10708 </p>
10709 </dd>
10710 <dt class="hdlist1">
10711 status.short
10712 </dt>
10713 <dd>
10714 <p>
10715         Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
10716         The option --no-short takes precedence over this variable.
10717 </p>
10718 </dd>
10719 <dt class="hdlist1">
10720 status.branch
10721 </dt>
10722 <dd>
10723 <p>
10724         Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
10725         The option --no-branch takes precedence over this variable.
10726 </p>
10727 </dd>
10728 <dt class="hdlist1">
10729 status.aheadBehind
10730 </dt>
10731 <dd>
10732 <p>
10733         Set to true to enable <code>--ahead-behind</code> and false to enable
10734         <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
10735         non-porcelain status formats.  Defaults to true.
10736 </p>
10737 </dd>
10738 <dt class="hdlist1">
10739 status.displayCommentPrefix
10740 </dt>
10741 <dd>
10742 <p>
10743         If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
10744         prefix before each output line (starting with
10745         <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
10746         behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
10747         Defaults to false.
10748 </p>
10749 </dd>
10750 <dt class="hdlist1">
10751 status.renameLimit
10752 </dt>
10753 <dd>
10754 <p>
10755         The number of files to consider when performing rename detection
10756         in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
10757         the value of diff.renameLimit.
10758 </p>
10759 </dd>
10760 <dt class="hdlist1">
10761 status.renames
10762 </dt>
10763 <dd>
10764 <p>
10765         Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
10766         <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
10767         disabled. If set to "true", basic rename detection is enabled.
10768         If set to "copies" or "copy", Git will detect copies, as well.
10769         Defaults to the value of diff.renames.
10770 </p>
10771 </dd>
10772 <dt class="hdlist1">
10773 status.showStash
10774 </dt>
10775 <dd>
10776 <p>
10777         If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
10778         entries currently stashed away.
10779         Defaults to false.
10780 </p>
10781 </dd>
10782 <dt class="hdlist1">
10783 status.showUntrackedFiles
10784 </dt>
10785 <dd>
10786 <p>
10787         By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
10788         files which are not currently tracked by Git. Directories which
10789         contain only untracked files, are shown with the directory name
10790         only. Showing untracked files means that Git needs to lstat() all
10791         the files in the whole repository, which might be slow on some
10792         systems. So, this variable controls how the commands displays
10793         the untracked files. Possible values are:
10794 </p>
10795 <div class="openblock">
10796 <div class="content">
10797 <div class="ulist"><ul>
10798 <li>
10799 <p>
10800 <code>no</code> - Show no untracked files.
10801 </p>
10802 </li>
10803 <li>
10804 <p>
10805 <code>normal</code> - Show untracked files and directories.
10806 </p>
10807 </li>
10808 <li>
10809 <p>
10810 <code>all</code> - Show also individual files in untracked directories.
10811 </p>
10812 </li>
10813 </ul></div>
10814 </div></div>
10815 <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
10816 This variable can be overridden with the -u|--untracked-files option
10817 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
10818 </dd>
10819 <dt class="hdlist1">
10820 status.submoduleSummary
10821 </dt>
10822 <dd>
10823 <p>
10824         Defaults to false.
10825         If this is set to a non zero number or true (identical to -1 or an
10826         unlimited number), the submodule summary will be enabled and a
10827         summary of commits for modified submodules will be shown (see
10828         --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
10829         that the summary output command will be suppressed for all
10830         submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
10831         for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
10832         exception to that rule is that status and commit will show staged
10833         submodule changes. To
10834         also view the summary for ignored submodules you can either use
10835         the --ignore-submodules=dirty command-line option or the <em>git
10836         submodule summary</em> command, which shows a similar output but does
10837         not honor these settings.
10838 </p>
10839 </dd>
10840 <dt class="hdlist1">
10841 stash.showIncludeUntracked
10842 </dt>
10843 <dd>
10844 <p>
10845         If this is set to true, the <code>git stash show</code> command will show
10846         the untracked files of a stash entry.  Defaults to false. See
10847         description of <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10848 </p>
10849 </dd>
10850 <dt class="hdlist1">
10851 stash.showPatch
10852 </dt>
10853 <dd>
10854 <p>
10855         If this is set to true, the <code>git stash show</code> command without an
10856         option will show the stash entry in patch form.  Defaults to false.
10857         See description of <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10858 </p>
10859 </dd>
10860 <dt class="hdlist1">
10861 stash.showStat
10862 </dt>
10863 <dd>
10864 <p>
10865         If this is set to true, the <code>git stash show</code> command without an
10866         option will show diffstat of the stash entry.  Defaults to true.
10867         See description of <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10868 </p>
10869 </dd>
10870 <dt class="hdlist1">
10871 submodule.&lt;name&gt;.url
10872 </dt>
10873 <dd>
10874 <p>
10875         The URL for a submodule. This variable is copied from the .gitmodules
10876         file to the git config via <em>git submodule init</em>. The user can change
10877         the configured URL before obtaining the submodule via <em>git submodule
10878         update</em>. If neither submodule.&lt;name&gt;.active or submodule.active are
10879         set, the presence of this variable is used as a fallback to indicate
10880         whether the submodule is of interest to git commands.
10881         See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
10882 </p>
10883 </dd>
10884 <dt class="hdlist1">
10885 submodule.&lt;name&gt;.update
10886 </dt>
10887 <dd>
10888 <p>
10889         The method by which a submodule is updated by <em>git submodule update</em>,
10890         which is the only affected command, others such as
10891         <em>git checkout --recurse-submodules</em> are unaffected. It exists for
10892         historical reasons, when <em>git submodule</em> was the only command to
10893         interact with submodules; settings like <code>submodule.active</code>
10894         and <code>pull.rebase</code> are more specific. It is populated by
10895         <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
10896         See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.
10897 </p>
10898 </dd>
10899 <dt class="hdlist1">
10900 submodule.&lt;name&gt;.branch
10901 </dt>
10902 <dd>
10903 <p>
10904         The remote branch name for a submodule, used by <code>git submodule
10905         update --remote</code>.  Set this option to override the value found in
10906         the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
10907         <a href="gitmodules.html">gitmodules(5)</a> for details.
10908 </p>
10909 </dd>
10910 <dt class="hdlist1">
10911 submodule.&lt;name&gt;.fetchRecurseSubmodules
10912 </dt>
10913 <dd>
10914 <p>
10915         This option can be used to control recursive fetching of this
10916         submodule. It can be overridden by using the --[no-]recurse-submodules
10917         command-line option to "git fetch" and "git pull".
10918         This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
10919         file.
10920 </p>
10921 </dd>
10922 <dt class="hdlist1">
10923 submodule.&lt;name&gt;.ignore
10924 </dt>
10925 <dd>
10926 <p>
10927         Defines under what circumstances "git status" and the diff family show
10928         a submodule as modified. When set to "all", it will never be considered
10929         modified (but it will nonetheless show up in the output of status and
10930         commit when it has been staged), "dirty" will ignore all changes
10931         to the submodules work tree and
10932         takes only differences between the HEAD of the submodule and the commit
10933         recorded in the superproject into account. "untracked" will additionally
10934         let submodules with modified tracked files in their work tree show up.
10935         Using "none" (the default when this option is not set) also shows
10936         submodules that have untracked files in their work tree as changed.
10937         This setting overrides any setting made in .gitmodules for this submodule,
10938         both settings can be overridden on the command line by using the
10939         "--ignore-submodules" option. The <em>git submodule</em> commands are not
10940         affected by this setting.
10941 </p>
10942 </dd>
10943 <dt class="hdlist1">
10944 submodule.&lt;name&gt;.active
10945 </dt>
10946 <dd>
10947 <p>
10948         Boolean value indicating if the submodule is of interest to git
10949         commands.  This config option takes precedence over the
10950         submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
10951         details.
10952 </p>
10953 </dd>
10954 <dt class="hdlist1">
10955 submodule.active
10956 </dt>
10957 <dd>
10958 <p>
10959         A repeated field which contains a pathspec used to match against a
10960         submodule&#8217;s path to determine if the submodule is of interest to git
10961         commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.
10962 </p>
10963 </dd>
10964 <dt class="hdlist1">
10965 submodule.recurse
10966 </dt>
10967 <dd>
10968 <p>
10969         A boolean indicating if commands should enable the <code>--recurse-submodules</code>
10970         option by default. Defaults to false.
10971 </p>
10972 <div class="paragraph"><p>When set to true, it can be deactivated via the
10973 <code>--no-recurse-submodules</code> option. Note that some Git commands
10974 lacking this option may call some of the above commands affected by
10975 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
10976 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
10977 For these commands a workaround is to temporarily change the
10978 configuration value by using <code>git -c submodule.recurse=0</code>.</p></div>
10979 <div class="paragraph"><p>The following list shows the commands that accept
10980 <code>--recurse-submodules</code> and whether they are supported by this
10981 setting.</p></div>
10982 <div class="ulist"><ul>
10983 <li>
10984 <p>
10985 <code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
10986 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.
10987 </p>
10988 </li>
10989 <li>
10990 <p>
10991 <code>clone</code> and <code>ls-files</code> are not supported.
10992 </p>
10993 </li>
10994 <li>
10995 <p>
10996 <code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
10997 enabled
10998 </p>
10999 </li>
11000 </ul></div>
11001 </dd>
11002 <dt class="hdlist1">
11003 submodule.propagateBranches
11004 </dt>
11005 <dd>
11006 <p>
11007         [EXPERIMENTAL] A boolean that enables branching support when
11008         using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
11009         Enabling this will allow certain commands to accept
11010         <code>--recurse-submodules</code> and certain commands that already accept
11011         <code>--recurse-submodules</code> will now consider branches.
11012         Defaults to false.
11013 </p>
11014 </dd>
11015 <dt class="hdlist1">
11016 submodule.fetchJobs
11017 </dt>
11018 <dd>
11019 <p>
11020         Specifies how many submodules are fetched/cloned at the same time.
11021         A positive integer allows up to that number of submodules fetched
11022         in parallel. A value of 0 will give some reasonable default.
11023         If unset, it defaults to 1.
11024 </p>
11025 </dd>
11026 <dt class="hdlist1">
11027 submodule.alternateLocation
11028 </dt>
11029 <dd>
11030 <p>
11031         Specifies how the submodules obtain alternates when submodules are
11032         cloned. Possible values are <code>no</code>, <code>superproject</code>.
11033         By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
11034         value is set to <code>superproject</code> the submodule to be cloned computes
11035         its alternates location relative to the superprojects alternate.
11036 </p>
11037 </dd>
11038 <dt class="hdlist1">
11039 submodule.alternateErrorStrategy
11040 </dt>
11041 <dd>
11042 <p>
11043         Specifies how to treat errors with the alternates for a submodule
11044         as computed via <code>submodule.alternateLocation</code>. Possible values are
11045         <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
11046         or <code>info</code>, and if there is an error with the computed alternate, the
11047         clone proceeds as if no alternate was specified.
11048 </p>
11049 </dd>
11050 <dt class="hdlist1">
11051 tag.forceSignAnnotated
11052 </dt>
11053 <dd>
11054 <p>
11055         A boolean to specify whether annotated tags created should be GPG signed.
11056         If <code>--annotate</code> is specified on the command line, it takes
11057         precedence over this option.
11058 </p>
11059 </dd>
11060 <dt class="hdlist1">
11061 tag.sort
11062 </dt>
11063 <dd>
11064 <p>
11065         This variable controls the sort ordering of tags when displayed by
11066         <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
11067         value of this variable will be used as the default.
11068 </p>
11069 </dd>
11070 <dt class="hdlist1">
11071 tag.gpgSign
11072 </dt>
11073 <dd>
11074 <p>
11075         A boolean to specify whether all tags should be GPG signed.
11076         Use of this option when running in an automated script can
11077         result in a large number of tags being signed. It is therefore
11078         convenient to use an agent to avoid typing your gpg passphrase
11079         several times. Note that this option doesn&#8217;t affect tag signing
11080         behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.
11081 </p>
11082 </dd>
11083 <dt class="hdlist1">
11084 tar.umask
11085 </dt>
11086 <dd>
11087 <p>
11088         This variable can be used to restrict the permission bits of
11089         tar archive entries.  The default is 0002, which turns off the
11090         world write bit.  The special value "user" indicates that the
11091         archiving user&#8217;s umask will be used instead.  See umask(2) and
11092         <a href="git-archive.html">git-archive(1)</a>.
11093 </p>
11094 </dd>
11095 </dl></div>
11096 <div class="paragraph"><p>Trace2 config settings are only read from the system and global
11097 config files; repository local and worktree config files and <code>-c</code>
11098 command line arguments are not respected.</p></div>
11099 <div class="dlist"><dl>
11100 <dt class="hdlist1">
11101 trace2.normalTarget
11102 </dt>
11103 <dd>
11104 <p>
11105         This variable controls the normal target destination.
11106         It may be overridden by the <code>GIT_TRACE2</code> environment variable.
11107         The following table shows possible values.
11108 </p>
11109 </dd>
11110 <dt class="hdlist1">
11111 trace2.perfTarget
11112 </dt>
11113 <dd>
11114 <p>
11115         This variable controls the performance target destination.
11116         It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
11117         The following table shows possible values.
11118 </p>
11119 </dd>
11120 <dt class="hdlist1">
11121 trace2.eventTarget
11122 </dt>
11123 <dd>
11124 <p>
11125         This variable controls the event target destination.
11126         It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
11127         The following table shows possible values.
11128 </p>
11129 <div class="openblock">
11130 <div class="content">
11131 <div class="ulist"><ul>
11132 <li>
11133 <p>
11134 <code>0</code> or <code>false</code> - Disables the target.
11135 </p>
11136 </li>
11137 <li>
11138 <p>
11139 <code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.
11140 </p>
11141 </li>
11142 <li>
11143 <p>
11144 <code>[2-9]</code> - Writes to the already opened file descriptor.
11145 </p>
11146 </li>
11147 <li>
11148 <p>
11149 <code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
11150 already exists and is a directory, the traces will be written to files (one
11151 per process) underneath the given directory.
11152 </p>
11153 </li>
11154 <li>
11155 <p>
11156 <code>af_unix:[&lt;socket_type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
11157 Unix DomainSocket (on platforms that support them).  Socket
11158 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
11159 try both.
11160 </p>
11161 </li>
11162 </ul></div>
11163 </div></div>
11164 </dd>
11165 <dt class="hdlist1">
11166 trace2.normalBrief
11167 </dt>
11168 <dd>
11169 <p>
11170         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11171         omitted from normal output.  May be overridden by the
11172         <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.
11173 </p>
11174 </dd>
11175 <dt class="hdlist1">
11176 trace2.perfBrief
11177 </dt>
11178 <dd>
11179 <p>
11180         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11181         omitted from PERF output.  May be overridden by the
11182         <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.
11183 </p>
11184 </dd>
11185 <dt class="hdlist1">
11186 trace2.eventBrief
11187 </dt>
11188 <dd>
11189 <p>
11190         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11191         omitted from event output.  May be overridden by the
11192         <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.
11193 </p>
11194 </dd>
11195 <dt class="hdlist1">
11196 trace2.eventNesting
11197 </dt>
11198 <dd>
11199 <p>
11200         Integer.  Specifies desired depth of nested regions in the
11201         event output.  Regions deeper than this value will be
11202         omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
11203         environment variable.  Defaults to 2.
11204 </p>
11205 </dd>
11206 <dt class="hdlist1">
11207 trace2.configParams
11208 </dt>
11209 <dd>
11210 <p>
11211         A comma-separated list of patterns of "important" config
11212         settings that should be recorded in the trace2 output.
11213         For example, <code>core.*,remote.*.url</code> would cause the trace2
11214         output to contain events listing each configured remote.
11215         May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
11216         variable.  Unset by default.
11217 </p>
11218 </dd>
11219 <dt class="hdlist1">
11220 trace2.envVars
11221 </dt>
11222 <dd>
11223 <p>
11224         A comma-separated list of "important" environment variables that should
11225         be recorded in the trace2 output.  For example,
11226         <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
11227         contain events listing the overrides for HTTP user agent and the
11228         location of the Git configuration file (assuming any are set).  May be
11229         overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
11230         default.
11231 </p>
11232 </dd>
11233 <dt class="hdlist1">
11234 trace2.destinationDebug
11235 </dt>
11236 <dd>
11237 <p>
11238         Boolean.  When true Git will print error messages when a
11239         trace target destination cannot be opened for writing.
11240         By default, these errors are suppressed and tracing is
11241         silently disabled.  May be overridden by the
11242         <code>GIT_TRACE2_DST_DEBUG</code> environment variable.
11243 </p>
11244 </dd>
11245 <dt class="hdlist1">
11246 trace2.maxFiles
11247 </dt>
11248 <dd>
11249 <p>
11250         Integer.  When writing trace files to a target directory, do not
11251         write additional traces if we would exceed this many files. Instead,
11252         write a sentinel file that will block further tracing to this
11253         directory. Defaults to 0, which disables this check.
11254 </p>
11255 </dd>
11256 <dt class="hdlist1">
11257 transfer.credentialsInUrl
11258 </dt>
11259 <dd>
11260 <p>
11261         A configured URL can contain plaintext credentials in the form
11262         <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
11263         to warn or forbid the use of such configuration (in favor of
11264         using <a href="git-credential.html">git-credential(1)</a>). This will be used on
11265         <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>,
11266         and any other direct use of the configured URL.
11267 </p>
11268 <div class="paragraph"><p>Note that this is currently limited to detecting credentials in
11269 <code>remote.&lt;name&gt;.url</code> configuration, it won&#8217;t detect credentials in
11270 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p></div>
11271 <div class="paragraph"><p>You might want to enable this to prevent inadvertent credentials
11272 exposure, e.g. because:</p></div>
11273 <div class="ulist"><ul>
11274 <li>
11275 <p>
11276 The OS or system where you&#8217;re running git may not provide a way or
11277   otherwise allow you to configure the permissions of the
11278   configuration file where the username and/or password are stored.
11279 </p>
11280 </li>
11281 <li>
11282 <p>
11283 Even if it does, having such data stored "at rest" might expose you
11284   in other ways, e.g. a backup process might copy the data to another
11285   system.
11286 </p>
11287 </li>
11288 <li>
11289 <p>
11290 The git programs will pass the full URL to one another as arguments
11291   on the command-line, meaning the credentials will be exposed to other
11292   users on OS&#8217;s or systems that allow other users to see the full
11293   process list of other users. On linux the "hidepid" setting
11294   documented in procfs(5) allows for configuring this behavior.
11295 </p>
11296 <div class="paragraph"><p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
11297 concerned about credentials exposure due to storing that sensitive
11298 data in git&#8217;s configuration files. If you do want to use this, set
11299 <code>transfer.credentialsInUrl</code> to one of these values:</p></div>
11300 </li>
11301 <li>
11302 <p>
11303 <code>allow</code> (default): Git will proceed with its activity without warning.
11304 </p>
11305 </li>
11306 <li>
11307 <p>
11308 <code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
11309   with a plaintext credential.
11310 </p>
11311 </li>
11312 <li>
11313 <p>
11314 <code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
11315   with a plaintext credential.
11316 </p>
11317 </li>
11318 </ul></div>
11319 </dd>
11320 <dt class="hdlist1">
11321 transfer.fsckObjects
11322 </dt>
11323 <dd>
11324 <p>
11325         When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
11326         not set, the value of this variable is used instead.
11327         Defaults to false.
11328 </p>
11329 <div class="paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
11330 object or a link to a nonexistent object. In addition, various other
11331 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
11332 and potential security issues like the existence of a <code>.GIT</code> directory
11333 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
11334 and v2.17.1 for details). Other sanity and security checks may be
11335 added in future releases.</p></div>
11336 <div class="paragraph"><p>On the receiving side, failing fsckObjects will make those objects
11337 unreachable, see "QUARANTINE ENVIRONMENT" in
11338 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
11339 instead be left unreferenced in the repository.</p></div>
11340 <div class="paragraph"><p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
11341 implementation it cannot be relied upon to leave the object store
11342 clean like <code>receive.fsckObjects</code> can.</p></div>
11343 <div class="paragraph"><p>As objects are unpacked they&#8217;re written to the object store, so there
11344 can be cases where malicious objects get introduced even though the
11345 "fetch" failed, only to have a subsequent "fetch" succeed because only
11346 new incoming objects are checked, not those that have already been
11347 written to the object store. That difference in behavior should not be
11348 relied upon. In the future, such objects may be quarantined for
11349 "fetch" as well.</p></div>
11350 <div class="paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
11351 environment if they&#8217;d like the same protection as "push". E.g. in the
11352 case of an internal mirror do the mirroring in two steps, one to fetch
11353 the untrusted objects, and then do a second "push" (which will use the
11354 quarantine) to another internal repo, and have internal clients
11355 consume this pushed-to repository, or embargo internal fetches and
11356 only allow them once a full "fsck" has run (and no new fetches have
11357 happened in the meantime).</p></div>
11358 </dd>
11359 <dt class="hdlist1">
11360 transfer.hideRefs
11361 </dt>
11362 <dd>
11363 <p>
11364         String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
11365         refs to omit from their initial advertisements.  Use more than
11366         one definition to specify multiple prefix strings. A ref that is
11367         under the hierarchies listed in the value of this variable is
11368         excluded, and is hidden when responding to <code>git push</code> or <code>git
11369         fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
11370         program-specific versions of this config.
11371 </p>
11372 <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
11373 explicitly exposing it, even if an earlier entry marked it as hidden.
11374 If you have multiple hideRefs values, later entries override earlier ones
11375 (and entries in more-specific config files override less-specific ones).</p></div>
11376 <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
11377 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
11378 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
11379 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
11380 <div class="paragraph"><p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
11381 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
11382 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
11383 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
11384 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
11385 <code>receive-pack</code>, on the other hand, will still advertise the object id the
11386 ref is pointing to without mentioning its name (a so-called ".have" line).</p></div>
11387 <div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
11388 objects via the techniques described in the "SECURITY" section of the
11389 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
11390 separate repository.</p></div>
11391 </dd>
11392 <dt class="hdlist1">
11393 transfer.unpackLimit
11394 </dt>
11395 <dd>
11396 <p>
11397         When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
11398         not set, the value of this variable is used instead.
11399         The default value is 100.
11400 </p>
11401 </dd>
11402 <dt class="hdlist1">
11403 transfer.advertiseSID
11404 </dt>
11405 <dd>
11406 <p>
11407         Boolean. When true, client and server processes will advertise their
11408         unique session IDs to their remote counterpart. Defaults to false.
11409 </p>
11410 </dd>
11411 <dt class="hdlist1">
11412 transfer.bundleURI
11413 </dt>
11414 <dd>
11415 <p>
11416         When <code>true</code>, local <code>git clone</code> commands will request bundle
11417         information from the remote server (if advertised) and download
11418         bundles before continuing the clone through the Git protocol.
11419         Defaults to <code>false</code>.
11420 </p>
11421 </dd>
11422 <dt class="hdlist1">
11423 uploadarchive.allowUnreachable
11424 </dt>
11425 <dd>
11426 <p>
11427         If true, allow clients to use <code>git archive --remote</code> to request
11428         any tree, whether reachable from the ref tips or not. See the
11429         discussion in the "SECURITY" section of
11430         <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
11431         <code>false</code>.
11432 </p>
11433 </dd>
11434 <dt class="hdlist1">
11435 uploadpack.hideRefs
11436 </dt>
11437 <dd>
11438 <p>
11439         This variable is the same as <code>transfer.hideRefs</code>, but applies
11440         only to <code>upload-pack</code> (and so affects only fetches, not pushes).
11441         An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
11442         also <code>uploadpack.allowTipSHA1InWant</code>.
11443 </p>
11444 </dd>
11445 <dt class="hdlist1">
11446 uploadpack.allowTipSHA1InWant
11447 </dt>
11448 <dd>
11449 <p>
11450         When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
11451         to accept a fetch request that asks for an object at the tip
11452         of a hidden ref (by default, such a request is rejected).
11453         See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
11454         may be able to steal objects via the techniques described in the
11455         "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
11456         best to keep private data in a separate repository.
11457 </p>
11458 </dd>
11459 <dt class="hdlist1">
11460 uploadpack.allowReachableSHA1InWant
11461 </dt>
11462 <dd>
11463 <p>
11464         Allow <code>upload-pack</code> to accept a fetch request that asks for an
11465         object that is reachable from any ref tip. However, note that
11466         calculating object reachability is computationally expensive.
11467         Defaults to <code>false</code>.  Even if this is false, a client may be able
11468         to steal objects via the techniques described in the "SECURITY"
11469         section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
11470         keep private data in a separate repository.
11471 </p>
11472 </dd>
11473 <dt class="hdlist1">
11474 uploadpack.allowAnySHA1InWant
11475 </dt>
11476 <dd>
11477 <p>
11478         Allow <code>upload-pack</code> to accept a fetch request that asks for any
11479         object at all.
11480         Defaults to <code>false</code>.
11481 </p>
11482 </dd>
11483 <dt class="hdlist1">
11484 uploadpack.keepAlive
11485 </dt>
11486 <dd>
11487 <p>
11488         When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
11489         quiet period while <code>pack-objects</code> prepares the pack. Normally
11490         it would output progress information, but if <code>--quiet</code> was used
11491         for the fetch, <code>pack-objects</code> will output nothing at all until
11492         the pack data begins. Some clients and networks may consider
11493         the server to be hung and give up. Setting this option instructs
11494         <code>upload-pack</code> to send an empty keepalive packet every
11495         <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
11496         disables keepalive packets entirely. The default is 5 seconds.
11497 </p>
11498 </dd>
11499 <dt class="hdlist1">
11500 uploadpack.packObjectsHook
11501 </dt>
11502 <dd>
11503 <p>
11504         If this option is set, when <code>upload-pack</code> would run
11505         <code>git pack-objects</code> to create a packfile for a client, it will
11506         run this shell command instead.  The <code>pack-objects</code> command and
11507         arguments it <em>would</em> have run (including the <code>git pack-objects</code>
11508         at the beginning) are appended to the shell command. The stdin
11509         and stdout of the hook are treated as if <code>pack-objects</code> itself
11510         was run. I.e., <code>upload-pack</code> will feed input intended for
11511         <code>pack-objects</code> to the hook, and expects a completed packfile on
11512         stdout.
11513 </p>
11514 <div class="paragraph"><p>Note that this configuration variable is only respected when it is specified
11515 in protected configuration (see <a href="#SCOPES">[SCOPES]</a>). This is a safety measure
11516 against fetching from untrusted repositories.</p></div>
11517 </dd>
11518 <dt class="hdlist1">
11519 uploadpack.allowFilter
11520 </dt>
11521 <dd>
11522 <p>
11523         If this option is set, <code>upload-pack</code> will support partial
11524         clone and partial fetch object filtering.
11525 </p>
11526 </dd>
11527 <dt class="hdlist1">
11528 uploadpackfilter.allow
11529 </dt>
11530 <dd>
11531 <p>
11532         Provides a default value for unspecified object filters (see: the
11533         below configuration variable). If set to <code>true</code>, this will also
11534         enable all filters which get added in the future.
11535         Defaults to <code>true</code>.
11536 </p>
11537 </dd>
11538 <dt class="hdlist1">
11539 uploadpackfilter.&lt;filter&gt;.allow
11540 </dt>
11541 <dd>
11542 <p>
11543         Explicitly allow or ban the object filter corresponding to
11544         <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
11545         <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
11546         If using combined filters, both <code>combine</code> and all of the nested
11547         filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.
11548 </p>
11549 </dd>
11550 <dt class="hdlist1">
11551 uploadpackfilter.tree.maxDepth
11552 </dt>
11553 <dd>
11554 <p>
11555         Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
11556         <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
11557         <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
11558         variable had already been set. Has no effect if unset.
11559 </p>
11560 </dd>
11561 <dt class="hdlist1">
11562 uploadpack.allowRefInWant
11563 </dt>
11564 <dd>
11565 <p>
11566         If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
11567         feature of the protocol version 2 <code>fetch</code> command.  This feature
11568         is intended for the benefit of load-balanced servers which may
11569         not have the same view of what OIDs their refs point to due to
11570         replication delay.
11571 </p>
11572 </dd>
11573 <dt class="hdlist1">
11574 url.&lt;base&gt;.insteadOf
11575 </dt>
11576 <dd>
11577 <p>
11578         Any URL that starts with this value will be rewritten to
11579         start, instead, with &lt;base&gt;. In cases where some site serves a
11580         large number of repositories, and serves them with multiple
11581         access methods, and some users need to use different access
11582         methods, this feature allows people to specify any of the
11583         equivalent URLs and have Git automatically rewrite the URL to
11584         the best alternative for the particular user, even for a
11585         never-before-seen repository on the site.  When more than one
11586         insteadOf strings match a given URL, the longest match is used.
11587 </p>
11588 <div class="paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
11589 URL. If the rewrite changes the URL to use a custom protocol or remote
11590 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
11591 the request.  In particular, protocols you expect to use for submodules
11592 must be set to <code>always</code> rather than the default of <code>user</code>. See the
11593 description of <code>protocol.allow</code> above.</p></div>
11594 </dd>
11595 <dt class="hdlist1">
11596 url.&lt;base&gt;.pushInsteadOf
11597 </dt>
11598 <dd>
11599 <p>
11600         Any URL that starts with this value will not be pushed to;
11601         instead, it will be rewritten to start with &lt;base&gt;, and the
11602         resulting URL will be pushed to. In cases where some site serves
11603         a large number of repositories, and serves them with multiple
11604         access methods, some of which do not allow push, this feature
11605         allows people to specify a pull-only URL and have Git
11606         automatically use an appropriate URL to push, even for a
11607         never-before-seen repository on the site.  When more than one
11608         pushInsteadOf strings match a given URL, the longest match is
11609         used.  If a remote has an explicit pushurl, Git will ignore this
11610         setting for that remote.
11611 </p>
11612 </dd>
11613 <dt class="hdlist1">
11614 user.name
11615 </dt>
11616 <dt class="hdlist1">
11617 user.email
11618 </dt>
11619 <dt class="hdlist1">
11620 author.name
11621 </dt>
11622 <dt class="hdlist1">
11623 author.email
11624 </dt>
11625 <dt class="hdlist1">
11626 committer.name
11627 </dt>
11628 <dt class="hdlist1">
11629 committer.email
11630 </dt>
11631 <dd>
11632 <p>
11633         The <code>user.name</code> and <code>user.email</code> variables determine what ends
11634         up in the <code>author</code> and <code>committer</code> field of commit
11635         objects.
11636         If you need the <code>author</code> or <code>committer</code> to be different, the
11637         <code>author.name</code>, <code>author.email</code>, <code>committer.name</code> or
11638         <code>committer.email</code> variables can be set.
11639         Also, all of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
11640         <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
11641         <code>GIT_COMMITTER_EMAIL</code> and <code>EMAIL</code> environment variables.
11642 </p>
11643 <div class="paragraph"><p>Note that the <code>name</code> forms of these variables conventionally refer to
11644 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
11645 environment variables section of <a href="git.html">git(1)</a> for more information on
11646 these settings and the <code>credential.username</code> option if you&#8217;re looking
11647 for authentication credentials instead.</p></div>
11648 </dd>
11649 <dt class="hdlist1">
11650 user.useConfigOnly
11651 </dt>
11652 <dd>
11653 <p>
11654         Instruct Git to avoid trying to guess defaults for <code>user.email</code>
11655         and <code>user.name</code>, and instead retrieve the values only from the
11656         configuration. For example, if you have multiple email addresses
11657         and would like to use a different one for each repository, then
11658         with this configuration option set to <code>true</code> in the global config
11659         along with a name, Git will prompt you to set up an email before
11660         making new commits in a newly cloned repository.
11661         Defaults to <code>false</code>.
11662 </p>
11663 </dd>
11664 <dt class="hdlist1">
11665 user.signingKey
11666 </dt>
11667 <dd>
11668 <p>
11669         If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
11670         key you want it to automatically when creating a signed tag or
11671         commit, you can override the default selection with this variable.
11672         This option is passed unchanged to gpg&#8217;s --local-user parameter,
11673         so you may specify a key using any method that gpg supports.
11674         If gpg.format is set to <code>ssh</code> this can contain the path to either
11675         your private ssh key or the public key when ssh-agent is used.
11676         Alternatively it can contain a public key prefixed with <code>key::</code>
11677         directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
11678         needs to be available via ssh-agent. If not set git will call
11679         gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
11680         first key available. For backward compatibility, a raw key which
11681         begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
11682         as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
11683         use the <code>key::</code> form instead.
11684 </p>
11685 </dd>
11686 <dt class="hdlist1">
11687 versionsort.prereleaseSuffix (deprecated)
11688 </dt>
11689 <dd>
11690 <p>
11691         Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
11692         <code>versionsort.suffix</code> is set.
11693 </p>
11694 </dd>
11695 <dt class="hdlist1">
11696 versionsort.suffix
11697 </dt>
11698 <dd>
11699 <p>
11700         Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
11701         with the same base version but different suffixes are still sorted
11702         lexicographically, resulting e.g. in prerelease tags appearing
11703         after the main release (e.g. "1.0-rc1" after "1.0").  This
11704         variable can be specified to determine the sorting order of tags
11705         with different suffixes.
11706 </p>
11707 <div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
11708 that suffix will appear before the corresponding main release.  E.g. if
11709 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
11710 "1.0".  If specified multiple times, once per suffix, then the order of
11711 suffixes in the configuration will determine the sorting order of tagnames
11712 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
11713 configuration, then all "1.0-preX" tags will be listed before any
11714 "1.0-rcX" tags.  The placement of the main release tag relative to tags
11715 with various suffixes can be determined by specifying the empty suffix
11716 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
11717 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
11718 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
11719 "v4.8-bfsX".</p></div>
11720 <div class="paragraph"><p>If more than one suffixes match the same tagname, then that tagname will
11721 be sorted according to the suffix which starts at the earliest position in
11722 the tagname.  If more than one different matching suffixes start at
11723 that earliest position, then that tagname will be sorted according to the
11724 longest of those suffixes.
11725 The sorting order between different suffixes is undefined if they are
11726 in multiple config files.</p></div>
11727 </dd>
11728 <dt class="hdlist1">
11729 web.browser
11730 </dt>
11731 <dd>
11732 <p>
11733         Specify a web browser that may be used by some commands.
11734         Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
11735         may use it.
11736 </p>
11737 </dd>
11738 <dt class="hdlist1">
11739 worktree.guessRemote
11740 </dt>
11741 <dd>
11742 <p>
11743         If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
11744         <code>--detach</code> is used, then <code>git worktree add</code> defaults to
11745         creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
11746         set to true, <code>worktree add</code> tries to find a remote-tracking
11747         branch whose name uniquely matches the new branch name.  If
11748         such a branch exists, it is checked out and set as "upstream"
11749         for the new branch.  If no such match can be found, it falls
11750         back to creating a new branch from the current HEAD.
11751 </p>
11752 </dd>
11753 </dl></div>
11754 </div>
11755 </div>
11756 </div>
11757 <div class="sect1">
11758 <h2 id="_bugs">BUGS</h2>
11759 <div class="sectionbody">
11760 <div class="paragraph"><p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
11761 will result in adding a multi-line key instead of a change, if the subsection
11762 is given with at least one uppercase character. For example when the config
11763 looks like</p></div>
11764 <div class="listingblock">
11765 <div class="content">
11766 <pre><code>  [section.subsection]
11767     key = value1</code></pre>
11768 </div></div>
11769 <div class="paragraph"><p>and running <code>git config section.Subsection.key value2</code> will result in</p></div>
11770 <div class="listingblock">
11771 <div class="content">
11772 <pre><code>  [section.subsection]
11773     key = value1
11774     key = value2</code></pre>
11775 </div></div>
11776 </div>
11777 </div>
11778 <div class="sect1">
11779 <h2 id="_git">GIT</h2>
11780 <div class="sectionbody">
11781 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
11782 </div>
11783 </div>
11784 </div>
11785 <div id="footnotes"><hr /></div>
11786 <div id="footer">
11787 <div id="footer-text">
11788 Last updated
11789  2022-07-22 15:56:51 PDT
11790 </div>
11791 </div>
11792 </body>
11793 </html>