git-config.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-config(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-config(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-config -
 743    Get and set repository or global options
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] &lt;name&gt; [&lt;value&gt; [&lt;value-pattern&gt;]]
 753 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] --add &lt;name&gt; &lt;value&gt;
 754 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--fixed-value] --replace-all &lt;name&gt; &lt;value&gt; [&lt;value-pattern&gt;]
 755 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get &lt;name&gt; [&lt;value-pattern&gt;]
 756 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all &lt;name&gt; [&lt;value-pattern&gt;]
 757 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp &lt;name-regex&gt; [&lt;value-pattern&gt;]
 758 <em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [-z|--null] --get-urlmatch &lt;name&gt; &lt;URL&gt;
 759 <em>git config</em> [&lt;file-option&gt;] [--fixed-value] --unset &lt;name&gt; [&lt;value-pattern&gt;]
 760 <em>git config</em> [&lt;file-option&gt;] [--fixed-value] --unset-all &lt;name&gt; [&lt;value-pattern&gt;]
 761 <em>git config</em> [&lt;file-option&gt;] --rename-section &lt;old-name&gt; &lt;new-name&gt;
 762 <em>git config</em> [&lt;file-option&gt;] --remove-section &lt;name&gt;
 763 <em>git config</em> [&lt;file-option&gt;] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
 764 <em>git config</em> [&lt;file-option&gt;] --get-color &lt;name&gt; [&lt;default&gt;]
 765 <em>git config</em> [&lt;file-option&gt;] --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]
 766 <em>git config</em> [&lt;file-option&gt;] -e | --edit</pre>
 767 <div class="attribution">
 768 </div></div>
 769 </div>
 770 </div>
 771 <div class="sect1">
 772 <h2 id="_description">DESCRIPTION</h2>
 773 <div class="sectionbody">
 774 <div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is
 775 actually the section and the key separated by a dot, and the value will be
 776 escaped.</p></div>
 777 <div class="paragraph"><p>Multiple lines can be added to an option by using the <code>--add</code> option.
 778 If you want to update or unset an option which can occur on multiple
 779 lines, a <code>value-pattern</code> (which is an extended regular expression,
 780 unless the <code>--fixed-value</code> option is given) needs to be given.  Only the
 781 existing values that match the pattern are updated or unset.  If
 782 you want to handle the lines that do <strong>not</strong> match the pattern, just
 783 prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>),
 784 but note that this only works when the <code>--fixed-value</code> option is not
 785 in use.</p></div>
 786 <div class="paragraph"><p>The <code>--type=&lt;type&gt;</code> option instructs <em>git config</em> to ensure that incoming and
 787 outgoing values are canonicalize-able under the given &lt;type&gt;.  If no
 788 <code>--type=&lt;type&gt;</code> is given, no canonicalization will be performed. Callers may
 789 unset an existing <code>--type</code> specifier with <code>--no-type</code>.</p></div>
 790 <div class="paragraph"><p>When reading, the values are read from the system, global and
 791 repository local configuration files by default, and options
 792 <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code> and
 793 <code>--file &lt;filename&gt;</code> can be used to tell the command to read from only
 794 that location (see <a href="#FILES">[FILES]</a>).</p></div>
 795 <div class="paragraph"><p>When writing, the new value is written to the repository local
 796 configuration file by default, and options <code>--system</code>, <code>--global</code>,
 797 <code>--worktree</code>, <code>--file &lt;filename&gt;</code> can be used to tell the command to
 798 write to that location (you can say <code>--local</code> but that is the
 799 default).</p></div>
 800 <div class="paragraph"><p>This command will fail with non-zero status upon error.  Some exit
 801 codes are:</p></div>
 802 <div class="ulist"><ul>
 803 <li>
 804 <p>
 805 The section or key is invalid (ret=1),
 806 </p>
 807 </li>
 808 <li>
 809 <p>
 810 no section or name was provided (ret=2),
 811 </p>
 812 </li>
 813 <li>
 814 <p>
 815 the config file is invalid (ret=3),
 816 </p>
 817 </li>
 818 <li>
 819 <p>
 820 the config file cannot be written (ret=4),
 821 </p>
 822 </li>
 823 <li>
 824 <p>
 825 you try to unset an option which does not exist (ret=5),
 826 </p>
 827 </li>
 828 <li>
 829 <p>
 830 you try to unset/set an option for which multiple lines match (ret=5), or
 831 </p>
 832 </li>
 833 <li>
 834 <p>
 835 you try to use an invalid regexp (ret=6).
 836 </p>
 837 </li>
 838 </ul></div>
 839 <div class="paragraph"><p>On success, the command returns the exit code 0.</p></div>
 840 <div class="paragraph"><p>A list of all available configuration variables can be obtained using the
 841 <code>git help --config</code> command.</p></div>
 842 </div>
 843 </div>
 844 <div class="sect1">
 845 <h2 id="OPTIONS">OPTIONS</h2>
 846 <div class="sectionbody">
 847 <div class="dlist"><dl>
 848 <dt class="hdlist1">
 849 --replace-all
 850 </dt>
 851 <dd>
 852 <p>
 853         Default behavior is to replace at most one line. This replaces
 854         all lines matching the key (and optionally the <code>value-pattern</code>).
 855 </p>
 856 </dd>
 857 <dt class="hdlist1">
 858 --add
 859 </dt>
 860 <dd>
 861 <p>
 862         Adds a new line to the option without altering any existing
 863         values.  This is the same as providing <em>^$</em> as the <code>value-pattern</code>
 864         in <code>--replace-all</code>.
 865 </p>
 866 </dd>
 867 <dt class="hdlist1">
 868 --get
 869 </dt>
 870 <dd>
 871 <p>
 872         Get the value for a given key (optionally filtered by a regex
 873         matching the value). Returns error code 1 if the key was not
 874         found and the last value if multiple key values were found.
 875 </p>
 876 </dd>
 877 <dt class="hdlist1">
 878 --get-all
 879 </dt>
 880 <dd>
 881 <p>
 882         Like get, but returns all values for a multi-valued key.
 883 </p>
 884 </dd>
 885 <dt class="hdlist1">
 886 --get-regexp
 887 </dt>
 888 <dd>
 889 <p>
 890         Like --get-all, but interprets the name as a regular expression and
 891         writes out the key names.  Regular expression matching is currently
 892         case-sensitive and done against a canonicalized version of the key
 893         in which section and variable names are lowercased, but subsection
 894         names are not.
 895 </p>
 896 </dd>
 897 <dt class="hdlist1">
 898 --get-urlmatch &lt;name&gt; &lt;URL&gt;
 899 </dt>
 900 <dd>
 901 <p>
 902         When given a two-part &lt;name&gt; as &lt;section&gt;.&lt;key&gt;, the value for
 903         &lt;section&gt;.&lt;URL&gt;.&lt;key&gt; whose &lt;URL&gt; part matches the best to the
 904         given URL is returned (if no such key exists, the value for
 905         &lt;section&gt;.&lt;key&gt; is used as a fallback).  When given just the
 906         &lt;section&gt; as name, do so for all the keys in the section and
 907         list them.  Returns error code 1 if no value is found.
 908 </p>
 909 </dd>
 910 <dt class="hdlist1">
 911 --global
 912 </dt>
 913 <dd>
 914 <p>
 915         For writing options: write to global <code>~/.gitconfig</code> file
 916         rather than the repository <code>.git/config</code>, write to
 917         <code>$XDG_CONFIG_HOME/git/config</code> file if this file exists and the
 918         <code>~/.gitconfig</code> file doesn&#8217;t.
 919 </p>
 920 <div class="paragraph"><p>For reading options: read only from global <code>~/.gitconfig</code> and from
 921 <code>$XDG_CONFIG_HOME/git/config</code> rather than from all available files.</p></div>
 922 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 923 </dd>
 924 <dt class="hdlist1">
 925 --system
 926 </dt>
 927 <dd>
 928 <p>
 929         For writing options: write to system-wide
 930         <code>$(prefix)/etc/gitconfig</code> rather than the repository
 931         <code>.git/config</code>.
 932 </p>
 933 <div class="paragraph"><p>For reading options: read only from system-wide <code>$(prefix)/etc/gitconfig</code>
 934 rather than from all available files.</p></div>
 935 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 936 </dd>
 937 <dt class="hdlist1">
 938 --local
 939 </dt>
 940 <dd>
 941 <p>
 942         For writing options: write to the repository <code>.git/config</code> file.
 943         This is the default behavior.
 944 </p>
 945 <div class="paragraph"><p>For reading options: read only from the repository <code>.git/config</code> rather than
 946 from all available files.</p></div>
 947 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 948 </dd>
 949 <dt class="hdlist1">
 950 --worktree
 951 </dt>
 952 <dd>
 953 <p>
 954         Similar to <code>--local</code> except that <code>$GIT_DIR/config.worktree</code> is
 955         read from or written to if <code>extensions.worktreeConfig</code> is
 956         enabled. If not it&#8217;s the same as <code>--local</code>. Note that <code>$GIT_DIR</code>
 957         is equal to <code>$GIT_COMMON_DIR</code> for the main working tree, but is of
 958         the form <code>$GIT_DIR/worktrees/&lt;id&gt;/</code> for other working trees. See
 959         <a href="git-worktree.html">git-worktree(1)</a> to learn how to enable
 960         <code>extensions.worktreeConfig</code>.
 961 </p>
 962 </dd>
 963 <dt class="hdlist1">
 964 -f &lt;config-file&gt;
 965 </dt>
 966 <dt class="hdlist1">
 967 --file &lt;config-file&gt;
 968 </dt>
 969 <dd>
 970 <p>
 971         For writing options: write to the specified file rather than the
 972         repository <code>.git/config</code>.
 973 </p>
 974 <div class="paragraph"><p>For reading options: read only from the specified file rather than from all
 975 available files.</p></div>
 976 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
 977 </dd>
 978 <dt class="hdlist1">
 979 --blob &lt;blob&gt;
 980 </dt>
 981 <dd>
 982 <p>
 983         Similar to <code>--file</code> but use the given blob instead of a file. E.g.
 984         you can use <em>master:.gitmodules</em> to read values from the file
 985         <em>.gitmodules</em> in the master branch. See "SPECIFYING REVISIONS"
 986         section in <a href="gitrevisions.html">gitrevisions(7)</a> for a more complete list of
 987         ways to spell blob names.
 988 </p>
 989 </dd>
 990 <dt class="hdlist1">
 991 --remove-section
 992 </dt>
 993 <dd>
 994 <p>
 995         Remove the given section from the configuration file.
 996 </p>
 997 </dd>
 998 <dt class="hdlist1">
 999 --rename-section
1000 </dt>
1001 <dd>
1002 <p>
1003         Rename the given section to a new name.
1004 </p>
1005 </dd>
1006 <dt class="hdlist1">
1007 --unset
1008 </dt>
1009 <dd>
1010 <p>
1011         Remove the line matching the key from config file.
1012 </p>
1013 </dd>
1014 <dt class="hdlist1">
1015 --unset-all
1016 </dt>
1017 <dd>
1018 <p>
1019         Remove all lines matching the key from config file.
1020 </p>
1021 </dd>
1022 <dt class="hdlist1">
1023 -l
1024 </dt>
1025 <dt class="hdlist1">
1026 --list
1027 </dt>
1028 <dd>
1029 <p>
1030         List all variables set in config file, along with their values.
1031 </p>
1032 </dd>
1033 <dt class="hdlist1">
1034 --fixed-value
1035 </dt>
1036 <dd>
1037 <p>
1038         When used with the <code>value-pattern</code> argument, treat <code>value-pattern</code> as
1039         an exact string instead of a regular expression. This will restrict
1040         the name/value pairs that are matched to only those where the value
1041         is exactly equal to the <code>value-pattern</code>.
1042 </p>
1043 </dd>
1044 <dt class="hdlist1">
1045 --type &lt;type&gt;
1046 </dt>
1047 <dd>
1048 <p>
1049   <em>git config</em> will ensure that any input or output is valid under the given
1050   type constraint(s), and will canonicalize outgoing values in <code>&lt;type&gt;</code>'s
1051   canonical form.
1052 </p>
1053 <div class="paragraph"><p>Valid <code>&lt;type&gt;</code>'s include:</p></div>
1054 <div class="ulist"><ul>
1055 <li>
1056 <p>
1057 <em>bool</em>: canonicalize values as either "true" or "false".
1058 </p>
1059 </li>
1060 <li>
1061 <p>
1062 <em>int</em>: canonicalize values as simple decimal numbers. An optional suffix of
1063   <em>k</em>, <em>m</em>, or <em>g</em> will cause the value to be multiplied by 1024, 1048576, or
1064   1073741824 upon input.
1065 </p>
1066 </li>
1067 <li>
1068 <p>
1069 <em>bool-or-int</em>: canonicalize according to either <em>bool</em> or <em>int</em>, as described
1070   above.
1071 </p>
1072 </li>
1073 <li>
1074 <p>
1075 <em>path</em>: canonicalize by expanding a leading <code>~</code> to the value of <code>$HOME</code> and
1076   <code>~user</code> to the home directory for the specified user. This specifier has no
1077   effect when setting the value (but you can use <code>git config section.variable
1078   ~/</code> from the command line to let your shell do the expansion.)
1079 </p>
1080 </li>
1081 <li>
1082 <p>
1083 <em>expiry-date</em>: canonicalize by converting from a fixed or relative date-string
1084   to a timestamp. This specifier has no effect when setting the value.
1085 </p>
1086 </li>
1087 <li>
1088 <p>
1089 <em>color</em>: When getting a value, canonicalize by converting to an ANSI color
1090   escape sequence. When setting a value, a sanity-check is performed to ensure
1091   that the given value is canonicalize-able as an ANSI color, but it is written
1092   as-is.
1093 </p>
1094 </li>
1095 </ul></div>
1096 </dd>
1097 <dt class="hdlist1">
1098 --bool
1099 </dt>
1100 <dt class="hdlist1">
1101 --int
1102 </dt>
1103 <dt class="hdlist1">
1104 --bool-or-int
1105 </dt>
1106 <dt class="hdlist1">
1107 --path
1108 </dt>
1109 <dt class="hdlist1">
1110 --expiry-date
1111 </dt>
1112 <dd>
1113 <p>
1114   Historical options for selecting a type specifier. Prefer instead <code>--type</code>
1115   (see above).
1116 </p>
1117 </dd>
1118 <dt class="hdlist1">
1119 --no-type
1120 </dt>
1121 <dd>
1122 <p>
1123   Un-sets the previously set type specifier (if one was previously set). This
1124   option requests that <em>git config</em> not canonicalize the retrieved variable.
1125   <code>--no-type</code> has no effect without <code>--type=&lt;type&gt;</code> or <code>--&lt;type&gt;</code>.
1126 </p>
1127 </dd>
1128 <dt class="hdlist1">
1129 -z
1130 </dt>
1131 <dt class="hdlist1">
1132 --null
1133 </dt>
1134 <dd>
1135 <p>
1136         For all options that output values and/or keys, always
1137         end values with the null character (instead of a
1138         newline). Use newline instead as a delimiter between
1139         key and value. This allows for secure parsing of the
1140         output without getting confused e.g. by values that
1141         contain line breaks.
1142 </p>
1143 </dd>
1144 <dt class="hdlist1">
1145 --name-only
1146 </dt>
1147 <dd>
1148 <p>
1149         Output only the names of config variables for <code>--list</code> or
1150         <code>--get-regexp</code>.
1151 </p>
1152 </dd>
1153 <dt class="hdlist1">
1154 --show-origin
1155 </dt>
1156 <dd>
1157 <p>
1158         Augment the output of all queried config options with the
1159         origin type (file, standard input, blob, command line) and
1160         the actual origin (config file path, ref, or blob id if
1161         applicable).
1162 </p>
1163 </dd>
1164 <dt class="hdlist1">
1165 --show-scope
1166 </dt>
1167 <dd>
1168 <p>
1169         Similar to <code>--show-origin</code> in that it augments the output of
1170         all queried config options with the scope of that value
1171         (worktree, local, global, system, command).
1172 </p>
1173 </dd>
1174 <dt class="hdlist1">
1175 --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]
1176 </dt>
1177 <dd>
1178 <p>
1179         Find the color setting for <code>&lt;name&gt;</code> (e.g. <code>color.diff</code>) and output
1180         "true" or "false".  <code>&lt;stdout-is-tty&gt;</code> should be either "true" or
1181         "false", and is taken into account when configuration says
1182         "auto".  If <code>&lt;stdout-is-tty&gt;</code> is missing, then checks the standard
1183         output of the command itself, and exits with status 0 if color
1184         is to be used, or exits with status 1 otherwise.
1185         When the color setting for <code>name</code> is undefined, the command uses
1186         <code>color.ui</code> as fallback.
1187 </p>
1188 </dd>
1189 <dt class="hdlist1">
1190 --get-color &lt;name&gt; [&lt;default&gt;]
1191 </dt>
1192 <dd>
1193 <p>
1194         Find the color configured for <code>name</code> (e.g. <code>color.diff.new</code>) and
1195         output it as the ANSI color escape sequence to the standard
1196         output.  The optional <code>default</code> parameter is used instead, if
1197         there is no color configured for <code>name</code>.
1198 </p>
1199 <div class="paragraph"><p><code>--type=color [--default=&lt;default&gt;]</code> is preferred over <code>--get-color</code>
1200 (but note that <code>--get-color</code> will omit the trailing newline printed by
1201 <code>--type=color</code>).</p></div>
1202 </dd>
1203 <dt class="hdlist1">
1204 -e
1205 </dt>
1206 <dt class="hdlist1">
1207 --edit
1208 </dt>
1209 <dd>
1210 <p>
1211         Opens an editor to modify the specified config file; either
1212         <code>--system</code>, <code>--global</code>, or repository (default).
1213 </p>
1214 </dd>
1215 <dt class="hdlist1">
1216 --[no-]includes
1217 </dt>
1218 <dd>
1219 <p>
1220         Respect <code>include.*</code> directives in config files when looking up
1221         values. Defaults to <code>off</code> when a specific file is given (e.g.,
1222         using <code>--file</code>, <code>--global</code>, etc) and <code>on</code> when searching all
1223         config files.
1224 </p>
1225 </dd>
1226 <dt class="hdlist1">
1227 --default &lt;value&gt;
1228 </dt>
1229 <dd>
1230 <p>
1231   When using <code>--get</code>, and the requested variable is not found, behave as if
1232   &lt;value&gt; were the value assigned to the that variable.
1233 </p>
1234 </dd>
1235 </dl></div>
1236 </div>
1237 </div>
1238 <div class="sect1">
1239 <h2 id="_configuration">CONFIGURATION</h2>
1240 <div class="sectionbody">
1241 <div class="paragraph"><p><code>pager.config</code> is only respected when listing configuration, i.e., when
1242 using <code>--list</code> or any of the <code>--get-*</code> which may return multiple results.
1243 The default is to use a pager.</p></div>
1244 </div>
1245 </div>
1246 <div class="sect1">
1247 <h2 id="FILES">FILES</h2>
1248 <div class="sectionbody">
1249 <div class="paragraph"><p>By default, <em>git config</em> will read configuration options from multiple
1250 files:</p></div>
1251 <div class="dlist"><dl>
1252 <dt class="hdlist1">
1253 $(prefix)/etc/gitconfig
1254 </dt>
1255 <dd>
1256 <p>
1257         System-wide configuration file.
1258 </p>
1259 </dd>
1260 <dt class="hdlist1">
1261 $XDG_CONFIG_HOME/git/config
1262 </dt>
1263 <dt class="hdlist1">
1264 ~/.gitconfig
1265 </dt>
1266 <dd>
1267 <p>
1268         User-specific configuration files. When the XDG_CONFIG_HOME environment
1269         variable is not set or empty, $HOME/.config/ is used as
1270         $XDG_CONFIG_HOME.
1271 </p>
1272 <div class="paragraph"><p>These are also called "global" configuration files. If both files exist, both
1273 files are read in the order given above.</p></div>
1274 </dd>
1275 <dt class="hdlist1">
1276 $GIT_DIR/config
1277 </dt>
1278 <dd>
1279 <p>
1280         Repository specific configuration file.
1281 </p>
1282 </dd>
1283 <dt class="hdlist1">
1284 $GIT_DIR/config.worktree
1285 </dt>
1286 <dd>
1287 <p>
1288         This is optional and is only searched when
1289         <code>extensions.worktreeConfig</code> is present in $GIT_DIR/config.
1290 </p>
1291 </dd>
1292 </dl></div>
1293 <div class="paragraph"><p>You may also provide additional configuration parameters when running any
1294 git command by using the <code>-c</code> option. See <a href="git.html">git(1)</a> for details.</p></div>
1295 <div class="paragraph"><p>Options will be read from all of these files that are available. If the
1296 global or the system-wide configuration files are missing or unreadable they
1297 will be ignored. If the repository configuration file is missing or unreadable,
1298 <em>git config</em> will exit with a non-zero error code. An error message is produced
1299 if the file is unreadable, but not if it is missing.</p></div>
1300 <div class="paragraph"><p>The files are read in the order given above, with last value found taking
1301 precedence over values read earlier.  When multiple values are taken then all
1302 values of a key from all files will be used.</p></div>
1303 <div class="paragraph"><p>By default, options are only written to the repository specific
1304 configuration file. Note that this also affects options like <code>--replace-all</code>
1305 and <code>--unset</code>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
1306 <div class="paragraph"><p>You can limit which configuration sources are read from or written to by
1307 specifying the path of a file with the <code>--file</code> option, or by specifying a
1308 configuration scope with <code>--system</code>, <code>--global</code>, <code>--local</code>, or <code>--worktree</code>.
1309 For more, see <a href="#OPTIONS">[OPTIONS]</a> above.</p></div>
1310 </div>
1311 </div>
1312 <div class="sect1">
1313 <h2 id="SCOPES">SCOPES</h2>
1314 <div class="sectionbody">
1315 <div class="paragraph"><p>Each configuration source falls within a configuration scope. The scopes
1316 are:</p></div>
1317 <div class="dlist"><dl>
1318 <dt class="hdlist1">
1319 system
1320 </dt>
1321 <dd>
1322 <p>
1323         $(prefix)/etc/gitconfig
1324 </p>
1325 </dd>
1326 <dt class="hdlist1">
1327 global
1328 </dt>
1329 <dd>
1330 <p>
1331         $XDG_CONFIG_HOME/git/config
1332 </p>
1333 <div class="paragraph"><p>~/.gitconfig</p></div>
1334 </dd>
1335 <dt class="hdlist1">
1336 local
1337 </dt>
1338 <dd>
1339 <p>
1340         $GIT_DIR/config
1341 </p>
1342 </dd>
1343 <dt class="hdlist1">
1344 worktree
1345 </dt>
1346 <dd>
1347 <p>
1348         $GIT_DIR/config.worktree
1349 </p>
1350 </dd>
1351 <dt class="hdlist1">
1352 command
1353 </dt>
1354 <dd>
1355 <p>
1356         GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see <a href="#ENVIRONMENT">[ENVIRONMENT]</a>
1357         below)
1358 </p>
1359 <div class="paragraph"><p>the <code>-c</code> option</p></div>
1360 </dd>
1361 </dl></div>
1362 <div class="paragraph"><p>With the exception of <em>command</em>, each scope corresponds to a command line
1363 option: <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code>.</p></div>
1364 <div class="paragraph"><p>When reading options, specifying a scope will only read options from the
1365 files within that scope. When writing options, specifying a scope will write
1366 to the files within that scope (instead of the repository specific
1367 configuration file). See <a href="#OPTIONS">[OPTIONS]</a> above for a complete description.</p></div>
1368 <div class="paragraph"><p>Most configuration options are respected regardless of the scope it is
1369 defined in, but some options are only respected in certain scopes. See the
1370 respective option&#8217;s documentation for the full details.</p></div>
1371 <div class="sect2">
1372 <h3 id="_protected_configuration">Protected configuration</h3>
1373 <div class="paragraph"><p>Protected configuration refers to the <em>system</em>, <em>global</em>, and <em>command</em> scopes.
1374 For security reasons, certain options are only respected when they are
1375 specified in protected configuration, and ignored otherwise.</p></div>
1376 <div class="paragraph"><p>Git treats these scopes as if they are controlled by the user or a trusted
1377 administrator. This is because an attacker who controls these scopes can do
1378 substantial harm without using Git, so it is assumed that the user&#8217;s environment
1379 protects these scopes against attackers.</p></div>
1380 </div>
1381 </div>
1382 </div>
1383 <div class="sect1">
1384 <h2 id="ENVIRONMENT">ENVIRONMENT</h2>
1385 <div class="sectionbody">
1386 <div class="dlist"><dl>
1387 <dt class="hdlist1">
1388 GIT_CONFIG_GLOBAL
1389 </dt>
1390 <dt class="hdlist1">
1391 GIT_CONFIG_SYSTEM
1392 </dt>
1393 <dd>
1394 <p>
1395         Take the configuration from the given files instead from global or
1396         system-level configuration. See <a href="git.html">git(1)</a> for details.
1397 </p>
1398 </dd>
1399 <dt class="hdlist1">
1400 GIT_CONFIG_NOSYSTEM
1401 </dt>
1402 <dd>
1403 <p>
1404         Whether to skip reading settings from the system-wide
1405         $(prefix)/etc/gitconfig file. See <a href="git.html">git(1)</a> for details.
1406 </p>
1407 </dd>
1408 </dl></div>
1409 <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
1410 <div class="dlist"><dl>
1411 <dt class="hdlist1">
1412 GIT_CONFIG_COUNT
1413 </dt>
1414 <dt class="hdlist1">
1415 GIT_CONFIG_KEY_&lt;n&gt;
1416 </dt>
1417 <dt class="hdlist1">
1418 GIT_CONFIG_VALUE_&lt;n&gt;
1419 </dt>
1420 <dd>
1421 <p>
1422         If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
1423         GIT_CONFIG_KEY_&lt;n&gt; and GIT_CONFIG_VALUE_&lt;n&gt; up to that number will be
1424         added to the process&#8217;s runtime configuration. The config pairs are
1425         zero-indexed. Any missing key or value is treated as an error. An empty
1426         GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
1427         pairs are processed. These environment variables will override values
1428         in configuration files, but will be overridden by any explicit options
1429         passed via <code>git -c</code>.
1430 </p>
1431 <div class="paragraph"><p>This is useful for cases where you want to spawn multiple git commands
1432 with a common configuration but cannot depend on a configuration file,
1433 for example when writing scripts.</p></div>
1434 </dd>
1435 <dt class="hdlist1">
1436 GIT_CONFIG
1437 </dt>
1438 <dd>
1439 <p>
1440         If no <code>--file</code> option is provided to <code>git config</code>, use the file
1441         given by <code>GIT_CONFIG</code> as if it were provided via <code>--file</code>. This
1442         variable has no effect on other Git commands, and is mostly for
1443         historical compatibility; there is generally no reason to use it
1444         instead of the <code>--file</code> option.
1445 </p>
1446 </dd>
1447 </dl></div>
1448 </div>
1449 </div>
1450 <div class="sect1">
1451 <h2 id="EXAMPLES">EXAMPLES</h2>
1452 <div class="sectionbody">
1453 <div class="paragraph"><p>Given a .git/config like this:</p></div>
1454 <div class="listingblock">
1455 <div class="content">
1456 <pre><code>#
1457 # This is the config file, and
1458 # a '#' or ';' character indicates
1459 # a comment
1460 #
1461
1462 ; core variables
1463 [core]
1464         ; Don't trust file modes
1465         filemode = false
1466
1467 ; Our diff algorithm
1468 [diff]
1469         external = /usr/local/bin/diff-wrapper
1470         renames = true
1471
1472 ; Proxy settings
1473 [core]
1474         gitproxy=proxy-command for kernel.org
1475         gitproxy=default-proxy ; for all the rest
1476
1477 ; HTTP
1478 [http]
1479         sslVerify
1480 [http "https://weak.example.com"]
1481         sslVerify = false
1482         cookieFile = /tmp/cookie.txt</code></pre>
1483 </div></div>
1484 <div class="paragraph"><p>you can set the filemode to true with</p></div>
1485 <div class="listingblock">
1486 <div class="content">
1487 <pre><code>% git config core.filemode true</code></pre>
1488 </div></div>
1489 <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
1490 what URL they apply to. Here is how to change the entry for kernel.org
1491 to "ssh".</p></div>
1492 <div class="listingblock">
1493 <div class="content">
1494 <pre><code>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</code></pre>
1495 </div></div>
1496 <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
1497 <div class="paragraph"><p>To delete the entry for renames, do</p></div>
1498 <div class="listingblock">
1499 <div class="content">
1500 <pre><code>% git config --unset diff.renames</code></pre>
1501 </div></div>
1502 <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
1503 you have to provide a regex matching the value of exactly one line.</p></div>
1504 <div class="paragraph"><p>To query the value for a given key, do</p></div>
1505 <div class="listingblock">
1506 <div class="content">
1507 <pre><code>% git config --get core.filemode</code></pre>
1508 </div></div>
1509 <div class="paragraph"><p>or</p></div>
1510 <div class="listingblock">
1511 <div class="content">
1512 <pre><code>% git config core.filemode</code></pre>
1513 </div></div>
1514 <div class="paragraph"><p>or, to query a multivar:</p></div>
1515 <div class="listingblock">
1516 <div class="content">
1517 <pre><code>% git config --get core.gitproxy "for kernel.org$"</code></pre>
1518 </div></div>
1519 <div class="paragraph"><p>If you want to know all the values for a multivar, do:</p></div>
1520 <div class="listingblock">
1521 <div class="content">
1522 <pre><code>% git config --get-all core.gitproxy</code></pre>
1523 </div></div>
1524 <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
1525 new one with</p></div>
1526 <div class="listingblock">
1527 <div class="content">
1528 <pre><code>% git config --replace-all core.gitproxy ssh</code></pre>
1529 </div></div>
1530 <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy,
1531 i.e. the one without a "for &#8230;" postfix, do something like this:</p></div>
1532 <div class="listingblock">
1533 <div class="content">
1534 <pre><code>% git config core.gitproxy ssh '! for '</code></pre>
1535 </div></div>
1536 <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div>
1537 <div class="listingblock">
1538 <div class="content">
1539 <pre><code>% git config section.key value '[!]'</code></pre>
1540 </div></div>
1541 <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
1542 <div class="listingblock">
1543 <div class="content">
1544 <pre><code>% git config --add core.gitproxy '"proxy-command" for example.com'</code></pre>
1545 </div></div>
1546 <div class="paragraph"><p>An example to use customized color from the configuration in your
1547 script:</p></div>
1548 <div class="listingblock">
1549 <div class="content">
1550 <pre><code>#!/bin/sh
1551 WS=$(git config --get-color color.diff.whitespace "blue reverse")
1552 RESET=$(git config --get-color "" "reset")
1553 echo "${WS}your whitespace color or blue reverse${RESET}"</code></pre>
1554 </div></div>
1555 <div class="paragraph"><p>For URLs in <code>https://weak.example.com</code>, <code>http.sslVerify</code> is set to
1556 false, while it is set to <code>true</code> for all others:</p></div>
1557 <div class="listingblock">
1558 <div class="content">
1559 <pre><code>% git config --type=bool --get-urlmatch http.sslverify https://good.example.com
1560 true
1561 % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com
1562 false
1563 % git config --get-urlmatch http https://weak.example.com
1564 http.cookieFile /tmp/cookie.txt
1565 http.sslverify false</code></pre>
1566 </div></div>
1567 </div>
1568 </div>
1569 <div class="sect1">
1570 <h2 id="_configuration_file">CONFIGURATION FILE</h2>
1571 <div class="sectionbody">
1572 <div class="paragraph"><p>The Git configuration file contains a number of variables that affect
1573 the Git commands' behavior. The files <code>.git/config</code> and optionally
1574 <code>config.worktree</code> (see the "CONFIGURATION FILE" section of
1575 <a href="git-worktree.html">git-worktree(1)</a>) in each repository are used to store the
1576 configuration for that repository, and <code>$HOME/.gitconfig</code> is used to
1577 store a per-user configuration as fallback values for the <code>.git/config</code>
1578 file. The file <code>/etc/gitconfig</code> can be used to store a system-wide
1579 default configuration.</p></div>
1580 <div class="paragraph"><p>The configuration variables are used by both the Git plumbing
1581 and the porcelain commands. The variables are divided into sections, wherein
1582 the fully qualified variable name of the variable itself is the last
1583 dot-separated segment and the section name is everything before the last
1584 dot. The variable names are case-insensitive, allow only alphanumeric
1585 characters and <code>-</code>, and must start with an alphabetic character.  Some
1586 variables may appear multiple times; we say then that the variable is
1587 multivalued.</p></div>
1588 <div class="sect2">
1589 <h3 id="_syntax">Syntax</h3>
1590 <div class="paragraph"><p>The syntax is fairly flexible and permissive; whitespaces are mostly
1591 ignored.  The <em>#</em> and <em>;</em> characters begin comments to the end of line,
1592 blank lines are ignored.</p></div>
1593 <div class="paragraph"><p>The file consists of sections and variables.  A section begins with
1594 the name of the section in square brackets and continues until the next
1595 section begins.  Section names are case-insensitive.  Only alphanumeric
1596 characters, <code>-</code> and <code>.</code> are allowed in section names.  Each variable
1597 must belong to some section, which means that there must be a section
1598 header before the first setting of a variable.</p></div>
1599 <div class="paragraph"><p>Sections can be further divided into subsections.  To begin a subsection
1600 put its name in double quotes, separated by space from the section name,
1601 in the section header, like in the example below:</p></div>
1602 <div class="listingblock">
1603 <div class="content">
1604 <pre><code>        [section "subsection"]</code></pre>
1605 </div></div>
1606 <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
1607 newline and the null byte. Doublequote <code>"</code> and backslash can be included
1608 by escaping them as <code>\"</code> and <code>\\</code>, respectively. Backslashes preceding
1609 other characters are dropped when reading; for example, <code>\t</code> is read as
1610 <code>t</code> and <code>\0</code> is read as <code>0</code>. Section headers cannot span multiple lines.
1611 Variables may belong directly to a section or to a given subsection. You
1612 can have <code>[section]</code> if you have <code>[section "subsection"]</code>, but you don&#8217;t
1613 need to.</p></div>
1614 <div class="paragraph"><p>There is also a deprecated <code>[section.subsection]</code> syntax. With this
1615 syntax, the subsection name is converted to lower-case and is also
1616 compared case sensitively. These subsection names follow the same
1617 restrictions as section names.</p></div>
1618 <div class="paragraph"><p>All the other lines (and the remainder of the line after the section
1619 header) are recognized as setting variables, in the form
1620 <em>name = value</em> (or just <em>name</em>, which is a short-hand to say that
1621 the variable is the boolean "true").
1622 The variable names are case-insensitive, allow only alphanumeric characters
1623 and <code>-</code>, and must start with an alphabetic character.</p></div>
1624 <div class="paragraph"><p>A line that defines a value can be continued to the next line by
1625 ending it with a <code>\</code>; the backslash and the end-of-line are
1626 stripped.  Leading whitespaces after <em>name =</em>, the remainder of the
1627 line after the first comment character <em>#</em> or <em>;</em>, and trailing
1628 whitespaces of the line are discarded unless they are enclosed in
1629 double quotes.  Internal whitespaces within the value are retained
1630 verbatim.</p></div>
1631 <div class="paragraph"><p>Inside double quotes, double quote <code>"</code> and backslash <code>\</code> characters
1632 must be escaped: use <code>\"</code> for <code>"</code> and <code>\\</code> for <code>\</code>.</p></div>
1633 <div class="paragraph"><p>The following escape sequences (beside <code>\"</code> and <code>\\</code>) are recognized:
1634 <code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB)
1635 and <code>\b</code> for backspace (BS).  Other char escape sequences (including octal
1636 escape sequences) are invalid.</p></div>
1637 </div>
1638 <div class="sect2">
1639 <h3 id="_includes">Includes</h3>
1640 <div class="paragraph"><p>The <code>include</code> and <code>includeIf</code> sections allow you to include config
1641 directives from another source. These sections behave identically to
1642 each other with the exception that <code>includeIf</code> sections may be ignored
1643 if their condition does not evaluate to true; see "Conditional includes"
1644 below.</p></div>
1645 <div class="paragraph"><p>You can include a config file from another by setting the special
1646 <code>include.path</code> (or <code>includeIf.*.path</code>) variable to the name of the file
1647 to be included. The variable takes a pathname as its value, and is
1648 subject to tilde expansion. These variables can be given multiple times.</p></div>
1649 <div class="paragraph"><p>The contents of the included file are inserted immediately, as if they
1650 had been found at the location of the include directive. If the value of the
1651 variable is a relative path, the path is considered to
1652 be relative to the configuration file in which the include directive
1653 was found.  See below for examples.</p></div>
1654 </div>
1655 <div class="sect2">
1656 <h3 id="_conditional_includes">Conditional includes</h3>
1657 <div class="paragraph"><p>You can conditionally include a config file from another by setting an
1658 <code>includeIf.&lt;condition&gt;.path</code> variable to the name of the file to be
1659 included.</p></div>
1660 <div class="paragraph"><p>The condition starts with a keyword followed by a colon and some data
1661 whose format and meaning depends on the keyword. Supported keywords
1662 are:</p></div>
1663 <div class="dlist"><dl>
1664 <dt class="hdlist1">
1665 <code>gitdir</code>
1666 </dt>
1667 <dd>
1668 <p>
1669         The data that follows the keyword <code>gitdir:</code> is used as a glob
1670         pattern. If the location of the .git directory matches the
1671         pattern, the include condition is met.
1672 </p>
1673 <div class="paragraph"><p>The .git location may be auto-discovered, or come from <code>$GIT_DIR</code>
1674 environment variable. If the repository is auto-discovered via a .git
1675 file (e.g. from submodules, or a linked worktree), the .git location
1676 would be the final location where the .git directory is, not where the
1677 .git file is.</p></div>
1678 <div class="paragraph"><p>The pattern can contain standard globbing wildcards and two additional
1679 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components. Please
1680 refer to <a href="gitignore.html">gitignore(5)</a> for details. For convenience:</p></div>
1681 <div class="ulist"><ul>
1682 <li>
1683 <p>
1684 If the pattern starts with <code>~/</code>, <code>~</code> will be substituted with the
1685    content of the environment variable <code>HOME</code>.
1686 </p>
1687 </li>
1688 <li>
1689 <p>
1690 If the pattern starts with <code>./</code>, it is replaced with the directory
1691    containing the current config file.
1692 </p>
1693 </li>
1694 <li>
1695 <p>
1696 If the pattern does not start with either <code>~/</code>, <code>./</code> or <code>/</code>, <code>**/</code>
1697    will be automatically prepended. For example, the pattern <code>foo/bar</code>
1698    becomes <code>**/foo/bar</code> and would match <code>/any/path/to/foo/bar</code>.
1699 </p>
1700 </li>
1701 <li>
1702 <p>
1703 If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1704    example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it
1705    matches "foo" and everything inside, recursively.
1706 </p>
1707 </li>
1708 </ul></div>
1709 </dd>
1710 <dt class="hdlist1">
1711 <code>gitdir/i</code>
1712 </dt>
1713 <dd>
1714 <p>
1715         This is the same as <code>gitdir</code> except that matching is done
1716         case-insensitively (e.g. on case-insensitive file systems)
1717 </p>
1718 </dd>
1719 <dt class="hdlist1">
1720 <code>onbranch</code>
1721 </dt>
1722 <dd>
1723 <p>
1724         The data that follows the keyword <code>onbranch:</code> is taken to be a
1725         pattern with standard globbing wildcards and two additional
1726         ones, <code>**/</code> and <code>/**</code>, that can match multiple path components.
1727         If we are in a worktree where the name of the branch that is
1728         currently checked out matches the pattern, the include condition
1729         is met.
1730 </p>
1731 <div class="paragraph"><p>If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1732 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it matches
1733 all branches that begin with <code>foo/</code>. This is useful if your branches are
1734 organized hierarchically and you would like to apply a configuration to
1735 all the branches in that hierarchy.</p></div>
1736 </dd>
1737 <dt class="hdlist1">
1738 <code>hasconfig:remote.*.url:</code>
1739 </dt>
1740 <dd>
1741 <p>
1742         The data that follows this keyword is taken to
1743         be a pattern with standard globbing wildcards and two
1744         additional ones, <code>**/</code> and <code>/**</code>, that can match multiple
1745         components. The first time this keyword is seen, the rest of
1746         the config files will be scanned for remote URLs (without
1747         applying any values). If there exists at least one remote URL
1748         that matches this pattern, the include condition is met.
1749 </p>
1750 <div class="paragraph"><p>Files included by this option (directly or indirectly) are not allowed
1751 to contain remote URLs.</p></div>
1752 <div class="paragraph"><p>Note that unlike other includeIf conditions, resolving this condition
1753 relies on information that is not yet known at the point of reading the
1754 condition. A typical use case is this option being present as a
1755 system-level or global-level config, and the remote URL being in a
1756 local-level config; hence the need to scan ahead when resolving this
1757 condition. In order to avoid the chicken-and-egg problem in which
1758 potentially-included files can affect whether such files are potentially
1759 included, Git breaks the cycle by prohibiting these files from affecting
1760 the resolution of these conditions (thus, prohibiting them from
1761 declaring remote URLs).</p></div>
1762 <div class="paragraph"><p>As for the naming of this keyword, it is for forwards compatibility with
1763 a naming scheme that supports more variable-based include conditions,
1764 but currently Git only supports the exact keyword described above.</p></div>
1765 </dd>
1766 </dl></div>
1767 <div class="paragraph"><p>A few more notes on matching via <code>gitdir</code> and <code>gitdir/i</code>:</p></div>
1768 <div class="ulist"><ul>
1769 <li>
1770 <p>
1771 Symlinks in <code>$GIT_DIR</code> are not resolved before matching.
1772 </p>
1773 </li>
1774 <li>
1775 <p>
1776 Both the symlink &amp; realpath versions of paths will be matched
1777    outside of <code>$GIT_DIR</code>. E.g. if ~/git is a symlink to
1778    /mnt/storage/git, both <code>gitdir:~/git</code> and <code>gitdir:/mnt/storage/git</code>
1779    will match.
1780 </p>
1781 <div class="paragraph"><p>This was not the case in the initial release of this feature in
1782 v2.13.0, which only matched the realpath version. Configuration that
1783 wants to be compatible with the initial release of this feature needs
1784 to either specify only the realpath version, or both versions.</p></div>
1785 </li>
1786 <li>
1787 <p>
1788 Note that "../" is not special and will match literally, which is
1789    unlikely what you want.
1790 </p>
1791 </li>
1792 </ul></div>
1793 </div>
1794 <div class="sect2">
1795 <h3 id="_example">Example</h3>
1796 <div class="listingblock">
1797 <div class="content">
1798 <pre><code># Core variables
1799 [core]
1800         ; Don't trust file modes
1801         filemode = false
1802
1803 # Our diff algorithm
1804 [diff]
1805         external = /usr/local/bin/diff-wrapper
1806         renames = true
1807
1808 [branch "devel"]
1809         remote = origin
1810         merge = refs/heads/devel
1811
1812 # Proxy settings
1813 [core]
1814         gitProxy="ssh" for "kernel.org"
1815         gitProxy=default-proxy ; for the rest
1816
1817 [include]
1818         path = /path/to/foo.inc ; include by absolute path
1819         path = foo.inc ; find "foo.inc" relative to the current file
1820         path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
1821
1822 ; include if $GIT_DIR is /path/to/foo/.git
1823 [includeIf "gitdir:/path/to/foo/.git"]
1824         path = /path/to/foo.inc
1825
1826 ; include for all repositories inside /path/to/group
1827 [includeIf "gitdir:/path/to/group/"]
1828         path = /path/to/foo.inc
1829
1830 ; include for all repositories inside $HOME/to/group
1831 [includeIf "gitdir:~/to/group/"]
1832         path = /path/to/foo.inc
1833
1834 ; relative paths are always relative to the including
1835 ; file (if the condition is true); their location is not
1836 ; affected by the condition
1837 [includeIf "gitdir:/path/to/group/"]
1838         path = foo.inc
1839
1840 ; include only if we are in a worktree where foo-branch is
1841 ; currently checked out
1842 [includeIf "onbranch:foo-branch"]
1843         path = foo.inc
1844
1845 ; include only if a remote with the given URL exists (note
1846 ; that such a URL may be provided later in a file or in a
1847 ; file read after this file is read, as seen in this example)
1848 [includeIf "hasconfig:remote.*.url:https://example.com/**"]
1849         path = foo.inc
1850 [remote "origin"]
1851         url = https://example.com/git</code></pre>
1852 </div></div>
1853 </div>
1854 <div class="sect2">
1855 <h3 id="_values">Values</h3>
1856 <div class="paragraph"><p>Values of many variables are treated as a simple string, but there
1857 are variables that take values of specific types and there are rules
1858 as to how to spell them.</p></div>
1859 <div class="dlist"><dl>
1860 <dt class="hdlist1">
1861 boolean
1862 </dt>
1863 <dd>
1864 <p>
1865        When a variable is said to take a boolean value, many
1866        synonyms are accepted for <em>true</em> and <em>false</em>; these are all
1867        case-insensitive.
1868 </p>
1869 <div class="dlist"><dl>
1870 <dt class="hdlist1">
1871 true
1872 </dt>
1873 <dd>
1874 <p>
1875 Boolean true literals are <code>yes</code>, <code>on</code>, <code>true</code>,
1876                 and <code>1</code>.  Also, a variable defined without <code>= &lt;value&gt;</code>
1877                 is taken as true.
1878 </p>
1879 </dd>
1880 <dt class="hdlist1">
1881 false
1882 </dt>
1883 <dd>
1884 <p>
1885 Boolean false literals are <code>no</code>, <code>off</code>, <code>false</code>,
1886                 <code>0</code> and the empty string.
1887 </p>
1888 <div class="paragraph"><p>When converting a value to its canonical form using the <code>--type=bool</code> type
1889 specifier, <em>git config</em> will ensure that the output is "true" or
1890 "false" (spelled in lowercase).</p></div>
1891 </dd>
1892 </dl></div>
1893 </dd>
1894 <dt class="hdlist1">
1895 integer
1896 </dt>
1897 <dd>
1898 <p>
1899        The value for many variables that specify various sizes can
1900        be suffixed with <code>k</code>, <code>M</code>,&#8230; to mean "scale the number by
1901        1024", "by 1024x1024", etc.
1902 </p>
1903 </dd>
1904 <dt class="hdlist1">
1905 color
1906 </dt>
1907 <dd>
1908 <p>
1909        The value for a variable that takes a color is a list of
1910        colors (at most two, one for foreground and one for background)
1911        and attributes (as many as you want), separated by spaces.
1912 </p>
1913 <div class="paragraph"><p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>,
1914 <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code> and <code>default</code>.  The first
1915 color given is the foreground; the second is the background.  All the
1916 basic colors except <code>normal</code> and <code>default</code> have a bright variant that can
1917 be specified by prefixing the color with <code>bright</code>, like <code>brightred</code>.</p></div>
1918 <div class="paragraph"><p>The color <code>normal</code> makes no change to the color. It is the same as an
1919 empty string, but can be used as the foreground color when specifying a
1920 background color alone (for example, "normal red").</p></div>
1921 <div class="paragraph"><p>The color <code>default</code> explicitly resets the color to the terminal default,
1922 for example to specify a cleared background. Although it varies between
1923 terminals, this is usually not the same as setting to "white black".</p></div>
1924 <div class="paragraph"><p>Colors may also be given as numbers between 0 and 255; these use ANSI
1925 256-color mode (but note that not all terminals may support this).  If
1926 your terminal supports it, you may also specify 24-bit RGB values as
1927 hex, like <code>#ff0ab3</code>.</p></div>
1928 <div class="paragraph"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
1929 <code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters).
1930 The position of any attributes with respect to the colors
1931 (before, after, or in between), doesn&#8217;t matter. Specific attributes may
1932 be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>,
1933 <code>no-ul</code>, etc).</p></div>
1934 <div class="paragraph"><p>The pseudo-attribute <code>reset</code> resets all colors and attributes before
1935 applying the specified coloring. For example, <code>reset green</code> will result
1936 in a green foreground and default background without any active
1937 attributes.</p></div>
1938 <div class="paragraph"><p>An empty color string produces no color effect at all. This can be used
1939 to avoid coloring specific elements without disabling color entirely.</p></div>
1940 <div class="paragraph"><p>For git&#8217;s pre-defined color slots, the attributes are meant to be reset
1941 at the beginning of each item in the colored output. So setting
1942 <code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a
1943 plain <code>black</code>, even if the previous thing on the same output line (e.g.
1944 opening parenthesis before the list of branch names in <code>log --decorate</code>
1945 output) is set to be painted with <code>bold</code> or some other attribute.
1946 However, custom log formats may do more complicated and layered
1947 coloring, and the negated forms may be useful there.</p></div>
1948 </dd>
1949 <dt class="hdlist1">
1950 pathname
1951 </dt>
1952 <dd>
1953 <p>
1954         A variable that takes a pathname value can be given a
1955         string that begins with "<code>~/</code>" or "<code>~user/</code>", and the usual
1956         tilde expansion happens to such a string: <code>~/</code>
1957         is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the
1958         specified user&#8217;s home directory.
1959 </p>
1960 <div class="paragraph"><p>If a path starts with <code>%(prefix)/</code>, the remainder is interpreted as a
1961 path relative to Git&#8217;s "runtime prefix", i.e. relative to the location
1962 where Git itself was installed. For example, <code>%(prefix)/bin/</code> refers to
1963 the directory in which the Git executable itself lives. If Git was
1964 compiled without runtime prefix support, the compiled-in prefix will be
1965 substituted instead. In the unlikely event that a literal path needs to
1966 be specified that should <em>not</em> be expanded, it needs to be prefixed by
1967 <code>./</code>, like so: <code>./%(prefix)/bin</code>.</p></div>
1968 </dd>
1969 </dl></div>
1970 </div>
1971 <div class="sect2">
1972 <h3 id="_variables">Variables</h3>
1973 <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
1974 For command-specific variables, you will find a more detailed description
1975 in the appropriate manual page.</p></div>
1976 <div class="paragraph"><p>Other git-related tools may and do use their own variables.  When
1977 inventing new variables for use in your own tool, make sure their
1978 names do not conflict with those that are used by Git itself and
1979 other popular tools, and describe them in your documentation.</p></div>
1980 <div class="dlist"><dl>
1981 <dt class="hdlist1">
1982 advice.*
1983 </dt>
1984 <dd>
1985 <p>
1986         These variables control various optional help messages designed to
1987         aid new users.  When left unconfigured, Git will give the message
1988         alongside instructions on how to squelch it.  You can tell Git
1989         that you do not need the help message by setting these to <em>false</em>:
1990 </p>
1991 <div class="openblock">
1992 <div class="content">
1993 <div class="dlist"><dl>
1994 <dt class="hdlist1">
1995 addEmbeddedRepo
1996 </dt>
1997 <dd>
1998 <p>
1999                 Advice on what to do when you&#8217;ve accidentally added one
2000                 git repo inside of another.
2001 </p>
2002 </dd>
2003 <dt class="hdlist1">
2004 addEmptyPathspec
2005 </dt>
2006 <dd>
2007 <p>
2008                 Advice shown if a user runs the add command without providing
2009                 the pathspec parameter.
2010 </p>
2011 </dd>
2012 <dt class="hdlist1">
2013 addIgnoredFile
2014 </dt>
2015 <dd>
2016 <p>
2017                 Advice shown if a user attempts to add an ignored file to
2018                 the index.
2019 </p>
2020 </dd>
2021 <dt class="hdlist1">
2022 amWorkDir
2023 </dt>
2024 <dd>
2025 <p>
2026                 Advice that shows the location of the patch file when
2027                 <a href="git-am.html">git-am(1)</a> fails to apply it.
2028 </p>
2029 </dd>
2030 <dt class="hdlist1">
2031 ambiguousFetchRefspec
2032 </dt>
2033 <dd>
2034 <p>
2035                 Advice shown when a fetch refspec for multiple remotes maps to
2036                 the same remote-tracking branch namespace and causes branch
2037                 tracking set-up to fail.
2038 </p>
2039 </dd>
2040 <dt class="hdlist1">
2041 checkoutAmbiguousRemoteBranchName
2042 </dt>
2043 <dd>
2044 <p>
2045                 Advice shown when the argument to
2046                 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
2047                 ambiguously resolves to a
2048                 remote tracking branch on more than one remote in
2049                 situations where an unambiguous argument would have
2050                 otherwise caused a remote-tracking branch to be
2051                 checked out. See the <code>checkout.defaultRemote</code>
2052                 configuration variable for how to set a given remote
2053                 to be used by default in some situations where this
2054                 advice would be printed.
2055 </p>
2056 </dd>
2057 <dt class="hdlist1">
2058 commitBeforeMerge
2059 </dt>
2060 <dd>
2061 <p>
2062                 Advice shown when <a href="git-merge.html">git-merge(1)</a> refuses to
2063                 merge to avoid overwriting local changes.
2064 </p>
2065 </dd>
2066 <dt class="hdlist1">
2067 detachedHead
2068 </dt>
2069 <dd>
2070 <p>
2071                 Advice shown when you used
2072                 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
2073                 to move to the detached HEAD state, to instruct how to
2074                 create a local branch after the fact.
2075 </p>
2076 </dd>
2077 <dt class="hdlist1">
2078 diverging
2079 </dt>
2080 <dd>
2081 <p>
2082                 Advice shown when a fast-forward is not possible.
2083 </p>
2084 </dd>
2085 <dt class="hdlist1">
2086 fetchShowForcedUpdates
2087 </dt>
2088 <dd>
2089 <p>
2090                 Advice shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
2091                 to calculate forced updates after ref updates, or to warn
2092                 that the check is disabled.
2093 </p>
2094 </dd>
2095 <dt class="hdlist1">
2096 forceDeleteBranch
2097 </dt>
2098 <dd>
2099 <p>
2100                 Advice shown when a user tries to delete a not fully merged
2101                 branch without the force option set.
2102 </p>
2103 </dd>
2104 <dt class="hdlist1">
2105 ignoredHook
2106 </dt>
2107 <dd>
2108 <p>
2109                 Advice shown if a hook is ignored because the hook is not
2110                 set as executable.
2111 </p>
2112 </dd>
2113 <dt class="hdlist1">
2114 implicitIdentity
2115 </dt>
2116 <dd>
2117 <p>
2118                 Advice on how to set your identity configuration when
2119                 your information is guessed from the system username and
2120                 domain name.
2121 </p>
2122 </dd>
2123 <dt class="hdlist1">
2124 nestedTag
2125 </dt>
2126 <dd>
2127 <p>
2128                 Advice shown if a user attempts to recursively tag a tag object.
2129 </p>
2130 </dd>
2131 <dt class="hdlist1">
2132 pushAlreadyExists
2133 </dt>
2134 <dd>
2135 <p>
2136                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2137                 does not qualify for fast-forwarding (e.g., a tag.)
2138 </p>
2139 </dd>
2140 <dt class="hdlist1">
2141 pushFetchFirst
2142 </dt>
2143 <dd>
2144 <p>
2145                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2146                 tries to overwrite a remote ref that points at an
2147                 object we do not have.
2148 </p>
2149 </dd>
2150 <dt class="hdlist1">
2151 pushNeedsForce
2152 </dt>
2153 <dd>
2154 <p>
2155                 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
2156                 tries to overwrite a remote ref that points at an
2157                 object that is not a commit-ish, or make the remote
2158                 ref point at an object that is not a commit-ish.
2159 </p>
2160 </dd>
2161 <dt class="hdlist1">
2162 pushNonFFCurrent
2163 </dt>
2164 <dd>
2165 <p>
2166                 Advice shown when <a href="git-push.html">git-push(1)</a> fails due to a
2167                 non-fast-forward update to the current branch.
2168 </p>
2169 </dd>
2170 <dt class="hdlist1">
2171 pushNonFFMatching
2172 </dt>
2173 <dd>
2174 <p>
2175                 Advice shown when you ran <a href="git-push.html">git-push(1)</a> and pushed
2176                 <em>matching refs</em> explicitly (i.e. you used <em>:</em>, or
2177                 specified a refspec that isn&#8217;t your current branch) and
2178                 it resulted in a non-fast-forward error.
2179 </p>
2180 </dd>
2181 <dt class="hdlist1">
2182 pushRefNeedsUpdate
2183 </dt>
2184 <dd>
2185 <p>
2186                 Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
2187                 a branch when its remote-tracking ref has updates that we
2188                 do not have locally.
2189 </p>
2190 </dd>
2191 <dt class="hdlist1">
2192 pushUnqualifiedRefname
2193 </dt>
2194 <dd>
2195 <p>
2196                 Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
2197                 guess based on the source and destination refs what
2198                 remote ref namespace the source belongs in, but where
2199                 we can still suggest that the user push to either
2200                 refs/heads/* or refs/tags/* based on the type of the
2201                 source object.
2202 </p>
2203 </dd>
2204 <dt class="hdlist1">
2205 pushUpdateRejected
2206 </dt>
2207 <dd>
2208 <p>
2209                 Set this variable to <em>false</em> if you want to disable
2210                 <em>pushNonFFCurrent</em>, <em>pushNonFFMatching</em>, <em>pushAlreadyExists</em>,
2211                 <em>pushFetchFirst</em>, <em>pushNeedsForce</em>, and <em>pushRefNeedsUpdate</em>
2212                 simultaneously.
2213 </p>
2214 </dd>
2215 <dt class="hdlist1">
2216 resetNoRefresh
2217 </dt>
2218 <dd>
2219 <p>
2220                 Advice to consider using the <code>--no-refresh</code> option to
2221                 <a href="git-reset.html">git-reset(1)</a> when the command takes more than 2 seconds
2222                 to refresh the index after reset.
2223 </p>
2224 </dd>
2225 <dt class="hdlist1">
2226 resolveConflict
2227 </dt>
2228 <dd>
2229 <p>
2230                 Advice shown by various commands when conflicts
2231                 prevent the operation from being performed.
2232 </p>
2233 </dd>
2234 <dt class="hdlist1">
2235 rmHints
2236 </dt>
2237 <dd>
2238 <p>
2239                 In case of failure in the output of <a href="git-rm.html">git-rm(1)</a>,
2240                 show directions on how to proceed from the current state.
2241 </p>
2242 </dd>
2243 <dt class="hdlist1">
2244 sequencerInUse
2245 </dt>
2246 <dd>
2247 <p>
2248                 Advice shown when a sequencer command is already in progress.
2249 </p>
2250 </dd>
2251 <dt class="hdlist1">
2252 skippedCherryPicks
2253 </dt>
2254 <dd>
2255 <p>
2256                 Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
2257                 been cherry-picked onto the upstream branch.
2258 </p>
2259 </dd>
2260 <dt class="hdlist1">
2261 statusAheadBehind
2262 </dt>
2263 <dd>
2264 <p>
2265                 Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
2266                 counts for a local ref compared to its remote tracking ref,
2267                 and that calculation takes longer than expected. Will not
2268                 appear if <code>status.aheadBehind</code> is false or the option
2269                 <code>--no-ahead-behind</code> is given.
2270 </p>
2271 </dd>
2272 <dt class="hdlist1">
2273 statusHints
2274 </dt>
2275 <dd>
2276 <p>
2277                 Show directions on how to proceed from the current
2278                 state in the output of <a href="git-status.html">git-status(1)</a>, in
2279                 the template shown when writing commit messages in
2280                 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
2281                 by <a href="git-switch.html">git-switch(1)</a> or
2282                 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.
2283 </p>
2284 </dd>
2285 <dt class="hdlist1">
2286 statusUoption
2287 </dt>
2288 <dd>
2289 <p>
2290                 Advise to consider using the <code>-u</code> option to <a href="git-status.html">git-status(1)</a>
2291                 when the command takes more than 2 seconds to enumerate untracked
2292                 files.
2293 </p>
2294 </dd>
2295 <dt class="hdlist1">
2296 submoduleAlternateErrorStrategyDie
2297 </dt>
2298 <dd>
2299 <p>
2300                 Advice shown when a submodule.alternateErrorStrategy option
2301                 configured to "die" causes a fatal error.
2302 </p>
2303 </dd>
2304 <dt class="hdlist1">
2305 submodulesNotUpdated
2306 </dt>
2307 <dd>
2308 <p>
2309                 Advice shown when a user runs a submodule command that fails
2310                 because <code>git submodule update --init</code> was not run.
2311 </p>
2312 </dd>
2313 <dt class="hdlist1">
2314 suggestDetachingHead
2315 </dt>
2316 <dd>
2317 <p>
2318                 Advice shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
2319                 without the explicit <code>--detach</code> option.
2320 </p>
2321 </dd>
2322 <dt class="hdlist1">
2323 updateSparsePath
2324 </dt>
2325 <dd>
2326 <p>
2327                 Advice shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
2328                 is asked to update index entries outside the current sparse
2329                 checkout.
2330 </p>
2331 </dd>
2332 <dt class="hdlist1">
2333 waitingForEditor
2334 </dt>
2335 <dd>
2336 <p>
2337                 Print a message to the terminal whenever Git is waiting for
2338                 editor input from the user.
2339 </p>
2340 </dd>
2341 <dt class="hdlist1">
2342 worktreeAddOrphan
2343 </dt>
2344 <dd>
2345 <p>
2346                 Advice shown when a user tries to create a worktree from an
2347                 invalid reference, to instruct how to create a new unborn
2348                 branch instead.
2349 </p>
2350 </dd>
2351 </dl></div>
2352 </div></div>
2353 </dd>
2354 <dt class="hdlist1">
2355 attr.tree
2356 </dt>
2357 <dd>
2358 <p>
2359         A reference to a tree in the repository from which to read attributes,
2360         instead of the <code>.gitattributes</code> file in the working tree. In a bare
2361         repository, this defaults to <code>HEAD:.gitattributes</code>. If the value does
2362         not resolve to a valid tree object, an empty tree is used instead.
2363         When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2364         command line option are used, this configuration variable has no effect.
2365 </p>
2366 </dd>
2367 <dt class="hdlist1">
2368 core.fileMode
2369 </dt>
2370 <dd>
2371 <p>
2372         Tells Git if the executable bit of files in the working tree
2373         is to be honored.
2374 </p>
2375 <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
2376 marked as executable is checked out, or checks out a
2377 non-executable file with executable bit on.
2378 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
2379 to see if it handles the executable bit correctly
2380 and this variable is automatically set as necessary.</p></div>
2381 <div class="paragraph"><p>A repository, however, may be on a filesystem that handles
2382 the filemode correctly, and this variable is set to <em>true</em>
2383 when created, but later may be made accessible from another
2384 environment that loses the filemode (e.g. exporting ext4 via
2385 CIFS mount, visiting a Cygwin created repository with
2386 Git for Windows or Eclipse).
2387 In such a case it may be necessary to set this variable to <em>false</em>.
2388 See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
2389 <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
2390 </dd>
2391 <dt class="hdlist1">
2392 core.hideDotFiles
2393 </dt>
2394 <dd>
2395 <p>
2396         (Windows-only) If true, mark newly-created directories and files whose
2397         name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
2398         directory is hidden, but no other files starting with a dot.  The
2399         default mode is <em>dotGitOnly</em>.
2400 </p>
2401 </dd>
2402 <dt class="hdlist1">
2403 core.ignoreCase
2404 </dt>
2405 <dd>
2406 <p>
2407         Internal variable which enables various workarounds to enable
2408         Git to work better on filesystems that are not case sensitive,
2409         like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
2410         finds "makefile" when Git expects "Makefile", Git will assume
2411         it is really the same file, and continue to remember it as
2412         "Makefile".
2413 </p>
2414 <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>
2415 will probe and set core.ignoreCase true if appropriate when the repository
2416 is created.</p></div>
2417 <div class="paragraph"><p>Git relies on the proper configuration of this variable for your operating
2418 and file system. Modifying this value may result in unexpected behavior.</p></div>
2419 </dd>
2420 <dt class="hdlist1">
2421 core.precomposeUnicode
2422 </dt>
2423 <dd>
2424 <p>
2425         This option is only used by Mac OS implementation of Git.
2426         When core.precomposeUnicode=true, Git reverts the unicode decomposition
2427         of filenames done by Mac OS. This is useful when sharing a repository
2428         between Mac OS and Linux or Windows.
2429         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
2430         When false, file names are handled fully transparent by Git,
2431         which is backward compatible with older versions of Git.
2432 </p>
2433 </dd>
2434 <dt class="hdlist1">
2435 core.protectHFS
2436 </dt>
2437 <dd>
2438 <p>
2439         If set to true, do not allow checkout of paths that would
2440         be considered equivalent to <code>.git</code> on an HFS+ filesystem.
2441         Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
2442 </p>
2443 </dd>
2444 <dt class="hdlist1">
2445 core.protectNTFS
2446 </dt>
2447 <dd>
2448 <p>
2449         If set to true, do not allow checkout of paths that would
2450         cause problems with the NTFS filesystem, e.g. conflict with
2451         8.3 "short" names.
2452         Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
2453 </p>
2454 </dd>
2455 <dt class="hdlist1">
2456 core.fsmonitor
2457 </dt>
2458 <dd>
2459 <p>
2460         If set to true, enable the built-in file system monitor
2461         daemon for this working directory (<a href="git-fsmonitor&#45;&#45;daemon.html">git-fsmonitor&#45;&#45;daemon(1)</a>).
2462 </p>
2463 <div class="paragraph"><p>Like hook-based file system monitors, the built-in file system monitor
2464 can speed up Git commands that need to refresh the Git index
2465 (e.g. <code>git status</code>) in a working directory with many files.  The
2466 built-in monitor eliminates the need to install and maintain an
2467 external third-party tool.</p></div>
2468 <div class="paragraph"><p>The built-in file system monitor is currently available only on a
2469 limited set of supported platforms.  Currently, this includes Windows
2470 and MacOS.</p></div>
2471 <div class="literalblock">
2472 <div class="content">
2473 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor"
2474 hook command.</code></pre>
2475 </div></div>
2476 <div class="paragraph"><p>This hook command is used to identify all files that may have changed
2477 since the requested date/time. This information is used to speed up
2478 git by avoiding unnecessary scanning of files that have not changed.</p></div>
2479 <div class="paragraph"><p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p></div>
2480 <div class="paragraph"><p>Note that if you concurrently use multiple versions of Git, such
2481 as one version on the command line and another version in an IDE
2482 tool, that the definition of <code>core.fsmonitor</code> was extended to
2483 allow boolean values in addition to hook pathnames.  Git versions
2484 2.35.1 and prior will not understand the boolean values and will
2485 consider the "true" or "false" values as hook pathnames to be
2486 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
2487 V2 and will fall back to no fsmonitor (full scan).  Git versions
2488 prior to 2.26 default to hook protocol V1 and will silently
2489 assume there were no changes to report (no scan), so status
2490 commands may report incomplete results.  For this reason, it is
2491 best to upgrade all of your Git versions before using the built-in
2492 file system monitor.</p></div>
2493 </dd>
2494 <dt class="hdlist1">
2495 core.fsmonitorHookVersion
2496 </dt>
2497 <dd>
2498 <p>
2499         Sets the protocol version to be used when invoking the
2500         "fsmonitor" hook.
2501 </p>
2502 <div class="paragraph"><p>There are currently versions 1 and 2. When this is not set,
2503 version 2 will be tried first and if it fails then version 1
2504 will be tried. Version 1 uses a timestamp as input to determine
2505 which files have changes since that time but some monitors
2506 like Watchman have race conditions when used with a timestamp.
2507 Version 2 uses an opaque string so that the monitor can return
2508 something that can be used to determine what files have changed
2509 without race conditions.</p></div>
2510 </dd>
2511 <dt class="hdlist1">
2512 core.trustctime
2513 </dt>
2514 <dd>
2515 <p>
2516         If false, the ctime differences between the index and the
2517         working tree are ignored; useful when the inode change time
2518         is regularly modified by something outside Git (file system
2519         crawlers and some backup systems).
2520         See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
2521 </p>
2522 </dd>
2523 <dt class="hdlist1">
2524 core.splitIndex
2525 </dt>
2526 <dd>
2527 <p>
2528         If true, the split-index feature of the index will be used.
2529         See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
2530 </p>
2531 </dd>
2532 <dt class="hdlist1">
2533 core.untrackedCache
2534 </dt>
2535 <dd>
2536 <p>
2537         Determines what to do about the untracked cache feature of the
2538         index. It will be kept, if this variable is unset or set to
2539         <code>keep</code>. It will automatically be added if set to <code>true</code>. And
2540         it will automatically be removed, if set to <code>false</code>. Before
2541         setting it to <code>true</code>, you should check that mtime is working
2542         properly on your system.
2543         See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
2544         <code>feature.manyFiles</code> is enabled which sets this setting to
2545         <code>true</code> by default.
2546 </p>
2547 </dd>
2548 <dt class="hdlist1">
2549 core.checkStat
2550 </dt>
2551 <dd>
2552 <p>
2553         When missing or is set to <code>default</code>, many fields in the stat
2554         structure are checked to detect if a file has been modified
2555         since Git looked at it.  When this configuration variable is
2556         set to <code>minimal</code>, sub-second part of mtime and ctime, the
2557         uid and gid of the owner of the file, the inode number (and
2558         the device number, if Git was compiled to use it), are
2559         excluded from the check among these fields, leaving only the
2560         whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
2561         is set) and the filesize to be checked.
2562 </p>
2563 <div class="paragraph"><p>There are implementations of Git that do not leave usable values in
2564 some fields (e.g. JGit); by excluding these fields from the
2565 comparison, the <code>minimal</code> mode may help interoperability when the
2566 same repository is used by these other systems at the same time.</p></div>
2567 </dd>
2568 <dt class="hdlist1">
2569 core.quotePath
2570 </dt>
2571 <dd>
2572 <p>
2573         Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
2574         quote "unusual" characters in the pathname by enclosing the
2575         pathname in double-quotes and escaping those characters with
2576         backslashes in the same way C escapes control characters (e.g.
2577         <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
2578         values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
2579         UTF-8).  If this variable is set to false, bytes higher than
2580         0x80 are not considered "unusual" any more. Double-quotes,
2581         backslash and control characters are always escaped regardless
2582         of the setting of this variable.  A simple space character is
2583         not considered "unusual".  Many commands can output pathnames
2584         completely verbatim using the <code>-z</code> option. The default value
2585         is true.
2586 </p>
2587 </dd>
2588 <dt class="hdlist1">
2589 core.eol
2590 </dt>
2591 <dd>
2592 <p>
2593         Sets the line ending type to use in the working directory for
2594         files that are marked as text (either by having the <code>text</code>
2595         attribute set, or by having <code>text=auto</code> and Git auto-detecting
2596         the contents as text).
2597         Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
2598         native line ending.  The default value is <code>native</code>.  See
2599         <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
2600         conversion. Note that this value is ignored if <code>core.autocrlf</code>
2601         is set to <code>true</code> or <code>input</code>.
2602 </p>
2603 </dd>
2604 <dt class="hdlist1">
2605 core.safecrlf
2606 </dt>
2607 <dd>
2608 <p>
2609         If true, makes Git check if converting <code>CRLF</code> is reversible when
2610         end-of-line conversion is active.  Git will verify if a command
2611         modifies a file in the work tree either directly or indirectly.
2612         For example, committing a file followed by checking out the
2613         same file should yield the original file in the work tree.  If
2614         this is not the case for the current setting of
2615         <code>core.autocrlf</code>, Git will reject the file.  The variable can
2616         be set to "warn", in which case Git will only warn about an
2617         irreversible conversion but continue the operation.
2618 </p>
2619 <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
2620 When it is enabled, Git will convert CRLF to LF during commit and LF to
2621 CRLF during checkout.  A file that contains a mixture of LF and
2622 CRLF before the commit cannot be recreated by Git.  For text
2623 files this is the right thing to do: it corrects line endings
2624 such that we have only LF line endings in the repository.
2625 But for binary files that are accidentally classified as text the
2626 conversion can corrupt data.</p></div>
2627 <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
2628 setting the conversion type explicitly in .gitattributes.  Right
2629 after committing you still have the original file in your work
2630 tree and this file is not yet corrupted.  You can explicitly tell
2631 Git that this file is binary and Git will handle the file
2632 appropriately.</p></div>
2633 <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
2634 mixed line endings and the undesired effect of corrupting binary
2635 files cannot be distinguished.  In both cases CRLFs are removed
2636 in an irreversible way.  For text files this is the right thing
2637 to do because CRLFs are line endings, while for binary files
2638 converting CRLFs corrupts data.</p></div>
2639 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
2640 file identical to the original file for a different setting of
2641 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
2642 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
2643 and could later be checked out with <code>core.eol=crlf</code>, in which case the
2644 resulting file would contain <code>CRLF</code>, although the original file
2645 contained <code>LF</code>.  However, in both work trees the line endings would be
2646 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
2647 file with mixed line endings would be reported by the <code>core.safecrlf</code>
2648 mechanism.</p></div>
2649 </dd>
2650 <dt class="hdlist1">
2651 core.autocrlf
2652 </dt>
2653 <dd>
2654 <p>
2655         Setting this variable to "true" is the same as setting
2656         the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
2657         Set to true if you want to have <code>CRLF</code> line endings in your
2658         working directory and the repository has LF line endings.
2659         This variable can be set to <em>input</em>,
2660         in which case no output conversion is performed.
2661 </p>
2662 </dd>
2663 <dt class="hdlist1">
2664 core.checkRoundtripEncoding
2665 </dt>
2666 <dd>
2667 <p>
2668         A comma and/or whitespace separated list of encodings that Git
2669         performs UTF-8 round trip checks on if they are used in an
2670         <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
2671         The default value is <code>SHIFT-JIS</code>.
2672 </p>
2673 </dd>
2674 <dt class="hdlist1">
2675 core.symlinks
2676 </dt>
2677 <dd>
2678 <p>
2679         If false, symbolic links are checked out as small plain files that
2680         contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
2681         <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
2682         file. Useful on filesystems like FAT that do not support
2683         symbolic links.
2684 </p>
2685 <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>
2686 will probe and set core.symlinks false if appropriate when the repository
2687 is created.</p></div>
2688 </dd>
2689 <dt class="hdlist1">
2690 core.gitProxy
2691 </dt>
2692 <dd>
2693 <p>
2694         A "proxy command" to execute (as <em>command host port</em>) instead
2695         of establishing direct connection to the remote server when
2696         using the Git protocol for fetching. If the variable value is
2697         in the "COMMAND for DOMAIN" format, the command is applied only
2698         on hostnames ending with the specified domain string. This variable
2699         may be set multiple times and is matched in the given order;
2700         the first match wins.
2701 </p>
2702 <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
2703 (which always applies universally, without the special "for"
2704 handling).</p></div>
2705 <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
2706 specify that no proxy be used for a given domain pattern.
2707 This is useful for excluding servers inside a firewall from
2708 proxy use, while defaulting to a common proxy for external domains.</p></div>
2709 </dd>
2710 <dt class="hdlist1">
2711 core.sshCommand
2712 </dt>
2713 <dd>
2714 <p>
2715         If this variable is set, <code>git fetch</code> and <code>git push</code> will
2716         use the specified command instead of <code>ssh</code> when they need to
2717         connect to a remote system. The command is in the same form as
2718         the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
2719         when the environment variable is set.
2720 </p>
2721 </dd>
2722 <dt class="hdlist1">
2723 core.ignoreStat
2724 </dt>
2725 <dd>
2726 <p>
2727         If true, Git will avoid using lstat() calls to detect if files have
2728         changed by setting the "assume-unchanged" bit for those tracked files
2729         which it has updated identically in both the index and working tree.
2730 </p>
2731 <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
2732 the modified files explicitly (e.g. see <em>Examples</em> section in
2733 <a href="git-update-index.html">git-update-index(1)</a>).
2734 Git will not normally detect changes to those files.</p></div>
2735 <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
2736 CIFS/Microsoft Windows.</p></div>
2737 <div class="paragraph"><p>False by default.</p></div>
2738 </dd>
2739 <dt class="hdlist1">
2740 core.preferSymlinkRefs
2741 </dt>
2742 <dd>
2743 <p>
2744         Instead of the default "symref" format for HEAD
2745         and other symbolic reference files, use symbolic links.
2746         This is sometimes needed to work with old scripts that
2747         expect HEAD to be a symbolic link.
2748 </p>
2749 </dd>
2750 <dt class="hdlist1">
2751 core.alternateRefsCommand
2752 </dt>
2753 <dd>
2754 <p>
2755         When advertising tips of available history from an alternate, use the shell to
2756         execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
2757         first argument is the absolute path of the alternate. Output must contain one
2758         hex object id per line (i.e., the same as produced by <code>git for-each-ref
2759         --format='%(objectname)'</code>).
2760 </p>
2761 <div class="paragraph"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
2762 value, as it does not take a repository path as an argument (but you can wrap
2763 the command above in a shell script).</p></div>
2764 </dd>
2765 <dt class="hdlist1">
2766 core.alternateRefsPrefixes
2767 </dt>
2768 <dd>
2769 <p>
2770         When listing references from an alternate, list only references that begin
2771         with the given prefix. Prefixes match as if they were given as arguments to
2772         <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
2773         whitespace. If <code>core.alternateRefsCommand</code> is set, setting
2774         <code>core.alternateRefsPrefixes</code> has no effect.
2775 </p>
2776 </dd>
2777 <dt class="hdlist1">
2778 core.bare
2779 </dt>
2780 <dd>
2781 <p>
2782         If true this repository is assumed to be <em>bare</em> and has no
2783         working directory associated with it.  If this is the case a
2784         number of commands that require a working directory will be
2785         disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
2786 </p>
2787 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
2788 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
2789 repository that ends in "/.git" is assumed to be not bare (bare =
2790 false), while all other repositories are assumed to be bare (bare
2791 = true).</p></div>
2792 </dd>
2793 <dt class="hdlist1">
2794 core.worktree
2795 </dt>
2796 <dd>
2797 <p>
2798         Set the path to the root of the working tree.
2799         If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
2800         is ignored and not used for determining the root of working tree.
2801         This can be overridden by the <code>GIT_WORK_TREE</code> environment
2802         variable and the <code>--work-tree</code> command-line option.
2803         The value can be an absolute path or relative to the path to
2804         the .git directory, which is either specified by --git-dir
2805         or GIT_DIR, or automatically discovered.
2806         If --git-dir or GIT_DIR is specified but none of
2807         --work-tree, GIT_WORK_TREE and core.worktree is specified,
2808         the current working directory is regarded as the top level
2809         of your working tree.
2810 </p>
2811 <div class="paragraph"><p>Note that this variable is honored even when set in a configuration
2812 file in a ".git" subdirectory of a directory and its value differs
2813 from the latter directory (e.g. "/path/to/.git/config" has
2814 core.worktree set to "/different/path"), which is most likely a
2815 misconfiguration.  Running Git commands in the "/path/to" directory will
2816 still use "/different/path" as the root of the work tree and can cause
2817 confusion unless you know what you are doing (e.g. you are creating a
2818 read-only snapshot of the same index to a location different from the
2819 repository&#8217;s usual working tree).</p></div>
2820 </dd>
2821 <dt class="hdlist1">
2822 core.logAllRefUpdates
2823 </dt>
2824 <dd>
2825 <p>
2826         Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
2827         "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
2828         SHA-1, the date/time and the reason of the update, but
2829         only when the file exists.  If this configuration
2830         variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
2831         file is automatically created for branch heads (i.e. under
2832         <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
2833         note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
2834         If it is set to <code>always</code>, then a missing reflog is automatically
2835         created for any ref under <code>refs/</code>.
2836 </p>
2837 <div class="paragraph"><p>This information can be used to determine what commit
2838 was the tip of a branch "2 days ago".</p></div>
2839 <div class="paragraph"><p>This value is true by default in a repository that has
2840 a working directory associated with it, and false by
2841 default in a bare repository.</p></div>
2842 </dd>
2843 <dt class="hdlist1">
2844 core.repositoryFormatVersion
2845 </dt>
2846 <dd>
2847 <p>
2848         Internal variable identifying the repository format and layout
2849         version.
2850 </p>
2851 </dd>
2852 <dt class="hdlist1">
2853 core.sharedRepository
2854 </dt>
2855 <dd>
2856 <p>
2857         When <em>group</em> (or <em>true</em>), the repository is made shareable between
2858         several users in a group (making sure all the files and objects are
2859         group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
2860         repository will be readable by all users, additionally to being
2861         group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
2862         reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
2863         files in the repository will have this mode value. <em>0xxx</em> will override
2864         user&#8217;s umask value (whereas the other options will only override
2865         requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
2866         the repo read/write-able for the owner and group, but inaccessible to
2867         others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
2868         repository that is group-readable but not group-writable.
2869         See <a href="git-init.html">git-init(1)</a>. False by default.
2870 </p>
2871 </dd>
2872 <dt class="hdlist1">
2873 core.warnAmbiguousRefs
2874 </dt>
2875 <dd>
2876 <p>
2877         If true, Git will warn you if the ref name you passed it is ambiguous
2878         and might match multiple refs in the repository. True by default.
2879 </p>
2880 </dd>
2881 <dt class="hdlist1">
2882 core.compression
2883 </dt>
2884 <dd>
2885 <p>
2886         An integer -1..9, indicating a default compression level.
2887         -1 is the zlib default. 0 means no compression,
2888         and 1..9 are various speed/size tradeoffs, 9 being slowest.
2889         If set, this provides a default to other compression variables,
2890         such as <code>core.looseCompression</code> and <code>pack.compression</code>.
2891 </p>
2892 </dd>
2893 <dt class="hdlist1">
2894 core.looseCompression
2895 </dt>
2896 <dd>
2897 <p>
2898         An integer -1..9, indicating the compression level for objects that
2899         are not in a pack file. -1 is the zlib default. 0 means no
2900         compression, and 1..9 are various speed/size tradeoffs, 9 being
2901         slowest.  If not set,  defaults to core.compression.  If that is
2902         not set,  defaults to 1 (best speed).
2903 </p>
2904 </dd>
2905 <dt class="hdlist1">
2906 core.packedGitWindowSize
2907 </dt>
2908 <dd>
2909 <p>
2910         Number of bytes of a pack file to map into memory in a
2911         single mapping operation.  Larger window sizes may allow
2912         your system to process a smaller number of large pack files
2913         more quickly.  Smaller window sizes will negatively affect
2914         performance due to increased calls to the operating system&#8217;s
2915         memory manager, but may improve performance when accessing
2916         a large number of large pack files.
2917 </p>
2918 <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
2919 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
2920 be reasonable for all users/operating systems.  You probably do
2921 not need to adjust this value.</p></div>
2922 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2923 </dd>
2924 <dt class="hdlist1">
2925 core.packedGitLimit
2926 </dt>
2927 <dd>
2928 <p>
2929         Maximum number of bytes to map simultaneously into memory
2930         from pack files.  If Git needs to access more than this many
2931         bytes at once to complete an operation it will unmap existing
2932         regions to reclaim virtual address space within the process.
2933 </p>
2934 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
2935 unlimited) on 64 bit platforms.
2936 This should be reasonable for all users/operating systems, except on
2937 the largest projects.  You probably do not need to adjust this value.</p></div>
2938 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2939 </dd>
2940 <dt class="hdlist1">
2941 core.deltaBaseCacheLimit
2942 </dt>
2943 <dd>
2944 <p>
2945         Maximum number of bytes per thread to reserve for caching base objects
2946         that may be referenced by multiple deltified objects.  By storing the
2947         entire decompressed base objects in a cache Git is able
2948         to avoid unpacking and decompressing frequently used base
2949         objects multiple times.
2950 </p>
2951 <div class="paragraph"><p>Default is 96 MiB on all platforms.  This should be reasonable
2952 for all users/operating systems, except on the largest projects.
2953 You probably do not need to adjust this value.</p></div>
2954 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
2955 </dd>
2956 <dt class="hdlist1">
2957 core.bigFileThreshold
2958 </dt>
2959 <dd>
2960 <p>
2961         The size of files considered "big", which as discussed below
2962         changes the behavior of numerous git commands, as well as how
2963         such files are stored within the repository. The default is
2964         512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
2965         supported.
2966 </p>
2967 <div class="paragraph"><p>Files above the configured limit will be:</p></div>
2968 <div class="ulist"><ul>
2969 <li>
2970 <p>
2971 Stored deflated in packfiles, without attempting delta compression.
2972 </p>
2973 <div class="paragraph"><p>The default limit is primarily set with this use-case in mind. With it,
2974 most projects will have their source code and other text files delta
2975 compressed, but not larger binary media files.</p></div>
2976 <div class="paragraph"><p>Storing large files without delta compression avoids excessive memory
2977 usage, at the slight expense of increased disk usage.</p></div>
2978 </li>
2979 <li>
2980 <p>
2981 Will be treated as if they were labeled "binary" (see
2982   <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
2983   <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.
2984 </p>
2985 </li>
2986 <li>
2987 <p>
2988 Will generally be streamed when written, which avoids excessive
2989 memory usage, at the cost of some fixed overhead. Commands that make
2990 use of this include <a href="git-archive.html">git-archive(1)</a>,
2991 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
2992 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.
2993 </p>
2994 </li>
2995 </ul></div>
2996 </dd>
2997 <dt class="hdlist1">
2998 core.excludesFile
2999 </dt>
3000 <dd>
3001 <p>
3002         Specifies the pathname to the file that contains patterns to
3003         describe paths that are not meant to be tracked, in addition
3004         to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
3005         Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
3006         If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
3007         is used instead. See <a href="gitignore.html">gitignore(5)</a>.
3008 </p>
3009 </dd>
3010 <dt class="hdlist1">
3011 core.askPass
3012 </dt>
3013 <dd>
3014 <p>
3015         Some commands (e.g. svn and http interfaces) that interactively
3016         ask for a password can be told to use an external program given
3017         via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
3018         environment variable. If not set, fall back to the value of the
3019         <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
3020         prompt. The external program shall be given a suitable prompt as
3021         command-line argument and write the password on its STDOUT.
3022 </p>
3023 </dd>
3024 <dt class="hdlist1">
3025 core.attributesFile
3026 </dt>
3027 <dd>
3028 <p>
3029         In addition to <code>.gitattributes</code> (per-directory) and
3030         <code>.git/info/attributes</code>, Git looks into this file for attributes
3031         (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
3032         way as for <code>core.excludesFile</code>. Its default value is
3033         <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
3034         set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
3035 </p>
3036 </dd>
3037 <dt class="hdlist1">
3038 core.hooksPath
3039 </dt>
3040 <dd>
3041 <p>
3042         By default Git will look for your hooks in the
3043         <code>$GIT_DIR/hooks</code> directory. Set this to different path,
3044         e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
3045         that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
3046         in <code>$GIT_DIR/hooks/pre-receive</code>.
3047 </p>
3048 <div class="paragraph"><p>The path can be either absolute or relative. A relative path is
3049 taken as relative to the directory where the hooks are run (see
3050 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
3051 <div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
3052 centrally configure your Git hooks instead of configuring them on a
3053 per-repository basis, or as a more flexible and centralized
3054 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
3055 default hooks.</p></div>
3056 </dd>
3057 <dt class="hdlist1">
3058 core.editor
3059 </dt>
3060 <dd>
3061 <p>
3062         Commands such as <code>commit</code> and <code>tag</code> that let you edit
3063         messages by launching an editor use the value of this
3064         variable when it is set, and the environment variable
3065         <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.
3066 </p>
3067 </dd>
3068 <dt class="hdlist1">
3069 core.commentChar
3070 </dt>
3071 <dd>
3072 <p>
3073         Commands such as <code>commit</code> and <code>tag</code> that let you edit
3074         messages consider a line that begins with this character
3075         commented, and removes them after the editor returns
3076         (default <em>#</em>).
3077 </p>
3078 <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
3079 the beginning character of any line in existing commit messages.</p></div>
3080 </dd>
3081 <dt class="hdlist1">
3082 core.filesRefLockTimeout
3083 </dt>
3084 <dd>
3085 <p>
3086         The length of time, in milliseconds, to retry when trying to
3087         lock an individual reference. Value 0 means not to retry at
3088         all; -1 means to try indefinitely. Default is 100 (i.e.,
3089         retry for 100ms).
3090 </p>
3091 </dd>
3092 <dt class="hdlist1">
3093 core.packedRefsTimeout
3094 </dt>
3095 <dd>
3096 <p>
3097         The length of time, in milliseconds, to retry when trying to
3098         lock the <code>packed-refs</code> file. Value 0 means not to retry at
3099         all; -1 means to try indefinitely. Default is 1000 (i.e.,
3100         retry for 1 second).
3101 </p>
3102 </dd>
3103 <dt class="hdlist1">
3104 core.pager
3105 </dt>
3106 <dd>
3107 <p>
3108         Text viewer for use by Git commands (e.g., <em>less</em>).  The value
3109         is meant to be interpreted by the shell.  The order of preference
3110         is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
3111         configuration, then <code>$PAGER</code>, and then the default chosen at
3112         compile time (usually <em>less</em>).
3113 </p>
3114 <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
3115 (if <code>LESS</code> environment variable is set, Git does not change it at
3116 all).  If you want to selectively override Git&#8217;s default setting
3117 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
3118 be passed to the shell by Git, which will translate the final
3119 command to <code>LESS=FRX less -S</code>. The environment does not set the
3120 <code>S</code> option but the command line does, instructing less to truncate
3121 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
3122 deactivate the <code>F</code> option specified by the environment from the
3123 command-line, deactivating the "quit if one screen" behavior of
3124 <code>less</code>.  One can specifically activate some flags for particular
3125 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
3126 line truncation only for <code>git blame</code>.</p></div>
3127 <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
3128 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
3129 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
3130 </dd>
3131 <dt class="hdlist1">
3132 core.whitespace
3133 </dt>
3134 <dd>
3135 <p>
3136         A comma separated list of common whitespace problems to
3137         notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
3138         highlight them, and <em>git apply --whitespace=error</em> will
3139         consider them as errors.  You can prefix <code>-</code> to disable
3140         any of them (e.g. <code>-trailing-space</code>):
3141 </p>
3142 <div class="ulist"><ul>
3143 <li>
3144 <p>
3145 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
3146   as an error (enabled by default).
3147 </p>
3148 </li>
3149 <li>
3150 <p>
3151 <code>space-before-tab</code> treats a space character that appears immediately
3152   before a tab character in the initial indent part of the line as an
3153   error (enabled by default).
3154 </p>
3155 </li>
3156 <li>
3157 <p>
3158 <code>indent-with-non-tab</code> treats a line that is indented with space
3159   characters instead of the equivalent tabs as an error (not enabled by
3160   default).
3161 </p>
3162 </li>
3163 <li>
3164 <p>
3165 <code>tab-in-indent</code> treats a tab character in the initial indent part of
3166   the line as an error (not enabled by default).
3167 </p>
3168 </li>
3169 <li>
3170 <p>
3171 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
3172   (enabled by default).
3173 </p>
3174 </li>
3175 <li>
3176 <p>
3177 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
3178   <code>blank-at-eof</code>.
3179 </p>
3180 </li>
3181 <li>
3182 <p>
3183 <code>cr-at-eol</code> treats a carriage-return at the end of line as
3184   part of the line terminator, i.e. with it, <code>trailing-space</code>
3185   does not trigger if the character before such a carriage-return
3186   is not a whitespace (not enabled by default).
3187 </p>
3188 </li>
3189 <li>
3190 <p>
3191 <code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
3192   is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
3193   errors. The default tab width is 8. Allowed values are 1 to 63.
3194 </p>
3195 </li>
3196 </ul></div>
3197 </dd>
3198 <dt class="hdlist1">
3199 core.fsync
3200 </dt>
3201 <dd>
3202 <p>
3203         A comma-separated list of components of the repository that
3204         should be hardened via the core.fsyncMethod when created or
3205         modified.  You can disable hardening of any component by
3206         prefixing it with a <em>-</em>.  Items that are not hardened may be
3207         lost in the event of an unclean system shutdown. Unless you
3208         have special requirements, it is recommended that you leave
3209         this option empty or pick one of <code>committed</code>, <code>added</code>,
3210         or <code>all</code>.
3211 </p>
3212 <div class="paragraph"><p>When this configuration is encountered, the set of components starts with
3213 the platform default value, disabled components are removed, and additional
3214 components are added. <code>none</code> resets the state so that the platform default
3215 is ignored.</p></div>
3216 <div class="paragraph"><p>The empty string resets the fsync configuration to the platform
3217 default. The default on most platforms is equivalent to
3218 <code>core.fsync=committed,-loose-object</code>, which has good performance,
3219 but risks losing recent work in the event of an unclean system shutdown.</p></div>
3220 <div class="ulist"><ul>
3221 <li>
3222 <p>
3223 <code>none</code> clears the set of fsynced components.
3224 </p>
3225 </li>
3226 <li>
3227 <p>
3228 <code>loose-object</code> hardens objects added to the repo in loose-object form.
3229 </p>
3230 </li>
3231 <li>
3232 <p>
3233 <code>pack</code> hardens objects added to the repo in packfile form.
3234 </p>
3235 </li>
3236 <li>
3237 <p>
3238 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
3239 </p>
3240 </li>
3241 <li>
3242 <p>
3243 <code>commit-graph</code> hardens the commit-graph file.
3244 </p>
3245 </li>
3246 <li>
3247 <p>
3248 <code>index</code> hardens the index when it is modified.
3249 </p>
3250 </li>
3251 <li>
3252 <p>
3253 <code>objects</code> is an aggregate option that is equivalent to
3254   <code>loose-object,pack</code>.
3255 </p>
3256 </li>
3257 <li>
3258 <p>
3259 <code>reference</code> hardens references modified in the repo.
3260 </p>
3261 </li>
3262 <li>
3263 <p>
3264 <code>derived-metadata</code> is an aggregate option that is equivalent to
3265   <code>pack-metadata,commit-graph</code>.
3266 </p>
3267 </li>
3268 <li>
3269 <p>
3270 <code>committed</code> is an aggregate option that is currently equivalent to
3271   <code>objects</code>. This mode sacrifices some performance to ensure that work
3272   that is committed to the repository with <code>git commit</code> or similar commands
3273   is hardened.
3274 </p>
3275 </li>
3276 <li>
3277 <p>
3278 <code>added</code> is an aggregate option that is currently equivalent to
3279   <code>committed,index</code>. This mode sacrifices additional performance to
3280   ensure that the results of commands like <code>git add</code> and similar operations
3281   are hardened.
3282 </p>
3283 </li>
3284 <li>
3285 <p>
3286 <code>all</code> is an aggregate option that syncs all individual components above.
3287 </p>
3288 </li>
3289 </ul></div>
3290 </dd>
3291 <dt class="hdlist1">
3292 core.fsyncMethod
3293 </dt>
3294 <dd>
3295 <p>
3296         A value indicating the strategy Git will use to harden repository data
3297         using fsync and related primitives.
3298 </p>
3299 <div class="ulist"><ul>
3300 <li>
3301 <p>
3302 <code>fsync</code> uses the fsync() system call or platform equivalents.
3303 </p>
3304 </li>
3305 <li>
3306 <p>
3307 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
3308   filesystem and storage hardware, data added to the repository may not be
3309   durable in the event of a system crash. This is the default mode on macOS.
3310 </p>
3311 </li>
3312 <li>
3313 <p>
3314 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
3315   updates in the disk writeback cache and then does a single full fsync of
3316   a dummy file to trigger the disk cache flush at the end of the operation.
3317 </p>
3318 <div class="paragraph"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
3319 data is made durable as if <code>fsync</code> was specified. This mode is expected to
3320 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
3321 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
3322 </li>
3323 </ul></div>
3324 </dd>
3325 <dt class="hdlist1">
3326 core.fsyncObjectFiles
3327 </dt>
3328 <dd>
3329 <p>
3330         This boolean will enable <em>fsync()</em> when writing object files.
3331         This setting is deprecated. Use core.fsync instead.
3332 </p>
3333 <div class="paragraph"><p>This setting affects data added to the Git repository in loose-object
3334 form. When set to true, Git will issue an fsync or similar system call
3335 to flush caches so that loose-objects remain consistent in the face
3336 of a unclean system shutdown.</p></div>
3337 </dd>
3338 <dt class="hdlist1">
3339 core.preloadIndex
3340 </dt>
3341 <dd>
3342 <p>
3343         Enable parallel index preload for operations like <em>git diff</em>
3344 </p>
3345 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
3346 on filesystems like NFS that have weak caching semantics and thus
3347 relatively high IO latencies.  When enabled, Git will do the
3348 index comparison to the filesystem data in parallel, allowing
3349 overlapping IO&#8217;s.  Defaults to true.</p></div>
3350 </dd>
3351 <dt class="hdlist1">
3352 core.unsetenvvars
3353 </dt>
3354 <dd>
3355 <p>
3356         Windows-only: comma-separated list of environment variables'
3357         names that need to be unset before spawning any other process.
3358         Defaults to <code>PERL5LIB</code> to account for the fact that Git for
3359         Windows insists on using its own Perl interpreter.
3360 </p>
3361 </dd>
3362 <dt class="hdlist1">
3363 core.restrictinheritedhandles
3364 </dt>
3365 <dd>
3366 <p>
3367         Windows-only: override whether spawned processes inherit only standard
3368         file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
3369         <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
3370         Windows 7 and later, and <code>false</code> on older Windows versions.
3371 </p>
3372 </dd>
3373 <dt class="hdlist1">
3374 core.createObject
3375 </dt>
3376 <dd>
3377 <p>
3378         You can set this to <em>link</em>, in which case a hardlink followed by
3379         a delete of the source are used to make sure that object creation
3380         will not overwrite existing objects.
3381 </p>
3382 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
3383 Set this config setting to <em>rename</em> there; However, This will remove the
3384 check that makes sure that existing object files will not get overwritten.</p></div>
3385 </dd>
3386 <dt class="hdlist1">
3387 core.notesRef
3388 </dt>
3389 <dd>
3390 <p>
3391         When showing commit messages, also show notes which are stored in
3392         the given ref.  The ref must be fully qualified.  If the given
3393         ref does not exist, it is not an error but means that no
3394         notes should be printed.
3395 </p>
3396 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
3397 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p></div>
3398 </dd>
3399 <dt class="hdlist1">
3400 core.commitGraph
3401 </dt>
3402 <dd>
3403 <p>
3404         If true, then git will read the commit-graph file (if it exists)
3405         to parse the graph structure of commits. Defaults to true. See
3406         <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
3407 </p>
3408 </dd>
3409 <dt class="hdlist1">
3410 core.useReplaceRefs
3411 </dt>
3412 <dd>
3413 <p>
3414         If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
3415         option was given on the command line. See <a href="git.html">git(1)</a> and
3416         <a href="git-replace.html">git-replace(1)</a> for more information.
3417 </p>
3418 </dd>
3419 <dt class="hdlist1">
3420 core.multiPackIndex
3421 </dt>
3422 <dd>
3423 <p>
3424         Use the multi-pack-index file to track multiple packfiles using a
3425         single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
3426         information. Defaults to true.
3427 </p>
3428 </dd>
3429 <dt class="hdlist1">
3430 core.sparseCheckout
3431 </dt>
3432 <dd>
3433 <p>
3434         Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
3435         for more information.
3436 </p>
3437 </dd>
3438 <dt class="hdlist1">
3439 core.sparseCheckoutCone
3440 </dt>
3441 <dd>
3442 <p>
3443         Enables the "cone mode" of the sparse checkout feature. When the
3444         sparse-checkout file contains a limited set of patterns, this
3445         mode provides significant performance advantages. The "non-cone
3446         mode" can be requested to allow specifying more flexible
3447         patterns by setting this variable to <em>false</em>. See
3448         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.
3449 </p>
3450 </dd>
3451 <dt class="hdlist1">
3452 core.abbrev
3453 </dt>
3454 <dd>
3455 <p>
3456         Set the length object names are abbreviated to.  If
3457         unspecified or set to "auto", an appropriate value is
3458         computed based on the approximate number of packed objects
3459         in your repository, which hopefully is enough for
3460         abbreviated object names to stay unique for some time.
3461         If set to "no", no abbreviation is made and the object names
3462         are shown in their full length.
3463         The minimum length is 4.
3464 </p>
3465 </dd>
3466 <dt class="hdlist1">
3467 core.maxTreeDepth
3468 </dt>
3469 <dd>
3470 <p>
3471         The maximum depth Git is willing to recurse while traversing a
3472         tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
3473         to allow Git to abort cleanly, and should not generally need to
3474         be adjusted. The default is 4096.
3475 </p>
3476 </dd>
3477 <dt class="hdlist1">
3478 add.ignoreErrors
3479 </dt>
3480 <dt class="hdlist1">
3481 add.ignore-errors (deprecated)
3482 </dt>
3483 <dd>
3484 <p>
3485         Tells <em>git add</em> to continue adding files when some files cannot be
3486         added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
3487         option of <a href="git-add.html">git-add(1)</a>.  <code>add.ignore-errors</code> is deprecated,
3488         as it does not follow the usual naming convention for configuration
3489         variables.
3490 </p>
3491 </dd>
3492 <dt class="hdlist1">
3493 add.interactive.useBuiltin
3494 </dt>
3495 <dd>
3496 <p>
3497         Unused configuration variable. Used in Git versions v2.25.0 to
3498         v2.36.0 to enable the built-in version of <a href="git-add.html">git-add(1)</a>'s
3499         interactive mode, which then became the default in Git
3500         versions v2.37.0 to v2.39.0.
3501 </p>
3502 </dd>
3503 <dt class="hdlist1">
3504 alias.*
3505 </dt>
3506 <dd>
3507 <p>
3508         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
3509         after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
3510         <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
3511         confusion and troubles with script usage, aliases that
3512         hide existing Git commands are ignored. Arguments are split by
3513         spaces, the usual shell quoting and escaping are supported.
3514         A quote pair or a backslash can be used to quote them.
3515 </p>
3516 <div class="paragraph"><p>Note that the first word of an alias does not necessarily have to be a
3517 command. It can be a command-line option that will be passed into the
3518 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
3519 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
3520 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
3521 running <code>git loud-rebase</code> would be equivalent to
3522 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
3523 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
3524 where the original command does not.</p></div>
3525 <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
3526 it will be treated as a shell command.  For example, defining
3527 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
3528 <code>git new</code> is equivalent to running the shell command
3529 <code>gitk --all --not ORIG_HEAD</code>.  Note that shell commands will be
3530 executed from the top-level directory of a repository, which may
3531 not necessarily be the current directory.
3532 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
3533 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
3534 </dd>
3535 <dt class="hdlist1">
3536 am.keepcr
3537 </dt>
3538 <dd>
3539 <p>
3540         If true, git-am will call git-mailsplit for patches in mbox format
3541         with parameter <code>--keep-cr</code>. In this case git-mailsplit will
3542         not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
3543         by giving <code>--no-keep-cr</code> from the command line.
3544         See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
3545 </p>
3546 </dd>
3547 <dt class="hdlist1">
3548 am.threeWay
3549 </dt>
3550 <dd>
3551 <p>
3552         By default, <code>git am</code> will fail if the patch does not apply cleanly. When
3553         set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
3554         the patch records the identity of blobs it is supposed to apply to and
3555         we have those blobs available locally (equivalent to giving the <code>--3way</code>
3556         option from the command line). Defaults to <code>false</code>.
3557         See <a href="git-am.html">git-am(1)</a>.
3558 </p>
3559 </dd>
3560 <dt class="hdlist1">
3561 apply.ignoreWhitespace
3562 </dt>
3563 <dd>
3564 <p>
3565         When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
3566         whitespace, in the same way as the <code>--ignore-space-change</code>
3567         option.
3568         When set to one of: no, none, never, false, it tells <em>git apply</em> to
3569         respect all whitespace differences.
3570         See <a href="git-apply.html">git-apply(1)</a>.
3571 </p>
3572 </dd>
3573 <dt class="hdlist1">
3574 apply.whitespace
3575 </dt>
3576 <dd>
3577 <p>
3578         Tells <em>git apply</em> how to handle whitespace, in the same way
3579         as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
3580 </p>
3581 </dd>
3582 <dt class="hdlist1">
3583 blame.blankBoundary
3584 </dt>
3585 <dd>
3586 <p>
3587         Show blank commit object name for boundary commits in
3588         <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.
3589 </p>
3590 </dd>
3591 <dt class="hdlist1">
3592 blame.coloring
3593 </dt>
3594 <dd>
3595 <p>
3596         This determines the coloring scheme to be applied to blame
3597         output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
3598         or <em>none</em> which is the default.
3599 </p>
3600 </dd>
3601 <dt class="hdlist1">
3602 blame.date
3603 </dt>
3604 <dd>
3605 <p>
3606         Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
3607         If unset the iso format is used. For supported values,
3608         see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.
3609 </p>
3610 </dd>
3611 <dt class="hdlist1">
3612 blame.showEmail
3613 </dt>
3614 <dd>
3615 <p>
3616         Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
3617         This option defaults to false.
3618 </p>
3619 </dd>
3620 <dt class="hdlist1">
3621 blame.showRoot
3622 </dt>
3623 <dd>
3624 <p>
3625         Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
3626         This option defaults to false.
3627 </p>
3628 </dd>
3629 <dt class="hdlist1">
3630 blame.ignoreRevsFile
3631 </dt>
3632 <dd>
3633 <p>
3634         Ignore revisions listed in the file, one unabbreviated object name per
3635         line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
3636         <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
3637         file names will reset the list of ignored revisions.  This option will
3638         be handled before the command line option <code>--ignore-revs-file</code>.
3639 </p>
3640 </dd>
3641 <dt class="hdlist1">
3642 blame.markUnblamableLines
3643 </dt>
3644 <dd>
3645 <p>
3646         Mark lines that were changed by an ignored revision that we could not
3647         attribute to another commit with a <em>*</em> in the output of
3648         <a href="git-blame.html">git-blame(1)</a>.
3649 </p>
3650 </dd>
3651 <dt class="hdlist1">
3652 blame.markIgnoredLines
3653 </dt>
3654 <dd>
3655 <p>
3656         Mark lines that were changed by an ignored revision that we attributed to
3657         another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.
3658 </p>
3659 </dd>
3660 <dt class="hdlist1">
3661 branch.autoSetupMerge
3662 </dt>
3663 <dd>
3664 <p>
3665         Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
3666         so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
3667         starting point branch. Note that even if this option is not set,
3668         this behavior can be chosen per-branch using the <code>--track</code>
3669         and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
3670         automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
3671         starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;        automatic setup is done when the starting point is either a
3672         local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
3673         has a tracking configuration, it is copied to the new
3674         branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
3675         is a remote-tracking branch and the new branch has the same name as the
3676         remote branch. This option defaults to true.
3677 </p>
3678 </dd>
3679 <dt class="hdlist1">
3680 branch.autoSetupRebase
3681 </dt>
3682 <dd>
3683 <p>
3684         When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
3685         that tracks another branch, this variable tells Git to set
3686         up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
3687         When <code>never</code>, rebase is never automatically set to true.
3688         When <code>local</code>, rebase is set to true for tracked branches of
3689         other local branches.
3690         When <code>remote</code>, rebase is set to true for tracked branches of
3691         remote-tracking branches.
3692         When <code>always</code>, rebase will be set to true for all tracking
3693         branches.
3694         See "branch.autoSetupMerge" for details on how to set up a
3695         branch to track another branch.
3696         This option defaults to never.
3697 </p>
3698 </dd>
3699 <dt class="hdlist1">
3700 branch.sort
3701 </dt>
3702 <dd>
3703 <p>
3704         This variable controls the sort ordering of branches when displayed by
3705         <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
3706         value of this variable will be used as the default.
3707         See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.
3708 </p>
3709 </dd>
3710 <dt class="hdlist1">
3711 branch.&lt;name&gt;.remote
3712 </dt>
3713 <dd>
3714 <p>
3715         When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
3716         which remote to fetch from or push to.  The remote to push to
3717         may be overridden with <code>remote.pushDefault</code> (for all branches).
3718         The remote to push to, for the current branch, may be further
3719         overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
3720         configured, or if you are not on any branch and there is more than
3721         one remote defined in the repository, it defaults to <code>origin</code> for
3722         fetching and <code>remote.pushDefault</code> for pushing.
3723         Additionally, <code>.</code> (a period) is the current local repository
3724         (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
3725 </p>
3726 </dd>
3727 <dt class="hdlist1">
3728 branch.&lt;name&gt;.pushRemote
3729 </dt>
3730 <dd>
3731 <p>
3732         When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
3733         pushing.  It also overrides <code>remote.pushDefault</code> for pushing
3734         from branch &lt;name&gt;.  When you pull from one place (e.g. your
3735         upstream) and push to another place (e.g. your own publishing
3736         repository), you would want to set <code>remote.pushDefault</code> to
3737         specify the remote to push to for all branches, and use this
3738         option to override it for a specific branch.
3739 </p>
3740 </dd>
3741 <dt class="hdlist1">
3742 branch.&lt;name&gt;.merge
3743 </dt>
3744 <dd>
3745 <p>
3746         Defines, together with branch.&lt;name&gt;.remote, the upstream branch
3747         for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
3748         branch to merge and can also affect <em>git push</em> (see push.default).
3749         When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
3750         refspec to be marked for merging in FETCH_HEAD. The value is
3751         handled like the remote part of a refspec, and must match a
3752         ref which is fetched from the remote given by
3753         "branch.&lt;name&gt;.remote".
3754         The merge information is used by <em>git pull</em> (which first calls
3755         <em>git fetch</em>) to lookup the default branch for merging. Without
3756         this option, <em>git pull</em> defaults to merge the first refspec fetched.
3757         Specify multiple values to get an octopus merge.
3758         If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
3759         another branch in the local repository, you can point
3760         branch.&lt;name&gt;.merge to the desired branch, and use the relative path
3761         setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
3762 </p>
3763 </dd>
3764 <dt class="hdlist1">
3765 branch.&lt;name&gt;.mergeOptions
3766 </dt>
3767 <dd>
3768 <p>
3769         Sets default options for merging into branch &lt;name&gt;. The syntax and
3770         supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
3771         option values containing whitespace characters are currently not
3772         supported.
3773 </p>
3774 </dd>
3775 <dt class="hdlist1">
3776 branch.&lt;name&gt;.rebase
3777 </dt>
3778 <dd>
3779 <p>
3780         When true, rebase the branch &lt;name&gt; on top of the fetched branch,
3781         instead of merging the default branch from the default remote when
3782         "git pull" is run. See "pull.rebase" for doing this in a non
3783         branch-specific manner.
3784 </p>
3785 <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>
3786 so that the local merge commits are included in the rebase (see
3787 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
3788 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
3789 mode.</p></div>
3790 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
3791 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
3792 for details).</p></div>
3793 </dd>
3794 <dt class="hdlist1">
3795 branch.&lt;name&gt;.description
3796 </dt>
3797 <dd>
3798 <p>
3799         Branch description, can be edited with
3800         <code>git branch --edit-description</code>. Branch description is
3801         automatically added to the format-patch cover letter or
3802         request-pull summary.
3803 </p>
3804 </dd>
3805 <dt class="hdlist1">
3806 browser.&lt;tool&gt;.cmd
3807 </dt>
3808 <dd>
3809 <p>
3810         Specify the command to invoke the specified browser. The
3811         specified command is evaluated in shell with the URLs passed
3812         as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
3813 </p>
3814 </dd>
3815 <dt class="hdlist1">
3816 browser.&lt;tool&gt;.path
3817 </dt>
3818 <dd>
3819 <p>
3820         Override the path for the given tool that may be used to
3821         browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
3822         working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
3823 </p>
3824 </dd>
3825 <dt class="hdlist1">
3826 bundle.*
3827 </dt>
3828 <dd>
3829 <p>
3830         The <code>bundle.*</code> keys may appear in a bundle list file found via the
3831         <code>git clone --bundle-uri</code> option. These keys currently have no effect
3832         if placed in a repository config file, though this will change in the
3833         future. See <a href="technical/bundle-uri.html">the bundle URI design
3834         document</a> for more details.
3835 </p>
3836 </dd>
3837 <dt class="hdlist1">
3838 bundle.version
3839 </dt>
3840 <dd>
3841 <p>
3842         This integer value advertises the version of the bundle list format
3843         used by the bundle list. Currently, the only accepted value is <code>1</code>.
3844 </p>
3845 </dd>
3846 <dt class="hdlist1">
3847 bundle.mode
3848 </dt>
3849 <dd>
3850 <p>
3851         This string value should be either <code>all</code> or <code>any</code>. This value describes
3852         whether all of the advertised bundles are required to unbundle a
3853         complete understanding of the bundled information (<code>all</code>) or if any one
3854         of the listed bundle URIs is sufficient (<code>any</code>).
3855 </p>
3856 </dd>
3857 <dt class="hdlist1">
3858 bundle.heuristic
3859 </dt>
3860 <dd>
3861 <p>
3862         If this string-valued key exists, then the bundle list is designed to
3863         work well with incremental <code>git fetch</code> commands. The heuristic signals
3864         that there are additional keys available for each bundle that help
3865         determine which subset of bundles the client should download. The
3866         only value currently understood is <code>creationToken</code>.
3867 </p>
3868 </dd>
3869 <dt class="hdlist1">
3870 bundle.&lt;id&gt;.*
3871 </dt>
3872 <dd>
3873 <p>
3874         The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
3875         bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.
3876 </p>
3877 </dd>
3878 <dt class="hdlist1">
3879 bundle.&lt;id&gt;.uri
3880 </dt>
3881 <dd>
3882 <p>
3883         This string value defines the URI by which Git can reach the contents
3884         of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.
3885 </p>
3886 </dd>
3887 <dt class="hdlist1">
3888 checkout.defaultRemote
3889 </dt>
3890 <dd>
3891 <p>
3892         When you run <code>git checkout &lt;something&gt;</code>
3893         or <code>git switch &lt;something&gt;</code> and only have one
3894         remote, it may implicitly fall back on checking out and
3895         tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
3896         as you have more than one remote with a <code>&lt;something&gt;</code>
3897         reference. This setting allows for setting the name of a
3898         preferred remote that should always win when it comes to
3899         disambiguation. The typical use-case is to set this to
3900         <code>origin</code>.
3901 </p>
3902 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
3903 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
3904 or <code>git switch &lt;something&gt;</code>
3905 will checkout the <code>&lt;something&gt;</code> branch on another remote,
3906 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
3907 remote branch. This setting might be used for other checkout-like
3908 commands or functionality in the future.</p></div>
3909 </dd>
3910 <dt class="hdlist1">
3911 checkout.guess
3912 </dt>
3913 <dd>
3914 <p>
3915         Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
3916         option in <code>git checkout</code> and <code>git switch</code>. See
3917         <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
3918 </p>
3919 </dd>
3920 <dt class="hdlist1">
3921 checkout.workers
3922 </dt>
3923 <dd>
3924 <p>
3925         The number of parallel workers to use when updating the working tree.
3926         The default is one, i.e. sequential execution. If set to a value less
3927         than one, Git will use as many workers as the number of logical cores
3928         available. This setting and <code>checkout.thresholdForParallelism</code> affect
3929         all commands that perform checkout. E.g. checkout, clone, reset,
3930         sparse-checkout, etc.
3931 </p>
3932 <div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories
3933 located on SSDs or over NFS. For repositories on spinning disks and/or machines
3934 with a small number of cores, the default sequential checkout often performs
3935 better. The size and compression level of a repository might also influence how
3936 well the parallel version performs.</p></div>
3937 </dd>
3938 <dt class="hdlist1">
3939 checkout.thresholdForParallelism
3940 </dt>
3941 <dd>
3942 <p>
3943         When running parallel checkout with a small number of files, the cost
3944         of subprocess spawning and inter-process communication might outweigh
3945         the parallelization gains. This setting allows you to define the minimum
3946         number of files for which parallel checkout should be attempted. The
3947         default is 100.
3948 </p>
3949 </dd>
3950 <dt class="hdlist1">
3951 clean.requireForce
3952 </dt>
3953 <dd>
3954 <p>
3955         A boolean to make git-clean do nothing unless given -f,
3956         -i, or -n.  Defaults to true.
3957 </p>
3958 </dd>
3959 <dt class="hdlist1">
3960 clone.defaultRemoteName
3961 </dt>
3962 <dd>
3963 <p>
3964         The name of the remote to create when cloning a repository.  Defaults to
3965         <code>origin</code>, and can be overridden by passing the <code>--origin</code> command-line
3966         option to <a href="git-clone.html">git-clone(1)</a>.
3967 </p>
3968 </dd>
3969 <dt class="hdlist1">
3970 clone.rejectShallow
3971 </dt>
3972 <dd>
3973 <p>
3974         Reject cloning a repository if it is a shallow one; this can be overridden by
3975         passing the <code>--reject-shallow</code> option on the command line. See <a href="git-clone.html">git-clone(1)</a>
3976 </p>
3977 </dd>
3978 <dt class="hdlist1">
3979 clone.filterSubmodules
3980 </dt>
3981 <dd>
3982 <p>
3983         If a partial clone filter is provided (see <code>--filter</code> in
3984         <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
3985         the filter to submodules.
3986 </p>
3987 </dd>
3988 <dt class="hdlist1">
3989 color.advice
3990 </dt>
3991 <dd>
3992 <p>
3993         A boolean to enable/disable color in hints (e.g. when a push
3994         failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
3995         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
3996         are used only when the error output goes to a terminal. If
3997         unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3998 </p>
3999 </dd>
4000 <dt class="hdlist1">
4001 color.advice.hint
4002 </dt>
4003 <dd>
4004 <p>
4005         Use customized color for hints.
4006 </p>
4007 </dd>
4008 <dt class="hdlist1">
4009 color.blame.highlightRecent
4010 </dt>
4011 <dd>
4012 <p>
4013         Specify the line annotation color for <code>git blame --color-by-age</code>
4014         depending upon the age of the line.
4015 </p>
4016 <div class="paragraph"><p>This setting should be set to a comma-separated list of color and
4017 date settings, starting and ending with a color, the dates should be
4018 set from oldest to newest. The metadata will be colored with the
4019 specified colors if the line was introduced before the given
4020 timestamp, overwriting older timestamped colors.</p></div>
4021 <div class="paragraph"><p>Instead of an absolute timestamp relative timestamps work as well,
4022 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
4023 <div class="paragraph"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
4024 colors everything older than one year blue, recent changes between
4025 one month and one year old are kept white, and lines introduced
4026 within the last month are colored red.</p></div>
4027 </dd>
4028 <dt class="hdlist1">
4029 color.blame.repeatedLines
4030 </dt>
4031 <dd>
4032 <p>
4033         Use the specified color to colorize line annotations for
4034         <code>git blame --color-lines</code>, if they come from the same commit as the
4035         preceding line. Defaults to cyan.
4036 </p>
4037 </dd>
4038 <dt class="hdlist1">
4039 color.branch
4040 </dt>
4041 <dd>
4042 <p>
4043         A boolean to enable/disable color in the output of
4044         <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
4045         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4046         only when the output is to a terminal. If unset, then the
4047         value of <code>color.ui</code> is used (<code>auto</code> by default).
4048 </p>
4049 </dd>
4050 <dt class="hdlist1">
4051 color.branch.&lt;slot&gt;
4052 </dt>
4053 <dd>
4054 <p>
4055         Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
4056         <code>current</code> (the current branch), <code>local</code> (a local branch),
4057         <code>remote</code> (a remote-tracking branch in refs/remotes/),
4058         <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
4059         refs).
4060 </p>
4061 </dd>
4062 <dt class="hdlist1">
4063 color.diff
4064 </dt>
4065 <dd>
4066 <p>
4067         Whether to use ANSI escape sequences to add color to patches.
4068         If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
4069         <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
4070         for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
4071         commands will only use color when output is to the terminal.
4072         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
4073         default).
4074 </p>
4075 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
4076 <em>git-diff-&#42;</em> plumbing commands.  Can be overridden on the
4077 command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
4078 </dd>
4079 <dt class="hdlist1">
4080 color.diff.&lt;slot&gt;
4081 </dt>
4082 <dd>
4083 <p>
4084         Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
4085         which part of the patch to use the specified color, and is one
4086         of <code>context</code> (context text - <code>plain</code> is a historical synonym),
4087         <code>meta</code> (metainformation), <code>frag</code>
4088         (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
4089         <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
4090         (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
4091         <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
4092         <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
4093         <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
4094         setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
4095         <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
4096         <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).
4097 </p>
4098 </dd>
4099 <dt class="hdlist1">
4100 color.decorate.&lt;slot&gt;
4101 </dt>
4102 <dd>
4103 <p>
4104         Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
4105         of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
4106         branches, remote-tracking branches, tags, stash and HEAD, respectively
4107         and <code>grafted</code> for grafted commits.
4108 </p>
4109 </dd>
4110 <dt class="hdlist1">
4111 color.grep
4112 </dt>
4113 <dd>
4114 <p>
4115         When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
4116         <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
4117         when the output is written to the terminal.  If unset, then the
4118         value of <code>color.ui</code> is used (<code>auto</code> by default).
4119 </p>
4120 </dd>
4121 <dt class="hdlist1">
4122 color.grep.&lt;slot&gt;
4123 </dt>
4124 <dd>
4125 <p>
4126         Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
4127         part of the line to use the specified color, and is one of
4128 </p>
4129 <div class="openblock">
4130 <div class="content">
4131 <div class="dlist"><dl>
4132 <dt class="hdlist1">
4133 <code>context</code>
4134 </dt>
4135 <dd>
4136 <p>
4137         non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
4138 </p>
4139 </dd>
4140 <dt class="hdlist1">
4141 <code>filename</code>
4142 </dt>
4143 <dd>
4144 <p>
4145         filename prefix (when not using <code>-h</code>)
4146 </p>
4147 </dd>
4148 <dt class="hdlist1">
4149 <code>function</code>
4150 </dt>
4151 <dd>
4152 <p>
4153         function name lines (when using <code>-p</code>)
4154 </p>
4155 </dd>
4156 <dt class="hdlist1">
4157 <code>lineNumber</code>
4158 </dt>
4159 <dd>
4160 <p>
4161         line number prefix (when using <code>-n</code>)
4162 </p>
4163 </dd>
4164 <dt class="hdlist1">
4165 <code>column</code>
4166 </dt>
4167 <dd>
4168 <p>
4169         column number prefix (when using <code>--column</code>)
4170 </p>
4171 </dd>
4172 <dt class="hdlist1">
4173 <code>match</code>
4174 </dt>
4175 <dd>
4176 <p>
4177         matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
4178 </p>
4179 </dd>
4180 <dt class="hdlist1">
4181 <code>matchContext</code>
4182 </dt>
4183 <dd>
4184 <p>
4185         matching text in context lines
4186 </p>
4187 </dd>
4188 <dt class="hdlist1">
4189 <code>matchSelected</code>
4190 </dt>
4191 <dd>
4192 <p>
4193         matching text in selected lines. Also, used to customize the following
4194         <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.
4195 </p>
4196 </dd>
4197 <dt class="hdlist1">
4198 <code>selected</code>
4199 </dt>
4200 <dd>
4201 <p>
4202         non-matching text in selected lines. Also, used to customize the
4203         following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
4204         <code>--committer</code>.
4205 </p>
4206 </dd>
4207 <dt class="hdlist1">
4208 <code>separator</code>
4209 </dt>
4210 <dd>
4211 <p>
4212         separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
4213         and between hunks (<code>--</code>)
4214 </p>
4215 </dd>
4216 </dl></div>
4217 </div></div>
4218 </dd>
4219 <dt class="hdlist1">
4220 color.interactive
4221 </dt>
4222 <dd>
4223 <p>
4224         When set to <code>always</code>, always use colors for interactive prompts
4225         and displays (such as those used by "git-add --interactive" and
4226         "git-clean --interactive"). When false (or <code>never</code>), never.
4227         When set to <code>true</code> or <code>auto</code>, use colors only when the output is
4228         to the terminal. If unset, then the value of <code>color.ui</code> is
4229         used (<code>auto</code> by default).
4230 </p>
4231 </dd>
4232 <dt class="hdlist1">
4233 color.interactive.&lt;slot&gt;
4234 </dt>
4235 <dd>
4236 <p>
4237         Use customized color for <em>git add --interactive</em> and <em>git clean
4238         --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
4239         or <code>error</code>, for four distinct types of normal output from
4240         interactive commands.
4241 </p>
4242 </dd>
4243 <dt class="hdlist1">
4244 color.pager
4245 </dt>
4246 <dd>
4247 <p>
4248         A boolean to specify whether <code>auto</code> color modes should colorize
4249         output going to the pager. Defaults to true; set this to false
4250         if your pager does not understand ANSI color codes.
4251 </p>
4252 </dd>
4253 <dt class="hdlist1">
4254 color.push
4255 </dt>
4256 <dd>
4257 <p>
4258         A boolean to enable/disable color in push errors. May be set to
4259         <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
4260         case colors are used only when the error output goes to a terminal.
4261         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
4262 </p>
4263 </dd>
4264 <dt class="hdlist1">
4265 color.push.error
4266 </dt>
4267 <dd>
4268 <p>
4269         Use customized color for push errors.
4270 </p>
4271 </dd>
4272 <dt class="hdlist1">
4273 color.remote
4274 </dt>
4275 <dd>
4276 <p>
4277         If set, keywords at the start of the line are highlighted. The
4278         keywords are "error", "warning", "hint" and "success", and are
4279         matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
4280         <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
4281         <code>color.ui</code> is used (<code>auto</code> by default).
4282 </p>
4283 </dd>
4284 <dt class="hdlist1">
4285 color.remote.&lt;slot&gt;
4286 </dt>
4287 <dd>
4288 <p>
4289         Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
4290         <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
4291         corresponding keyword.
4292 </p>
4293 </dd>
4294 <dt class="hdlist1">
4295 color.showBranch
4296 </dt>
4297 <dd>
4298 <p>
4299         A boolean to enable/disable color in the output of
4300         <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
4301         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4302         only when the output is to a terminal. If unset, then the
4303         value of <code>color.ui</code> is used (<code>auto</code> by default).
4304 </p>
4305 </dd>
4306 <dt class="hdlist1">
4307 color.status
4308 </dt>
4309 <dd>
4310 <p>
4311         A boolean to enable/disable color in the output of
4312         <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
4313         <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
4314         only when the output is to a terminal. If unset, then the
4315         value of <code>color.ui</code> is used (<code>auto</code> by default).
4316 </p>
4317 </dd>
4318 <dt class="hdlist1">
4319 color.status.&lt;slot&gt;
4320 </dt>
4321 <dd>
4322 <p>
4323         Use customized color for status colorization. <code>&lt;slot&gt;</code> is
4324         one of <code>header</code> (the header text of the status message),
4325         <code>added</code> or <code>updated</code> (files which are added but not committed),
4326         <code>changed</code> (files which are changed but not added in the index),
4327         <code>untracked</code> (files which are not tracked by Git),
4328         <code>branch</code> (the current branch),
4329         <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
4330         to red),
4331         <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
4332         respectively, when branch and tracking information is displayed in the
4333         status short-format), or
4334         <code>unmerged</code> (files which have unmerged changes).
4335 </p>
4336 </dd>
4337 <dt class="hdlist1">
4338 color.transport
4339 </dt>
4340 <dd>
4341 <p>
4342         A boolean to enable/disable color when pushes are rejected. May be
4343         set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
4344         case colors are used only when the error output goes to a terminal.
4345         If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
4346 </p>
4347 </dd>
4348 <dt class="hdlist1">
4349 color.transport.rejected
4350 </dt>
4351 <dd>
4352 <p>
4353         Use customized color when a push was rejected.
4354 </p>
4355 </dd>
4356 <dt class="hdlist1">
4357 color.ui
4358 </dt>
4359 <dd>
4360 <p>
4361         This variable determines the default value for variables such
4362         as <code>color.diff</code> and <code>color.grep</code> that control the use of color
4363         per command family. Its scope will expand as more commands learn
4364         configuration to set a default for the <code>--color</code> option.  Set it
4365         to <code>false</code> or <code>never</code> if you prefer Git commands not to use
4366         color unless enabled explicitly with some other configuration
4367         or the <code>--color</code> option. Set it to <code>always</code> if you want all
4368         output not intended for machine consumption to use color, to
4369         <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
4370         want such output to use color when written to the terminal.
4371 </p>
4372 </dd>
4373 <dt class="hdlist1">
4374 column.ui
4375 </dt>
4376 <dd>
4377 <p>
4378         Specify whether supported commands should output in columns.
4379         This variable consists of a list of tokens separated by spaces
4380         or commas:
4381 </p>
4382 <div class="paragraph"><p>These options control when the feature should be enabled
4383 (defaults to <em>never</em>):</p></div>
4384 <div class="openblock">
4385 <div class="content">
4386 <div class="dlist"><dl>
4387 <dt class="hdlist1">
4388 <code>always</code>
4389 </dt>
4390 <dd>
4391 <p>
4392         always show in columns
4393 </p>
4394 </dd>
4395 <dt class="hdlist1">
4396 <code>never</code>
4397 </dt>
4398 <dd>
4399 <p>
4400         never show in columns
4401 </p>
4402 </dd>
4403 <dt class="hdlist1">
4404 <code>auto</code>
4405 </dt>
4406 <dd>
4407 <p>
4408         show in columns if the output is to the terminal
4409 </p>
4410 </dd>
4411 </dl></div>
4412 </div></div>
4413 <div class="paragraph"><p>These options control layout (defaults to <em>column</em>).  Setting any
4414 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
4415 specified.</p></div>
4416 <div class="openblock">
4417 <div class="content">
4418 <div class="dlist"><dl>
4419 <dt class="hdlist1">
4420 <code>column</code>
4421 </dt>
4422 <dd>
4423 <p>
4424         fill columns before rows
4425 </p>
4426 </dd>
4427 <dt class="hdlist1">
4428 <code>row</code>
4429 </dt>
4430 <dd>
4431 <p>
4432         fill rows before columns
4433 </p>
4434 </dd>
4435 <dt class="hdlist1">
4436 <code>plain</code>
4437 </dt>
4438 <dd>
4439 <p>
4440         show in one column
4441 </p>
4442 </dd>
4443 </dl></div>
4444 </div></div>
4445 <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
4446 to <em>nodense</em>):</p></div>
4447 <div class="openblock">
4448 <div class="content">
4449 <div class="dlist"><dl>
4450 <dt class="hdlist1">
4451 <code>dense</code>
4452 </dt>
4453 <dd>
4454 <p>
4455         make unequal size columns to utilize more space
4456 </p>
4457 </dd>
4458 <dt class="hdlist1">
4459 <code>nodense</code>
4460 </dt>
4461 <dd>
4462 <p>
4463         make equal size columns
4464 </p>
4465 </dd>
4466 </dl></div>
4467 </div></div>
4468 </dd>
4469 <dt class="hdlist1">
4470 column.branch
4471 </dt>
4472 <dd>
4473 <p>
4474         Specify whether to output branch listing in <code>git branch</code> in columns.
4475         See <code>column.ui</code> for details.
4476 </p>
4477 </dd>
4478 <dt class="hdlist1">
4479 column.clean
4480 </dt>
4481 <dd>
4482 <p>
4483         Specify the layout when listing items in <code>git clean -i</code>, which always
4484         shows files and directories in columns. See <code>column.ui</code> for details.
4485 </p>
4486 </dd>
4487 <dt class="hdlist1">
4488 column.status
4489 </dt>
4490 <dd>
4491 <p>
4492         Specify whether to output untracked files in <code>git status</code> in columns.
4493         See <code>column.ui</code> for details.
4494 </p>
4495 </dd>
4496 <dt class="hdlist1">
4497 column.tag
4498 </dt>
4499 <dd>
4500 <p>
4501         Specify whether to output tag listings in <code>git tag</code> in columns.
4502         See <code>column.ui</code> for details.
4503 </p>
4504 </dd>
4505 <dt class="hdlist1">
4506 commit.cleanup
4507 </dt>
4508 <dd>
4509 <p>
4510         This setting overrides the default of the <code>--cleanup</code> option in
4511         <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
4512         default can be useful when you always want to keep lines that begin
4513         with the comment character <code>#</code> in your log message, in which case you
4514         would do <code>git config commit.cleanup whitespace</code> (note that you will
4515         have to remove the help lines that begin with <code>#</code> in the commit log
4516         template yourself, if you do this).
4517 </p>
4518 </dd>
4519 <dt class="hdlist1">
4520 commit.gpgSign
4521 </dt>
4522 <dd>
4523 <p>
4524         A boolean to specify whether all commits should be GPG signed.
4525         Use of this option when doing operations such as rebase can
4526         result in a large number of commits being signed. It may be
4527         convenient to use an agent to avoid typing your GPG passphrase
4528         several times.
4529 </p>
4530 </dd>
4531 <dt class="hdlist1">
4532 commit.status
4533 </dt>
4534 <dd>
4535 <p>
4536         A boolean to enable/disable inclusion of status information in the
4537         commit message template when using an editor to prepare the commit
4538         message.  Defaults to true.
4539 </p>
4540 </dd>
4541 <dt class="hdlist1">
4542 commit.template
4543 </dt>
4544 <dd>
4545 <p>
4546         Specify the pathname of a file to use as the template for
4547         new commit messages.
4548 </p>
4549 </dd>
4550 <dt class="hdlist1">
4551 commit.verbose
4552 </dt>
4553 <dd>
4554 <p>
4555         A boolean or int to specify the level of verbosity with <code>git commit</code>.
4556         See <a href="git-commit.html">git-commit(1)</a>.
4557 </p>
4558 </dd>
4559 <dt class="hdlist1">
4560 commitGraph.generationVersion
4561 </dt>
4562 <dd>
4563 <p>
4564         Specifies the type of generation number version to use when writing
4565         or reading the commit-graph file. If version 1 is specified, then
4566         the corrected commit dates will not be written or read. Defaults to
4567         2.
4568 </p>
4569 </dd>
4570 <dt class="hdlist1">
4571 commitGraph.maxNewFilters
4572 </dt>
4573 <dd>
4574 <p>
4575         Specifies the default value for the <code>--max-new-filters</code> option of <code>git
4576         commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).
4577 </p>
4578 </dd>
4579 <dt class="hdlist1">
4580 commitGraph.readChangedPaths
4581 </dt>
4582 <dd>
4583 <p>
4584         If true, then git will use the changed-path Bloom filters in the
4585         commit-graph file (if it exists, and they are present). Defaults to
4586         true. See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.
4587 </p>
4588 </dd>
4589 <dt class="hdlist1">
4590 credential.helper
4591 </dt>
4592 <dd>
4593 <p>
4594         Specify an external helper to be called when a username or
4595         password credential is needed; the helper may consult external
4596         storage to avoid prompting the user for the credentials. This is
4597         normally the name of a credential helper with possible
4598         arguments, but may also be an absolute path with arguments or, if
4599         preceded by <code>!</code>, shell commands.
4600 </p>
4601 <div class="paragraph"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
4602 for details and examples.</p></div>
4603 </dd>
4604 <dt class="hdlist1">
4605 credential.useHttpPath
4606 </dt>
4607 <dd>
4608 <p>
4609         When acquiring credentials, consider the "path" component of an http
4610         or https URL to be important. Defaults to false. See
4611         <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
4612 </p>
4613 </dd>
4614 <dt class="hdlist1">
4615 credential.username
4616 </dt>
4617 <dd>
4618 <p>
4619         If no username is set for a network authentication, use this username
4620         by default. See credential.&lt;context&gt;.* below, and
4621         <a href="gitcredentials.html">gitcredentials(7)</a>.
4622 </p>
4623 </dd>
4624 <dt class="hdlist1">
4625 credential.&lt;url&gt;.*
4626 </dt>
4627 <dd>
4628 <p>
4629         Any of the credential.* options above can be applied selectively to
4630         some credentials. For example, "credential.https://example.com.username"
4631         would set the default username only for https connections to
4632         example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
4633         matched.
4634 </p>
4635 </dd>
4636 <dt class="hdlist1">
4637 credentialCache.ignoreSIGHUP
4638 </dt>
4639 <dd>
4640 <p>
4641         Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
4642 </p>
4643 </dd>
4644 <dt class="hdlist1">
4645 credentialStore.lockTimeoutMS
4646 </dt>
4647 <dd>
4648 <p>
4649         The length of time, in milliseconds, for git-credential-store to retry
4650         when trying to lock the credentials file. A value of 0 means not to retry at
4651         all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
4652         1s).
4653 </p>
4654 </dd>
4655 <dt class="hdlist1">
4656 completion.commands
4657 </dt>
4658 <dd>
4659 <p>
4660         This is only used by git-completion.bash to add or remove
4661         commands from the list of completed commands. Normally only
4662         porcelain commands and a few select others are completed. You
4663         can add more commands, separated by space, in this
4664         variable. Prefixing the command with <em>-</em> will remove it from
4665         the existing list.
4666 </p>
4667 </dd>
4668 <dt class="hdlist1">
4669 diff.autoRefreshIndex
4670 </dt>
4671 <dd>
4672 <p>
4673         When using <em>git diff</em> to compare with work tree
4674         files, do not consider stat-only changes as changed.
4675         Instead, silently run <code>git update-index --refresh</code> to
4676         update the cached stat information for paths whose
4677         contents in the work tree match the contents in the
4678         index.  This option defaults to true.  Note that this
4679         affects only <em>git diff</em> Porcelain, and not lower level
4680         <em>diff</em> commands such as <em>git diff-files</em>.
4681 </p>
4682 </dd>
4683 <dt class="hdlist1">
4684 diff.dirstat
4685 </dt>
4686 <dd>
4687 <p>
4688         A comma separated list of <code>--dirstat</code> parameters specifying the
4689         default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
4690         and friends. The defaults can be overridden on the command line
4691         (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
4692         (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
4693         The following parameters are available:
4694 </p>
4695 <div class="openblock">
4696 <div class="content">
4697 <div class="dlist"><dl>
4698 <dt class="hdlist1">
4699 <code>changes</code>
4700 </dt>
4701 <dd>
4702 <p>
4703         Compute the dirstat numbers by counting the lines that have been
4704         removed from the source, or added to the destination. This ignores
4705         the amount of pure code movements within a file.  In other words,
4706         rearranging lines in a file is not counted as much as other changes.
4707         This is the default behavior when no parameter is given.
4708 </p>
4709 </dd>
4710 <dt class="hdlist1">
4711 <code>lines</code>
4712 </dt>
4713 <dd>
4714 <p>
4715         Compute the dirstat numbers by doing the regular line-based diff
4716         analysis, and summing the removed/added line counts. (For binary
4717         files, count 64-byte chunks instead, since binary files have no
4718         natural concept of lines). This is a more expensive <code>--dirstat</code>
4719         behavior than the <code>changes</code> behavior, but it does count rearranged
4720         lines within a file as much as other changes. The resulting output
4721         is consistent with what you get from the other <code>--*stat</code> options.
4722 </p>
4723 </dd>
4724 <dt class="hdlist1">
4725 <code>files</code>
4726 </dt>
4727 <dd>
4728 <p>
4729         Compute the dirstat numbers by counting the number of files changed.
4730         Each changed file counts equally in the dirstat analysis. This is
4731         the computationally cheapest <code>--dirstat</code> behavior, since it does
4732         not have to look at the file contents at all.
4733 </p>
4734 </dd>
4735 <dt class="hdlist1">
4736 <code>cumulative</code>
4737 </dt>
4738 <dd>
4739 <p>
4740         Count changes in a child directory for the parent directory as well.
4741         Note that when using <code>cumulative</code>, the sum of the percentages
4742         reported may exceed 100%. The default (non-cumulative) behavior can
4743         be specified with the <code>noncumulative</code> parameter.
4744 </p>
4745 </dd>
4746 <dt class="hdlist1">
4747 &lt;limit&gt;
4748 </dt>
4749 <dd>
4750 <p>
4751         An integer parameter specifies a cut-off percent (3% by default).
4752         Directories contributing less than this percentage of the changes
4753         are not shown in the output.
4754 </p>
4755 </dd>
4756 </dl></div>
4757 </div></div>
4758 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
4759 directories with less than 10% of the total amount of changed files,
4760 and accumulating child directory counts in the parent directories:
4761 <code>files,10,cumulative</code>.</p></div>
4762 </dd>
4763 <dt class="hdlist1">
4764 diff.statNameWidth
4765 </dt>
4766 <dd>
4767 <p>
4768         Limit the width of the filename part in --stat output. If set, applies
4769         to all commands generating --stat output except format-patch.
4770 </p>
4771 </dd>
4772 <dt class="hdlist1">
4773 diff.statGraphWidth
4774 </dt>
4775 <dd>
4776 <p>
4777         Limit the width of the graph part in --stat output. If set, applies
4778         to all commands generating --stat output except format-patch.
4779 </p>
4780 </dd>
4781 <dt class="hdlist1">
4782 diff.context
4783 </dt>
4784 <dd>
4785 <p>
4786         Generate diffs with &lt;n&gt; lines of context instead of the default
4787         of 3. This value is overridden by the -U option.
4788 </p>
4789 </dd>
4790 <dt class="hdlist1">
4791 diff.interHunkContext
4792 </dt>
4793 <dd>
4794 <p>
4795         Show the context between diff hunks, up to the specified number
4796         of lines, thereby fusing the hunks that are close to each other.
4797         This value serves as the default for the <code>--inter-hunk-context</code>
4798         command line option.
4799 </p>
4800 </dd>
4801 <dt class="hdlist1">
4802 diff.external
4803 </dt>
4804 <dd>
4805 <p>
4806         If this config variable is set, diff generation is not
4807         performed using the internal diff machinery, but using the
4808         given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
4809         environment variable.  The command is called with parameters
4810         as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
4811         you want to use an external diff program only on a subset of
4812         your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
4813 </p>
4814 </dd>
4815 <dt class="hdlist1">
4816 diff.ignoreSubmodules
4817 </dt>
4818 <dd>
4819 <p>
4820         Sets the default value of --ignore-submodules. Note that this
4821         affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
4822         commands such as <em>git diff-files</em>. <em>git checkout</em>
4823         and <em>git switch</em> also honor
4824         this setting when reporting uncommitted changes. Setting it to
4825         <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
4826         and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
4827         overridden by using the --ignore-submodules command-line option.
4828         The <em>git submodule</em> commands are not affected by this setting.
4829         By default this is set to untracked so that any untracked
4830         submodules are ignored.
4831 </p>
4832 </dd>
4833 <dt class="hdlist1">
4834 diff.mnemonicPrefix
4835 </dt>
4836 <dd>
4837 <p>
4838         If set, <em>git diff</em> uses a prefix pair that is different from the
4839         standard "a/" and "b/" depending on what is being compared.  When
4840         this configuration is in effect, reverse diff output also swaps
4841         the order of the prefixes:
4842 </p>
4843 <div class="dlist"><dl>
4844 <dt class="hdlist1">
4845 <code>git diff</code>
4846 </dt>
4847 <dd>
4848 <p>
4849         compares the (i)ndex and the (w)ork tree;
4850 </p>
4851 </dd>
4852 <dt class="hdlist1">
4853 <code>git diff HEAD</code>
4854 </dt>
4855 <dd>
4856 <p>
4857          compares a (c)ommit and the (w)ork tree;
4858 </p>
4859 </dd>
4860 <dt class="hdlist1">
4861 <code>git diff --cached</code>
4862 </dt>
4863 <dd>
4864 <p>
4865         compares a (c)ommit and the (i)ndex;
4866 </p>
4867 </dd>
4868 <dt class="hdlist1">
4869 <code>git diff HEAD:file1 file2</code>
4870 </dt>
4871 <dd>
4872 <p>
4873         compares an (o)bject and a (w)ork tree entity;
4874 </p>
4875 </dd>
4876 <dt class="hdlist1">
4877 <code>git diff --no-index a b</code>
4878 </dt>
4879 <dd>
4880 <p>
4881         compares two non-git things (1) and (2).
4882 </p>
4883 </dd>
4884 </dl></div>
4885 </dd>
4886 <dt class="hdlist1">
4887 diff.noprefix
4888 </dt>
4889 <dd>
4890 <p>
4891         If set, <em>git diff</em> does not show any source or destination prefix.
4892 </p>
4893 </dd>
4894 <dt class="hdlist1">
4895 diff.relative
4896 </dt>
4897 <dd>
4898 <p>
4899         If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
4900         and show pathnames relative to the current directory.
4901 </p>
4902 </dd>
4903 <dt class="hdlist1">
4904 diff.orderFile
4905 </dt>
4906 <dd>
4907 <p>
4908         File indicating how to order files within a diff.
4909         See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
4910         If <code>diff.orderFile</code> is a relative pathname, it is treated as
4911         relative to the top of the working tree.
4912 </p>
4913 </dd>
4914 <dt class="hdlist1">
4915 diff.renameLimit
4916 </dt>
4917 <dd>
4918 <p>
4919         The number of files to consider in the exhaustive portion of
4920         copy/rename detection; equivalent to the <em>git diff</em> option
4921         <code>-l</code>.  If not set, the default value is currently 1000.  This
4922         setting has no effect if rename detection is turned off.
4923 </p>
4924 </dd>
4925 <dt class="hdlist1">
4926 diff.renames
4927 </dt>
4928 <dd>
4929 <p>
4930         Whether and how Git detects renames.  If set to "false",
4931         rename detection is disabled. If set to "true", basic rename
4932         detection is enabled.  If set to "copies" or "copy", Git will
4933         detect copies, as well.  Defaults to true.  Note that this
4934         affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
4935         <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
4936         <a href="git-diff-files.html">git-diff-files(1)</a>.
4937 </p>
4938 </dd>
4939 <dt class="hdlist1">
4940 diff.suppressBlankEmpty
4941 </dt>
4942 <dd>
4943 <p>
4944         A boolean to inhibit the standard behavior of printing a space
4945         before each empty output line. Defaults to false.
4946 </p>
4947 </dd>
4948 <dt class="hdlist1">
4949 diff.submodule
4950 </dt>
4951 <dd>
4952 <p>
4953         Specify the format in which differences in submodules are
4954         shown.  The "short" format just shows the names of the commits
4955         at the beginning and end of the range. The "log" format lists
4956         the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
4957         does. The "diff" format shows an inline diff of the changed
4958         contents of the submodule. Defaults to "short".
4959 </p>
4960 </dd>
4961 <dt class="hdlist1">
4962 diff.wordRegex
4963 </dt>
4964 <dd>
4965 <p>
4966         A POSIX Extended Regular Expression used to determine what is a "word"
4967         when performing word-by-word difference calculations.  Character
4968         sequences that match the regular expression are "words", all other
4969         characters are <strong>ignorable</strong> whitespace.
4970 </p>
4971 </dd>
4972 <dt class="hdlist1">
4973 diff.&lt;driver&gt;.command
4974 </dt>
4975 <dd>
4976 <p>
4977         The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
4978         for details.
4979 </p>
4980 </dd>
4981 <dt class="hdlist1">
4982 diff.&lt;driver&gt;.xfuncname
4983 </dt>
4984 <dd>
4985 <p>
4986         The regular expression that the diff driver should use to
4987         recognize the hunk header.  A built-in pattern may also be used.
4988         See <a href="gitattributes.html">gitattributes(5)</a> for details.
4989 </p>
4990 </dd>
4991 <dt class="hdlist1">
4992 diff.&lt;driver&gt;.binary
4993 </dt>
4994 <dd>
4995 <p>
4996         Set this option to true to make the diff driver treat files as
4997         binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
4998 </p>
4999 </dd>
5000 <dt class="hdlist1">
5001 diff.&lt;driver&gt;.textconv
5002 </dt>
5003 <dd>
5004 <p>
5005         The command that the diff driver should call to generate the
5006         text-converted version of a file.  The result of the
5007         conversion is used to generate a human-readable diff.  See
5008         <a href="gitattributes.html">gitattributes(5)</a> for details.
5009 </p>
5010 </dd>
5011 <dt class="hdlist1">
5012 diff.&lt;driver&gt;.wordRegex
5013 </dt>
5014 <dd>
5015 <p>
5016         The regular expression that the diff driver should use to
5017         split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
5018         details.
5019 </p>
5020 </dd>
5021 <dt class="hdlist1">
5022 diff.&lt;driver&gt;.cachetextconv
5023 </dt>
5024 <dd>
5025 <p>
5026         Set this option to true to make the diff driver cache the text
5027         conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
5028 </p>
5029 <div class="dlist"><dl>
5030 <dt class="hdlist1">
5031 <code>araxis</code>
5032 </dt>
5033 <dd>
5034 <p>
5035 Use Araxis Merge (requires a graphical session)
5036 </p>
5037 </dd>
5038 <dt class="hdlist1">
5039 <code>bc</code>
5040 </dt>
5041 <dd>
5042 <p>
5043 Use Beyond Compare (requires a graphical session)
5044 </p>
5045 </dd>
5046 <dt class="hdlist1">
5047 <code>bc3</code>
5048 </dt>
5049 <dd>
5050 <p>
5051 Use Beyond Compare (requires a graphical session)
5052 </p>
5053 </dd>
5054 <dt class="hdlist1">
5055 <code>bc4</code>
5056 </dt>
5057 <dd>
5058 <p>
5059 Use Beyond Compare (requires a graphical session)
5060 </p>
5061 </dd>
5062 <dt class="hdlist1">
5063 <code>codecompare</code>
5064 </dt>
5065 <dd>
5066 <p>
5067 Use Code Compare (requires a graphical session)
5068 </p>
5069 </dd>
5070 <dt class="hdlist1">
5071 <code>deltawalker</code>
5072 </dt>
5073 <dd>
5074 <p>
5075 Use DeltaWalker (requires a graphical session)
5076 </p>
5077 </dd>
5078 <dt class="hdlist1">
5079 <code>diffmerge</code>
5080 </dt>
5081 <dd>
5082 <p>
5083 Use DiffMerge (requires a graphical session)
5084 </p>
5085 </dd>
5086 <dt class="hdlist1">
5087 <code>diffuse</code>
5088 </dt>
5089 <dd>
5090 <p>
5091 Use Diffuse (requires a graphical session)
5092 </p>
5093 </dd>
5094 <dt class="hdlist1">
5095 <code>ecmerge</code>
5096 </dt>
5097 <dd>
5098 <p>
5099 Use ECMerge (requires a graphical session)
5100 </p>
5101 </dd>
5102 <dt class="hdlist1">
5103 <code>emerge</code>
5104 </dt>
5105 <dd>
5106 <p>
5107 Use Emacs' Emerge
5108 </p>
5109 </dd>
5110 <dt class="hdlist1">
5111 <code>examdiff</code>
5112 </dt>
5113 <dd>
5114 <p>
5115 Use ExamDiff Pro (requires a graphical session)
5116 </p>
5117 </dd>
5118 <dt class="hdlist1">
5119 <code>guiffy</code>
5120 </dt>
5121 <dd>
5122 <p>
5123 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
5124 </p>
5125 </dd>
5126 <dt class="hdlist1">
5127 <code>gvimdiff</code>
5128 </dt>
5129 <dd>
5130 <p>
5131 Use gVim (requires a graphical session)
5132 </p>
5133 </dd>
5134 <dt class="hdlist1">
5135 <code>kdiff3</code>
5136 </dt>
5137 <dd>
5138 <p>
5139 Use KDiff3 (requires a graphical session)
5140 </p>
5141 </dd>
5142 <dt class="hdlist1">
5143 <code>kompare</code>
5144 </dt>
5145 <dd>
5146 <p>
5147 Use Kompare (requires a graphical session)
5148 </p>
5149 </dd>
5150 <dt class="hdlist1">
5151 <code>meld</code>
5152 </dt>
5153 <dd>
5154 <p>
5155 Use Meld (requires a graphical session)
5156 </p>
5157 </dd>
5158 <dt class="hdlist1">
5159 <code>nvimdiff</code>
5160 </dt>
5161 <dd>
5162 <p>
5163 Use Neovim
5164 </p>
5165 </dd>
5166 <dt class="hdlist1">
5167 <code>opendiff</code>
5168 </dt>
5169 <dd>
5170 <p>
5171 Use FileMerge (requires a graphical session)
5172 </p>
5173 </dd>
5174 <dt class="hdlist1">
5175 <code>p4merge</code>
5176 </dt>
5177 <dd>
5178 <p>
5179 Use HelixCore P4Merge (requires a graphical session)
5180 </p>
5181 </dd>
5182 <dt class="hdlist1">
5183 <code>smerge</code>
5184 </dt>
5185 <dd>
5186 <p>
5187 Use Sublime Merge (requires a graphical session)
5188 </p>
5189 </dd>
5190 <dt class="hdlist1">
5191 <code>tkdiff</code>
5192 </dt>
5193 <dd>
5194 <p>
5195 Use TkDiff (requires a graphical session)
5196 </p>
5197 </dd>
5198 <dt class="hdlist1">
5199 <code>vimdiff</code>
5200 </dt>
5201 <dd>
5202 <p>
5203 Use Vim
5204 </p>
5205 </dd>
5206 <dt class="hdlist1">
5207 <code>winmerge</code>
5208 </dt>
5209 <dd>
5210 <p>
5211 Use WinMerge (requires a graphical session)
5212 </p>
5213 </dd>
5214 <dt class="hdlist1">
5215 <code>xxdiff</code>
5216 </dt>
5217 <dd>
5218 <p>
5219 Use xxdiff (requires a graphical session)
5220 </p>
5221 </dd>
5222 </dl></div>
5223 </dd>
5224 <dt class="hdlist1">
5225 diff.indentHeuristic
5226 </dt>
5227 <dd>
5228 <p>
5229         Set this option to <code>false</code> to disable the default heuristics
5230         that shift diff hunk boundaries to make patches easier to read.
5231 </p>
5232 </dd>
5233 <dt class="hdlist1">
5234 diff.algorithm
5235 </dt>
5236 <dd>
5237 <p>
5238         Choose a diff algorithm.  The variants are as follows:
5239 </p>
5240 <div class="openblock">
5241 <div class="content">
5242 <div class="dlist"><dl>
5243 <dt class="hdlist1">
5244 <code>default</code>, <code>myers</code>
5245 </dt>
5246 <dd>
5247 <p>
5248         The basic greedy diff algorithm. Currently, this is the default.
5249 </p>
5250 </dd>
5251 <dt class="hdlist1">
5252 <code>minimal</code>
5253 </dt>
5254 <dd>
5255 <p>
5256         Spend extra time to make sure the smallest possible diff is
5257         produced.
5258 </p>
5259 </dd>
5260 <dt class="hdlist1">
5261 <code>patience</code>
5262 </dt>
5263 <dd>
5264 <p>
5265         Use "patience diff" algorithm when generating patches.
5266 </p>
5267 </dd>
5268 <dt class="hdlist1">
5269 <code>histogram</code>
5270 </dt>
5271 <dd>
5272 <p>
5273         This algorithm extends the patience algorithm to "support
5274         low-occurrence common elements".
5275 </p>
5276 </dd>
5277 </dl></div>
5278 </div></div>
5279 </dd>
5280 <dt class="hdlist1">
5281 diff.wsErrorHighlight
5282 </dt>
5283 <dd>
5284 <p>
5285         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5286         lines of the diff.  Multiple values are separated by comma,
5287         <code>none</code> resets previous values, <code>default</code> reset the list to
5288         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
5289         whitespace errors are colored with <code>color.diff.whitespace</code>.
5290         The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
5291         overrides this setting.
5292 </p>
5293 </dd>
5294 <dt class="hdlist1">
5295 diff.colorMoved
5296 </dt>
5297 <dd>
5298 <p>
5299         If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
5300         in a diff are colored differently, for details of valid modes
5301         see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
5302         true the default color mode will be used. When set to false,
5303         moved lines are not colored.
5304 </p>
5305 </dd>
5306 <dt class="hdlist1">
5307 diff.colorMovedWS
5308 </dt>
5309 <dd>
5310 <p>
5311         When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5312         this option controls the <code>&lt;mode&gt;</code> how spaces are treated
5313         for details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.
5314 </p>
5315 </dd>
5316 <dt class="hdlist1">
5317 diff.tool
5318 </dt>
5319 <dd>
5320 <p>
5321         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
5322         This variable overrides the value configured in <code>merge.tool</code>.
5323         The list below shows the valid built-in values.
5324         Any other value is treated as a custom diff tool and requires
5325         that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
5326 </p>
5327 </dd>
5328 <dt class="hdlist1">
5329 diff.guitool
5330 </dt>
5331 <dd>
5332 <p>
5333         Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
5334         the -g/--gui flag is specified. This variable overrides the value
5335         configured in <code>merge.guitool</code>. The list below shows the valid
5336         built-in values. Any other value is treated as a custom diff tool
5337         and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
5338         is defined.
5339 </p>
5340 </dd>
5341 <dt class="hdlist1">
5342 difftool.&lt;tool&gt;.cmd
5343 </dt>
5344 <dd>
5345 <p>
5346         Specify the command to invoke the specified diff tool.
5347         The specified command is evaluated in shell with the following
5348         variables available:  <em>LOCAL</em> is set to the name of the temporary
5349         file containing the contents of the diff pre-image and <em>REMOTE</em>
5350         is set to the name of the temporary file containing the contents
5351         of the diff post-image.
5352 </p>
5353 <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>
5354 </dd>
5355 <dt class="hdlist1">
5356 difftool.&lt;tool&gt;.path
5357 </dt>
5358 <dd>
5359 <p>
5360         Override the path for the given tool.  This is useful in case
5361         your tool is not in the PATH.
5362 </p>
5363 </dd>
5364 <dt class="hdlist1">
5365 difftool.trustExitCode
5366 </dt>
5367 <dd>
5368 <p>
5369         Exit difftool if the invoked diff tool returns a non-zero exit status.
5370 </p>
5371 <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>
5372 </dd>
5373 <dt class="hdlist1">
5374 difftool.prompt
5375 </dt>
5376 <dd>
5377 <p>
5378         Prompt before each invocation of the diff tool.
5379 </p>
5380 </dd>
5381 <dt class="hdlist1">
5382 difftool.guiDefault
5383 </dt>
5384 <dd>
5385 <p>
5386         Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5387         the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5388         depending on the presence of a <code>DISPLAY</code> environment variable value. The
5389         default is <code>false</code>, where the <code>--gui</code> argument must be provided
5390         explicitly for the <code>diff.guitool</code> to be used.
5391 </p>
5392 </dd>
5393 <dt class="hdlist1">
5394 extensions.objectFormat
5395 </dt>
5396 <dd>
5397 <p>
5398         Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
5399         <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
5400         this key unless <code>core.repositoryFormatVersion</code> is 1.
5401 </p>
5402 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5403 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
5404 work and will produce hard-to-diagnose issues.</p></div>
5405 </dd>
5406 <dt class="hdlist1">
5407 extensions.refStorage
5408 </dt>
5409 <dd>
5410 <p>
5411         Specify the ref storage format to use. The acceptable values are:
5412 </p>
5413 <div class="ulist"><ul>
5414 <li>
5415 <p>
5416 <code>files</code> for loose files with packed-refs. This is the default.
5417 </p>
5418 <div class="paragraph"><p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p></div>
5419 <div class="paragraph"><p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
5420 <a href="git-clone.html">git-clone(1)</a>. Trying to change it after initialization will not
5421 work and will produce hard-to-diagnose issues.</p></div>
5422 </li>
5423 </ul></div>
5424 </dd>
5425 <dt class="hdlist1">
5426 extensions.worktreeConfig
5427 </dt>
5428 <dd>
5429 <p>
5430         If enabled, then worktrees will load config settings from the
5431         <code>$GIT_DIR/config.worktree</code> file in addition to the
5432         <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5433         <code>$GIT_DIR</code> are the same for the main working tree, while other
5434         working trees have <code>$GIT_DIR</code> equal to
5435         <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
5436         <code>config.worktree</code> file will override settings from any other
5437         config files.
5438 </p>
5439 <div class="paragraph"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5440 certain values from the common config file to the main working tree&#8217;s
5441 <code>config.worktree</code> file, if present:</p></div>
5442 <div class="ulist"><ul>
5443 <li>
5444 <p>
5445 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5446   <code>$GIT_COMMON_DIR/config.worktree</code>.
5447 </p>
5448 </li>
5449 <li>
5450 <p>
5451 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5452   to <code>$GIT_COMMON_DIR/config.worktree</code>.
5453 </p>
5454 <div class="paragraph"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5455 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5456 sparse-checkout settings for each worktree. By default, the <code>git
5457 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5458 these config values on a per-worktree basis, and uses the
5459 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5460 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
5461 details.</p></div>
5462 <div class="paragraph"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5463 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5464 </li>
5465 </ul></div>
5466 </dd>
5467 <dt class="hdlist1">
5468 fastimport.unpackLimit
5469 </dt>
5470 <dd>
5471 <p>
5472         If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
5473         is below this limit, then the objects will be unpacked into
5474         loose object files.  However, if the number of imported objects
5475         equals or exceeds this limit, then the pack will be stored as a
5476         pack.  Storing the pack from a fast-import can make the import
5477         operation complete faster, especially on slow filesystems.  If
5478         not set, the value of <code>transfer.unpackLimit</code> is used instead.
5479 </p>
5480 </dd>
5481 <dt class="hdlist1">
5482 feature.*
5483 </dt>
5484 <dd>
5485 <p>
5486         The config settings that start with <code>feature.</code> modify the defaults of
5487         a group of other config settings. These groups are created by the Git
5488         developer community as recommended defaults and are subject to change.
5489         In particular, new config options may be added with different defaults.
5490 </p>
5491 </dd>
5492 <dt class="hdlist1">
5493 feature.experimental
5494 </dt>
5495 <dd>
5496 <p>
5497         Enable config options that are new to Git, and are being considered for
5498         future defaults. Config settings included here may be added or removed
5499         with each release, including minor version updates. These settings may
5500         have unintended interactions since they are so new. Please enable this
5501         setting if you are interested in providing feedback on experimental
5502         features. The new default values are:
5503 </p>
5504 <div class="ulist"><ul>
5505 <li>
5506 <p>
5507 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5508 skipping more commits at a time, reducing the number of round trips.
5509 </p>
5510 </li>
5511 <li>
5512 <p>
5513 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5514 walking fewer objects.
5515 </p>
5516 </li>
5517 <li>
5518 <p>
5519 <code>pack.allowPackReuse=multi</code> may improve the time it takes to create a pack by
5520 reusing objects from multiple packs instead of just one.
5521 </p>
5522 </li>
5523 </ul></div>
5524 </dd>
5525 <dt class="hdlist1">
5526 feature.manyFiles
5527 </dt>
5528 <dd>
5529 <p>
5530         Enable config options that optimize for repos with many files in the
5531         working directory. With many files, commands such as <code>git status</code> and
5532         <code>git checkout</code> may be slow and these new defaults improve performance:
5533 </p>
5534 <div class="ulist"><ul>
5535 <li>
5536 <p>
5537 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5538   checksum. Note that this will cause Git versions earlier than 2.13.0 to
5539   refuse to parse the index and Git versions earlier than 2.40.0 will report
5540   a corrupted index during <code>git fsck</code>.
5541 </p>
5542 </li>
5543 <li>
5544 <p>
5545 <code>index.version=4</code> enables path-prefix compression in the index.
5546 </p>
5547 </li>
5548 <li>
5549 <p>
5550 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5551 that mtime is working on your machine.
5552 </p>
5553 </li>
5554 </ul></div>
5555 </dd>
5556 <dt class="hdlist1">
5557 fetch.recurseSubmodules
5558 </dt>
5559 <dd>
5560 <p>
5561         This option controls whether <code>git fetch</code> (and the underlying fetch
5562         in <code>git pull</code>) will recursively fetch into populated submodules.
5563         This option can be set either to a boolean value or to <em>on-demand</em>.
5564         Setting it to a boolean changes the behavior of fetch and pull to
5565         recurse unconditionally into submodules when set to true or to not
5566         recurse at all when set to false. When set to <em>on-demand</em>, fetch and
5567         pull will only recurse into a populated submodule when its
5568         superproject retrieves a commit that updates the submodule&#8217;s
5569         reference.
5570         Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
5571 </p>
5572 </dd>
5573 <dt class="hdlist1">
5574 fetch.fsckObjects
5575 </dt>
5576 <dd>
5577 <p>
5578         If it is set to true, git-fetch-pack will check all fetched
5579         objects. See <code>transfer.fsckObjects</code> for what&#8217;s
5580         checked. Defaults to false. If not set, the value of
5581         <code>transfer.fsckObjects</code> is used instead.
5582 </p>
5583 </dd>
5584 <dt class="hdlist1">
5585 fetch.fsck.&lt;msg-id&gt;
5586 </dt>
5587 <dd>
5588 <p>
5589         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
5590         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5591         the <code>fsck.&lt;msg-id&gt;</code> documentation for details.
5592 </p>
5593 </dd>
5594 <dt class="hdlist1">
5595 fetch.fsck.skipList
5596 </dt>
5597 <dd>
5598 <p>
5599         Acts like <code>fsck.skipList</code>, but is used by
5600         <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
5601         the <code>fsck.skipList</code> documentation for details.
5602 </p>
5603 </dd>
5604 <dt class="hdlist1">
5605 fetch.unpackLimit
5606 </dt>
5607 <dd>
5608 <p>
5609         If the number of objects fetched over the Git native
5610         transfer is below this
5611         limit, then the objects will be unpacked into loose object
5612         files. However if the number of received objects equals or
5613         exceeds this limit then the received pack will be stored as
5614         a pack, after adding any missing delta bases.  Storing the
5615         pack from a push can make the push operation complete faster,
5616         especially on slow filesystems.  If not set, the value of
5617         <code>transfer.unpackLimit</code> is used instead.
5618 </p>
5619 </dd>
5620 <dt class="hdlist1">
5621 fetch.prune
5622 </dt>
5623 <dd>
5624 <p>
5625         If true, fetch will automatically behave as if the <code>--prune</code>
5626         option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
5627         and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.
5628 </p>
5629 </dd>
5630 <dt class="hdlist1">
5631 fetch.pruneTags
5632 </dt>
5633 <dd>
5634 <p>
5635         If true, fetch will automatically behave as if the
5636         <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
5637         if not set already. This allows for setting both this option
5638         and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
5639         refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
5640         section of <a href="git-fetch.html">git-fetch(1)</a>.
5641 </p>
5642 </dd>
5643 <dt class="hdlist1">
5644 fetch.all
5645 </dt>
5646 <dd>
5647 <p>
5648         If true, fetch will attempt to update all available remotes.
5649         This behavior can be overridden by passing <code>--no-all</code> or by
5650         explicitly specifying one or more remote(s) to fetch from.
5651         Defaults to false.
5652 </p>
5653 </dd>
5654 <dt class="hdlist1">
5655 fetch.output
5656 </dt>
5657 <dd>
5658 <p>
5659         Control how ref update status is printed. Valid values are
5660         <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
5661         OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.
5662 </p>
5663 </dd>
5664 <dt class="hdlist1">
5665 fetch.negotiationAlgorithm
5666 </dt>
5667 <dd>
5668 <p>
5669         Control how information about the commits in the local repository
5670         is sent when negotiating the contents of the packfile to be sent by
5671         the server.  Set to "consecutive" to use an algorithm that walks
5672         over consecutive commits checking each one.  Set to "skipping" to
5673         use an algorithm that skips commits in an effort to converge
5674         faster, but may result in a larger-than-necessary packfile; or set
5675         to "noop" to not send any information at all, which will almost
5676         certainly result in a larger-than-necessary packfile, but will skip
5677         the negotiation step.  Set to "default" to override settings made
5678         previously and use the default behaviour.  The default is normally
5679         "consecutive", but if <code>feature.experimental</code> is true, then the
5680         default is "skipping".  Unknown values will cause <em>git fetch</em> to
5681         error out.
5682 </p>
5683 <div class="paragraph"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
5684 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
5685 </dd>
5686 <dt class="hdlist1">
5687 fetch.showForcedUpdates
5688 </dt>
5689 <dd>
5690 <p>
5691         Set to false to enable <code>--no-show-forced-updates</code> in
5692         <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
5693         Defaults to true.
5694 </p>
5695 </dd>
5696 <dt class="hdlist1">
5697 fetch.parallel
5698 </dt>
5699 <dd>
5700 <p>
5701         Specifies the maximal number of fetch operations to be run in parallel
5702         at a time (submodules, or remotes when the <code>--multiple</code> option of
5703         <a href="git-fetch.html">git-fetch(1)</a> is in effect).
5704 </p>
5705 <div class="paragraph"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
5706 <div class="paragraph"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
5707 config setting.</p></div>
5708 </dd>
5709 <dt class="hdlist1">
5710 fetch.writeCommitGraph
5711 </dt>
5712 <dd>
5713 <p>
5714         Set to true to write a commit-graph after every <code>git fetch</code> command
5715         that downloads a pack-file from a remote. Using the <code>--split</code> option,
5716         most executions will create a very small commit-graph file on top of
5717         the existing commit-graph file(s). Occasionally, these files will
5718         merge and the write may take longer. Having an updated commit-graph
5719         file helps performance of many Git commands, including <code>git merge-base</code>,
5720         <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
5721 </p>
5722 </dd>
5723 <dt class="hdlist1">
5724 fetch.bundleURI
5725 </dt>
5726 <dd>
5727 <p>
5728         This value stores a URI for downloading Git object data from a bundle
5729         URI before performing an incremental fetch from the origin Git server.
5730         This is similar to how the <code>--bundle-uri</code> option behaves in
5731         <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
5732         <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
5733         list that is organized for incremental fetches.
5734 </p>
5735 <div class="paragraph"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
5736 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
5737 the new bundle URI.</p></div>
5738 </dd>
5739 <dt class="hdlist1">
5740 fetch.bundleCreationToken
5741 </dt>
5742 <dd>
5743 <p>
5744         When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
5745         list that uses the "creationToken" heuristic, this config value
5746         stores the maximum <code>creationToken</code> value of the downloaded bundles.
5747         This value is used to prevent downloading bundles in the future
5748         if the advertised <code>creationToken</code> is not strictly larger than this
5749         value.
5750 </p>
5751 <div class="paragraph"><p>The creation token values are chosen by the provider serving the specific
5752 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
5753 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
5754 </dd>
5755 <dt class="hdlist1">
5756 format.attach
5757 </dt>
5758 <dd>
5759 <p>
5760         Enable multipart/mixed attachments as the default for
5761         <em>format-patch</em>.  The value can also be a double quoted string
5762         which will enable attachments as the default and set the
5763         value as the boundary.  See the --attach option in
5764         <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
5765         value, set it to an empty string.
5766 </p>
5767 </dd>
5768 <dt class="hdlist1">
5769 format.from
5770 </dt>
5771 <dd>
5772 <p>
5773         Provides the default value for the <code>--from</code> option to format-patch.
5774         Accepts a boolean value, or a name and email address.  If false,
5775         format-patch defaults to <code>--no-from</code>, using commit authors directly in
5776         the "From:" field of patch mails.  If true, format-patch defaults to
5777         <code>--from</code>, using your committer identity in the "From:" field of patch
5778         mails and including a "From:" field in the body of the patch mail if
5779         different.  If set to a non-boolean value, format-patch uses that
5780         value instead of your committer identity.  Defaults to false.
5781 </p>
5782 </dd>
5783 <dt class="hdlist1">
5784 format.forceInBodyFrom
5785 </dt>
5786 <dd>
5787 <p>
5788         Provides the default value for the <code>--[no-]force-in-body-from</code>
5789         option to format-patch.  Defaults to false.
5790 </p>
5791 </dd>
5792 <dt class="hdlist1">
5793 format.numbered
5794 </dt>
5795 <dd>
5796 <p>
5797         A boolean which can enable or disable sequence numbers in patch
5798         subjects.  It defaults to "auto" which enables it only if there
5799         is more than one patch.  It can be enabled or disabled for all
5800         messages by setting it to "true" or "false".  See --numbered
5801         option in <a href="git-format-patch.html">git-format-patch(1)</a>.
5802 </p>
5803 </dd>
5804 <dt class="hdlist1">
5805 format.headers
5806 </dt>
5807 <dd>
5808 <p>
5809         Additional email headers to include in a patch to be submitted
5810         by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.
5811 </p>
5812 </dd>
5813 <dt class="hdlist1">
5814 format.to
5815 </dt>
5816 <dt class="hdlist1">
5817 format.cc
5818 </dt>
5819 <dd>
5820 <p>
5821         Additional recipients to include in a patch to be submitted
5822         by mail.  See the --to and --cc options in
5823         <a href="git-format-patch.html">git-format-patch(1)</a>.
5824 </p>
5825 </dd>
5826 <dt class="hdlist1">
5827 format.subjectPrefix
5828 </dt>
5829 <dd>
5830 <p>
5831         The default for format-patch is to output files with the <em>[PATCH]</em>
5832         subject prefix. Use this variable to change that prefix.
5833 </p>
5834 </dd>
5835 <dt class="hdlist1">
5836 format.coverFromDescription
5837 </dt>
5838 <dd>
5839 <p>
5840         The default mode for format-patch to determine which parts of
5841         the cover letter will be populated using the branch&#8217;s
5842         description. See the <code>--cover-from-description</code> option in
5843         <a href="git-format-patch.html">git-format-patch(1)</a>.
5844 </p>
5845 </dd>
5846 <dt class="hdlist1">
5847 format.signature
5848 </dt>
5849 <dd>
5850 <p>
5851         The default for format-patch is to output a signature containing
5852         the Git version number. Use this variable to change that default.
5853         Set this variable to the empty string ("") to suppress
5854         signature generation.
5855 </p>
5856 </dd>
5857 <dt class="hdlist1">
5858 format.signatureFile
5859 </dt>
5860 <dd>
5861 <p>
5862         Works just like format.signature except the contents of the
5863         file specified by this variable will be used as the signature.
5864 </p>
5865 </dd>
5866 <dt class="hdlist1">
5867 format.suffix
5868 </dt>
5869 <dd>
5870 <p>
5871         The default for format-patch is to output files with the suffix
5872         <code>.patch</code>. Use this variable to change that suffix (make sure to
5873         include the dot if you want it).
5874 </p>
5875 </dd>
5876 <dt class="hdlist1">
5877 format.encodeEmailHeaders
5878 </dt>
5879 <dd>
5880 <p>
5881         Encode email headers that have non-ASCII characters with
5882         "Q-encoding" (described in RFC 2047) for email transmission.
5883         Defaults to true.
5884 </p>
5885 </dd>
5886 <dt class="hdlist1">
5887 format.pretty
5888 </dt>
5889 <dd>
5890 <p>
5891         The default pretty format for log/show/whatchanged command.
5892         See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
5893         <a href="git-whatchanged.html">git-whatchanged(1)</a>.
5894 </p>
5895 </dd>
5896 <dt class="hdlist1">
5897 format.thread
5898 </dt>
5899 <dd>
5900 <p>
5901         The default threading style for <em>git format-patch</em>.  Can be
5902         a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
5903         makes every mail a reply to the head of the series,
5904         where the head is chosen from the cover letter, the
5905         <code>--in-reply-to</code>, and the first patch mail, in this order.
5906         <code>deep</code> threading makes every mail a reply to the previous one.
5907         A true boolean value is the same as <code>shallow</code>, and a false
5908         value disables threading.
5909 </p>
5910 </dd>
5911 <dt class="hdlist1">
5912 format.signOff
5913 </dt>
5914 <dd>
5915 <p>
5916         A boolean value which lets you enable the <code>-s/--signoff</code> option of
5917         format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
5918         patch should be a conscious act and means that you certify you have
5919         the rights to submit this work under the same open source license.
5920         Please see the <em>SubmittingPatches</em> document for further discussion.
5921 </p>
5922 </dd>
5923 <dt class="hdlist1">
5924 format.coverLetter
5925 </dt>
5926 <dd>
5927 <p>
5928         A boolean that controls whether to generate a cover-letter when
5929         format-patch is invoked, but in addition can be set to "auto", to
5930         generate a cover-letter only when there&#8217;s more than one patch.
5931         Default is false.
5932 </p>
5933 </dd>
5934 <dt class="hdlist1">
5935 format.outputDirectory
5936 </dt>
5937 <dd>
5938 <p>
5939         Set a custom directory to store the resulting files instead of the
5940         current working directory. All directory components will be created.
5941 </p>
5942 </dd>
5943 <dt class="hdlist1">
5944 format.filenameMaxLength
5945 </dt>
5946 <dd>
5947 <p>
5948         The maximum length of the output filenames generated by the
5949         <code>format-patch</code> command; defaults to 64.  Can be overridden
5950         by the <code>--filename-max-length=&lt;n&gt;</code> command line option.
5951 </p>
5952 </dd>
5953 <dt class="hdlist1">
5954 format.useAutoBase
5955 </dt>
5956 <dd>
5957 <p>
5958         A boolean value which lets you enable the <code>--base=auto</code> option of
5959         format-patch by default. Can also be set to "whenAble" to allow
5960         enabling <code>--base=auto</code> if a suitable base is available, but to skip
5961         adding base info otherwise without the format dying.
5962 </p>
5963 </dd>
5964 <dt class="hdlist1">
5965 format.notes
5966 </dt>
5967 <dd>
5968 <p>
5969         Provides the default value for the <code>--notes</code> option to
5970         format-patch. Accepts a boolean value, or a ref which specifies
5971         where to get notes. If false, format-patch defaults to
5972         <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
5973         set to a non-boolean value, format-patch defaults to
5974         <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
5975         to false.
5976 </p>
5977 <div class="paragraph"><p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
5978 instead.</p></div>
5979 <div class="paragraph"><p>This configuration can be specified multiple times in order to allow
5980 multiple notes refs to be included. In that case, it will behave
5981 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
5982 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
5983 also show notes from that notes ref and a value of <code>false</code> will negate
5984 previous configurations and not show notes.</p></div>
5985 <div class="paragraph"><p>For example,</p></div>
5986 <div class="listingblock">
5987 <div class="content">
5988 <pre><code>[format]
5989         notes = true
5990         notes = foo
5991         notes = false
5992         notes = bar</code></pre>
5993 </div></div>
5994 <div class="paragraph"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
5995 </dd>
5996 <dt class="hdlist1">
5997 format.mboxrd
5998 </dt>
5999 <dd>
6000 <p>
6001         A boolean value which enables the robust "mboxrd" format when
6002         <code>--stdout</code> is in use to escape "^&gt;+From " lines.
6003 </p>
6004 </dd>
6005 <dt class="hdlist1">
6006 format.noprefix
6007 </dt>
6008 <dd>
6009 <p>
6010         If set, do not show any source or destination prefix in patches.
6011         This is equivalent to the <code>diff.noprefix</code> option used by <code>git
6012         diff</code> (but which is not respected by <code>format-patch</code>). Note that
6013         by setting this, the receiver of any patches you generate will
6014         have to apply them using the <code>-p0</code> option.
6015 </p>
6016 </dd>
6017 <dt class="hdlist1">
6018 filter.&lt;driver&gt;.clean
6019 </dt>
6020 <dd>
6021 <p>
6022         The command which is used to convert the content of a worktree
6023         file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
6024         details.
6025 </p>
6026 </dd>
6027 <dt class="hdlist1">
6028 filter.&lt;driver&gt;.smudge
6029 </dt>
6030 <dd>
6031 <p>
6032         The command which is used to convert the content of a blob
6033         object to a worktree file upon checkout.  See
6034         <a href="gitattributes.html">gitattributes(5)</a> for details.
6035 </p>
6036 </dd>
6037 <dt class="hdlist1">
6038 fsck.&lt;msg-id&gt;
6039 </dt>
6040 <dd>
6041 <p>
6042         During fsck git may find issues with legacy data which
6043         wouldn&#8217;t be generated by current versions of git, and which
6044         wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
6045         set. This feature is intended to support working with legacy
6046         repositories containing such data.
6047 </p>
6048 <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
6049 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
6050 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
6051 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
6052 same applies for the corresponding <code>receive.fsck.*</code> and
6053 <code>fetch.fsck.*</code>. variables.</p></div>
6054 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
6055 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
6056 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
6057 uniformly configure the same fsck settings in different circumstances,
6058 all three of them must be set to the same values.</p></div>
6059 <div class="paragraph"><p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
6060 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
6061 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
6062 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
6063 with the message ID, e.g. "missingEmail: invalid author/committer
6064 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
6065 will hide that issue.</p></div>
6066 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
6067 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6068 problematic objects share to be ignored, as doing the latter will
6069 allow new instances of the same breakages go unnoticed.</p></div>
6070 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
6071 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
6072 will only cause git to warn.</p></div>
6073 <div class="paragraph"><p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
6074 values of <code>&lt;msg-id&gt;</code>.</p></div>
6075 </dd>
6076 <dt class="hdlist1">
6077 fsck.skipList
6078 </dt>
6079 <dd>
6080 <p>
6081         The path to a list of object names (i.e. one unabbreviated SHA-1 per
6082         line) that are known to be broken in a non-fatal way and should
6083         be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
6084         lines, and any leading and trailing whitespace are ignored. Everything
6085         but a SHA-1 per line will error out on older versions.
6086 </p>
6087 <div class="paragraph"><p>This feature is useful when an established project should be accepted
6088 despite early commits containing errors that can be safely ignored,
6089 such as invalid committer email addresses.  Note: corrupt objects
6090 cannot be skipped with this setting.</p></div>
6091 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
6092 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6093 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6094 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6095 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
6096 uniformly configure the same fsck settings in different circumstances,
6097 all three of them must be set to the same values.</p></div>
6098 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
6099 list should be sorted. This was never a requirement; the object names
6100 could appear in any order, but when reading the list we tracked whether
6101 the list was sorted for the purposes of an internal binary search
6102 implementation, which could save itself some work with an already sorted
6103 list. Unless you had a humongous list there was no reason to go out of
6104 your way to pre-sort the list. After Git version 2.20 a hash implementation
6105 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
6106 </dd>
6107 <dt class="hdlist1">
6108 fsmonitor.allowRemote
6109 </dt>
6110 <dd>
6111 <p>
6112     By default, the fsmonitor daemon refuses to work with network-mounted
6113     repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6114     behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6115 </p>
6116 </dd>
6117 <dt class="hdlist1">
6118 fsmonitor.socketDir
6119 </dt>
6120 <dd>
6121 <p>
6122     This Mac OS-specific option, if set, specifies the directory in
6123     which to create the Unix domain socket used for communication
6124     between the fsmonitor daemon and various Git commands. The directory must
6125     reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
6126     is set to <code>true</code>.
6127 </p>
6128 </dd>
6129 <dt class="hdlist1">
6130 gc.aggressiveDepth
6131 </dt>
6132 <dd>
6133 <p>
6134         The depth parameter used in the delta compression
6135         algorithm used by <em>git gc --aggressive</em>.  This defaults
6136         to 50, which is the default for the <code>--depth</code> option when
6137         <code>--aggressive</code> isn&#8217;t in use.
6138 </p>
6139 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
6140 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6141 </dd>
6142 <dt class="hdlist1">
6143 gc.aggressiveWindow
6144 </dt>
6145 <dd>
6146 <p>
6147         The window size parameter used in the delta compression
6148         algorithm used by <em>git gc --aggressive</em>.  This defaults
6149         to 250, which is a much more aggressive window size than
6150         the default <code>--window</code> of 10.
6151 </p>
6152 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
6153 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
6154 </dd>
6155 <dt class="hdlist1">
6156 gc.auto
6157 </dt>
6158 <dd>
6159 <p>
6160         When there are approximately more than this many loose
6161         objects in the repository, <code>git gc --auto</code> will pack them.
6162         Some Porcelain commands use this command to perform a
6163         light-weight garbage collection from time to time.  The
6164         default value is 6700.
6165 </p>
6166 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
6167 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
6168 otherwise use to determine if there&#8217;s work to do, such as
6169 <code>gc.autoPackLimit</code>.</p></div>
6170 </dd>
6171 <dt class="hdlist1">
6172 gc.autoPackLimit
6173 </dt>
6174 <dd>
6175 <p>
6176         When there are more than this many packs that are not
6177         marked with <code>*.keep</code> file in the repository, <code>git gc
6178         --auto</code> consolidates them into one larger pack.  The
6179         default value is 50.  Setting this to 0 disables it.
6180         Setting <code>gc.auto</code> to 0 will also disable this.
6181 </p>
6182 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6183 use, it&#8217;ll affect how the auto pack limit works.</p></div>
6184 </dd>
6185 <dt class="hdlist1">
6186 gc.autoDetach
6187 </dt>
6188 <dd>
6189 <p>
6190         Make <code>git gc --auto</code> return immediately and run in the background
6191         if the system supports it. Default is true.
6192 </p>
6193 </dd>
6194 <dt class="hdlist1">
6195 gc.bigPackThreshold
6196 </dt>
6197 <dd>
6198 <p>
6199         If non-zero, all non-cruft packs larger than this limit are kept
6200         when <code>git gc</code> is run. This is very similar to
6201         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6202         the threshold are kept, not just the largest pack. Defaults to
6203         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6204 </p>
6205 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6206 this configuration variable is ignored, all packs except the base pack
6207 will be repacked. After this the number of packs should go below
6208 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6209 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6210 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6211 will also be excluded (this is the equivalent of running <code>git gc</code> with
6212 <code>--keep-largest-pack</code>).</p></div>
6213 </dd>
6214 <dt class="hdlist1">
6215 gc.writeCommitGraph
6216 </dt>
6217 <dd>
6218 <p>
6219         If true, then gc will rewrite the commit-graph file when
6220         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6221         the commit-graph will be updated if housekeeping is
6222         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
6223         for details.
6224 </p>
6225 </dd>
6226 <dt class="hdlist1">
6227 gc.logExpiry
6228 </dt>
6229 <dd>
6230 <p>
6231         If the file gc.log exists, then <code>git gc --auto</code> will print
6232         its content and exit with status zero instead of running
6233         unless that file is more than <em>gc.logExpiry</em> old.  Default is
6234         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
6235         value.
6236 </p>
6237 </dd>
6238 <dt class="hdlist1">
6239 gc.packRefs
6240 </dt>
6241 <dd>
6242 <p>
6243         Running <code>git pack-refs</code> in a repository renders it
6244         unclonable by Git versions prior to 1.5.1.2 over dumb
6245         transports such as HTTP.  This variable determines whether
6246         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6247         to enable it within all non-bare repos or it can be set to a
6248         boolean value.  The default is <code>true</code>.
6249 </p>
6250 </dd>
6251 <dt class="hdlist1">
6252 gc.cruftPacks
6253 </dt>
6254 <dd>
6255 <p>
6256         Store unreachable objects in a cruft pack (see
6257         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
6258         is <code>true</code>.
6259 </p>
6260 </dd>
6261 <dt class="hdlist1">
6262 gc.maxCruftSize
6263 </dt>
6264 <dd>
6265 <p>
6266         Limit the size of new cruft packs when repacking. When
6267         specified in addition to <code>--max-cruft-size</code>, the command line
6268         option takes priority. See the <code>--max-cruft-size</code> option of
6269         <a href="git-repack.html">git-repack(1)</a>.
6270 </p>
6271 </dd>
6272 <dt class="hdlist1">
6273 gc.pruneExpire
6274 </dt>
6275 <dd>
6276 <p>
6277         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6278         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6279         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
6280         grace period with this config variable.  The value "now" may be
6281         used to disable this grace period and always prune unreachable
6282         objects immediately, or "never" may be used to suppress pruning.
6283         This feature helps prevent corruption when <em>git gc</em> runs
6284         concurrently with another process writing to the repository; see
6285         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
6286 </p>
6287 </dd>
6288 <dt class="hdlist1">
6289 gc.worktreePruneExpire
6290 </dt>
6291 <dd>
6292 <p>
6293         When <em>git gc</em> is run, it calls
6294         <em>git worktree prune --expire 3.months.ago</em>.
6295         This config variable can be used to set a different grace
6296         period. The value "now" may be used to disable the grace
6297         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
6298         may be used to suppress pruning.
6299 </p>
6300 </dd>
6301 <dt class="hdlist1">
6302 gc.reflogExpire
6303 </dt>
6304 <dt class="hdlist1">
6305 gc.&lt;pattern&gt;.reflogExpire
6306 </dt>
6307 <dd>
6308 <p>
6309         <em>git reflog expire</em> removes reflog entries older than
6310         this time; defaults to 90 days. The value "now" expires all
6311         entries immediately, and "never" suppresses expiration
6312         altogether. With "&lt;pattern&gt;" (e.g.
6313         "refs/stash") in the middle the setting applies only to
6314         the refs that match the &lt;pattern&gt;.
6315 </p>
6316 </dd>
6317 <dt class="hdlist1">
6318 gc.reflogExpireUnreachable
6319 </dt>
6320 <dt class="hdlist1">
6321 gc.&lt;pattern&gt;.reflogExpireUnreachable
6322 </dt>
6323 <dd>
6324 <p>
6325         <em>git reflog expire</em> removes reflog entries older than
6326         this time and are not reachable from the current tip;
6327         defaults to 30 days. The value "now" expires all entries
6328         immediately, and "never" suppresses expiration altogether.
6329         With "&lt;pattern&gt;" (e.g. "refs/stash")
6330         in the middle, the setting applies only to the refs that
6331         match the &lt;pattern&gt;.
6332 </p>
6333 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
6334 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6335 or rebase occurring.  Since these changes are not part of the current
6336 project most users will want to expire them sooner, which is why the
6337 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6338 </dd>
6339 <dt class="hdlist1">
6340 gc.recentObjectsHook
6341 </dt>
6342 <dd>
6343 <p>
6344         When considering whether or not to remove an object (either when
6345         generating a cruft pack or storing unreachable objects as
6346         loose), use the shell to execute the specified command(s).
6347         Interpret their output as object IDs which Git will consider as
6348         "recent", regardless of their age. By treating their mtimes as
6349         "now", any objects (and their descendants) mentioned in the
6350         output will be kept regardless of their true age.
6351 </p>
6352 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
6353 else. Objects which cannot be found in the repository are ignored.
6354 Multiple hooks are supported, but all must exit successfully, else the
6355 operation (either generating a cruft pack or unpacking unreachable
6356 objects) will be halted.</p></div>
6357 </dd>
6358 <dt class="hdlist1">
6359 gc.repackFilter
6360 </dt>
6361 <dd>
6362 <p>
6363         When repacking, use the specified filter to move certain
6364         objects into a separate packfile.  See the
6365         <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.
6366 </p>
6367 </dd>
6368 <dt class="hdlist1">
6369 gc.repackFilterTo
6370 </dt>
6371 <dd>
6372 <p>
6373         When repacking and using a filter, see <code>gc.repackFilter</code>, the
6374         specified location will be used to create the packfile
6375         containing the filtered out objects. <strong>WARNING:</strong> The
6376         specified location should be accessible, using for example the
6377         Git alternates mechanism, otherwise the repo could be
6378         considered corrupt by Git as it migh not be able to access the
6379         objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
6380         of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
6381         section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.
6382 </p>
6383 </dd>
6384 <dt class="hdlist1">
6385 gc.rerereResolved
6386 </dt>
6387 <dd>
6388 <p>
6389         Records of conflicted merge you resolved earlier are
6390         kept for this many days when <em>git rerere gc</em> is run.
6391         You can also use more human-readable "1.month.ago", etc.
6392         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6393 </p>
6394 </dd>
6395 <dt class="hdlist1">
6396 gc.rerereUnresolved
6397 </dt>
6398 <dd>
6399 <p>
6400         Records of conflicted merge you have not resolved are
6401         kept for this many days when <em>git rerere gc</em> is run.
6402         You can also use more human-readable "1.month.ago", etc.
6403         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
6404 </p>
6405 </dd>
6406 <dt class="hdlist1">
6407 gitcvs.commitMsgAnnotation
6408 </dt>
6409 <dd>
6410 <p>
6411         Append this string to each commit message. Set to empty string
6412         to disable this feature. Defaults to "via git-CVS emulator".
6413 </p>
6414 </dd>
6415 <dt class="hdlist1">
6416 gitcvs.enabled
6417 </dt>
6418 <dd>
6419 <p>
6420         Whether the CVS server interface is enabled for this repository.
6421         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6422 </p>
6423 </dd>
6424 <dt class="hdlist1">
6425 gitcvs.logFile
6426 </dt>
6427 <dd>
6428 <p>
6429         Path to a log file where the CVS server interface well&#8230; logs
6430         various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6431 </p>
6432 </dd>
6433 <dt class="hdlist1">
6434 gitcvs.usecrlfattr
6435 </dt>
6436 <dd>
6437 <p>
6438         If true, the server will look up the end-of-line conversion
6439         attributes for files to determine the <code>-k</code> modes to use. If
6440         the attributes force Git to treat a file as text,
6441         the <code>-k</code> mode will be left blank so CVS clients will
6442         treat it as text. If they suppress text conversion, the file
6443         will be set with <em>-kb</em> mode, which suppresses any newline munging
6444         the client might otherwise do. If the attributes do not allow
6445         the file type to be determined, then <code>gitcvs.allBinary</code> is
6446         used. See <a href="gitattributes.html">gitattributes(5)</a>.
6447 </p>
6448 </dd>
6449 <dt class="hdlist1">
6450 gitcvs.allBinary
6451 </dt>
6452 <dd>
6453 <p>
6454         This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6455         the correct <em>-kb</em> mode to use. If true, all
6456         unresolved files are sent to the client in
6457         mode <em>-kb</em>. This causes the client to treat them
6458         as binary files, which suppresses any newline munging it
6459         otherwise might do. Alternatively, if it is set to "guess",
6460         then the contents of the file are examined to decide if
6461         it is binary, similar to <code>core.autocrlf</code>.
6462 </p>
6463 </dd>
6464 <dt class="hdlist1">
6465 gitcvs.dbName
6466 </dt>
6467 <dd>
6468 <p>
6469         Database used by git-cvsserver to cache revision information
6470         derived from the Git repository. The exact meaning depends on the
6471         used database driver, for SQLite (which is the default driver) this
6472         is a filename. Supports variable substitution (see
6473         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6474         Default: <em>%Ggitcvs.%m.sqlite</em>
6475 </p>
6476 </dd>
6477 <dt class="hdlist1">
6478 gitcvs.dbDriver
6479 </dt>
6480 <dd>
6481 <p>
6482         Used Perl DBI driver. You can specify any available driver
6483         for this here, but it might not work. git-cvsserver is tested
6484         with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6485         reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6486         May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6487         See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
6488 </p>
6489 </dd>
6490 <dt class="hdlist1">
6491 gitcvs.dbUser, gitcvs.dbPass
6492 </dt>
6493 <dd>
6494 <p>
6495         Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6496         since SQLite has no concept of database users and/or passwords.
6497         <em>gitcvs.dbUser</em> supports variable substitution (see
6498         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
6499 </p>
6500 </dd>
6501 <dt class="hdlist1">
6502 gitcvs.dbTableNamePrefix
6503 </dt>
6504 <dd>
6505 <p>
6506         Database table name prefix.  Prepended to the names of any
6507         database tables used, allowing a single database to be used
6508         for several repositories.  Supports variable substitution (see
6509         <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
6510         characters will be replaced with underscores.
6511 </p>
6512 </dd>
6513 </dl></div>
6514 <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6515 <code>gitcvs.allBinary</code> can also be specified as
6516 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
6517 is one of "ext" and "pserver") to make them apply only for the given
6518 access method.</p></div>
6519 <div class="dlist"><dl>
6520 <dt class="hdlist1">
6521 gitweb.category
6522 </dt>
6523 <dt class="hdlist1">
6524 gitweb.description
6525 </dt>
6526 <dt class="hdlist1">
6527 gitweb.owner
6528 </dt>
6529 <dt class="hdlist1">
6530 gitweb.url
6531 </dt>
6532 <dd>
6533 <p>
6534         See <a href="gitweb.html">gitweb(1)</a> for description.
6535 </p>
6536 </dd>
6537 <dt class="hdlist1">
6538 gitweb.avatar
6539 </dt>
6540 <dt class="hdlist1">
6541 gitweb.blame
6542 </dt>
6543 <dt class="hdlist1">
6544 gitweb.grep
6545 </dt>
6546 <dt class="hdlist1">
6547 gitweb.highlight
6548 </dt>
6549 <dt class="hdlist1">
6550 gitweb.patches
6551 </dt>
6552 <dt class="hdlist1">
6553 gitweb.pickaxe
6554 </dt>
6555 <dt class="hdlist1">
6556 gitweb.remote_heads
6557 </dt>
6558 <dt class="hdlist1">
6559 gitweb.showSizes
6560 </dt>
6561 <dt class="hdlist1">
6562 gitweb.snapshot
6563 </dt>
6564 <dd>
6565 <p>
6566         See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
6567 </p>
6568 </dd>
6569 <dt class="hdlist1">
6570 grep.lineNumber
6571 </dt>
6572 <dd>
6573 <p>
6574         If set to true, enable <code>-n</code> option by default.
6575 </p>
6576 </dd>
6577 <dt class="hdlist1">
6578 grep.column
6579 </dt>
6580 <dd>
6581 <p>
6582         If set to true, enable the <code>--column</code> option by default.
6583 </p>
6584 </dd>
6585 <dt class="hdlist1">
6586 grep.patternType
6587 </dt>
6588 <dd>
6589 <p>
6590         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
6591         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
6592         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
6593         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
6594         between <em>basic</em> and <em>extended</em>.
6595 </p>
6596 </dd>
6597 <dt class="hdlist1">
6598 grep.extendedRegexp
6599 </dt>
6600 <dd>
6601 <p>
6602         If set to true, enable <code>--extended-regexp</code> option by default. This
6603         option is ignored when the <code>grep.patternType</code> option is set to a value
6604         other than <em>default</em>.
6605 </p>
6606 </dd>
6607 <dt class="hdlist1">
6608 grep.threads
6609 </dt>
6610 <dd>
6611 <p>
6612         Number of grep worker threads to use. If unset (or set to 0), Git will
6613         use as many threads as the number of logical cores available.
6614 </p>
6615 </dd>
6616 <dt class="hdlist1">
6617 grep.fullName
6618 </dt>
6619 <dd>
6620 <p>
6621         If set to true, enable <code>--full-name</code> option by default.
6622 </p>
6623 </dd>
6624 <dt class="hdlist1">
6625 grep.fallbackToNoIndex
6626 </dt>
6627 <dd>
6628 <p>
6629         If set to true, fall back to git grep --no-index if git grep
6630         is executed outside of a git repository.  Defaults to false.
6631 </p>
6632 </dd>
6633 <dt class="hdlist1">
6634 gpg.program
6635 </dt>
6636 <dd>
6637 <p>
6638         Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
6639         making or verifying a PGP signature. The program must support the
6640         same command-line interface as GPG, namely, to verify a detached
6641         signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
6642         program is expected to signal a good signature by exiting with
6643         code 0.  To generate an ASCII-armored detached signature, the
6644         standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
6645         signed, and the program is expected to send the result to its
6646         standard output.
6647 </p>
6648 </dd>
6649 <dt class="hdlist1">
6650 gpg.format
6651 </dt>
6652 <dd>
6653 <p>
6654         Specifies which key format to use when signing with <code>--gpg-sign</code>.
6655         Default is "openpgp". Other possible values are "x509", "ssh".
6656 </p>
6657 <div class="paragraph"><p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
6658 based on the selected <code>gpg.format</code>.</p></div>
6659 </dd>
6660 <dt class="hdlist1">
6661 gpg.&lt;format&gt;.program
6662 </dt>
6663 <dd>
6664 <p>
6665         Use this to customize the program used for the signing format you
6666         chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
6667         be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
6668         value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".
6669 </p>
6670 </dd>
6671 <dt class="hdlist1">
6672 gpg.minTrustLevel
6673 </dt>
6674 <dd>
6675 <p>
6676         Specifies a minimum trust level for signature verification.  If
6677         this option is unset, then signature verification for merge
6678         operations requires a key with at least <code>marginal</code> trust.  Other
6679         operations that perform signature verification require a key
6680         with at least <code>undefined</code> trust.  Setting this option overrides
6681         the required trust-level for all operations.  Supported values,
6682         in increasing order of significance:
6683 </p>
6684 <div class="ulist"><ul>
6685 <li>
6686 <p>
6687 <code>undefined</code>
6688 </p>
6689 </li>
6690 <li>
6691 <p>
6692 <code>never</code>
6693 </p>
6694 </li>
6695 <li>
6696 <p>
6697 <code>marginal</code>
6698 </p>
6699 </li>
6700 <li>
6701 <p>
6702 <code>fully</code>
6703 </p>
6704 </li>
6705 <li>
6706 <p>
6707 <code>ultimate</code>
6708 </p>
6709 </li>
6710 </ul></div>
6711 </dd>
6712 <dt class="hdlist1">
6713 gpg.ssh.defaultKeyCommand
6714 </dt>
6715 <dd>
6716 <p>
6717         This command will be run when user.signingkey is not set and a ssh
6718         signature is requested. On successful exit a valid ssh public key
6719         prefixed with <code>key::</code> is expected in the first line of its output.
6720         This allows for a script doing a dynamic lookup of the correct public
6721         key when it is impractical to statically configure <code>user.signingKey</code>.
6722         For example when keys or SSH Certificates are rotated frequently or
6723         selection of the right key depends on external factors unknown to git.
6724 </p>
6725 </dd>
6726 <dt class="hdlist1">
6727 gpg.ssh.allowedSignersFile
6728 </dt>
6729 <dd>
6730 <p>
6731         A file containing ssh public keys which you are willing to trust.
6732         The file consists of one or more lines of principals followed by an ssh
6733         public key.
6734         e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
6735         See ssh-keygen(1) "ALLOWED SIGNERS" for details.
6736         The principal is only used to identify the key and is available when
6737         verifying a signature.
6738 </p>
6739 <div class="paragraph"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
6740 between valid signatures and trusted signatures the trust level of a signature
6741 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
6742 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
6743 <div class="paragraph"><p>This file can be set to a location outside of the repository and every developer
6744 maintains their own trust store. A central repository server could generate this
6745 file automatically from ssh keys with push access to verify the code against.
6746 In a corporate setting this file is probably generated at a global location
6747 from automation that already handles developer ssh keys.</p></div>
6748 <div class="paragraph"><p>A repository that only allows signed commits can store the file
6749 in the repository itself using a path relative to the top-level of the working tree.
6750 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
6751 <div class="paragraph"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
6752 valid-before options. Git will mark signatures as valid if the signing key was
6753 valid at the time of the signature&#8217;s creation. This allows users to change a
6754 signing key without invalidating all previously made signatures.</p></div>
6755 <div class="paragraph"><p>Using a SSH CA key with the cert-authority option
6756 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p></div>
6757 </dd>
6758 <dt class="hdlist1">
6759 gpg.ssh.revocationFile
6760 </dt>
6761 <dd>
6762 <p>
6763         Either a SSH KRL or a list of revoked public keys (without the principal prefix).
6764         See ssh-keygen(1) for details.
6765         If a public key is found in this file then it will always be treated
6766         as having trust level "never" and signatures will show as invalid.
6767 </p>
6768 </dd>
6769 <dt class="hdlist1">
6770 gui.commitMsgWidth
6771 </dt>
6772 <dd>
6773 <p>
6774         Defines how wide the commit message window is in the
6775         <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
6776 </p>
6777 </dd>
6778 <dt class="hdlist1">
6779 gui.diffContext
6780 </dt>
6781 <dd>
6782 <p>
6783         Specifies how many context lines should be used in calls to diff
6784         made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
6785 </p>
6786 </dd>
6787 <dt class="hdlist1">
6788 gui.displayUntracked
6789 </dt>
6790 <dd>
6791 <p>
6792         Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
6793         in the file list. The default is "true".
6794 </p>
6795 </dd>
6796 <dt class="hdlist1">
6797 gui.encoding
6798 </dt>
6799 <dd>
6800 <p>
6801         Specifies the default character encoding to use for displaying of
6802         file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
6803         It can be overridden by setting the <em>encoding</em> attribute
6804         for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
6805         If this option is not set, the tools default to the
6806         locale encoding.
6807 </p>
6808 </dd>
6809 <dt class="hdlist1">
6810 gui.matchTrackingBranch
6811 </dt>
6812 <dd>
6813 <p>
6814         Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
6815         default to tracking remote branches with matching names or
6816         not. Default: "false".
6817 </p>
6818 </dd>
6819 <dt class="hdlist1">
6820 gui.newBranchTemplate
6821 </dt>
6822 <dd>
6823 <p>
6824         Is used as a suggested name when creating new branches using the
6825         <a href="git-gui.html">git-gui(1)</a>.
6826 </p>
6827 </dd>
6828 <dt class="hdlist1">
6829 gui.pruneDuringFetch
6830 </dt>
6831 <dd>
6832 <p>
6833         "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
6834         performing a fetch. The default value is "false".
6835 </p>
6836 </dd>
6837 <dt class="hdlist1">
6838 gui.trustmtime
6839 </dt>
6840 <dd>
6841 <p>
6842         Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
6843         timestamp or not. By default the timestamps are not trusted.
6844 </p>
6845 </dd>
6846 <dt class="hdlist1">
6847 gui.spellingDictionary
6848 </dt>
6849 <dd>
6850 <p>
6851         Specifies the dictionary used for spell checking commit messages in
6852         the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
6853         off.
6854 </p>
6855 </dd>
6856 <dt class="hdlist1">
6857 gui.fastCopyBlame
6858 </dt>
6859 <dd>
6860 <p>
6861         If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
6862         location detection. It makes blame significantly faster on huge
6863         repositories at the expense of less thorough copy detection.
6864 </p>
6865 </dd>
6866 <dt class="hdlist1">
6867 gui.copyBlameThreshold
6868 </dt>
6869 <dd>
6870 <p>
6871         Specifies the threshold to use in <em>git gui blame</em> original location
6872         detection, measured in alphanumeric characters. See the
6873         <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
6874 </p>
6875 </dd>
6876 <dt class="hdlist1">
6877 gui.blamehistoryctx
6878 </dt>
6879 <dd>
6880 <p>
6881         Specifies the radius of history context in days to show in
6882         <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
6883         Context</code> menu item is invoked from <em>git gui blame</em>. If this
6884         variable is set to zero, the whole history is shown.
6885 </p>
6886 </dd>
6887 <dt class="hdlist1">
6888 guitool.&lt;name&gt;.cmd
6889 </dt>
6890 <dd>
6891 <p>
6892         Specifies the shell command line to execute when the corresponding item
6893         of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
6894         mandatory for every tool. The command is executed from the root of
6895         the working directory, and in the environment it receives the name of
6896         the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
6897         <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
6898         the head is detached, <em>CUR_BRANCH</em> is empty).
6899 </p>
6900 </dd>
6901 <dt class="hdlist1">
6902 guitool.&lt;name&gt;.needsFile
6903 </dt>
6904 <dd>
6905 <p>
6906         Run the tool only if a diff is selected in the GUI. It guarantees
6907         that <em>FILENAME</em> is not empty.
6908 </p>
6909 </dd>
6910 <dt class="hdlist1">
6911 guitool.&lt;name&gt;.noConsole
6912 </dt>
6913 <dd>
6914 <p>
6915         Run the command silently, without creating a window to display its
6916         output.
6917 </p>
6918 </dd>
6919 <dt class="hdlist1">
6920 guitool.&lt;name&gt;.noRescan
6921 </dt>
6922 <dd>
6923 <p>
6924         Don&#8217;t rescan the working directory for changes after the tool
6925         finishes execution.
6926 </p>
6927 </dd>
6928 <dt class="hdlist1">
6929 guitool.&lt;name&gt;.confirm
6930 </dt>
6931 <dd>
6932 <p>
6933         Show a confirmation dialog before actually running the tool.
6934 </p>
6935 </dd>
6936 <dt class="hdlist1">
6937 guitool.&lt;name&gt;.argPrompt
6938 </dt>
6939 <dd>
6940 <p>
6941         Request a string argument from the user, and pass it to the tool
6942         through the <code>ARGS</code> environment variable. Since requesting an
6943         argument implies confirmation, the <em>confirm</em> option has no effect
6944         if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
6945         the dialog uses a built-in generic prompt; otherwise the exact
6946         value of the variable is used.
6947 </p>
6948 </dd>
6949 <dt class="hdlist1">
6950 guitool.&lt;name&gt;.revPrompt
6951 </dt>
6952 <dd>
6953 <p>
6954         Request a single valid revision from the user, and set the
6955         <code>REVISION</code> environment variable. In other aspects this option
6956         is similar to <em>argPrompt</em>, and can be used together with it.
6957 </p>
6958 </dd>
6959 <dt class="hdlist1">
6960 guitool.&lt;name&gt;.revUnmerged
6961 </dt>
6962 <dd>
6963 <p>
6964         Show only unmerged branches in the <em>revPrompt</em> subdialog.
6965         This is useful for tools similar to merge or rebase, but not
6966         for things like checkout or reset.
6967 </p>
6968 </dd>
6969 <dt class="hdlist1">
6970 guitool.&lt;name&gt;.title
6971 </dt>
6972 <dd>
6973 <p>
6974         Specifies the title to use for the prompt dialog. The default
6975         is the tool name.
6976 </p>
6977 </dd>
6978 <dt class="hdlist1">
6979 guitool.&lt;name&gt;.prompt
6980 </dt>
6981 <dd>
6982 <p>
6983         Specifies the general prompt string to display at the top of
6984         the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
6985         The default value includes the actual command.
6986 </p>
6987 </dd>
6988 <dt class="hdlist1">
6989 help.browser
6990 </dt>
6991 <dd>
6992 <p>
6993         Specify the browser that will be used to display help in the
6994         <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
6995 </p>
6996 </dd>
6997 <dt class="hdlist1">
6998 help.format
6999 </dt>
7000 <dd>
7001 <p>
7002         Override the default help format used by <a href="git-help.html">git-help(1)</a>.
7003         Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
7004         the default. <em>web</em> and <em>html</em> are the same.
7005 </p>
7006 </dd>
7007 <dt class="hdlist1">
7008 help.autoCorrect
7009 </dt>
7010 <dd>
7011 <p>
7012         If git detects typos and can identify exactly one valid command similar
7013         to the error, git will try to suggest the correct command or even
7014         run the suggestion automatically. Possible config values are:
7015 </p>
7016 <div class="ulist"><ul>
7017 <li>
7018 <p>
7019 0 (default): show the suggested command.
7020 </p>
7021 </li>
7022 <li>
7023 <p>
7024 positive number: run the suggested command after specified
7025 deciseconds (0.1 sec).
7026 </p>
7027 </li>
7028 <li>
7029 <p>
7030 "immediate": run the suggested command immediately.
7031 </p>
7032 </li>
7033 <li>
7034 <p>
7035 "prompt": show the suggestion and prompt for confirmation to run
7036 the command.
7037 </p>
7038 </li>
7039 <li>
7040 <p>
7041 "never": don&#8217;t run or show any suggested command.
7042 </p>
7043 </li>
7044 </ul></div>
7045 </dd>
7046 <dt class="hdlist1">
7047 help.htmlPath
7048 </dt>
7049 <dd>
7050 <p>
7051         Specify the path where the HTML documentation resides. File system paths
7052         and URLs are supported. HTML pages will be prefixed with this path when
7053         help is displayed in the <em>web</em> format. This defaults to the documentation
7054         path of your Git installation.
7055 </p>
7056 </dd>
7057 <dt class="hdlist1">
7058 http.proxy
7059 </dt>
7060 <dd>
7061 <p>
7062         Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
7063         <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
7064         addition to the syntax understood by curl, it is possible to specify a
7065         proxy string with a user name but no password, in which case git will
7066         attempt to acquire one in the same way it does for other credentials. See
7067         <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
7068         <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
7069         on a per-remote basis; see remote.&lt;name&gt;.proxy
7070 </p>
7071 </dd>
7072 <dt class="hdlist1">
7073 http.proxyAuthMethod
7074 </dt>
7075 <dd>
7076 <p>
7077         Set the method with which to authenticate against the HTTP proxy. This
7078         only takes effect if the configured proxy string contains a user name part
7079         (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
7080         overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
7081         Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
7082         variable.  Possible values are:
7083 </p>
7084 <div class="openblock">
7085 <div class="content">
7086 <div class="ulist"><ul>
7087 <li>
7088 <p>
7089 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
7090   assumed that the proxy answers an unauthenticated request with a 407
7091   status code and one or more Proxy-authenticate headers with supported
7092   authentication methods. This is the default.
7093 </p>
7094 </li>
7095 <li>
7096 <p>
7097 <code>basic</code> - HTTP Basic authentication
7098 </p>
7099 </li>
7100 <li>
7101 <p>
7102 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
7103   transmitted to the proxy in clear text
7104 </p>
7105 </li>
7106 <li>
7107 <p>
7108 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7109   of <code>curl(1)</code>)
7110 </p>
7111 </li>
7112 <li>
7113 <p>
7114 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7115 </p>
7116 </li>
7117 </ul></div>
7118 </div></div>
7119 </dd>
7120 <dt class="hdlist1">
7121 http.proxySSLCert
7122 </dt>
7123 <dd>
7124 <p>
7125         The pathname of a file that stores a client certificate to use to authenticate
7126         with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7127         variable.
7128 </p>
7129 </dd>
7130 <dt class="hdlist1">
7131 http.proxySSLKey
7132 </dt>
7133 <dd>
7134 <p>
7135         The pathname of a file that stores a private key to use to authenticate with
7136         an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7137         variable.
7138 </p>
7139 </dd>
7140 <dt class="hdlist1">
7141 http.proxySSLCertPasswordProtected
7142 </dt>
7143 <dd>
7144 <p>
7145         Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
7146         will prompt the user, possibly many times, if the certificate or private key
7147         is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7148         environment variable.
7149 </p>
7150 </dd>
7151 <dt class="hdlist1">
7152 http.proxySSLCAInfo
7153 </dt>
7154 <dd>
7155 <p>
7156         Pathname to the file containing the certificate bundle that should be used to
7157         verify the proxy with when using an HTTPS proxy. Can be overridden by the
7158         <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7159 </p>
7160 </dd>
7161 <dt class="hdlist1">
7162 http.emptyAuth
7163 </dt>
7164 <dd>
7165 <p>
7166         Attempt authentication without seeking a username or password.  This
7167         can be used to attempt GSS-Negotiate authentication without specifying
7168         a username in the URL, as libcurl normally requires a username for
7169         authentication.
7170 </p>
7171 </dd>
7172 <dt class="hdlist1">
7173 http.delegation
7174 </dt>
7175 <dd>
7176 <p>
7177         Control GSSAPI credential delegation. The delegation is disabled
7178         by default in libcurl since version 7.21.7. Set parameter to tell
7179         the server what it is allowed to delegate when it comes to user
7180         credentials. Used with GSS/kerberos. Possible values are:
7181 </p>
7182 <div class="openblock">
7183 <div class="content">
7184 <div class="ulist"><ul>
7185 <li>
7186 <p>
7187 <code>none</code> - Don&#8217;t allow any delegation.
7188 </p>
7189 </li>
7190 <li>
7191 <p>
7192 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7193   Kerberos service ticket, which is a matter of realm policy.
7194 </p>
7195 </li>
7196 <li>
7197 <p>
7198 <code>always</code> - Unconditionally allow the server to delegate.
7199 </p>
7200 </li>
7201 </ul></div>
7202 </div></div>
7203 </dd>
7204 <dt class="hdlist1">
7205 http.extraHeader
7206 </dt>
7207 <dd>
7208 <p>
7209         Pass an additional HTTP header when communicating with a server.  If
7210         more than one such entry exists, all of them are added as extra
7211         headers.  To allow overriding the settings inherited from the system
7212         config, an empty value will reset the extra headers to the empty list.
7213 </p>
7214 </dd>
7215 <dt class="hdlist1">
7216 http.cookieFile
7217 </dt>
7218 <dd>
7219 <p>
7220         The pathname of a file containing previously stored cookie lines,
7221         which should be used
7222         in the Git http session, if they match the server. The file format
7223         of the file to read cookies from should be plain HTTP headers or
7224         the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7225         NOTE that the file specified with http.cookieFile is used only as
7226         input unless http.saveCookies is set.
7227 </p>
7228 </dd>
7229 <dt class="hdlist1">
7230 http.saveCookies
7231 </dt>
7232 <dd>
7233 <p>
7234         If set, store cookies received during requests to the file specified by
7235         http.cookieFile. Has no effect if http.cookieFile is unset.
7236 </p>
7237 </dd>
7238 <dt class="hdlist1">
7239 http.version
7240 </dt>
7241 <dd>
7242 <p>
7243         Use the specified HTTP protocol version when communicating with a server.
7244         If you want to force the default. The available and default version depend
7245         on libcurl. Currently the possible values of
7246         this option are:
7247 </p>
7248 <div class="ulist"><ul>
7249 <li>
7250 <p>
7251 HTTP/2
7252 </p>
7253 </li>
7254 <li>
7255 <p>
7256 HTTP/1.1
7257 </p>
7258 </li>
7259 </ul></div>
7260 </dd>
7261 <dt class="hdlist1">
7262 http.curloptResolve
7263 </dt>
7264 <dd>
7265 <p>
7266         Hostname resolution information that will be used first by
7267         libcurl when sending HTTP requests.  This information should
7268         be in one of the following formats:
7269 </p>
7270 <div class="ulist"><ul>
7271 <li>
7272 <p>
7273 [+]HOST:PORT:ADDRESS[,ADDRESS]
7274 </p>
7275 </li>
7276 <li>
7277 <p>
7278 -HOST:PORT
7279 </p>
7280 </li>
7281 </ul></div>
7282 <div class="paragraph"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7283 to the provided <code>ADDRESS</code>(s). The second format clears all
7284 previous config values for that <code>HOST:PORT</code> combination.  To
7285 allow easy overriding of all the settings inherited from the
7286 system config, an empty value will reset all resolution
7287 information to the empty list.</p></div>
7288 </dd>
7289 <dt class="hdlist1">
7290 http.sslVersion
7291 </dt>
7292 <dd>
7293 <p>
7294         The SSL version to use when negotiating an SSL connection, if you
7295         want to force the default.  The available and default version
7296         depend on whether libcurl was built against NSS or OpenSSL and the
7297         particular configuration of the crypto library in use. Internally
7298         this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7299         documentation for more details on the format of this option and
7300         for the ssl version supported. Currently the possible values of
7301         this option are:
7302 </p>
7303 <div class="ulist"><ul>
7304 <li>
7305 <p>
7306 sslv2
7307 </p>
7308 </li>
7309 <li>
7310 <p>
7311 sslv3
7312 </p>
7313 </li>
7314 <li>
7315 <p>
7316 tlsv1
7317 </p>
7318 </li>
7319 <li>
7320 <p>
7321 tlsv1.0
7322 </p>
7323 </li>
7324 <li>
7325 <p>
7326 tlsv1.1
7327 </p>
7328 </li>
7329 <li>
7330 <p>
7331 tlsv1.2
7332 </p>
7333 </li>
7334 <li>
7335 <p>
7336 tlsv1.3
7337 </p>
7338 </li>
7339 </ul></div>
7340 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7341 To force git to use libcurl&#8217;s default ssl version and ignore any
7342 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7343 empty string.</p></div>
7344 </dd>
7345 <dt class="hdlist1">
7346 http.sslCipherList
7347 </dt>
7348 <dd>
7349 <p>
7350   A list of SSL ciphers to use when negotiating an SSL connection.
7351   The available ciphers depend on whether libcurl was built against
7352   NSS or OpenSSL and the particular configuration of the crypto
7353   library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7354   option; see the libcurl documentation for more details on the format
7355   of this list.
7356 </p>
7357 <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7358 To force git to use libcurl&#8217;s default cipher list and ignore any
7359 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7360 empty string.</p></div>
7361 </dd>
7362 <dt class="hdlist1">
7363 http.sslVerify
7364 </dt>
7365 <dd>
7366 <p>
7367         Whether to verify the SSL certificate when fetching or pushing
7368         over HTTPS. Defaults to true. Can be overridden by the
7369         <code>GIT_SSL_NO_VERIFY</code> environment variable.
7370 </p>
7371 </dd>
7372 <dt class="hdlist1">
7373 http.sslCert
7374 </dt>
7375 <dd>
7376 <p>
7377         File containing the SSL certificate when fetching or pushing
7378         over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7379         variable.
7380 </p>
7381 </dd>
7382 <dt class="hdlist1">
7383 http.sslKey
7384 </dt>
7385 <dd>
7386 <p>
7387         File containing the SSL private key when fetching or pushing
7388         over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7389         variable.
7390 </p>
7391 </dd>
7392 <dt class="hdlist1">
7393 http.sslCertPasswordProtected
7394 </dt>
7395 <dd>
7396 <p>
7397         Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
7398         OpenSSL will prompt the user, possibly many times, if the
7399         certificate or private key is encrypted.  Can be overridden by the
7400         <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7401 </p>
7402 </dd>
7403 <dt class="hdlist1">
7404 http.sslCAInfo
7405 </dt>
7406 <dd>
7407 <p>
7408         File containing the certificates to verify the peer with when
7409         fetching or pushing over HTTPS. Can be overridden by the
7410         <code>GIT_SSL_CAINFO</code> environment variable.
7411 </p>
7412 </dd>
7413 <dt class="hdlist1">
7414 http.sslCAPath
7415 </dt>
7416 <dd>
7417 <p>
7418         Path containing files with the CA certificates to verify the peer
7419         with when fetching or pushing over HTTPS. Can be overridden
7420         by the <code>GIT_SSL_CAPATH</code> environment variable.
7421 </p>
7422 </dd>
7423 <dt class="hdlist1">
7424 http.sslBackend
7425 </dt>
7426 <dd>
7427 <p>
7428         Name of the SSL backend to use (e.g. "openssl" or "schannel").
7429         This option is ignored if cURL lacks support for choosing the SSL
7430         backend at runtime.
7431 </p>
7432 </dd>
7433 <dt class="hdlist1">
7434 http.schannelCheckRevoke
7435 </dt>
7436 <dd>
7437 <p>
7438         Used to enforce or disable certificate revocation checks in cURL
7439         when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
7440         unset. Only necessary to disable this if Git consistently errors
7441         and the message is about checking the revocation status of a
7442         certificate. This option is ignored if cURL lacks support for
7443         setting the relevant SSL option at runtime.
7444 </p>
7445 </dd>
7446 <dt class="hdlist1">
7447 http.schannelUseSSLCAInfo
7448 </dt>
7449 <dd>
7450 <p>
7451         As of cURL v7.60.0, the Secure Channel backend can use the
7452         certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7453         override the Windows Certificate Store. Since this is not desirable
7454         by default, Git will tell cURL not to use that bundle by default
7455         when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7456         unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7457 </p>
7458 </dd>
7459 <dt class="hdlist1">
7460 http.pinnedPubkey
7461 </dt>
7462 <dd>
7463 <p>
7464         Public key of the https service. It may either be the filename of
7465         a PEM or DER encoded public key file or a string starting with
7466         <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7467         public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7468         exit with an error if this option is set but not supported by
7469         cURL.
7470 </p>
7471 </dd>
7472 <dt class="hdlist1">
7473 http.sslTry
7474 </dt>
7475 <dd>
7476 <p>
7477         Attempt to use AUTH SSL/TLS and encrypted data transfers
7478         when connecting via regular FTP protocol. This might be needed
7479         if the FTP server requires it for security reasons or you wish
7480         to connect securely whenever remote FTP server supports it.
7481         Default is false since it might trigger certificate verification
7482         errors on misconfigured servers.
7483 </p>
7484 </dd>
7485 <dt class="hdlist1">
7486 http.maxRequests
7487 </dt>
7488 <dd>
7489 <p>
7490         How many HTTP requests to launch in parallel. Can be overridden
7491         by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7492 </p>
7493 </dd>
7494 <dt class="hdlist1">
7495 http.minSessions
7496 </dt>
7497 <dd>
7498 <p>
7499         The number of curl sessions (counted across slots) to be kept across
7500         requests. They will not be ended with curl_easy_cleanup() until
7501         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7502         value will be capped at 1. Defaults to 1.
7503 </p>
7504 </dd>
7505 <dt class="hdlist1">
7506 http.postBuffer
7507 </dt>
7508 <dd>
7509 <p>
7510         Maximum size in bytes of the buffer used by smart HTTP
7511         transports when POSTing data to the remote system.
7512         For requests larger than this buffer size, HTTP/1.1 and
7513         Transfer-Encoding: chunked is used to avoid creating a
7514         massive pack file locally.  Default is 1 MiB, which is
7515         sufficient for most requests.
7516 </p>
7517 <div class="paragraph"><p>Note that raising this limit is only effective for disabling chunked
7518 transfer encoding and therefore should be used only where the remote
7519 server or a proxy only supports HTTP/1.0 or is noncompliant with the
7520 HTTP standard.  Raising this is not, in general, an effective solution
7521 for most push problems, but can increase memory consumption
7522 significantly since the entire buffer is allocated even for small
7523 pushes.</p></div>
7524 </dd>
7525 <dt class="hdlist1">
7526 http.lowSpeedLimit, http.lowSpeedTime
7527 </dt>
7528 <dd>
7529 <p>
7530         If the HTTP transfer speed, in bytes per second, is less than
7531         <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
7532         the transfer is aborted.
7533         Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
7534         <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
7535 </p>
7536 </dd>
7537 <dt class="hdlist1">
7538 http.noEPSV
7539 </dt>
7540 <dd>
7541 <p>
7542         A boolean which disables using of EPSV ftp command by curl.
7543         This can be helpful with some "poor" ftp servers which don&#8217;t
7544         support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
7545         environment variable. Default is false (curl will use EPSV).
7546 </p>
7547 </dd>
7548 <dt class="hdlist1">
7549 http.userAgent
7550 </dt>
7551 <dd>
7552 <p>
7553         The HTTP USER_AGENT string presented to an HTTP server.  The default
7554         value represents the version of the Git client such as git/1.7.1.
7555         This option allows you to override this value to a more common value
7556         such as Mozilla/4.0.  This may be necessary, for instance, if
7557         connecting through a firewall that restricts HTTP connections to a set
7558         of common USER_AGENT strings (but not including those like git/1.7.1).
7559         Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
7560 </p>
7561 </dd>
7562 <dt class="hdlist1">
7563 http.followRedirects
7564 </dt>
7565 <dd>
7566 <p>
7567         Whether git should follow HTTP redirects. If set to <code>true</code>, git
7568         will transparently follow any redirect issued by a server it
7569         encounters. If set to <code>false</code>, git will treat all redirects as
7570         errors. If set to <code>initial</code>, git will follow redirects only for
7571         the initial request to a remote, but not for subsequent
7572         follow-up HTTP requests. Since git uses the redirected URL as
7573         the base for the follow-up requests, this is generally
7574         sufficient. The default is <code>initial</code>.
7575 </p>
7576 </dd>
7577 <dt class="hdlist1">
7578 http.&lt;url&gt;.*
7579 </dt>
7580 <dd>
7581 <p>
7582         Any of the http.* options above can be applied selectively to some URLs.
7583         For a config key to match a URL, each element of the config key is
7584         compared to that of the URL, in the following order:
7585 </p>
7586 <div class="openblock">
7587 <div class="content">
7588 <div class="olist arabic"><ol class="arabic">
7589 <li>
7590 <p>
7591 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
7592   must match exactly between the config key and the URL.
7593 </p>
7594 </li>
7595 <li>
7596 <p>
7597 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
7598   This field must match between the config key and the URL. It is
7599   possible to specify a <code>*</code> as part of the host name to match all subdomains
7600   at this level. <code>https://*.example.com/</code> for example would match
7601   <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
7602 </p>
7603 </li>
7604 <li>
7605 <p>
7606 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
7607   This field must match exactly between the config key and the URL.
7608   Omitted port numbers are automatically converted to the correct
7609   default for the scheme before matching.
7610 </p>
7611 </li>
7612 <li>
7613 <p>
7614 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
7615   path field of the config key must match the path field of the URL
7616   either exactly or as a prefix of slash-delimited path elements.  This means
7617   a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
7618   match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
7619   key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
7620   key with just path <code>foo/</code>).
7621 </p>
7622 </li>
7623 <li>
7624 <p>
7625 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
7626   the config key has a user name it must match the user name in the
7627   URL exactly. If the config key does not have a user name, that
7628   config key will match a URL with any user name (including none),
7629   but at a lower precedence than a config key with a user name.
7630 </p>
7631 </li>
7632 </ol></div>
7633 </div></div>
7634 <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
7635 a config key&#8217;s path is preferred to one that matches its user name. For example,
7636 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
7637 <code>https://example.com/foo</code> will be preferred over a config key match of
7638 <code>https://user@example.com</code>.</p></div>
7639 <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
7640 if embedded in the URL, is always ignored for matching purposes) so that
7641 equivalent URLs that are simply spelled differently will match properly.
7642 Environment variable settings always override any matches.  The URLs that are
7643 matched against are those given directly to Git commands.  This means any URLs
7644 visited as a result of a redirection do not participate in matching.</p></div>
7645 </dd>
7646 <dt class="hdlist1">
7647 i18n.commitEncoding
7648 </dt>
7649 <dd>
7650 <p>
7651         Character encoding the commit messages are stored in; Git itself
7652         does not care per se, but this information is necessary e.g. when
7653         importing commits from emails or in the gitk graphical history
7654         browser (and possibly in other places in the future or in other
7655         porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
7656 </p>
7657 </dd>
7658 <dt class="hdlist1">
7659 i18n.logOutputEncoding
7660 </dt>
7661 <dd>
7662 <p>
7663         Character encoding the commit messages are converted to when
7664         running <em>git log</em> and friends.
7665 </p>
7666 </dd>
7667 <dt class="hdlist1">
7668 imap.folder
7669 </dt>
7670 <dd>
7671 <p>
7672         The folder to drop the mails into, which is typically the Drafts
7673         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
7674         "[Gmail]/Drafts". Required.
7675 </p>
7676 </dd>
7677 <dt class="hdlist1">
7678 imap.tunnel
7679 </dt>
7680 <dd>
7681 <p>
7682         Command used to set up a tunnel to the IMAP server through which
7683         commands will be piped instead of using a direct network connection
7684         to the server. Required when imap.host is not set.
7685 </p>
7686 </dd>
7687 <dt class="hdlist1">
7688 imap.host
7689 </dt>
7690 <dd>
7691 <p>
7692         A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
7693         connections and an <code>imaps://</code> prefix for secure connections.
7694         Ignored when imap.tunnel is set, but required otherwise.
7695 </p>
7696 </dd>
7697 <dt class="hdlist1">
7698 imap.user
7699 </dt>
7700 <dd>
7701 <p>
7702         The username to use when logging in to the server.
7703 </p>
7704 </dd>
7705 <dt class="hdlist1">
7706 imap.pass
7707 </dt>
7708 <dd>
7709 <p>
7710         The password to use when logging in to the server.
7711 </p>
7712 </dd>
7713 <dt class="hdlist1">
7714 imap.port
7715 </dt>
7716 <dd>
7717 <p>
7718         An integer port number to connect to on the server.
7719         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
7720         Ignored when imap.tunnel is set.
7721 </p>
7722 </dd>
7723 <dt class="hdlist1">
7724 imap.sslverify
7725 </dt>
7726 <dd>
7727 <p>
7728         A boolean to enable/disable verification of the server certificate
7729         used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
7730         imap.tunnel is set.
7731 </p>
7732 </dd>
7733 <dt class="hdlist1">
7734 imap.preformattedHTML
7735 </dt>
7736 <dd>
7737 <p>
7738         A boolean to enable/disable the use of html encoding when sending
7739         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
7740         and have a content type of text/html.  Ironically, enabling this
7741         option causes Thunderbird to send the patch as a plain/text,
7742         format=fixed email.  Default is <code>false</code>.
7743 </p>
7744 </dd>
7745 <dt class="hdlist1">
7746 imap.authMethod
7747 </dt>
7748 <dd>
7749 <p>
7750         Specify the authentication method for authenticating with the IMAP server.
7751         If Git was built with the NO_CURL option, or if your curl version is older
7752         than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
7753         option, the only supported method is <em>CRAM-MD5</em>. If this is not set
7754         then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
7755 </p>
7756 </dd>
7757 <dt class="hdlist1">
7758 include.path
7759 </dt>
7760 <dt class="hdlist1">
7761 includeIf.&lt;condition&gt;.path
7762 </dt>
7763 <dd>
7764 <p>
7765         Special variables to include other configuration files. See
7766         the "CONFIGURATION FILE" section in the main
7767         <a href="git-config.html">git-config(1)</a> documentation,
7768         specifically the "Includes" and "Conditional Includes" subsections.
7769 </p>
7770 </dd>
7771 <dt class="hdlist1">
7772 index.recordEndOfIndexEntries
7773 </dt>
7774 <dd>
7775 <p>
7776         Specifies whether the index file should include an "End Of Index
7777         Entry" section. This reduces index load time on multiprocessor
7778         machines but produces a message "ignoring EOIE extension" when
7779         reading the index using Git versions before 2.20. Defaults to
7780         <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
7781         otherwise.
7782 </p>
7783 </dd>
7784 <dt class="hdlist1">
7785 index.recordOffsetTable
7786 </dt>
7787 <dd>
7788 <p>
7789         Specifies whether the index file should include an "Index Entry
7790         Offset Table" section. This reduces index load time on
7791         multiprocessor machines but produces a message "ignoring IEOT
7792         extension" when reading the index using Git versions before 2.20.
7793         Defaults to <em>true</em> if index.threads has been explicitly enabled,
7794         <em>false</em> otherwise.
7795 </p>
7796 </dd>
7797 <dt class="hdlist1">
7798 index.sparse
7799 </dt>
7800 <dd>
7801 <p>
7802         When enabled, write the index using sparse-directory entries. This
7803         has no effect unless <code>core.sparseCheckout</code> and
7804         <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
7805 </p>
7806 </dd>
7807 <dt class="hdlist1">
7808 index.threads
7809 </dt>
7810 <dd>
7811 <p>
7812         Specifies the number of threads to spawn when loading the index.
7813         This is meant to reduce index load time on multiprocessor machines.
7814         Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
7815         CPUs and set the number of threads accordingly. Specifying 1 or
7816         <em>false</em> will disable multithreading. Defaults to <em>true</em>.
7817 </p>
7818 </dd>
7819 <dt class="hdlist1">
7820 index.version
7821 </dt>
7822 <dd>
7823 <p>
7824         Specify the version with which new index files should be
7825         initialized.  This does not affect existing repositories.
7826         If <code>feature.manyFiles</code> is enabled, then the default is 4.
7827 </p>
7828 </dd>
7829 <dt class="hdlist1">
7830 index.skipHash
7831 </dt>
7832 <dd>
7833 <p>
7834         When enabled, do not compute the trailing hash for the index file.
7835         This accelerates Git commands that manipulate the index, such as
7836         <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
7837         checksum, write a trailing set of bytes with value zero, indicating
7838         that the computation was skipped.
7839 </p>
7840 <div class="paragraph"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
7841 refuse to parse the index and Git clients older than 2.40.0 will report an
7842 error during <code>git fsck</code>.</p></div>
7843 </dd>
7844 <dt class="hdlist1">
7845 init.templateDir
7846 </dt>
7847 <dd>
7848 <p>
7849         Specify the directory from which templates will be copied.
7850         (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
7851 </p>
7852 </dd>
7853 <dt class="hdlist1">
7854 init.defaultBranch
7855 </dt>
7856 <dd>
7857 <p>
7858         Allows overriding the default branch name e.g. when initializing
7859         a new repository.
7860 </p>
7861 </dd>
7862 <dt class="hdlist1">
7863 instaweb.browser
7864 </dt>
7865 <dd>
7866 <p>
7867         Specify the program that will be used to browse your working
7868         repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7869 </p>
7870 </dd>
7871 <dt class="hdlist1">
7872 instaweb.httpd
7873 </dt>
7874 <dd>
7875 <p>
7876         The HTTP daemon command-line to start gitweb on your working
7877         repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
7878 </p>
7879 </dd>
7880 <dt class="hdlist1">
7881 instaweb.local
7882 </dt>
7883 <dd>
7884 <p>
7885         If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
7886         be bound to the local IP (127.0.0.1).
7887 </p>
7888 </dd>
7889 <dt class="hdlist1">
7890 instaweb.modulePath
7891 </dt>
7892 <dd>
7893 <p>
7894         The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
7895         instead of /usr/lib/apache2/modules.  Only used if httpd
7896         is Apache.
7897 </p>
7898 </dd>
7899 <dt class="hdlist1">
7900 instaweb.port
7901 </dt>
7902 <dd>
7903 <p>
7904         The port number to bind the gitweb httpd to. See
7905         <a href="git-instaweb.html">git-instaweb(1)</a>.
7906 </p>
7907 </dd>
7908 <dt class="hdlist1">
7909 interactive.singleKey
7910 </dt>
7911 <dd>
7912 <p>
7913         In interactive commands, allow the user to provide one-letter
7914         input with a single key (i.e., without hitting enter).
7915         Currently this is used by the <code>--patch</code> mode of
7916         <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
7917         <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
7918         <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>. Note that this
7919         setting is silently ignored if portable keystroke input
7920         is not available; requires the Perl module Term::ReadKey.
7921 </p>
7922 </dd>
7923 <dt class="hdlist1">
7924 interactive.diffFilter
7925 </dt>
7926 <dd>
7927 <p>
7928         When an interactive command (such as <code>git add --patch</code>) shows
7929         a colorized diff, git will pipe the diff through the shell
7930         command defined by this configuration variable. The command may
7931         mark up the diff further for human consumption, provided that it
7932         retains a one-to-one correspondence with the lines in the
7933         original diff. Defaults to disabled (no filtering).
7934 </p>
7935 </dd>
7936 <dt class="hdlist1">
7937 log.abbrevCommit
7938 </dt>
7939 <dd>
7940 <p>
7941         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
7942         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
7943         override this option with <code>--no-abbrev-commit</code>.
7944 </p>
7945 </dd>
7946 <dt class="hdlist1">
7947 log.date
7948 </dt>
7949 <dd>
7950 <p>
7951         Set the default date-time mode for the <em>log</em> command.
7952         Setting a value for log.date is similar to using <em>git log</em>'s
7953         <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.
7954 </p>
7955 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
7956 "foo" will be used for the date format. Otherwise, "default" will
7957 be used.</p></div>
7958 </dd>
7959 <dt class="hdlist1">
7960 log.decorate
7961 </dt>
7962 <dd>
7963 <p>
7964         Print out the ref names of any commits that are shown by the log
7965         command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
7966         <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
7967         specified, the full ref name (including prefix) will be printed.
7968         If <em>auto</em> is specified, then if the output is going to a terminal,
7969         the ref names are shown as if <em>short</em> were given, otherwise no ref
7970         names are shown. This is the same as the <code>--decorate</code> option
7971         of the <code>git log</code>.
7972 </p>
7973 </dd>
7974 <dt class="hdlist1">
7975 log.initialDecorationSet
7976 </dt>
7977 <dd>
7978 <p>
7979         By default, <code>git log</code> only shows decorations for certain known ref
7980         namespaces. If <em>all</em> is specified, then show all refs as
7981         decorations.
7982 </p>
7983 </dd>
7984 <dt class="hdlist1">
7985 log.excludeDecoration
7986 </dt>
7987 <dd>
7988 <p>
7989         Exclude the specified patterns from the log decorations. This is
7990         similar to the <code>--decorate-refs-exclude</code> command-line option, but
7991         the config option can be overridden by the <code>--decorate-refs</code>
7992         option.
7993 </p>
7994 </dd>
7995 <dt class="hdlist1">
7996 log.diffMerges
7997 </dt>
7998 <dd>
7999 <p>
8000         Set diff format to be used when <code>--diff-merges=on</code> is
8001         specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
8002         details. Defaults to <code>separate</code>.
8003 </p>
8004 </dd>
8005 <dt class="hdlist1">
8006 log.follow
8007 </dt>
8008 <dd>
8009 <p>
8010         If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
8011         a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
8012         i.e. it cannot be used to follow multiple files and does not work well
8013         on non-linear history.
8014 </p>
8015 </dd>
8016 <dt class="hdlist1">
8017 log.graphColors
8018 </dt>
8019 <dd>
8020 <p>
8021         A list of colors, separated by commas, that can be used to draw
8022         history lines in <code>git log --graph</code>.
8023 </p>
8024 </dd>
8025 <dt class="hdlist1">
8026 log.showRoot
8027 </dt>
8028 <dd>
8029 <p>
8030         If true, the initial commit will be shown as a big creation event.
8031         This is equivalent to a diff against an empty tree.
8032         Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
8033         normally hide the root commit will now show it. True by default.
8034 </p>
8035 </dd>
8036 <dt class="hdlist1">
8037 log.showSignature
8038 </dt>
8039 <dd>
8040 <p>
8041         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8042         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
8043 </p>
8044 </dd>
8045 <dt class="hdlist1">
8046 log.mailmap
8047 </dt>
8048 <dd>
8049 <p>
8050         If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
8051         <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
8052         assume <code>--no-use-mailmap</code>. True by default.
8053 </p>
8054 </dd>
8055 <dt class="hdlist1">
8056 lsrefs.unborn
8057 </dt>
8058 <dd>
8059 <p>
8060         May be "advertise" (the default), "allow", or "ignore". If "advertise",
8061         the server will respond to the client sending "unborn" (as described in
8062         <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
8063         protocol v2 capability advertisement. "allow" is the same as
8064         "advertise" except that the server will not advertise support for this
8065         feature; this is useful for load-balanced servers that cannot be
8066         updated atomically (for example), since the administrator could
8067         configure "allow", then after a delay, configure "advertise".
8068 </p>
8069 </dd>
8070 <dt class="hdlist1">
8071 mailinfo.scissors
8072 </dt>
8073 <dd>
8074 <p>
8075         If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
8076         <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
8077         was provided on the command-line. When active, this feature
8078         removes everything from the message body before a scissors
8079         line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
8080 </p>
8081 </dd>
8082 <dt class="hdlist1">
8083 mailmap.file
8084 </dt>
8085 <dd>
8086 <p>
8087         The location of an augmenting mailmap file. The default
8088         mailmap, located in the root of the repository, is loaded
8089         first, then the mailmap file pointed to by this variable.
8090         The location of the mailmap file may be in a repository
8091         subdirectory, or somewhere outside of the repository itself.
8092         See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
8093 </p>
8094 </dd>
8095 <dt class="hdlist1">
8096 mailmap.blob
8097 </dt>
8098 <dd>
8099 <p>
8100         Like <code>mailmap.file</code>, but consider the value as a reference to a
8101         blob in the repository. If both <code>mailmap.file</code> and
8102         <code>mailmap.blob</code> are given, both are parsed, with entries from
8103         <code>mailmap.file</code> taking precedence. In a bare repository, this
8104         defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8105         defaults to empty.
8106 </p>
8107 </dd>
8108 <dt class="hdlist1">
8109 maintenance.auto
8110 </dt>
8111 <dd>
8112 <p>
8113         This boolean config option controls whether some commands run
8114         <code>git maintenance run --auto</code> after doing their normal work. Defaults
8115         to true.
8116 </p>
8117 </dd>
8118 <dt class="hdlist1">
8119 maintenance.strategy
8120 </dt>
8121 <dd>
8122 <p>
8123         This string config option provides a way to specify one of a few
8124         recommended schedules for background maintenance. This only affects
8125         which tasks are run during <code>git maintenance run --schedule=X</code>
8126         commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
8127         Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
8128         then that value is used instead of the one provided by
8129         <code>maintenance.strategy</code>. The possible strategy strings are:
8130 </p>
8131 <div class="ulist"><ul>
8132 <li>
8133 <p>
8134 <code>none</code>: This default setting implies no tasks are run at any schedule.
8135 </p>
8136 </li>
8137 <li>
8138 <p>
8139 <code>incremental</code>: This setting optimizes for performing small maintenance
8140   activities that do not delete any data. This does not schedule the <code>gc</code>
8141   task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8142   <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8143   task weekly.
8144 </p>
8145 </li>
8146 </ul></div>
8147 </dd>
8148 <dt class="hdlist1">
8149 maintenance.&lt;task&gt;.enabled
8150 </dt>
8151 <dd>
8152 <p>
8153         This boolean config option controls whether the maintenance task
8154         with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
8155         <code>git maintenance run</code>. These config values are ignored if a
8156         <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8157         is true.
8158 </p>
8159 </dd>
8160 <dt class="hdlist1">
8161 maintenance.&lt;task&gt;.schedule
8162 </dt>
8163 <dd>
8164 <p>
8165         This config option controls whether or not the given <code>&lt;task&gt;</code> runs
8166         during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
8167         value must be one of "hourly", "daily", or "weekly".
8168 </p>
8169 </dd>
8170 <dt class="hdlist1">
8171 maintenance.commit-graph.auto
8172 </dt>
8173 <dd>
8174 <p>
8175         This integer config option controls how often the <code>commit-graph</code> task
8176         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8177         the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8178         negative value will force the task to run every time. Otherwise, a
8179         positive value implies the command should run when the number of
8180         reachable commits that are not in the commit-graph file is at least
8181         the value of <code>maintenance.commit-graph.auto</code>. The default value is
8182         100.
8183 </p>
8184 </dd>
8185 <dt class="hdlist1">
8186 maintenance.loose-objects.auto
8187 </dt>
8188 <dd>
8189 <p>
8190         This integer config option controls how often the <code>loose-objects</code> task
8191         should be run as part of <code>git maintenance run --auto</code>. If zero, then
8192         the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8193         negative value will force the task to run every time. Otherwise, a
8194         positive value implies the command should run when the number of
8195         loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8196         The default value is 100.
8197 </p>
8198 </dd>
8199 <dt class="hdlist1">
8200 maintenance.incremental-repack.auto
8201 </dt>
8202 <dd>
8203 <p>
8204         This integer config option controls how often the <code>incremental-repack</code>
8205         task should be run as part of <code>git maintenance run --auto</code>. If zero,
8206         then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8207         option. A negative value will force the task to run every time.
8208         Otherwise, a positive value implies the command should run when the
8209         number of pack-files not in the multi-pack-index is at least the value
8210         of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8211 </p>
8212 </dd>
8213 <dt class="hdlist1">
8214 man.viewer
8215 </dt>
8216 <dd>
8217 <p>
8218         Specify the programs that may be used to display help in the
8219         <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8220 </p>
8221 </dd>
8222 <dt class="hdlist1">
8223 man.&lt;tool&gt;.cmd
8224 </dt>
8225 <dd>
8226 <p>
8227         Specify the command to invoke the specified man viewer. The
8228         specified command is evaluated in shell with the man page
8229         passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)
8230 </p>
8231 </dd>
8232 <dt class="hdlist1">
8233 man.&lt;tool&gt;.path
8234 </dt>
8235 <dd>
8236 <p>
8237         Override the path for the given tool that may be used to
8238         display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
8239 </p>
8240 </dd>
8241 <dt class="hdlist1">
8242 merge.conflictStyle
8243 </dt>
8244 <dd>
8245 <p>
8246         Specify the style in which conflicted hunks are written out to
8247         working tree files upon merge.  The default is "merge", which
8248         shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
8249         a <code>=======</code> marker, changes made by the other side, and then
8250         a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
8251         marker and the original text before the <code>=======</code> marker.  The
8252         "merge" style tends to produce smaller conflict regions than diff3,
8253         both because of the exclusion of the original text, and because
8254         when a subset of lines match on the two sides, they are just pulled
8255         out of the conflict region.  Another alternate style, "zdiff3", is
8256         similar to diff3 but removes matching lines on the two sides from
8257         the conflict region when those matching lines appear near either
8258         the beginning or end of a conflict region.
8259 </p>
8260 </dd>
8261 <dt class="hdlist1">
8262 merge.defaultToUpstream
8263 </dt>
8264 <dd>
8265 <p>
8266         If merge is called without any commit argument, merge the upstream
8267         branches configured for the current branch by using their last
8268         observed values stored in their remote-tracking branches.
8269         The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
8270         branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
8271         are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
8272         to their corresponding remote-tracking branches, and the tips of
8273         these tracking branches are merged. Defaults to true.
8274 </p>
8275 </dd>
8276 <dt class="hdlist1">
8277 merge.ff
8278 </dt>
8279 <dd>
8280 <p>
8281         By default, Git does not create an extra merge commit when merging
8282         a commit that is a descendant of the current commit. Instead, the
8283         tip of the current branch is fast-forwarded. When set to <code>false</code>,
8284         this variable tells Git to create an extra merge commit in such
8285         a case (equivalent to giving the <code>--no-ff</code> option from the command
8286         line). When set to <code>only</code>, only such fast-forward merges are
8287         allowed (equivalent to giving the <code>--ff-only</code> option from the
8288         command line).
8289 </p>
8290 </dd>
8291 <dt class="hdlist1">
8292 merge.verifySignatures
8293 </dt>
8294 <dd>
8295 <p>
8296         If true, this is equivalent to the --verify-signatures command
8297         line option. See <a href="git-merge.html">git-merge(1)</a> for details.
8298 </p>
8299 </dd>
8300 <dt class="hdlist1">
8301 merge.branchdesc
8302 </dt>
8303 <dd>
8304 <p>
8305         In addition to branch names, populate the log message with
8306         the branch description text associated with them.  Defaults
8307         to false.
8308 </p>
8309 </dd>
8310 <dt class="hdlist1">
8311 merge.log
8312 </dt>
8313 <dd>
8314 <p>
8315         In addition to branch names, populate the log message with at
8316         most the specified number of one-line descriptions from the
8317         actual commits that are being merged.  Defaults to false, and
8318         true is a synonym for 20.
8319 </p>
8320 </dd>
8321 <dt class="hdlist1">
8322 merge.suppressDest
8323 </dt>
8324 <dd>
8325 <p>
8326         By adding a glob that matches the names of integration
8327         branches to this multi-valued configuration variable, the
8328         default merge message computed for merges into these
8329         integration branches will omit "into &lt;branch name&gt;" from
8330         its title.
8331 </p>
8332 <div class="paragraph"><p>An element with an empty value can be used to clear the list
8333 of globs accumulated from previous configuration entries.
8334 When there is no <code>merge.suppressDest</code> variable defined, the
8335 default value of <code>master</code> is used for backward compatibility.</p></div>
8336 </dd>
8337 <dt class="hdlist1">
8338 merge.renameLimit
8339 </dt>
8340 <dd>
8341 <p>
8342         The number of files to consider in the exhaustive portion of
8343         rename detection during a merge.  If not specified, defaults
8344         to the value of diff.renameLimit.  If neither
8345         merge.renameLimit nor diff.renameLimit are specified,
8346         currently defaults to 7000.  This setting has no effect if
8347         rename detection is turned off.
8348 </p>
8349 </dd>
8350 <dt class="hdlist1">
8351 merge.renames
8352 </dt>
8353 <dd>
8354 <p>
8355         Whether Git detects renames.  If set to "false", rename detection
8356         is disabled. If set to "true", basic rename detection is enabled.
8357         Defaults to the value of diff.renames.
8358 </p>
8359 </dd>
8360 <dt class="hdlist1">
8361 merge.directoryRenames
8362 </dt>
8363 <dd>
8364 <p>
8365         Whether Git detects directory renames, affecting what happens at
8366         merge time to new files added to a directory on one side of
8367         history when that directory was renamed on the other side of
8368         history.  If merge.directoryRenames is set to "false", directory
8369         rename detection is disabled, meaning that such new files will be
8370         left behind in the old directory.  If set to "true", directory
8371         rename detection is enabled, meaning that such new files will be
8372         moved into the new directory.  If set to "conflict", a conflict
8373         will be reported for such paths.  If merge.renames is false,
8374         merge.directoryRenames is ignored and treated as false.  Defaults
8375         to "conflict".
8376 </p>
8377 </dd>
8378 <dt class="hdlist1">
8379 merge.renormalize
8380 </dt>
8381 <dd>
8382 <p>
8383         Tell Git that canonical representation of files in the
8384         repository has changed over time (e.g. earlier commits record
8385         text files with CRLF line endings, but recent ones use LF line
8386         endings).  In such a repository, Git can convert the data
8387         recorded in commits to a canonical form before performing a
8388         merge to reduce unnecessary conflicts.  For more information,
8389         see section "Merging branches with differing checkin/checkout
8390         attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
8391 </p>
8392 </dd>
8393 <dt class="hdlist1">
8394 merge.stat
8395 </dt>
8396 <dd>
8397 <p>
8398         Whether to print the diffstat between ORIG_HEAD and the merge result
8399         at the end of the merge.  True by default.
8400 </p>
8401 </dd>
8402 <dt class="hdlist1">
8403 merge.autoStash
8404 </dt>
8405 <dd>
8406 <p>
8407         When set to true, automatically create a temporary stash entry
8408         before the operation begins, and apply it after the operation
8409         ends.  This means that you can run merge on a dirty worktree.
8410         However, use with care: the final stash application after a
8411         successful merge might result in non-trivial conflicts.
8412         This option can be overridden by the <code>--no-autostash</code> and
8413         <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
8414         Defaults to false.
8415 </p>
8416 </dd>
8417 <dt class="hdlist1">
8418 merge.tool
8419 </dt>
8420 <dd>
8421 <p>
8422         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
8423         The list below shows the valid built-in values.
8424         Any other value is treated as a custom merge tool and requires
8425         that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
8426 </p>
8427 </dd>
8428 <dt class="hdlist1">
8429 merge.guitool
8430 </dt>
8431 <dd>
8432 <p>
8433         Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
8434         -g/--gui flag is specified. The list below shows the valid built-in values.
8435         Any other value is treated as a custom merge tool and requires that a
8436         corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.
8437 </p>
8438 <div class="dlist"><dl>
8439 <dt class="hdlist1">
8440 <code>araxis</code>
8441 </dt>
8442 <dd>
8443 <p>
8444 Use Araxis Merge (requires a graphical session)
8445 </p>
8446 </dd>
8447 <dt class="hdlist1">
8448 <code>bc</code>
8449 </dt>
8450 <dd>
8451 <p>
8452 Use Beyond Compare (requires a graphical session)
8453 </p>
8454 </dd>
8455 <dt class="hdlist1">
8456 <code>bc3</code>
8457 </dt>
8458 <dd>
8459 <p>
8460 Use Beyond Compare (requires a graphical session)
8461 </p>
8462 </dd>
8463 <dt class="hdlist1">
8464 <code>bc4</code>
8465 </dt>
8466 <dd>
8467 <p>
8468 Use Beyond Compare (requires a graphical session)
8469 </p>
8470 </dd>
8471 <dt class="hdlist1">
8472 <code>codecompare</code>
8473 </dt>
8474 <dd>
8475 <p>
8476 Use Code Compare (requires a graphical session)
8477 </p>
8478 </dd>
8479 <dt class="hdlist1">
8480 <code>deltawalker</code>
8481 </dt>
8482 <dd>
8483 <p>
8484 Use DeltaWalker (requires a graphical session)
8485 </p>
8486 </dd>
8487 <dt class="hdlist1">
8488 <code>diffmerge</code>
8489 </dt>
8490 <dd>
8491 <p>
8492 Use DiffMerge (requires a graphical session)
8493 </p>
8494 </dd>
8495 <dt class="hdlist1">
8496 <code>diffuse</code>
8497 </dt>
8498 <dd>
8499 <p>
8500 Use Diffuse (requires a graphical session)
8501 </p>
8502 </dd>
8503 <dt class="hdlist1">
8504 <code>ecmerge</code>
8505 </dt>
8506 <dd>
8507 <p>
8508 Use ECMerge (requires a graphical session)
8509 </p>
8510 </dd>
8511 <dt class="hdlist1">
8512 <code>emerge</code>
8513 </dt>
8514 <dd>
8515 <p>
8516 Use Emacs' Emerge
8517 </p>
8518 </dd>
8519 <dt class="hdlist1">
8520 <code>examdiff</code>
8521 </dt>
8522 <dd>
8523 <p>
8524 Use ExamDiff Pro (requires a graphical session)
8525 </p>
8526 </dd>
8527 <dt class="hdlist1">
8528 <code>guiffy</code>
8529 </dt>
8530 <dd>
8531 <p>
8532 Use Guiffy&#8217;s Diff Tool (requires a graphical session)
8533 </p>
8534 </dd>
8535 <dt class="hdlist1">
8536 <code>gvimdiff</code>
8537 </dt>
8538 <dd>
8539 <p>
8540 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8541 </p>
8542 </dd>
8543 <dt class="hdlist1">
8544 <code>gvimdiff1</code>
8545 </dt>
8546 <dd>
8547 <p>
8548 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
8549 </p>
8550 </dd>
8551 <dt class="hdlist1">
8552 <code>gvimdiff2</code>
8553 </dt>
8554 <dd>
8555 <p>
8556 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
8557 </p>
8558 </dd>
8559 <dt class="hdlist1">
8560 <code>gvimdiff3</code>
8561 </dt>
8562 <dd>
8563 <p>
8564 Use gVim (requires a graphical session) where only the MERGED file is shown
8565 </p>
8566 </dd>
8567 <dt class="hdlist1">
8568 <code>kdiff3</code>
8569 </dt>
8570 <dd>
8571 <p>
8572 Use KDiff3 (requires a graphical session)
8573 </p>
8574 </dd>
8575 <dt class="hdlist1">
8576 <code>meld</code>
8577 </dt>
8578 <dd>
8579 <p>
8580 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
8581 </p>
8582 </dd>
8583 <dt class="hdlist1">
8584 <code>nvimdiff</code>
8585 </dt>
8586 <dd>
8587 <p>
8588 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8589 </p>
8590 </dd>
8591 <dt class="hdlist1">
8592 <code>nvimdiff1</code>
8593 </dt>
8594 <dd>
8595 <p>
8596 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
8597 </p>
8598 </dd>
8599 <dt class="hdlist1">
8600 <code>nvimdiff2</code>
8601 </dt>
8602 <dd>
8603 <p>
8604 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8605 </p>
8606 </dd>
8607 <dt class="hdlist1">
8608 <code>nvimdiff3</code>
8609 </dt>
8610 <dd>
8611 <p>
8612 Use Neovim where only the MERGED file is shown
8613 </p>
8614 </dd>
8615 <dt class="hdlist1">
8616 <code>opendiff</code>
8617 </dt>
8618 <dd>
8619 <p>
8620 Use FileMerge (requires a graphical session)
8621 </p>
8622 </dd>
8623 <dt class="hdlist1">
8624 <code>p4merge</code>
8625 </dt>
8626 <dd>
8627 <p>
8628 Use HelixCore P4Merge (requires a graphical session)
8629 </p>
8630 </dd>
8631 <dt class="hdlist1">
8632 <code>smerge</code>
8633 </dt>
8634 <dd>
8635 <p>
8636 Use Sublime Merge (requires a graphical session)
8637 </p>
8638 </dd>
8639 <dt class="hdlist1">
8640 <code>tkdiff</code>
8641 </dt>
8642 <dd>
8643 <p>
8644 Use TkDiff (requires a graphical session)
8645 </p>
8646 </dd>
8647 <dt class="hdlist1">
8648 <code>tortoisemerge</code>
8649 </dt>
8650 <dd>
8651 <p>
8652 Use TortoiseMerge (requires a graphical session)
8653 </p>
8654 </dd>
8655 <dt class="hdlist1">
8656 <code>vimdiff</code>
8657 </dt>
8658 <dd>
8659 <p>
8660 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8661 </p>
8662 </dd>
8663 <dt class="hdlist1">
8664 <code>vimdiff1</code>
8665 </dt>
8666 <dd>
8667 <p>
8668 Use Vim with a 2 panes layout (LOCAL and REMOTE)
8669 </p>
8670 </dd>
8671 <dt class="hdlist1">
8672 <code>vimdiff2</code>
8673 </dt>
8674 <dd>
8675 <p>
8676 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8677 </p>
8678 </dd>
8679 <dt class="hdlist1">
8680 <code>vimdiff3</code>
8681 </dt>
8682 <dd>
8683 <p>
8684 Use Vim where only the MERGED file is shown
8685 </p>
8686 </dd>
8687 <dt class="hdlist1">
8688 <code>winmerge</code>
8689 </dt>
8690 <dd>
8691 <p>
8692 Use WinMerge (requires a graphical session)
8693 </p>
8694 </dd>
8695 <dt class="hdlist1">
8696 <code>xxdiff</code>
8697 </dt>
8698 <dd>
8699 <p>
8700 Use xxdiff (requires a graphical session)
8701 </p>
8702 </dd>
8703 </dl></div>
8704 </dd>
8705 <dt class="hdlist1">
8706 merge.verbosity
8707 </dt>
8708 <dd>
8709 <p>
8710         Controls the amount of output shown by the recursive merge
8711         strategy.  Level 0 outputs nothing except a final error
8712         message if conflicts were detected. Level 1 outputs only
8713         conflicts, 2 outputs conflicts and file changes.  Level 5 and
8714         above outputs debugging information.  The default is level 2.
8715         Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
8716 </p>
8717 </dd>
8718 <dt class="hdlist1">
8719 merge.&lt;driver&gt;.name
8720 </dt>
8721 <dd>
8722 <p>
8723         Defines a human-readable name for a custom low-level
8724         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8725 </p>
8726 </dd>
8727 <dt class="hdlist1">
8728 merge.&lt;driver&gt;.driver
8729 </dt>
8730 <dd>
8731 <p>
8732         Defines the command that implements a custom low-level
8733         merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
8734 </p>
8735 </dd>
8736 <dt class="hdlist1">
8737 merge.&lt;driver&gt;.recursive
8738 </dt>
8739 <dd>
8740 <p>
8741         Names a low-level merge driver to be used when
8742         performing an internal merge between common ancestors.
8743         See <a href="gitattributes.html">gitattributes(5)</a> for details.
8744 </p>
8745 </dd>
8746 <dt class="hdlist1">
8747 mergetool.&lt;tool&gt;.path
8748 </dt>
8749 <dd>
8750 <p>
8751         Override the path for the given tool.  This is useful in case
8752         your tool is not in the PATH.
8753 </p>
8754 </dd>
8755 <dt class="hdlist1">
8756 mergetool.&lt;tool&gt;.cmd
8757 </dt>
8758 <dd>
8759 <p>
8760         Specify the command to invoke the specified merge tool.  The
8761         specified command is evaluated in shell with the following
8762         variables available: <em>BASE</em> is the name of a temporary file
8763         containing the common base of the files to be merged, if available;
8764         <em>LOCAL</em> is the name of a temporary file containing the contents of
8765         the file on the current branch; <em>REMOTE</em> is the name of a temporary
8766         file containing the contents of the file from the branch being
8767         merged; <em>MERGED</em> contains the name of the file to which the merge
8768         tool should write the results of a successful merge.
8769 </p>
8770 </dd>
8771 <dt class="hdlist1">
8772 mergetool.&lt;tool&gt;.hideResolved
8773 </dt>
8774 <dd>
8775 <p>
8776         Allows the user to override the global <code>mergetool.hideResolved</code> value
8777         for a specific tool. See <code>mergetool.hideResolved</code> for the full
8778         description.
8779 </p>
8780 </dd>
8781 <dt class="hdlist1">
8782 mergetool.&lt;tool&gt;.trustExitCode
8783 </dt>
8784 <dd>
8785 <p>
8786         For a custom merge command, specify whether the exit code of
8787         the merge command can be used to determine whether the merge was
8788         successful.  If this is not set to true then the merge target file
8789         timestamp is checked, and the merge is assumed to have been successful
8790         if the file has been updated; otherwise, the user is prompted to
8791         indicate the success of the merge.
8792 </p>
8793 </dd>
8794 <dt class="hdlist1">
8795 mergetool.meld.hasOutput
8796 </dt>
8797 <dd>
8798 <p>
8799         Older versions of <code>meld</code> do not support the <code>--output</code> option.
8800         Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
8801         by inspecting the output of <code>meld --help</code>.  Configuring
8802         <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
8803         use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
8804         to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
8805         and <code>false</code> avoids using <code>--output</code>.
8806 </p>
8807 </dd>
8808 <dt class="hdlist1">
8809 mergetool.meld.useAutoMerge
8810 </dt>
8811 <dd>
8812 <p>
8813         When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
8814         parts automatically, highlight the conflicting parts, and wait for
8815         user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
8816         Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
8817         Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
8818         is supported and will only use <code>--auto-merge</code> when available.  A
8819         value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
8820         default value.
8821 </p>
8822 </dd>
8823 <dt class="hdlist1">
8824 mergetool.vimdiff.layout
8825 </dt>
8826 <dd>
8827 <p>
8828         The vimdiff backend uses this variable to control how its split
8829         windows appear. Applies even if you are using Neovim (<code>nvim</code>) or
8830         gVim (<code>gvim</code>) as the merge tool. See BACKEND SPECIFIC HINTS section
8831         in <a href="git-mergetool.html">git-mergetool(1)</a>.
8832         for details.
8833 </p>
8834 </dd>
8835 <dt class="hdlist1">
8836 mergetool.hideResolved
8837 </dt>
8838 <dd>
8839 <p>
8840         During a merge, Git will automatically resolve as many conflicts as
8841         possible and write the <em>MERGED</em> file containing conflict markers around
8842         any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
8843         represent the versions of the file from before Git&#8217;s conflict
8844         resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
8845         that only the unresolved conflicts are presented to the merge tool. Can
8846         be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
8847         configuration variable. Defaults to <code>false</code>.
8848 </p>
8849 </dd>
8850 <dt class="hdlist1">
8851 mergetool.keepBackup
8852 </dt>
8853 <dd>
8854 <p>
8855         After performing a merge, the original file with conflict markers
8856         can be saved as a file with a <code>.orig</code> extension.  If this variable
8857         is set to <code>false</code> then this file is not preserved.  Defaults to
8858         <code>true</code> (i.e. keep the backup files).
8859 </p>
8860 </dd>
8861 <dt class="hdlist1">
8862 mergetool.keepTemporaries
8863 </dt>
8864 <dd>
8865 <p>
8866         When invoking a custom merge tool, Git uses a set of temporary
8867         files to pass to the tool. If the tool returns an error and this
8868         variable is set to <code>true</code>, then these temporary files will be
8869         preserved; otherwise, they will be removed after the tool has
8870         exited. Defaults to <code>false</code>.
8871 </p>
8872 </dd>
8873 <dt class="hdlist1">
8874 mergetool.writeToTemp
8875 </dt>
8876 <dd>
8877 <p>
8878         Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
8879         conflicting files in the worktree by default.  Git will attempt
8880         to use a temporary directory for these files when set <code>true</code>.
8881         Defaults to <code>false</code>.
8882 </p>
8883 </dd>
8884 <dt class="hdlist1">
8885 mergetool.prompt
8886 </dt>
8887 <dd>
8888 <p>
8889         Prompt before each invocation of the merge resolution program.
8890 </p>
8891 </dd>
8892 <dt class="hdlist1">
8893 mergetool.guiDefault
8894 </dt>
8895 <dd>
8896 <p>
8897         Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
8898         specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
8899         or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
8900         variable value. The default is <code>false</code>, where the <code>--gui</code> argument
8901         must be provided explicitly for the <code>merge.guitool</code> to be used.
8902 </p>
8903 </dd>
8904 <dt class="hdlist1">
8905 notes.mergeStrategy
8906 </dt>
8907 <dd>
8908 <p>
8909         Which merge strategy to choose by default when resolving notes
8910         conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
8911         <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
8912         section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
8913 </p>
8914 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
8915 <a href="git-notes.html">git-notes(1)</a>.</p></div>
8916 </dd>
8917 <dt class="hdlist1">
8918 notes.&lt;name&gt;.mergeStrategy
8919 </dt>
8920 <dd>
8921 <p>
8922         Which merge strategy to choose when doing a notes merge into
8923         refs/notes/&lt;name&gt;.  This overrides the more general
8924         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
8925         <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
8926 </p>
8927 </dd>
8928 <dt class="hdlist1">
8929 notes.displayRef
8930 </dt>
8931 <dd>
8932 <p>
8933         Which ref (or refs, if a glob or specified more than once), in
8934         addition to the default set by <code>core.notesRef</code> or
8935         <code>GIT_NOTES_REF</code>, to read notes from when showing commit
8936         messages with the <em>git log</em> family of commands.
8937 </p>
8938 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
8939 environment variable, which must be a colon separated list of refs or
8940 globs.</p></div>
8941 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
8942 but a glob that does not match any refs is silently ignored.</p></div>
8943 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
8944 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
8945 those commands.</p></div>
8946 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
8947 GIT_NOTES_REF) is also implicitly added to the list of refs to be
8948 displayed.</p></div>
8949 </dd>
8950 <dt class="hdlist1">
8951 notes.rewrite.&lt;command&gt;
8952 </dt>
8953 <dd>
8954 <p>
8955         When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
8956         <code>rebase</code>), if this variable is <code>false</code>, git will not copy
8957         notes from the original to the rewritten commit.  Defaults to
8958         <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.
8959 </p>
8960 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
8961 environment variable, which must be a colon separated list of refs or
8962 globs.</p></div>
8963 </dd>
8964 <dt class="hdlist1">
8965 notes.rewriteMode
8966 </dt>
8967 <dd>
8968 <p>
8969         When copying notes during a rewrite (see the
8970         "notes.rewrite.&lt;command&gt;" option), determines what to do if
8971         the target commit already has a note.  Must be one of
8972         <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
8973         Defaults to <code>concatenate</code>.
8974 </p>
8975 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
8976 environment variable.</p></div>
8977 </dd>
8978 <dt class="hdlist1">
8979 notes.rewriteRef
8980 </dt>
8981 <dd>
8982 <p>
8983         When copying notes during a rewrite, specifies the (fully
8984         qualified) ref whose notes should be copied.  May be a glob,
8985         in which case notes in all matching refs will be copied.  You
8986         may also specify this configuration several times.
8987 </p>
8988 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
8989 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
8990 rewriting for the default commit notes.</p></div>
8991 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
8992 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
8993 </dd>
8994 <dt class="hdlist1">
8995 pack.window
8996 </dt>
8997 <dd>
8998 <p>
8999         The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9000         window size is given on the command line. Defaults to 10.
9001 </p>
9002 </dd>
9003 <dt class="hdlist1">
9004 pack.depth
9005 </dt>
9006 <dd>
9007 <p>
9008         The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
9009         maximum depth is given on the command line. Defaults to 50.
9010         Maximum value is 4095.
9011 </p>
9012 </dd>
9013 <dt class="hdlist1">
9014 pack.windowMemory
9015 </dt>
9016 <dd>
9017 <p>
9018         The maximum size of memory that is consumed by each thread
9019         in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
9020         no limit is given on the command line.  The value can be
9021         suffixed with "k", "m", or "g".  When left unconfigured (or
9022         set explicitly to 0), there will be no limit.
9023 </p>
9024 </dd>
9025 <dt class="hdlist1">
9026 pack.compression
9027 </dt>
9028 <dd>
9029 <p>
9030         An integer -1..9, indicating the compression level for objects
9031         in a pack file. -1 is the zlib default. 0 means no
9032         compression, and 1..9 are various speed/size tradeoffs, 9 being
9033         slowest.  If not set,  defaults to core.compression.  If that is
9034         not set,  defaults to -1, the zlib default, which is "a default
9035         compromise between speed and compression (currently equivalent
9036         to level 6)."
9037 </p>
9038 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
9039 all existing objects. You can force recompression by passing the -F option
9040 to <a href="git-repack.html">git-repack(1)</a>.</p></div>
9041 </dd>
9042 <dt class="hdlist1">
9043 pack.allowPackReuse
9044 </dt>
9045 <dd>
9046 <p>
9047         When true or "single", and when reachability bitmaps are
9048         enabled, pack-objects will try to send parts of the bitmapped
9049         packfile verbatim. When "multi", and when a multi-pack
9050         reachability bitmap is available, pack-objects will try to send
9051         parts of all packs in the MIDX.
9052 </p>
9053 <div class="literalblock">
9054 <div class="content">
9055 <pre><code>If only a single pack bitmap is available, and
9056 `pack.allowPackReuse` is set to "multi", reuse parts of just the
9057 bitmapped packfile. This can reduce memory and CPU usage to
9058 serve fetches, but might result in sending a slightly larger
9059 pack. Defaults to true.</code></pre>
9060 </div></div>
9061 </dd>
9062 <dt class="hdlist1">
9063 pack.island
9064 </dt>
9065 <dd>
9066 <p>
9067         An extended regular expression configuring a set of delta
9068         islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
9069         for details.
9070 </p>
9071 </dd>
9072 <dt class="hdlist1">
9073 pack.islandCore
9074 </dt>
9075 <dd>
9076 <p>
9077         Specify an island name which gets to have its objects be
9078         packed first. This creates a kind of pseudo-pack at the front
9079         of one pack, so that the objects from the specified island are
9080         hopefully faster to copy into any pack that should be served
9081         to a user requesting these objects. In practice this means
9082         that the island specified should likely correspond to what is
9083         the most commonly cloned in the repo. See also "DELTA ISLANDS"
9084         in <a href="git-pack-objects.html">git-pack-objects(1)</a>.
9085 </p>
9086 </dd>
9087 <dt class="hdlist1">
9088 pack.deltaCacheSize
9089 </dt>
9090 <dd>
9091 <p>
9092         The maximum memory in bytes used for caching deltas in
9093         <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
9094         This cache is used to speed up the writing object phase by not
9095         having to recompute the final delta result once the best match
9096         for all objects is found.  Repacking large repositories on machines
9097         which are tight with memory might be badly impacted by this though,
9098         especially if this cache pushes the system into swapping.
9099         A value of 0 means no limit. The smallest size of 1 byte may be
9100         used to virtually disable this cache. Defaults to 256 MiB.
9101 </p>
9102 </dd>
9103 <dt class="hdlist1">
9104 pack.deltaCacheLimit
9105 </dt>
9106 <dd>
9107 <p>
9108         The maximum size of a delta, that is cached in
9109         <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
9110         writing object phase by not having to recompute the final delta
9111         result once the best match for all objects is found.
9112         Defaults to 1000. Maximum value is 65535.
9113 </p>
9114 </dd>
9115 <dt class="hdlist1">
9116 pack.threads
9117 </dt>
9118 <dd>
9119 <p>
9120         Specifies the number of threads to spawn when searching for best
9121         delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
9122         be compiled with pthreads otherwise this option is ignored with a
9123         warning. This is meant to reduce packing time on multiprocessor
9124         machines. The required amount of memory for the delta search window
9125         is however multiplied by the number of threads.
9126         Specifying 0 will cause Git to auto-detect the number of CPUs
9127         and set the number of threads accordingly.
9128 </p>
9129 </dd>
9130 <dt class="hdlist1">
9131 pack.indexVersion
9132 </dt>
9133 <dd>
9134 <p>
9135         Specify the default pack index version.  Valid values are 1 for
9136         legacy pack index used by Git versions prior to 1.5.2, and 2 for
9137         the new pack index with capabilities for packs larger than 4 GB
9138         as well as proper protection against the repacking of corrupted
9139         packs.  Version 2 is the default.  Note that version 2 is enforced
9140         and this config option is ignored whenever the corresponding pack is
9141         larger than 2 GB.
9142 </p>
9143 <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9144 cloning or fetching over a non-native protocol (e.g. "http")
9145 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9146 other side may give you a repository that cannot be accessed with your
9147 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9148 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
9149 the <code>*.idx</code> file.</p></div>
9150 </dd>
9151 <dt class="hdlist1">
9152 pack.packSizeLimit
9153 </dt>
9154 <dd>
9155 <p>
9156         The maximum size of a pack.  This setting only affects
9157         packing to a file when repacking, i.e. the git:// protocol
9158         is unaffected.  It can be overridden by the <code>--max-pack-size</code>
9159         option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
9160         in the creation of multiple packfiles.
9161 </p>
9162 <div class="paragraph"><p>Note that this option is rarely useful, and may result in a larger total
9163 on-disk size (because Git will not store deltas between packs) and
9164 worse runtime performance (object lookup within multiple packs is
9165 slower than a single pack, and optimizations like reachability bitmaps
9166 cannot cope with multiple packs).</p></div>
9167 <div class="paragraph"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9168 filesystem does not support large files), this option may help. But if
9169 your goal is to transmit a packfile over a medium that supports limited
9170 sizes (e.g., removable media that cannot store the whole repository),
9171 you are likely better off creating a single large packfile and splitting
9172 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9173 <div class="paragraph"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9174 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9175 </dd>
9176 <dt class="hdlist1">
9177 pack.useBitmaps
9178 </dt>
9179 <dd>
9180 <p>
9181         When true, git will use pack bitmaps (if available) when packing
9182         to stdout (e.g., during the server side of a fetch). Defaults to
9183         true. You should not generally need to turn this off unless
9184         you are debugging pack bitmaps.
9185 </p>
9186 </dd>
9187 <dt class="hdlist1">
9188 pack.useBitmapBoundaryTraversal
9189 </dt>
9190 <dd>
9191 <p>
9192         When true, Git will use an experimental algorithm for computing
9193         reachability queries with bitmaps. Instead of building up
9194         complete bitmaps for all of the negated tips and then OR-ing
9195         them together, consider negated tips with existing bitmaps as
9196         additive (i.e. OR-ing them into the result if they exist,
9197         ignoring them otherwise), and build up a bitmap at the boundary
9198         instead.
9199 </p>
9200 <div class="paragraph"><p>When using this algorithm, Git may include too many objects as a result
9201 of not opening up trees belonging to certain UNINTERESTING commits. This
9202 inexactness matches the non-bitmap traversal algorithm.</p></div>
9203 <div class="paragraph"><p>In many cases, this can provide a speed-up over the exact algorithm,
9204 particularly when there is poor bitmap coverage of the negated side of
9205 the query.</p></div>
9206 </dd>
9207 <dt class="hdlist1">
9208 pack.useSparse
9209 </dt>
9210 <dd>
9211 <p>
9212         When true, git will default to using the <em>--sparse</em> option in
9213         <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9214         algorithm only walks trees that appear in paths that introduce new
9215         objects. This can have significant performance benefits when
9216         computing a pack to send a small change. However, it is possible
9217         that extra objects are added to the pack-file if the included
9218         commits contain certain types of direct renames. Default is
9219         <code>true</code>.
9220 </p>
9221 </dd>
9222 <dt class="hdlist1">
9223 pack.preferBitmapTips
9224 </dt>
9225 <dd>
9226 <p>
9227         When selecting which commits will receive bitmaps, prefer a
9228         commit at the tip of any reference that is a suffix of any value
9229         of this configuration over any other commits in the "selection
9230         window".
9231 </p>
9232 <div class="paragraph"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9233 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9234 necessarily be selected. This is because commits are selected for
9235 bitmaps from within a series of windows of variable length.</p></div>
9236 <div class="paragraph"><p>If a commit at the tip of any reference which is a suffix of any value
9237 of this configuration is seen in a window, it is immediately given
9238 preference over any other commit in that window.</p></div>
9239 </dd>
9240 <dt class="hdlist1">
9241 pack.writeBitmaps (deprecated)
9242 </dt>
9243 <dd>
9244 <p>
9245         This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9246 </p>
9247 </dd>
9248 <dt class="hdlist1">
9249 pack.writeBitmapHashCache
9250 </dt>
9251 <dd>
9252 <p>
9253         When true, git will include a "hash cache" section in the bitmap
9254         index (if one is written). This cache can be used to feed git&#8217;s
9255         delta heuristics, potentially leading to better deltas between
9256         bitmapped and non-bitmapped objects (e.g., when serving a fetch
9257         between an older, bitmapped pack and objects that have been
9258         pushed since the last gc). The downside is that it consumes 4
9259         bytes per object of disk space. Defaults to true.
9260 </p>
9261 <div class="paragraph"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9262 computed; instead, any namehashes stored in an existing bitmap are
9263 permuted into their appropriate location when writing a new bitmap.</p></div>
9264 </dd>
9265 <dt class="hdlist1">
9266 pack.writeBitmapLookupTable
9267 </dt>
9268 <dd>
9269 <p>
9270         When true, Git will include a "lookup table" section in the
9271         bitmap index (if one is written). This table is used to defer
9272         loading individual bitmaps as late as possible. This can be
9273         beneficial in repositories that have relatively large bitmap
9274         indexes. Defaults to false.
9275 </p>
9276 </dd>
9277 <dt class="hdlist1">
9278 pack.readReverseIndex
9279 </dt>
9280 <dd>
9281 <p>
9282         When true, git will read any .rev file(s) that may be available
9283         (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
9284         will be generated from scratch and stored in memory. Defaults to
9285         true.
9286 </p>
9287 </dd>
9288 <dt class="hdlist1">
9289 pack.writeReverseIndex
9290 </dt>
9291 <dd>
9292 <p>
9293         When true, git will write a corresponding .rev file (see:
9294         <a href="gitformat-pack.html">gitformat-pack(5)</a>)
9295         for each new packfile that it writes in all places except for
9296         <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
9297         Defaults to true.
9298 </p>
9299 </dd>
9300 <dt class="hdlist1">
9301 pager.&lt;cmd&gt;
9302 </dt>
9303 <dd>
9304 <p>
9305         If the value is boolean, turns on or off pagination of the
9306         output of a particular Git subcommand when writing to a tty.
9307         Otherwise, turns on pagination for the subcommand using the
9308         pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
9309         or <code>--no-pager</code> is specified on the command line, it takes
9310         precedence over this option.  To disable pagination for all
9311         commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9312 </p>
9313 </dd>
9314 <dt class="hdlist1">
9315 pretty.&lt;name&gt;
9316 </dt>
9317 <dd>
9318 <p>
9319         Alias for a --pretty= format string, as specified in
9320         <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
9321         as the built-in pretty formats could. For example,
9322         running <code>git config pretty.changelog "format:* %H %s"</code>
9323         would cause the invocation <code>git log --pretty=changelog</code>
9324         to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
9325         Note that an alias with the same name as a built-in format
9326         will be silently ignored.
9327 </p>
9328 </dd>
9329 <dt class="hdlist1">
9330 protocol.allow
9331 </dt>
9332 <dd>
9333 <p>
9334         If set, provide a user defined default policy for all protocols which
9335         don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
9336         if unset, known-safe protocols (http, https, git, ssh) have a
9337         default policy of <code>always</code>, known-dangerous protocols (ext) have a
9338         default policy of <code>never</code>, and all other protocols (including file)
9339         have a default policy of <code>user</code>.  Supported policies:
9340 </p>
9341 <div class="openblock">
9342 <div class="content">
9343 <div class="ulist"><ul>
9344 <li>
9345 <p>
9346 <code>always</code> - protocol is always able to be used.
9347 </p>
9348 </li>
9349 <li>
9350 <p>
9351 <code>never</code> - protocol is never able to be used.
9352 </p>
9353 </li>
9354 <li>
9355 <p>
9356 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9357   either unset or has a value of 1.  This policy should be used when you want a
9358   protocol to be directly usable by the user but don&#8217;t want it used by commands which
9359   execute clone/fetch/push commands without user input, e.g. recursive
9360   submodule initialization.
9361 </p>
9362 </li>
9363 </ul></div>
9364 </div></div>
9365 </dd>
9366 <dt class="hdlist1">
9367 protocol.&lt;name&gt;.allow
9368 </dt>
9369 <dd>
9370 <p>
9371         Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
9372         commands. See <code>protocol.allow</code> above for the available policies.
9373 </p>
9374 <div class="paragraph"><p>The protocol names currently used by git are:</p></div>
9375 <div class="openblock">
9376 <div class="content">
9377 <div class="ulist"><ul>
9378 <li>
9379 <p>
9380 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9381     or local paths)
9382 </p>
9383 </li>
9384 <li>
9385 <p>
9386 <code>git</code>: the anonymous git protocol over a direct TCP
9387     connection (or proxy, if configured)
9388 </p>
9389 </li>
9390 <li>
9391 <p>
9392 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9393     <code>ssh://</code>, etc).
9394 </p>
9395 </li>
9396 <li>
9397 <p>
9398 <code>http</code>: git over http, both "smart http" and "dumb http".
9399     Note that this does <em>not</em> include <code>https</code>; if you want to configure
9400     both, you must do so individually.
9401 </p>
9402 </li>
9403 <li>
9404 <p>
9405 any external helpers are named by their protocol (e.g., use
9406     <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9407 </p>
9408 </li>
9409 </ul></div>
9410 </div></div>
9411 </dd>
9412 <dt class="hdlist1">
9413 protocol.version
9414 </dt>
9415 <dd>
9416 <p>
9417         If set, clients will attempt to communicate with a server
9418         using the specified protocol version.  If the server does
9419         not support it, communication falls back to version 0.
9420         If unset, the default is <code>2</code>.
9421         Supported versions:
9422 </p>
9423 <div class="openblock">
9424 <div class="content">
9425 <div class="ulist"><ul>
9426 <li>
9427 <p>
9428 <code>0</code> - the original wire protocol.
9429 </p>
9430 </li>
9431 <li>
9432 <p>
9433 <code>1</code> - the original wire protocol with the addition of a version string
9434   in the initial response from the server.
9435 </p>
9436 </li>
9437 <li>
9438 <p>
9439 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.
9440 </p>
9441 </li>
9442 </ul></div>
9443 </div></div>
9444 </dd>
9445 <dt class="hdlist1">
9446 pull.ff
9447 </dt>
9448 <dd>
9449 <p>
9450         By default, Git does not create an extra merge commit when merging
9451         a commit that is a descendant of the current commit. Instead, the
9452         tip of the current branch is fast-forwarded. When set to <code>false</code>,
9453         this variable tells Git to create an extra merge commit in such
9454         a case (equivalent to giving the <code>--no-ff</code> option from the command
9455         line). When set to <code>only</code>, only such fast-forward merges are
9456         allowed (equivalent to giving the <code>--ff-only</code> option from the
9457         command line). This setting overrides <code>merge.ff</code> when pulling.
9458 </p>
9459 </dd>
9460 <dt class="hdlist1">
9461 pull.rebase
9462 </dt>
9463 <dd>
9464 <p>
9465         When true, rebase branches on top of the fetched branch, instead
9466         of merging the default branch from the default remote when "git
9467         pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
9468         per-branch basis.
9469 </p>
9470 <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>
9471 so that the local merge commits are included in the rebase (see
9472 <a href="git-rebase.html">git-rebase(1)</a> for details).</p></div>
9473 <div class="paragraph"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9474 mode.</p></div>
9475 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9476 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
9477 for details).</p></div>
9478 </dd>
9479 <dt class="hdlist1">
9480 pull.octopus
9481 </dt>
9482 <dd>
9483 <p>
9484         The default merge strategy to use when pulling multiple branches
9485         at once.
9486 </p>
9487 </dd>
9488 <dt class="hdlist1">
9489 pull.twohead
9490 </dt>
9491 <dd>
9492 <p>
9493         The default merge strategy to use when pulling a single branch.
9494 </p>
9495 </dd>
9496 <dt class="hdlist1">
9497 push.autoSetupRemote
9498 </dt>
9499 <dd>
9500 <p>
9501         If set to "true" assume <code>--set-upstream</code> on default push when no
9502         upstream tracking exists for the current branch; this option
9503         takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9504         and <em>current</em>. It is useful if by default you want new branches
9505         to be pushed to the default remote (like the behavior of
9506         <em>push.default=current</em>) and you also want the upstream tracking
9507         to be set. Workflows most likely to benefit from this option are
9508         <em>simple</em> central workflows where all branches are expected to
9509         have the same name on the remote.
9510 </p>
9511 </dd>
9512 <dt class="hdlist1">
9513 push.default
9514 </dt>
9515 <dd>
9516 <p>
9517         Defines the action <code>git push</code> should take if no refspec is
9518         given (whether from the command-line, config, or elsewhere).
9519         Different values are well-suited for
9520         specific workflows; for instance, in a purely central workflow
9521         (i.e. the fetch source is equal to the push destination),
9522         <code>upstream</code> is probably what you want.  Possible values are:
9523 </p>
9524 <div class="openblock">
9525 <div class="content">
9526 <div class="ulist"><ul>
9527 <li>
9528 <p>
9529 <code>nothing</code> - do not push anything (error out) unless a refspec is
9530   given. This is primarily meant for people who want to
9531   avoid mistakes by always being explicit.
9532 </p>
9533 </li>
9534 <li>
9535 <p>
9536 <code>current</code> - push the current branch to update a branch with the same
9537   name on the receiving end.  Works in both central and non-central
9538   workflows.
9539 </p>
9540 </li>
9541 <li>
9542 <p>
9543 <code>upstream</code> - push the current branch back to the branch whose
9544   changes are usually integrated into the current branch (which is
9545   called <code>@{upstream}</code>).  This mode only makes sense if you are
9546   pushing to the same repository you would normally pull from
9547   (i.e. central workflow).
9548 </p>
9549 </li>
9550 <li>
9551 <p>
9552 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
9553 </p>
9554 </li>
9555 <li>
9556 <p>
9557 <code>simple</code> - push the current branch with the same name on the remote.
9558 </p>
9559 <div class="paragraph"><p>If you are working on a centralized workflow (pushing to the same repository you
9560 pull from, which is typically <code>origin</code>), then you need to configure an upstream
9561 branch with the same name.</p></div>
9562 <div class="paragraph"><p>This mode is the default since Git 2.0, and is the safest option suited for
9563 beginners.</p></div>
9564 </li>
9565 <li>
9566 <p>
9567 <code>matching</code> - push all branches having the same name on both ends.
9568   This makes the repository you are pushing to remember the set of
9569   branches that will be pushed out (e.g. if you always push <em>maint</em>
9570   and <em>master</em> there and no other branches, the repository you push
9571   to will have these two branches, and your local <em>maint</em> and
9572   <em>master</em> will be pushed there).
9573 </p>
9574 <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
9575 branches you would push out are ready to be pushed out before
9576 running <em>git push</em>, as the whole point of this mode is to allow you
9577 to push all of the branches in one go.  If you usually finish work
9578 on only one branch and push out the result, while other branches are
9579 unfinished, this mode is not for you.  Also this mode is not
9580 suitable for pushing into a shared central repository, as other
9581 people may add new branches there, or update the tip of existing
9582 branches outside your control.</p></div>
9583 <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
9584 new default).</p></div>
9585 </li>
9586 </ul></div>
9587 </div></div>
9588 </dd>
9589 <dt class="hdlist1">
9590 push.followTags
9591 </dt>
9592 <dd>
9593 <p>
9594         If set to true, enable <code>--follow-tags</code> option by default.  You
9595         may override this configuration at time of push by specifying
9596         <code>--no-follow-tags</code>.
9597 </p>
9598 </dd>
9599 <dt class="hdlist1">
9600 push.gpgSign
9601 </dt>
9602 <dd>
9603 <p>
9604         May be set to a boolean value, or the string <em>if-asked</em>. A true
9605         value causes all pushes to be GPG signed, as if <code>--signed</code> is
9606         passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
9607         pushes to be signed if the server supports it, as if
9608         <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
9609         override a value from a lower-priority config file. An explicit
9610         command-line flag always overrides this config option.
9611 </p>
9612 </dd>
9613 <dt class="hdlist1">
9614 push.pushOption
9615 </dt>
9616 <dd>
9617 <p>
9618         When no <code>--push-option=&lt;option&gt;</code> argument is given from the
9619         command line, <code>git push</code> behaves as if each &lt;value&gt; of
9620         this variable is given as <code>--push-option=&lt;value&gt;</code>.
9621 </p>
9622 <div class="paragraph"><p>This is a multi-valued variable, and an empty value can be used in a
9623 higher priority configuration file (e.g. <code>.git/config</code> in a
9624 repository) to clear the values inherited from a lower priority
9625 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
9626 <div class="listingblock">
9627 <div class="content">
9628 <pre><code>Example:
9629
9630 /etc/gitconfig
9631   push.pushoption = a
9632   push.pushoption = b
9633
9634 ~/.gitconfig
9635   push.pushoption = c
9636
9637 repo/.git/config
9638   push.pushoption =
9639   push.pushoption = b
9640
9641 This will result in only b (a and c are cleared).</code></pre>
9642 </div></div>
9643 </dd>
9644 <dt class="hdlist1">
9645 push.recurseSubmodules
9646 </dt>
9647 <dd>
9648 <p>
9649         May be "check", "on-demand", "only", or "no", with the same behavior
9650         as that of "push --recurse-submodules".
9651         If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
9652         set (in which case a <em>true</em> value means <em>on-demand</em>).
9653 </p>
9654 </dd>
9655 <dt class="hdlist1">
9656 push.useForceIfIncludes
9657 </dt>
9658 <dd>
9659 <p>
9660         If set to "true", it is equivalent to specifying
9661         <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
9662         in the command line. Adding <code>--no-force-if-includes</code> at the
9663         time of push overrides this configuration setting.
9664 </p>
9665 </dd>
9666 <dt class="hdlist1">
9667 push.negotiate
9668 </dt>
9669 <dd>
9670 <p>
9671         If set to "true", attempt to reduce the size of the packfile
9672         sent by rounds of negotiation in which the client and the
9673         server attempt to find commits in common. If "false", Git will
9674         rely solely on the server&#8217;s ref advertisement to find commits
9675         in common.
9676 </p>
9677 </dd>
9678 <dt class="hdlist1">
9679 push.useBitmaps
9680 </dt>
9681 <dd>
9682 <p>
9683         If set to "false", disable use of bitmaps for "git push" even if
9684         <code>pack.useBitmaps</code> is "true", without preventing other git operations
9685         from using bitmaps. Default is true.
9686 </p>
9687 </dd>
9688 <dt class="hdlist1">
9689 rebase.backend
9690 </dt>
9691 <dd>
9692 <p>
9693         Default backend to use for rebasing.  Possible choices are
9694         <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
9695         all remaining capabilities of the apply backend, this setting
9696         may become unused.
9697 </p>
9698 </dd>
9699 <dt class="hdlist1">
9700 rebase.stat
9701 </dt>
9702 <dd>
9703 <p>
9704         Whether to show a diffstat of what changed upstream since the last
9705         rebase. False by default.
9706 </p>
9707 </dd>
9708 <dt class="hdlist1">
9709 rebase.autoSquash
9710 </dt>
9711 <dd>
9712 <p>
9713         If set to true, enable the <code>--autosquash</code> option of
9714         <a href="git-rebase.html">git-rebase(1)</a> by default for interactive mode.
9715         This can be overridden with the <code>--no-autosquash</code> option.
9716 </p>
9717 </dd>
9718 <dt class="hdlist1">
9719 rebase.autoStash
9720 </dt>
9721 <dd>
9722 <p>
9723         When set to true, automatically create a temporary stash entry
9724         before the operation begins, and apply it after the operation
9725         ends.  This means that you can run rebase on a dirty worktree.
9726         However, use with care: the final stash application after a
9727         successful rebase might result in non-trivial conflicts.
9728         This option can be overridden by the <code>--no-autostash</code> and
9729         <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
9730         Defaults to false.
9731 </p>
9732 </dd>
9733 <dt class="hdlist1">
9734 rebase.updateRefs
9735 </dt>
9736 <dd>
9737 <p>
9738         If set to true enable <code>--update-refs</code> option by default.
9739 </p>
9740 </dd>
9741 <dt class="hdlist1">
9742 rebase.missingCommitsCheck
9743 </dt>
9744 <dd>
9745 <p>
9746         If set to "warn", git rebase -i will print a warning if some
9747         commits are removed (e.g. a line was deleted), however the
9748         rebase will still proceed. If set to "error", it will print
9749         the previous warning and stop the rebase, <em>git rebase
9750         --edit-todo</em> can then be used to correct the error. If set to
9751         "ignore", no checking is done.
9752         To drop a commit without warning or error, use the <code>drop</code>
9753         command in the todo list.
9754         Defaults to "ignore".
9755 </p>
9756 </dd>
9757 <dt class="hdlist1">
9758 rebase.instructionFormat
9759 </dt>
9760 <dd>
9761 <p>
9762         A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
9763         todo list during an interactive rebase.  The format will
9764         automatically have the commit hash prepended to the format.
9765 </p>
9766 </dd>
9767 <dt class="hdlist1">
9768 rebase.abbreviateCommands
9769 </dt>
9770 <dd>
9771 <p>
9772         If set to true, <code>git rebase</code> will use abbreviated command names in the
9773         todo list resulting in something like this:
9774 </p>
9775 <div class="listingblock">
9776 <div class="content">
9777 <pre><code>        p deadbee The oneline of the commit
9778         p fa1afe1 The oneline of the next commit
9779         ...</code></pre>
9780 </div></div>
9781 <div class="paragraph"><p>instead of:</p></div>
9782 <div class="listingblock">
9783 <div class="content">
9784 <pre><code>        pick deadbee The oneline of the commit
9785         pick fa1afe1 The oneline of the next commit
9786         ...</code></pre>
9787 </div></div>
9788 <div class="paragraph"><p>Defaults to false.</p></div>
9789 </dd>
9790 <dt class="hdlist1">
9791 rebase.rescheduleFailedExec
9792 </dt>
9793 <dd>
9794 <p>
9795         Automatically reschedule <code>exec</code> commands that failed. This only makes
9796         sense in interactive mode (or when an <code>--exec</code> option was provided).
9797         This is the same as specifying the <code>--reschedule-failed-exec</code> option.
9798 </p>
9799 </dd>
9800 <dt class="hdlist1">
9801 rebase.forkPoint
9802 </dt>
9803 <dd>
9804 <p>
9805         If set to false set <code>--no-fork-point</code> option by default.
9806 </p>
9807 </dd>
9808 <dt class="hdlist1">
9809 rebase.rebaseMerges
9810 </dt>
9811 <dd>
9812 <p>
9813         Whether and how to set the <code>--rebase-merges</code> option by default. Can
9814         be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
9815         true or to <code>no-rebase-cousins</code> is equivalent to
9816         <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
9817         equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
9818         equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
9819         command line, with or without an argument, overrides any
9820         <code>rebase.rebaseMerges</code> configuration.
9821 </p>
9822 </dd>
9823 <dt class="hdlist1">
9824 rebase.maxLabelLength
9825 </dt>
9826 <dd>
9827 <p>
9828         When generating label names from commit subjects, truncate the names to
9829         this length. By default, the names are truncated to a little less than
9830         <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
9831         corresponding loose refs).
9832 </p>
9833 </dd>
9834 <dt class="hdlist1">
9835 receive.advertiseAtomic
9836 </dt>
9837 <dd>
9838 <p>
9839         By default, git-receive-pack will advertise the atomic push
9840         capability to its clients. If you don&#8217;t want to advertise this
9841         capability, set this variable to false.
9842 </p>
9843 </dd>
9844 <dt class="hdlist1">
9845 receive.advertisePushOptions
9846 </dt>
9847 <dd>
9848 <p>
9849         When set to true, git-receive-pack will advertise the push options
9850         capability to its clients. False by default.
9851 </p>
9852 </dd>
9853 <dt class="hdlist1">
9854 receive.autogc
9855 </dt>
9856 <dd>
9857 <p>
9858         By default, git-receive-pack will run "git-gc --auto" after
9859         receiving data from git-push and updating refs.  You can stop
9860         it by setting this variable to false.
9861 </p>
9862 </dd>
9863 <dt class="hdlist1">
9864 receive.certNonceSeed
9865 </dt>
9866 <dd>
9867 <p>
9868         By setting this variable to a string, <code>git receive-pack</code>
9869         will accept a <code>git push --signed</code> and verify it by using
9870         a "nonce" protected by HMAC using this string as a secret
9871         key.
9872 </p>
9873 </dd>
9874 <dt class="hdlist1">
9875 receive.certNonceSlop
9876 </dt>
9877 <dd>
9878 <p>
9879         When a <code>git push --signed</code> sends a push certificate with a
9880         "nonce" that was issued by a receive-pack serving the same
9881         repository within this many seconds, export the "nonce"
9882         found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
9883         hooks (instead of what the receive-pack asked the sending
9884         side to include).  This may allow writing checks in
9885         <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
9886         checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
9887         that records by how many seconds the nonce is stale to
9888         decide if they want to accept the certificate, they only
9889         can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
9890 </p>
9891 </dd>
9892 <dt class="hdlist1">
9893 receive.fsckObjects
9894 </dt>
9895 <dd>
9896 <p>
9897         If it is set to true, git-receive-pack will check all received
9898         objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
9899         Defaults to false. If not set, the value of
9900         <code>transfer.fsckObjects</code> is used instead.
9901 </p>
9902 </dd>
9903 <dt class="hdlist1">
9904 receive.fsck.&lt;msg-id&gt;
9905 </dt>
9906 <dd>
9907 <p>
9908         Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
9909         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
9910         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
9911         details.
9912 </p>
9913 </dd>
9914 <dt class="hdlist1">
9915 receive.fsck.skipList
9916 </dt>
9917 <dd>
9918 <p>
9919         Acts like <code>fsck.skipList</code>, but is used by
9920         <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
9921         <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
9922         details.
9923 </p>
9924 </dd>
9925 <dt class="hdlist1">
9926 receive.keepAlive
9927 </dt>
9928 <dd>
9929 <p>
9930         After receiving the pack from the client, <code>receive-pack</code> may
9931         produce no output (if <code>--quiet</code> was specified) while processing
9932         the pack, causing some networks to drop the TCP connection.
9933         With this option set, if <code>receive-pack</code> does not transmit
9934         any data in this phase for <code>receive.keepAlive</code> seconds, it will
9935         send a short keepalive packet.  The default is 5 seconds; set
9936         to 0 to disable keepalives entirely.
9937 </p>
9938 </dd>
9939 <dt class="hdlist1">
9940 receive.unpackLimit
9941 </dt>
9942 <dd>
9943 <p>
9944         If the number of objects received in a push is below this
9945         limit then the objects will be unpacked into loose object
9946         files. However if the number of received objects equals or
9947         exceeds this limit then the received pack will be stored as
9948         a pack, after adding any missing delta bases.  Storing the
9949         pack from a push can make the push operation complete faster,
9950         especially on slow filesystems.  If not set, the value of
9951         <code>transfer.unpackLimit</code> is used instead.
9952 </p>
9953 </dd>
9954 <dt class="hdlist1">
9955 receive.maxInputSize
9956 </dt>
9957 <dd>
9958 <p>
9959         If the size of the incoming pack stream is larger than this
9960         limit, then git-receive-pack will error out, instead of
9961         accepting the pack file. If not set or set to 0, then the size
9962         is unlimited.
9963 </p>
9964 </dd>
9965 <dt class="hdlist1">
9966 receive.denyDeletes
9967 </dt>
9968 <dd>
9969 <p>
9970         If set to true, git-receive-pack will deny a ref update that deletes
9971         the ref. Use this to prevent such a ref deletion via a push.
9972 </p>
9973 </dd>
9974 <dt class="hdlist1">
9975 receive.denyDeleteCurrent
9976 </dt>
9977 <dd>
9978 <p>
9979         If set to true, git-receive-pack will deny a ref update that
9980         deletes the currently checked out branch of a non-bare repository.
9981 </p>
9982 </dd>
9983 <dt class="hdlist1">
9984 receive.denyCurrentBranch
9985 </dt>
9986 <dd>
9987 <p>
9988         If set to true or "refuse", git-receive-pack will deny a ref update
9989         to the currently checked out branch of a non-bare repository.
9990         Such a push is potentially dangerous because it brings the HEAD
9991         out of sync with the index and working tree. If set to "warn",
9992         print a warning of such a push to stderr, but allow the push to
9993         proceed. If set to false or "ignore", allow such pushes with no
9994         message. Defaults to "refuse".
9995 </p>
9996 <div class="paragraph"><p>Another option is "updateInstead" which will update the working
9997 tree if pushing into the current branch.  This option is
9998 intended for synchronizing working directories when one side is not easily
9999 accessible via interactive ssh (e.g. a live web site, hence the requirement
10000 that the working directory be clean). This mode also comes in handy when
10001 developing inside a VM to test and fix code on different Operating Systems.</p></div>
10002 <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
10003 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
10004 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p></div>
10005 </dd>
10006 <dt class="hdlist1">
10007 receive.denyNonFastForwards
10008 </dt>
10009 <dd>
10010 <p>
10011         If set to true, git-receive-pack will deny a ref update which is
10012         not a fast-forward. Use this to prevent such an update via a push,
10013         even if that push is forced. This configuration variable is
10014         set when initializing a shared repository.
10015 </p>
10016 </dd>
10017 <dt class="hdlist1">
10018 receive.hideRefs
10019 </dt>
10020 <dd>
10021 <p>
10022         This variable is the same as <code>transfer.hideRefs</code>, but applies
10023         only to <code>receive-pack</code> (and so affects pushes, but not fetches).
10024         An attempt to update or delete a hidden ref by <code>git push</code> is
10025         rejected.
10026 </p>
10027 </dd>
10028 <dt class="hdlist1">
10029 receive.procReceiveRefs
10030 </dt>
10031 <dd>
10032 <p>
10033         This is a multi-valued variable that defines reference prefixes
10034         to match the commands in <code>receive-pack</code>.  Commands matching the
10035         prefixes will be executed by an external hook "proc-receive",
10036         instead of the internal <code>execute_commands</code> function.  If this
10037         variable is not defined, the "proc-receive" hook will never be
10038         used, and all commands will be executed by the internal
10039         <code>execute_commands</code> function.
10040 </p>
10041 <div class="paragraph"><p>For example, if this variable is set to "refs/for", pushing to reference
10042 such as "refs/for/master" will not create or update a reference named
10043 "refs/for/master", but may create or update a pull request directly by
10044 running the hook "proc-receive".</p></div>
10045 <div class="paragraph"><p>Optional modifiers can be provided in the beginning of the value to filter
10046 commands for specific actions: create (a), modify (m), delete (d).
10047 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
10048 E.g.:</p></div>
10049 <div class="literalblock">
10050 <div class="content">
10051 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
10052 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
10053 </div></div>
10054 </dd>
10055 <dt class="hdlist1">
10056 receive.updateServerInfo
10057 </dt>
10058 <dd>
10059 <p>
10060         If set to true, git-receive-pack will run git-update-server-info
10061         after receiving data from git-push and updating refs.
10062 </p>
10063 </dd>
10064 <dt class="hdlist1">
10065 receive.shallowUpdate
10066 </dt>
10067 <dd>
10068 <p>
10069         If set to true, .git/shallow can be updated when new refs
10070         require new shallow roots. Otherwise those refs are rejected.
10071 </p>
10072 </dd>
10073 <dt class="hdlist1">
10074 remote.pushDefault
10075 </dt>
10076 <dd>
10077 <p>
10078         The remote to push to by default.  Overrides
10079         <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
10080         <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
10081 </p>
10082 </dd>
10083 <dt class="hdlist1">
10084 remote.&lt;name&gt;.url
10085 </dt>
10086 <dd>
10087 <p>
10088         The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
10089         <a href="git-push.html">git-push(1)</a>.
10090 </p>
10091 </dd>
10092 <dt class="hdlist1">
10093 remote.&lt;name&gt;.pushurl
10094 </dt>
10095 <dd>
10096 <p>
10097         The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
10098 </p>
10099 </dd>
10100 <dt class="hdlist1">
10101 remote.&lt;name&gt;.proxy
10102 </dt>
10103 <dd>
10104 <p>
10105         For remotes that require curl (http, https and ftp), the URL to
10106         the proxy to use for that remote.  Set to the empty string to
10107         disable proxying for that remote.
10108 </p>
10109 </dd>
10110 <dt class="hdlist1">
10111 remote.&lt;name&gt;.proxyAuthMethod
10112 </dt>
10113 <dd>
10114 <p>
10115         For remotes that require curl (http, https and ftp), the method to use for
10116         authenticating against the proxy in use (probably set in
10117         <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
10118 </p>
10119 </dd>
10120 <dt class="hdlist1">
10121 remote.&lt;name&gt;.fetch
10122 </dt>
10123 <dd>
10124 <p>
10125         The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
10126         <a href="git-fetch.html">git-fetch(1)</a>.
10127 </p>
10128 </dd>
10129 <dt class="hdlist1">
10130 remote.&lt;name&gt;.push
10131 </dt>
10132 <dd>
10133 <p>
10134         The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
10135         <a href="git-push.html">git-push(1)</a>.
10136 </p>
10137 </dd>
10138 <dt class="hdlist1">
10139 remote.&lt;name&gt;.mirror
10140 </dt>
10141 <dd>
10142 <p>
10143         If true, pushing to this remote will automatically behave
10144         as if the <code>--mirror</code> option was given on the command line.
10145 </p>
10146 </dd>
10147 <dt class="hdlist1">
10148 remote.&lt;name&gt;.skipDefaultUpdate
10149 </dt>
10150 <dd>
10151 <p>
10152         If true, this remote will be skipped by default when updating
10153         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10154         <a href="git-remote.html">git-remote(1)</a>.
10155 </p>
10156 </dd>
10157 <dt class="hdlist1">
10158 remote.&lt;name&gt;.skipFetchAll
10159 </dt>
10160 <dd>
10161 <p>
10162         If true, this remote will be skipped by default when updating
10163         using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
10164         <a href="git-remote.html">git-remote(1)</a>.
10165 </p>
10166 </dd>
10167 <dt class="hdlist1">
10168 remote.&lt;name&gt;.receivepack
10169 </dt>
10170 <dd>
10171 <p>
10172         The default program to execute on the remote side when pushing.  See
10173         option --receive-pack of <a href="git-push.html">git-push(1)</a>.
10174 </p>
10175 </dd>
10176 <dt class="hdlist1">
10177 remote.&lt;name&gt;.uploadpack
10178 </dt>
10179 <dd>
10180 <p>
10181         The default program to execute on the remote side when fetching.  See
10182         option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
10183 </p>
10184 </dd>
10185 <dt class="hdlist1">
10186 remote.&lt;name&gt;.tagOpt
10187 </dt>
10188 <dd>
10189 <p>
10190         Setting this value to --no-tags disables automatic tag following when
10191         fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
10192         tag from remote &lt;name&gt;, even if they are not reachable from remote
10193         branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
10194         override this setting. See options --tags and --no-tags of
10195         <a href="git-fetch.html">git-fetch(1)</a>.
10196 </p>
10197 </dd>
10198 <dt class="hdlist1">
10199 remote.&lt;name&gt;.vcs
10200 </dt>
10201 <dd>
10202 <p>
10203         Setting this to a value &lt;vcs&gt; will cause Git to interact with
10204         the remote with the git-remote-&lt;vcs&gt; helper.
10205 </p>
10206 </dd>
10207 <dt class="hdlist1">
10208 remote.&lt;name&gt;.prune
10209 </dt>
10210 <dd>
10211 <p>
10212         When set to true, fetching from this remote by default will also
10213         remove any remote-tracking references that no longer exist on the
10214         remote (as if the <code>--prune</code> option was given on the command line).
10215         Overrides <code>fetch.prune</code> settings, if any.
10216 </p>
10217 </dd>
10218 <dt class="hdlist1">
10219 remote.&lt;name&gt;.pruneTags
10220 </dt>
10221 <dd>
10222 <p>
10223         When set to true, fetching from this remote by default will also
10224         remove any local tags that no longer exist on the remote if pruning
10225         is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
10226         <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10227 </p>
10228 <div class="paragraph"><p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
10229 <a href="git-fetch.html">git-fetch(1)</a>.</p></div>
10230 </dd>
10231 <dt class="hdlist1">
10232 remote.&lt;name&gt;.promisor
10233 </dt>
10234 <dd>
10235 <p>
10236         When set to true, this remote will be used to fetch promisor
10237         objects.
10238 </p>
10239 </dd>
10240 <dt class="hdlist1">
10241 remote.&lt;name&gt;.partialclonefilter
10242 </dt>
10243 <dd>
10244 <p>
10245         The filter that will be applied when fetching from this promisor remote.
10246         Changing or clearing this value will only affect fetches for new commits.
10247         To fetch associated objects for commits already present in the local object
10248         database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.
10249 </p>
10250 </dd>
10251 <dt class="hdlist1">
10252 remotes.&lt;group&gt;
10253 </dt>
10254 <dd>
10255 <p>
10256         The list of remotes which are fetched by "git remote update
10257         &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.
10258 </p>
10259 </dd>
10260 <dt class="hdlist1">
10261 repack.useDeltaBaseOffset
10262 </dt>
10263 <dd>
10264 <p>
10265         By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
10266         delta-base offset. If you need to share your repository with
10267         Git older than version 1.4.4, either directly or via a dumb
10268         protocol such as http, then you need to set this option to
10269         "false" and repack. Access from old Git versions over the
10270         native protocol are unaffected by this option.
10271 </p>
10272 </dd>
10273 <dt class="hdlist1">
10274 repack.packKeptObjects
10275 </dt>
10276 <dd>
10277 <p>
10278         If set to true, makes <code>git repack</code> act as if
10279         <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
10280         details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10281         index is being written (either via <code>--write-bitmap-index</code> or
10282         <code>repack.writeBitmaps</code>).
10283 </p>
10284 </dd>
10285 <dt class="hdlist1">
10286 repack.useDeltaIslands
10287 </dt>
10288 <dd>
10289 <p>
10290         If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10291         was passed. Defaults to <code>false</code>.
10292 </p>
10293 </dd>
10294 <dt class="hdlist1">
10295 repack.writeBitmaps
10296 </dt>
10297 <dd>
10298 <p>
10299         When true, git will write a bitmap index when packing all
10300         objects to disk (e.g., when <code>git repack -a</code> is run).  This
10301         index can speed up the "counting objects" phase of subsequent
10302         packs created for clones and fetches, at the cost of some disk
10303         space and extra time spent on the initial repack.  This has
10304         no effect if multiple packfiles are created.
10305         Defaults to true on bare repos, false otherwise.
10306 </p>
10307 </dd>
10308 <dt class="hdlist1">
10309 repack.updateServerInfo
10310 </dt>
10311 <dd>
10312 <p>
10313         If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
10314         <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10315         when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.
10316 </p>
10317 </dd>
10318 <dt class="hdlist1">
10319 repack.cruftWindow
10320 </dt>
10321 <dt class="hdlist1">
10322 repack.cruftWindowMemory
10323 </dt>
10324 <dt class="hdlist1">
10325 repack.cruftDepth
10326 </dt>
10327 <dt class="hdlist1">
10328 repack.cruftThreads
10329 </dt>
10330 <dd>
10331 <p>
10332         Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
10333         a cruft pack and the respective parameters are not given over
10334         the command line. See similarly named <code>pack.*</code> configuration
10335         variables for defaults and meaning.
10336 </p>
10337 </dd>
10338 <dt class="hdlist1">
10339 rerere.autoUpdate
10340 </dt>
10341 <dd>
10342 <p>
10343         When set to true, <code>git-rerere</code> updates the index with the
10344         resulting contents after it cleanly resolves conflicts using
10345         previously recorded resolutions.  Defaults to false.
10346 </p>
10347 </dd>
10348 <dt class="hdlist1">
10349 rerere.enabled
10350 </dt>
10351 <dd>
10352 <p>
10353         Activate recording of resolved conflicts, so that identical
10354         conflict hunks can be resolved automatically, should they be
10355         encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
10356         enabled if there is an <code>rr-cache</code> directory under the
10357         <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
10358         repository.
10359 </p>
10360 </dd>
10361 <dt class="hdlist1">
10362 revert.reference
10363 </dt>
10364 <dd>
10365 <p>
10366         Setting this variable to true makes <code>git revert</code> behave
10367         as if the <code>--reference</code> option is given.
10368 </p>
10369 </dd>
10370 <dt class="hdlist1">
10371 safe.bareRepository
10372 </dt>
10373 <dd>
10374 <p>
10375         Specifies which bare repositories Git will work with. The currently
10376         supported values are:
10377 </p>
10378 <div class="ulist"><ul>
10379 <li>
10380 <p>
10381 <code>all</code>: Git works with all bare repositories. This is the default.
10382 </p>
10383 </li>
10384 <li>
10385 <p>
10386 <code>explicit</code>: Git only works with bare repositories specified via
10387   the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10388   environment variable (see <a href="git.html">git(1)</a>).
10389 </p>
10390 <div class="paragraph"><p>If you do not use bare repositories in your workflow, then it may be
10391 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10392 config. This will protect you from attacks that involve cloning a
10393 repository that contains a bare repository and running a Git command
10394 within that directory.</p></div>
10395 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10396 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with
10397 this value.</p></div>
10398 </li>
10399 </ul></div>
10400 </dd>
10401 <dt class="hdlist1">
10402 safe.directory
10403 </dt>
10404 <dd>
10405 <p>
10406         These config entries specify Git-tracked directories that are
10407         considered safe even if they are owned by someone other than the
10408         current user. By default, Git will refuse to even parse a Git
10409         config of a repository owned by someone else, let alone run its
10410         hooks, and this config setting allows users to specify exceptions,
10411         e.g. for intentionally shared repositories (see the <code>--shared</code>
10412         option in <a href="git-init.html">git-init(1)</a>).
10413 </p>
10414 <div class="paragraph"><p>This is a multi-valued setting, i.e. you can add more than one directory
10415 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10416 override any such directories specified in the system config), add a
10417 <code>safe.directory</code> entry with an empty value.</p></div>
10418 <div class="paragraph"><p>This config setting is only respected in protected configuration (see
10419 <a href="#SCOPES">[SCOPES]</a>). This prevents untrusted repositories from tampering with this
10420 value.</p></div>
10421 <div class="paragraph"><p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
10422 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
10423 path relative to Git&#8217;s (runtime) prefix.</p></div>
10424 <div class="paragraph"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10425 string <code>*</code>. This will allow all repositories to be treated as if their
10426 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10427 is set in system config and you want to re-enable this protection, then
10428 initialize your list with an empty value before listing the repositories
10429 that you deem safe.</p></div>
10430 <div class="paragraph"><p>As explained, Git only allows you to access repositories owned by
10431 yourself, i.e. the user who is running Git, by default.  When Git
10432 is running as <em>root</em> in a non Windows platform that provides sudo,
10433 however, git checks the SUDO_UID environment variable that sudo creates
10434 and will allow access to the uid recorded as its value in addition to
10435 the id from <em>root</em>.
10436 This is to make it easy to perform a common sequence during installation
10437 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
10438 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
10439 which id the original user has.
10440 If that is not what you would prefer and want git to only trust
10441 repositories that are owned by root instead, then you can remove
10442 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p></div>
10443 </dd>
10444 <dt class="hdlist1">
10445 sendemail.identity
10446 </dt>
10447 <dd>
10448 <p>
10449         A configuration identity. When given, causes values in the
10450         <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
10451         values in the <em>sendemail</em> section. The default identity is
10452         the value of <code>sendemail.identity</code>.
10453 </p>
10454 </dd>
10455 <dt class="hdlist1">
10456 sendemail.smtpEncryption
10457 </dt>
10458 <dd>
10459 <p>
10460         See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
10461         setting is not subject to the <em>identity</em> mechanism.
10462 </p>
10463 </dd>
10464 <dt class="hdlist1">
10465 sendemail.smtpsslcertpath
10466 </dt>
10467 <dd>
10468 <p>
10469         Path to ca-certificates (either a directory or a single file).
10470         Set it to an empty string to disable certificate verification.
10471 </p>
10472 </dd>
10473 <dt class="hdlist1">
10474 sendemail.&lt;identity&gt;.*
10475 </dt>
10476 <dd>
10477 <p>
10478         Identity-specific versions of the <em>sendemail.*</em> parameters
10479         found below, taking precedence over those when this
10480         identity is selected, through either the command-line or
10481         <code>sendemail.identity</code>.
10482 </p>
10483 </dd>
10484 <dt class="hdlist1">
10485 sendemail.multiEdit
10486 </dt>
10487 <dd>
10488 <p>
10489         If true (default), a single editor instance will be spawned to edit
10490         files you have to edit (patches when <code>--annotate</code> is used, and the
10491         summary when <code>--compose</code> is used). If false, files will be edited one
10492         after the other, spawning a new editor each time.
10493 </p>
10494 </dd>
10495 <dt class="hdlist1">
10496 sendemail.confirm
10497 </dt>
10498 <dd>
10499 <p>
10500         Sets the default for whether to confirm before sending. Must be
10501         one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
10502         in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
10503         values.
10504 </p>
10505 </dd>
10506 <dt class="hdlist1">
10507 sendemail.aliasesFile
10508 </dt>
10509 <dd>
10510 <p>
10511         To avoid typing long email addresses, point this to one or more
10512         email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.
10513 </p>
10514 </dd>
10515 <dt class="hdlist1">
10516 sendemail.aliasFileType
10517 </dt>
10518 <dd>
10519 <p>
10520         Format of the file(s) specified in sendemail.aliasesFile. Must be
10521         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.
10522 </p>
10523 <div class="paragraph"><p>What an alias file in each format looks like can be found in
10524 the documentation of the email program of the same name. The
10525 differences and limitations from the standard formats are
10526 described below:</p></div>
10527 <div class="openblock">
10528 <div class="content">
10529 <div class="dlist"><dl>
10530 <dt class="hdlist1">
10531 sendmail
10532 </dt>
10533 <dd>
10534 <div class="ulist"><ul>
10535 <li>
10536 <p>
10537 Quoted aliases and quoted addresses are not supported: lines that
10538         contain a <code>"</code> symbol are ignored.
10539 </p>
10540 </li>
10541 <li>
10542 <p>
10543 Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
10544         supported.
10545 </p>
10546 </li>
10547 <li>
10548 <p>
10549 File inclusion (<code>:include: /path/name</code>) is not supported.
10550 </p>
10551 </li>
10552 <li>
10553 <p>
10554 Warnings are printed on the standard error output for any
10555         explicitly unsupported constructs, and any other lines that are not
10556         recognized by the parser.
10557 </p>
10558 </li>
10559 </ul></div>
10560 </dd>
10561 </dl></div>
10562 </div></div>
10563 </dd>
10564 <dt class="hdlist1">
10565 sendemail.annotate
10566 </dt>
10567 <dt class="hdlist1">
10568 sendemail.bcc
10569 </dt>
10570 <dt class="hdlist1">
10571 sendemail.cc
10572 </dt>
10573 <dt class="hdlist1">
10574 sendemail.ccCmd
10575 </dt>
10576 <dt class="hdlist1">
10577 sendemail.chainReplyTo
10578 </dt>
10579 <dt class="hdlist1">
10580 sendemail.envelopeSender
10581 </dt>
10582 <dt class="hdlist1">
10583 sendemail.from
10584 </dt>
10585 <dt class="hdlist1">
10586 sendemail.headerCmd
10587 </dt>
10588 <dt class="hdlist1">
10589 sendemail.signedoffbycc
10590 </dt>
10591 <dt class="hdlist1">
10592 sendemail.smtpPass
10593 </dt>
10594 <dt class="hdlist1">
10595 sendemail.suppresscc
10596 </dt>
10597 <dt class="hdlist1">
10598 sendemail.suppressFrom
10599 </dt>
10600 <dt class="hdlist1">
10601 sendemail.to
10602 </dt>
10603 <dt class="hdlist1">
10604 sendemail.tocmd
10605 </dt>
10606 <dt class="hdlist1">
10607 sendemail.smtpDomain
10608 </dt>
10609 <dt class="hdlist1">
10610 sendemail.smtpServer
10611 </dt>
10612 <dt class="hdlist1">
10613 sendemail.smtpServerPort
10614 </dt>
10615 <dt class="hdlist1">
10616 sendemail.smtpServerOption
10617 </dt>
10618 <dt class="hdlist1">
10619 sendemail.smtpUser
10620 </dt>
10621 <dt class="hdlist1">
10622 sendemail.thread
10623 </dt>
10624 <dt class="hdlist1">
10625 sendemail.transferEncoding
10626 </dt>
10627 <dt class="hdlist1">
10628 sendemail.validate
10629 </dt>
10630 <dt class="hdlist1">
10631 sendemail.xmailer
10632 </dt>
10633 <dd>
10634 <p>
10635         These configuration variables all provide a default for
10636         <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
10637         documentation for details.
10638 </p>
10639 </dd>
10640 <dt class="hdlist1">
10641 sendemail.signedoffcc (deprecated)
10642 </dt>
10643 <dd>
10644 <p>
10645         Deprecated alias for <code>sendemail.signedoffbycc</code>.
10646 </p>
10647 </dd>
10648 <dt class="hdlist1">
10649 sendemail.smtpBatchSize
10650 </dt>
10651 <dd>
10652 <p>
10653         Number of messages to be sent per connection, after that a relogin
10654         will happen.  If the value is 0 or undefined, send all messages in
10655         one connection.
10656         See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10657 </p>
10658 </dd>
10659 <dt class="hdlist1">
10660 sendemail.smtpReloginDelay
10661 </dt>
10662 <dd>
10663 <p>
10664         Seconds to wait before reconnecting to the smtp server.
10665         See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.
10666 </p>
10667 </dd>
10668 <dt class="hdlist1">
10669 sendemail.forbidSendmailVariables
10670 </dt>
10671 <dd>
10672 <p>
10673         To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
10674         will abort with a warning if any configuration options for "sendmail"
10675         exist. Set this variable to bypass the check.
10676 </p>
10677 </dd>
10678 <dt class="hdlist1">
10679 sequence.editor
10680 </dt>
10681 <dd>
10682 <p>
10683         Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
10684         The value is meant to be interpreted by the shell when it is used.
10685         It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
10686         When not configured, the default commit message editor is used instead.
10687 </p>
10688 </dd>
10689 <dt class="hdlist1">
10690 showBranch.default
10691 </dt>
10692 <dd>
10693 <p>
10694         The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
10695         See <a href="git-show-branch.html">git-show-branch(1)</a>.
10696 </p>
10697 </dd>
10698 <dt class="hdlist1">
10699 sparse.expectFilesOutsideOfPatterns
10700 </dt>
10701 <dd>
10702 <p>
10703         Typically with sparse checkouts, files not matching any
10704         sparsity patterns are marked with a SKIP_WORKTREE bit in the
10705         index and are missing from the working tree.  Accordingly, Git
10706         will ordinarily check whether files with the SKIP_WORKTREE bit
10707         are in fact present in the working tree contrary to
10708         expectations.  If Git finds any, it marks those paths as
10709         present by clearing the relevant SKIP_WORKTREE bits.  This
10710         option can be used to tell Git that such
10711         present-despite-skipped files are expected and to stop
10712         checking for them.
10713 </p>
10714 <div class="paragraph"><p>The default is <code>false</code>, which allows Git to automatically recover
10715 from the list of files in the index and working tree falling out of
10716 sync.</p></div>
10717 <div class="paragraph"><p>Set this to <code>true</code> if you are in a setup where some external factor
10718 relieves Git of the responsibility for maintaining the consistency
10719 between the presence of working tree files and sparsity patterns.  For
10720 example, if you have a Git-aware virtual file system that has a robust
10721 mechanism for keeping the working tree and the sparsity patterns up to
10722 date based on access patterns.</p></div>
10723 <div class="paragraph"><p>Regardless of this setting, Git does not check for
10724 present-despite-skipped files unless sparse checkout is enabled, so
10725 this config option has no effect unless <code>core.sparseCheckout</code> is
10726 <code>true</code>.</p></div>
10727 </dd>
10728 <dt class="hdlist1">
10729 splitIndex.maxPercentChange
10730 </dt>
10731 <dd>
10732 <p>
10733         When the split index feature is used, this specifies the
10734         percent of entries the split index can contain compared to the
10735         total number of entries in both the split index and the shared
10736         index before a new shared index is written.
10737         The value should be between 0 and 100. If the value is 0, then
10738         a new shared index is always written; if it is 100, a new
10739         shared index is never written.
10740         By default, the value is 20, so a new shared index is written
10741         if the number of entries in the split index would be greater
10742         than 20 percent of the total number of entries.
10743         See <a href="git-update-index.html">git-update-index(1)</a>.
10744 </p>
10745 </dd>
10746 <dt class="hdlist1">
10747 splitIndex.sharedIndexExpire
10748 </dt>
10749 <dd>
10750 <p>
10751         When the split index feature is used, shared index files that
10752         were not modified since the time this variable specifies will
10753         be removed when a new shared index file is created. The value
10754         "now" expires all entries immediately, and "never" suppresses
10755         expiration altogether.
10756         The default value is "2.weeks.ago".
10757         Note that a shared index file is considered modified (for the
10758         purpose of expiration) each time a new split-index file is
10759         either created based on it or read from it.
10760         See <a href="git-update-index.html">git-update-index(1)</a>.
10761 </p>
10762 </dd>
10763 <dt class="hdlist1">
10764 ssh.variant
10765 </dt>
10766 <dd>
10767 <p>
10768         By default, Git determines the command line arguments to use
10769         based on the basename of the configured SSH command (configured
10770         using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
10771         the config setting <code>core.sshCommand</code>). If the basename is
10772         unrecognized, Git will attempt to detect support of OpenSSH
10773         options by first invoking the configured SSH command with the
10774         <code>-G</code> (print configuration) option and will subsequently use
10775         OpenSSH options (if that is successful) or no options besides
10776         the host and remote command (if it fails).
10777 </p>
10778 <div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this detection.
10779 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
10780 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
10781 The default auto-detection can be explicitly requested using the value
10782 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
10783 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
10784 <div class="paragraph"><p>The current command-line parameters used for each variant are as
10785 follows:</p></div>
10786 <div class="openblock">
10787 <div class="content">
10788 <div class="ulist"><ul>
10789 <li>
10790 <p>
10791 <code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command
10792 </p>
10793 </li>
10794 <li>
10795 <p>
10796 <code>simple</code> - [username@]host command
10797 </p>
10798 </li>
10799 <li>
10800 <p>
10801 <code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command
10802 </p>
10803 </li>
10804 <li>
10805 <p>
10806 <code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command
10807 </p>
10808 </li>
10809 </ul></div>
10810 </div></div>
10811 <div class="paragraph"><p>Except for the <code>simple</code> variant, command-line parameters are likely to
10812 change as git gains new features.</p></div>
10813 </dd>
10814 <dt class="hdlist1">
10815 status.relativePaths
10816 </dt>
10817 <dd>
10818 <p>
10819         By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
10820         current directory. Setting this variable to <code>false</code> shows paths
10821         relative to the repository root (this was the default for Git
10822         prior to v1.5.4).
10823 </p>
10824 </dd>
10825 <dt class="hdlist1">
10826 status.short
10827 </dt>
10828 <dd>
10829 <p>
10830         Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
10831         The option --no-short takes precedence over this variable.
10832 </p>
10833 </dd>
10834 <dt class="hdlist1">
10835 status.branch
10836 </dt>
10837 <dd>
10838 <p>
10839         Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
10840         The option --no-branch takes precedence over this variable.
10841 </p>
10842 </dd>
10843 <dt class="hdlist1">
10844 status.aheadBehind
10845 </dt>
10846 <dd>
10847 <p>
10848         Set to true to enable <code>--ahead-behind</code> and false to enable
10849         <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
10850         non-porcelain status formats.  Defaults to true.
10851 </p>
10852 </dd>
10853 <dt class="hdlist1">
10854 status.displayCommentPrefix
10855 </dt>
10856 <dd>
10857 <p>
10858         If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
10859         prefix before each output line (starting with
10860         <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
10861         behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
10862         Defaults to false.
10863 </p>
10864 </dd>
10865 <dt class="hdlist1">
10866 status.renameLimit
10867 </dt>
10868 <dd>
10869 <p>
10870         The number of files to consider when performing rename detection
10871         in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
10872         the value of diff.renameLimit.
10873 </p>
10874 </dd>
10875 <dt class="hdlist1">
10876 status.renames
10877 </dt>
10878 <dd>
10879 <p>
10880         Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
10881         <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
10882         disabled. If set to "true", basic rename detection is enabled.
10883         If set to "copies" or "copy", Git will detect copies, as well.
10884         Defaults to the value of diff.renames.
10885 </p>
10886 </dd>
10887 <dt class="hdlist1">
10888 status.showStash
10889 </dt>
10890 <dd>
10891 <p>
10892         If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
10893         entries currently stashed away.
10894         Defaults to false.
10895 </p>
10896 </dd>
10897 <dt class="hdlist1">
10898 status.showUntrackedFiles
10899 </dt>
10900 <dd>
10901 <p>
10902         By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
10903         files which are not currently tracked by Git. Directories which
10904         contain only untracked files, are shown with the directory name
10905         only. Showing untracked files means that Git needs to lstat() all
10906         the files in the whole repository, which might be slow on some
10907         systems. So, this variable controls how the commands display
10908         the untracked files. Possible values are:
10909 </p>
10910 <div class="openblock">
10911 <div class="content">
10912 <div class="ulist"><ul>
10913 <li>
10914 <p>
10915 <code>no</code> - Show no untracked files.
10916 </p>
10917 </li>
10918 <li>
10919 <p>
10920 <code>normal</code> - Show untracked files and directories.
10921 </p>
10922 </li>
10923 <li>
10924 <p>
10925 <code>all</code> - Show also individual files in untracked directories.
10926 </p>
10927 </li>
10928 </ul></div>
10929 </div></div>
10930 <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
10931 This variable can be overridden with the -u|--untracked-files option
10932 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
10933 </dd>
10934 <dt class="hdlist1">
10935 status.submoduleSummary
10936 </dt>
10937 <dd>
10938 <p>
10939         Defaults to false.
10940         If this is set to a non-zero number or true (identical to -1 or an
10941         unlimited number), the submodule summary will be enabled and a
10942         summary of commits for modified submodules will be shown (see
10943         --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
10944         that the summary output command will be suppressed for all
10945         submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
10946         for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
10947         exception to that rule is that status and commit will show staged
10948         submodule changes. To
10949         also view the summary for ignored submodules you can either use
10950         the --ignore-submodules=dirty command-line option or the <em>git
10951         submodule summary</em> command, which shows a similar output but does
10952         not honor these settings.
10953 </p>
10954 </dd>
10955 <dt class="hdlist1">
10956 stash.showIncludeUntracked
10957 </dt>
10958 <dd>
10959 <p>
10960         If this is set to true, the <code>git stash show</code> command will show
10961         the untracked files of a stash entry.  Defaults to false. See
10962         the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10963 </p>
10964 </dd>
10965 <dt class="hdlist1">
10966 stash.showPatch
10967 </dt>
10968 <dd>
10969 <p>
10970         If this is set to true, the <code>git stash show</code> command without an
10971         option will show the stash entry in patch form.  Defaults to false.
10972         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10973 </p>
10974 </dd>
10975 <dt class="hdlist1">
10976 stash.showStat
10977 </dt>
10978 <dd>
10979 <p>
10980         If this is set to true, the <code>git stash show</code> command without an
10981         option will show a diffstat of the stash entry.  Defaults to true.
10982         See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
10983 </p>
10984 </dd>
10985 <dt class="hdlist1">
10986 submodule.&lt;name&gt;.url
10987 </dt>
10988 <dd>
10989 <p>
10990         The URL for a submodule. This variable is copied from the .gitmodules
10991         file to the git config via <em>git submodule init</em>. The user can change
10992         the configured URL before obtaining the submodule via <em>git submodule
10993         update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
10994         set, the presence of this variable is used as a fallback to indicate
10995         whether the submodule is of interest to git commands.
10996         See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
10997 </p>
10998 </dd>
10999 <dt class="hdlist1">
11000 submodule.&lt;name&gt;.update
11001 </dt>
11002 <dd>
11003 <p>
11004         The method by which a submodule is updated by <em>git submodule update</em>,
11005         which is the only affected command, others such as
11006         <em>git checkout --recurse-submodules</em> are unaffected. It exists for
11007         historical reasons, when <em>git submodule</em> was the only command to
11008         interact with submodules; settings like <code>submodule.active</code>
11009         and <code>pull.rebase</code> are more specific. It is populated by
11010         <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
11011         See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.
11012 </p>
11013 </dd>
11014 <dt class="hdlist1">
11015 submodule.&lt;name&gt;.branch
11016 </dt>
11017 <dd>
11018 <p>
11019         The remote branch name for a submodule, used by <code>git submodule
11020         update --remote</code>.  Set this option to override the value found in
11021         the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
11022         <a href="gitmodules.html">gitmodules(5)</a> for details.
11023 </p>
11024 </dd>
11025 <dt class="hdlist1">
11026 submodule.&lt;name&gt;.fetchRecurseSubmodules
11027 </dt>
11028 <dd>
11029 <p>
11030         This option can be used to control recursive fetching of this
11031         submodule. It can be overridden by using the --[no-]recurse-submodules
11032         command-line option to "git fetch" and "git pull".
11033         This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
11034         file.
11035 </p>
11036 </dd>
11037 <dt class="hdlist1">
11038 submodule.&lt;name&gt;.ignore
11039 </dt>
11040 <dd>
11041 <p>
11042         Defines under what circumstances "git status" and the diff family show
11043         a submodule as modified. When set to "all", it will never be considered
11044         modified (but it will nonetheless show up in the output of status and
11045         commit when it has been staged), "dirty" will ignore all changes
11046         to the submodule&#8217;s work tree and
11047         takes only differences between the HEAD of the submodule and the commit
11048         recorded in the superproject into account. "untracked" will additionally
11049         let submodules with modified tracked files in their work tree show up.
11050         Using "none" (the default when this option is not set) also shows
11051         submodules that have untracked files in their work tree as changed.
11052         This setting overrides any setting made in .gitmodules for this submodule,
11053         both settings can be overridden on the command line by using the
11054         "--ignore-submodules" option. The <em>git submodule</em> commands are not
11055         affected by this setting.
11056 </p>
11057 </dd>
11058 <dt class="hdlist1">
11059 submodule.&lt;name&gt;.active
11060 </dt>
11061 <dd>
11062 <p>
11063         Boolean value indicating if the submodule is of interest to git
11064         commands.  This config option takes precedence over the
11065         submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
11066         details.
11067 </p>
11068 </dd>
11069 <dt class="hdlist1">
11070 submodule.active
11071 </dt>
11072 <dd>
11073 <p>
11074         A repeated field which contains a pathspec used to match against a
11075         submodule&#8217;s path to determine if the submodule is of interest to git
11076         commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.
11077 </p>
11078 </dd>
11079 <dt class="hdlist1">
11080 submodule.recurse
11081 </dt>
11082 <dd>
11083 <p>
11084         A boolean indicating if commands should enable the <code>--recurse-submodules</code>
11085         option by default. Defaults to false.
11086 </p>
11087 <div class="paragraph"><p>When set to true, it can be deactivated via the
11088 <code>--no-recurse-submodules</code> option. Note that some Git commands
11089 lacking this option may call some of the above commands affected by
11090 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
11091 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
11092 For these commands a workaround is to temporarily change the
11093 configuration value by using <code>git -c submodule.recurse=0</code>.</p></div>
11094 <div class="paragraph"><p>The following list shows the commands that accept
11095 <code>--recurse-submodules</code> and whether they are supported by this
11096 setting.</p></div>
11097 <div class="ulist"><ul>
11098 <li>
11099 <p>
11100 <code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
11101 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.
11102 </p>
11103 </li>
11104 <li>
11105 <p>
11106 <code>clone</code> and <code>ls-files</code> are not supported.
11107 </p>
11108 </li>
11109 <li>
11110 <p>
11111 <code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
11112 enabled
11113 </p>
11114 </li>
11115 </ul></div>
11116 </dd>
11117 <dt class="hdlist1">
11118 submodule.propagateBranches
11119 </dt>
11120 <dd>
11121 <p>
11122         [EXPERIMENTAL] A boolean that enables branching support when
11123         using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
11124         Enabling this will allow certain commands to accept
11125         <code>--recurse-submodules</code> and certain commands that already accept
11126         <code>--recurse-submodules</code> will now consider branches.
11127         Defaults to false.
11128 </p>
11129 </dd>
11130 <dt class="hdlist1">
11131 submodule.fetchJobs
11132 </dt>
11133 <dd>
11134 <p>
11135         Specifies how many submodules are fetched/cloned at the same time.
11136         A positive integer allows up to that number of submodules fetched
11137         in parallel. A value of 0 will give some reasonable default.
11138         If unset, it defaults to 1.
11139 </p>
11140 </dd>
11141 <dt class="hdlist1">
11142 submodule.alternateLocation
11143 </dt>
11144 <dd>
11145 <p>
11146         Specifies how the submodules obtain alternates when submodules are
11147         cloned. Possible values are <code>no</code>, <code>superproject</code>.
11148         By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
11149         value is set to <code>superproject</code> the submodule to be cloned computes
11150         its alternates location relative to the superprojects alternate.
11151 </p>
11152 </dd>
11153 <dt class="hdlist1">
11154 submodule.alternateErrorStrategy
11155 </dt>
11156 <dd>
11157 <p>
11158         Specifies how to treat errors with the alternates for a submodule
11159         as computed via <code>submodule.alternateLocation</code>. Possible values are
11160         <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
11161         or <code>info</code>, and if there is an error with the computed alternate, the
11162         clone proceeds as if no alternate was specified.
11163 </p>
11164 </dd>
11165 <dt class="hdlist1">
11166 tag.forceSignAnnotated
11167 </dt>
11168 <dd>
11169 <p>
11170         A boolean to specify whether annotated tags created should be GPG signed.
11171         If <code>--annotate</code> is specified on the command line, it takes
11172         precedence over this option.
11173 </p>
11174 </dd>
11175 <dt class="hdlist1">
11176 tag.sort
11177 </dt>
11178 <dd>
11179 <p>
11180         This variable controls the sort ordering of tags when displayed by
11181         <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
11182         value of this variable will be used as the default.
11183 </p>
11184 </dd>
11185 <dt class="hdlist1">
11186 tag.gpgSign
11187 </dt>
11188 <dd>
11189 <p>
11190         A boolean to specify whether all tags should be GPG signed.
11191         Use of this option when running in an automated script can
11192         result in a large number of tags being signed. It is therefore
11193         convenient to use an agent to avoid typing your gpg passphrase
11194         several times. Note that this option doesn&#8217;t affect tag signing
11195         behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.
11196 </p>
11197 </dd>
11198 <dt class="hdlist1">
11199 tar.umask
11200 </dt>
11201 <dd>
11202 <p>
11203         This variable can be used to restrict the permission bits of
11204         tar archive entries.  The default is 0002, which turns off the
11205         world write bit.  The special value "user" indicates that the
11206         archiving user&#8217;s umask will be used instead.  See umask(2) and
11207         <a href="git-archive.html">git-archive(1)</a>.
11208 </p>
11209 </dd>
11210 </dl></div>
11211 <div class="paragraph"><p>Trace2 config settings are only read from the system and global
11212 config files; repository local and worktree config files and <code>-c</code>
11213 command line arguments are not respected.</p></div>
11214 <div class="dlist"><dl>
11215 <dt class="hdlist1">
11216 trace2.normalTarget
11217 </dt>
11218 <dd>
11219 <p>
11220         This variable controls the normal target destination.
11221         It may be overridden by the <code>GIT_TRACE2</code> environment variable.
11222         The following table shows possible values.
11223 </p>
11224 </dd>
11225 <dt class="hdlist1">
11226 trace2.perfTarget
11227 </dt>
11228 <dd>
11229 <p>
11230         This variable controls the performance target destination.
11231         It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
11232         The following table shows possible values.
11233 </p>
11234 </dd>
11235 <dt class="hdlist1">
11236 trace2.eventTarget
11237 </dt>
11238 <dd>
11239 <p>
11240         This variable controls the event target destination.
11241         It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
11242         The following table shows possible values.
11243 </p>
11244 <div class="openblock">
11245 <div class="content">
11246 <div class="ulist"><ul>
11247 <li>
11248 <p>
11249 <code>0</code> or <code>false</code> - Disables the target.
11250 </p>
11251 </li>
11252 <li>
11253 <p>
11254 <code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.
11255 </p>
11256 </li>
11257 <li>
11258 <p>
11259 <code>[2-9]</code> - Writes to the already opened file descriptor.
11260 </p>
11261 </li>
11262 <li>
11263 <p>
11264 <code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
11265 already exists and is a directory, the traces will be written to files (one
11266 per process) underneath the given directory.
11267 </p>
11268 </li>
11269 <li>
11270 <p>
11271 <code>af_unix:[&lt;socket-type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
11272 Unix DomainSocket (on platforms that support them).  Socket
11273 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
11274 try both.
11275 </p>
11276 </li>
11277 </ul></div>
11278 </div></div>
11279 </dd>
11280 <dt class="hdlist1">
11281 trace2.normalBrief
11282 </dt>
11283 <dd>
11284 <p>
11285         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11286         omitted from normal output.  May be overridden by the
11287         <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.
11288 </p>
11289 </dd>
11290 <dt class="hdlist1">
11291 trace2.perfBrief
11292 </dt>
11293 <dd>
11294 <p>
11295         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11296         omitted from PERF output.  May be overridden by the
11297         <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.
11298 </p>
11299 </dd>
11300 <dt class="hdlist1">
11301 trace2.eventBrief
11302 </dt>
11303 <dd>
11304 <p>
11305         Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
11306         omitted from event output.  May be overridden by the
11307         <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.
11308 </p>
11309 </dd>
11310 <dt class="hdlist1">
11311 trace2.eventNesting
11312 </dt>
11313 <dd>
11314 <p>
11315         Integer.  Specifies desired depth of nested regions in the
11316         event output.  Regions deeper than this value will be
11317         omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
11318         environment variable.  Defaults to 2.
11319 </p>
11320 </dd>
11321 <dt class="hdlist1">
11322 trace2.configParams
11323 </dt>
11324 <dd>
11325 <p>
11326         A comma-separated list of patterns of "important" config
11327         settings that should be recorded in the trace2 output.
11328         For example, <code>core.*,remote.*.url</code> would cause the trace2
11329         output to contain events listing each configured remote.
11330         May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
11331         variable.  Unset by default.
11332 </p>
11333 </dd>
11334 <dt class="hdlist1">
11335 trace2.envVars
11336 </dt>
11337 <dd>
11338 <p>
11339         A comma-separated list of "important" environment variables that should
11340         be recorded in the trace2 output.  For example,
11341         <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
11342         contain events listing the overrides for HTTP user agent and the
11343         location of the Git configuration file (assuming any are set).  May be
11344         overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
11345         default.
11346 </p>
11347 </dd>
11348 <dt class="hdlist1">
11349 trace2.destinationDebug
11350 </dt>
11351 <dd>
11352 <p>
11353         Boolean.  When true Git will print error messages when a
11354         trace target destination cannot be opened for writing.
11355         By default, these errors are suppressed and tracing is
11356         silently disabled.  May be overridden by the
11357         <code>GIT_TRACE2_DST_DEBUG</code> environment variable.
11358 </p>
11359 </dd>
11360 <dt class="hdlist1">
11361 trace2.maxFiles
11362 </dt>
11363 <dd>
11364 <p>
11365         Integer.  When writing trace files to a target directory, do not
11366         write additional traces if doing so would exceed this many files. Instead,
11367         write a sentinel file that will block further tracing to this
11368         directory. Defaults to 0, which disables this check.
11369 </p>
11370 </dd>
11371 <dt class="hdlist1">
11372 transfer.credentialsInUrl
11373 </dt>
11374 <dd>
11375 <p>
11376         A configured URL can contain plaintext credentials in the form
11377         <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
11378         to warn or forbid the use of such configuration (in favor of
11379         using <a href="git-credential.html">git-credential(1)</a>). This will be used on
11380         <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>,
11381         and any other direct use of the configured URL.
11382 </p>
11383 <div class="paragraph"><p>Note that this is currently limited to detecting credentials in
11384 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
11385 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p></div>
11386 <div class="paragraph"><p>You might want to enable this to prevent inadvertent credentials
11387 exposure, e.g. because:</p></div>
11388 <div class="ulist"><ul>
11389 <li>
11390 <p>
11391 The OS or system where you&#8217;re running git may not provide a way or
11392   otherwise allow you to configure the permissions of the
11393   configuration file where the username and/or password are stored.
11394 </p>
11395 </li>
11396 <li>
11397 <p>
11398 Even if it does, having such data stored "at rest" might expose you
11399   in other ways, e.g. a backup process might copy the data to another
11400   system.
11401 </p>
11402 </li>
11403 <li>
11404 <p>
11405 The git programs will pass the full URL to one another as arguments
11406   on the command-line, meaning the credentials will be exposed to other
11407   unprivileged users on systems that allow them to see the full
11408   process list of other users. On linux the "hidepid" setting
11409   documented in procfs(5) allows for configuring this behavior.
11410 </p>
11411 <div class="paragraph"><p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
11412 concerned about credentials exposure due to storing sensitive
11413 data in git&#8217;s configuration files. If you do want to use this, set
11414 <code>transfer.credentialsInUrl</code> to one of these values:</p></div>
11415 </li>
11416 <li>
11417 <p>
11418 <code>allow</code> (default): Git will proceed with its activity without warning.
11419 </p>
11420 </li>
11421 <li>
11422 <p>
11423 <code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
11424   with a plaintext credential.
11425 </p>
11426 </li>
11427 <li>
11428 <p>
11429 <code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
11430   with a plaintext credential.
11431 </p>
11432 </li>
11433 </ul></div>
11434 </dd>
11435 <dt class="hdlist1">
11436 transfer.fsckObjects
11437 </dt>
11438 <dd>
11439 <p>
11440         When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
11441         not set, the value of this variable is used instead.
11442         Defaults to false.
11443 </p>
11444 <div class="paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
11445 object or a link to a nonexistent object. In addition, various other
11446 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
11447 and potential security issues like the existence of a <code>.GIT</code> directory
11448 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
11449 and v2.17.1 for details). Other sanity and security checks may be
11450 added in future releases.</p></div>
11451 <div class="paragraph"><p>On the receiving side, failing fsckObjects will make those objects
11452 unreachable, see "QUARANTINE ENVIRONMENT" in
11453 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
11454 instead be left unreferenced in the repository.</p></div>
11455 <div class="paragraph"><p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
11456 implementation it cannot be relied upon to leave the object store
11457 clean like <code>receive.fsckObjects</code> can.</p></div>
11458 <div class="paragraph"><p>As objects are unpacked they&#8217;re written to the object store, so there
11459 can be cases where malicious objects get introduced even though the
11460 "fetch" failed, only to have a subsequent "fetch" succeed because only
11461 new incoming objects are checked, not those that have already been
11462 written to the object store. That difference in behavior should not be
11463 relied upon. In the future, such objects may be quarantined for
11464 "fetch" as well.</p></div>
11465 <div class="paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
11466 environment if they&#8217;d like the same protection as "push". E.g. in the
11467 case of an internal mirror do the mirroring in two steps, one to fetch
11468 the untrusted objects, and then do a second "push" (which will use the
11469 quarantine) to another internal repo, and have internal clients
11470 consume this pushed-to repository, or embargo internal fetches and
11471 only allow them once a full "fsck" has run (and no new fetches have
11472 happened in the meantime).</p></div>
11473 </dd>
11474 <dt class="hdlist1">
11475 transfer.hideRefs
11476 </dt>
11477 <dd>
11478 <p>
11479         String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
11480         refs to omit from their initial advertisements.  Use more than
11481         one definition to specify multiple prefix strings. A ref that is
11482         under the hierarchies listed in the value of this variable is
11483         excluded, and is hidden when responding to <code>git push</code> or <code>git
11484         fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
11485         program-specific versions of this config.
11486 </p>
11487 <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
11488 explicitly exposing it, even if an earlier entry marked it as hidden.
11489 If you have multiple hideRefs values, later entries override earlier ones
11490 (and entries in more-specific config files override less-specific ones).</p></div>
11491 <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
11492 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
11493 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
11494 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
11495 <div class="paragraph"><p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
11496 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
11497 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
11498 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
11499 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
11500 <code>receive-pack</code>, on the other hand, will still advertise the object id the
11501 ref is pointing to without mentioning its name (a so-called ".have" line).</p></div>
11502 <div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
11503 objects via the techniques described in the "SECURITY" section of the
11504 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
11505 separate repository.</p></div>
11506 </dd>
11507 <dt class="hdlist1">
11508 transfer.unpackLimit
11509 </dt>
11510 <dd>
11511 <p>
11512         When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
11513         not set, the value of this variable is used instead.
11514         The default value is 100.
11515 </p>
11516 </dd>
11517 <dt class="hdlist1">
11518 transfer.advertiseSID
11519 </dt>
11520 <dd>
11521 <p>
11522         Boolean. When true, client and server processes will advertise their
11523         unique session IDs to their remote counterpart. Defaults to false.
11524 </p>
11525 </dd>
11526 <dt class="hdlist1">
11527 transfer.bundleURI
11528 </dt>
11529 <dd>
11530 <p>
11531         When <code>true</code>, local <code>git clone</code> commands will request bundle
11532         information from the remote server (if advertised) and download
11533         bundles before continuing the clone through the Git protocol.
11534         Defaults to <code>false</code>.
11535 </p>
11536 </dd>
11537 <dt class="hdlist1">
11538 uploadarchive.allowUnreachable
11539 </dt>
11540 <dd>
11541 <p>
11542         If true, allow clients to use <code>git archive --remote</code> to request
11543         any tree, whether reachable from the ref tips or not. See the
11544         discussion in the "SECURITY" section of
11545         <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
11546         <code>false</code>.
11547 </p>
11548 </dd>
11549 <dt class="hdlist1">
11550 uploadpack.hideRefs
11551 </dt>
11552 <dd>
11553 <p>
11554         This variable is the same as <code>transfer.hideRefs</code>, but applies
11555         only to <code>upload-pack</code> (and so affects only fetches, not pushes).
11556         An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
11557         also <code>uploadpack.allowTipSHA1InWant</code>.
11558 </p>
11559 </dd>
11560 <dt class="hdlist1">
11561 uploadpack.allowTipSHA1InWant
11562 </dt>
11563 <dd>
11564 <p>
11565         When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
11566         to accept a fetch request that asks for an object at the tip
11567         of a hidden ref (by default, such a request is rejected).
11568         See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
11569         may be able to steal objects via the techniques described in the
11570         "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
11571         best to keep private data in a separate repository.
11572 </p>
11573 </dd>
11574 <dt class="hdlist1">
11575 uploadpack.allowReachableSHA1InWant
11576 </dt>
11577 <dd>
11578 <p>
11579         Allow <code>upload-pack</code> to accept a fetch request that asks for an
11580         object that is reachable from any ref tip. However, note that
11581         calculating object reachability is computationally expensive.
11582         Defaults to <code>false</code>.  Even if this is false, a client may be able
11583         to steal objects via the techniques described in the "SECURITY"
11584         section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
11585         keep private data in a separate repository.
11586 </p>
11587 </dd>
11588 <dt class="hdlist1">
11589 uploadpack.allowAnySHA1InWant
11590 </dt>
11591 <dd>
11592 <p>
11593         Allow <code>upload-pack</code> to accept a fetch request that asks for any
11594         object at all.
11595         Defaults to <code>false</code>.
11596 </p>
11597 </dd>
11598 <dt class="hdlist1">
11599 uploadpack.keepAlive
11600 </dt>
11601 <dd>
11602 <p>
11603         When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
11604         quiet period while <code>pack-objects</code> prepares the pack. Normally
11605         it would output progress information, but if <code>--quiet</code> was used
11606         for the fetch, <code>pack-objects</code> will output nothing at all until
11607         the pack data begins. Some clients and networks may consider
11608         the server to be hung and give up. Setting this option instructs
11609         <code>upload-pack</code> to send an empty keepalive packet every
11610         <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
11611         disables keepalive packets entirely. The default is 5 seconds.
11612 </p>
11613 </dd>
11614 <dt class="hdlist1">
11615 uploadpack.packObjectsHook
11616 </dt>
11617 <dd>
11618 <p>
11619         If this option is set, when <code>upload-pack</code> would run
11620         <code>git pack-objects</code> to create a packfile for a client, it will
11621         run this shell command instead.  The <code>pack-objects</code> command and
11622         arguments it <em>would</em> have run (including the <code>git pack-objects</code>
11623         at the beginning) are appended to the shell command. The stdin
11624         and stdout of the hook are treated as if <code>pack-objects</code> itself
11625         was run. I.e., <code>upload-pack</code> will feed input intended for
11626         <code>pack-objects</code> to the hook, and expects a completed packfile on
11627         stdout.
11628 </p>
11629 <div class="paragraph"><p>Note that this configuration variable is only respected when it is specified
11630 in protected configuration (see <a href="#SCOPES">[SCOPES]</a>). This is a safety measure
11631 against fetching from untrusted repositories.</p></div>
11632 </dd>
11633 <dt class="hdlist1">
11634 uploadpack.allowFilter
11635 </dt>
11636 <dd>
11637 <p>
11638         If this option is set, <code>upload-pack</code> will support partial
11639         clone and partial fetch object filtering.
11640 </p>
11641 </dd>
11642 <dt class="hdlist1">
11643 uploadpackfilter.allow
11644 </dt>
11645 <dd>
11646 <p>
11647         Provides a default value for unspecified object filters (see: the
11648         below configuration variable). If set to <code>true</code>, this will also
11649         enable all filters which get added in the future.
11650         Defaults to <code>true</code>.
11651 </p>
11652 </dd>
11653 <dt class="hdlist1">
11654 uploadpackfilter.&lt;filter&gt;.allow
11655 </dt>
11656 <dd>
11657 <p>
11658         Explicitly allow or ban the object filter corresponding to
11659         <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
11660         <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
11661         If using combined filters, both <code>combine</code> and all of the nested
11662         filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.
11663 </p>
11664 </dd>
11665 <dt class="hdlist1">
11666 uploadpackfilter.tree.maxDepth
11667 </dt>
11668 <dd>
11669 <p>
11670         Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
11671         <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
11672         <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
11673         variable had already been set. Has no effect if unset.
11674 </p>
11675 </dd>
11676 <dt class="hdlist1">
11677 uploadpack.allowRefInWant
11678 </dt>
11679 <dd>
11680 <p>
11681         If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
11682         feature of the protocol version 2 <code>fetch</code> command.  This feature
11683         is intended for the benefit of load-balanced servers which may
11684         not have the same view of what OIDs their refs point to due to
11685         replication delay.
11686 </p>
11687 </dd>
11688 <dt class="hdlist1">
11689 url.&lt;base&gt;.insteadOf
11690 </dt>
11691 <dd>
11692 <p>
11693         Any URL that starts with this value will be rewritten to
11694         start, instead, with &lt;base&gt;. In cases where some site serves a
11695         large number of repositories, and serves them with multiple
11696         access methods, and some users need to use different access
11697         methods, this feature allows people to specify any of the
11698         equivalent URLs and have Git automatically rewrite the URL to
11699         the best alternative for the particular user, even for a
11700         never-before-seen repository on the site.  When more than one
11701         insteadOf strings match a given URL, the longest match is used.
11702 </p>
11703 <div class="paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
11704 URL. If the rewrite changes the URL to use a custom protocol or remote
11705 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
11706 the request.  In particular, protocols you expect to use for submodules
11707 must be set to <code>always</code> rather than the default of <code>user</code>. See the
11708 description of <code>protocol.allow</code> above.</p></div>
11709 </dd>
11710 <dt class="hdlist1">
11711 url.&lt;base&gt;.pushInsteadOf
11712 </dt>
11713 <dd>
11714 <p>
11715         Any URL that starts with this value will not be pushed to;
11716         instead, it will be rewritten to start with &lt;base&gt;, and the
11717         resulting URL will be pushed to. In cases where some site serves
11718         a large number of repositories, and serves them with multiple
11719         access methods, some of which do not allow push, this feature
11720         allows people to specify a pull-only URL and have Git
11721         automatically use an appropriate URL to push, even for a
11722         never-before-seen repository on the site.  When more than one
11723         pushInsteadOf strings match a given URL, the longest match is
11724         used.  If a remote has an explicit pushurl, Git will ignore this
11725         setting for that remote.
11726 </p>
11727 </dd>
11728 <dt class="hdlist1">
11729 user.name
11730 </dt>
11731 <dt class="hdlist1">
11732 user.email
11733 </dt>
11734 <dt class="hdlist1">
11735 author.name
11736 </dt>
11737 <dt class="hdlist1">
11738 author.email
11739 </dt>
11740 <dt class="hdlist1">
11741 committer.name
11742 </dt>
11743 <dt class="hdlist1">
11744 committer.email
11745 </dt>
11746 <dd>
11747 <p>
11748         The <code>user.name</code> and <code>user.email</code> variables determine what ends
11749         up in the <code>author</code> and <code>committer</code> fields of commit
11750         objects.
11751         If you need the <code>author</code> or <code>committer</code> to be different, the
11752         <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
11753         <code>committer.email</code> variables can be set.
11754         All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
11755         <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
11756         <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.
11757 </p>
11758 <div class="paragraph"><p>Note that the <code>name</code> forms of these variables conventionally refer to
11759 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
11760 environment variables section of <a href="git.html">git(1)</a> for more information on
11761 these settings and the <code>credential.username</code> option if you&#8217;re looking
11762 for authentication credentials instead.</p></div>
11763 </dd>
11764 <dt class="hdlist1">
11765 user.useConfigOnly
11766 </dt>
11767 <dd>
11768 <p>
11769         Instruct Git to avoid trying to guess defaults for <code>user.email</code>
11770         and <code>user.name</code>, and instead retrieve the values only from the
11771         configuration. For example, if you have multiple email addresses
11772         and would like to use a different one for each repository, then
11773         with this configuration option set to <code>true</code> in the global config
11774         along with a name, Git will prompt you to set up an email before
11775         making new commits in a newly cloned repository.
11776         Defaults to <code>false</code>.
11777 </p>
11778 </dd>
11779 <dt class="hdlist1">
11780 user.signingKey
11781 </dt>
11782 <dd>
11783 <p>
11784         If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
11785         key you want it to automatically when creating a signed tag or
11786         commit, you can override the default selection with this variable.
11787         This option is passed unchanged to gpg&#8217;s --local-user parameter,
11788         so you may specify a key using any method that gpg supports.
11789         If gpg.format is set to <code>ssh</code> this can contain the path to either
11790         your private ssh key or the public key when ssh-agent is used.
11791         Alternatively it can contain a public key prefixed with <code>key::</code>
11792         directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
11793         needs to be available via ssh-agent. If not set Git will call
11794         gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
11795         first key available. For backward compatibility, a raw key which
11796         begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
11797         as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
11798         use the <code>key::</code> form instead.
11799 </p>
11800 </dd>
11801 <dt class="hdlist1">
11802 versionsort.prereleaseSuffix (deprecated)
11803 </dt>
11804 <dd>
11805 <p>
11806         Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
11807         <code>versionsort.suffix</code> is set.
11808 </p>
11809 </dd>
11810 <dt class="hdlist1">
11811 versionsort.suffix
11812 </dt>
11813 <dd>
11814 <p>
11815         Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
11816         with the same base version but different suffixes are still sorted
11817         lexicographically, resulting e.g. in prerelease tags appearing
11818         after the main release (e.g. "1.0-rc1" after "1.0").  This
11819         variable can be specified to determine the sorting order of tags
11820         with different suffixes.
11821 </p>
11822 <div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
11823 that suffix will appear before the corresponding main release.  E.g. if
11824 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
11825 "1.0".  If specified multiple times, once per suffix, then the order of
11826 suffixes in the configuration will determine the sorting order of tagnames
11827 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
11828 configuration, then all "1.0-preX" tags will be listed before any
11829 "1.0-rcX" tags.  The placement of the main release tag relative to tags
11830 with various suffixes can be determined by specifying the empty suffix
11831 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
11832 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
11833 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
11834 "v4.8-bfsX".</p></div>
11835 <div class="paragraph"><p>If more than one suffix matches the same tagname, then that tagname will
11836 be sorted according to the suffix which starts at the earliest position in
11837 the tagname.  If more than one different matching suffix starts at
11838 that earliest position, then that tagname will be sorted according to the
11839 longest of those suffixes.
11840 The sorting order between different suffixes is undefined if they are
11841 in multiple config files.</p></div>
11842 </dd>
11843 <dt class="hdlist1">
11844 web.browser
11845 </dt>
11846 <dd>
11847 <p>
11848         Specify a web browser that may be used by some commands.
11849         Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
11850         may use it.
11851 </p>
11852 </dd>
11853 <dt class="hdlist1">
11854 worktree.guessRemote
11855 </dt>
11856 <dd>
11857 <p>
11858         If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
11859         <code>--detach</code> is used, then <code>git worktree add</code> defaults to
11860         creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
11861         set to true, <code>worktree add</code> tries to find a remote-tracking
11862         branch whose name uniquely matches the new branch name.  If
11863         such a branch exists, it is checked out and set as "upstream"
11864         for the new branch.  If no such match can be found, it falls
11865         back to creating a new branch from the current HEAD.
11866 </p>
11867 </dd>
11868 </dl></div>
11869 </div>
11870 </div>
11871 </div>
11872 <div class="sect1">
11873 <h2 id="_bugs">BUGS</h2>
11874 <div class="sectionbody">
11875 <div class="paragraph"><p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
11876 will result in adding a multi-line key instead of a change, if the subsection
11877 is given with at least one uppercase character. For example when the config
11878 looks like</p></div>
11879 <div class="listingblock">
11880 <div class="content">
11881 <pre><code>  [section.subsection]
11882     key = value1</code></pre>
11883 </div></div>
11884 <div class="paragraph"><p>and running <code>git config section.Subsection.key value2</code> will result in</p></div>
11885 <div class="listingblock">
11886 <div class="content">
11887 <pre><code>  [section.subsection]
11888     key = value1
11889     key = value2</code></pre>
11890 </div></div>
11891 </div>
11892 </div>
11893 <div class="sect1">
11894 <h2 id="_git">GIT</h2>
11895 <div class="sectionbody">
11896 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
11897 </div>
11898 </div>
11899 </div>
11900 <div id="footnotes"><hr /></div>
11901 <div id="footer">
11902 <div id="footer-text">
11903 Last updated
11904  2024-02-08 15:45:59 PST
11905 </div>
11906 </div>
11907 </body>
11908 </html>